Broadband Forum

    DATA MODEL DEFINITION


TR-069 InternetGatewayDevice:1.14 Root Object definition
tr-098-1-8-0.xml

License

Copyright (c) 2009-2017, Broadband Forum

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

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

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

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

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

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

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

Table of Contents

Data Types

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

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

Data Type Base Type Description
Alias string(64)

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

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

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

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

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

Possible patterns:

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

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

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

  • 216.52.29.100
  • 192.168.1.254

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

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

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

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

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

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

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

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

IPv4 address (or subnet mask).

Can be any IPv4 address that is permitted by the IPAddress data type.
IPv4Prefix IPPrefix(18)

IPv4 address prefix.

Can be any IPv4 prefix that is permitted by the IPPrefix data type.
IPv6Address IPAddress(45)

IPv6 address.

Can be any IPv6 address that is permitted by the IPAddress data type.
IPv6Prefix IPPrefix(49)

IPv6 address prefix.

Can be any IPv6 prefix that is permitted by the IPPrefix data type.
MACAddress string(17)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Base64 encoded binary (no line-length limitation).

A minimum and maximum allowed length can be indicated using the form base64(Min:Max), where Min and Max are the minimum and maximum length in characters before Base64 encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in base64(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges.
boolean - Boolean, where the allowed values are 0 or 1 (or equivalently, true or false).
dateTime - The subset of the ISO 8601 date-time format defined by the SOAP dateTime type.
hexBinary -

Hex encoded binary.

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

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

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

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

For some long types, a value range is given using the form long[Min:Max] or long[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.
object - A container for parameters and/or other objects. The full Path Name of a parameter is given by the parameter name appended to the full Path Name of the object it is contained within.
string - For strings, a minimum and maximum allowed length can be indicated using the form string(Min:Max), where Min and Max are the minimum and maximum string length in characters. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in string(Max). Multiple comma-separated ranges can be specified, in which case the string length will be in one of the ranges.
unsignedInt -

Unsigned integer in the range 0 to 4294967295, inclusive.

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

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

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

References

[3GPP-TS.23.107] 3GPP TS 23.107, Quality of Service (QoS) concept and architecture, 3GPP SA WG2.
[3GPP-TS.25.171] 3GPP TS 25.171, Requirements for support of Assisted Global Positioning System (A-GPS), 3GPP RAN WG4.
[3GPP-TS.32.582] 3GPP TS 32.582, Telecommunications management; Home Node B (HNB) Operations, Administration, Maintenance and Provisioning (OAM&P); Information model for Type 1 interface HNB to HNB Management System (HMS), 3GPP SA WG5.
[3GPP-TS.32.584] 3GPP TS 32.584, Telecommunications management; Home Node B (HNB) Operations, Administration, Maintenance and Provisioning (OAM&P); XML definitions for Type 1 interface HNB to HNB Management Systems (HMS), 3GPP SA WG5.
[3GPP-TS.32.592] 3GPP TS 32.592, Telecommunications management; Home enhanced Node B (HeNB) Operations, Administration, Maintenance and Provisioning (OAM&P); Information model for Type 1 interface HeNB to HeNB Management System (HeMS), 3GPP SA WG5.
[3GPP2-S.S0132] S.S0132-0 v1.0, Femtocell Security Framework, 3GPP2, January 2010.
[3GPP2-X.S0011] X.S0011-005-C, cdma2000 Wireless IP Network Standard: Accounting Services and 3GPP2 RADIUS VSAs, 3GPP2, August 2003.
[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.
[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.
[DVB-TS.102.824] TS 102 824, Digital Video Broadcasting (DVB);Remote Management and Firmware Update System for DVB IP Services, ETSI, July 2008.
[ETSIM2MFA] ETSI TS 102 690 v1.1.6, Machine-to-Machine Communications (M2M Functional Architecture), ETSI, June 2012.
[G.9973] G.9973, Protocol for identifying home network topology, ITU-T, 2011.
[HTML4.01] HTML 4.01 Specification, W3C.
[ICSA-Baseline] ICSA Baseline Modular Firewall Certification Criteria, Baseline module - version 4.1, ICSA Labs, 2008.
[ICSA-Firewall] ICSA Modular Firewall Certification Criteria, Required Services Security Policy - Small/Medium Business (SMB) Category module - version 4.0, ICSA Labs.
[ICSA-Residential] ICSA Residential Modular Firewall Certification Criteria, Required Services Security Policy - Residential Category module - version 4.1, ICSA Labs, 2008.
[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.
[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.
[OUI] Organizationally Unique Identifiers (OUIs).
[RED] References on RED (Random Early Detection) Queue Management.
[RFC793] RFC 793, Transmission Control Protocol, IETF, September 1981.
[RFC862] RFC 862, Echo Protocol, IETF, 1983.
[RFC959] RFC 959, File Transfer Protocol, IETF, 1985.
[RFC1035] RFC 1035, Domain Names - Implementation and Specification, IETF, 1987.
[RFC1323] RFC 1323, TCP Extensions for High Performance, IETF, May 1992.
[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.
[RFC2474] RFC 2474, Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers, IETF.
[RFC2516] RFC 2516, A Method for Transmitting PPP Over Ethernet (PPPoE), 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.
[RFC2634] RFC 2634, Enhanced Security Services for S/MIME, IETF.
[RFC2662] RFC 2662, Definitions of Managed Objects for the ADSL Lines, IETF.
[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.
[RFC2818] RFC 2818, HTTP Over TLS, IETF, May 2000.
[RFC2863] RFC 2863, The Interfaces Group MIB, IETF, 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.
[RFC3489] RFC 3489, STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network Address Translators (NATs), IETF.
[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.
[RFC3986] RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF.
[RFC4122] RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.
[RFC4291] RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006.
[RFC4301] RFC 4301, Security Architecture for the Internet Protocol, IETF, December 2005.
[RFC4307] RFC 4307, Cryptographic Algorithms for Use in the Internet Key Exchange Version 2 (IKEv2), IETF, December 2005.
[RFC4632] RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan, IETF, 2006.
[RFC4835] RFC 4835, Cryptographic Algorithm Implementation Requirements for Encapsulating Security Payload (ESP) and Authentication Header (AH), IETF, 2007.
[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.
[RFC6120] RFC 6120, Extensible Messaging and Presence Protocol (XMPP) : Core, IETF, 2011.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-069] TR-069, CPE WAN Management Protocol, Broadband Forum, 2004.
[TR-069a1] TR-069 Amendment 1, CPE WAN Management Protocol, Broadband Forum, 2006.
[TR-069a2] TR-069 Amendment 2, CPE WAN Management Protocol, Broadband Forum, 2007.
[TR-069a3] TR-069 Amendment 3, CPE WAN Management Protocol, Broadband Forum, 2010.
[TR-069a4] TR-069 Amendment 4, CPE WAN Management Protocol, Broadband Forum, 2011.
[TR-069a5] TR-069 Amendment 5, CPE WAN Management Protocol, Broadband Forum, December 2013.
[TR-098] TR-098, Internet Gateway Device Data Model for TR-069, Broadband Forum, 2005.
[TR-098a1] TR-098 Amendment 1, Internet Gateway Device Data Model for TR-069, Broadband Forum, 2006.
[TR-098a2] TR-098 Amendment 2, Internet Gateway Device Data Model for TR-069, Broadband Forum, 2008.
[TR-106] TR-106, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2005.
[TR-106a1] TR-106 Amendment 1, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2006.
[TR-106a2] TR-106 Amendment 2, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2008.
[TR-106a3] TR-106 Amendment 3, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2009.
[TR-106a4] TR-106 Amendment 4, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2010.
[TR-106a6] TR-106 Amendment 6, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2011.
[TR-106a7] TR-106 Amendment 7, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2013.
[TR-143] TR-143, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, 2008.
[TR-157] TR-157, Component Object for CWMP, Broadband Forum, March 2009.
[TR-157a3] TR-157 Amendment 3, Component Objects for CWMP, Broadband Forum, 2010.
[TR-157a5] TR-157 Amendment 5, Component Objects for CWMP, Broadband Forum, 2011.
[TR-181i1] TR-181 Issue 1, Device Data Model for TR-069, Broadband Forum, 2010.
[TR-181i2] TR-181 Issue 2, Device Data Model for TR-069, Broadband Forum, 2010.
[TR-196i2] TR-196 Issue 2, Femto Access Point Service Data Model, Broadband Forum, 2011.
[TR-232] TR-232, Bulk Data Collection, Broadband Forum, May 2012.
[TR-262] TR-262, Femto Component Objects, Broadband Forum, 2011.
[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.
[USB1.0] USB 1.0, USB 1.0 Specification, USB-IF, January 1996.
[USB2.0] USB 2.0, USB 2.0 Specification, USB-IF, April 2000.
[USB3.0] USB 3.0, USB 3.0 Specification, USB-IF, November 2008.
[WPSv1.0] Wi-Fi Protected Setup Specification Version 1.0h, Wi-Fi Alliance, 2006.
[Z-Wave] Z-Wave, Z-Wave website.
[ZigBee] ZigBee, ZigBee Alliance website.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

InternetGatewayDevice:1.14 Data Model

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

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

As defined in [TR-106a1].

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

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

 - 1.1
LANDeviceNumberOfEntries unsignedInt - Number of instances of LANDevice. - 1.0
WANDeviceNumberOfEntries unsignedInt - Number of instances of WANDevice. - 1.0
UserNumberOfEntries unsignedInt - The number of entries in the User table. - 1.5
SmartCardReaderNumberOfEntries unsignedInt - The number of entries in the SmartCardReader table. - 1.5
InternetGatewayDevice.Services. object - This object contains general services information. - 1.1
InternetGatewayDevice.Capabilities. object - The capabilities of the device. This is a constant read-only object, meaning that only a firmware upgrade will cause these values to be altered. - 1.3
InternetGatewayDevice.Capabilities.PerformanceDiagnostic. object - The capabilities of the Performance Diagnostics (DownloadDiagnostics and UploadDiagnostics) for the device. - 1.3
DownloadTransports string -

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

 - 1.3
UploadTransports string -

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

 - 1.3
InternetGatewayDevice.DeviceInfo. object - This object contains general device information. - 1.0
DeviceCategory string -

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

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

 - 1.14
Manufacturer string­(64) - The manufacturer of the CPE (human readable string). - 1.0
ManufacturerOUI string­(6:6) -

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

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

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

 - 1.0
ModelName string­(64) - Model name of the CPE (human readable string). - 1.0
ModelNumber string­(64) -

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

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

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

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

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

 - 1.0
SerialNumber string­(64) -

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.

 - 1.0
HardwareVersion string­(64) - A string identifying the particular CPE model and version. - 1.0
SoftwareVersion string­(64) -

A string identifying the software version currently installed in the CPE.

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

 - 1.0
ModemFirmwareVersion string­(64) - A string identifying the version of the modem firmware currently installed in the CPE. This is applicable only when the modem firmware is separable from the overall CPE software. - 1.0
EnabledOptions string­(1024) -

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

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

 - 1.0
AdditionalHardwareVersion string­(64) - Comma-separated list (maximum list length 64) of strings. Any additional hardware version information the vendor might wish to supply. - 1.0
AdditionalSoftwareVersion string­(64) - Comma-separated list (maximum list length 64) of strings. Any additional software version information the vendor might wish to supply. - 1.0
SpecVersion string­(16) -

Represents the version of the specification implemented by the device. Currently 1.0 is the only available version. The value of this parameter MUST equal "1.0".

This parameter is DEPRECATED because its value is fixed and it therefore serves no purpose. However, it is a Forced Inform parameter and therefore cannot be OBSOLETED.

 - 1.0
ProvisioningCode string­(64) W

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

If not an empty string, this argument SHOULD be in the form of a hierarchical descriptor with one or more nodes specified. Each node in the hierarchy is represented as a 4-character sub-string, containing only numerals or upper-case letters. If there is more than one node indicated, each node is separated by a "." (dot). Examples: "TLCO" or "TLCO.GRP2".

 - 1.0
UpTime unsignedInt - Time in seconds since the CPE was last restarted. - 1.0
FirstUseDate dateTime -

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

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

 - 1.0
DeviceLog string­(32768) - Vendor-specific log(s). - 1.0
VendorConfigFileNumberOfEntries unsignedInt - Number of instances of VendorConfigFile. - 1.0
SupportedDataModelNumberOfEntries unsignedInt - The number of entries in the SupportedDataModel table. - 1.6
ProcessorNumberOfEntries unsignedInt - The number of entries in the Processor table. - 1.8
VendorLogFileNumberOfEntries unsignedInt - The number of entries in the VendorLogFile table. - 1.8
LocationNumberOfEntries unsignedInt - The number of entries in the Location table. - 1.10
InternetGatewayDevice.DeviceInfo.VendorConfigFile.{i}. object -

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

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

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

 - 1.0
Alias string­(64) W

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

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

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

Name of the vendor configuration file.

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

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

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

 - 1.0
Version string­(16) -

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

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

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

 - 1.0
Date dateTime - Date and time when the content of the current version of this vendor configuration file was first applied by the CPE. - 1.0
Description string­(256) - A description of the vendor configuration file (human-readable string). - 1.0
InternetGatewayDevice.DeviceInfo.MemoryStatus. object - Status of the device's volatile physical memory. - 1.5
Total unsignedInt - The total physical RAM, in kilobytes, installed on the device. - 1.5
Free unsignedInt - The free physical RAM, in kilobytes, currently available on the device. - 1.5
InternetGatewayDevice.DeviceInfo.ProcessStatus. object - Status of the processes on the device. - 1.5
CPUUsage unsignedInt­[:100] - The total amount of the CPU, in percent, rounded up to the nearest whole percent. In the case that multiple CPU are present, this value represents the average of all CPU. - 1.5
ProcessNumberOfEntries unsignedInt -

The number of entries in the Process table.

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

 - 1.5
InternetGatewayDevice.DeviceInfo.ProcessStatus.Process.{i}. object -

List of all processes running on the device.

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

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

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

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

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

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

 - 1.5
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
Enable boolean W Indicates whether or not the temperature sensor is enabled. - 1.5
Status string -

The status of this temperature sensor. Enumeration of:

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

When set to true, resets the temperature sensor.

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

 - 1.5
ResetTime dateTime -

The time at which this temperature sensor was reset.

Reset can be caused by:

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

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

 - 1.5
Name string­(256) - Name of this temperature sensor. This text MUST be sufficient to distinguish this temperature sensor from other temperature sensors. - 1.5
Value int­[-274:] -

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

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

 - 1.5
LastUpdate dateTime -

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

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

 - 1.5
MinValue int­[-274:] -

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

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

 - 1.5
MinTime dateTime -

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

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

 - 1.5
MaxValue int­[-274:] -

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

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

 - 1.5
MaxTime dateTime -

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

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

 - 1.5
LowAlarmValue int­[-274:] W

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

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

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

 - 1.5
LowAlarmTime dateTime -

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

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

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

 - 1.5
HighAlarmValue int­[-274:] W

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

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

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

 - 1.5
PollingInterval unsignedInt W

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

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

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

 - 1.8
HighAlarmTime dateTime -

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

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

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

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

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

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

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

 - 1.5
InternetGatewayDevice.DeviceInfo.SupportedDataModel.{i}. object -

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

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

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

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

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

 - 1.6
Alias string­(64) W

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

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

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

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

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

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

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

 - 1.6
UUID string­(36:36) - [UUID] UUID ([RFC4122]) that is the value of the uuid attribute in the DT Instance referenced by URL. - 1.12
URN string­(256) -

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

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

 - 1.6
Features string -

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

For example, if the DT instance specified the following:

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

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

 - 1.6
InternetGatewayDevice.DeviceInfo.Processor.{i}. object -

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

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

 - 1.8
Alias string­(64) W

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

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

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

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

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

 - 1.8
InternetGatewayDevice.DeviceInfo.VendorLogFile.{i}. object -

Each table entry represents a Vendor Log File.

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

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

 - 1.8
Alias string­(64) W

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

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

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

Name of the log file.

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

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

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

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

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

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

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

 - 1.9
ProductClass string­(64) -

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

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

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

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

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

 - 1.9
InternetGatewayDevice.DeviceInfo.Location.{i}. object W

This object contains Location information.

At most one entry in this table can exist with the same values for 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.

 - 1.10
Source string -

Identifies the source of the location data. Enumeration of:

 "External" 1.10
AcquiredTime dateTime - The time when the location was acquired. - 1.10
ExternalSource string -

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

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

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

 - 1.10
ExternalProtocol string -

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

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

 "CWMP" 1.10
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.

 - 1.10
InternetGatewayDevice.DeviceConfig. object - This object contains general configuration parameters. - 1.0
PersistentData string­(256) W Arbitrary user data that MUST persist across CPE reboots. - 1.0
ConfigFile string­(32768) W

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

An alternative to this parameter, e.g. when the configuration file is larger than the parameter size limit, is to use the Upload and Download RPCs with a FileType of 1 Vendor Configuration File.

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

Enables and disables the CPE's support for CWMP.

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

true means that CWMP support on the CPE is enabled.

The factory default value MUST be true.

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.

 - 1.4
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 [RFC2616].

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

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

 - 1.0
Username string­(256) W

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

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

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

 - 1.0
Password string­(256) W

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

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

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

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

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

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

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

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

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

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

 - 1.0
ParameterKey string­(32) -

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

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

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

 - 1.0
ConnectionRequestURL string­(256) -

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

In the form:

http://host:port/path

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

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

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

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

 - 1.0
UpgradesManaged boolean W

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

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

 - 1.0
KickURL string­(256) -

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

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

 - 1.0
DownloadProgressURL string­(256) -

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

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

 - 1.0
DefaultActiveNotificationThrottle unsignedInt W

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

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

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

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

 - 1.4
UDPConnectionRequestAddress string­(256) -

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

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

host:port
host

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

When STUNEnable is false, the host and port portions of the URL MUST represent the local IP address and port on which the CPE is listening for UDP Connection Request messages.

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

 - 1.2
UDPConnectionRequestAddressNotificationLimit unsignedInt W The minimum time, in seconds, between Active Notifications resulting from changes to the UDPConnectionRequestAddress (if Active Notification is enabled). - 1.2
STUNEnable boolean W Enables or disables the use of STUN by the CPE. This applies only to the use of STUN in association with the ACS to allow UDP Connection Requests. - 1.2
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 an empty string and STUNEnable is true, the CPE MUST use the address of the ACS extracted from the host portion of the ACS URL.

 - 1.2
STUNServerPort unsignedInt­[0:65535] W

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

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

 - 1.2
STUNUsername string­(256) W

If 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 an empty string, the CPE MUST NOT send STUN Binding Requests with message integrity.

 - 1.2
STUNPassword string­(256) W

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

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

 - 1.2
STUNMaximumKeepAlivePeriod int­[-1:] W

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

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

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

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

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

When STUNEnable is false, this value MUST be false.

 - 1.2
AliasBasedAddressing boolean -

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

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

 - 1.9
InstanceMode string W

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

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

The factory default value MUST be InstanceNumber.

 - 1.9
AutoCreateInstances boolean W

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

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

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

The factory default value MUST be false.

 - 1.9
CWMPRetryMinimumWaitInterval unsignedInt­[1:65535] W

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

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

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

 - 1.9
CWMPRetryIntervalMultiplier unsignedInt­[1000:65535] W

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 - 1.13
ConnReqJabberID string -

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

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

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

 - 1.13
HTTPCompressionSupported string -

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

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

 - 1.13
HTTPCompression string W

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

The factory default value MUST be Disabled.

 - 1.13
LightweightNotificationProtocolsSupported string -

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

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

 - 1.13
LightweightNotificationProtocolsUsed string W

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

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

 - 1.13
UDPLightweightNotificationHost string­(256) W

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

UDPLightweightNotificationHost is only applicable when LightweightNotificationProtocolsUsed contains the UDP enumeration.

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

 - 1.13
UDPLightweightNotificationPort unsignedInt W

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

UDPLightweightNotificationPort is only applicable when LightweightNotificationProtocolsUsed contains the UDP enumeration.

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

 - 1.13
InformParameterNumberOfEntries unsignedInt - The number of entries in the InformParameter table. - 1.14
InternetGatewayDevice.ManagementServer.ManageableDevice.{i}. object -

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 all the same values for ManufacturerOUI, SerialNumber and ProductClass.

 - 1.2
ManufacturerOUI string­(6) - Organizationally unique identifier of the Device manufacturer as provided to the Gateway by the Device. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. The value MUST be a valid OUI as defined in [OUI]. - 1.2
SerialNumber string­(64) - Serial number of the Device as provided to the Gateway by the Device. - 1.2
ProductClass string­(64) -

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

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

 - 1.2
Host string­(1024) -

Comma-separated list (maximum list length 1024) of strings. Each list item MUST be the Path Name of a Host table row. If the referenced object is deleted, the corresponding item MUST be removed from the list. This list MUST include an item for each Host table entry, whether active or inactive, that corresponds to this physical LAN Device.

As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly.

For example: InternetGatewayDevice.LANDevice.1.Hosts.Host.1,InternetGatewayDevice.LANDevice.1.Hosts.Host.5

 - 1.4
InternetGatewayDevice.ManagementServer.AutonomousTransferCompletePolicy. object -

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

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

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

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

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

 - 1.5
ResultTypeFilter string W

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

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

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

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

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

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

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

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

 - 1.5
InternetGatewayDevice.ManagementServer.DUStateChangeComplPolicy. object -

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

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

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

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

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

 - 1.8
ResultTypeFilter string W

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

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

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

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

 - 1.8
InternetGatewayDevice.ManagementServer.EmbeddedDevice.{i}. object -

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 ControllerID and ProxiedDeviceID.

 - 1.9
ControllerID string­(256) -

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

An empty string indicates that this Proxied Device either:

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

Idenitfier of the Proxied Device.

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

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

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

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

 - 1.9
ProxyProtocolReference string - The value MUST be the Path Name of a protocol object that uses the ProxyProtocol. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 1.12
DiscoveryProtocol string -

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

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

 - 1.12
DiscoveryProtocolReference string -

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

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

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

 - 1.12
CommandProcessed string -

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

 - 1.9
CommandProcessingErrMsg string­(1024) - Detailed CommandProcessed error description (vendor specific). - 1.9
LastSyncTime dateTime -

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

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

 - 1.9
InternetGatewayDevice.ManagementServer.VirtualDevice.{i}. object -

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

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

 - 1.9
ManufacturerOUI string­(6:6) -

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

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

 - 1.9
ProductClass string­(64) - Identifier of the class of product of the associated Proxied Device for which the serial number applies. - 1.9
SerialNumber string­(64) - Serial number of the associated Proxied Device. - 1.9
Host string - Comma-separated list (up to 32 items) of strings. Each list item MUST be the Path Name of a row in the LANDevice.{i}.Hosts.Host table. If the referenced object is deleted, the corresponding item MUST be removed from the list. References all the LANDevice.{i}.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. - 1.9
ProxyProtocol string -

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

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

 - 1.9
ProxyProtocolReference string - The value MUST be the Path Name of a protocol object that uses the ProxyProtocol. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 1.12
DiscoveryProtocol string -

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

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

 - 1.12
DiscoveryProtocolReference string -

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

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

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

 - 1.12
InternetGatewayDevice.ManagementServer.StandbyPolicy. object -

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.

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

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

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

 - 1.13
NetworkAwarenessCapable boolean - Indicates that the CPE is capable of CR-Aware Standby. - 1.13
SelfTimerCapable boolean - Indicates that the CPE is capable of Timer-Aware Standby. - 1.13
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.

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

 - 1.13
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.
- 1.13
InternetGatewayDevice.ManagementServer.InformParameter.{i}. object 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.

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

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.14
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> 1.14
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> 1.14
InternetGatewayDevice.Time. object - This object contains parameters relating an NTP or SNTP time client in the CPE. - 1.0
Enable boolean W Enables or disables the NTP or SNTP time client. - 1.4
Status string -

Status of Time support on the CPE. Enumeration of:

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

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

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

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

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

The local time zone offset from UTC, ignoring daylight savings time adjustments, in the form:

+hh:mm
-hh:mm

For example, this will always be "-08:00" for California, "+00:00" or "-00:00" for the United Kingdom, and "+01:00" for France.

This parameter is OBSOLETED because the information that it represents is fully covered by LocalTimeZoneName.

 - 1.0
LocalTimeZoneName string­(64) W

Name of the local time zone (human readable string).

The name SHOULD be encoded according to IEEE 1003.1 (POSIX). The following is an example value: EST+5EDT,M4.1.0/2,M10.5.0/2

 - 1.0
DaylightSavingsUsed boolean W

Whether or not daylight savings time is in use in the CPE's local time zone.

This parameter is OBSOLETED because the information that it represents is fully covered by LocalTimeZoneName.

 - 1.0
DaylightSavingsStart dateTime W

Current local date and time at which the switch to daylight savings time occurs. If daylight savings time is not used, this value is ignored.

This parameter is OBSOLETED because the information that it represents is fully covered by LocalTimeZoneName.

 - 1.0
DaylightSavingsEnd dateTime W

Current local date and time at which the switch from daylight savings time will occur. If daylight savings time is not used, this value is ignored.

This parameter is OBSOLETED because the information that it represents is fully covered by LocalTimeZoneName.

 - 1.0
InternetGatewayDevice.UserInterface. object - This object contains parameters relating to the user interface of the CPE. - 1.0
UserDatabaseSupported boolean -

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

Indicates whether or not the CPE supports a user database that provides per-user passwords that can be used for accessing the local user interface.

 - 1.4
SharedPassword boolean W

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

Indicates whether or not a single shared password MUST protect the local user interface, or whether per-user passwords can be used.

If either UserDatabaseSupported or PasswordUserSelectable is false, the CPE MUST ignore the value of this parameter.

 - 1.4
PasswordRequired boolean W

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

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

 - 1.0
PasswordUserSelectable boolean W

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

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

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

Un-encoded binary image size in bytes.

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

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

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

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

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

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

 - 1.5
Enable boolean W Enables/Disables remotely accessing the CPE's user interface. - 1.5
Port unsignedInt­[:65535] W Destination TCP port required for remote access connection. - 1.5
SupportedProtocols string -

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

 - 1.5
Protocol string W The value MUST be a member of the list reported by the SupportedProtocols parameter. This is the protocol currently being used for remote access. - 1.5
InternetGatewayDevice.UserInterface.LocalDisplay. object - This object describes how to remotely manage the initial positioning of a user interface on a device's local display. - 1.5
Movable boolean W Controls whether the user is allowed to change the GUI window position on the local CPE's display. - 1.5
Resizable boolean W Controls whether the user is allowed to resize the GUI window on the local CPE's display. - 1.5
PosX int W The horizontal position of the User Interface's top left corner within the local CPE's display measured from the top left corner, expressed in pixels. - 1.5
PosY int W The vertical position of the User Interface's top left corner within the local CPE's display measured from the top left corner, expressed in pixels. - 1.5
Width unsignedInt W The width of the user interface within the local CPE's display, expressed in pixels. - 1.5
Height unsignedInt W The height of the user interface within the local CPE's display, expressed in pixels. - 1.5
DisplayWidth unsignedInt - The width of the local CPE's display, expressed in pixels. - 1.5
DisplayHeight unsignedInt - The height of the local CPE's display, expressed in pixels. - 1.5
InternetGatewayDevice.Layer3Forwarding. object - This object allows the handling of the routing and forwarding configuration of the device. - 1.0
DefaultConnectionService string­(256) W Specifies the default WAN interface. The content is the full hierarchical parameter name of the default layer 3 connection object. Example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1. - 1.0
ForwardNumberOfEntries unsignedInt - Number of forwarding instances. - 1.0
InternetGatewayDevice.Layer3Forwarding.Forwarding.{i}. object W

Layer 3 forwarding table.

In addition to statically configured routes, this table MUST include dynamic routes learned through layer 3 routing protocols, including RIP, OSPF, DHCP, 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 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.
  • For the remaining table entries, those for which the source address/mask matches are sorted by longest prefix, i.e. with the most specific networks first (an unspecified source address is a wild-card and always matches, with a prefix length of zero).
  • For the remaining table entries, those for which the destination address/mask matches are sorted by longest prefix, i.e. with the most specific networks first (an unspecified destination address is a wild-card and always matches, with a prefix length of zero).
  • The first of the remaining table entries is applied to the packet.

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 all the same values for DestIPAddress, DestSubnetMask, SourceIPAddress and SourceSubnetMask.

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

Indicates the status of the forwarding entry. Enumeration of:

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

 "Disabled" 1.0
Alias string­(64) W

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

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

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

This parameter can only be modified if StaticRoute is true

 - 1.9
StaticRoute boolean - If true, this route is a Static route. true 1.4
Type string W

Indicates the type of route. Enumeration of:

This parameter is DEPRECATED because its value could conflict with DestIPAddress and/or DestSubnetMask.

 "Host" 1.0
DestIPAddress string­(45) W

[IPAddress] Destination address. An empty string or a value of "0.0.0.0" indicates no destination address is specified.

A Forwarding table entry for which DestIPAddress and DestSubnetMask are both an empty string or "0.0.0.0" is a default route.

 <Empty> 1.0
DestSubnetMask string­(45) W

[IPAddress] Destination subnet mask. An empty string or a value of "0.0.0.0" 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 or "0.0.0.0" is a default route.

 <Empty> 1.0
SourceIPAddress string­(45) W [IPAddress] Source address. An empty string or a value of "0.0.0.0" indicates no source address is specified. <Empty> 1.0
SourceSubnetMask string­(45) W

[IPAddress] Source subnet mask. An empty string or a value of "0.0.0.0" indicates no source subnet mask is specified.

If a source subnet mask is specified, the SourceSubnetMask is ANDed with the source address before comparing with the SourceIPAddress. Otherwise, the full source address is used as is.

 <Empty> 1.0
ForwardingPolicy int­[-1:] W

Identifier of a set of classes or flows that have the corresponding ForwardingPolicy value as defined in the QueueManagement 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 1.1
GatewayIPAddress string­(45) W

[IPAddress] IP 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> 1.0
Interface string­(256) W

Specifies the egress interface associated with this entry. The value MUST be the Path Name of the layer 3 connection object. Example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.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 route's egress interface.

 - 1.0
ForwardingMetric int­[-1:] W Forwarding metric. A value of -1 indicates this metric is not used. -1 1.0
MTU unsignedInt­[1:1540] W The maximum allowed size of an Ethernet frame for this route. - 1.0
InternetGatewayDevice.Layer2Bridging. object -

Layer 2 bridging configuration. Specifies bridges between layer 2 LAN and/or WAN 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-2005] 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.

If the Layer2Bridging object is implemented, the view that it provides of the CPE's underlying bridging configuration MUST be consistent with the view provided by any LANDevice and WAN**Connection objects. The implications of this are explained in Annex A.6.

 - 1.1
MaxBridgeEntries unsignedInt - The maximum number of entries available in the Bridge table. - 1.1
MaxDBridgeEntries unsignedInt -

The maximum number of 802.1D [802.1D-2004] entries available in the 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.

 - 1.4
MaxQBridgeEntries unsignedInt -

The maximum number of 802.1Q [802.1Q-2005] entries available in the Bridge table. A positive 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.

 - 1.4
MaxVLANEntries unsignedInt - The maximum number of 802.1Q [802.1Q-2005] VLANs supported per Bridge table entry. - 1.4
MaxFilterEntries unsignedInt - The maximum number of entries available in the Filter table. - 1.1
MaxMarkingEntries unsignedInt - The maximum number of entries available in the Marking table. - 1.1
BridgeNumberOfEntries unsignedInt - Number of entries in the Bridge table. - 1.1
FilterNumberOfEntries unsignedInt - Number of entries in the Filter table. - 1.1
MarkingNumberOfEntries unsignedInt - Number of entries in the Marking table. - 1.1
AvailableInterfaceNumberOfEntries unsignedInt - Number of entries in the AvailableInterface table. - 1.1
InternetGatewayDevice.Layer2Bridging.Bridge.{i}. object W

Bridge table. Each entry in this table represents a single physical 802.1D [802.1D-2004] or 802.1Q [802.1Q-2005] bridge.

If the Bridge Port table is supported, it explicitly defines the Bridge's interfaces. Otherwise, they are implicitly defined via the union of the FilterInterface / MarkingInterface parameters for all the Filter and Marking table entries that are associated with 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 a given value for BridgeKey.

 - 1.1
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
BridgeKey unsignedInt - Unique key for each Bridge table entry. - 1.1
BridgeStandard string W

Selects the standard supported by this Bridge table entry. Enumeration of:

 "802.1D" 1.4
BridgeEnable boolean W Enables or disables this Bridge table entry. false 1.1
BridgeStatus string -

The status of this Bridge table entry. Enumeration of:

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

 "Disabled" 1.1
BridgeName string­(64) W Human-readable name for this Bridge table entry. <Empty> 1.1
VLANID unsignedInt­[0:4094] W

For an 802.1D [802.1D-2004] Bridge, which has no concept of VLANs, the value of this parameter MUST be 0.

For an 802.1Q [802.1Q-2005] Bridge, this is the Bridge's default VLAN ID, i.e. the VLAN ID that applies to Filter table entries with VLANIDFilter=-1. For an 802.1Q Bridge, the value of this parameter MUST NOT be 0.

 - 1.1
PortNumberOfEntries unsignedInt - Number of entries in the Bridge Port table. 0 1.4
VLANNumberOfEntries unsignedInt - Number of entries in the Bridge VLAN table. 0 1.4
InternetGatewayDevice.Layer2Bridging.Bridge.{i}.Port.{i}. object W

Bridge Port table. If this table is supported, it MUST contain an entry for each Bridge Port.

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

 - 1.4
PortEnable boolean W Enables or disables this Bridge Port table entry. false 1.4
Alias string­(64) W

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

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

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

The interface associated with this Bridge Port table entry. Represents a bridge port as defined in 802.1D [802.1D-2004] and 802.1Q [802.1Q-2005].

To associate this Bridge Port with an interface listed in the AvailableInterface table, the PortInterface value is set to the value of the corresponding AvailableInterfaceKey.

 <Empty> 1.4
PortState string -

Bridge Port state as defined in 802.1D [802.1D-2004] and 802.1Q [802.1Q-2005]. Enumeration of:

 "Disabled" 1.4
PVID int­[1:4094] W

Default Port VLAN ID as defined in 802.1Q [802.1Q-2005].

For an 802.1D [802.1D-2004] Bridge, this parameter MUST be ignored.

 1 1.4
AcceptableFrameTypes string W

Bridge Port acceptable frame types as defined in 802.1Q [802.1Q-2005]. Enumeration of:

For an 802.1D [802.1D-2004] Bridge, the value of this parameter MUST be AdmitAll.

 "Admit­All" 1.4
IngressFiltering boolean W

Enables or disables Ingress Filtering as defined in 802.1Q [802.1Q-2005].

For an 802.1D [802.1D-2004] Bridge, the value of this parameter MUST be false.

 false 1.4
InternetGatewayDevice.Layer2Bridging.Bridge.{i}.VLAN.{i}. object 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-2005] 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.

 - 1.4
VLANEnable boolean W Enables or disables this VLAN table entry. false 1.4
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
VLANName string­(64) W Human-readable name for this VLAN table entry. <Empty> 1.4
VLANID int­[1:4094] W VLAN ID of the entry, - 1.4
InternetGatewayDevice.Layer2Bridging.Filter.{i}. object W

Filter table containing filter entries each of which is associated with one Bridge as specified by a Bridge table entry.

For both 802.1D [802.1D-2004] and 802.1Q [802.1Q-2005] Bridges, this table is used for the following:

  1. If the Bridge Port table is not supported, it implicitly specifies the Bridge interfaces (in collaboration with the Marking table).
  2. It specifies destination MAC address classification rules.

For an 802.1Q Bridge, this table is also used for the following:

  1. For each VLAN ID, it specifies the interfaces that are in the VLAN's Member Set.
  2. If the Bridge Port table is not supported, it specifies the Port VLAN ID (PVID) for each interface.

This table also supports several concepts that are not covered by either 802.1D or 802.1Q:

  1. It allows a given packet to be admitted to multiple Bridges.
  2. It supports Ethertype and source MAC address classification rules.

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

 - 1.1
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
FilterKey unsignedInt - Unique key for each Filter table entry. - 1.1
FilterEnable boolean W Enables or disables this Filter table entry. false 1.1
FilterStatus string -

The status of this Filter table entry. Enumeration of:

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 FilterInterface, or if such an entry exists but is disabled, FilterStatus 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, FilterStatus MUST NOT indicate Enabled.

 "Disabled" 1.1
FilterBridgeReference int­[-1:] W The BridgeKey value of the Bridge table entry associated with this Filter. A value of -1 indicates the Filter table entry is not associated with a Bridge (and has no effect). -1 1.1
ExclusivityOrder unsignedInt W

Whether or not the Filter definition is exclusive of all others. And if the entry is exclusive, order of precedence.

A value of 1 or greater indicates an Exclusive Filter, where the value 1 indicates the first entry to be considered (highest precedence).

A value of 0 indicates a Non-Exclusive Filter (OPTIONAL).

For each packet, if the packet matches any Exclusive Filters, the packet is assigned to the Bridge associated with the highest precedence Exclusive Filter to which it matches (lowest ExclusivityOrder value).

If and only if the packet does not match any Exclusive Filters, the packet is assigned to all Bridges associated with each Non-Exclusive Filter for which it matches the defining criteria.

If a packet matches no Filter, it is discarded.

When the ExclusivityOrder is set to match that of an existing Exclusive Filter (1 or greater), the value for the existing entry and all higher numbered entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion or change in ExclusivityOrder of an Exclusive Filter causes ExclusivityOrder values of other Exclusive Filters (values 1 or greater) to be compacted.

Note that the use of Exclusive Filters to associate a layer 3 router interface with LAN and/or WAN interfaces via a Bridge entry overrides and updates the association between layer 3 and layer 2 objects implied by the InternetGatewayDevice object hierarchy.

Support for Non-Exclusive Filter entries, i.e. entries with an ExclusivityOrder value of 0, is OPTIONAL because 802.1D [802.1D-2004] and 802.1Q [802.1Q-2005] do not consider the case of a packet potentially being admitted to more than one bridge.

 - 1.1
FilterInterface string­(16) W

The interface or interfaces associated with this Filter table entry. The bridge corresponding to this Filter table entry is defined to admit packets on ingress to the bridge from the specified interfaces that meet all of the criteria specified in the Filter table entry. The following values are defined.

  • To associate this Filter with a single interface listed in the AvailableInterface table, the FilterInterface value is set to the value of the corresponding AvailableInterfaceKey.
  • AllInterfaces indicates that this Filter is associated with all LAN and WAN interfaces listed in the AvailableInterface table (all entries of InterfaceType LANInterface or WANInterface). This value is DEPRECATED because of the configuration complexity it requires.
  • LANInterfaces indicates that this Filter is associated with all LAN interfaces listed in the AvailableInterface table (all entries of InterfaceType LANInterface). This value is DEPRECATED because of the configuration complexity it requires.
  • WANInterfaces indicates that this Filter is associated with all WAN interfaces listed in the AvailableInterface table (all entries of InterfaceType WANInterface). This value is DEPRECATED because of the configuration complexity it requires.

An empty string indicates the Filter table entry is not associated with any interface (and has no effect)

 <Empty> 1.1
VLANIDFilter int­[-1:4094] W

The 802.1Q [802.1Q-2005] VLAN ID associated with this Filter table entry.

A value of -1 indicates that the default VLAN ID for the Bridge MUST be used instead (as specified by InternetGatewayDevice.Layer2Bridging.Bridge.{i}.VLANID for the Bridge table entry associated with this Filter table entry).

For an 802.1Q bridge, the value of this parameter MUST NOT be 0, and it is interpreted as follows (more than one condition can apply, e.g. a single Filter table entry might both add an interface to a VLAN's Member Set, and define a classification rule).

  1. If the Bridge Port table is not supported, it is a candidate to be the 802.1Q Port VLAN ID (PVID) for the interface associated with this Filter. Where there is more than one such candidate for a given interface, the PVID MUST be selected according to the ExclusivityOrder precedence rules.
  2. The interface associated with this Filter is added to the VLAN's 802.1Q Member Set.
  3. If a classification parameter, e.g. DestMACAddressFilterList, is specified, a classification rule for this VLAN ID is added.

For an 802.1D [802.1D-2004] Bridge, which has no concept of VLANs, the VLAN ID MUST be 0. This is most easily achieved by allowing this parameter to retain its default value of -1 and relying on the fact that the default VLAN ID for an 802.1D bridge will always be 0.

 -1 1.1
AdmitOnlyVLANTagged boolean W

802.1Q [802.1Q-2005] Acceptable Frame Types criterion.

This parameter is DEPRECATED, because it only partly models 802.1Q Acceptable Frame Types (and Ingress Filtering). The Bridge Port table SHOULD be used instead and, if supported, MUST take precedence over this parameter.

If true, the Bridge admits only packets tagged with VLAN IDs that include the ingress interface in their 802.1Q Member Sets.

If false, the Bridge admits both packets tagged with VLAN IDs that include the ingress interface in their 802.1Q Member Sets, and any Untagged or PriorityOnly packets. All Untagged or PriorityOnly packets are associated on ingress with the interface's Port VLAN ID (PVID).

See the description of VLANIDFilter for an explanation of how the Member Set and PVID are determined.

If more than one Filter table entry is associated with a given interface, the value of AdmitOnlyVLANTagged MUST be the same for all such entries.

For an 802.1D [802.1D-2004] Bridge, which has no concept of VLANs, the value of this parameter MUST be false.

 false 1.1
EthertypeFilterList string­(256) W

Classification criterion.

Comma-separated list (maximum list length 256) of unsigned integers, each representing an Ethertype value.

Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2005] support classification based on Ethertype.

 <Empty> 1.1
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-2005] support classification based on Ethertype.

 true 1.1
SourceMACAddressFilterList string­(512) W

Classification criterion.

Comma-separated list (maximum list length 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-2005] support classification based on source MAC address.

 <Empty> 1.1
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-2005] support classification based on source MAC address.

 true 1.1
DestMACAddressFilterList string­(512) W

Classification criterion.

Comma-separated list (maximum list length 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

 <Empty> 1.1
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 1.1
SourceMACFromVendorClassIDFilter string­(256) 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 DHCP Vendor Class Identifier (Option 60 as defined in RFC 2132 [RFC2132]) in the most recent DHCP lease acquisition or renewal matches the specified value according to the match criterion in SourceMACFromVendorClassIDMode. Case sensitive.

Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2005] support classification based on source MAC address.

 <Empty> 1.1
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. If SourceMACFromVendorClassIDFilter 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. If the SourceMACFromVendorClassIDFilter is an empty string, packets are admitted regardless of MAC address.

Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2005] support classification based on source MAC address.

 true 1.1
SourceMACFromVendorClassIDMode string W SourceMACFromVendorClassIDFilter pattern match criterion. Enumeration of:

For example, if SourceMACFromVendorClassIDFilter is "Example" then an Option 60 value of "Example device" will match with SourceMACFromVendorClassIDMode values of Prefix or Substring, but not with Exact or Suffix.

Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2005] support classification based on source MAC address.

 "Exact" 1.4
DestMACFromVendorClassIDFilter string­(256) 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 DHCP Vendor Class Identifier (Option 60 as defined in RFC 2132 [RFC2132]) in the most recent DHCP lease acquisition or renewal matches the specified value according to the match criterion in DestMACFromVendorClassIDMode. Case sensitive.

 <Empty> 1.1
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. If DestMACFromVendorClassIDFilter 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. If the DestMACFromVendorClassIDFilter is an empty string, packets are admitted regardless of MAC address.

 true 1.1
DestMACFromVendorClassIDMode string W DestMACFromVendorClassIDFilter pattern match criterion. Enumeration of:

For example, if DestMACFromVendorClassIDFilter is Example then an Option 60 value of "Example device" will match with DestMACFromVendorClassIDMode values of Prefix or Substring, but not with Exact or Suffix.

 "Exact" 1.4
SourceMACFromClientIDFilter string­(256) 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 DHCP Client Identifier (Option 61 as defined in RFC 2132 [RFC2132]) in the most recent DHCP lease acquisition or renewal 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-2005] support classification based on source MAC address.

 <Empty> 1.1
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-2005] support classification based on source MAC address.

 true 1.1
DestMACFromClientIDFilter string­(256) 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 DHCP Client Identifier (Option 61 as defined in RFC 2132 [RFC2132]) in the most recent DHCP lease acquisition or renewal was equal to the specified value. The option value is binary, so an exact match is REQUIRED.

 <Empty> 1.1
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 1.1
SourceMACFromUserClassIDFilter string­(256) 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 DHCP User Class Identifier (Option 77 as defined in RFC 3004 [RFC3004]) in the most recent DHCP lease acquisition or renewal was equal to the specified value.

Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2005] support classification based on source MAC address.

 <Empty> 1.1
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-2005] support classification based on source MAC address.

 true 1.1
DestMACFromUserClassIDFilter string­(256) 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 DHCP User Class Identifier (Option 77 as defined in RFC 3004 [RFC3004]) in the most recent DHCP lease acquisition or renewal was equal to the specified value.

 <Empty> 1.1
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 1.1
InternetGatewayDevice.Layer2Bridging.Marking.{i}. object W

Marking table identifying non-default layer 2 marking behavior for packets on egress from the specified interfaces.

This table is not relevant to 802.1D [802.1D-2004] Bridges, which are not VLAN-aware.

For 802.1Q [802.1Q-2005] Bridges, this table is used for the following:

  1. It specifies whether VLAN tags are to be removed on egress.

This table also supports several concepts that are not covered by 802.1Q:

  1. It allows the VLAN ID to be changed on egress.
  2. It allows the Ethernet Priority to be changed on egress.

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

 - 1.1
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
MarkingKey unsignedInt - Unique key for each Marking table entry. - 1.1
MarkingEnable boolean W Enables or disables this Marking table entry. false 1.1
MarkingStatus string -

The status of this Marking table entry. Enumeration of:

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 MarkingInterface, or if such an entry exists but is disabled, MarkingStatus MUST NOT indicate Enabled.

 "Disabled" 1.1
MarkingBridgeReference int­[-1:] W

The BridgeKey value of the Bridge table entry associated with this Marking table entry. A value of -1 indicates the Marking table entry is not associated with a Bridge (and has no effect).

The effect of a Marking table entry applies only to packets that have been admitted to the specified bridge (regardless of the ingress interface).

 -1 1.1
MarkingInterface string­(16) W

The interface or interfaces associated with this Marking table entry for which the specified marking behavior is to apply on egress from the associated bridge. The following values are defined.

  • To associate this Marking table entry with a single interface listed in the AvailableInterface table, the MarkingInterface value is set to the value of the corresponding AvailableInterfaceKey.
  • AllInterfaces indicates that this Marking table entry is associated with all LAN and WAN interfaces listed in the AvailableInterface table (all entries of InterfaceType LANInterface or WANInterface). This value is DEPRECATED because of the configuration complexity it requires.
  • LANInterfaces indicates that this Marking table entry is associated with all LAN interfaces listed in the AvailableInterface table (all entries of InterfaceType LANInterface). This value is DEPRECATED because of the configuration complexity it requires.
  • WANInterfaces indicates that this Marking table entry is associated with all WAN interfaces listed in the AvailableInterface table (all entries of InterfaceType WANInterface). This value is DEPRECATED because of the configuration complexity it requires.
  • an empty string indicates the Marking table entry table entry is not associated with any interface (and has no effect)

If there is more than one enabled Marking table entry that specifies one or more of the same interfaces for the same bridge (identical values of MarkingBridgeReference), then for packets on egress from the specified bridge to those interfaces, the applied marking MUST be that specified in the Marking table entry among those in conflict with the lowest MarkingKey value.

If an interface in a given bridge does not have a corresponding Marking table entry, the marking is left unchanged on egress.

 <Empty> 1.1
VLANIDUntag boolean W

If true, on egress to the interfaces associated with this Marking table entry, all packets are sent Untagged.

If false, on egress to the interfaces associated with this Marking table entry, all packets are sent Tagged with the VLAN ID of the VLAN in which the packet is being bridged.

 false 1.1
VLANIDMark int­[-1:4094] W

The 802.1Q [802.1Q-2005] VLAN ID to be used on egress to the interfaces associated with this Marking table entry.

A value of -1 indicates that the VLAN ID of the VLAN in which the packet is being bridged is to be used, i.e. no change.

The value of this parameter MUST NOT be 0.

If VLANIDUntag is true, then no VLAN marking is done since the tag containing the VLAN ID is removed.

Note that 802.1Q does not support re-marking on egress.

 -1 1.1
VLANIDMarkOverride boolean W

If false, on egress to the interfaces associated with this Marking table entry, the VLANIDMark, if specified, is applied only to PriorityOnly packets.

If true, on egress to the interfaces associated with this Marking table entry, the VLANIDMark, if specified, is to be applied to all packets on this Bridge.

If VLANIDUntag is true, then no VLAN marking is done since the tag containing the VLAN ID is removed.

Note that 802.1Q [802.1Q-2005] does not support re-marking on egress.

 false 1.4
EthernetPriorityMark int­[-1:7] W

Ethernet priority code (as defined in 802.1D [802.1D-2004]) to mark traffic with that falls into this Bridge on egress to the interfaces associated with this Marking table entry. A value of -1 indicates no change from the incoming packet or the mark assigned by the classifier.

Note that 802.1Q [802.1Q-2005] does not support re-marking on egress.

 -1 1.1
EthernetPriorityOverride boolean W

If false, on egress to the interfaces associated with this Marking table entry, the EthernetPriorityMark, if specified, is applied only to packets of priority 0.

If true, on egress to the interfaces associated with this Marking table entry, the EthernetPriorityMark, if specified, is to be applied to all packets on this Bridge.

Note that 802.1Q [802.1Q-2005] does not support re-marking on egress.

 false 1.1
InternetGatewayDevice.Layer2Bridging.AvailableInterface.{i}. object -

Table containing all LAN and WAN interfaces that are available to be referenced by the Bridge table. Only interfaces that can carry layer 2 bridged traffic are included.

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

 - 1.1
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
AvailableInterfaceKey unsignedInt - Unique key for each Interface entry. - 1.1
InterfaceType string -

Whether the interface is a LAN-side or WAN-side interface, or a LAN-side or WAN-side connection to the Gateway's IP router. Enumeration of:

 - 1.1
InterfaceReference string­(256) -

Comma-separated list (maximum list length 256) of strings. Each list item MUST be the Path Name of an available LAN or WAN interface. If the referenced object is deleted, the corresponding item MUST be removed from the list. This table SHOULD contain a single entry for each available LAN and WAN interface.

When such an interface is modeled in more than one place within the data model, the value of this parameter MUST include the full hierarchical parameter names of all of the corresponding objects. For example, if a given Ethernet interface is present within two LANDevice instances, the value of this parameter might be: InternetGatewayDevice.LANDevice.1.LANEthernetInterfaceConfig.1, InternetGatewayDevice.LANDevice.2.LANEthernetInterfaceConfig.1

Note that the remainder of the parameter description does not refer to the possibility that the parameter value is a comma-separated list. Nevertheless, the above requirement does apply.

  • For a WAN interface, this parameter is the full hierarchical parameter name of a particular WANConnectionDevice. A WANConnectionDevice is considered available (included in this table) only if it supports layer 2 bridged traffic. That is, this table MUST include only WANConnectionDevices that contain either a WANEthernetLinkConfig object, or that contain a WANDSLLinkConfig object for which the LinkType is EoA. For example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2
  • For a LAN interface, this parameter is the full hierarchical parameter name of a particular LAN**InterfaceConfig object, or a WLANConfiguration object. This table SHOULD include one entry for each such object. For example: InternetGatewayDevice.LANDevice.1.LANEthernetInterfaceConfig.2
  • For a WAN-side connection to the Gateway's IP router, this parameter is the full hierarchical parameter name of a particular WAN**Connection service. This table SHOULD include an entry for each layer 3 WAN connection. For example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1
  • For a LAN-side connection to the Gateway's IP router, this parameter is the full hierarchical parameter name of a particular LANDevice. This table SHOULD include an entry for each LANDevice, each of which is associated with a LAN-side layer 3 connection to the Gateway's IP router. For example: InternetGatewayDevice.LANDevice.2
- 1.1
InternetGatewayDevice.QueueManagement. object - Queue management configuration object. - 1.1
Enable boolean W Enables or disables all queuing operation. - 1.1
MaxQueues unsignedInt - The maximum number of queues supported by the CPE. Calculated as the sum of the number of different queues pointed to by Classification table. For each entry in the Classification table, the count includes a queue for each egress interface to which the corresponding classified traffic could reach. - 1.1
MaxClassificationEntries unsignedInt - The maximum number of entries available in the Classification table. - 1.1
ClassificationNumberOfEntries unsignedInt - The number of entries in the Classification table. - 1.1
MaxAppEntries unsignedInt - The maximum number of entries available in the App table. - 1.1
AppNumberOfEntries unsignedInt - The number of entries in the App table. - 1.1
MaxFlowEntries unsignedInt - The maximum number of entries available in the Flow table. - 1.1
FlowNumberOfEntries unsignedInt - The number of entries in the Flow table. - 1.1
MaxPolicerEntries unsignedInt - The maximum number of entries available in the Policer table. - 1.1
PolicerNumberOfEntries unsignedInt - The number of entries in the Policer table. - 1.1
MaxQueueEntries unsignedInt - The maximum number of entries available in the Queue table. - 1.1
QueueNumberOfEntries unsignedInt - The number of entries in the Queue table. - 1.1
QueueStatsNumberOfEntries unsignedInt - The number of entries in the QueueStats table. - 1.4
DefaultForwardingPolicy unsignedInt W Identifier of the forwarding policy associated with traffic not associated with any specified classifier. - 1.1
DefaultTrafficClass int­[-1:] W

Identifier of the traffic class associated with traffic not associated with any specified classifier.

A value of -1 indicates a null traffic class.

 - 1.4
DefaultPolicer int­[-1:] W

Instance number of the Policer table entry for traffic not associated with any specified classifier.

A value of -1 indicates a null policer.

 - 1.1
DefaultQueue unsignedInt W

Instance number of the Queue table entry for traffic not associated with any specified classifier.

A value of 0xffffffff (-1) indicates a null queue (permitted in data model versions 1.4 and later).

 - 1.1
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-098a1].

 - 1.1
DefaultEthernetPriorityMark int­[-2:] W

Ethernet priority code (as defined in 802.1D) 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-098a1].

 - 1.1
AvailableAppList string­(1024) - Comma-separated list (maximum list length 1024) of strings. 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-098a1] as well as other URNs defined elsewhere. - 1.1
InternetGatewayDevice.QueueManagement.Classification.{i}. object W

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

 - 1.1
ClassificationKey unsignedInt -

Unique key for each classification entry.

This parameter is OBSOLETED because it serves no purpose (no other parameter references it).

 - 1.1
ClassificationEnable boolean W Enables or disables this classifier. false 1.1
ClassificationStatus string -

The status of this classifier. Enumeration of:

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

 "Disabled" 1.1
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
ClassificationOrder unsignedInt­[1:] W

Position of the classification entry in the order of precedence. A value of 1 indicates the first entry considered. 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 on creation of a Classification table entry MUST be one greater than the largest current value.

 - 1.1
ClassInterface string­(256) W

Classification criterion.

Specifies the LAN or WAN ingress interface associated with this entry. The content is the full hierarchical parameter name of the particular WANDevice, WANConnectionDevice, WAN**Connection, LANDevice, LAN**InterfaceConfig, or WLANConfiguration object.

The following are WAN interface examples:

  • InternetGatewayDevice.WANDevice.2
  • InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1

The following are LAN interface examples:

  • InternetGatewayDevice.LANDevice.3
  • InternetGatewayDevice.LANDevice.1.LANEthernetInterfaceConfig.2
  • InternetGatewayDevice.LANDevice.1.WLANConfiguration.3

The string WAN indicates this entry is to apply to traffic entering from any WAN interface.

The string LAN indicates this entry is to apply to traffic entering from any LAN interface.

The string Local indicates this entry is to apply to IP-layer traffic entering from a local source within the Internet Gateway Device.

An empty string indicates this classification entry is to apply to all sources.

 <Empty> 1.1
DestIP string­(45) W

[IPAddress] Classification criterion.

Destination IP address. An empty string indicates this criterion is not used for classification.

 <Empty> 1.1
DestMask string­(45) W [IPAddress] Destination IP address mask. If not an empty string, only the indicated network portion of the DestIP address is to be used for classification. An empty string indicates that the full DestIP address is to be used for classification. <Empty> 1.1
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 1.1
SourceIP string­(45) W

[IPAddress] Classification criterion.

Source IP address. An empty string indicates this criterion is not used for classification.

 <Empty> 1.1
SourceMask string­(45) W [IPAddress] Source IP address mask. If not an empty string, only the indicated network portion of the SourceIP address is to be used for classification. An empty string indicates that the full SourceIP address is to be used for classification. <Empty> 1.1
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 1.1
Protocol int­[-1:] W

Classification criterion.

Protocol number. A value of -1 indicates this criterion is not used for classification.

 -1 1.1
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 1.1
DestPort int­[-1:] W

Classification criterion.

Destination port number. A value of -1 indicates this criterion is not used for classification.

 -1 1.1
DestPortRangeMax int­[-1:] 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 1.1
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 1.1
SourcePort int­[-1:] W

Classification criterion.

Source port number. A value of -1 indicates this criterion is not used for classification.

 -1 1.1
SourcePortRangeMax int­[-1:] 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 1.1
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 1.1
SourceMACAddress string­(17) W

[MACAddress] Classification criterion.

Source MAC Address. An empty string indicates this criterion is not used for classification.

 <Empty> 1.1
SourceMACMask string­(45) W [IPAddress] 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 SourceMACAdress are to be used for classification. <Empty> 1.1
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 1.1
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> 1.1
DestMACMask string­(45) W [IPAddress] 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 DestMACAdress are to be used for classification. <Empty> 1.1
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 1.1
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 1.1
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 1.1
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 1.1
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 1.1
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 1.1
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 1.1
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 1.1
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 1.1
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 1.1
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 1.1
SourceVendorClassID string­(256) W

Classification criterion.

Used to identify one or more LAN devices, value of the DHCP Vendor Class Identifier (Option 60) as defined in RFC 2132 [RFC2132], matched according to the criterion in SourceVendorClassIDMode. Case sensitive.

An empty string indicates this criterion is not used for classification.

 <Empty> 1.1
SourceVendorClassIDExclude boolean W

If false, the class includes only those packets sourced from LAN devices that match the SourceVendorClassID entry, if specified.

If true, the class includes all packets except those sourced from LAN devices that match the SourceVendorClassID entry, if specified.

 false 1.1
SourceVendorClassIDMode string W

SourceVendorClassID pattern match criterion. Enumeration of:

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" 1.4
DestVendorClassID string­(256) W

Classification criterion.

Used to identify one or more LAN devices, value of the DHCP Vendor Class Identifier (Option 60) as defined in RFC 2132 [RFC2132], matched according to the criterion in DestVendorClassIDMode. Case sensitive.

An empty string indicates this criterion is not used for classification.

 <Empty> 1.1
DestVendorClassIDExclude boolean W

If false, the class includes only those packets destined for LAN devices that match the DestVendorClassID entry, if specified.

If true, the class includes all packets except those destined for LAN devices that match the DestVendorClassID entry, if specified.

 false 1.1
DestVendorClassIDMode string W

DestVendorClassID pattern match criterion. Enumeration of:

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" 1.4
SourceClientID string­(256) W

Classification criterion.

Used to identify one or more LAN devices, value of the DHCP Client Identifier (Option 61) as defined in RFC 2132 [RFC2132]. The option value is binary, so an exact match is REQUIRED.

An empty string indicates this criterion is not used for classification.

 <Empty> 1.1
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 1.1
DestClientID string­(256) W

Classification criterion.

Used to identify one or more LAN devices, value of the DHCP Client Identifier (Option 61) as defined in RFC 2132 [RFC2132]. The option value is binary, so an exact match is REQUIRED.

An empty string indicates this criterion is not used for classification.

 <Empty> 1.1
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 1.1
SourceUserClassID string­(256) W

Classification criterion.

Used to identify one or more LAN devices, value of the DHCP User Class Identifier (Option 77) as defined in RFC 3004 [RFC3004].

An empty string indicates this criterion is not used for classification.

 <Empty> 1.1
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 1.1
DestUserClassID string­(256) W

Classification criterion.

Used to identify one or more LAN devices, value of the DHCP User Class Identifier (Option 77) as defined in RFC 3004 [RFC3004].

An empty string indicates this criterion is not used for classification.

 <Empty> 1.1
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 1.1
SourceVendorSpecificInfo string­(256) W

Classification criterion.

Used to identify one or more LAN devices, value of the DHCP Vendor-specific Information (Option 125) as defined in RFC 3925 [RFC3925], matched according to the criteria in SourceVendorSpecificInfoEnterprise, SourceVendorSpecificInfoSubOption and SourceVendorSpecificInfoMode. Case sensitive.

An empty string indicates this criterion is not used for classification.

 <Empty> 1.4
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 1.4
SourceVendorSpecificInfoEnterprise unsignedInt W SourceVendorSpecificInfo Enterprise Number as defined in RFC 3925 [RFC3925]. The default value (0) is assigned to IANA and will probably need to be replaced with an appropriate enterprise number. 0 1.4
SourceVendorSpecificInfoSubOption int­[0:255] W SourceVendorSpecificInfo Sub Option Code as defined in RFC 3925 [RFC3925]. 0 1.4
SourceVendorSpecificInfoMode string W SourceVendorSpecificInfo pattern match criterion. Enumeration of: "Exact" 1.4
DestVendorSpecificInfo string­(256) W

Classification criterion.

Used to identify one or more LAN devices, value of the DHCP Vendor-specific Information (Option 125) as defined in RFC 3925 [RFC3925], matched according to the criteria in DestVendorSpecificInfoEnterprise, DestVendorSpecificInfoSubOption and DestVendorSpecificInfoMode.

An empty string indicates this criterion is not used for classification.

 <Empty> 1.4
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 1.4
DestVendorSpecificInfoEnterprise unsignedInt W DestVendorSpecificInfo Enterprise Number as defined in RFC 3925 [RFC3925]. The default value (0) is assigned to IANA and will probably need to be replaced with an appropriate enterprise number. 0 1.4
DestVendorSpecificInfoSubOption int­[0:255] W DestVendorSpecificInfo Sub Option Code as defined in RFC 3925 [RFC3925]. 0 1.4
DestVendorSpecificInfoMode string W DestVendorSpecificInfo pattern match criterion. Enumeration of: "Exact" 1.4
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 1.1
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 1.1
IPLengthMin unsignedInt W

Classification criterion.

Minimum IP Packet Length (including header) in bytes.

 0 1.1
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 1.1
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 1.1
DSCPCheck int­[-1:] W

Classification criterion.

DiffServ codepoint (defined in RFC 2474 [RFC2474]).

If set to a Class Selector Codepoint (defined in RFC 2474), 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 1.1
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 1.1
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-098a1].

 -1 1.1
EthernetPriorityCheck int­[-1:] W

Classification criterion.

Current Ethernet priority as defined in 802.1D. A value of -1 indicates this criterion is not used for classification.

 -1 1.1
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 1.1
EthernetPriorityMark int­[-2:] W

Classification result.

Ethernet priority code (as defined in 802.1D) 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 EthernetPriority based upon the DSCP value of the incoming packet as defined in [Annex A/TR-098a1].

 -1 1.1
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 1.1
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 1.1
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 1.4
ForwardingPolicy unsignedInt W

Classification result.

Identifier of the forwarding policy associated with traffic that falls in this classification.

 0 1.1
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 TrafficClass parameter (which is a comma-separated list).

A value of -1 indicates a null traffic class.

TrafficClass, ClassQueue and ClassApp are mutually exclusive and one of the three MUST be specified. If TrafficClass and ClassQueue are null, ClassApp MUST be specified, and vice versa.

 -1 1.4
ClassPolicer int­[-1:] W

Classification result.

Instance number of the Policer table entry for traffic that falls in this classification.

A value of -1 indicates a null policer.

 -1 1.1
ClassQueue int­[-1:] W

Classification result.

Instance number of the Queue table entry for traffic that falls in this classification.

A value of -1 indicates a null queue.

TrafficClass, ClassQueue and ClassApp are mutually exclusive and one of the three MUST be specified. If TrafficClass and ClassQueue are null, ClassApp MUST be specified, and vice versa.

 -1 1.1
ClassApp int­[-1:] W

Classification result.

Instance number of the App table entry for traffic that falls in this classification.

A value of -1 indicates a null App table entry.

TrafficClass, ClassQueue and ClassApp are mutually exclusive and one of the three MUST be specified. If TrafficClass and ClassQueue are null, ClassApp MUST be specified, and vice versa.

 -1 1.1
InternetGatewayDevice.QueueManagement.App.{i}. object 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.

 - 1.1
AppKey unsignedInt -

Unique key for each App table entry.

This parameter is OBSOLETED because it serves no purpose (no other parameter references it).

 - 1.1
AppEnable boolean W Enables or disables this App table entry. false 1.1
AppStatus string -

The status of this App table entry. Enumeration of:

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

 "Disabled" 1.1
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
ProtocolIdentifier string­(256) W URN identifying the protocol associated with the given application. A set of defined URNs is given in [Annex A/TR-098a1]. <Empty> 1.1
AppName string­(64) W Human-readable name associated with this entry in the App table. <Empty> 1.1
AppDefaultForwardingPolicy unsignedInt W Identifier of the forwarding policy associated with traffic associated with this App table entry, but not associated with any specified flow. 0 1.1
AppDefaultTrafficClass int­[-1:] W

Identifier of the traffic class associated with traffic associated with this App table entry, but not associated with any specified flow.

A value of -1 indicates a null traffic class.

AppDefaultTrafficClass and AppDefaultQueue MUST NOT both be specified.

 -1 1.4
AppDefaultPolicer int­[-1:] W

Instance number of the Policer table entry for traffic associated with this App table entry, but not associated with any specified flow.

A value of -1 indicates a null policer.

 -1 1.1
AppDefaultQueue int­[-1:] W

Instance number of the Queue table entry for traffic associated with this App table entry, but not associated with any specified flow.

A value of -1 indicates a null queue.

AppDefaultTrafficClass and AppDefaultQueue MUST NOT both be specified.

 -1 1.1
AppDefaultDSCPMark 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-098a1].

 -1 1.1
AppDefaultEthernetPriorityMark int­[-2:] W

Ethernet priority code (as defined in 802.1D) 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-098a1].

 -1 1.1
InternetGatewayDevice.QueueManagement.Flow.{i}. object 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.

 - 1.1
FlowKey unsignedInt -

Unique key for each Flow table entry.

This parameter is OBSOLETED because it serves no purpose (no other parameter references it).

 - 1.1
FlowEnable boolean W Enables or disables this Flow table entry. false 1.1
FlowStatus string -

The status of this Flow table entry. Enumeration of:

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

 "Disabled" 1.1
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
FlowType string­(256) W URN identifying the type of flow to be associated with the specified queue and policer. A set of defined URNs is given in [Annex A/TR-098a1]. <Empty> 1.1
FlowTypeParameters 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> 1.1
FlowName string­(64) W Human-readable name associated with this entry in the Flow table. <Empty> 1.1
AppIdentifier int­[-1:] W Instance number of the App table entry associated with this flow. A value of -1 indicates the flow table is not associated with any App table entry. -1 1.1
FlowForwardingPolicy unsignedInt W Identifier of the forwarding policy associated with this flow. 0 1.1
FlowTrafficClass int­[-1:] W

Identifier of the traffic class associated with this flow.

A value of -1 indicates a null traffic class.

FlowTrafficClass and FlowQueue MUST NOT both be specified.

 -1 1.4
FlowPolicer int­[-1:] W

Instance number of the Policer table entry for traffic that falls in this flow.

A value of -1 indicates a null policer.

 -1 1.1
FlowQueue int­[-1:] W

Instance number of the Queue table entry for traffic that falls in this flow.

A value of -1 indicates a null queue.

FlowTrafficClass and FlowQueue MUST NOT both be specified.

 -1 1.1
FlowDSCPMark 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-098a1].

 -1 1.1
FlowEthernetPriorityMark int­[-2:] W

Ethernet priority code (as defined in 802.1D) 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-098a1].

 -1 1.1
InternetGatewayDevice.QueueManagement.Policer.{i}. object 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.

 - 1.1
PolicerKey unsignedInt -

Unique key for each policer entry.

This parameter is OBSOLETED because it serves no purpose (no other parameter references it).

 - 1.1
PolicerEnable boolean W Enables or disables this policer. false 1.1
PolicerStatus string -

The status of this policer. Enumeration of:

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

 "Disabled" 1.1
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
CommittedRate unsignedInt W Committed rate allowed for this policer in bits-per-second. 0 1.1
CommittedBurstSize unsignedInt W Committed Burstsize in bytes. 0 1.1
ExcessBurstSize unsignedInt W

Excess Burstsize in bytes.

Applied for a SingleRateThreeColor meter.

 0 1.1
PeakRate unsignedInt W

Peak rate allowed for this Meter in bits-per-second.

Applied for TwoRateThreeColor meters.

 0 1.1
PeakBurstSize unsignedInt W

Peak Burstsize in bytes.

Applied for TwoRateThreeColor meters.

 0 1.1
MeterType string W

Identifies the method of traffic measurement to be used for this policer. Enumeration of:

SimpleTokenBucket makes use of CommittedRate and CommittedBurstSize.

SingleRateThreeColor makes use of CommittedRate, CommittedBurstSize, and ExcessBurstSize as defined in RFC 2697 [RFC2697].

TwoRateThreeColor makes use of CommittedRate, CommittedBurstSize, PeakRate, and PeakBurstSize as defined in RFC 2698 [RFC2698].

 "Simple­Token­Bucket" 1.1
PossibleMeterTypes string -

Comma-separated list of strings. Supported meter types. Each list item is an enumeration of:

 - 1.1
ConformingAction string W

Instructions for how to handle traffic that is conforming. Possible patterns:

Null corresponds with no action.

A Count action (and only the Count action) increases the meter instance count statistics in the CountedPackets and CountedBytes parameters. Count actions are DEPRECATED because they can not be combined with other actions, e.g. marking actions.

<DSCP Value> 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.

<DSCP Value: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" 1.1
PartialConformingAction string W

Instructions for how to handle traffic that is partially conforming (colored yellow). Possible patterns:

Null corresponds with no action.

A Count action (and only the Count action) increases the meter instance count statistics in the CountedPackets and CountedBytes parameters. Count actions are DEPRECATED because they can not be combined with other actions, e.g. marking actions.

<DSCP Value> 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.

<DSCP Value: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" 1.1
NonConformingAction string W

Instructions for how to handle traffic that is non-conforming. Possible patterns:

Null corresponds with no action.

A Count action (and only the Count action) increases the meter instance count statistics in the CountedPackets and CountedBytes parameters. Count actions are DEPRECATED because they can not be combined with other actions, e.g. marking actions.

<DSCP Value> 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.

<DSCP Value: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" 1.1
CountedPackets unsignedInt -

Number of Packets counted as result of a Count meter action.

This parameter is DEPRECATED because the Count meter action is DEPRECATED.

 0 1.1
CountedBytes unsignedInt -

Number of Bytes counted as result of a Count meter action.

This parameter is DEPRECATED because the Count meter action is DEPRECATED.

 0 1.1
TotalCountedPackets unsignedInt - Total number of Packets counted by this policer, regardless of meter action. 0 1.4
TotalCountedBytes unsignedInt - Total number of Bytes counted by this policer, regardless of meter action. 0 1.4
ConformingCountedPackets unsignedInt - Number of conforming Packets counted by this policer, regardless of meter action. 0 1.4
ConformingCountedBytes unsignedInt - Number of conforming Bytes counted by this policer, regardless of meter action. 0 1.4
PartiallyConformingCountedPackets unsignedInt - Number of partially conforming Packets counted by this policer, regardless of meter action. 0 1.4
PartiallyConformingCountedBytes unsignedInt - Number of partially conforming Bytes counted by this policer, regardless of meter action. 0 1.4
NonConformingCountedPackets unsignedInt - Number of non-conforming Packets counted by this policer, regardless of meter action. 0 1.4
NonConformingCountedBytes unsignedInt - Number of non-conforming Bytes counted by this policer, regardless of meter action. 0 1.4
InternetGatewayDevice.QueueManagement.Queue.{i}. object W

Queue table.

This table can contain hardware queues. The CPE MAY refuse to allow hardware queues to be deleted.

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.

 - 1.1
QueueKey unsignedInt -

Unique key for each queue entry.

This parameter is OBSOLETED because it serves no purpose (no other parameter references it).

 - 1.1
QueueEnable boolean W Enables or disables this queue. false 1.1
QueueStatus string -

The status of this queue. Enumeration of:

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

 "Disabled" 1.1
Alias string­(64) W

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

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

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

Comma-separated list (maximum list length 256) of unsigned integers. Identifies the set of traffic classes associated with this queue.

If this list is empty then traffic can be sent to this queue only as a result of a direct reference from a Classification, App or Flow table entry, e.g. via the Classification table's ClassQueue parameter.

If this list is non-empty then traffic can additionally be sent to this queue if a Classification, App or Flow table entry specifies a traffic class, e.g. via the Classification table's 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> 1.4
QueueInterface string­(256) W

Egress interfaces for which the specified queue MUST exist. This parameter MUST be in one of the following forms:

The full hierarchical parameter name of the particular WANDevice, WANConnectionDevice, WAN**Connection, LANDevice, LAN**InterfaceConfig, or WLANConfiguration object.

The string WAN, which indicates this entry applies to all WAN interfaces.

The string LAN, which indicates this entry applies to all LAN interfaces.

An empty string, which indicates this classification entry is to apply to all interfaces.

Packets classified into this queue that exit through any other interface MUST instead use the default queuing behavior specified in the Queue table entry referenced by InternetGatewayDevice.QueueManagement.DefaultQueue.

For the default queue itself (the Queue table entry referenced by InternetGatewayDevice.QueueManagement.DefaultQueue), the value of the QueueInterface parameter MUST be ignored. That is, the default queue MUST exist on all egress interfaces.

 <Empty> 1.1
QueueBufferLength unsignedInt -

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.

 - 1.1
QueueWeight unsignedInt W Weight of this queue in case of WFQ or WRR, but only used for queues of equal precedence. 0 1.1
QueuePrecedence unsignedInt­[1:] W Precedence of this queue relative to others. Lower numbers imply greater precedence. 1 1.1
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 1.1
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 1.1
DropAlgorithm string W

Dropping algorithm used for this queue if congested. Enumeration of:

 "DT" 1.1
SchedulerAlgorithm string W

Scheduling Algorithm used by scheduler. Enumeration of:

  • WFQ (Weighted Fair Queueing)
  • WRR (Weighted Round Robin)
  • SP (Strict Priority)
"SP" 1.1
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 1.1
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. - 1.1
InternetGatewayDevice.QueueManagement.QueueStats.{i}. object 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.

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 Queue and Interface.

 - 1.4
Enable boolean W Enables or disables this object. false 1.4
Status string -

The status of this object. Enumeration of:

  • Disabled
  • Enabled (Enabled and {Queue,Interface} is valid)
  • Error (Enabled but {Queue,Interface} is invalid)
"Disabled" 1.4
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
Queue unsignedInt W Instance number of the Queue table entry with which this object is associated. 0 1.4
Interface string­(256) W Egress interface for which this object contains statistics. This parameter MUST be the full hierarchical parameter name of the particular WANDevice, WANConnectionDevice, WAN**Connection, LANDevice, LAN**InterfaceConfig, or WLANConfiguration object. <Empty> 1.4
OutputPackets unsignedInt - Number of packets output through the queue. 0 1.4
OutputBytes unsignedInt - Number of bytes output through the queue. 0 1.4
DroppedPackets unsignedInt - Number of packets dropped by the queue. 0 1.4
DroppedBytes unsignedInt - Number of bytes dropped by the queue. 0 1.4
QueueOccupancyPackets unsignedInt - Queue occupancy in packets (gives a measure of queue latency). 0 1.4
QueueOccupancyPercentage unsignedInt­[0:100] - Queue occupancy as a percentage, i.e. 100 * queue occupancy in bytes / queue size in bytes (gives a measure of queue usage). 0 1.4
InternetGatewayDevice.LANConfigSecurity. object - This object contains generic device configuration information. - 1.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 InternetGatewayDevice.UserInterface.PasswordUserSelectable is true.

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

 - 1.0
InternetGatewayDevice.IPPingDiagnostics. object - This object provides access to an IP-layer ping test. - 1.0
DiagnosticsState string W

Indicates availability of diagnostic data. Enumeration of:

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

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

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

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

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

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

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

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

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

 - 1.0
Interface string­(256) W

The value MUST be the Path Name of the WAN or LAN IP-layer interface over which the test is to be performed. This identifies the source IP address to use when performing the test.

The following is a WAN interface example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1

The following is a LAN interface example: InternetGatewayDevice.LANDevice.1.LANHostConfigManagement.IPInterface.1

The value of this parameter MUST be either a valid interface or an empty string. An attempt to set this parameter to a different value MUST be rejected as an invalid parameter value.

If an empty string is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface.

 - 1.0
Host string­(256) W Host name or address of the host to ping. - 1.0
NumberOfRepetitions unsignedInt­[1:] W Number of repetitions of the ping test to perform before reporting the results. - 1.0
Timeout unsignedInt­[1:] W Timeout in milliseconds for the ping test. - 1.0
DataBlockSize unsignedInt­[1:65535] W Size of the data block in bytes to be sent for each ping. - 1.0
DSCP unsignedInt­[0:63] W DiffServ codepoint to be used for the test packets. By default the CPE SHOULD set this value to zero. - 1.0
SuccessCount unsignedInt - Result parameter indicating the number of successful pings (those in which a successful response was received prior to the timeout) in the most recent ping test. - 1.0
FailureCount unsignedInt - Result parameter indicating the number of failed pings in the most recent ping test. - 1.0
AverageResponseTime unsignedInt - Result parameter indicating the average response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 1.0
MinimumResponseTime unsignedInt - Result parameter indicating the minimum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 1.1
MaximumResponseTime unsignedInt - Result parameter indicating the maximum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 1.0
InternetGatewayDevice.DownloadDiagnostics. object -

This object defines the diagnostics configuration for a HTTP and FTP DownloadDiagnostics Test.

Files received in the DownloadDiagnostics do not require file storage on the CPE device.

 - 1.3
DiagnosticsState string W

Indicate the availability of diagnostic data. Enumeration of:

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

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

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

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

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

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

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

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

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

 - 1.3
Interface string­(256) W

The value MUST be the Path Name of the IP-layer interface over which the test is to be performed.

The value of this parameter MUST be either a valid interface or an empty string. An attempt to set this parameter to a different value MUST be rejected as an invalid parameter value.

If an empty string is specified, the CPE MUST use the default routing interface.

 - 1.3
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 [RFC862] URL.

When using FTP transport, FTP binary transfer MUST be used.

When using HTTP transport, persistent connections MUST be used and pipelining MUST NOT be used.

When using HTTP transport the HTTP Authentication MUST NOT be used.

 - 1.3
DSCP unsignedInt­[0:63] W

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

The default value SHOULD be zero.

 - 1.3
EthernetPriority unsignedInt­[0:7] W

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

The default value SHOULD be zero.

 - 1.3
ROMTime dateTime -

Request time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456

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

Begin of transmission time in UTC, which MUST be specified to microsecond precision

For example: 2008-04-09T15:01:05.123456

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

End of transmission in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456

  • For HTTP this is the time at which the last data packet is received.
  • For FTP this is the time at which the client receives the last packet on the data connection.
- 1.3
TestBytesReceived unsignedInt - The test traffic received in bytes during the FTP/HTTP transaction including FTP/HTTP headers, between BOMTime and EOMTime, - 1.3
TotalBytesReceived unsignedInt - The total number of bytes received on the Interface between BOMTime and EOMTime. - 1.3
TCPOpenRequestTime dateTime -

Request time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456

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

Note: Interval of 1 microsecond SHOULD be supported.

 - 1.3
TCPOpenResponseTime dateTime -

Response time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456

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

Note: Interval of 1 microsecond SHOULD be supported.

 - 1.3
InternetGatewayDevice.UploadDiagnostics. object -

This object defines the diagnostics configuration for a HTTP or FTP UploadDiagnostics test.

Files sent by the UploadDiagnostics do not require file storage on the CPE device, and MAY be an arbitrary stream of bytes.

 - 1.3
DiagnosticsState string W

Indicate the availability of diagnostic data. Enumeration of:

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

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

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

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

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

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

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

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

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

 - 1.3
Interface string­(256) W

The value MUST be the Path Name of the IP-layer interface over which the test is to be performed.

The value of this parameter MUST be either a valid interface or an empty string. An attempt to set this parameter to a different value MUST be rejected as an invalid parameter value.

If an empty string is specified, the CPE MUST use the default routing interface.

 - 1.3
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 [RFC862] URL.

When using FTP transport, FTP binary transfer MUST be used.

When using HTTP transport, persistent connections MUST be used and pipelining MUST NOT be used.

When using HTTP transport the HTTP Authentication MUST NOT be used.

 - 1.3
DSCP unsignedInt­[0:63] W

DiffServ code point for marking packets transmitted in the test.

The default value SHOULD be zero.

 - 1.3
EthernetPriority unsignedInt­[0:7] W

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

The default value SHOULD be zero.

 - 1.3
TestFileLength unsignedInt W

The size of the file (in bytes) to be uploaded to the server.

The CPE MUST insure the appropriate number of bytes are sent.

 - 1.3
ROMTime dateTime -

Request time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456

  • For HTTP this is the time at which the client sends the PUT command
  • For FTP this is the time at which the STOR command is sent.
- 1.3
BOMTime dateTime -

Begin of transmission time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456

  • For HTTP this is the time at which the first data packet is sent.
  • For FTP this is the time at which the client receives the ready for transfer notification.
- 1.3
EOMTime dateTime -

End of transmission in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456

  • For HTTP this is the time when the HTTP successful response code is received.
  • For FTP this is the time when the client receives a transfer complete.
- 1.3
TotalBytesSent unsignedInt - The total number of bytes sent on the Interface between BOMTime and EOMTime. - 1.3
TCPOpenRequestTime dateTime -

Request time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456

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

Note: Interval of 1 microsecond SHOULD be supported.

 - 1.3
TCPOpenResponseTime dateTime -

Response time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456

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

Note: Interval of 1 microsecond SHOULD be supported.

 - 1.3
InternetGatewayDevice.UDPEchoConfig. object - This object allows the CPE to be configured to perform the UDP Echo Service defined in [RFC862] and UDP Echo Plus Service defined in [Appendix A.1/TR-143]. - 1.3
Enable boolean W MUST be enabled to receive UDP echo. When enabled from a disabled state all related timestamps, statistics and UDP Echo Plus counters are cleared. - 1.3
Interface string­(256) W

The value MUST be the Path Name of IP-layer interface over which the CPE MUST listen and receive UDP echo requests on.

The value of this parameter MUST be either a valid interface or an empty string. An attempt to set this parameter to a different value MUST be rejected as an invalid parameter value.

If an empty string is specified, the CPE MUST listen and receive UDP echo requests on all interfaces.

Note: Interfaces behind a NAT MAY require port forwarding rules configured in the Gateway to enable receiving the UDP packets.

 - 1.3
SourceIPAddress string­(45) W [IPAddress] The Source IP address of the UDP echo packet. The CPE MUST only respond to a UDP echo from this source IP address. - 1.3
UDPPort unsignedInt W The UDP port on which the UDP server MUST listen and respond to UDP echo requests. - 1.3
EchoPlusEnabled boolean W If true the CPE will perform necessary packet processing for UDP Echo Plus packets. - 1.3
EchoPlusSupported boolean - true if UDP Echo Plus is supported. - 1.3
PacketsReceived unsignedInt - Incremented upon each valid UDP echo packet received. - 1.3
PacketsResponded unsignedInt - Incremented for each UDP echo response sent. - 1.3
BytesReceived unsignedInt - The number of UDP received bytes including payload and UDP header after the UDPEchoConfig is enabled. - 1.3
BytesResponded unsignedInt - The number of UDP responded bytes, including payload and UDP header sent after the UDPEchoConfig is enabled. - 1.3
TimeFirstPacketReceived dateTime -

Time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456,

The time that the server receives the first UDP echo packet after the UDPEchoConfig is enabled.

 - 1.3
TimeLastPacketReceived dateTime -

Time in UTC, which MUST be specified to microsecond precision.

For example: 2008-04-09T15:01:05.123456

The time that the server receives the most recent UDP echo packet.

 - 1.3
InternetGatewayDevice.LANDevice.{i}. object W

Each instance models a LAN side layer 3 IP interface.

Each instance has children that correspond to the layer 2 interfaces that are connected to the Gateway's IP router via the modeled IP interface. If a LANDevice instance is deleted, the objects modeling those layer 2 interfaces that are as a result no longer connected to the Gateway's IP router will move to the InternetGatewayDevice.LANInterfaces object.

If the Layer2Bridging object is implemented, the view that it provides of the CPE's underlying bridging configuration MUST be consistent with the view provided by any LANDevice and WAN**Connection objects. The implications of this are explained in [Annex A.6/TR-098a2].

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

 - 1.0
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
LANEthernetInterfaceNumberOfEntries unsignedInt - Number of instances of LANEthernetInterfaceConfig in this LANDevice. 0 1.0
LANUSBInterfaceNumberOfEntries unsignedInt - Number of instances of LANUSBInterfaceConfig in this LANDevice. 0 1.0
LANWLANConfigurationNumberOfEntries unsignedInt - Number of instances of WLANConfiguration in this LANDevice. 0 1.0
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement. object -

This object enables reporting of LAN-related device information and setting and configuring LAN IP addressing.

The DHCP parameters in this object define the behavior of the default DHCP server, i.e. the behavior for DHCP requests that do not match any of the DHCP conditional serving pool entries.

 - 1.0
MACAddress string­(17) -

[MACAddress] The MAC address associated with the IP interface modeled by this LANDevice instance. This is the MAC address that is returned in response to an ARP request for any of the IP interface's IP addresses. It is also the source MAC address in all IP traffic sent over the IP interface.

If no single MAC address meets the above criteria, the value of this parameter MUST be the all-zero MAC address 00:00:00:00:00:00.

 - 1.4
DHCPServerConfigurable boolean W Enables the configuration of the DHCP server on the LAN interface. If this variable is set to false, the CPE SHOULD restore its default DHCP server settings. true 1.0
DHCPServerEnable boolean W Enables or disables the DHCP server on the LAN interface. false 1.0
DHCPRelay boolean -

Indicates if the DHCP server performs the role of a server (false) or a relay (true) on the LAN interface.

This parameter is DEPRECATED because the functionality that it describes is not well-defined. The CPE MAY set it to the value that it thinks most appropriate, based on its configuration.

 - 1.0
MinAddress string­(45) W

[IPAddress] Specifies first address in the pool to be assigned by the DHCP server on the LAN interface.

This parameter MUST have a valid value before the DHCP server can be enabled.

 - 1.0
MaxAddress string­(45) W

[IPAddress] Specifies last address in the pool to be assigned by the DHCP server on the LAN interface.

This parameter MUST have a valid value before the DHCP server can be enabled.

 - 1.0
ReservedAddresses string­(256) W [IPAddress] Comma-separated list (maximum list length 256) of IPAddresses. Addresses marked reserved from the address allocation pool. <Empty> 1.0
SubnetMask string­(45) W

[IPAddress] Specifies the client's network subnet mask.

This parameter MUST have a valid value before the DHCP server can be enabled.

 - 1.0
DNSServers string­(64) W [IPAddress] Comma-separated list (maximum list length 64) of IPAddresses. DNS servers offered to DHCP clients. Support for more than three DNS Servers is OPTIONAL. - 1.0
DomainName string­(64) W Sets the domain name to provide to clients on the LAN interface. - 1.0
IPRouters string­(64) W [IPAddress] Comma-separated list (maximum list length 64) of IPAddresses. IP addresses of routers on this subnet. Also known as default gateway. Support for more than one Router address is OPTIONAL. - 1.0
DHCPLeaseTime int­[-1:] W Specifies the lease time in seconds of client assigned addresses. A value of -1 indicates an infinite lease. 86400 1.0
UseAllocatedWAN string W

Controls use of addresses from the associated WAN connection. Enumeration of:

If Normal, the address pool is directly configured by the ACS.

If UseAllocatedSubnet, behavior is the same as for Passthrough with an empty PassthroughMACAddress. For this reason, UseAllocatedSubnet is DEPRECATED.

If Passthrough, and PassthroughMACAddress is an empty string, the configured values of the MinAddress, MaxAddress, SubnetMask and DNSServers parameters are ignored. The corresponding address pool values are instead taken from the WAN connection specified by AssociatedConnection.

If Passthrough, and PassthroughMACAddress is not an empty string, the LAN Host identified by PassthroughMACAddress is given a WAN IP address from the WAN connection specified by AssociatedConnection. Other LAN Hosts are treated as for Normal.

Use of PassthroughMACAddress does not cover the case where more than one LAN Host is to be given a WAN IP address. This can be achieved by using a DHCP conditional serving pool.

 "Normal" 1.0
AssociatedConnection string­(256) W

The value MUST be the Path Name of the connection instance to be used for address allocation if UseAllocatedWAN is set to UseAllocatedSubnet or Passthrough. The content is the full hierarchical parameter name of a WAN-side layer 3 connection object. Example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1.

If UseAllocatedWAN is UseAllocatedSubnet or Passthrough, this parameter MUST have a valid value before the DHCP server can be enabled.

 - 1.0
PassthroughLease unsignedInt W

DHCP lease time in seconds given to the LAN Host that is used to passthrough a WAN IP address if UseAllocatedWAN is Passthrough.

Note: A temporary private IP address with short lease (for example, 1 min) might be given to the passthrough LAN Host before the WAN IP address is acquired.

 600 1.0
PassthroughMACAddress string­(17) W

[MACAddress] Hardware address of the LAN Host that is used to passthrough a WAN IP address if UseAllocatedWAN is Passthrough.

Note: an empty string indicates that no specific LAN Host is designated, and results in the same behavior as the (DEPRECATED) UseAllocatedSubnet.

 - 1.0
AllowedMACAddresses string­(512) W [MACAddress] Comma-separated list (maximum list length 512) of MACAddresses. Hardware addresses that are allowed to connect to this connection if MACAddressControlEnabled is 1 for a given interface. - 1.0
IPInterfaceNumberOfEntries unsignedInt - The number of entries in the IPInterface table. 0 1.0
DHCPStaticAddressNumberOfEntries unsignedInt - The number of entries in the DHCPStaticAddress table. 0 1.4
DHCPOptionNumberOfEntries unsignedInt - The number of entries in the DHCPOption table. 0 1.4
DHCPConditionalPoolNumberOfEntries unsignedInt - The number of entries in the DHCPConditionalServingPool table. 0 1.4
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.IPInterface.{i}. object W

IP address table with each object representing an IP address on the LANDevice IP interface.

Support for more than one interface instance is OPTIONAL.

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 IPInterfaceIPAddress and IPInterfaceSubnetMask.

 - 1.0
Enable boolean W Enables or disables this entry. On creation, an entry is disabled by default. false 1.0
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
IPInterfaceIPAddress string­(45) W [IPAddress] IP address of the LAN-side interface of the CPE. <Empty> 1.0
IPInterfaceSubnetMask string­(45) W [IPAddress] Subnet mask of the LAN-side interface of the IGD. <Empty> 1.0
IPInterfaceAddressingType string W

Represents the addressing method used to assign the LAN-side IP address of the CPE on this interface. Enumeration of:

 "DHCP" 1.0
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.DHCPStaticAddress.{i}. object W

DHCP static address table.

Entries in this table correspond to what RFC 2131 [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 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.

 - 1.4
Enable boolean W

Enables or disables the DHCPStaticAddress table entry.

Disabling an entry does not return the IP address to the pool.

 false 1.4
Alias string­(64) W

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

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

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

[MACAddress] Hardware address (MAC address) of the physical interface of the DHCP client.

This parameter MUST have a valid value before the table entry can be enabled.

 <Empty> 1.4
Yiaddr string­(45) W

[IPAddress] IP address to be assigned by the DHCP server to the DHCP client with the specified hardware address (MAC address).

This parameter MUST have a valid value before the table entry can be enabled.

 <Empty> 1.4
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.DHCPOption.{i}. object W

This object specifies the DHCP options that MUST, if enabled, be returned to clients whose DHCP requests do not match any of the DHCP conditional serving pool entries.

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.

 - 1.4
Enable boolean W Enables or disables this DHCPOption table entry. false 1.4
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
Tag unsignedInt­[1:254] W Option tag as defined in RFC 2132 [RFC2132]. - 1.4
Value base64­(255) W Base64 encoded option value. <Empty> 1.4
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.DHCPConditionalServingPool.{i}. object 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.

If a DHCP request does not match any of the DHCP conditional serving pool entries, the handling of the request is determined by the default DHCP server behavior that is defined by the LANHostConfigManagement object.

Overlapping pool ranges MUST be supported.

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.

 - 1.4
Enable boolean W Enables or disables the DHCPConditionalServingPool entry. false 1.4
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
PoolOrder unsignedInt­[1:] W

Position of the pool entry in the order of precedence. A value of 1 indicates the first entry considered. 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 on creation of a DHCPConditionalServingPool table entry MUST be one greater than the largest current value.

 - 1.4
SourceInterface string­(1024) W

Pool association criterion.

Comma-separated list (maximum list length 1024) of strings. Each list item MUST be the Path Name of the layer 2 ingress interfaces associated with this entry, i.e. the corresponding LAN**InterfaceConfig or WLANConfiguration objects.

For example: InternetGatewayDevice.LANDevice.1.LANEthernetInterfaceConfig.2,InternetGatewayDevice.LANDevice.1.WLANConfiguration.3

An empty string indicates this entry is to apply to all layer 2 interface objects under this LANDevice instance.

 <Empty> 1.4
VendorClassID string­(256) W

Pool association criterion.

Used to identify one or more LAN devices, value of the DHCP Vendor Class Identifier (Option 60) as defined in RFC 2132 [RFC2132], matched according to the criterion in VendorClassIDMode. Case sensitive.

An empty string indicates this criterion is not used for conditional serving.

 <Empty> 1.4
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 1.4
VendorClassIDMode string W VendorClassID pattern match criterion. Enumeration of:

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" 1.4
ClientID string­(256) W

Pool association criterion.

Used to identify one or more LAN devices, value of the DHCP Client Identifier (Option 61) as defined in RFC 2132 [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> 1.4
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 1.4
UserClassID string­(256) W

Pool association criterion.

Used to identify one or more LAN devices, value of the DHCP User Class Identifier (Option 77) as defined in RFC 3004 [RFC3004].

An empty string indicates this criterion is not used for conditional serving.

 <Empty> 1.4
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 1.4
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> 1.4
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> 1.4
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 1.4
LocallyServed boolean W If true, then the local DHCP server will assign an IP address from the specific address pool specified in this object. If false, the DHCP server will send the request to the DHCPServerIPAddress configured for this pool. true 1.4
MinAddress string­(45) W

[IPAddress] Specifies first address in the pool to be assigned by the DHCP server on the LAN interface.

This parameter is configurable only if UseAllocatedWAN is Normal.

This parameter MUST have a valid value before this pool can be enabled.

 - 1.4
MaxAddress string­(45) W

[IPAddress] Specifies last address in the pool to be assigned by the DHCP server on the LAN interface.

This parameter is configurable only if UseAllocatedWAN is Normal.

This parameter MUST have a valid value before this pool can be enabled.

 - 1.4
ReservedAddresses string­(512) W [IPAddress] Comma-separated list (maximum list length 512) of IPAddresses. IP addresses marked reserved from the address allocation pool. <Empty> 1.4
SubnetMask string­(45) W

[IPAddress] Specifies the client's network subnet mask.

This parameter is configurable only if UseAllocatedWAN is Normal.

This parameter MUST have a valid value before this pool can be enabled.

 - 1.4
DNSServers string­(64) W

[IPAddress] Comma-separated list (maximum list length 64) of IPAddresses. DNS servers offered to DHCP clients. Support for more than three DNS Servers is OPTIONAL.

This parameter is configurable only if UseAllocatedWAN is Normal.

 - 1.4
DomainName string­(64) W Sets the domain name to provide to clients on the LAN interface. - 1.4
IPRouters string­(64) W [IPAddress] Comma-separated list (maximum list length 64) of IPAddresses. IP addresses of routers on this subnet. Also known as default gateway. Support for more than one Router address is OPTIONAL. - 1.4
DHCPLeaseTime int­[-1:] W Specifies the lease time in seconds of client assigned addresses. A value of -1 indicates an infinite lease. 86400 1.4
UseAllocatedWAN string W

Controls whether the MinAddress, MaxAddress, SubnetMask and DNSServers parameters are configurable or are taken from the associated WAN connection. Enumeration of:

If Normal, the above-mentioned pool parameters are directly configured by the ACS.

If Passthrough, the above-mentioned pool parameters cannot be configured by the ACS. Their values are instead taken from the WAN connection specified by AssociatedConnection.

 "Normal" 1.4
AssociatedConnection string­(256) W

The value MUST be the Path Name of the connection instance to be used for address allocation if UseAllocatedWAN is set to Passthrough. The content is the full hierarchical parameter name of a WAN-side layer 3 connection object. Example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1.

If UseAllocatedWAN is Passthrough, this parameter MUST have a valid value before this pool can be enabled.

 - 1.4
DHCPServerIPAddress string­(45) W [IPAddress] IP address of the DHCP server, where the request has to be sent to when there is a conditional match with this pool and LocallyServed is false. If this parameter is not configured, then the DHCP request is dropped. - 1.4
DHCPStaticAddressNumberOfEntries unsignedInt - The number of entries in the DHCPStaticAddress table. 0 1.4
DHCPOptionNumberOfEntries unsignedInt - The number of entries in the DHCPOption table. 0 1.4
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.DHCPConditionalServingPool.{i}.DHCPStaticAddress.{i}. object W

DHCP static address table.

Entries in this table correspond to what RFC 2131 [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 the main pool and/or 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.

 - 1.4
Enable boolean W

Enables or disables the DHCPStaticAddress table entry.

Disabling an entry does not return the IP address to the pool.

 false 1.4
Alias string­(64) W

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

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

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

[MACAddress] Hardware address (MAC address) of the physical interface of the DHCP client.

This parameter MUST have a valid value before the table entry can be enabled.

 <Empty> 1.4
Yiaddr string­(45) W

[IPAddress] IP address to be assigned by the DHCP server to the DHCP client with the specified hardware address (MAC address).

This parameter MUST have a valid value before the table entry can be enabled.

 <Empty> 1.4
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.DHCPConditionalServingPool.{i}.DHCPOption.{i}. object 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.

 - 1.4
Enable boolean W Enables or disables this DHCPOption table entry. false 1.4
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
Tag unsignedInt­[1:254] W Option tag as defined in RFC 2132 [RFC2132]. - 1.4
Value base64­(255) W Base64 encoded option value. <Empty> 1.4
InternetGatewayDevice.LANDevice.{i}.LANEthernetInterfaceConfig.{i}. object -

This object models an Ethernet LAN connection on a CPE device. This object MUST be implemented for CPE that contain an Ethernet interface on the LAN side.

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

 - 1.0
Enable boolean W Enables or disables this interface. - 1.0
Status string -

Indicates the status of this interface. Enumeration of:

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

 - 1.0
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
Name string­(16) - The name of this layer 2 interface, chosen by the vendor, e.g. "eth0" or "eth0:1". - 1.4
MACAddress string­(17) - [MACAddress] The physical address of the interface. - 1.0
MACAddressControlEnabled boolean W Indicates whether MAC Address Control is enabled or not on this interface. MAC Address Control limits the clients that connect to those that match a list of allowed MAC addresses specified in InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.AllowedMACAddresses. - 1.0
MaxBitRate string W

The maximum upstream and downstream bit rate available to this connection. Enumeration of:

 - 1.0
DuplexMode string W

The duplex mode available to this connection. Enumeration of:

 - 1.0
InternetGatewayDevice.LANDevice.{i}.LANEthernetInterfaceConfig.{i}.Stats. object -

This object contains statistics for an Ethernet LAN interface on a CPE device.

Note that these statistics refer to the link layer, not to the physical layer.

 - 1.0
BytesSent unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.0
BytesReceived unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.0
PacketsSent unsignedInt -

The total number of packets transmitted out of the interface.

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.0
PacketsReceived unsignedInt -

The total number of packets which were received on this interface.

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.0
ErrorsSent unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
ErrorsReceived unsignedInt -

The total number of inbound packets that contained errors preventing them from being deliverable.

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
UnicastPacketsSent unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
UnicastPacketsReceived unsignedInt -

The total number of received packets which were not addressed to a multicast or broadcast address.

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
DiscardPacketsSent unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
DiscardPacketsReceived unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
MulticastPacketsSent unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
MulticastPacketsReceived unsignedInt -

The total number of received packets which were addressed to a multicast address.

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
BroadcastPacketsSent unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
BroadcastPacketsReceived unsignedInt -

The total number of received packets which were addressed to a broadcast address.

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
UnknownProtoPacketsReceived unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
InternetGatewayDevice.LANDevice.{i}.LANUSBInterfaceConfig.{i}. object -

This object models a USB LAN connection on a CPE device. This object MUST be implemented for CPE that contain a USB interface on the LAN side.

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

 - 1.0
Enable boolean W Enables or disables this interface. - 1.0
Status string -

Indicates the status of this interface. Enumeration of:

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

 - 1.0
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
Name string­(16) - The name of this layer 2 interface, chosen by the vendor, e.g. "usb0". - 1.4
MACAddress string­(17) - [MACAddress] The physical address of the interface. - 1.0
MACAddressControlEnabled boolean W Indicates whether MAC Address Control is enabled or not on this interface. MAC Address Control limits the clients that connect to those that match a list of allowed MAC addresses specified in InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.AllowedMACAddresses. - 1.0
Standard string­(6) - USB version supported by the device. - 1.0
Type string -

Type of the USB interface. Enumeration of:

 - 1.0
Rate string -

Speed of the USB interface. Enumeration of:

 - 1.0
Power string -

Power configuration of the USB interface. Enumeration of:

 - 1.0
InternetGatewayDevice.LANDevice.{i}.LANUSBInterfaceConfig.{i}.Stats. object -

This object contains statistics for a USB LAN interface on a CPE device.

Note that these statistics refer to the link layer, not to the physical layer.

 - 1.0
BytesSent unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.0
BytesReceived unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.0
CellsSent unsignedInt -

The total number of packets (cells) transmitted out of the interface.

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.0
CellsReceived unsignedInt -

The total number of packets (cells) which were received on this interface.

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.0
ErrorsSent unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
ErrorsReceived unsignedInt -

The total number of inbound packets that contained errors preventing them from being deliverable.

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
UnicastPacketsSent unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
UnicastPacketsReceived unsignedInt -

The total number of received packets which were not addressed to a multicast or broadcast address.

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
DiscardPacketsSent unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
DiscardPacketsReceived unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
MulticastPacketsSent unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
MulticastPacketsReceived unsignedInt -

The total number of received packets which were addressed to a multicast address.

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
BroadcastPacketsSent unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
BroadcastPacketsReceived unsignedInt -

The total number of received packets which were addressed to a broadcast address.

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
UnknownProtoPacketsReceived unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}. object -

This object models an 802.11 LAN connection on a CPE device. This object MUST be implemented for CPE that contain an 802.11 interface on the LAN side.

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

 - 1.0
Enable boolean W

Enables or disables this interface.

When there are multiple WLANConfiguration instances, e.g. each instance supports a different 802.11 standard or has a different security configuration, this parameter can be used to control which of the instances are currently enabled.

 - 1.0
Status string -

Indicates the status of this interface. Enumeration of:

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

 - 1.0
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
Name string­(16) - The name of this layer 2 interface, chosen by the vendor, e.g. "wlan0". - 1.4
BSSID string - The MAC address of the interface. - 1.0
MaxBitRate string­(4) W The maximum upstream and downstream bit rate available to this connection in Mbps. Either Auto, or the largest of the OperationalDataTransmitRates values. - 1.0
Channel unsignedInt­[0: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.

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

 - 1.4
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 a "password" for joining a particular radio network (BSS). Note: If an access point wishes to be known by more than one SSID, it MUST provide a WLANConfiguration instance for each SSID. - 1.0
BeaconType string W

The capabilities that are currently enabled on the access point (and that are announced via beacons if BeaconAdvertisementEnabled is true). Write access to this parameter enables and disables such capabilities.

An attempt to set this parameter to one of the REQUIRED (mandatory) values MAY be rejected if (and only if) the requested capability is not available on this WLANConfiguration instance but is available on another WLANConfiguration instance within this Internet Gateway Device. For example, only basic 802.11 might be supported by one virtual AP, and only WPA might be supported by another virtual AP.

A value of None means that no capabilities are currently enabled on the access point and that no stations will be able to associate with it. Enumeration of:

11i SHOULD be taken to refer to both the 802.11i specification and to the WPA2 specification (any WPA2-certified device will implement all mandatory parts of the 802.11i standard).

The OBSOLETED values are those for Basic + WPA/WPA2 mixed modes, which are not permitted by the WPA specifications.

 - 1.0
MACAddressControlEnabled boolean W Indicates whether MAC Address Control is enabled or not on this interface. MAC Address Control limits the clients that connect to those that match a list of allowed MAC addresses specified in InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.AllowedMACAddresses. - 1.0
Standard string -

Indicates which IEEE 802.11 standard this WLANConfiguration instance is configured for. Enumeration of:

  • a
  • b
  • g (b and g clients supported)
  • g-only (only g clients supported)
  • n

Where each value indicates support for only the indicated standard.

If the device is configured simultaneously for more than one standard, a separate WLANConfiguration instance MUST be used for each supported standard.

 - 1.0
WEPKeyIndex unsignedInt­[1:4] W The index of the default WEP key. - 1.0
KeyPassphrase string­(63) W

A passphrase from which the WEP keys are to be generated.

This parameter is the same as the parameter InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.PreSharedKey.1.KeyPassphrase for the same instance of WLANConfiguration. When either parameter is changed, the value of the other is changed as well.

If KeyPassphrase is written, all four WEP keys are immediately generated. The ACS SHOULD NOT set the passphrase and also set the WEP keys directly (the result of doing this is undefined).

This MUST either be a valid key length divided by 8, in which case each byte contributes 8 bits to the key, or else MUST consist of Hex digits and be a valid key length divided by 4, in which case each byte contributes 4 bits to the key.

Note: If a passphrase is used, all four WEP keys will be the same.

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

 - 1.0
WEPEncryptionLevel string­(64) -

Comma-separated list (maximum list length 64) of strings. Supported key lengths. Each list item is an enumeration of:

Any additional vendor-specific values MUST start with the key length in bits.

This parameter does not enforce a given encryption level but only indicates capabilities. The WEP encryption level for a given key is inferred from the key length.

 - 1.0
BasicEncryptionModes string W

Encryption modes that are available when basic 802.11 is enabled. WEPEncryption implies that all wireless clients can use WEP for data encryption. Enumeration of:

If this WLANConfiguration instance does not support basic 802.11 then this parameter MUST NOT be present in this instance of the WLANConfiguration object.

 - 1.0
BasicAuthenticationMode string W

Authentication modes that are available when basic 802.11 is enabled. Enumeration of:

If this WLANConfiguration instance does not support basic 802.11 then this parameter MUST NOT be present in this instance of the WLANConfiguration object.

 - 1.0
WPAEncryptionModes string W

Encryption modes that are available when WPA is enabled. Enumeration of:

If this WLANConfiguration instance does not support WPA then this parameter MUST NOT be present in this instance of the WLANConfiguration object.

The DEPRECATED values are those that combine WEP with TKIP and/or AES, which is not permitted by the WPA specifications.

 - 1.0
WPAAuthenticationMode string W

Authentication modes that are available when WPA is enabled. Enumeration of:

If this WLANConfiguration instance does not support WPA then this parameter MUST NOT be present in this instance of the WLANConfiguration object.

 - 1.0
IEEE11iEncryptionModes string W

Encryption modes that are available when 802.11i is enabled. Enumeration of:

If this WLANConfiguration instance does not support 802.11i then this parameter MUST NOT be present in this instance of the WLANConfiguration object.

IEEE11i SHOULD be taken to refer to both the 802.11i specification and to the WPA2 specification (any WPA2-certified device will implement all mandatory parts of the 802.11i standard).

The DEPRECATED values are those that combine WEP with TKIP and/or AES, which is not permitted by the WPA2 specifications.

 - 1.0
IEEE11iAuthenticationMode string W

Authentication modes that are available when 802.11i is enabled. Enumeration of:

If this WLANConfiguration instance does not support 802.11i then this parameter MUST NOT be present in this instance of the WLANConfiguration object.

IEEE11i SHOULD be taken to refer to both the 802.11i specification and to the WPA2 specification (any WPA2-certified device will implement all mandatory parts of the 802.11i standard).

 - 1.0
PossibleChannels string­(1024) -

Comma-separated list (maximum list length 1024) of strings. Possible radio channels for the wireless standard (a, b or g) and the regulatory domain.

Ranges in the form "n-m" are permitted.

For example, for 802.11b and North America, would be "1-11".

 - 1.0
BasicDataTransmitRates string­(256) W

Comma-separated list (maximum list length 256) of strings. Maximum access point data transmit rates in Mbps for unicast, multicast and broadcast frames.

For example, a value of "1,2", indicates that unicast, multicast and broadcast frames can be transmitted at 1 Mbps and 2 Mbps.

 - 1.0
OperationalDataTransmitRates string­(256) W

Comma-separated list (maximum list length 256) 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.

 - 1.0
PossibleDataTransmitRates string­(256) -

Comma-separated list (maximum list length 256) of strings. Data transmit rates 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, PossibleDataTransmitRates 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.

 - 1.0
InsecureOOBAccessEnabled boolean W Indicates whether insecure write access via mechanisms other than the CPE WAN Management Protocol is permitted to the parameters in this object. - 1.0
BeaconAdvertisementEnabled boolean W Indicates whether or not the access point is sending out beacons. - 1.0
SSIDAdvertisementEnabled boolean W

Indicates whether or not beacons include the SSID name.

This parameter has an effect only if BeaconAdvertisementEnabled is true.

 - 1.4
RadioEnabled boolean W Indicates whether or not the access point radio is enabled. - 1.0
TransmitPowerSupported string­(64) - Comma-separated list (maximum list length 64) of unsigned integers (value 0 to 100). Supported transmit power levels as percentages of full power. For example, "0,25,50,75,100". - 1.4
TransmitPower unsignedInt­[0: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. - 1.4
AutoRateFallBackEnabled boolean W Indicates whether the access point can automatically reduce the data rate in the event of undue noise or contention. - 1.0
LocationDescription string­(4096) W An XML description of information used to identify the access point by name and physical location. The CPE is not expected to parse this string, but simply to treat it as an opaque string. An empty string indicates no location has been set. - 1.0
RegulatoryDomain string­(3) W 802.11d Regulatory Domain String. First two octets are ISO/IEC 3166-1 two-character country code. The third octet is either " " (all environments), "O" (outside) or "I" (inside). - 1.0
TotalPSKFailures unsignedInt - The number of times pre-shared key (PSK) authentication has failed (relevant only to WPA and 802.11i). - 1.0
TotalIntegrityFailures unsignedInt - The number of times the MICHAEL integrity check has failed (relevant only to WPA and 802.11i) - 1.0
ChannelsInUse string­(1024) -

Comma-separated list (maximum list length 1024) of strings. Channels that the access point determines to be currently in use (including any that it is using itself).

Ranges in the form "n-m" are permitted.

 - 1.0
DeviceOperationMode string W

The current access-point operating mode. The OPTIONAL modes permit the AP to be configured as a wireless bridge (to bridge two wired networks), repeater (a bridge that also serves wireless clients), or wireless station. Ad hoc stations are not supported. Enumeration of:

 - 1.0
DistanceFromRoot unsignedInt W The number of hops from the root access point to the wireless repeater or bridge. - 1.0
PeerBSSID string W The MAC address of the peer in wireless repeater or bridge mode. - 1.0
AuthenticationServiceMode string W

Indicates whether another service is involved in client authentication (LinkAuthentication for a co-located authentication server; RadiusClient for an external RADIUS server). Enumeration of:

 - 1.0
WMMSupported boolean - Indicates whether this interface supports WiFi Multimedia (WMM) Access Categories (AC). - 1.4
UAPSDSupported boolean -

Indicates whether this interface supports WMM Unscheduled Automatic Power Save Delivery (U-APSD).

Note: U-APSD support implies WMM support.

 - 1.4
WMMEnable boolean W Whether WMM support is currently enabled. When enabled, this is indicated in beacon frames - 1.4
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.

 - 1.4
TotalBytesSent unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.0
TotalBytesReceived unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.0
TotalPacketsSent unsignedInt -

The total number of packets transmitted out of the interface.

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.0
TotalPacketsReceived unsignedInt -

The total number of packets which were received on this interface.

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.0
TotalAssociations unsignedInt - The number of devices currently associated with the access point. This corresponds to the number of entries in the AssociatedDevice table. - 1.0
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.AssociatedDevice.{i}. object -

A table of the devices currently associated with the access point. The size of this table is given by InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.TotalAssociations. This object MUST be implemented for CPE that contain an 802.11 interface on the LAN side.

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

 - 1.0
AssociatedDeviceMACAddress string­(17) - [MACAddress] The MAC address of an associated device. - 1.0
AssociatedDeviceIPAddress string­(64) - The IP address or DNS name of an associated device. - 1.0
AssociatedDeviceAuthenticationState boolean - Whether an associated device has authenticated (true) or not (false). - 1.0
LastRequestedUnicastCipher string­(256) - The unicast cipher that was most recently used for a station with a specified MAC address (802.11i only). - 1.0
LastRequestedMulticastCipher string­(256) - The multicast cipher that was most recently used for a station with a specified MAC address (802.11i only). - 1.0
LastPMKId string­(256) - The pairwise master key (PMK) that was most recently used for a station with a specified MAC address (802.11i only). - 1.0
LastDataTransmitRate string­(4) - The data transmit rate that was most recently used for a station with a specified MAC address. - 1.4
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.WEPKey.{i}. object -

This is a table of WEP keys. The size of this table is fixed with exactly 4 entries (with instance numbers 1 through 4). This object MUST be implemented for CPE that contain an 802.11 interface on the LAN side.

This table MUST contain exactly 4 entries.

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

 - 1.0
Alias string­(64) W

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

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

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

A WEP key expressed as a hexadecimal string.

The WEP encryption level for a given key is inferred from the key length, e.g. 10 characters for 40-bit encryption, or 26 characters for 104-bit encryption (keys do not all have to be of the same length, although they will be if the CPE uses InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.KeyPassphrase to generate them).

If InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.KeyPassphrase is written, all four WEP keys are immediately generated. The ACS SHOULD NOT set the passphrase and also set the WEP keys directly (the result of doing this is undefined).

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

 - 1.0
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.PreSharedKey.{i}. object -

This is a table of preshared keys. The size of this table is fixed with exactly 10 entries (with instance numbers 1 through 10). This object MUST be implemented for CPE that contain an 802.11 interface on the LAN side.

This table MUST contain exactly 10 entries.

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

 - 1.0
Alias string­(64) W

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

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

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

A literal WPA PSK expressed as a hexadecimal string.

The first table entry contains the default PreSharedKey (InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.PreSharedKey.1.PreSharedKey).

If KeyPassphrase is written, the PSK is immediately generated. The ACS SHOULD NOT set the passphrase and also set the PSK directly (the result of doing this is undefined).

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

 - 1.0
KeyPassphrase string­(63) W

A passphrase from which the PSK is to be generated.

The first table entry is the same as the parameter InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.KeyPassphrase for the same instance of WLANConfiguration. When either parameter is changed, the value of the other is changed as well.

If KeyPassphrase is written, the PSK is immediately generated. The ACS SHOULD NOT set the passphrase and also set the PSK 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 (RFC 2898 [RFC2898]).

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

 - 1.0
AssociatedDeviceMACAddress string­(17) W [MACAddress] The MAC address associated with a preshared key, or an empty string if no MAC address is associated with the key. - 1.0
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.Stats. object -

This object contains statistics for an 802.11 LAN interface on a CPE device.

Note that these statistics refer to the link layer, not to the physical layer.

Note that this object does not include the total byte and packet statistics, which are, for historical reasons, in the parent object.

 - 1.4
ErrorsSent unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
ErrorsReceived unsignedInt -

The total number of inbound packets that contained errors preventing them from being deliverable.

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
UnicastPacketsSent unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
UnicastPacketsReceived unsignedInt -

The total number of received packets which were not addressed to a multicast or broadcast address.

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
DiscardPacketsSent unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
DiscardPacketsReceived unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
MulticastPacketsSent unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
MulticastPacketsReceived unsignedInt -

The total number of received packets which were addressed to a multicast address.

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
BroadcastPacketsSent unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
BroadcastPacketsReceived unsignedInt -

The total number of received packets which were addressed to a broadcast address.

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
UnknownProtoPacketsReceived unsignedInt -

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

The value of this counter MAY be reset to zero when the CPE is rebooted.

 - 1.4
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.WPS. object - This object contains parameters related to WPS (Wi-Fi Protected Setup) [WPSv1.0] that apply to a CPE acting as an Access Point. - 1.4
Enable boolean W Enables or disables WPS functionality for this interface. - 1.4
DeviceName string­(32) -

User-friendly description of the device.

This parameter corresponds directly to the "Device Name" attribute of the WPS specification [WPSv1.0].

 - 1.4
DevicePassword unsignedInt W

Represents the DevicePassword used (commonly known as PIN).

This parameter corresponds directly to the "Device Password" attribute of the WPS specification [WPSv1.0].

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

 - 1.4
UUID string­(36) -

UUID of the device. This is represented as specified in RFC 4122 [RFC4122] but omitting the leading "urn:uuid:", e.g. "f81d4fae-7dec-11d0-a765-00a0c91e6bf6".

This parameter corresponds directly to the "UUID-E" (enrollee) and "UUID-R" (registrar) attributes of the WPS specification [WPSv1.0]. Note that if the Access Point can act both as an enrollee and as a registrar then UUID-E and UUID-R will be the same as each other. Possible patterns:

 - 1.4
Version unsignedInt -

The Wi-Fi Protected Setup version supported by the device.

This parameter corresponds directly to the "Version" attribute of the WPS specification [WPSv1.0].

 - 1.4
ConfigMethodsSupported string -

Comma-separated list of strings. WPS configuration methods supported by the device. Each list item is an enumeration of:

This parameter corresponds directly to the "Config Methods" attribute of the WPS specification [WPSv1.0].

 - 1.4
ConfigMethodsEnabled string W Comma-separated list of strings. Each list item MUST be a member of the list reported by the ConfigMethodsSupported parameter. WPS configuration methods enabled on the device. This parameter corresponds directly to the "Permitted Config Methods" attribute of the WPS specification [WPSv1.0]. - 1.4
SetupLockedState string -

Indicates if the AP Setup mode is enabled for configuration of the AP through an external registrar. The AP Setup mode can be disabled by the user, by the remote management or in case of a brute force attack against the AP's PIN (Wrong PIN provided to AP multiple times). Enumeration of:

This parameter corresponds directly to the "AP Setup Locked" attribute of the WPS specification [WPSv1.0]. The factory default setting is Unlocked.

 - 1.4
SetupLock boolean W

When set to true, the Access Point will refuse to accept new external registrars; already established registrars will continue to be able to add new enrollees (the SetupLockedState becomes LockedByRemoteManagement).

When set to false, the Access Point is enabled for configuration through an external registrar (the SetupLockedState becomes Unlocked).

The factory default setting is false.

 - 1.4
ConfigurationState string -

Description of the WPS status on the Wireless Access Point side. Enumeration of:

  • Not configured (WLAN interface is unconfigured: out-of-the box configuration)
  • Configured (WLAN interface is configured)

This parameter corresponds directly to the "Wi-Fi Protected Setup State" attribute of the WPS specification [WPSv1.0].

 - 1.4
LastConfigurationError string -

Shows the result of the last external registrar attempt to configure the Access Point. Enumeration of:

If no external registrar has yet attempted to configure the Access Point, this parameter MUST have the value NoError. The value of this parameter MUST persist across CPE reboots.

This parameter corresponds directly to the "Configuration Error" attribute of the WPS specification [WPSv1.0].

 - 1.4
RegistrarNumberOfEntries unsignedInt -

Number of entries in the Registrar table: number of Registrars that currently have an association with the Access Point.

This parameter corresponds directly to the "Registrar Current" attribute of the WPS specification [WPSv1.0].

 - 1.4
RegistrarEstablished boolean -

true if the Access Point has ever previously created an association with a Registrar.

This parameter corresponds directly to the "Registrar Established" attribute of the WPS specification [WPSv1.0]. The factory default setting is false.

 - 1.4
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.WPS.Registrar.{i}. object -

This table lists the Registrars associated with the Access Point.

This table MUST persist across CPE reboots. The registrar UUID is the unique key.

This object corresponds directly to the "Registrar List" attribute of the WPS specification [WPSv1.0].

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

 - 1.4
Enable boolean W If true, the registrar can be used by the Access Point for WPS procedures. - 1.4
Alias string­(64) W

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

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

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

UUID of the registrar. This is represented as specified in RFC 4122 [RFC4122] but omitting the leading "urn:uuid:", e.g. f81d4fae-7dec-11d0-a765-00a0c91e6bf6.

This parameter corresponds directly to the "UUID-R" attribute of the WPS specification [WPSv1.0]. Possible patterns:

 - 1.4
DeviceName string­(32) -

Device Name of the registrar.

This parameter corresponds directly to the "Device Name" attribute of the WPS specification [WPSv1.0].

 - 1.4
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.APWMMParameter.{i}. object -

This is a table of WMM parameters for traffic that originates at the wireless access point, i.e. for outgoing traffic. The size of this table is fixed, with 4 entries (with instance numbers 1 through 4). Instance numbers MUST be assigned as follows:

  1. BE AC (Best Effort)
  2. BK AC (Background)
  3. VI AC (Video)
  4. VO AC (Voice)

This table MUST contain exactly 4 entries.

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

 - 1.4
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
AIFSN unsignedInt­[2:15] W Arbitration Inter Frame Spacing (Number). This is the number of time slots in the arbitration interframe space. - 1.4
ECWMin unsignedInt­[0:15] W

Exponent of Contention Window (Minimum). This encodes the Values of CWMin as an exponent: CWMin = 2^ECWMin - 1.

For example, if ECWMin is 8, then CWMin is 2^8 - 1, or 255,

 - 1.4
ECWMax unsignedInt­[0:15] W

Exponent of Contention Window (Maximum). This encodes the Values of CWMax as an exponent: CWMax = 2^ECWMax - 1.

For example, if ECWMax is 8, then CWMax is 2^8 - 1, or 255,

 - 1.4
TXOP unsignedInt­[0:255] W Transmit Opportunity, in multiples of 32 microseconds. - 1.4
AckPolicy boolean W Ack Policy, where false=Do Not Acknowledge and true=Acknowledge. - 1.4
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.STAWMMParameter.{i}. object -

This is a table of WMM parameters for traffic that originates at the wireless station, i.e. for incoming traffic. The size of this table is fixed, with 4 entries (with instance numbers 1 through 4). Instance numbers MUST be assigned as follows:

  1. BE AC (Best Effort)
  2. BK AC (Background)
  3. VI AC (Video)
  4. VO AC (Voice)

This table MUST contain exactly 4 entries.

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

 - 1.4
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
AIFSN unsignedInt­[2:15] W Arbitration Inter Frame Spacing (Number). This is the number of time slots in the arbitration interframe space. - 1.4
ECWMin unsignedInt­[0:15] W

Exponent of Contention Window (Minimum). This encodes the Values of CWMin as an exponent: CWMin = 2^ECWMin - 1.

For example, if ECWMin is 8, then CWMin is 2^8 - 1, or 255,

 - 1.4
ECWMax unsignedInt­[0:15] W

Exponent of Contention Window (Maximum). This encodes the Values of CWMax as an exponent: CWMax = 2^ECWMax - 1.

For example, if ECWMax is 8, then CWMax is 2^8 - 1, or 255,

 - 1.4
TXOP unsignedInt­[0:255] W Transmit Opportunity, in multiples of 32 microseconds. - 1.4
AckPolicy boolean W Ack Policy, where false=Do Not Acknowledge and true=Acknowledge. - 1.4
InternetGatewayDevice.LANDevice.{i}.Hosts. object - 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. - 1.0
HostNumberOfEntries unsignedInt - Number of entries in the Host table. - 1.0
InternetGatewayDevice.LANDevice.{i}.Hosts.Host.{i}. object -

Host table.

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

 - 1.0
IPAddress string­(45) - [IPAddress] Current IP Address of the host. - 1.0
AddressSource string -

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:

 - 1.0
LeaseTimeRemaining int­[-1:] - 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. - 1.0
MACAddress string­(17) - [MACAddress] MAC address of the host. - 1.0
Layer2Interface string­(256) -

This parameter is the full hierarchical parameter name of a particular LAN**InterfaceConfig object or a WLANConfiguration object. For example: InternetGatewayDevice.LANDevice.1.LANEthernetInterfaceConfig.2.

In the case of an embedded Ethernet switch, the Layer2Interface parameter references the LANEthernetInterfaceConfig object that corresponds to the switch port the device is connected to (a LANEthernetInterfaceConfig instance for each switch port).

In the case of an embedded WLAN access point, the Layer2Interface parameter references the WLANConfiguration object that corresponds to the SSID the device is connected to (if the access point supports multiple SSIDs, then each SSID is a separate instance).

 - 1.4
VendorClassID string­(256) -

Vendor Class Identifier DHCP option (Option 60) of the host.

It MAY be defined when AddressSource is DHCP. An empty string indicates this option is not used.

 - 1.4
ClientID string­(256) -

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.

 - 1.4
UserClassID string­(256) -

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.

 - 1.4
HostName string­(64) - The device's host name or an empty string if unknown. - 1.0
InterfaceType string -

Type of physical interface through which this host is connected to the CPE. Enumeration of:

 - 1.0
Active boolean -

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, this variable 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.

 - 1.0
InternetGatewayDevice.LANInterfaces. object - This object contains LAN-side layer 1/2 interfaces that are not currently connected to the Gateway's IP router and which therefore do not currently reside within a LANDevice instance. - 1.4
LANEthernetInterfaceNumberOfEntries unsignedInt - Number of instances of LANEthernetInterfaceConfig in this object. - 1.4
LANUSBInterfaceNumberOfEntries unsignedInt - Number of instances of LANUSBInterfaceConfig in this object. - 1.4
LANWLANConfigurationNumberOfEntries unsignedInt - Number of instances of WLANConfiguration in this object object. - 1.4
InternetGatewayDevice.LANInterfaces.LANEthernetInterfaceConfig.{i}. object -

This object models an Ethernet LAN connection on a CPE device.

The object definition is identical to that for InternetGatewayDevice.LANDevice.{i}.LANEthernetInterfaceConfig.{i}.

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

 - 1.4
Alias string­(64) W

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

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

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

This object models a USB LAN connection on a CPE device.

The object definition is identical to that for InternetGatewayDevice.LANDevice.{i}.LANUSBInterfaceConfig.{i}.

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

 - 1.4
Alias string­(64) W

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

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

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

This object models an 802.11 LAN connection on a CPE device.

The object definition is identical to that for InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.

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

 - 1.4
Alias string­(64) W

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

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

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

Each instance contains all objects associated with a particular physical WAN interface.

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

 - 1.0
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
WANConnectionNumberOfEntries unsignedInt - Number of instances of WANConnectionDevice in this WANDevice. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANCommonInterfaceConfig. object - This object models WAN interface properties common across all connection instances. - 1.0
EnabledForInternet boolean W Used to enable or disable access to and from the Internet across all connection instances. - 1.0
WANAccessType string -

Specifies the WAN access (modem) type. Enumeration of:

 - 1.0
Layer1UpstreamMaxBitRate unsignedInt -

Specifies the maximum upstream theoretical bit rate for the WAN device in bits per second. This describes the maximum possible rate given the type of interface assuming the best-case operating environment, regardless of the current operating rate.

For example, if the physical interface is 100BaseT, this value would be 100000000, regardless of the current operating rate.

 - 1.0
Layer1DownstreamMaxBitRate unsignedInt -

Specifies the maximum downstream theoretical bit rate for the WAN device in bits per second. This describes the maximum possible rate given the type of interface assuming the best-case operating environment, regardless of the current operating rate.

For example, if the physical interface is 100BaseT, this value would be 100000000, regardless of the current operating rate.

 - 1.0
PhysicalLinkStatus string -

Indicates the state of the physical connection (link) from WANDevice to a connected entity. Enumeration of:

 - 1.0
WANAccessProvider string­(256) - Name of the Service Provider providing link connectivity on the WAN. - 1.0
TotalBytesSent unsignedInt - The cumulative counter for total number of bytes sent upstream across all connection service instances on the WAN device. - 1.0
TotalBytesReceived unsignedInt - The cumulative counter for total number of bytes received downstream across all connection service instances on the WAN device. - 1.0
TotalPacketsSent unsignedInt - The cumulative counter for total number of packets (IP or PPP) sent upstream across all connection service instances on the WAN device. - 1.0
TotalPacketsReceived unsignedInt - The cumulative counter for total number of packets (IP or PPP) received downstream across all connection service instances on the WAN device. - 1.0
MaximumActiveConnections unsignedInt - Indicates the maximum number of active connections the CPE can simultaneously support. - 1.0
NumberOfActiveConnections unsignedInt - Number of WAN connection service instances currently active on this WAN interface. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANCommonInterfaceConfig.Connection.{i}. object -

Active connection table.

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

 - 1.0
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
ActiveConnectionDeviceContainer string­(256) - Specifies a WAN connection device object associated with this connection instance. The content is the full hierarchical parameter name of the WAN connection device. Example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2. - 1.0
ActiveConnectionServiceID string­(256) - Specifies a WAN connection object associated with this connection instance. The content is the full hierarchical parameter name of the layer 3 connection object. Example: InternetGatewayDevice.WANDevice.1.WANConnectionDevice.2.WANPPPConnection.1. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig. object - This object models physical layer properties specific to a single physical connection of a DSL modem used for Internet access on a CPE. This object is required for a CPE with a DSL modem WAN interface, and is exclusive of any other WAN*InterfaceConfig object within a given WANDevice instance. - 1.0
Enable boolean W Enables or disables the link. - 1.0
Status string -

Status of the DSL physical link. Enumeration of:

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

 - 1.0
LinkEncapsulationSupported string -

Comma-separated list of strings. Indicates which link encapsulation standards and recommendations are supported by the B-NT. Each list item is an enumeration of:

 - 1.4
LinkEncapsulationRequested string W The value MUST be a member of the list reported by the LinkEncapsulationSupported parameter. Indicates the link encapsulation standard requested by the B-NT. - 1.4
LinkEncapsulationUsed string -

Indicates the link encapsulation standard that the B-NT is using for the connection. Enumeration of:

When the standard identifies ATM encapsulation then the InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANDSLLinkConfig object MUST be used.

When the standard identifies PTM encapsulation then the InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPTMLinkConfig object MUST be used.

 - 1.4
ModulationType string -

Indicates the type of modulation used on the connection. Enumeration of:

This parameter, which was inherited from WANDSLLinkConfig, is DEPRECATED because it is in general not clear which standards correspond to which of the the above enumerated values.

It is RECOMMENDED that the StandardUsed parameter be used to indicate which standard is in use.

 - 1.0
StandardsSupported string -

Comma-separated list of strings. Indicates which DSL standards and recommendations are supported by the B-NT. Each list item is an enumeration of:

 - 1.4
StandardUsed string - The value MUST be a member of the list reported by the StandardsSupported parameter. Indicates the standard that the B-NT is using for the connection. - 1.4
LineEncoding string -

The line encoding method used in establishing the Layer 1 DSL connection between the CPE and the DSLAM. Note: Generally speaking, this variable does not change after provisioning. Enumeration of:

 - 1.0
AllowedProfiles string -

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

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

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be an empty string.

 - 1.4
CurrentProfile string -

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

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be an empty string.

 - 1.4
PowerManagementState string -

The power management state of the line. Enumeration of:

 - 1.4
SuccessFailureCause unsignedInt­[0:5] -

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.
- 1.4
LastStateTransmittedDownstream unsignedInt -

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

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

 - 1.4
LastStateTransmittedUpstream unsignedInt -

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

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

 - 1.4
UPBOKLE unsignedInt­[0:1280] - This parameter contains the estimated electrical loop length expressed in dB at 1MHz, kle (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. - 1.4
MREFPSDds base64­(145) - This parameter SHALL contain the set of breakpoints exchanged in the MREFPSDds fields of the O-PRM message of G.993.2. Base64 encoded of the binary representation defined in Table 12-19/G.993.2 (maximum length is 145 octets, which requires 196 bytes for Base64 encoding). - 1.4
MREFPSDus base64­(145) - This parameter SHALL contain the set of breakpoints exchanged in the MREFPSDus fields of the R-PRM message of G.993.2. Base64 encoded of the binary representation defined in Table 12-19/G.993.2 (maximum length is 145 octets, which requires 196 bytes for Base64 encoding). - 1.4
LIMITMASK unsignedInt -

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

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

 - 1.4
US0MASK unsignedInt -

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

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

 - 1.4
DataPath string -

Indicates whether the data path is fast (lower latency) or interleaved (lower error rate). Enumeration of:

Note1: This parameter is only applicable to G.992.1.

Note2: For an ADSL1-capable multimode device operating in a mode other than ADSL1, the value of this parameter SHOULD be set to None.

 - 1.0
InterleaveDepth unsignedInt - ADSL1 Interleaved depth. This variable is only applicable to ADSL1 and only if DataPath = Interleaved. Otherwise, the value of this parameter MUST be zero. - 1.0
LPATH unsignedInt -

Reports the index of the latency path supporting the bearer channel. For single-latency connections, LPATH = 0.

Note: See ITU-T Recommendation G.997.1.

 - 1.4
INTLVDEPTH int -

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

 - 1.4
INTLVBLOCK int -

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

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

 - 1.4
ActualInterleavingDelay unsignedInt -

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

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

 - 1.4
ACTINP int -

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

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

 - 1.4
INPREPORT boolean -

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

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

 - 1.4
NFEC int -

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

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

 - 1.4
RFEC int -

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

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

 - 1.4
LSYMB int -

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

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

 - 1.4
TRELLISds int -

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

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

 - 1.4
TRELLISus int -

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

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

 - 1.4
ACTSNRMODEds unsignedInt -

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

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

 - 1.4
ACTSNRMODEus unsignedInt -

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

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

 - 1.4
VirtualNoisePSDds base64­(97) -

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

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

 - 1.4
VirtualNoisePSDus base64­(49) -

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

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

 - 1.4
ACTUALCE unsignedInt -

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

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

 - 1.4
LineNumber int­[1:] - Signifies the line pair that the modem is using to connection. LineNumber = 1 is the innermost pair. - 1.0
UpstreamCurrRate unsignedInt -

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

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 4294967295 (the maximum for its data type).

 - 1.0
DownstreamCurrRate unsignedInt -

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

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 4294967295 (the maximum for its data type).

 - 1.0
UpstreamMaxRate unsignedInt -

The current attainable rate (expressed in Kbps) of the upstream DSL channel.

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.

 - 1.0
DownstreamMaxRate unsignedInt -

The current attainable rate (expressed in Kbps) of the downstream DSL channel.

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.

 - 1.0
UpstreamNoiseMargin int -

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

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

 - 1.0
DownstreamNoiseMargin int -

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

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

 - 1.0
SNRMpbus string­(24) -

Comma-separated list (maximum list length 24) of strings. 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.

 - 1.4
SNRMpbds string­(24) -

Comma-separated list (maximum list length 24) of strings. 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.

 - 1.4
INMIATOds unsignedInt­[3:511] -

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

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

 - 1.4
INMIATSds unsignedInt­[0:7] -

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

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

 - 1.4
INMCCds unsignedInt­[0:64] -

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

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

 - 1.4
INMINPEQMODEds unsignedInt­[0:3] -

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

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

 - 1.4
UpstreamAttenuation int - The current upstream signal loss (expressed in 0.1 dB). - 1.0
DownstreamAttenuation int - The current downstream signal loss (expressed in 0.1 dB). - 1.0
UpstreamPower int - The current output power at the CPE's DSL interface (expressed in 0.1 dBmV). - 1.0
DownstreamPower int - The current received power at the CPE's DSL interface (expressed in 0.1 dBmV). - 1.0
ATURVendor string­(8) -

ATU-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".

 - 1.0
ATURCountry string­(4) -

T.35 country code of the ATU-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".

 - 1.0
ATURANSIStd unsignedInt -

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

 - 1.0
ATURANSIRev unsignedInt -

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

 - 1.0
ATUCVendor string­(8) -

ATU-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".

 - 1.0
ATUCCountry string­(4) -

T.35 country code of the ATU-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".

 - 1.0
ATUCANSIStd unsignedInt -

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

 - 1.0
ATUCANSIRev unsignedInt -

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

 - 1.0
TotalStart unsignedInt -

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.

 - 1.0
ShowtimeStart unsignedInt -

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.

 - 1.0
LastShowtimeStart unsignedInt -

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.

 - 1.0
CurrentDayStart unsignedInt -

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 does not have to do so.

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

 - 1.0
QuarterHourStart unsignedInt -

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 does not have to do so.

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

 - 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats. object - This object contains statistics for a WAN DSL physical interface. - 1.0