Broadband Forum

TR-069 InternetGatewayDevice:1.12 Root Object definition

tr-098-1-6-0.xml

DATA MODEL DEFINITION

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.

Data Types

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

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

Data Type Base Type Description
base64 -

Base64 encoded binary (no line-length limitation).

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

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

Hex encoded binary.

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

int -

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

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

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.

Alias string(:64)

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

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

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

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])*
UUID string(36)

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

  • [*[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}*

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.
[HTML4.01] HTML 4.01 Specification, W3C.
[IANA-uri-schemes] IANA Uniform Resource Identifier (URI) Schemes Registry, Uniform Resource Identifier (URI) Schemes, IANA.
[ICSA-Baseline] ICSA Baseline Modular Firewall Certification Criteria, Baseline module - version 4.1, ICSA Labs, 2008.
[ICSA-Residential] ICSA Residential Modular Firewall Certification Criteria, Required Services Security Policy - Residential Category module - version 4.1, ICSA Labs, 2008.
[IEEE_EUI64] Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, IEEE, March 1997.
[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.
[OUI] Organizationally Unique Identifiers (OUIs).
[RED] References on RED (Random Early Detection) Queue Management.
[RFC1035] RFC 1035, Domain Names - Implementation and Specification, IETF, 1987.
[RFC1323] RFC 1323, TCP Extensions for High Performance, IETF, May 1992.
[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.
[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.
[RFC4007] RFC 4007, IPv6 Scoped Address Architecture, IETF.
[RFC4122] RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.
[RFC4291] RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006.
[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.
[RFC7159] RFC7159, The JavaScript Object Notation (JSON) Data Interchange Format, IETF, March 2014.
[RFC7230] RFC 7230, Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing, IETF, June 2014.
[RFC7252] RFC 7252, The Constrained Application Protocol (CoAP), IETF, June 2014.
[RFC793] RFC 793, Transmission Control Protocol, IETF, September 1981.
[RFC8141] RFC 8141, Uniform Resource Names (URNs), IETF, April 2017.
[RFC862] RFC 862, Echo Protocol, IETF, 1983.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-069] TR-069 Amendment 6, CPE WAN Management Protocol, Broadband Forum, April 2018.
[TR-069a2] TR-069 Amendment 2, CPE WAN Management Protocol, Broadband Forum, December 2007.
[TR-069a3] TR-069 Amendment 3, CPE WAN Management Protocol, Broadband Forum, November 2010.
[TR-069a4] TR-069 Amendment 4, CPE WAN Management Protocol, Broadband Forum, July 2011.
[TR-098] TR-098 Amendment 2 Corrigendum 1, Internet Gateway Device Data Model for TR-069, Broadband Forum, December 2014.
[TR-098a1] TR-098 Amendment 1, Internet Gateway Device Data Model for TR-069, Broadband Forum, December 2006.
[TR-098a2] TR-098 Amendment 2, Internet Gateway Device Data Model for TR-069, Broadband Forum, September 2008.
[TR-106a1] TR-106 Amendment 1, Data Model Template for TR-069-Enabled Devices, Broadband Forum, November 2006.
[TR-106a2] TR-106 Amendment 2, Data Model Template for TR-069-Enabled Devices, Broadband Forum, November 2008.
[TR-106a3] TR-106 Amendment 3, Data Model Template for TR-069-Enabled Devices, Broadband Forum, September 2009.
[TR-106a4] TR-106 Amendment 4, Data Model Template for TR-069-Enabled Devices, Broadband Forum, February 2010.
[TR-106a6] TR-106 Amendment 6, Data Model Template for TR-069-Enabled Devices, Broadband Forum, July 2011.
[TR-143] TR-143 Amendment 1 Corrigendum 1, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, August 2015.
[TR-157] TR-157 Amendment 10, Component Objects for CWMP, Broadband Forum, November 2015.
[TR-157a3] TR-157 Amendment 3, Component Objects for CWMP, Broadband Forum, November 2010.
[TR-157a5] TR-157 Amendment 5, Component Objects for CWMP, Broadband Forum, November 2011.
[TR-181i1] TR-181 Issue 1, Device Data Model for TR-069, Broadband Forum, February 2010.
[TR-181i2] TR-181 Issue 2 Amendment 15, Device Data Model, Broadband Forum, January 2022.
[TR-196i2] TR-196 Issue 2, Femto Access Point Service Data Model, Broadband Forum, November 2011.
[TR-232] TR-232, Bulk Data Collection, Broadband Forum, May 2012.
[TR-262] TR-262, Femto Component Objects, Broadband Forum, November 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.

Legend

Object definition.
Parameter definition.

InternetGatewayDevice:1.12 Data Model

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

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

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.0
LANDeviceNumberOfEntries unsignedInt R Number of instances of LANDevice. - 1.0
WANDeviceNumberOfEntries unsignedInt R Number of instances of WANDevice. - 1.0
UserNumberOfEntries unsignedInt R The number of entries in the User table. - 1.0
SmartCardReaderNumberOfEntries unsignedInt R The number of entries in the SmartCardReader table. - 1.0
InternetGatewayDevice.Services. object R This object contains general services information. - 1.0
InternetGatewayDevice.DeviceInfo. object R This object contains general device information. - 1.0
Manufacturer string(:64) R The manufacturer of the CPE (human readable string). - 1.0
ManufacturerOUI string(6) R

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

  • [0-9A-F]{6} The value MUST be a valid OUI as defined in [OUI]. This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it’s a new device and would therefore require a BOOTSTRAP Inform.
- 1.0
ModelName string(:64) R Model name of the CPE (human readable string). - 1.0
Description string(:256) R A full description of the CPE device (human readable string). - 1.0
ProductClass string(:64) R Identifier of the class of product for which the serial number applies. That is, for a given manufacturer, this parameter is used to identify the product or class of product over which the SerialNumber parameter is unique. This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it’s a new device and would therefore require a BOOTSTRAP Inform. - 1.0
SerialNumber string(:64) R Identifier of the particular device that is unique for the indicated class of product and manufacturer. This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it’s a new device and would therefore require a BOOTSTRAP Inform. - 1.0
HardwareVersion string(:64) R A string identifying the particular CPE model and version. - 1.0
SoftwareVersion string(:64) R 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) R 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) R 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 number of characters 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) R Comma-separated list (maximum number of characters 64) of strings. Any additional hardware version information the vendor might wish to supply. - 1.0
AdditionalSoftwareVersion string[](:64) R Comma-separated list (maximum number of characters 64) of strings. Any additional software version information the vendor might wish to supply. - 1.0
SpecVersion string(:16) R 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 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 R Time in seconds since the CPE was last restarted. - 1.0
FirstUseDate dateTime R

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

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

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

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

This table of Vendor Configuration Files is for information only and does not allow the ACS to operate on these files in any way. Whenever the CPE successfully downloads a configuration file as a result of the Download RPC with the FileType argument of 3 Vendor Configuration File, the CPE MUST update this table. 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

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

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

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

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

- 1.0
Name string(:64) R

Name of the vendor configuration file.

If the CPE is able to obtain the name of the configuration file from the file itself, then the value of this parameter MUST be set to that name. Otherwise, if the CPE can extract the file name from the URL used to download the configuration file, then the value of this parameter MUST be set to that name. Otherwise, the value of this parameter MUST be set to the value of the TargetFileName argument of the Download RPC used to download this configuration file.

- 1.0
Version string(:16) R

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

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

- 1.0
Date dateTime R Date and time when the content of the current version of this vendor configuration file was first applied by the CPE. - 1.0
Description string(:256) R A description of the vendor configuration file (human-readable string). - 1.0
InternetGatewayDevice.DeviceInfo.MemoryStatus. object R Status of the device’s volatile physical memory. - 1.0
Total unsignedInt R The total physical RAM, in kilobytes, installed on the device. - 1.0
Free unsignedInt R The free physical RAM, in kilobytes, currently available on the device. - 1.0
InternetGatewayDevice.DeviceInfo.ProcessStatus. object R Status of the processes on the device. - 1.0
CPUUsage unsignedInt(:100) R The total amount of the CPU, in percent, rounded up to the nearest whole percent. In the case that multiple CPU are present, this value represents the average of all CPU. - 1.0
ProcessNumberOfEntries unsignedInt R The number of entries in the Process table. Since a Process can come and go very quickly, the CPE SHOULD place a locally specified limit on the frequency at which it will notify the ACS of value changes, as described in [Section 3.2.1/TR-069a2]. - 1.0
InternetGatewayDevice.DeviceInfo.ProcessStatus.Process.{i}. object(0:) R

List of all processes running on the device.

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

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

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

  • Running
  • Sleeping
  • Stopped
  • Idle (OPTIONAL)
  • Uninterruptible (OPTIONAL)
  • Zombie (OPTIONAL)
- 1.0
InternetGatewayDevice.DeviceInfo.TemperatureStatus. object R Status of the temperature of the device. - 1.0
TemperatureSensorNumberOfEntries unsignedInt R The number of entries in the TemperatureSensor table. - 1.0
InternetGatewayDevice.DeviceInfo.TemperatureStatus.TemperatureSensor.{i}. object(0:) R

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

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

- 1.0
Alias string(:64) W

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

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

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

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

- 1.0
Enable boolean W Indicates whether or not the temperature sensor is enabled. - 1.0
Status string R

The status of this temperature sensor. Enumeration of:

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

When set to true, resets the temperature sensor.

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

- 1.0
ResetTime dateTime R The time at which this temperature sensor was reset. Reset can be caused by:
  • Status transition from Disabled to Enabled
  • Reset set to true.
  • An internal reset of the temperature sensor (including a reboot of the device). The Unknown Time value, as defined in [TR-106a2], indicates that this temperature sensor has never been reset, which can only happen if it has never been enabled.
- 1.0
Name string(:256) R Name of this temperature sensor. This text MUST be sufficient to distinguish this temperature sensor from other temperature sensors. - 1.0
Value int(-274:) R This temperature sensor’s last good reading in degrees celsius. A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset. - 1.0
LastUpdate dateTime R The time at which this temperature sensor’s last good reading was obtained. The Unknown Time value, as defined in [TR-106a2], indicates a good reading has not been obtained since last reset. - 1.0
MinValue int(-274:) R This temperature sensor’s lowest value reading in degrees celsius since last reset. A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset. - 1.0
MinTime dateTime R The time at which this temperature sensor’s lowest value was read. The Unknown Time value, as defined in [TR-106a2], indicates a good reading has not been obtained since last reset. - 1.0
MaxValue int(-274:) R This temperature sensor’s highest value reading in degrees celsius since last reset. A value of -274 (which is below absolute zero) indicates a good reading has not been obtained since last reset. - 1.0
MaxTime dateTime R The time at which this temperature sensor’s highest value was read. The Unknown Time value, as defined in [TR-106a2], indicates a good reading has not been obtained since last reset. - 1.0
LowAlarmValue int(-274:) W

This temperature sensor’s low alarm value in degrees celsius. A value of -274 (which is below absolute zero) indicates a non configured value.

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

- 1.0
LowAlarmTime dateTime R Initial time at which this temperature sensor’s LowAlarmValue was encountered. This value is only set the first time the alarm is seen and not changed until the next reset. The Unknown Time value, as defined in [TR-106a2], indicates that an alarm has not been encountered since the last reset. - 1.0
HighAlarmValue int(-274:) W

This temperature sensor’s high alarm value in degrees celsius. A value of -274 (which is below absolute zero) indicates a non configured value.

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

- 1.0
HighAlarmTime dateTime R Initial time at which this temperature sensor’s HighAlarmValue was encountered. This value is only set the first time the alarm is seen and not changed until the next reset. The Unknown Time value, as defined in [TR-106a2], indicates that an alarm has not been encountered since the last reset. - 1.0
PollingInterval unsignedInt W The interval, measured in seconds, in which the device polls this TemperatureSensor. If the value is 0 then the device selects its own polling interval. If the value is greater than 0 then the device MUST use this value as the polling interval. - 1.0
InternetGatewayDevice.DeviceInfo.NetworkProperties. object R This object defines the parameters that describe how the device handles network traffic. - 1.0
MaxTCPWindowSize unsignedInt R The maximum number of bytes of outstanding data a sender can send on a particular connection prior to an acknowledgment [RFC793]. Any scaling factor SHOULD be included in this parameter [RFC1323]. - 1.0
TCPImplementation string[] R

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

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

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

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

- 1.0
Alias string(:64) W

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

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

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

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

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

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

- 1.0
Alias string(:64) W

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

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

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

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

- 1.0
Architecture string R

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

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

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

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

- 1.0
Alias string(:64) W

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

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

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

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

- 1.0
Name string(:64) R Name of the log file. Typically this will be the full file system path, but provided that it is guaranteed to be unique across current and future log files, it MAY be a shorter name derived from the file system path, or be derived via another mechanism. - 1.0
MaximumSize unsignedInt R The maximum size of the log file in bytes. If the device doesn’t know the maximum file size then MaximumSize will be 0. - 1.0
Persistent boolean R When true, the log file contents are preserved across a device reboot. When false, the log file contents will be purged when the device is rebooted. - 1.0
InternetGatewayDevice.DeviceInfo.ProxierInfo. object R Represents the associated CPE Proxier for a Proxied Device that utilizes the Virtual CWMP Device Mechanism [Annex J.1.1/TR-069a4]. - 1.0
ManufacturerOUI string(6) R

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

  • [0-9A-F]{6} The value MUST be a valid OUI as defined in [OUI].
- 1.0
ProductClass string(:64) R Identifier of the class of product of the associated CPE Proxier for which the serial number applies. An empty string indicates either that the CPE Proxier does not use a product class to differentiate its serial number. - 1.0
SerialNumber string(:64) R Serial number of the associated CPE Proxier. - 1.0
ProxyProtocol string() R

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

  • Z-Wave (see [Z-Wave])
  • ZigBee (see [ZigBee])
  • UPnP-DM (see [UPnP-DM:1])
  • ETSI-M2M (see [ETSIM2MFA]) Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a6] MUST be adhered to.
- 1.0
InternetGatewayDevice.DeviceInfo.Location.{i}. object(0:) W

This object contains Location information.

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

- 1.0
Source string R

Identifies the source of the location data. Enumeration of:

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

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

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

- 1.0
ExternalProtocol string R

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

  • <Empty> (An empty string)
  • CWMP
  • OMA-DM
  • SNMP
  • UPnP
  • HELD
  • DHCPv4
  • DHCPv6
  • LLDP-MED
  • MLP
  • Other Meaningful only if Source has a value of External, otherwise it MUST be an empty string.
CWMP 1.0
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.0
InternetGatewayDevice.DeviceConfig. object R 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 R This object contains parameters relating to the CPE’s association with an ACS. - 1.0
EnableCWMP boolean W Enables and disables the CPE’s support for CWMP. false means that CWMP support in the CPE is disabled, in which case the device MUST NOT send any Inform messages to the ACS or accept any Connection Request notifications from the ACS. true means that CWMP support on the CPE is enabled. The 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.0
URL string(:256) W URL, as defined in [RFC3986], for the CPE to connect to the ACS using the CPE WAN Management Protocol. This parameter MUST be in the form of a valid HTTP or HTTPS URL [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) R ParameterKey provides the ACS a reliable and extensible means to track changes made by the ACS. The value of ParameterKey MUST be equal to the value of the ParameterKey argument from the most recent successful SetParameterValues, AddObject, or DeleteObject method call from the ACS. The CPE MUST set ParameterKey to the value specified in the corresponding method arguments if and only if the method completes successfully and no fault response is generated. If a method call does not complete successfully (implying that the changes requested in the method did not take effect), the value of ParameterKey MUST NOT be modified. The CPE MUST only modify the value of ParameterKey as a result of SetParameterValues, AddObject, DeleteObject, or due to a factory reset. On factory reset, the value of ParameterKey MUST be set to an empty string. - 1.0
ConnectionRequestURL string(:256) R HTTP URL, as defined in [RFC3986], for an ACS to make a Connection Request notification to the CPE. In the form: http://host:port/path The host portion of the URL MAY be the IP address for the management interface of the CPE in lieu of a host name. - 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) R Present only for a CPE that supports the Kicked RPC method. LAN-accessible URL, as defined in [RFC3986], from which the CPE can be “kicked” to initiate the Kicked RPC method call. MUST be an absolute URL including a host name or IP address as would be used on the LAN side of the CPE. - 1.0
DownloadProgressURL string(:256) R Present only for a CPE that provides a LAN-side web page to show progress during a file download. LAN-accessible URL, as defined in [RFC3986], to which a web-server associated with the ACS MAY redirect a user’s browser on initiation of a file download to observer the status of the download. - 1.0
DefaultActiveNotificationThrottle unsignedInt W This parameter is used to control throttling of active notifications sent by the CPE to the ACS. It defines the minimum number of seconds that the CPE MUST wait since the end of the last session with the ACS before establishing a new session for the purpose of delivering an active notification. In other words, if CPE needs to establish a new session with the ACS for the sole purpose of delivering an active notification, it MUST delay establishing such a session as needed to ensure that the minimum time since the last session completion has been met. The time is counted since the last successfully completed session, regardless of whether or not it was used for active notifications or other purposes. However, if connection to the ACS is established for purposes other than just delivering active notifications, including for the purpose of retrying a failed session, such connection MUST NOT be delayed based on this parameter value, and the pending active notifications MUST be communicated during that connection. The time of the last session completion does not need to be tracked across reboots. - 1.0
UDPConnectionRequestAddress string(:256) R Address and port to which an ACS MAY send a UDP Connection Request to the CPE (see [Annex G/TR-069a2]). This parameter is represented in the form of an Authority element as defined in [RFC3986]. The value MUST be in one of the following two forms:
  • host:port
  • host When STUNEnable is true, the host and port portions of this parameter MUST represent the public address and port corresponding to the NAT binding through which the ACS can send UDP Connection Request messages (once this information is learned by the CPE through the use of STUN). When STUNEnable is false, the host and port portions of the URL MUST represent the local IP address and port on which the CPE is listening for UDP Connection Request messages. The second form of this parameter MAY be used only if the port value is equal to “80”.
- 1.0
UDPConnectionRequestAddressNotificationLimit unsignedInt W The minimum time, in seconds, between Active Notifications resulting from changes to the UDPConnectionRequestAddress (if Active Notification is enabled). - 1.0
STUNEnable boolean W Enables or disables the use of STUN by the CPE. This applies only to the use of STUN in association with the ACS to allow UDP Connection Requests. - 1.0
STUNServerAddress string(:256) W Host name or IP address of the STUN server for the CPE to send Binding Requests if STUN is enabled via STUNEnable. If an empty string and STUNEnable is true, the CPE MUST use the address of the ACS extracted from the host portion of the ACS URL. - 1.0
STUNServerPort unsignedInt(0:65535) W Port number of the STUN server for the CPE to send Binding Requests if STUN is enabled via STUNEnable. By default, this SHOULD be the equal to the default STUN port, 3478. - 1.0
STUNUsername string(:256) W If 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.0
STUNPassword string(:256) W

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

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

- 1.0
STUNMaximumKeepAlivePeriod int(-1:) W If STUN Is enabled, the maximum period, in seconds, that STUN Binding Requests MUST be sent by the CPE for the purpose of maintaining the binding in the Gateway. This applies specifically to Binding Requests sent from the UDP Connection Request address and port. A value of -1 indicates that no maximum period is specified. - 1.0
STUNMinimumKeepAlivePeriod unsignedInt W If STUN Is enabled, the minimum period, in seconds, that STUN Binding Requests can be sent by the CPE for the purpose of maintaining the binding in the Gateway. This limit applies only to Binding Requests sent from the UDP Connection Request address and port, and only those that do not contain the BINDING-CHANGE attribute. This limit does not apply to retransmissions following the procedures defined in [RFC3489]. - 1.0
NATDetected boolean R When STUN is enabled, this parameter indicates whether or not the CPE has detected address and/or port mapping in use. A true value indicates that the received MAPPED-ADDRESS in the most recent Binding Response differs from the CPE’s source address and port. When STUNEnable is false, this value MUST be false. - 1.0
AliasBasedAddressing boolean R Indicates whether or not the Alias-Based Addressing Mechanism is supported. A true value indicates that the CPE supports the Alias-Based Addressing Mechanism, as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4]. - 1.0
ManageableDeviceNumberOfEntries unsignedInt R Number of entries in the ManageableDevice table. - 1.0
ManageableDeviceNotificationLimit unsignedInt W The minimum time, in seconds, between Active Notifications resulting from changes to the ManageableDeviceNumberOfEntries (if Active Notification is enabled). - 1.0
EmbeddedDeviceNumberOfEntries unsignedInt R The number of entries in the EmbeddedDevice table. - 1.0
VirtualDeviceNumberOfEntries unsignedInt R The number of entries in the VirtualDevice table. - 1.0
InstanceMode string W

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

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

The factory default value MUST be InstanceNumber.

- 1.0
AutoCreateInstances boolean W

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

The factory default value MUST be false.

- 1.0
CWMPRetryMinimumWaitInterval unsignedInt(1:65535) W Configures the first session retry wait interval, in seconds, as specified in [Section 3.2.1.1/TR-069a2]. A value of 5 corresponds to the default behavior that is described in [TR-069a2]. The device MUST use a random value between CWMPRetryMinimumWaitInterval and (CWMPRetryMinimumWaitInterval * CWMPRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. - 1.0
CWMPRetryIntervalMultiplier unsignedInt(1000:65535) W Configures the retry interval multiplier as specified in [Section 3.2.1.1/TR-069a2]. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. A value of 2000 corresponds to the default behavior that is described in [TR-069a2]. The device MUST use a random value between CWMPRetryMinimumWaitInterval and (CWMPRetryMinimumWaitInterval * CWMPRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. - 1.0
InternetGatewayDevice.ManagementServer.ManageableDevice.{i}. object(0:) R

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

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

- 1.0
ManufacturerOUI string(:6) R Organizationally unique identifier of the Device manufacturer as provided to the Gateway by the Device. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. The value MUST be a valid OUI as defined in [OUI]. - 1.0
SerialNumber string(:64) R Serial number of the Device as provided to the Gateway by the Device. - 1.0
ProductClass string(:64) R Identifier of the class of product for which the Device’s serial number applies as provided to the Gateway by the Device. If the Device does not provide a Product Class, then this parameter MUST be an empty string. - 1.0
Host string[](:1024) R Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of a 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.0
InternetGatewayDevice.ManagementServer.AutonomousTransferCompletePolicy. object R This object allows configuration of CPE policy for notification of AUTONOMOUS TRANSFER COMPLETE events, defined in [TR-069a2]. The CPE policy determines the conditions under which the CPE notifies the ACS of the completion of file transfers that were not specifically requested by the ACS. - 1.0
Enable boolean W Enable/disable CPE notification of AUTONOMOUS TRANSFER COMPLETE events to the ACS. - 1.0
TransferTypeFilter string W

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

  • Upload
  • Download
  • Both (Upload and Download) Note that this includes any backup or restore operations that were not specifically requested by the ACS. A backup is regarded as an Upload and a restore is regarded as a Download.
- 1.0
ResultTypeFilter string W

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

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

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

Each list item matches one of:

  • 1 Firmware Upgrade Image (Download Only)
  • 2 Web Content (Download Only)
  • 3 Vendor Configuration File (Download or Upload)
  • 4 Vendor Log File (Upload Only)
  • *X [0-9A-F]{6} .** (For Vendor-Specific File Types, could be for either Download or Upload) Additionally, the following format is defined to allow the unique definition of vendor-specific file types:
  • “X <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.0
InternetGatewayDevice.ManagementServer.DUStateChangeComplPolicy. object R This object allows configuration of CPE policy for notification of “12 AUTONOMOUS DU STATE CHANGE COMPLETE” events defined in [TR-069a3]. The CPE policy determines the conditions under which the CPE notifies the ACS of the completion of Deployment Unit state changes that were not specifically requested via CWMP. - 1.0
Enable boolean W Enables/Disables CPE notification of “12 AUTONOMOUS DU STATE CHANGE COMPLETE” events to the ACS. - 1.0
OperationTypeFilter string[] W

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

  • Install
  • Update
  • Uninstall
- 1.0
ResultTypeFilter string W

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

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

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

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

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

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

- 1.0
ControllerID string(:256) R Identifier of the controller that is responsible for a sub-network of Proxied Devices within the LAN. An empty string indicates that this Proxied Device either:
  • Isn’t part of a sub-network, within the LAN, with a controller entity.
  • Doesn’t need a ControllerID to ensure its ProxiedDeviceID is unique throughout the LAN.
- 1.0
ProxiedDeviceID string(:256) R Idenitfier of the Proxied Device. This is an opaque string that is unique to the Proxied Device within a specific sub-network within the LAN (identified by the ControllerID). If the ControllerID is an empty string this ProxiedDeviceID is unique across the LAN. - 1.0
Reference string R The value MUST be the path name of a table row. If the referenced object is deleted, this EmbeddedDevice instance MUST also be removed. Represents the instance of a multi-instanced object that is directly controlled by, and has come into existence because of, this Proxied Device that utilizes the Embedded Object Mechanism [Annex J.1.2/TR-069a4]. - 1.0
SupportedDataModel string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.SupportedDataModel. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the CWMP-DT schema instance(s) that this Proxied Device is utilizing. The CWMP-DT schema instance is also the one being utilized by the object referenced within Reference. - 1.0
Host string[:32] R Comma-separated list (up to 32 items) of strings. Each list item MUST be the Path Name of a row in the 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.0
ProxyProtocol string() R

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

  • Z-Wave (see [Z-Wave])
  • ZigBee (see [ZigBee])
  • UPnP-DM (see [UPnP-DM:1])
  • ETSI-M2M (see [ETSIM2MFA]) Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a6] MUST be adhered to.
- 1.0
ProxyProtocolReference string R The value MUST be the Path Name of a protocol object that uses the ProxyProtocol. - 1.0
DiscoveryProtocol string[] R

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

- 1.0
DiscoveryProtocolReference string[] R Comma-separated list of strings. Each list item MUST be the Path Name of an object discovered using one or more protocols listed in DiscoveryProtocol, or an empty string. For objects discovered by the UPnP discovery protocol, the DiscoveryProtocolReference would contain items that are references to instances of the following: - 1.0
CommandProcessed string R

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

  • Pending
  • Retrying
  • Success
  • Error
- 1.0
CommandProcessingErrMsg string(:1024) R Detailed CommandProcessed error description (vendor specific). - 1.0
LastSyncTime dateTime R The last time that the CPE Proxier synchronized the state of the Proxied Device. This parameter MUST be updated when a proxy command is executed successfully on the Proxied Device. The Unknown Time value, as defined in [TR-106a6], indicates that the Proxied Device’s state has not been synchronized since the CPE Proxier was last rebooted. - 1.0
InternetGatewayDevice.ManagementServer.VirtualDevice.{i}. object(0:) R

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

- 1.0
ManufacturerOUI string(6) R

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

  • [0-9A-F]{6} The value MUST be a valid OUI as defined in [OUI].
- 1.0
ProductClass string(:64) R Identifier of the class of product of the associated Proxied Device for which the serial number applies. - 1.0
SerialNumber string(:64) R Serial number of the associated Proxied Device. - 1.0
Host string[:32] R Comma-separated list (up to 32 items) of strings. Each list item MUST be the Path Name of a row in the 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.0
ProxyProtocol string() R

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

  • Z-Wave (see [Z-Wave])
  • ZigBee (see [ZigBee])
  • UPnP-DM (see [UPnP-DM:1])
  • ETSI-M2M (see [ETSIM2MFA]) Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a6] MUST be adhered to.
- 1.0
ProxyProtocolReference string R The value MUST be the Path Name of a protocol object that uses the ProxyProtocol. - 1.0
DiscoveryProtocol string[] R

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

- 1.0
DiscoveryProtocolReference string[] R Comma-separated list of strings. Each list item MUST be the Path Name of an object discovered using one or more protocols listed in DiscoveryProtocol, or an empty string. For objects discovered by the UPnP discovery protocol, the DiscoveryProtocolReference would contain items that are references to instances of the following: - 1.0
InternetGatewayDevice.Time. object R 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.0
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 R 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
Status string R

Status of Time support on the CPE. Enumeration of:

  • Disabled
  • Unsynchronized
  • Synchronized
  • Error_FailedToSynchronize
  • Error (OPTIONAL) The Unsynchronized value indicates that the CPE’s absolute time has not yet been set. The Synchronized value indicates that the CPE has acquired accurate absolute time; its current time is accurate. The Error_FailedToSynchronize value indicates that the CPE failed to acquire accurate absolute time; its current time is not accurate. The Error value MAY be used by the CPE to indicate a locally defined error condition.
- 1.0
InternetGatewayDevice.UserInterface. object R This object contains parameters relating to the user interface of the CPE. - 1.0
UserDatabaseSupported boolean R 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.0
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
base64(0: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) R Comma-separated list (maximum number of characters 256) of strings. Available user-interface languages, where each language is specified according to RFC 3066 [RFC3066]. - 1.0
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.0
CurrentLanguage string(:16) W Current user-interface language, specified according to RFC 3066 [RFC3066]. - 1.0
InternetGatewayDevice.UserInterface.RemoteAccess. object R This object contains parameters relating to remotely accessing the CPE’s user interface. Remote access is defined as any entity not of a local subnet attempting to connect to the CPE. Remote access requires user authentication. To provide remote access authentication the CPE MUST support a “User” table with at least one instance that has “RemoteAccessCapable” set to true. - 1.0
Enable boolean W Enables/Disables remotely accessing the CPE’s user interface. - 1.0
Port unsignedInt(:65535) W Destination TCP port required for remote access connection. - 1.0
SupportedProtocols string[] R

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

- 1.0
Protocol string W The value MUST be a member of the list reported by the SupportedProtocols parameter. This is the protocol currently being used for remote access. - 1.0
InternetGatewayDevice.UserInterface.LocalDisplay. object R This object describes how to remotely manage the initial positioning of a user interface on a device’s local display. - 1.0
Movable boolean W Controls whether the user is allowed to change the GUI window position on the local CPE’s display. - 1.0
Resizable boolean W Controls whether the user is allowed to resize the GUI window on the local CPE’s display. - 1.0
PosX int W The horizontal position of the User Interface’s top left corner within the local CPE’s display measured from the top left corner, expressed in pixels. - 1.0
PosY int W The vertical position of the User Interface’s top left corner within the local CPE’s display measured from the top left corner, expressed in pixels. - 1.0
Width unsignedInt W The width of the user interface within the local CPE’s display, expressed in pixels. - 1.0
Height unsignedInt W The height of the user interface within the local CPE’s display, expressed in pixels. - 1.0
DisplayWidth unsignedInt R The width of the local CPE’s display, expressed in pixels. - 1.0
DisplayHeight unsignedInt R The height of the local CPE’s display, expressed in pixels. - 1.0
InternetGatewayDevice.Layer3Forwarding. object R 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 R Number of forwarding instances. - 1.0
InternetGatewayDevice.Layer3Forwarding.Forwarding.{i}. object(0:) 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 the same values for all of 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 R

Indicates the status of the forwarding entry.

Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 1.0
Alias string(:64) W

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

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

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

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of DestIPAddress, DestSubnetMask, SourceIPAddress and SourceSubnetMask. This parameter can only be modified if StaticRoute is true

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

- 1.0
StaticRoute boolean R If true, this route is a Static route. true 1.0
Type string W

Indicates the type of route.

Enumeration of:

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.

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.

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

1.0
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. 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
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.0
InternetGatewayDevice.LANConfigSecurity. object R 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 R This object provides access to an IP-layer ping test. - 1.0
DiagnosticsState string W

Indicates availability of diagnostic data. Enumeration of:

  • None (READONLY)
  • Requested
  • Complete (READONLY)
  • Error_CannotResolveHostName (READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY) If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the test is completed, the value of this parameter MUST be either 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 R Result parameter indicating the number of successful pings (those in which a successful response was received prior to the timeout) in the most recent ping test. - 1.0
FailureCount unsignedInt R Result parameter indicating the number of failed pings in the most recent ping test. - 1.0
AverageResponseTime unsignedInt R Result parameter indicating the average response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 1.0
MinimumResponseTmie unsignedInt R Result parameter indicating the minimum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 1.0
MaximumResponseTime unsignedInt R Result parameter indicating the maximum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 1.0
MinimumResponseTime unsignedInt R Result parameter indicating the minimum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 1.0
InternetGatewayDevice.LANDevice.{i}. object(0:) 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

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

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

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

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.

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

- 1.0
LANEthernetInterfaceNumberOfEntries unsignedInt R Number of instances of LANEthernetInterfaceConfig in this LANDevice. 0 1.0
LANUSBInterfaceNumberOfEntries unsignedInt R Number of instances of LANUSBInterfaceConfig in this LANDevice. 0 1.0
LANWLANConfigurationNumberOfEntries unsignedInt R Number of instances of WLANConfiguration in this LANDevice. 0 1.0
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement. object R

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) R [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.0
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 R 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(:45)[](:256) W [IPAddress] Comma-separated list (maximum number of characters 256) of IP Addresses. Addresses marked reserved from the address allocation pool. 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(:45)[](:64) W [IPAddress] Comma-separated list (maximum number of characters 64) of IP Addresses. 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(:45)[](:64) W [IPAddress] Comma-separated list (maximum number of characters 64) of IP Addresses. 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:

  • Normal
  • UseAllocatedSubnet (DEPRECATED)
  • Passthrough If Normal, the address pool is directly configured by the ACS. If {{enum: reference to deprecated enumeration InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.UseAllocatedWAN.UseAllocatedSubnet}}, behavior is the same as for Passthrough with an empty PassthroughMACAddress. For this reason, {{enum: reference to deprecated enumeration InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.UseAllocatedWAN.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 {{enum: reference to deprecated enumeration InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.UseAllocatedWAN.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 {{enum: reference to deprecated enumeration InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.UseAllocatedWAN.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) {{enum: reference to deprecated enumeration InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.UseAllocatedWAN.UseAllocatedSubnet}}. - 1.0
AllowedMACAddresses string(:17)[](:512) W [MACAddress] Comma-separated list (maximum number of characters 512) of MAC Addresses. Hardware addresses that are allowed to connect to this connection if MACAddressControlEnabled is 1 for a given interface. - 1.0
IPInterfaceNumberOfEntries unsignedInt R The number of entries in the IPInterface table. 0 1.0
DHCPStaticAddressNumberOfEntries unsignedInt R The number of entries in the DHCPStaticAddress table. 0 1.0
DHCPOptionNumberOfEntries unsignedInt R The number of entries in the DHCPOption table. 0 1.0
DHCPConditionalPoolNumberOfEntries unsignedInt R The number of entries in the DHCPConditionalServingPool table. 0 1.0
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.IPInterface.{i}. object(0:) 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 both 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

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

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

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

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

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

- 1.0
IPInterfaceIPAddress string(:45) W [IPAddress] IP address of the LAN-side interface of the CPE. 1.0
IPInterfaceSubnetMask string(:45) W [IPAddress] Subnet mask of the LAN-side interface of the IGD. 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
  • Static
  • AutoIP
DHCP 1.0
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.DHCPStaticAddress.{i}. object(0:) 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.0
Enable boolean W Enables or disables the DHCPStaticAddress table entry. Disabling an entry does not return the IP address to the pool. false 1.0
Alias string(:64) W

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

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

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

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.

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

- 1.0
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. 1.0
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. 1.0
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.DHCPOption.{i}. object(0:) 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.0
Enable boolean W Enables or disables this DHCPOption table entry. false 1.0
Alias string(:64) W

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

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

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

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.

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

- 1.0
Tag unsignedInt(1:254) W Option tag as defined in RFC 2132 [RFC2132]. - 1.0
Value base64(0:255) W Base64 encoded option value. 1.0
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.DHCPConditionalServingPool.{i}. object(0:) W

DHCP conditional serving pool table. Each instance of this object defines a DHCP conditional serving pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCP options, and MAC address. 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.0
Enable boolean W Enables or disables the DHCPConditionalServingPool entry. false 1.0
Alias string(:64) W

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

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

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

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.

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

- 1.0
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.0
SourceInterface string[](:1024) W Pool association criterion. Comma-separated list (maximum number of characters 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. 1.0
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. 1.0
VendorClassIDExclude boolean W If false, matching packets are those that match the VendorClassID entry, if specified. If true, matching packets are those that do not match the VendorClassID entry, if specified. false 1.0
VendorClassIDMode string W

VendorClassID pattern match criterion. Enumeration of:

  • Exact
  • Prefix
  • Suffix
  • Substring For example, if VendorClassID is “Example” then an Option 60 value of “Example device” will match with VendorClassIDMode values of Prefix or Substring, but not with Exact or Suffix.
Exact 1.0
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. 1.0
ClientIDExclude boolean W If false, matching packets are those that match the ClientID entry, if specified. If true, matching packets are those that do not match the ClientID entry, if specified. false 1.0
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. 1.0
UserClassIDExclude boolean W If false, matching packets are those that match the UserClassID entry, if specified. If true, matching packets are those that do not match the UserClassID entry, if specified. false 1.0
Chaddr string(:17) W [MACAddress] Pool association criterion. Hardware address (MAC address.) of the physical interface of the DHCP client. An empty string indicates this criterion is not used for conditional serving. 1.0
ChaddrMask string(:17) W [MACAddress] Bit-mask for the MAC address, where matching of a packet’s MAC address with the Chaddr is only to be done for bit positions set to one in the mask. A mask of FF:FF:FF:FF:FF:FF or an empty string indicates all bits of the Chaddr are to be used for conditional serving classification. 1.0
ChaddrExclude boolean W If false, matching packets are those that match the (masked) Chaddr entry, if specified. If true, matching packets are those that do not match the (masked) Chaddr entry, if specified. false 1.0
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.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 is configurable only if UseAllocatedWAN is Normal. This parameter MUST have a valid value before this pool 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 is configurable only if UseAllocatedWAN is Normal. This parameter MUST have a valid value before this pool can be enabled. - 1.0
ReservedAddresses string(:45)[](:512) W [IPAddress] Comma-separated list (maximum number of characters 512) of IP Addresses. IP addresses marked reserved from the address allocation pool. 1.0
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.0
DNSServers string(:45)[](:64) W [IPAddress] Comma-separated list (maximum number of characters 64) of IP Addresses. 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.0
DomainName string(:64) W Sets the domain name to provide to clients on the LAN interface. - 1.0
IPRouters string(:45)[](:64) W [IPAddress] Comma-separated list (maximum number of characters 64) of IP Addresses. 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 whether the MinAddress, MaxAddress, SubnetMask and DNSServers parameters are configurable or are taken from the associated WAN connection. Enumeration of:

  • Normal
  • Passthrough 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.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 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.0
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.0
DHCPStaticAddressNumberOfEntries unsignedInt R The number of entries in the DHCPStaticAddress table. 0 1.0
DHCPOptionNumberOfEntries unsignedInt R The number of entries in the DHCPOption table. 0 1.0
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.DHCPConditionalServingPool.{i}.DHCPStaticAddress.{i}. object(0:) 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.0
Enable boolean W Enables or disables the DHCPStaticAddress table entry. Disabling an entry does not return the IP address to the pool. false 1.0
Alias string(:64) W

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

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

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

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.

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

- 1.0
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. 1.0
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. 1.0
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.DHCPConditionalServingPool.{i}.DHCPOption.{i}. object(0:) W

This object specifies the DHCP options that MUST, if enabled, be returned to clients whose DHCP requests are associated with this pool.

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

- 1.0
Enable boolean W Enables or disables this DHCPOption table entry. false 1.0
Alias string(:64) W

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

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

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

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.

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

- 1.0
Tag unsignedInt(1:254) W Option tag as defined in RFC 2132 [RFC2132]. - 1.0
Value base64(0:255) W Base64 encoded option value. 1.0
InternetGatewayDevice.LANDevice.{i}.LANEthernetInterfaceConfig.{i}. object(0:) R

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 R

Indicates the status of this interface.

Enumeration of:

  • Up
  • NoLink
  • Error (OPTIONAL)
  • Disabled The Error value MAY be used by the CPE to indicate a locally defined error condition.
- 1.0
Alias string(:64) W

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

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

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

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

- 1.0
Name string(:16) R The name of this layer 2 interface, chosen by the vendor, e.g. “eth0” or “eth0:1”. - 1.0
MACAddress string(:17) R [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:

  • 10
  • 100
  • 1000
  • 10000
  • Auto
- 1.0
DuplexMode string W

The duplex mode available to this connection. Enumeration of:

  • Half
  • Full
  • Auto
- 1.0
InternetGatewayDevice.LANDevice.{i}.LANEthernetInterfaceConfig.{i}.Stats. object R

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 R 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 R 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 R 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 R 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 R 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.0
ErrorsReceived unsignedInt R 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.0
UnicastPacketsSent unsignedInt R 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.0
UnicastPacketsReceived unsignedInt R 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.0
DiscardPacketsSent unsignedInt R The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
DiscardPacketsReceived unsignedInt R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being 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.0
MulticastPacketsSent unsignedInt R 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.0
MulticastPacketsReceived unsignedInt R 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.0
BroadcastPacketsSent unsignedInt R 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.0
BroadcastPacketsReceived unsignedInt R 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.0
UnknownProtoPacketsReceived unsignedInt R 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.0
InternetGatewayDevice.LANDevice.{i}.LANUSBInterfaceConfig.{i}. object(0:) R

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 R

Indicates the status of this interface.

Enumeration of:

  • Up
  • NoLink
  • Error (OPTIONAL)
  • Disabled The Error value MAY be used by the CPE to indicate a locally defined error condition.
- 1.0
Alias string(:64) W

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

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

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

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

- 1.0
Name string(:16) R The name of this layer 2 interface, chosen by the vendor, e.g. “usb0”. - 1.0
MACAddress string(:17) R [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) R USB version supported by the device. - 1.0
Type string R

Type of the USB interface. Enumeration of:

  • Host
  • Hub
  • Device
- 1.0
Rate string R

Speed of the USB interface. Enumeration of:

  • Low
  • Full
  • High (USB 2.0)
- 1.0
Power string R

Power configuration of the USB interface. Enumeration of:

  • Self
  • Bus
  • Unknown
- 1.0
InternetGatewayDevice.LANDevice.{i}.LANUSBInterfaceConfig.{i}.Stats. object R

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 R 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 R 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 R 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 R 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 R 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.0
ErrorsReceived unsignedInt R 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.0
UnicastPacketsSent unsignedInt R 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.0
UnicastPacketsReceived unsignedInt R 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.0
DiscardPacketsSent unsignedInt R The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
DiscardPacketsReceived unsignedInt R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being 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.0
MulticastPacketsSent unsignedInt R 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.0
MulticastPacketsReceived unsignedInt R 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.0
BroadcastPacketsSent unsignedInt R 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.0
BroadcastPacketsReceived unsignedInt R 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.0
UnknownProtoPacketsReceived unsignedInt R 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.0
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}. object(0:) R

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 R

Indicates the status of this interface.

Enumeration of:

  • Up
  • Error (OPTIONAL)
  • Disabled The Error value MAY be used by the CPE to indicate a locally defined error condition.
- 1.0
Alias string(:64) W

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

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

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

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
Name string(:16) R The name of this layer 2 interface, chosen by the vendor, e.g. “wlan0”. - 1.0
BSSID string R 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
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:

  • None
  • Basic
  • WPA
  • 11i (OPTIONAL)
  • BasicandWPA (OPTIONAL, OBSOLETED)
  • Basicand11i (OPTIONAL, OBSOLETED)
  • WPAand11i (OPTIONAL)
  • BasicandWPAand11i (OPTIONAL, OBSOLETED) 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 R

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

Comma-separated list (maximum number of characters 64) of strings. Supported key lengths. Each list item is an enumeration of:

  • Disabled
  • 40-bit
  • 104-bit 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(:31) 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:

  • None
  • WEPEncryption 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(:31) W

Authentication modes that are available when basic 802.11 is enabled.

Enumeration of:

  • None (Open authentication)
  • EAPAuthentication (OPTIONAL)
  • SharedAuthentication (OPTIONAL) 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(:31) W

Encryption modes that are available when WPA is enabled.

Enumeration of:

  • WEPEncryption (DEPRECATED)
  • TKIPEncryption
  • WEPandTKIPEncryption (DEPRECATED)
  • AESEncryption (OPTIONAL)
  • WEPandAESEncryption (OPTIONAL, DEPRECATED)
  • TKIPandAESEncryption (OPTIONAL)
  • WEPandTKIPandAESEncryption (OPTIONAL, DEPRECATED) 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(:31) W

Authentication modes that are available when WPA is enabled.

Enumeration of:

  • PSKAuthentication
  • EAPAuthentication (OPTIONAL) 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(:31) W

Encryption modes that are available when 802.11i is enabled.

Enumeration of:

  • WEPEncryption (DEPRECATED)
  • TKIPEncryption (OPTIONAL)
  • WEPandTKIPEncryption (DEPRECATED)
  • AESEncryption (OPTIONAL)
  • WEPandAESEncryption (OPTIONAL, DEPRECATED)
  • TKIPandAESEncryption (OPTIONAL)
  • WEPandTKIPandAESEncryption (OPTIONAL, DEPRECATED) 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(:31) W

Authentication modes that are available when 802.11i is enabled.

Enumeration of:

  • PSKAuthentication
  • EAPAuthentication (OPTIONAL)
  • EAPandPSKAuthentication (OPTIONAL) 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) R Comma-separated list (maximum number of characters 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 number of characters 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 number of characters 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) R Comma-separated list (maximum number of characters 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.0
RadioEnabled boolean W Indicates whether or not the access point radio is enabled. - 1.0
TransmitPowerSupported unsignedInt(0:100)[](:64) R Comma-separated list (maximum number of characters 64) of unsigned integers (0 to 100). Supported transmit power levels as percentages of full power. For example, “0,25,50,75,100”. - 1.0
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 R The number of times pre-shared key (PSK) authentication has failed (relevant only to WPA and 802.11i). - 1.0
TotalIntegrityFailures unsignedInt R The number of times the MICHAEL integrity check has failed (relevant only to WPA and 802.11i) - 1.0
ChannelsInUse string[](:1024) R Comma-separated list (maximum number of characters 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(:31) 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:

  • InfrastructureAccessPoint
  • WirelessBridge (OPTIONAL)
  • WirelessRepeater (OPTIONAL)
  • WirelessStation (OPTIONAL)
- 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:

  • None
  • LinkAuthentication (OPTIONAL)
  • RadiusClient (OPTIONAL)
- 1.0
WMMSupported boolean R Indicates whether this interface supports WiFi Multimedia (WMM) Access Categories (AC). - 1.0
TotalBytesSent unsignedInt R 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 R 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 R 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 R 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 R The number of devices currently associated with the access point. This corresponds to the number of entries in the AssociatedDevice table. - 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.0
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.0
UAPSDSupported boolean R Indicates whether this interface supports WMM Unscheduled Automatic Power Save Delivery (U-APSD). Note: U-APSD support implies WMM support. - 1.0
WMMEnable boolean W Whether WMM support is currently enabled. When enabled, this is indicated in beacon frames - 1.0
UAPSDEnable boolean W Whether U-APSD support is currently enabled. When enabled, this is indicated in beacon frames. Note: U-APSD can only be enabled if WMM is also enabled. - 1.0
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.AssociatedDevice.{i}. object(0:) R

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) R [MACAddress] The MAC address of an associated device. - 1.0
AssociatedDeviceIPAddress string(:64) R The IP address or DNS name of an associated device. - 1.0
AssociatedDeviceAuthenticationState boolean R Whether an associated device has authenticated (true) or not (false). - 1.0
LastRequestedUnicastCipher string(:256) R The unicast cipher that was most recently used for a station with a specified MAC address (802.11i only). - 1.0
LastRequestedMulticastCipher string(:256) R The multicast cipher that was most recently used for a station with a specified MAC address (802.11i only). - 1.0
LastPMKId string(:256) R 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) R The data transmit rate that was most recently used for a station with a specified MAC address. - 1.0
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.WEPKey.{i}. object(4:4) R

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

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

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

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

This table MUST contain exactly 4 entries.

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

- 1.0
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(10:10) R

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

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

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

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

This table MUST contain exactly 10 entries.

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

- 1.0
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 R 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.0
ErrorsSent unsignedInt R 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.0
ErrorsReceived unsignedInt R 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.0
UnicastPacketsSent unsignedInt R 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.0
UnicastPacketsReceived unsignedInt R 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.0
DiscardPacketsSent unsignedInt R The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
DiscardPacketsReceived unsignedInt R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being 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.0
MulticastPacketsSent unsignedInt R 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.0
MulticastPacketsReceived unsignedInt R 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.0
BroadcastPacketsSent unsignedInt R 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.0
BroadcastPacketsReceived unsignedInt R 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.0
UnknownProtoPacketsReceived unsignedInt R 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.0
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.WPS. object R This object contains parameters related to WPS (Wi-Fi Protected Setup) [WPSv1.0] that apply to a CPE acting as an Access Point. - 1.0
Enable boolean W Enables or disables WPS functionality for this interface. - 1.0
DeviceName string(:32) R User-friendly description of the device. This parameter corresponds directly to the “Device Name” attribute of the WPS specification [WPSv1.0]. - 1.0
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.0
UUID string(:36) R

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:

  • [*[0-9A-Fa-f]{8}-(0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}*
- 1.0
Version unsignedInt R 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.0
ConfigMethodsSupported string[] R

Comma-separated list of strings. WPS configuration methods supported by the device. Each list item is an enumeration of:

  • USBFlashDrive
  • Ethernet
  • Label
  • Display
  • ExternalNFCToken
  • IntegratedNFCToken
  • NFCInterface
  • PushButton
  • Keypad This parameter corresponds directly to the “Config Methods” attribute of the WPS specification [WPSv1.0].
- 1.0
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.0
SetupLockedState string R

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:

  • Unlocked
  • LockedByLocalManagement
  • LockedByRemoteManagement
  • PINRetryLimitReached This parameter corresponds directly to the “AP Setup Locked” attribute of the WPS specification [WPSv1.0]. The factory default setting is Unlocked.
- 1.0
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.0
ConfigurationState string R

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.0
LastConfigurationError string R

Shows the result of the last external registrar attempt to configure the Access Point. Enumeration of:

  • NoError
  • DecryptionCRCFailure
  • SignalTooWeak
  • CouldntConnectToRegistrar
  • RogueActivitySuspected
  • DeviceBusy
  • SetupLocked
  • MessageTimeout
  • RegistrationSessionTimeout
  • DevicePasswordAuthFailure 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.0
RegistrarNumberOfEntries unsignedInt R 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.0
RegistrarEstablished boolean R 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.0
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.WPS.Registrar.{i}. object(0:) R

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.0
Enable boolean W If true, the registrar can be used by the Access Point for WPS procedures. - 1.0
Alias string(:64) W

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

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

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

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

- 1.0
UUID string(:36) R

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:

  • [*[0-9A-Fa-f]{8}-(0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}*
- 1.0
DeviceName string(:32) R Device Name of the registrar. This parameter corresponds directly to the “Device Name” attribute of the WPS specification [WPSv1.0]. - 1.0
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.APWMMParameter.{i}. object(4:4) R

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

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

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

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

This table MUST contain exactly 4 entries.

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

- 1.0
AIFSN unsignedInt(2:15) W Arbitration Inter Frame Spacing (Number). This is the number of time slots in the arbitration interframe space. - 1.0
ECWMin unsignedInt(0:15) W Exponent of Contention Window (Minimum). This encodes the Values of CWMin as an exponent: CWMin = 2ECWMin - 1. For example, if ECWMin is 8, then CWMin is 28 - 1, or 255, - 1.0
ECWMax unsignedInt(0:15) W Exponent of Contention Window (Maximum). This encodes the Values of CWMax as an exponent: CWMax = 2ECWMax - 1. For example, if ECWMax is 8, then CWMax is 28 - 1, or 255, - 1.0
TXOP unsignedInt(0:255) W Transmit Opportunity, in multiples of 32 microseconds. - 1.0
AckPolicy boolean W Ack Policy, where false=Do Not Acknowledge and true=Acknowledge. - 1.0
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.STAWMMParameter.{i}. object(4:4) R

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

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

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

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

This table MUST contain exactly 4 entries.

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

- 1.0
AIFSN unsignedInt(2:15) W Arbitration Inter Frame Spacing (Number). This is the number of time slots in the arbitration interframe space. - 1.0
ECWMin unsignedInt(0:15) W Exponent of Contention Window (Minimum). This encodes the Values of CWMin as an exponent: CWMin = 2ECWMin - 1. For example, if ECWMin is 8, then CWMin is 28 - 1, or 255, - 1.0
ECWMax unsignedInt(0:15) W Exponent of Contention Window (Maximum). This encodes the Values of CWMax as an exponent: CWMax = 2ECWMax - 1. For example, if ECWMax is 8, then CWMax is 28 - 1, or 255, - 1.0
TXOP unsignedInt(0:255) W Transmit Opportunity, in multiples of 32 microseconds. - 1.0
AckPolicy boolean W Ack Policy, where false=Do Not Acknowledge and true=Acknowledge. - 1.0
InternetGatewayDevice.LANDevice.{i}.Hosts. object R This object provides information about each of the hosts on the LAN, including those whose IP address was allocated by the CPE using DHCP as well as hosts with statically allocated IP addresses. - 1.0
HostNumberOfEntries unsignedInt R Number of entries in the Host table. - 1.0
InternetGatewayDevice.LANDevice.{i}.Hosts.Host.{i}. object(0:) R

Host table.

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

- 1.0
IPAddress string(:45) R [IPAddress] Current IP Address of the host. - 1.0
AddressSource string R

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

  • DHCP
  • Static
  • AutoIP
- 1.0
LeaseTimeRemaining int(-1:) R DHCP lease time remaining in seconds. A value of -1 indicates an infinite lease. The value MUST be 0 (zero) if the AddressSource is not DHCP. - 1.0
MACAddress string(:17) R [MACAddress] MAC address of the host. - 1.0
Layer2Interface string(:256) R 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.0
HostName string(:64) R The device’s host name or an empty string if unknown. - 1.0
InterfaceType string R

Type of physical interface through which this host is connected to the CPE. Enumeration of:

  • Ethernet
  • USB
  • 802.11
  • HomePNA
  • HomePlug
  • MoCA
  • Other
- 1.0
Active boolean R Whether or not the host is currently present on the LAN. The method of presence detection is a local matter to the CPE. The ability to list inactive hosts is OPTIONAL. If the CPE includes inactive hosts in this table, 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
VendorClassID string(:256) R 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.0
ClientID string(:256) R 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.0
UserClassID string(:256) R 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.0
InternetGatewayDevice.WANDevice.{i}. object(0:) R

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

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

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

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

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

- 1.0
WANConnectionNumberOfEntries unsignedInt R Number of instances of WANConnectionDevice in this WANDevice. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANCommonInterfaceConfig. object R 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 R

Specifies the WAN access (modem) type. Enumeration of:

  • DSL
  • Ethernet
  • POTS
- 1.0
Layer1UpstreamMaxBitRate unsignedInt R 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 R 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 R

Indicates the state of the physical connection (link) from WANDevice to a connected entity. Enumeration of:

  • Up
  • Down
  • Initializing
  • Unavailable
- 1.0
WANAccessProvider string(:256) R Name of the Service Provider providing link connectivity on the WAN. - 1.0
TotalBytesSent unsignedInt R The cumulative counter for total number of bytes sent upstream across all connection service instances on the WAN device. - 1.0
TotalBytesReceived unsignedInt R The cumulative counter for total number of bytes received downstream across all connection service instances on the WAN device. - 1.0
TotalPacketsSent unsignedInt R 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 R 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 R Indicates the maximum number of active connections the CPE can simultaneously support. - 1.0
NumberOfActiveConnections unsignedInt R Number of WAN connection service instances currently active on this WAN interface. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANCommonInterfaceConfig.Connection.{i}. object(0:) R

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

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

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

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

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

- 1.0
ActiveConnectionDeviceContainer string(:256) R 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) R 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(0:1) R

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 WANInterfaceConfig* object within a given WANDevice instance.

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

- 1.0
Enable boolean W Enables or disables the link. - 1.0
Status string R

Status of the DSL physical link.

Enumeration of:

  • Up
  • Initializing
  • EstablishingLink
  • NoSignal
  • Error (OPTIONAL)
  • Disabled The Error value MAY be used by the CPE to indicate a locally defined error condition.
- 1.0
LinkEncapsulationSupported string[] R

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:

  • G.992.3_Annex_K_ATM
  • G.992.3_Annex_K_PTM
  • G.993.2_Annex_K_ATM
  • G.993.2_Annex_K_PTM
  • G.994.1 (Auto)
- 1.0
ModulationType string R

Indicates the type of modulation used on the connection.

Enumeration of:

  • ADSL_G.dmt
  • ADSL_G.lite
  • ADSL_G.dmt.bis
  • ADSL_re-adsl
  • ADSL_2plus
  • ADLS_four
  • ADSL_ANSI_T1.413
  • G.shdsl
  • IDSL
  • HDSL
  • SDSL
  • VDSL 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
LineEncoding string R

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:

  • DMT
  • CAP
  • 2B1Q
  • 43BT
  • PAM
  • QAM
- 1.0
AllowedProfiles string[] R

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

  • 8a
  • 8b
  • 8c
  • 8d
  • 12a
  • 12b
  • 17a
  • 17b
  • 30a Note: In G.997.1, this parameter is called PROFILES. See ITU-T Recommendation G.997.1. Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be an empty string.
- 1.0
DataPath string R

Indicates whether the data path is fast (lower latency) or interleaved (lower error rate).

Enumeration of:

  • Interleaved
  • Fast
  • None 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 R 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
LineNumber int(1:) R Signifies the line pair that the modem is using to connection. LineNumber = 1 is the innermost pair. - 1.0
UpstreamCurrRate unsignedInt R

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 R

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 R

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 R

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 R 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 R 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
UpstreamAttenuation int R The current upstream signal loss (expressed in 0.1 dB). - 1.0
DownstreamAttenuation int R The current downstream signal loss (expressed in 0.1 dB). - 1.0
UpstreamPower int R The current output power at the CPE’s DSL interface (expressed in 0.1 dBmV). - 1.0
DownstreamPower int R The current received power at the CPE’s DSL interface (expressed in 0.1 dBmV). - 1.0
ATURVendor string(:8) R

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

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 R

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 R

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

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

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 R

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 R

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 R 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 R 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 R 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 R 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 R 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
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.0
LinkEncapsulationUsed string R

Indicates the link encapsulation standard that the B-NT is using for the connection. Enumeration of:

- 1.0
StandardsSupported string[] R

Comma-separated list of strings. Indicates which DSL standards and recommendations are supported by the B-NT. Each list item is an enumeration of:

  • G.992.1_Annex_A
  • G.992.1_Annex_B
  • G.992.1_Annex_C
  • T1.413
  • T1.413i2
  • ETSI_101_388
  • G.992.2
  • G.992.3_Annex_A
  • G.992.3_Annex_B
  • G.992.3_Annex_C
  • G.992.3_Annex_I
  • G.992.3_Annex_J
  • G.992.3_Annex_L
  • G.992.3_Annex_M
  • G.992.4
  • G.992.5_Annex_A
  • G.992.5_Annex_B
  • G.992.5_Annex_C
  • G.992.5_Annex_I
  • G.992.5_Annex_J
  • G.992.5_Annex_M
  • G.993.1
  • G.993.1_Annex_A
  • G.993.2_Annex_A
  • G.993.2_Annex_B
  • G.993.2_Annex_C
- 1.0
StandardUsed string R 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.0
CurrentProfile string R The value MUST be a member of the list reported by the AllowedProfiles parameter, or else be an empty string. Indicates which VDSL2 profile is currently in use on the line. Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be an empty string. - 1.0
PowerManagementState string R

The power management state of the line. Enumeration of:

  • L0
  • L1
  • L3
  • L4
- 1.0
SuccessFailureCause unsignedInt(0:5) R The success failure cause of the initialization. An enumeration of the following integer values:
  • 0: Successful
  • 1: Configuration error. This error occurs with inconsistencies in configuration parameters, e.g. when the line is initialized in an xDSL Transmission system where an xTU does not support the configured Maximum Delay or the configured Minimum or Maximum Data Rate for one or more bearer channels.
  • 2: Configuration not feasible on the line. This error occurs if the Minimum Data Rate cannot be reached on the line with the Minimum Noise Margin, Maximum PSD level, Maximum Delay and Maximum Bit Error Ratio for one or more bearer channels.
  • 3: Communication problem. This error occurs, for example, due to corrupted messages or bad syntax messages or if no common mode can be selected in the G.994.1 handshaking procedure or due to a timeout..
  • 4: No peer xTU detected. This error occurs if the peer xTU is not powered or not connected or if the line is too long to allow detection of a peer xTU.
  • 5: Any other or unknown Initialization Failure cause.
- 1.0
LastStateTransmittedDownstream unsignedInt R This parameter represents the last successful transmitted initialization state in the downstream direction in the last full initialization performed on the line. Initialization states are defined in the individual xDSL Recommendations and are counted from 0 (if G.994.1 is used) or 1 (if G.994.1 is not used) up to Showtime. This parameter needs to be interpreted along with the xDSL Transmission System. This parameter is available only when, after a failed full initialization, the line diagnostics procedures are activated on the line. - 1.0
LastStateTransmittedUpstream unsignedInt R This parameter represents the last successful transmitted initialization state in the upstream direction in the last full initialization performed on the line. Initialization states are defined in the individual xDSL Recommendations and are counted from 0 (if G.994.1 is used) or 1 (if G.994.1 is not used) up to Showtime. This parameter needs to be interpreted along with the xDSL Transmission System. This parameter is available only when, after a failed full initialization, the line diagnostics procedures are activated on the line. - 1.0
UPBOKLE unsignedInt(0:1280) R 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.0
MREFPSDds base64(0:145) R This parameter SHALL contain the set of breakpoints exchanged in the MREFPSDds fields of the O-PRM message of G.993.2. Base64 encoded of the binary representation defined in Table 12-19/G.993.2 (maximum length is 145 octets, which requires 196 bytes for Base64 encoding). - 1.0
MREFPSDus base64(0:145) R This parameter SHALL contain the set of breakpoints exchanged in the MREFPSDus fields of the R-PRM message of G.993.2. Base64 encoded of the binary representation defined in Table 12-19/G.993.2 (maximum length is 145 octets, which requires 196 bytes for Base64 encoding). - 1.0
LIMITMASK unsignedInt R Indicates the enabled VDSL2 Limit PSD mask of the selected PSD mask class. Bit mask as specified in ITU-T Recommendation G.997.1. Note: For a VDSL2-capable multimode device operating in a mode other than VDSL2, the value of this parameter SHOULD be set to 0. - 1.0
US0MASK unsignedInt R Indicates the allowed VDSL2 US0 PSD masks for Annex A operation. Bit mask as specified in see ITU-T Recommendation G.997.1. Note: For a VDSL2-capable multimode device operating in a mode other than VDSL2, the value of this parameter SHOULD be set to 0. - 1.0
LPATH unsignedInt R 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.0
INTLVDEPTH int R Reports the interleaver depth D for the latency path indicated in LPATH. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1. - 1.0
INTLVBLOCK int R Reports the interleaver block length in use on the latency path indicated in LPATH. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1. - 1.0
ActualInterleavingDelay unsignedInt R Reports the actual delay, in milliseconds, of the latency path due to interleaving. Note: In G.997.1, this parameter is called “Actual Interleaving Delay.” See ITU-T Recommendation G.997.1. - 1.0
ACTINP int R Reports the actual impulse noise protection (INP) provided by the latency path indicated in LPATH. The value is the actual INP in the L0 (i.e., Showtime) state. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1. - 1.0
INPREPORT boolean R Reports whether the value reported in ACTINP was computed assuming the receiver does not use erasure decoding. Valid values are 0 (computed per the formula assuming no erasure decoding) and 1 (computed by taking into account erasure decoding capabilities of receiver). Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to false. - 1.0
NFEC int R Reports the size, in octets, of the Reed-Solomon codeword in use on the latency path indicated in LPATH. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1. - 1.0
RFEC int R Reports the number of redundancy bytes per Reed-Solomon codeword on the latency path indicated in LPATH. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1. - 1.0
LSYMB int R Reports the number of bits per symbol assigned to the latency path indicated in LPATH. This value does not include overhead due to trellis coding. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1. - 1.0
TRELLISds int R Reports whether trellis coding is enabled in the downstream direction. A value of 1 indicates that trellis coding is in use, and a value of 0 indicates that the trellis is disabled. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1. - 1.0
TRELLISus int R Reports whether trellis coding is enabled in the upstream direction. A value of 1 indicates that trellis coding is in use, and a value of 0 indicates that the trellis is disabled. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1. - 1.0
ACTSNRMODEds unsignedInt R Reports whether the OPTIONAL virtual noise mechanism is in use in the downstream direction. A value of 1 indicates the virtual noise mechanism is not in use, and a value of 2 indicates the virtual noise mechanism is in use. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 1.0
ACTSNRMODEus unsignedInt R Reports whether the OPTIONAL virtual noise mechanism is in use in the upstream direction. A value of 1 indicates the virtual noise mechanism is not in use, and a value of 2 indicates the virtual noise mechanism is in use. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 1.0
VirtualNoisePSDds base64(0:97) R Reports the virtual noise PSD for the downstream direction. Base64 encoded of the binary representation defined in G.997.1 by the parameter called TXREFVNds (maximum length is 97 octets, which requires 132 bytes for Base64 encoding). See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to an empty string. - 1.0
VirtualNoisePSDus base64(0:49) R Reports the virtual noise PSD for the upstream direction. Base64 encoded of the binary representation defined in G.997.1by the parameter called TXREFVNus (maximum length is 49 octets, which requires 68 bytes for Base64 encoding). See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to an empty string. - 1.0
ACTUALCE unsignedInt R Reports the actual cyclic extension, as the value of m, in use for the connection. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 99. - 1.0
SNRMpbus string[](:24) R Comma-separated list (maximum number of characters 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.0
SNRMpbds string[](:24) R Comma-separated list (maximum number of characters 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.0
INMIATOds unsignedInt(3:511) R The Impulse Noise Monitoring (INM) Inter Arrival Time (IAT) Offset, measured in DMT symbols, that the xTU receiver uses to determine in which bin of the IAT histogram the IAT is reported. Note: In G.997.1, this parameter is called INMIATO. See ITU-T Recommendation G.997.1. - 1.0
INMIATSds unsignedInt(0:7) R The Impulse Noise Monitoring (INM) Inter Arrival Time (IAT) Step that the xTU receiver uses to determine in which bin of the IAT histogram the IAT is reported. Note: In G.997.1, this parameter is called INMIATS. See ITU-T Recommendation G.997.1. - 1.0
INMCCds unsignedInt(0:64) R The Impulse Noise Monitoring (INM) Cluster Continuation value, measured in DMT symbols, that the xTU receiver uses in the cluster indication process. Note: In G.997.1, this parameter is called INMCC. See ITU-T Recommendation G.997.1. - 1.0
INMINPEQMODEds unsignedInt(0:3) R The Impulse Noise Monitoring (INM) Equivalent Impulse Noise Protection (INP) Mode that the xTU receiver uses in the computation of the Equivalent INP. Note: In G.997.1, this parameter is called INM_INPEQ_MODE. See ITU-T Recommendation G.997.1. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats. object R This object contains statistics for a WAN DSL physical interface. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.Total. object R This object contains DSL total statistics. - 1.0
ReceiveBlocks unsignedInt R Total number of successfully received blocks, where a block is as defined in RFC 2662 [RFC2662]. This parameter is DEPRECATED because it is not available at either the G or the S/T interface. - 1.0
TransmitBlocks unsignedInt R Total number of successfully transmitted blocks, where a block is as defined in RFC 2662 [RFC2662]. This parameter is DEPRECATED because it is not available at either the G or the S/T interface. - 1.0
CellDelin unsignedInt R

Total number of cell-delineation errors (total seconds with NCD or LCD failures as defined in ITU-T Rec. G.997.1).

This parameter is DEPRECATED because it is not available at either the G or the S/T interface.

- 1.0
LinkRetrain unsignedInt R

Total number of link-retrain errors (Full Initialization Count as defined in ITU-T Rec. G.997.1).

This parameter is DEPRECATED because it is not available at either the G or the S/T interface.

- 1.0
InitErrors unsignedInt R

Total number of initialization errors (LINIT failures as defined in ITU-T Rec. G.997.1).

This parameter is DEPRECATED because it is not defined in G.997.1.

- 1.0
InitTimeouts unsignedInt R Total number of initialization timeout errors. - 1.0
LossOfFraming unsignedInt R

Total number of loss-of-framing errors (LOF failures as defined in ITU-T Rec. G.997.1).

This parameter is DEPRECATED because it is not defined in G.997.1.

- 1.0
ErroredSecs unsignedInt R

Total number of errored seconds (ES-L as defined in ITU-T Rec. G.997.1).

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 1.0
SeverelyErroredSecs unsignedInt R

Total number of severely errored seconds (SES-L as defined in ITU-T Rec. G.997.1).

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 1.0
FECErrors unsignedInt R

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

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 1.0
ATUCFECErrors unsignedInt R

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

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 1.0
HECErrors unsignedInt R

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

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 1.0
ATUCHECErrors unsignedInt R

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

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 1.0
CRCErrors unsignedInt R

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

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 1.0
ATUCCRCErrors unsignedInt R

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

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 1.0
LInit boolean R LInit is a flag to signal that a failure occurred as defined in G.997.1. - 1.0
LOF boolean R This parameter corresponds to LOF as defined in ITU-T Rec. G.997.1. LOF is a flag to signal that a failure occurred. - 1.0
ATUCErroredSecs unsignedInt R Total number of errored seconds detected by the ATU-C (ES-L as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
ATUCSeverelyErroredSecs unsignedInt R Total number of severely errored seconds detected by the ATU-C (SES-L as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.Showtime. object R This object contains DSL statistics accumulated since the most recent DSL Showtime. - 1.0
ReceiveBlocks unsignedInt R Number of successfully received blocks since the most recent DSL Showtime, where a block is as defined in RFC 2662 [RFC2662]. This parameter is DEPRECATED because it is not available at either the G or the S/T interface. - 1.0
TransmitBlocks unsignedInt R Number of successfully transmitted blocks since the most recent DSL Showtime, where a block is as defined in RFC 2662 [RFC2662]. This parameter is DEPRECATED because it is not available at either the G or the S/T interface. - 1.0
CellDelin unsignedInt R

Number of cell-delineation errors since the most recent DSL Showtime (total seconds with NCD or LCD failures as defined in ITU-T Rec. G.997.1).

This parameter is DEPRECATED because it is not available at either the G or the S/T interface.

- 1.0
LinkRetrain unsignedInt R

Number of link-retrain errors since the most recent DSL Showtime (Full Initialization Count as defined in ITU-T Rec. G.997.1).

This parameter is DEPRECATED because it is not available at either the G or the S/T interface.

- 1.0
InitErrors unsignedInt R

Number of initialization errors since the most recent DSL Showtime (LINIT failures as defined in ITU-T Rec. G.997.1).

This parameter is DEPRECATED because it is not defined in G.997.1.

- 1.0
InitTimeouts unsignedInt R Number of initialization timeout errors since the most recent DSL Showtime. - 1.0
LossOfFraming unsignedInt R

Number of loss-of-framing errors since the most recent DSL Showtime (LOF failures as defined in ITU-T Rec. G.997.1).

This parameter is DEPRECATED because it is not defined in G.997.1.

- 1.0
ErroredSecs unsignedInt R

Number of errored seconds since the most recent DSL Showtime (ES-L as defined in ITU-T Rec. G.997.1).

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 1.0
SeverelyErroredSecs unsignedInt R

Number of severely errored seconds since the most recent DSL Showtime (SES-L as defined in ITU-T Rec. G.997.1).

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 1.0
FECErrors unsignedInt R

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

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 1.0
ATUCFECErrors unsignedInt R

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

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 1.0
HECErrors unsignedInt R

Number of HEC errors detected since the most recent DSL Showtime (HEC-P as defined in ITU-T Rec. G.997.1).

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 1.0
ATUCHECErrors unsignedInt R

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

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 1.0
CRCErrors unsignedInt R

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

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 1.0
ATUCCRCErrors unsignedInt R

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

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 1.0
LInit boolean R LInit is a flag to signal that a failure occurred as defined in G.997.1. - 1.0
LOF boolean R This parameter corresponds to LOF as defined in ITU-T Rec. G.997.1. LOF is a flag to signal that a failure occurred. - 1.0
ATUCErroredSecs unsignedInt R Number of errored seconds since the most recent DSL Showtime detected by the ATU-C (ES-L as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
ATUCSeverelyErroredSecs unsignedInt R Number of severely errored seconds since the most recent DSL Showtime detected by the ATU-C (SES-L as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.LastShowtime. object R This object contains DSL statistics accumulated since the second most recent DSL Showtime. - 1.0
ReceiveBlocks unsignedInt R Number of successfully received blocks since the second most recent DSL Showtime, where a block is as defined in RFC 2662 [RFC2662]. This parameter is DEPRECATED because it is not available at either the G or the S/T interface. - 1.0
TransmitBlocks unsignedInt R Number of successfully transmitted blocks since the second most recent DSL Showtime, where a block is as defined in RFC 2662 [RFC2662]. This parameter is DEPRECATED because it is not available at either the G or the S/T interface. - 1.0
CellDelin unsignedInt R

Number of cell-delineation errors since the second most recent DSL Showtime (total seconds with NCD or LCD failures as defined in ITU-T Rec. G.997.1).

This parameter is DEPRECATED because it is not available at either the G or the S/T interface.

- 1.0
LinkRetrain unsignedInt R

Number of link-retrain errors since the second most recent DSL Showtime (Full Initialization Count as defined in ITU-T Rec. G.997.1).

This parameter is DEPRECATED because it is not available at either the G or the S/T interface.

- 1.0
InitErrors unsignedInt R

Number of initialization errors since the second most recent DSL Showtime (LINIT failures as defined in ITU-T Rec. G.997.1).

This parameter is DEPRECATED because it is not defined in G.997.1.

- 1.0
InitTimeouts unsignedInt R Number of initialization timeout errors since the second most recent DSL Showtime. - 1.0
LossOfFraming unsignedInt R

Number of loss-of-framing errors since the second most recent DSL Showtime (LOF failures as defined in ITU-T Rec. G.997.1).

This parameter is DEPRECATED because it is not defined in G.997.1.

- 1.0
ErroredSecs unsignedInt R

Number of errored seconds since the second most recent DSL Showtime (ES-L as defined in ITU-T Rec. G.997.1).

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

- 1.0
SeverelyErroredSecs unsignedInt R Number of severely errored seconds since the second most recent DSL Showtime (SES-L as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
FECErrors unsignedInt R Number of FEC errors detected since the second most recent DSL Showtime (FEC-C as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
ATUCFECErrors unsignedInt R Number of FEC errors detected by the ATU-C since the second most recent DSL Showtime (FEC-CFE as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
HECErrors unsignedInt R Number of HEC errors detected since the second most recent DSL Showtime (HEC-P as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
ATUCHECErrors unsignedInt R Number of HEC errors detected by the ATU-C since the second most recent DSL Showtime (HEC-PFE as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
CRCErrors unsignedInt R Number of CRC errors detected since the second most recent DSL Showtime (CV-C as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
ATUCCRCErrors unsignedInt R Number of CRC errors detected by the ATU-C since the second most recent DSL Showtime (CV-CFE as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
LInit boolean R LInit is a flag to signal that a failure occurred as defined in G.997.1. - 1.0
LOF boolean R This parameter corresponds to LOF as defined in ITU-T Rec. G.997.1. LOF is a flag to signal that a failure occurred. - 1.0
ATUCErroredSecs unsignedInt R Number of errored seconds since the second most recent DSL Showtime detected by the ATU-C (ES-L as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
ATUCSeverelyErroredSecs unsignedInt R Number of severely errored seconds since the second most recent DSL Showtime detected by the ATU-C (SES-L as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.CurrentDay. object R This object contains DSL statistics accumulated during the current day. - 1.0
ReceiveBlocks unsignedInt R Number of successfully received blocks during the current day, where a block is as defined in RFC 2662 [RFC2662]. This parameter is DEPRECATED because it is not available at either the G or the S/T interface. - 1.0
TransmitBlocks unsignedInt R Number of successfully transmitted blocks during the current day, where a block is as defined in RFC 2662 [RFC2662]. This parameter is DEPRECATED because it is not available at either the G or the S/T interface. - 1.0
CellDelin unsignedInt R Number of cell-delineation errors during the current day (total seconds with NCD or LCD failures as defined in ITU-T Rec. G.997.1). This parameter is DEPRECATED because it is not available at either the G or the S/T interface. - 1.0
LinkRetrain unsignedInt R Number of link-retrain errors during the current day (Full Initialization Count as defined in ITU-T Rec. G.997.1). This parameter is DEPRECATED because it is not available at either the G or the S/T interface. - 1.0
InitErrors unsignedInt R Number of initialization errors during the current day (LINIT failures as defined in ITU-T Rec. G.997.1). This parameter is DEPRECATED because it is not defined in G.997.1. - 1.0
InitTimeouts unsignedInt R Number of initialization timeout errors during the current day. - 1.0
LossOfFraming unsignedInt R Number of loss-of-framing errors during the current day (LOF failures as defined in ITU-T Rec. G.997.1). This parameter is DEPRECATED because it is not defined in G.997.1. - 1.0
ErroredSecs unsignedInt R Number of errored seconds during the current day (ES-L as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
SeverelyErroredSecs unsignedInt R Number of severely errored seconds during the current day (SES-L as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
FECErrors unsignedInt R Number of FEC errors detected during the current day (FEC-C as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
ATUCFECErrors unsignedInt R Number of FEC errors detected by the ATU-C during the current day (FEC-CFE as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
HECErrors unsignedInt R Number of HEC errors detected during the current day (HEC-P as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
ATUCHECErrors unsignedInt R Number of HEC errors detected by the ATU-C during the current day (HEC-PFE as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
CRCErrors unsignedInt R Number of CRC errors detected during the current day (CV-C as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
ATUCCRCErrors unsignedInt R Number of CRC errors detected by the ATU-C during the current day (CV-CFE as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
LInit boolean R LInit is a flag to signal that a failure occurred as defined in G.997.1. - 1.0
LOF boolean R This parameter corresponds to LOF as defined in ITU-T Rec. G.997.1. LOF is a flag to signal that a failure occurred. - 1.0
ATUCErroredSecs unsignedInt R Number of errored seconds during the current day detected by the ATU-C (ES-L as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
ATUCSeverelyErroredSecs unsignedInt R Number of severely errored seconds during the current day detected by the ATU-C (SES-L as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.QuarterHour. object R This object contains DSL statistics accumulated during the current quarter hour. - 1.0
ReceiveBlocks unsignedInt R Number of successfully received blocks during the current quarter hour, where a block is as defined in RFC 2662 [RFC2662]. This parameter is DEPRECATED because it is not available at either the G or the S/T interface. - 1.0
TransmitBlocks unsignedInt R Number of successfully transmitted blocks during the current quarter hour, where a block is as defined in RFC 2662 [RFC2662]. This parameter is DEPRECATED because it is not available at either the G or the S/T interface. - 1.0
CellDelin unsignedInt R Number of cell-delineation errors during the current quarter hour (total seconds with NCD or LCD failures as defined in ITU-T Rec. G.997.1). This parameter is DEPRECATED because it is not available at either the G or the S/T interface. - 1.0
LinkRetrain unsignedInt R Number of link-retrain errors during the current quarter hour (Full Initialization Count as defined in ITU-T Rec. G.997.1). This parameter is DEPRECATED because it is not available at either the G or the S/T interface. - 1.0
InitErrors unsignedInt R Number of initialization errors during the current quarter hour (LINIT failures as defined in ITU-T Rec. G.997.1). This parameter is DEPRECATED because it is not defined in G.997.1. - 1.0
InitTimeouts unsignedInt R Number of initialization timeout errors during the current quarter hour. - 1.0
LossOfFraming unsignedInt R Number of loss-of-framing errors during the current quarter hour (LOF failures as defined in ITU-T Rec. G.997.1). This parameter is DEPRECATED because it is not defined in G.997.1. - 1.0
ErroredSecs unsignedInt R Number of errored seconds during the current quarter hour (ES-L as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
SeverelyErroredSecs unsignedInt R Number of severely errored seconds during the current quarter hour (SES-L as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
FECErrors unsignedInt R Number of FEC errors detected during the current quarter hour (FEC-C as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
ATUCFECErrors unsignedInt R Number of FEC errors detected by the ATU-C during the current quarter hour (FEC-CFE as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
HECErrors unsignedInt R Number of HEC errors detected during the current quarter hour (HEC-P as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
ATUCHECErrors unsignedInt R Number of HEC errors detected by the ATU-C during the current quarter hour (HEC-PFE as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
CRCErrors unsignedInt R Number of CRC errors detected during the current quarter hour (CV-C as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
ATUCCRCErrors unsignedInt R Number of CRC errors detected by the ATU-C during the current quarter hour (CV-CFE as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
LInit boolean R LInit is a flag to signal that a failure occurred as defined in G.997.1. - 1.0
LOF boolean R This parameter corresponds to LOF as defined in ITU-T Rec. G.997.1. LOF is a flag to signal that a failure occurred. - 1.0
ATUCErroredSecs unsignedInt R Number of errored seconds during the current quarter hour detected by the ATU-C (ES-L as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
ATUCSeverelyErroredSecs unsignedInt R Number of severely errored seconds during the current quarter hour detected by the ATU-C (SES-L as defined in ITU-T Rec. G.997.1). Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.TestParams. object R This object contains the DSL test parameters that are available during the L0 (i.e., Showtime) state. - 1.0
HLOGGds unsignedInt R Number of sub-carriers per sub-carrier group in the downstream direction for HLOGpsds. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 1.0
HLOGGus unsignedInt R Number of sub-carriers per sub-carrier group in the upstream direction for HLOGpsus. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 1.0
HLOGpsds string[](:2559) R Comma-separated list (maximum number of characters 2559) of strings. Downstream logarithmic channel characteristics per sub-carrier group. The maximum number of elements is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGds but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: HLOGpsds is measured during initialization and is not updated during Showtime. - 1.0
HLOGpsus string[](:2559) R Comma-separated list (maximum number of characters 2559) of strings. Upstream logarithmic channel characteristics per sub-carrier group. The maximum number of elements is 64 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: HLOGpsus is measured during initialization and is not updated during Showtime. - 1.0
HLOGMTds unsignedInt R Indicates the number of symbols over which HLOGpsds was measured. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 1.0
HLOGMTus unsignedInt R Indicates the number of symbols over which HLOGpsus was measured. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 1.0
QLNGds unsignedInt R Number of sub-carriers per sub-carrier group in the downstream direction for QLNpsds. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 1.0
QLNGus unsignedInt R Number of sub-carriers per sub-carrier group in the upstream direction for QLNpsus. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 1.0
QLNpsds int[](:2047) R Comma-separated list (maximum number of characters 2047) of integers. Downstream quiet line noise per subcarrier group. The maximum number of elements is 256 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of QLNGds but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter should be set to None. Note: QLNpsds is measured during initialization and is not updated during Showtime. - 1.0
QLNpsus string[](:2047) R Comma-separated list (maximum number of characters 2047) of strings. Upstream quiet line noise per subcarrier group. The maximum number of elements is 64 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of QLNGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter should be set to None. Note: QLNpsus is measured during initialization and is not updated during Showtime. - 1.0
QLNMTds unsignedInt R Indicates the number of symbols over which QLNpsds was measured. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 1.0
QLNMTus unsignedInt R Indicates the number of symbols over which QLNpsus was measured. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 1.0
SNRGds unsignedInt R Number of sub-carriers per sub-carrier group in the downstream direction for SNRpsds. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 1.0
SNRGus unsignedInt R Number of sub-carriers per sub-carrier group in the upstream direction for SNRpsus. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 1.0
SNRpsds int[](:2047) R Comma-separated list (maximum number of characters 2047) of integers. Downstream SNR per subcarrier group. The maximum number of elements is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of elements will depend on the value of SNRGds but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter should be set to None. Note: SNRpsds is first measured during initialization and is updated during Showtime. - 1.0
SNRpsus string[](:2047) R Comma-separated list (maximum number of characters 2047) of strings. Upstream SNR per subcarrier group. The maximum number of elements is 64 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of SNRGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter should be set to None. Note: SNRpsus is first measured during initialization and is updated during Showtime. - 1.0
SNRMTds unsignedInt R Indicates the number of symbols over which SNRpsds was measured. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 1.0
SNRMTus unsignedInt R Indicates the number of symbols over which SNRpsus was measured. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 1.0
LATNds string[](:24) R Comma-separated list (maximum number of characters 24) of strings. Downstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of LATNds is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation G.997.1. - 1.0
LATNus string[](:24) R Comma-separated list (maximum number of characters 24) of strings. Upstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of upstream bands but will exceed one only for G.993.2. Interpretation of LATNus is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation G.997.1. - 1.0
SATNds string[](:24) R Comma-separated list (maximum number of characters 24) of strings. Downstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNds is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation G.997.1. - 1.0
SATNus string[](:24) R Comma-separated list (maximum number of characters 24) of strings. Upstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNus is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation G.997.1. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANEthernetInterfaceConfig. object(0:1) R

This object models physical layer properties specific to a single Ethernet physical connection used for Internet access on a CPE. This object is required for a CPE with an Ethernet WAN interface, and is exclusive of any other WANInterfaceConfig* object within a given WANDevice instance. Note that this object is not related to the Ethernet protocol layer sometimes used in associated with a DSL connection.

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

- 1.0
Enable boolean W Enables or disables this interface. - 1.0
Status string R

Indicates the status of this interface.

Enumeration of:

  • Up
  • NoLink
  • Error (OPTIONAL)
  • Disabled The Error value MAY be used by the CPE to indicate a locally defined error condition.
- 1.0
MACAddress string(:17) R [MACAddress] The physical address of the interface. - 1.0
MaxBitRate string W

The maximum upstream and downstream bit rate available to this connection. Enumeration of:

  • 10
  • 100
  • Auto (DELETED)
  • 1000
  • 10000
- 1.0
DuplexMode string W

The duplex mode available to this connection. Enumeration of:

  • Half
  • Full
  • Auto
- 1.0
ShapingRate int(-1:) W Rate to shape this connection’s egress traffic to. For leaky bucket (constant rate shaping), this is the constant rate. For token bucket (variable rate shaping), this is the average rate. If <= 100, in percent of the rate of the highest rate-constrained layer over which the packet will travel on egress. If > 100, in bits per second. A value of -1 indicates no shaping. For example, for packets destined for a WAN DSL interface, if the ATM layer is rate-constrained, then the rate is calculated relative to this rate. Otherwise, the rate is calculated relative to the physical-layer DSL rate. - 1.0
ShapingBurstSize unsignedInt W Burst size in bytes. For both leaky bucket (constant rate shaping) and token bucket (variable rate shaping) this is the bucket size and is therefore the maximum burst size. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANEthernetInterfaceConfig.Stats. object R This object contains statistics for an Ethernet WAN interface on a CPE device. - 1.0
BytesSent unsignedInt R Total number of bytes sent over the interface since the CPE was last reset. - 1.0
BytesReceived unsignedInt R Total number of bytes received over the interface since the CPE was last reset. - 1.0
PacketsSent unsignedInt R Total number of packets sent over the interface since the CPE was last reset. - 1.0
PacketsReceived unsignedInt R Total number of packets received over the interface since the CPE was last reset. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLConnectionManagement. object R This object is intended for a CPE with a DSL modem WAN interface. Note - This object was originally created to allow WANConnection devices and services to be added dynamically in the IGD object model in TR-064 because UPnP Device Architecture 1.0 did not contain this capability natively. Because in TR-069 objects can be created and removed using the AddObject and DeleteObject RPCs, WANConnection interfaces can be managed using these TR-069 mechanisms directly. Therefore, unlike the TR-064 equivalent, the ConnectionService table within this object is Read-Only in the TR-069 InternetGatewayDevice data model context. This object is OBSOLETED because it serves no purpose. - 1.0
ConnectionServiceNumberOfEntries unsignedInt R
Number of table entries in the ConnectionService table.
This parameter is OBSOLETED because it is within an OBSOLETED object. The CPE MAY return a value of 0 for this parameter, regardless of the number of connection services, in which case no ConnectionService instances will exist.
- 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLConnectionManagement.ConnectionService.{i}. object(0:) R
This table contains an entry for each connection service.
This object is OBSOLETED because it is within an OBSOLETED object.
At most one entry in this table can exist with a given value for WANConnectionService.
- 1.0
WANConnectionDevice string(:256) R
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.
This parameter is OBSOLETED because it is within an OBSOLETED object.
- 1.0
WANConnectionService string(:256) R
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. This parameter is OBSOLETED because it is within an OBSOLETED object.
- 1.0
DestinationAddress string(:256) R

Destination address of the WANConnectionDevice entry. One of:

  • PVC: VPI/VCI
  • SVC: ATM connection name
  • SVC: ATM address
The “PVC:” or “SVC:” prefix is part of the parameter value and MUST be followed by 0 or 1 space characters. For example, possible values for this parameter are “PVC:8/23” or “PVC: 0/35”. This parameter is OBSOLETED because it is within an OBSOLETED object.
- 1.0
LinkType string(:16) R
Link Type of the WANConnectionDevice entry. One of Link Types as described in WANDSLLinkConfig. This parameter is OBSOLETED because it is within an OBSOLETED object.
- 1.0
ConnectionType string(:16) R
Connection Type of the WANPPPConnection or WANIPConnection entry. One of PossibleConnectionTypes as described in WAN**Connection service.
This parameter is OBSOLETED because it is within an OBSOLETED object.
- 1.0
Name string(:32) R
User-readable name of the connection.
This parameter is OBSOLETED because it is within an OBSOLETED object.
- 1.0
InternetGatewayDevice.WANDevice.{i}.WANDSLDiagnostics. object R This object is to provide diagnostic information for a CPE with an ADSL2 or ADSL2+ modem WAN interface, but MAY also be used for ADSL. - 1.0
LoopDiagnosticsState string W

Indicates availability of diagnostic data. Enumeration of:

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

Downstream actual power spectral density. Interpretation of the value is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation G.997.1.

- 1.0
ACTPSDus int R

Upstream actual power spectral density. Interpretation of the value is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation G.997.1.

- 1.0
ACTATPds int R

Downstream actual aggregate transmitter power. Interpretation of the value is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation G.997.1.

- 1.0
ACTATPus int R

Upstream actual aggregate transmitter power. Interpretation of the value is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation G.997.1.

- 1.0
HLINSCds int R

Downstream linear representation scale. Interpretation of the value is as defined in ITU-T Rec. G.997.1.

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

- 1.0
HLINpsds int[](:61430) R Comma-separated list (maximum number of characters 61430) of integers. Downstream linear channel characteristics per subcarrier group. Maximum number of complex pairs is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of pairs will depend on the value of HLINGds but will not exceed 512. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: HLIN is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. - 1.0
QLNpsds int[](:61430) R Comma-separated list (maximum number of characters 61430) of integers. Downstream quiet line noise per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. For G.993.2, the number of elements will depend on the value of QLNGds but will not exceed 512. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: QLN is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. - 1.0
SNRpsds int[](:61430) R Comma-separated list (maximum number of characters 61430) of integers. Downstream SNR per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. For G.993.2, the number of elements will depend on the value of SNRGds but will not exceed 512. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: SNRps is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. - 1.0
BITSpsds int[](:61430) R Comma-separated list (maximum number of characters 61430) of integers. Downstream bit allocation per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. Interpretation of the value is as defined in ITU-T Rec. G.997.1. - 1.0
GAINSpsds int[](:61430) R Comma-separated list (maximum number of characters 61430) of integers. Downstream gain allocation per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. Interpretation of the value is as defined in ITU-T Rec. G.997.1. This parameter is DEPRECATED. - 1.0
HLINSCus int R Scaling used to represent the upstream linear channel characteristics. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 1.0
HLINGds unsignedInt R Number of sub-carriers per sub-carrier group in the downstream direction for HLINpsds. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 1.0
HLINGus unsignedInt R Number of sub-carriers per sub-carrier group in the downstream direction for HLINpsus. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 1.0
HLOGGds unsignedInt R Number of sub-carriers per sub-carrier group in the downstream direction for HLOGpsds. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 1.0
HLOGGus unsignedInt R Number of sub-carriers per sub-carrier group in the upstream direction for HLOGpsus. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 1.0
HLOGpsds string[](:2559) R Comma-separated list (maximum number of characters 2559) of strings. Downstream logarithmic channel characteristics per sub-carrier group. The maximum number of elements is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGds but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: HLOGpsds is measured during initialization and is not updated during Showtime. - 1.0
HLOGpsus string[](:2559) R Comma-separated list (maximum number of characters 2559) of strings. Upstream logarithmic channel characteristics per sub-carrier group. The maximum number of elements is 64 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: HLOGpsus is measured during initialization and is not updated during Showtime. - 1.0
HLOGMTds unsignedInt R Indicates the number of symbols over which HLOGpsds was measured. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 1.0
HLOGMTus unsignedInt R Indicates the number of symbols over which HLOGpsus was measured. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 1.0
LATNpbds string[](:24) R Comma-separated list (maximum number of characters 24) of strings. Downstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of LATNpbds is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation G.997.1. - 1.0
LATNpbus string[](:24) R Comma-separated list (maximum number of characters 24) of strings. Upstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of upstream bands but will exceed one only for G.993.2. Interpretation of LATNpbus is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation G.997.1. - 1.0
SATNds string[](:24) R Comma-separated list (maximum number of characters 24) of strings. Downstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNds is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation G.997.1. - 1.0
SATNus string[](:24) R Comma-separated list (maximum number of characters 24) of strings. Upstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNus is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation G.997.1. - 1.0
HLINpsus string[](:61430) R Comma-separated list (maximum number of characters 61430) of strings. Upstream linear channel characteristics per sub-carrier group. Maximum number of complex pairs is 64 for G.992.3, and G.992.5. For G.993.2, the number of pairs will depend on the value of HLINGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: HLIN is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. - 1.0
QLNGds unsignedInt R Number of sub-carriers per sub-carrier group in the downstream direction for QLNpsds. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 1.0
QLNGus unsignedInt R Number of sub-carriers per sub-carrier group in the upstream direction for QLNpsus. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 1.0
QLNpsus string[](:61430) R Comma-separated list (maximum number of characters 61430) of strings. Upstream quiet line noise per subcarrier group. The maximum number of elements is 64 for G.992.3, and G.992.5. For G.993.2, the number of elements will depend on the value of QLNGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: QLN is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. - 1.0
QLNMTds unsignedInt R Indicates the number of symbols over which QLNpsds was measured. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 1.0
QLNMTus unsignedInt R Indicates the number of symbols over which QLNpsus was measured. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 1.0
SNRGds unsignedInt R Number of sub-carriers per sub-carrier group in the downstream direction for SNRpsds. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 1.0
SNRGus unsignedInt R Number of sub-carriers per sub-carrier group in the upstream direction for SNRpsus. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 1.0
SNRpsus string[](:61430) R Comma-separated list (maximum number of characters 61430) of strings. Upstream SNR per subcarrier group. The maximum number of elements is 64 for G.992.3, and G.992.5. For G.993.2, the number of elements will depend on the value of SNRGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: SNRps is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. - 1.0
SNRMTds unsignedInt R Indicates the number of symbols over which SNRpsds was measured. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 1.0
SNRMTus unsignedInt R Indicates the number of symbols over which SNRpsus was measured. Note: See ITU-T Recommendation G.997.1. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 1.0
BITSpsus string[](:61430) R Comma-separated list (maximum number of characters 61430) of strings. Upstream bit allocation per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. Interpretation of the value is as defined in ITU-T Rec. G.997.1. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}. object(0:) W

Each instance contains objects associated with a given WAN link. In the case of DSL, each instance corresponds to either a single ATM VC or a PTM Ethernet link. On creation of a WANConnectionDevice instance, there are initially no connection objects contained within. In the case of Ethernet (interface or link), only one WANConnectionDevice instance is supported.

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

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

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

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

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.

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

- 1.0
WANIPConnectionNumberOfEntries unsignedInt R Number of instances of WANIPConnection in this WANConnectionDevice. - 1.0
WANPPPConnectionNumberOfEntries unsignedInt R Number of instances of WANPPPConnection in this WANConnectionDevice. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANDSLLinkConfig. object(0:1) R

This object models the ATM layer properties specific to a single physical connection of a DSL modem used for Internet access on a CPE. This object is intended for a CPE with a DSL modem WAN interface, and is exclusive of any other WANLinkConfig* object within a given WANConnectionDevice instance.

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

- 1.0
Enable boolean W Enables or disables the link. On creation of a WANConnectionDevice, this object is disabled by default. false 1.0
LinkStatus string R

Status of the link. Enumeration of:

  • Up
  • Down
  • Initializing
  • Unavailable
- 1.0
LinkType string W

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

  • EoA (RFC 2684 [RFC2684] bridged Ethernet over ATM)
  • IPoA (RFC 2684 [RFC2684] routed IP over ATM)
  • PPPoA (RFC 2364 [RFC2634] PPP over ATM)
  • PPPoE (RFC 2516 [RFC2516] PPP over Ethernet on RFC 2684 [RFC2684] bridged Ethernet over ATM, DEPRECATED)
  • CIP (RFC 2225 [RFC2225] Classical IP over ATM)
  • Unconfigured The value {{enum: reference to deprecated enumeration InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANDSLLinkConfig.LinkType.PPPoE}} has always been DEPRECATED and EoA SHOULD be used instead (see [Annex B/TR-098a2]). The ACS MUST NOT set this parameter to {{enum: reference to deprecated enumeration InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANDSLLinkConfig.LinkType.PPPoE}} and the CPE MUST reject attempts to do so.
Unconfigured 1.0
AutoConfig boolean R Indicates if the CPE is currently using some auto configuration mechanisms for this connection. If this variable is true, all writable variables in this connection instance become read-only. Any attempt to change one of these variables SHOULD fail and an error SHOULD be returned. - 1.0
ModulationType string R

Indicates the type of DSL modulation used on the interface associated with this connection (duplication from WANDSLInterfaceConfig). Enumeration of:

  • ADSL_G.dmt
  • ADSL_G.lite
  • ADSL_G.dmt.bis
  • ADSL_re-adsl
  • ADSL_2plus
  • ADLS_four
  • ADSL_ANSI_T1.413
  • G.shdsl
  • IDSL
  • HDSL
  • SDSL
  • VDSL
- 1.0
DestinationAddress string(:256) W

Destination address of this link. One of:

  • PVC: VPI/VCI
  • SVC: ATM connection name
  • SVC: ATM address

The “PVC:” or “SVC:” prefix is part of the parameter value and MUST be followed by 0 or 1 space characters. For example, possible values for this parameter are “PVC:8/23” or “PVC: 0/35”.

- 1.0
ATMEncapsulation string W

Identifies the connection encapsulation that will be used. Enumeration of:

  • LLC
  • VCMUX
- 1.0
FCSPreserved boolean W This flag tells if a checksum SHOULD be added in the ATM payload. It does not refer to the checksum of one of the ATM cells or AALX packets. In case of LLC or VCMUX encapsulation, this ATM checksum is the FCS field described in RFC 2684 [RFC2684]. It is only applicable in the upstream direction. - 1.0
VCSearchList string[](:256) W Comma-separated list (maximum number of characters 256) of strings. Ordered list of VPI/VCI pairs to search if a link using the DestinationAddress cannot be established. In the form:
  • VPI1/VCI1, VPI2/VCI2, … Example:
  • 0/35, 8/35, 1/35
- 1.0
ATMAAL string R

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

  • AAL1
  • AAL2
  • AAL3
  • AAL4
  • AAL5
- 1.0
ATMTransmittedBlocks unsignedInt R The current count of successfully transmitted cells. - 1.0
ATMReceivedBlocks unsignedInt R The current count of successfully received cells. - 1.0
ATMQoS string W

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

  • UBR
  • CBR
  • GFR
  • VBR-nrt
  • VBR-rt
  • UBR+
  • ABR
- 1.0
ATMPeakCellRate unsignedInt W Specifies the upstream peak cell rate in cells per second. - 1.0
ATMMaximumBurstSize unsignedInt W Specifies the upstream maximum burst size in cells. - 1.0
ATMSustainableCellRate unsignedInt W Specifies the upstream sustainable cell rate, in cells per second, used for traffic shaping. - 1.0
AAL5CRCErrors unsignedInt R

Count of the AAL5 layer cyclic redundancy check errors.

This parameter is DEPRECATED because it overlaps with the ATMCRCErrors parameter. If present, it MUST have the same value as the ATMCRCErrors parameter if AAL5 is in use, or 0 if AAL5 is not in use.

- 1.0
ATMCRCErrors unsignedInt R Count of the ATM layer cyclic redundancy check (CRC) errors. This refers to CRC errors at the ATM adaptation layer (AAL). The AAL in use is indicated by the ATMAAL parameter. The value of the ATMCRCErrors parameter MUST be 0 for AAL types that have no CRCs. - 1.0
ATMHECErrors unsignedInt R Count of the number of Header Error Check related errors at the ATM layer. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANATMF5LoopbackDiagnostics. object R This object is provides access to an ATM-layer F5 OAM loopback test. - 1.0
DiagnosticsState string W

Indicates availability of diagnostic data. Enumeration of:

  • None (READONLY)
  • Requested
  • Complete (READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY) If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object instance) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters.
None 1.0
NumberOfRepetitions unsignedInt(1:) W Number of repetitions of the ping test to perform before reporting the results. 1 1.0
Timeout unsignedInt(1:) W Timeout in milliseconds for the ping test. - 1.0
SuccessCount unsignedInt R Result parameter indicating the number of successful pings (those in which a successful response was received prior to the timeout) in the most recent ping test. 0 1.0
FailureCount unsignedInt R Result parameter indicating the number of failed pings in the most recent ping test. 0 1.0
AverageResponseTime unsignedInt R Result parameter indicating the average response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. 0 1.0
MinimumResponseTime unsignedInt R Result parameter indicating the minimum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. 0 1.0
MaximumResponseTime unsignedInt R Result parameter indicating the maximum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. 0 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPTMLinkConfig. object(0:1) R

This object models the PTM layer properties specific to a layer 2 interface of a DSL modem used for Internet access on a CPE. This object is intended for a CPE with a DSL modem WAN interface, and is exclusive of any other WANLinkConfig* object within a given WANConnectionDevice instance. The PTM Link Layer object exists when the WANDSLInterfaceConfig LinkEncapsulationSupported parameter includes any of:

  • G.992.3_Annex_K_PTM
  • G.993.2_Annex_K_PTM
  • G.994.1

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

- 1.0
Enable boolean W Enables or disables the link. On creation of a WANConnectionDevice, this object is disabled by default. false 1.0
LinkStatus string R

Status of the link. Enumeration of:

  • Up
  • Down
  • Initializing
  • Unavailable
- 1.0
MACAddress string(:17) R [MACAddress] The physical address of the interface. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPTMLinkConfig.Stats. object R This object represents the statistics collected and returned over a PTM link. - 1.0
BytesSent unsignedInt R 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 R 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
FramesSent unsignedInt R The total number of packets (frames) transmitted out of the interface. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
FramesReceived unsignedInt R The total number of packets (frames) which were received on this interface. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
OOSNearEnd boolean R Indication that the CPE has detected the link is Out of Synchronization since the CPE rebooted or the interface was last enabled. - 1.0
OOSFarEnd boolean R Indication that the remote device has detected the link is Out of Synchronization since the CPE rebooted or the interface was last enabled. - 1.0
ErrorsSent unsignedInt R 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.0
ErrorsReceived unsignedInt R 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.0
UnicastPacketsSent unsignedInt R 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.0
UnicastPacketsReceived unsignedInt R 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.0
DiscardPacketsSent unsignedInt R The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
DiscardPacketsReceived unsignedInt R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being 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.0
MulticastPacketsSent unsignedInt R 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.0
MulticastPacketsReceived unsignedInt R 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.0
BroadcastPacketsSent unsignedInt R 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.0
BroadcastPacketsReceived unsignedInt R 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.0
UnknownProtoPacketsReceived unsignedInt R 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.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANEthernetLinkConfig. object(0:1) R

This object models the Ethernet link layer properties specific to a single physical connection used for Internet access on a CPE. This object is intended for a CPE with an Ethernet WAN interface, and is exclusive of any other WANLinkConfig* object within a given WANConnectionDevice instance. Note that this object is not related to the Ethernet protocol layer sometimes used in associated with a DSL connection.

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

- 1.0
EthernetLinkStatus string R

Status of the Ethernet link. Enumeration of:

  • Up
  • Down
  • Unavailable
- 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPOTSLinkConfig. object(0:1) R

This object models the POTS link layer properties specific to a single physical connection used for Internet access on a CPE. This object is intended for a CPE with a POTS WAN interface, and is exclusive of any other WANLinkConfig* object within a given WANConnectionDevice instance.

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

- 1.0
Enable boolean W Enables or disables the link. On creation of a WANConnectionDevice, this object is disabled by default. false 1.0
LinkStatus string R

Status of the link. Enumeration of:

  • Up
  • Down
  • Dialing
  • Connecting
  • Unavailable
- 1.0
ISPPhoneNumber string(:64) W Specifies a list of strings separated by semicolon (;), each string representing a phone number to connect to a particular ISP. The digits of the phone number follow the semantics of the ITU-T E.164 specification. Delimiters such as brackets or hyphens between the digits of a phone number are to be ignored by the CPE. 1.0
ISPInfo string(:64) W Information identifying the Internet Service Provider. The format of the string is vendor specific. 1.0
LinkType string W

This variable indicates the type of POTS link used for the dialup connection. Enumeration of:

  • PPP_Dialup
PPP_Dialup 1.0
NumberOfRetries unsignedInt W The number of times the CPE SHOULD attempt an Internet connection setup before returning error. - 1.0
DelayBetweenRetries unsignedInt W The number of seconds the CPE SHOULD wait between attempts to setup an Internet connection. - 1.0
Fclass string[] R

Comma-separated list of strings. Specifies capabilities of the POTS modem - i.e., if it handles data (0), fax (1,2,2.0), voice (8), DSVD (80). Each list item is an enumeration of:

  • 0
  • 1
  • 2
  • 2.0
  • 8
  • 80
- 1.0
DataModulationSupported string R

The modulation standard currently being used for data. Enumeration of:

  • V92
  • V90
  • V34
  • V32bis
  • V32
- 1.0
DataProtocol string R

The protocol standard currently being used for data transfers. Enumeration of:

  • V42_LAPM
  • V42_MNP4
  • V14
  • V80
- 1.0
DataCompression string R

The compression technology implemented on the modem. Enumeration of:

  • V42bis
  • MNP5
- 1.0
PlusVTRCommandSupported boolean R Capability for full duplex operation with data and voice. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}. object(0:) W

This object enables configuration of IP connections on the WAN interface of a CPE.

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 (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 ExternalIPAddress.

- 1.0
Enable boolean W Enables or disables the connection instance. On creation of a WANIPConnection instance, it is initially disabled. false 1.0
Alias string(:64) W

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

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

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

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

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

- 1.0
Reset boolean W When set to true, the device MUST tear down the existing IP connection represented by this object and establish a new one. The device MUST initiate the reset after completion of the current CWMP session. The device MAY delay resetting the connection in order to avoid interruption of a user service such as an ongoing voice call. When read, this parameter always returns false. false 1.0
ConnectionStatus string R

Current status of the connection.

Enumeration of:

  • Unconfigured
  • Connecting
  • Connected
  • PendingDisconnect
  • Disconneting (DEPRECATED)
  • Disconnecting
  • Disconnected The value {{enum: reference to deprecated enumeration InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.ConnectionStatus.Disconneting}} is DEPRECATED because it is a typo. The ACS MUST treat {{enum: reference to deprecated enumeration InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.ConnectionStatus.Disconneting}} and Disconnecting the same.
- 1.0
PossibleConnectionTypes string[] R

Comma-separated list of strings. Types of connections possible for this connection instance. Each list item is an enumeration of:

  • Unconfigured
  • IP_Routed
  • IP_Bridged
- 1.0
ConnectionType string W

Specifies the connection type of the connection instance. Enumeration of:

  • Unconfigured
  • IP_Routed
  • IP_Bridged
- 1.0
Name string(:256) W User-readable name of this connection. - 1.0
Uptime unsignedInt R The time in seconds that this connection has been up. - 1.0
LastConnectionError string R

The cause of failure for the last connection setup attempt. Enumeration of:

  • ERROR_NONE
  • ERROR_COMMAND_ABORTED
  • ERROR_NOT_ENABLED_FOR_INTERNET
  • ERROR_USER_DISCONNECT
  • ERROR_ISP_DISCONNECT
  • ERROR_IDLE_DISCONNECT
  • ERROR_FORCED_DISCONNECT
  • ERROR_NO_CARRIER
  • ERROR_IP_CONFIGURATION
  • ERROR_UNKNOWN
ERROR_NONE 1.0
AutoDisconnectTime unsignedInt W The time in seconds since the establishment of the connection after which connection termination is automatically initiated by the CPE. This occurs irrespective of whether the connection is being used or not. A value of 0 (zero) indicates that the connection is not to be shut down automatically. - 1.0
IdleDisconnectTime unsignedInt W The time in seconds that if the connection remains idle, the CPE automatically terminates the connection. A value of 0 (zero) indicates that the connection is not to be shut down automatically. - 1.0
WarnDisconnectDelay unsignedInt W Time in seconds the Status remains in the pending disconnect state before transitioning to disconnecting state to drop the connection. - 1.0
RSIPAvailable boolean R Indicates if Realm-specific IP (RSIP) is available as a feature on the CPE. - 1.0
NATEnabled boolean W Indicates if Network Address Translation (NAT) is enabled for this connection. - 1.0
AddressingType string W

The method used to assign an address to the WAN side interface of the CPE for this connection. Enumeration of:

  • DHCP
  • Static
- 1.0
ExternalIPAddress string(:45) W

[IPAddress] This is the external IP address used by NAT for this connection. This parameter is configurable only if the AddressingType is Static.

If Active Notification is enabled, the CPE MUST initiate an Inform whenever either the value of this parameter changes or the default WAN connection changes to a different connection.

- 1.0
SubnetMask string(:45) W [IPAddress] Subnet mask of the WAN interface. This parameter is configurable only if the AddressingType is Static. - 1.0
DefaultGateway string W The IP address of the default gateway for this connection. This parameter is configurable only if the AddressingType is Static. - 1.0
DNSEnabled boolean W Whether or not the device SHOULD attempt to query a DNS server across this connection. true 1.0
DNSOverrideAllowed boolean W Whether or not a manually set, non-empty DNS address can be overridden by a DNS entry received from the WAN. false 1.0
DNSServers string(:45)[](:64) W [IPAddress] Comma-separated list (maximum number of characters 64) of IP Addresses. DNS server IP addresses for this connection. Support for more than three DNS Servers is OPTIONAL. - 1.0
MaxMTUSize unsignedInt(1:1540) W The maximum allowed size of an Ethernet frame from LAN-side devices. - 1.0
MACAddress string(:17) W [MACAddress] The physical address of the WANIPConnection if applicable. Configurable only if MACAddressOverride is present and true. - 1.0
MACAddressOverride boolean W Whether the value of MACAddress parameter can be overridden. If false, the CPE’s default value is used (or restored if it had previously been overridden). - 1.0
ConnectionTrigger string W

Trigger used to establish the IP connection.

Enumeration of:

  • OnDemand
  • AlwaysOn
  • Manual The above values are defined as follows:
  • OnDemand: If this IP connection is disconnected for any reason, it is to remain disconnected until the CPE has one or more packets to communicate over this connection, at which time the CPE automatically attempts to reestablish the connection.
  • AlwaysOn: If this IP connection is disconnected for any reason, the CPE automatically attempts to reestablish the connection (and continues to attempt to reestablish the connection as long it remains disconnected).
  • Manual: If this IP connection is disconnected for any reason, it is to remain disconnected until the user of the CPE explicitly instructs the CPE to reestablish the connection. Note that the reason for an IP connection becoming disconnected to begin with might be either external to the CPE, such as non-renewal of a DHCP lease or momentary disconnection of the physical interface, or internal to the CPE, such as use of the IdleDisconnectTime and/or AutoDisconnectTime parameters in this object. Note also that the means by which a CPE would keep an IP connection disconnected (while waiting for the designated trigger) if it is otherwise physically connected and has an IP address is a local matter specific to the implementation of the CPE.
OnDemand 1.0
RouteProtocolRx string W

Defines the Rx protocol to be used. Enumeration of:

  • Off
  • RIPv1 (OPTIONAL)
  • RIPv2 (OPTIONAL)
  • OSPF (OPTIONAL)
Off 1.0
PortMappingNumberOfEntries unsignedInt R Total number of port mapping entries. - 1.0
ShapingRate int(-1:) W Rate to shape this connection’s egress traffic to. For leaky bucket (constant rate shaping), this is the constant rate. For token bucket (variable rate shaping), this is the average rate. If <= 100, in percent of the rate of the highest rate-constrained layer over which the packet will travel on egress. If > 100, in bits per second. A value of -1 indicates no shaping. For example, for packets destined for a WAN DSL interface, if the ATM layer is rate-constrained, then the rate is calculated relative to this rate. Otherwise, the rate is calculated relative to the physical-layer DSL rate. -1 1.0
ShapingBurstSize unsignedInt W Burst size in bytes. For both leaky bucket (constant rate shaping) and token bucket (variable rate shaping) this is the bucket size and is therefore the maximum burst size. 0 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.DHCPClient. object R This object contains DHCP client configuration parameters. - 1.0
SentDHCPOptionNumberOfEntries unsignedInt R The number of entries in the SentDHCPOption table. - 1.0
ReqDHCPOptionNumberOfEntries unsignedInt R The number of entries in the ReqDHCPOption table. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.DHCPClient.SentDHCPOption.{i}. object(0:) W

Each instance of this object represents a DHCP option that MUST, if enabled, be sent in DHCP client requests. All sent DHCP options MUST be listed.

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

- 1.0
Enable boolean W Enables or disables this SentDHCPOption table entry. false 1.0
Alias string(:64) W

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

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

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

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.

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

- 1.0
Tag unsignedInt(1:254) W Option tag as defined in RFC 2132 [RFC2132]. - 1.0
Value base64(0:255) W Base64 encoded option value. 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.DHCPClient.ReqDHCPOption.{i}. object(0:) W

Each instance of this object represents a DHCP option that MUST, if enabled, be requested in DHCP client requests. All requested DHCP options MUST be listed.

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

- 1.0
Enable boolean W Enables or disables this ReqDHCPOption table entry. false 1.0
Alias string(:64) W

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

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

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

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.

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

- 1.0
Order unsignedInt(1:) W Position of the option in the DHCP client request. A value of 1 indicates the first entry. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value on creation of a ReqDHCPOption table entry MUST be one greater than the largest current value. - 1.0
Tag unsignedInt(1:254) W Option tag as defined in RFC 2132 [RFC2132]. - 1.0
Value base64(0:255) R Base64 encoded most recently received DHCP option value. If no option value has been received, then the value MUST represent an empty string. Received DHCP option values MAY, but need not, persist across CPE reboots. 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.PortMapping.{i}. object(0:) W

Port mapping table. This table MUST contain all NAT port mappings associated with this connection, including static and dynamic port mappings programmatically created via local control protocol, such as UPnP. This table MUST NOT contain dynamic NAT binding entries associated with the normal operation of NAT. At most one entry in an instance of this table can exist with all of the same values for RemoteHost, ExternalPort, and PortMappingProtocol. If the ACS attempts to set the parameters of an existing entry such that this requirement would be violated, the CPE MUST reject the request. In this case, the SetParameterValues response MUST include a SetParameterValuesFault element for each parameter in the corresponding request whose modification would have resulted in such a violation. On creation of a new table entry, the CPE MUST choose default values for ExternalPort and PortMappingProtocol such that the new entry does not conflict with any existing entry.

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

- 1.0
PortMappingEnabled boolean W Enables or disables the port mapping instance. On creation, an entry is disabled by default. false 1.0
Alias string(:64) W

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

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

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

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of RemoteHost, ExternalPort and PortMappingProtocol. Note: There is no guarantee that the Alias value on automatically-created PortMapping instances will be retained. This is because automatically-created PortMapping instances can be transitory.

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

- 1.0
PortMappingLeaseDuration unsignedInt W Determines the time to live, in seconds, of a port-mapping lease, where “time to live” means the number of seconds before the port mapping expires. A value of 0 means the port mapping is static. Support for dynamic (non-static) port mappings is OPTIONAL. That is, the only value for PortMappingLeaseDuration that MUST be supported is 0. For a dynamic (non-static) port mapping, when this parameter is read, the value represents the time remaining on the port-mapping lease. That is, for a dynamic port mapping, the value counts down toward 0. When a dynamic port-mapping lease expires, the CPE MUST automatically terminate that port mapping, and MUST automatically delete the corresponding PortMapping table entry. - 1.0
RemoteHost string W This parameter is the IP address of the source of inbound packets. An empty string indicates a “wildcard” (this will be a wildcard in most cases). CPE are REQUIRED only to support wildcards. When RemoteHost is a wildcard, all traffic sent to the ExternalPort on the WAN interface of the gateway is forwarded to the InternalClient on the InternalPort. When RemoteHost is specified as one external IP address, the NAT will only forward inbound packets from this RemoteHost to the InternalClient, all other packets will be dropped. If a CPE supports non-wildcard values for RemoteHost, it MAY additionally support the ability to have more than one port mapping with the same ExternalPort and PortMappingProtocol, but with differing values of RemoteHost. When wildcard values are used for RemoteHost and/or ExternalPort, the following precedence order applies (with the highest precedence listed first):
  1. Explicit RemoteHost, explicit ExternalPort
  2. Explicit RemoteHost, wildcard ExternalPort
  3. Wildcard RemoteHost, explicit ExternalPort
  4. Wildcard RemoteHost, wildcard ExternalPort If an incoming packet matches the criteria associated with more than one entry in this table, the CPE MUST apply the port mapping associated with the highest precedence entry. At most one entry in this table can exist with all of the same values for RemoteHost, ExternalPort, and PortMappingProtocol.
1.0
ExternalPort unsignedInt W The external port (or the first port of a range of external ports) that the NAT gateway would listen on for connection requests to a corresponding InternalPort. Inbound packets to this external port on the WAN interface SHOULD be forwarded to InternalClient on the InternalPort. A value of zero (0) represents a “wildcard”. If this value is a wildcard, connection requests on all external ports (that are not otherwise mapped) will be forwarded to InternalClient. In the wildcard case, the value(s) of InternalPort on InternalClient are ignored. When wildcard values are used for RemoteHost and/or ExternalPort, the following precedence order applies (with the highest precedence listed first):
  1. Explicit RemoteHost, explicit ExternalPort
  2. Explicit RemoteHost, wildcard ExternalPort
  3. Wildcard RemoteHost, explicit ExternalPort
  4. Wildcard RemoteHost, wildcard ExternalPort If an incoming packet matches the criteria associated with more than one entry in this table, the CPE MUST apply the port mapping associated with the highest precedence entry. At most one entry in this table can exist with all of the same values for RemoteHost, ExternalPort, and PortMappingProtocol.
- 1.0
InternalPort unsignedInt W The port on InternalClient that the gateway SHOULD forward connection requests to. A value of zero (0) is not allowed. - 1.0
PortMappingProtocol string W

The protocol of the port mapping.

Enumeration of:

  • TCP
  • UDP At most one entry in this table can exist with all of the same values for RemoteHost, ExternalPort, and PortMappingProtocol.
- 1.0
InternalClient string(:256) W The IP address or DNS host name of an internal client (on the LAN). Support for an IP address is mandatory. If InternalClient is specified as an IP address and the LAN device’s IP address subsequently changes, the port mapping MUST remain associated with the original IP address. Support for DNS host names is OPTIONAL. If InternalClient is specified as a DNS host name and the LAN device’s IP address subsequently changes, the port mapping MUST remain associated with this LAN device. In this case, it is the responsibility of the CPE to maintain the name-to-address mapping in the event of IP address changes. This can be accomplished, for example, by assigning the DNS host name via use of DHCP option 12 (Host Name) or option 81 (FQDN). Note that the ACS can learn the host name associated with a given LAN device via the Hosts table (InternetGatewayDevice.LANDevice.{i}.Hosts). Read access to this parameter MUST always return the exact value that was last set by the ACS. For example, if the internal client is set to a DNS host name, it MUST read back as a DNS host name and not as an IP address. An empty string indicates an unconfigured InternalClient. If this parameter is unconfigured, this port mapping MUST NOT be operational. It MUST be possible to set the InternalClient to the broadcast IP address 255.255.255.255 for UDP mappings. This is to enable multiple NAT clients to use the same well-known port simultaneously. 1.0
PortMappingDescription string(:256) W User-readable description of this port mapping. 1.0
ExternalPortEndRange unsignedInt W Indicates the last port of the external port range that starts with ExternalPort. If an external port range is specified, then the behavior described for ExternalPort applies to all ports within the range. A value of zero (0) indicates that no external port range is specified, i.e. that the range consists only of ExternalPort. If ExternalPort is zero (wildcard), the value of this parameter MUST be ignored. If specified, the value of this parameter MUST be greater than or equal to the value of ExternalPort. 0 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.Stats. object R This object contains statistics for all connections within the same WANConnectionDevice that share a common MAC address. The contents of this object SHOULD be identical for each such connection. This object is intended only for WANConnectionDevices that can support an Ethernet-layer on this interface (e.g., PPPoE, IPoE). - 1.0
EthernetBytesSent unsignedInt R The total number of bytes transmitted, including framing characters, over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetBytesReceived unsignedInt R The total number of bytes received, including framing characters, over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetPacketsSent unsignedInt R The total number of packets transmitted over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetPacketsReceived unsignedInt R The total number of packets which were received over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetErrorsSent unsignedInt R The total number of outbound packets that could not be transmitted because of errors, over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetErrorsReceived unsignedInt R The total number of inbound packets that contained errors preventing them from being deliverable, over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetUnicastPacketsSent unsignedInt R 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, over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetUnicastPacketsReceived unsignedInt R The total number of received packets which were not addressed to a multicast or broadcast address, over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetDiscardPacketsSent unsignedInt R The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted, over all connections within the same WANConnectionDevice that share a common MAC address. 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.0
EthernetDiscardPacketsReceived unsignedInt R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being deliverable, over all connections within the same WANConnectionDevice that share a common MAC address. 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.0
EthernetMulticastPacketsSent unsignedInt R The total number of packets requested for transmission, including those that were discarded or not sent, which were addressed to a multicast address, over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetMulticastPacketsReceived unsignedInt R The total number of received packets which were addressed to a multicast address, over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetBroadcastPacketsSent unsignedInt R The total number of packets requested for transmission, including those that were discarded or not sent, which were addressed to a broadcast address, over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetBroadcastPacketsReceived unsignedInt R The total number of received packets which were addressed to a broadcast address, over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetUnknownProtoPacketsReceived unsignedInt R The total number of packets which were discarded because of an unknown or unsupported protocol, received over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}. object(0:) W

This object enables configuration of PPP connections on the WAN interface of a CPE.

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 (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 ExternalIPAddress.

- 1.0
Enable boolean W Enables or disables the connection instance. On creation of a WANPPPConnection instance, it is initially disabled. false 1.0
Alias string(:64) W

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

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

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

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

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

- 1.0
Reset boolean W When set to true, the device MUST tear down the existing PPP connection represented by this object and establish a new one. The device MUST initiate the reset after completion of the current CWMP session. The device MAY delay resetting the connection in order to avoid interruption of a user service such as an ongoing voice call. When read, this parameter always returns false. false 1.0
ConnectionStatus string R

Current status of the connection. Enumeration of:

  • Unconfigured
  • Connecting
  • Authenticating
  • Connected
  • PendingDisconnect
  • Disconnecting
  • Disconnected
- 1.0
PossibleConnectionTypes string[] R

Comma-separated list of strings. Types of connections possible for this connection instance. Each list item is an enumeration of:

  • Unconfigured
  • IP_Routed
  • DHCP_Spoofed
  • PPPoE_Bridged
  • PPPoE_Relay
  • PPTP_Relay
  • L2TP_Relay
- 1.0
ConnectionType string W

Specifies the connection type of the connection instance. Enumeration of:

  • Unconfigured
  • IP_Routed
  • DHCP_Spoofed
  • PPPoE_Bridged
  • PPPoE_Relay
  • PPTP_Relay
  • L2TP_Relay
- 1.0
PPPoESessionID unsignedInt(1:) R Represents the PPPoE Session ID. - 1.0
Name string(:256) W User-readable name of this connection. - 1.0
Uptime unsignedInt R The time in seconds that this connection has been up. - 1.0
LastConnectionError string R

The cause of failure for the last connection setup attempt. Enumeration of:

  • ERROR_NONE
  • ERROR_ISP_TIME_OUT
  • ERROR_COMMAND_ABORTED
  • ERROR_NOT_ENABLED_FOR_INTERNET
  • ERROR_BAD_PHONE_NUMBER
  • ERROR_USER_DISCONNECT
  • ERROR_ISP_DISCONNECT
  • ERROR_IDLE_DISCONNECT
  • ERROR_FORCED_DISCONNECT
  • ERROR_SERVER_OUT_OF_RESOURCES
  • ERROR_RESTRICTED_LOGON_HOURS
  • ERROR_ACCOUNT_DISABLED
  • ERROR_ACCOUNT_EXPIRED
  • ERROR_PASSWORD_EXPIRED
  • ERROR_AUTHENTICATION_FAILURE
  • ERROR_NO_DIALTONE
  • ERROR_NO_CARRIER
  • ERROR_NO_ANSWER
  • ERROR_LINE_BUSY
  • ERROR_UNSUPPORTED_BITSPERSECOND
  • ERROR_TOO_MANY_LINE_ERRORS
  • ERROR_IP_CONFIGURATION
  • ERROR_UNKNOWN
ERROR_NONE 1.0
AutoDisconnectTime unsignedInt W The time in seconds since the establishment of the connection after which connection termination is automatically initiated by the CPE. This occurs irrespective of whether the connection is being used or not. A value of 0 (zero) indicates that the connection is not to be shut down automatically. - 1.0
IdleDisconnectTime unsignedInt W The time in seconds that if the connection remains idle, the CPE automatically terminates the connection. A value of 0 (zero) indicates that the connection is not to be shut down automatically. - 1.0
WarnDisconnectDelay unsignedInt W Time in seconds the Status remains in the pending disconnect state before transitioning to disconnecting state to drop the connection. - 1.0
RSIPAvailable boolean R Indicates if Realm-specific IP (RSIP) is available as a feature on the CPE. - 1.0
NATEnabled boolean W Indicates if Network Address Translation (NAT) is enabled for this connection. - 1.0
Username string(:64) W Username to be used for authentication. 1.0
Password string(:64) W

Password to be usef for authentication.

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

1.0
PPPEncryptionProtocol string R

Describes the PPP encryption protocol used between the WAN device and the ISP POP. Enumeration of:

  • None
  • MPPE
- 1.0
PPPCompressionProtocol string R

Describes the PPP compression protocol used between the WAN device and the ISP POP. Enumeration of:

  • None
  • Van Jacobsen
  • STAC LZS
- 1.0
PPPAuthenticationProtocol string R

Describes the PPP authentication protocol used between the WAN device and the ISP POP. Enumeration of:

  • PAP
  • CHAP
  • MS-CHAP
- 1.0
ExternalIPAddress string(:45) W

[IPAddress] This is the external IP address used by NAT for this connection.

If Active Notification is enabled, the CPE MUST initiate an Inform whenever either the value of this parameter changes or the default WAN connection changes to a different connection.

- 1.0
RemoteIPAddress string(:45) R [IPAddress] The remote IP address for this connection. - 1.0
MaxMRUSize unsignedInt(1:1540) W The maximum allowed size of frames sent from the remote peer. - 1.0
CurrentMRUSize unsignedInt(1:1540) R The current MRU in use over this connection. - 1.0
DNSEnabled boolean W Whether or not the device SHOULD attempt to query a DNS server across this connection. true 1.0
DNSOverrideAllowed boolean W Whether or not a manually set, non-empty DNS address can be overridden by a DNS entry received from the WAN. false 1.0
DNSServers string(:45)[](:64) W [IPAddress] Comma-separated list (maximum number of characters 64) of IP Addresses. DNS server IP addresses for this connection. Support for more than three DNS Servers is OPTIONAL. - 1.0
MACAddress string(:17) W

[MACAddress] The physical address of the WANPPPConnection if applicable. Configurable only if MACAddressOverride is present and true.

If TransportType is PPPoA, the value of this parameter is irrelevant and MUST be an empty string.

- 1.0
MACAddressOverride boolean W

Whether the value of MACAddress parameter can be overridden. If false, the CPE’s default value is used (or restored if it had previously been overridden).

If TransportType is PPPoA, the value of this parameter is irrelevant and MUST be false.

- 1.0
TransportType string R

PPP transport type of the connection. Enumeration of:

  • PPPoA
  • PPPoE
  • L2TP (for future use)
  • PPTP (for future use)
- 1.0
PPPoEACName string(:256) W PPPoE Access Concentrator. 1.0
PPPoEServiceName string(:256) W PPPoE Service Name. 1.0
ConnectionTrigger string W

Trigger used to establish the PPP connection.

Enumeration of:

  • OnDemand
  • AlwaysOn
  • Manual The above values are defined as follows:
  • OnDemand: If this PPP connection is disconnected for any reason, it is to remain disconnected until the CPE has one or more packets to communicate over this connection, at which time the CPE automatically attempts to reestablish the connection.
  • AlwaysOn: If this PPP connection is disconnected for any reason, the CPE automatically attempts to reestablish the connection (and continues to attempt to reestablish the connection as long it remains disconnected).
  • Manual: If this PPP connection is disconnected for any reason, it is to remain disconnected until the user of the CPE explicitly instructs the CPE to reestablish the connection. Note that the reason for a PPP connection becoming disconnected to begin with might be either external to the CPE, such as termination by the BRAS or momentary disconnection of the physical interface, or internal to the CPE, such as use of the IdleDisconnectTime and/or AutoDisconnectTime parameters in this object.
OnDemand 1.0
RouteProtocolRx string W

Defines the Rx protocol to be used. Enumeration of:

  • Off
  • RIPv1 (OPTIONAL)
  • RIPv2 (OPTIONAL)
  • OSPF (OPTIONAL)
Off 1.0
PPPLCPEcho unsignedInt R PPP LCP Echo period in seconds. - 1.0
PPPLCPEchoRetry unsignedInt R Number of PPP LCP Echo retries within an echo period. - 1.0
PortMappingNumberOfEntries unsignedInt R Total number of port mapping entries. - 1.0
ShapingRate int(-1:) W Rate to shape this connection’s egress traffic to. For leaky bucket (constant rate shaping), this is the constant rate. For token bucket (variable rate shaping), this is the average rate. If <= 100, in percent of the rate of the highest rate-constrained layer over which the packet will travel on egress. If > 100, in bits per second. A value of -1 indicates no shaping. For example, for packets destined for a WAN DSL interface, if the ATM layer is rate-constrained, then the rate is calculated relative to this rate. Otherwise, the rate is calculated relative to the physical-layer DSL rate. -1 1.0
ShapingBurstSize unsignedInt W Burst size in bytes. For both leaky bucket (constant rate shaping) and token bucket (variable rate shaping) this is the bucket size and is therefore the maximum burst size. 0 1.0
DefaultGateway string R Represents the IP Address of the remote end Default Gateway established through PPPoE. - 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}.PortMapping.{i}. object(0:) W

Port mapping table. This table MUST contain all NAT port mappings associated with this connection, including static and dynamic port mappings programmatically created via local control protocol, such as UPnP. This table MUST NOT contain dynamic NAT binding entries associated with the normal operation of NAT. At most one entry in an instance of this table can exist with all of the same values for RemoteHost, ExternalPort, and PortMappingProtocol. If the ACS attempts to set the parameters of an existing entry such that this requirement would be violated, the CPE MUST reject the request. In this case, the SetParameterValues response MUST include a SetParameterValuesFault element for each parameter in the corresponding request whose modification would have resulted in such a violation. On creation of a new table entry, the CPE MUST choose default values for ExternalPort and PortMappingProtocol such that the new entry does not conflict with any existing entry.

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

- 1.0
PortMappingEnabled boolean W Enables or disables the port mapping instance. On creation, an entry is disabled by default. false 1.0
Alias string(:64) W

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

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

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

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of RemoteHost, ExternalPort and PortMappingProtocol. Note: There is no guarantee that the Alias value on automatically-created PortMapping instances will be retained. This is because automatically-created PortMapping instances can be transitory.

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

- 1.0
PortMappingLeaseDuration unsignedInt W Determines the time to live, in seconds, of a port-mapping lease, where “time to live” means the number of seconds before the port mapping expires. A value of 0 means the port mapping is static. Support for dynamic (non-static) port mappings is OPTIONAL. That is, the only value for PortMappingLeaseDuration that MUST be supported is 0. For a dynamic (non-static) port mapping, when this parameter is read, the value represents the time remaining on the port-mapping lease. That is, for a dynamic port mapping, the value counts down toward 0. When a dynamic port-mapping lease expires, the CPE MUST automatically terminate that port mapping, and MUST automatically delete the corresponding PortMapping table entry. - 1.0
RemoteHost string W This parameter is the IP address of the source of inbound packets. An empty string indicates a “wildcard” (this will be a wildcard in most cases). CPE are REQUIRED only to support wildcards. When RemoteHost is a wildcard, all traffic sent to the ExternalPort on the WAN interface of the gateway is forwarded to the InternalClient on the InternalPort. When RemoteHost is specified as one external IP address, the NAT will only forward inbound packets from this RemoteHost to the InternalClient, all other packets will be dropped. If a CPE supports non-wildcard values for RemoteHost, it MAY additionally support the ability to have more than one port mapping with the same ExternalPort and PortMappingProtocol, but with differing values of RemoteHost. When wildcard values are used for RemoteHost and/or ExternalPort, the following precedence order applies (with the highest precedence listed first):
  1. Explicit RemoteHost, explicit ExternalPort
  2. Explicit RemoteHost, wildcard ExternalPort
  3. Wildcard RemoteHost, explicit ExternalPort
  4. Wildcard RemoteHost, wildcard ExternalPort If an incoming packet matches the criteria associated with more than one entry in this table, the CPE MUST apply the port mapping associated with the highest precedence entry. At most one entry in this table can exist with all of the same values for RemoteHost, ExternalPort, and PortMappingProtocol.
1.0
ExternalPort unsignedInt W The external port (or the first port of a range of external ports) that the NAT gateway would listen on for connection requests to a corresponding InternalPort. Inbound packets to this external port on the WAN interface SHOULD be forwarded to InternalClient on the InternalPort. A value of zero (0) represents a “wildcard”. If this value is a wildcard, connection request on all external ports (that are not otherwise mapped) will be forwarded to InternalClient. In the wildcard case, the value(s) of InternalPort on InternalClient are ignored. When wildcard values are used for RemoteHost and/or ExternalPort, the following precedence order applies (with the highest precedence listed first):
  1. Explicit RemoteHost, explicit ExternalPort
  2. Explicit RemoteHost, wildcard ExternalPort
  3. Wildcard RemoteHost, explicit ExternalPort
  4. Wildcard RemoteHost, wildcard ExternalPort If an incoming packet matches the criteria associated with more than one entry in this table, the CPE MUST apply the port mapping associated with the highest precedence entry. At most one entry in this table can exist with all of the same values for RemoteHost, ExternalPort, and PortMappingProtocol.
- 1.0
InternalPort unsignedInt W The port on InternalClient that the gateway SHOULD forward connection requests to. A value of zero (0) is not allowed. - 1.0
PortMappingProtocol string W

The protocol of the port mapping.

Enumeration of:

  • TCP
  • UDP At most one entry in this table can exist with all of the same values for RemoteHost, ExternalPort, and PortMappingProtocol.
- 1.0
InternalClient string(:256) W The IP address or DNS host name of an internal client (on the LAN). Support for an IP address is mandatory. If InternalClient is specified as an IP address and the LAN device’s IP address subsequently changes, the port mapping MUST remain associated with the original IP address. Support for DNS host names is OPTIONAL. If InternalClient is specified as a DNS host name and the LAN device’s IP address subsequently changes, the port mapping MUST remain associated with this LAN device. In this case, it is the responsibility of the CPE to maintain the name-to-address mapping in the event of IP address changes. This can be accomplished, for example, by assigning the DNS host name via use of DHCP option 12 (Host Name) or option 81 (FQDN). Note that the ACS can learn the host name associated with a given LAN device via the Hosts table (InternetGatewayDevice.LANDevice.{i}.Hosts). Read access to this parameter MUST always return the exact value that was last set by the ACS. For example, if the internal client is set to a DNS host name, it MUST read back as a DNS host name and not as an IP address. An empty string indicates an unconfigured InternalClient. If this parameter is unconfigured, this port mapping MUST NOT be operational. It MUST be possible to set the InternalClient to the broadcast IP address 255.255.255.255 for UDP mappings. This is to enable multiple NAT clients to use the same well-known port simultaneously. 1.0
PortMappingDescription string(:256) W User-readable description of this port mapping. 1.0
ExternalPortEndRange unsignedInt W Indicates the last port of the external port range that starts with ExternalPort. If an external port range is specified, then the behavior described for ExternalPort applies to all ports within the range. A value of zero (0) indicates that no external port range is specified, i.e. that the range consists only of ExternalPort. If ExternalPort is zero (wildcard), the value of this parameter MUST be ignored. If specified, the value of this parameter MUST be greater than or equal to the value of ExternalPort. 0 1.0
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}.Stats. object R This object contains statistics for all connections within the same WANConnectionDevice that share a common MAC address. The contents of this object SHOULD be identical for each such connection. This object is intended only for WANConnectionDevices that can support an Ethernet-layer on this interface (e.g., PPPoE, IPoE). - 1.0
EthernetBytesSent unsignedInt R The total number of bytes transmitted, including framing characters, over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetBytesReceived unsignedInt R The total number of bytes received, including framing characters, over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetPacketsSent unsignedInt R The total number of packets transmitted over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetPacketsReceived unsignedInt R The total number of packets which were received over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetErrorsSent unsignedInt R The total number of outbound packets that could not be transmitted because of errors, over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetErrorsReceived unsignedInt R The total number of inbound packets that contained errors preventing them from being deliverable, over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetUnicastPacketsSent unsignedInt R 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, over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetUnicastPacketsReceived unsignedInt R The total number of received packets which were not addressed to a multicast or broadcast address, over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetDiscardPacketsSent unsignedInt R The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted, over all connections within the same WANConnectionDevice that share a common MAC address. 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.0
EthernetDiscardPacketsReceived unsignedInt R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being deliverable, over all connections within the same WANConnectionDevice that share a common MAC address. 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.0
EthernetMulticastPacketsSent unsignedInt R The total number of packets requested for transmission, including those that were discarded or not sent, which were addressed to a multicast address, over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetMulticastPacketsReceived unsignedInt R The total number of received packets which were addressed to a multicast address, over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetBroadcastPacketsSent unsignedInt R The total number of packets requested for transmission, including those that were discarded or not sent, which were addressed to a broadcast address, over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetBroadcastPacketsReceived unsignedInt R The total number of received packets which were addressed to a broadcast address, over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
EthernetUnknownProtoPacketsReceived unsignedInt R The total number of packets which were discarded because of an unknown or unsupported protocol, received over all connections within the same WANConnectionDevice that share a common MAC address. The value of this counter MAY be reset to zero when the CPE is rebooted. - 1.0
InternetGatewayDevice.Layer2Bridging. object R 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.0
MaxBridgeEntries unsignedInt R The maximum number of entries available in the Bridge table. - 1.0
MaxDBridgeEntries unsignedInt R 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.0
MaxFilterEntries unsignedInt R The maximum number of entries available in the Filter table. - 1.0
MaxMarkingEntries unsignedInt R The maximum number of entries available in the Marking table. - 1.0
BridgeNumberOfEntries unsignedInt R Number of entries in the Bridge table. - 1.0
FilterNumberOfEntries unsignedInt R Number of entries in the Filter table. - 1.0
MarkingNumberOfEntries unsignedInt R Number of entries in the Marking table. - 1.0
AvailableInterfaceNumberOfEntries unsignedInt R Number of entries in the AvailableInterface table. - 1.0
MaxQBridgeEntries unsignedInt R 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.0
MaxVLANEntries unsignedInt R The maximum number of 802.1Q [802.1Q-2005] VLANs supported per Bridge table entry. - 1.0
InternetGatewayDevice.Layer2Bridging.Bridge.{i}. object(0:) 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.0
Alias string(:64) W

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

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

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

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.

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

- 1.0
BridgeKey unsignedInt R Unique key for each Bridge table entry. - 1.0
BridgeStandard string W

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

802.1D 1.0
BridgeEnable boolean W Enables or disables this Bridge table entry. false 1.0
BridgeStatus string R

The status of this Bridge table entry.

Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 1.0
BridgeName string(:64) W Human-readable name for this Bridge table entry. 1.0
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. 0 1.0
PortNumberOfEntries unsignedInt R Number of entries in the Bridge Port table. 0 1.0
VLANNumberOfEntries unsignedInt R Number of entries in the Bridge VLAN table. 0 1.0
InternetGatewayDevice.Layer2Bridging.Bridge.{i}.Port.{i}. object(0:) 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.0
PortEnable boolean W Enables or disables this Bridge Port table entry. false 1.0
Alias string(:64) W

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

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

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

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.

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

- 1.0
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. 1.0
PortState string R

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

  • Disabled
  • Blocking
  • Listening
  • Learning
  • Forwarding
  • Broken
Disabled 1.0
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.0
AcceptableFrameTypes string W

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

  • AdmitAll
  • AdmitOnlyVLANTagged (OPTIONAL)
  • AdmitOnlyPrioUntagged (OPTIONAL) For an 802.1D [802.1D-2004] Bridge, the value of this parameter MUST be AdmitAll.
AdmitAll 1.0
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.0
InternetGatewayDevice.Layer2Bridging.Bridge.{i}.VLAN.{i}. object(0:) W

Bridge VLAN table. If this table is supported, if MUST contain an entry for each VLAN known to the Bridge. This table only applies to an 802.1Q [802.1Q-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.0
VLANEnable boolean W Enables or disables this VLAN table entry. false 1.0
Alias string(:64) W

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

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

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

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.

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

- 1.0
VLANName string(:64) W Human-readable name for this VLAN table entry. 1.0
VLANID int(1:4094) W VLAN ID of the entry, - 1.0
InternetGatewayDevice.Layer2Bridging.Filter.{i}. object(0:) 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:
  3. For each VLAN ID, it specifies the interfaces that are in the VLAN’s Member Set.
  4. 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:
  5. It allows a given packet to be admitted to multiple Bridges.
  6. 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.0
Alias string(:64) W

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

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

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

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.

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

- 1.0
FilterKey unsignedInt R Unique key for each Filter table entry. - 1.0
FilterEnable boolean W Enables or disables this Filter table entry. false 1.0
FilterStatus string R

The status of this Filter table entry.

Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) 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.0
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.0
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. 0 1.0
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)
1.0
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.0
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.0
EthertypeFilterList unsignedInt[](:256) W Classification criterion. Comma-separated list (maximum number of characters 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. 1.0
EthertypeFilterExclude boolean W

If false, on ingress to the interfaces associated with this Filter, the Bridge is defined to admit only those packets that match one of the EthertypeFilterList entries (in either the Ethernet or SNAP Type header). If the EthertypeFilterList is empty, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge is defined to admit all packets except those packets that match one of the EthertypeFilterList entries (in either the Ethernet or SNAP Type header). If the EthertypeFilterList is empty, packets are admitted regardless of Ethertype.

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

true 1.0
SourceMACAddressFilterList string[](:512) W Classification criterion. Comma-separated list (maximum number of characters 512) of strings, each representing a MAC Address. Each list entry MAY optionally specify a bit-mask, where matching of a packet’s MAC address is only to be done for bit positions set to one in the mask. If no mask is specified, all bits of the MAC Address are to be used for matching. For example, the list might be: 01:02:03:04:05:06, 1:22:33:00:00:00/FF:FF:FF:00:00:00, 88:77:66:55:44:33 Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2005] support classification based on source MAC address. 1.0
SourceMACAddressFilterExclude boolean W

If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose source MAC Address matches one of the SourceMACAddressFilterList entries. If the SourceMACAddressFilterList is empty, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose source MAC Address matches one of the SourceMACAddressFilterList entries. If the SourceMACAddressFilterList is empty, packets are admitted regardless of MAC address.

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

true 1.0
DestMACAddressFilterList string[](:512) W Classification criterion. Comma-separated list (maximum number of characters 512) of strings, each representing a MAC Address. Each list entry MAY optionally specify a bit-mask, where matching of a packet’s MAC address is only to be done for bit positions set to one in the mask. If no mask is specified, all bits of the MAC Address are to be used for matching. For example, the list might be: 01:02:03:04:05:06, 1:22:33:00:00:00/FF:FF:FF:00:00:00, 88:77:66:55:44:33 1.0
DestMACAddressFilterExclude boolean W If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches one of the DestMACAddressFilterList entries. If the DestMACAddressFilterList is empty, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches one of the DestMACAddressFilterList entries. If the DestMACAddressFilterList is empty, packets are admitted regardless of MAC address. true 1.0
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. 1.0
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.0
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. 1.0
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.0
DestMACFromVendorClassIDMode string W

DestMACFromVendorClassIDFilter pattern match criterion. Enumeration of:

Exact 1.0
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. 1.0
SourceMACFromClientIDFilterExclude boolean W

If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromClientIDFilter. If SourceMACFromClientIDFilter is an empty string, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromClientIDFilter. If the SourceMACFromClientIDFilter is an empty string, packets are admitted regardless of MAC address.

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

true 1.0
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. 1.0
DestMACFromClientIDFilterExclude boolean W If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromClientIDFilter. If DestMACFromClientIDFilter is an empty string, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromClientIDFilter. If the DestMACFromClientIDFilter is an empty string, packets are admitted regardless of MAC address. true 1.0
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. 1.0
SourceMACFromUserClassIDFilterExclude boolean W

If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromUserClassIDFilter. If SourceMACFromUserClassIDFilter is an empty string, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose source MAC Address matches that of a LAN device previously identified as described in SourceMACFromUserClassIDFilter. If the SourceMACFromUserClassIDFilter is an empty string, packets are admitted regardless of MAC address.

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

true 1.0
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. 1.0
DestMACFromUserClassIDFilterExclude boolean W If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromUserClassIDFilter. If DestMACFromUserClassIDFilter is an empty string, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromUserClassIDFilter. If the DestMACFromUserClassIDFilter is an empty string, packets are admitted regardless of MAC address. true 1.0
SourceMACFromVendorClassIDMode string W

SourceMACFromVendorClassIDFilter pattern match criterion. Enumeration of:

Exact 1.0
InternetGatewayDevice.Layer2Bridging.Marking.{i}. object(0:) 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:
  2. It allows the VLAN ID to be changed on egress.
  3. 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.0
Alias string(:64) W

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

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

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

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.

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

- 1.0
MarkingKey unsignedInt R Unique key for each Marking table entry. - 1.0
MarkingEnable boolean W Enables or disables this Marking table entry. false 1.0
MarkingStatus string R

The status of this Marking table entry.

Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) 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.0
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.0
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.
1.0
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.0
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.0
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.0
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.0
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.0
InternetGatewayDevice.Layer2Bridging.AvailableInterface.{i}. object(0:) R

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

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

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

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

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

- 1.0
AvailableInterfaceKey unsignedInt R Unique key for each Interface entry. - 1.0
InterfaceType string R

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:

  • LANInterface
  • WANInterface
  • LANRouterConnection
  • WANRouterConnection
- 1.0
InterfaceReference string(:256)[](:256) R Comma-separated list (maximum number of characters 256) of strings (maximum number of characters per item 256). Each list item MUST be the Path Name of an available LAN or WAN interface, or an empty string. 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.0
InternetGatewayDevice.QueueManagement. object R Queue management configuration object. - 1.0
Enable boolean W Enables or disables all queuing operation. - 1.0
MaxQueues unsignedInt R 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.0
MaxClassificationEntries unsignedInt R The maximum number of entries available in the Classification table. - 1.0
ClassificationNumberOfEntries unsignedInt R The number of entries in the Classification table. - 1.0
MaxAppEntries unsignedInt R The maximum number of entries available in the App table. - 1.0
AppNumberOfEntries unsignedInt R The number of entries in the App table. - 1.0
MaxFlowEntries unsignedInt R The maximum number of entries available in the Flow table. - 1.0
FlowNumberOfEntries unsignedInt R The number of entries in the Flow table. - 1.0
MaxPolicerEntries unsignedInt R The maximum number of entries available in the Policer table. - 1.0
PolicerNumberOfEntries unsignedInt R The number of entries in the Policer table. - 1.0
MaxQueueEntries unsignedInt R The maximum number of entries available in the Queue table. - 1.0
QueueNumberOfEntries unsignedInt R The number of entries in the Queue table. - 1.0
QueueStatsNumberOfEntries unsignedInt R The number of entries in the QueueStats table. - 1.0
DefaultForwardingPolicy unsignedInt W Identifier of the forwarding policy associated with traffic not associated with any specified classifier. - 1.0
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.0
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.0
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.0
DefaultDSCPMark int(-2:) W DSCP to mark traffic not associated with any specified classifier. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of DSCP based upon the EthernetPriority value of the incoming packet as defined in [Annex A/TR-098a1]. - 1.0
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.0
AvailableAppList string[](:1024) R Comma-separated list (maximum number of characters 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.0
InternetGatewayDevice.QueueManagement.Classification.{i}. object(0:) 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.0
ClassificationKey unsignedInt R

Unique key for each classification entry.

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

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

The status of this classifier.

Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 1.0
Alias string(:64) W

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

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

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

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.

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

- 1.0
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.0
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.
1.0
DestIP string(:45) W [IPAddress] Classification criterion. Destination IP address. An empty string indicates this criterion is not used for classification. 1.0
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. 1.0
DestIPExclude boolean W If false, the class includes only those packets that match the (masked) DestIP entry, if specified. If true, the class includes all packets except those that match the (masked) DestIP entry, if specified. false 1.0
SourceIP string(:45) W [IPAddress] Classification criterion. Source IP address. An empty string indicates this criterion is not used for classification. 1.0
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. 1.0
SourceIPExclude boolean W If false, the class includes only those packets that match the (masked) SourceIP entry, if specified. If true, the class includes all packets except those that match the (masked) SourceIP entry, if specified. false 1.0
Protocol int(-1:) W Classification criterion. Protocol number. A value of -1 indicates this criterion is not used for classification. -1 1.0
ProtocolExclude boolean W If false, the class includes only those packets that match the Protocol entry, if specified. If true, the class includes all packets except those that match the Protocol entry, if specified. false 1.0
DestPort int(-1:) W Classification criterion. Destination port number. A value of -1 indicates this criterion is not used for classification. -1 1.0
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.0
DestPortExclude boolean W If false, the class includes only those packets that match the DestPort entry (or port range), if specified. If true, the class includes all packets except those that match the DestPort entry (or port range), if specified. false 1.0
SourcePort int(-1:) W Classification criterion. Source port number. A value of -1 indicates this criterion is not used for classification. -1 1.0
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.0
SourcePortExclude boolean W If false, the class includes only those packets that match the SourcePort entry (or port range), if specified. If true, the class includes all packets except those that match the SourcePort entry (or port range), if specified. false 1.0
SourceMACAddress string(:17) W [MACAddress] Classification criterion. Source MAC Address. An empty string indicates this criterion is not used for classification. 1.0
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. 1.0
SourceMACExclude boolean W If false, the class includes only those packets that match the (masked) SourceMACAddress entry, if specified. If true, the class includes all packets except those that match the (masked) SourceMACAddress entry, if specified. false 1.0
DestMACAddress string(:17) W [MACAddress] Classification criterion. Destination MAC Address. An empty string indicates this criterion is not used for classification. The use of destination MAC address as a classification criterion is primarily useful only for bridged traffic. 1.0
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. 1.0
DestMACExclude boolean W If false, the class includes only those packets that match the (masked) DestMACAddress entry, if specified. If true, the class includes all packets except those that match the (masked) DestMACAddress entry, if specified. false 1.0
Ethertype int(-1:) W Classification criterion. Ethertype as indicated in either the Ethernet or SNAP Type header. A value of -1 indicates this criterion is not used for classification. -1 1.0
EthertypeExclude boolean W If false, the class includes only those packets that match the Ethertype entry, if specified. If true, the class includes all packets except those that match the Ethertype entry, if specified. false 1.0
SSAP int(-1:) W Classification criterion. SSAP element in the LLC header. A value of -1 indicates this criterion is not used for classification. -1 1.0
SSAPExclude boolean W If false, the class includes only those packets that match the SSAP entry, if specified. If true, the class includes all packets except those that match the SSAP entry, if specified. false 1.0
DSAP int(-1:) W Classification criterion. DSAP element in the LLC header. A value of -1 indicates this criterion is not used for classification. -1 1.0
DSAPExclude boolean W If false, the class includes only those packets that match the DSAP entry, if specified. If true, the class includes all packets except those that match the DSAP entry, if specified. false 1.0
LLCControl int(-1:) W Classification criterion. Control element in the LLC header. A value of -1 indicates this criterion is not used for classification. -1 1.0
LLCControlExclude boolean W If false, the class includes only those packets that match the LLCControl entry, if specified. If true, the class includes all packets except those that match the LLCControl entry, if specified. false 1.0
SNAPOUI int(-1:) W Classification criterion. OUI element in the SNAP header. A value of -1 indicates this criterion is not used for classification. -1 1.0
SNAPOUIExclude boolean W If false, the class includes only those packets that match the SNAPOUI entry, if specified. If true, the class includes all packets except those that match the SNAPOUI entry, if specified. false 1.0
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. 1.0
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.0
SourceVendorClassIDMode string W

SourceVendorClassID pattern match criterion. Enumeration of:

  • Exact
  • Prefix
  • Suffix
  • Substring For example, if SourceVendorClassID is “Example” then an Option 60 value of “Example device” will match with SourceVendorClassIDMode values of Prefix or Substring, but not with Exact or Suffix.
Exact 1.0
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. 1.0
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.0
DestVendorClassIDMode string W

DestVendorClassID pattern match criterion. Enumeration of:

  • Exact
  • Prefix
  • Suffix
  • Substring For example, if DestVendorClassID is “Example” then an Option 60 value of “Example device” will match with DestVendorClassIDMode values of Prefix or Substring, but not with Exact or Suffix.
Exact 1.0
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. 1.0
SourceClientIDExclude boolean W If false, the class includes only those packets sourced from LAN devices that match the SourceClientID entry, if specified. If true, the class includes all packets except those sourced from LAN devices that match the SourceClientID entry, if specified. false 1.0
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. 1.0
DestClientIDExclude boolean W If false, the class includes only those packets destined for LAN devices that match the DestClientID entry, if specified. If true, the class includes all packets except those destined for LAN devices that match the DestClientID entry, if specified. false 1.0
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. 1.0
SourceUserClassIDExclude boolean W If false, the class includes only those packets sourced from LAN devices that match the SourceUserClassID entry, if specified. If true, the class includes all packets except those sourced from LAN devices that match the SourceUserClassID entry, if specified. false 1.0
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. 1.0
DestUserClassIDExclude boolean W If false, the class includes only those packets destined for LAN devices that match the DestUserClassID entry, if specified. If true, the class includes all packets except those destined for LAN devices that match the DestUserClassID entry, if specified. false 1.0
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. 1.0
TCPACK boolean W Classification criterion. If false, this criterion is not used for classification. If true, this criterion matches with all TCP segments that have the ACK control bit set. false 1.0
TCPACKExclude boolean W If false, the class includes only those packets that match the TCPACK entry, if specified. If true, the class includes all packets except those that match the TCPACK entry, if specified. false 1.0
IPLengthMin unsignedInt W Classification criterion. Minimum IP Packet Length (including header) in bytes. 0 1.0
IPLengthMax unsignedInt W Classification criterion. Maximum IP Packet Length (including header) in bytes. A value of zero indicates that no maximum is specified (an umlimited maximum length). 0 1.0
IPLengthExclude boolean W If false, the class includes only those packets whose length (including header) falls within the inclusive range IPLengthMin through IPLengthMax. A value of zero for both IPLengthMin and IPLengthMax allows any length packet. An equal non-zero value of IPLengthMin and IPLengthMax allows only a packet with the exact length specified. If true, the class includes all packets except those whose length (including header) falls within the inclusive range IPLengthMin through IPLengthMax. false 1.0
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.0
DSCPExclude boolean W If false, the class includes only those packets that match the DSCPCheck entry, if specified. If true, the class includes all packets except those that match the DSCPCheck entry, if specified. false 1.0
DSCPMark int(-2:) W Classification result. DSCP to mark traffic with that falls into this classification entry. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of DSCP based upon the EthernetPriority value of the incoming packet as defined in [Annex A/TR-098a1]. -1 1.0
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.0
EthernetPriorityExclude boolean W If false, the class includes only those packets that match the EthernetPriorityCheck entry, if specified. If true, the class includes all packets except those that match the EthernetPriorityCheck entry, if specified. false 1.0
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.0
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.0
VLANIDExclude boolean W If false, the class includes only those packets that match the VLANIDCheck entry, if specified. If true, the class includes all packets except those that match the VLANIDCheck entry, if specified. false 1.0
OutOfBandInfo int(-1:) W Classification criterion. Allows traffic to be distinguished based on out-of-band information such as physical port or application ID. Primarily intended for, but not restricted to, locally sourced traffic. If specified, this entry applies to traffic with matching out-of-band information. A value of -1 indicates this criterion is not used for classification. -1 1.0
ForwardingPolicy unsignedInt W Classification result. Identifier of the forwarding policy associated with traffic that falls in this classification. 0 1.0
TrafficClass int(-1:) W Classification result. Identifier of the traffic class associated with traffic that falls in this classification. If specified, at least one Queue table entry MUST include this traffic class in its 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.0
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.0
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.0
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.0
SourceVendorSpecificInfoExclude boolean W If false, the class includes only those packets sourced from LAN devices that match the SourceVendorSpecificInfo entry, if specified. If true, the class includes all packets except those sourced from LAN devices that match the SourceVendorSpecificInfo entry, if specified. false 1.0
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.0
SourceVendorSpecificInfoSubOption int(0:255) W SourceVendorSpecificInfo Sub Option Code as defined in RFC 3925 [RFC3925]. 0 1.0
SourceVendorSpecificInfoMode string W

SourceVendorSpecificInfo pattern match criterion. Enumeration of:

  • Exact
  • Prefix
  • Suffix
  • Substring
Exact 1.0
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. 1.0
DestVendorSpecificInfoExclude boolean W If false, the class includes only those packets destined for LAN devices that match the DestVendorSpecificInfo entry, if specified. If true, the class includes all packets except those destined for LAN devices that match the DestVendorSpecificInfo entry, if specified. false 1.0
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.0
DestVendorSpecificInfoSubOption int(0:255) W DestVendorSpecificInfo Sub Option Code as defined in RFC 3925 [RFC3925]. 0 1.0
DestVendorSpecificInfoMode string W

DestVendorSpecificInfo pattern match criterion. Enumeration of:

  • Exact
  • Prefix
  • Suffix
  • Substring
Exact 1.0
InternetGatewayDevice.QueueManagement.App.{i}. object(0:) W

Application table.

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

- 1.0
AppKey unsignedInt R

Unique key for each App table entry.

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

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

The status of this App table entry.

Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 1.0
Alias string(:64) W

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

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

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

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.

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

- 1.0
ProtocolIdentifier string(:256) W URN identifying the protocol associated with the given application. A set of defined URNs is given in [Annex A/TR-098a1]. 1.0
AppName string(:64) W Human-readable name associated with this entry in the App table. 1.0
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.0
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.0
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.0
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.0
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.0
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.0
InternetGatewayDevice.QueueManagement.Flow.{i}. object(0:) W

Flow table.

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

- 1.0
FlowKey unsignedInt R

Unique key for each Flow table entry.

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

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

The status of this Flow table entry.

Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 1.0
Alias string(:64) W

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

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

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

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.

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

- 1.0
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]. 1.0
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]. 1.0
FlowName string(:64) W Human-readable name associated with this entry in the Flow table. 1.0
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.0
FlowForwardingPolicy unsignedInt W Identifier of the forwarding policy associated with this flow. 0 1.0
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.0
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.0
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.0
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.0
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.0
InternetGatewayDevice.QueueManagement.Policer.{i}. object(0:) W

Policer table.

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

- 1.0
PolicerKey unsignedInt R

Unique key for each policer entry.

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

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

The status of this policer.

Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 1.0
Alias string(:64) W

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

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

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

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.

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

- 1.0
CommittedRate unsignedInt W Committed rate allowed for this policer in bits-per-second. 0 1.0
CommittedBurstSize unsignedInt W Committed Burstsize in bytes. 0 1.0
ExcessBurstSize unsignedInt W Excess Burstsize in bytes. Applied for a SingleRateThreeColor meter. 0 1.0
PeakRate unsignedInt W Peak rate allowed for this Meter in bits-per-second. Applied for TwoRateThreeColor meters. 0 1.0
PeakBurstSize unsignedInt W Peak Burstsize in bytes. Applied for TwoRateThreeColor meters. 0 1.0
MeterType string W

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

SimpleTokenBucket 1.0
PossibleMeterTypes string[] R

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

  • SimpleTokenBucket
  • SingleRateThreeColor
  • TwoRateThreeColor
- 1.0
ConformingAction string W

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

  • Null
  • Drop
  • Count (DEPRECATED)
  • [*[0-9]|[1-5]0-9]|6[0-3]* (<DSCP Value>)
  • :[0-7] (<Ethernet Priority>)
  • [*([0-9]|[1-5][0-9]|60-3]):[0-7]* (<DSCP Value:Ethernet Priority>)

Null corresponds with no action. A {{pattern: reference to deprecated pattern InternetGatewayDevice.QueueManagement.Policer.{i}.ConformingAction.Count}} action (and only the {{pattern: reference to deprecated pattern InternetGatewayDevice.QueueManagement.Policer.{i}.ConformingAction.Count}} action) increases the meter instance count statistics in the {{param: reference to deprecated parameter InternetGatewayDevice.QueueManagement.Policer.{i}.CountedPackets (scope_or_status normal status current)}} and {{param: reference to deprecated parameter InternetGatewayDevice.QueueManagement.Policer.{i}.CountedBytes (scope_or_status normal status current)}} parameters. {{pattern: reference to deprecated pattern InternetGatewayDevice.QueueManagement.Policer.{i}.ConformingAction.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.0
PartialConformingAction string W

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

  • Null
  • Drop
  • Count (DEPRECATED)
  • [*[0-9]|[1-5]0-9]|6[0-3]* (<DSCP Value>)
  • :[0-7] (<Ethernet Priority>)
  • [*([0-9]|[1-5][0-9]|60-3]):[0-7]* (<DSCP Value:Ethernet Priority>)

Null corresponds with no action. A {{pattern: reference to deprecated pattern InternetGatewayDevice.QueueManagement.Policer.{i}.PartialConformingAction.Count}} action (and only the {{pattern: reference to deprecated pattern InternetGatewayDevice.QueueManagement.Policer.{i}.PartialConformingAction.Count}} action) increases the meter instance count statistics in the {{param: reference to deprecated parameter InternetGatewayDevice.QueueManagement.Policer.{i}.CountedPackets (scope_or_status normal status current)}} and {{param: reference to deprecated parameter InternetGatewayDevice.QueueManagement.Policer.{i}.CountedBytes (scope_or_status normal status current)}} parameters. {{pattern: reference to deprecated pattern InternetGatewayDevice.QueueManagement.Policer.{i}.PartialConformingAction.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.0
NonConformingAction string W

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

  • Null
  • Drop
  • Count (DEPRECATED)
  • [*[0-9]|[1-5]0-9]|6[0-3]* (<DSCP Value>)
  • :[0-7] (<Ethernet Priority>)
  • [*([0-9]|[1-5][0-9]|60-3]):[0-7]* (<DSCP Value:Ethernet Priority>)

Null corresponds with no action. A {{pattern: reference to deprecated pattern InternetGatewayDevice.QueueManagement.Policer.{i}.NonConformingAction.Count}} action (and only the {{pattern: reference to deprecated pattern InternetGatewayDevice.QueueManagement.Policer.{i}.NonConformingAction.Count}} action) increases the meter instance count statistics in the {{param: reference to deprecated parameter InternetGatewayDevice.QueueManagement.Policer.{i}.CountedPackets (scope_or_status normal status current)}} and {{param: reference to deprecated parameter InternetGatewayDevice.QueueManagement.Policer.{i}.CountedBytes (scope_or_status normal status current)}} parameters. {{pattern: reference to deprecated pattern InternetGatewayDevice.QueueManagement.Policer.{i}.NonConformingAction.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.0
CountedPackets unsignedInt R Number of Packets counted as result of a Count meter action. This parameter is DEPRECATED because the Count meter action is DEPRECATED. 0 1.0
CountedBytes unsignedInt R Number of Bytes counted as result of a Count meter action. This parameter is DEPRECATED because the Count meter action is DEPRECATED. 0 1.0
TotalCountedPackets unsignedInt R Total number of Packets counted by this policer, regardless of meter action. 0 1.0
TotalCountedBytes unsignedInt R Total number of Bytes counted by this policer, regardless of meter action. 0 1.0
ConformingCountedPackets unsignedInt R Number of conforming Packets counted by this policer, regardless of meter action. 0 1.0
ConformingCountedBytes unsignedInt R Number of conforming Bytes counted by this policer, regardless of meter action. 0 1.0
PartiallyConformingCountedPackets unsignedInt R Number of partially conforming Packets counted by this policer, regardless of meter action. 0 1.0
PartiallyConformingCountedBytes unsignedInt R Number of partially conforming Bytes counted by this policer, regardless of meter action. 0 1.0
NonConformingCountedPackets unsignedInt R Number of non-conforming Packets counted by this policer, regardless of meter action. 0 1.0
NonConformingCountedBytes unsignedInt R Number of non-conforming Bytes counted by this policer, regardless of meter action. 0 1.0
InternetGatewayDevice.QueueManagement.Queue.{i}. object(0:) 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.0
QueueKey unsignedInt R

Unique key for each queue entry.

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

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

The status of this queue.

Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 1.0
Alias string(:64) W

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

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

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

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.

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

- 1.0
TrafficClasses unsignedInt[](:256) W Comma-separated list (maximum number of characters 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. 1.0
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. 1.0
QueueBufferLength unsignedInt R

Number of bytes in the buffer.

Queue buffer size for all egress interfaces for which this queue exists. If the buffer size is not the same for all such egress interfaces, this parameter MUST be 0.

- 1.0
QueueWeight unsignedInt W Weight of this queue in case of WFQ or WRR, but only used for queues of equal precedence. 0 1.0
QueuePrecedence unsignedInt(1:) W Precedence of this queue relative to others. Lower numbers imply greater precedence. 1 1.0
REDThreshold unsignedInt(:100) W Random Early Detection threshold, used only when DropAlgorithm is RED. This is the minimum threshold (min_th) and is measured as a percentage of the queue size. If the value is set to zero, the CPE MUST choose a sensible value, e.g. 5 (but the value MUST still read back as zero). In this version of the data model, there is no way to set the maximum threshold (max_th). The CPE MUST choose a sensible value, e.g. three times the minimum threshold. In this version of the data model, there is no way to set the RED weight (w_q). The CPE MUST choose a sensible value, e.g. 0.002. 0 1.0
REDPercentage unsignedInt(:100) W Random Early Detection percentage, used only when DropAlgorithm is RED. This is the maximum value of the packet marking probability (max_p). If the value is set to zero, the CPE MUST choose a sensible value, e.g. 10 (but the value MUST still read back as zero). In this version of the data model, there is no way to set the RED weight (w_q). The CPE MUST choose a sensible value, e.g. 0.002. 0 1.0
DropAlgorithm string W

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

  • RED (Random Early Detection [RED])
  • DT (Drop Tail)
  • WRED (Weighted RED)
  • BLUE ([BLUE])
DT 1.0
SchedulerAlgorithm string W

Scheduling Algorithm used by scheduler. Enumeration of:

  • WFQ (Weighted Fair Queueing)
  • WRR (Weighted Round Robin)
  • SP (Strict Priority)
SP 1.0
ShapingRate int(-1:) W Rate to shape this queue’s traffic to. For leaky bucket (constant rate shaping), this is the constant rate. For token bucket (variable rate shaping), this is the average rate. If <= 100, in percent of the rate of the highest rate-constrained layer over which the packet will travel on egress. If > 100, in bits per second. A value of -1 indicates no shaping. For example, for packets destined for a WAN DSL interface, if the egress will be on a PPP or IP link with a specified ShapingRate, the percentage is calculated relative to this rate. Otherwise, if the ATM layer is rate-constrained, then the rate is calculated relative to this rate. Otherwise, the rate is calculated relative to the physical-layer DSL rate. -1 1.0
ShapingBurstSize unsignedInt W Burst size in bytes. For both leaky bucket (constant rate shaping) and token bucket (variable rate shaping) this is the bucket size and is therefore the maximum burst size. 0 1.0
InternetGatewayDevice.QueueManagement.QueueStats.{i}. object(0:) W

Queue statistics table. This table is managed by the ACS, which will create entries only for those {Queue, Interface} combinations for which statistics are to be collected.

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

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

The status of this object. Enumeration of:

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

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

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

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

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

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

- 1.0
Queue unsignedInt W Instance number of the Queue table entry with which this object is associated. 0 1.0
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. 1.0
OutputPackets unsignedInt R Number of packets output through the queue. 0 1.0
OutputBytes unsignedInt R Number of bytes output through the queue. 0 1.0
DroppedPackets unsignedInt R Number of packets dropped by the queue. 0 1.0
DroppedBytes unsignedInt R Number of bytes dropped by the queue. 0 1.0
QueueOccupancyPackets unsignedInt R Queue occupancy in packets (gives a measure of queue latency). 0 1.0
QueueOccupancyPercentage unsignedInt(0:100) R Queue occupancy as a percentage, i.e. 100 * queue occupancy in bytes / queue size in bytes (gives a measure of queue usage). 0 1.0
InternetGatewayDevice.Capabilities. object R 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.0
InternetGatewayDevice.Capabilities.PerformanceDiagnostic. object R The capabilities of the Performance Diagnostics (DownloadDiagnostics and UploadDiagnostics) for the device. - 1.0
DownloadTransports string[] R

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

  • HTTP
  • FTP (OPTIONAL)
- 1.0
UploadTransports string[] R

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

  • HTTP
  • FTP (OPTIONAL)
- 1.0
InternetGatewayDevice.DownloadDiagnostics. object R This object defines the diagnostics configuration for a HTTP and FTP DownloadDiagnostics Test. Files received in the DownloadDiagnostics do not require file storage on the CPE device. - 1.0
DiagnosticsState string W

Indicate the availability of diagnostic data. Enumeration of:

  • None (READONLY)
  • Requested
  • Completed (READONLY)
  • Error_InitConnectionFailed (READONLY)
  • Error_NoResponse (READONLY)
  • Error_TransferFailed (READONLY)
  • Error_PasswordRequestFailed (READONLY)
  • Error_LoginFailed (READONLY)
  • Error_NoTransferMode (READONLY)
  • Error_NoPASV (READONLY)
  • Error_IncorrectSize (READONLY)
  • Error_Timeout (READONLY) 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.0
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.0
DownloadURL string(:256) W The URL, as defined in [RFC3986], for the CPE to perform the download on. This parameter MUST be in the form of a valid HTTP [RFC2616] or FTP [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.0
DSCP unsignedInt(0:63) W The DiffServ code point for marking packets transmitted in the test. The default value SHOULD be zero. - 1.0
EthernetPriority unsignedInt(0:7) W Ethernet priority code for marking packets transmitted in the test (if applicable). The default value SHOULD be zero. - 1.0
ROMTime dateTime R 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.0
BOMTime dateTime R 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.0
EOMTime dateTime R 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.0
TestBytesReceived unsignedInt R The test traffic received in bytes during the FTP/HTTP transaction including FTP/HTTP headers, between BOMTime and EOMTime, - 1.0
TotalBytesReceived unsignedInt R The total number of bytes received on the Interface between BOMTime and EOMTime. - 1.0
TCPOpenRequestTime dateTime R 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.0
TCPOpenResponseTime dateTime R 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.0
InternetGatewayDevice.UploadDiagnostics. object R This object defines the diagnostics configuration for a HTTP or FTP UploadDiagnostics test. Files sent by the UploadDiagnostics do not require file storage on the CPE device, and MAY be an arbitrary stream of bytes. - 1.0
DiagnosticsState string W

Indicate the availability of diagnostic data. Enumeration of:

  • None (READONLY)
  • Requested
  • Completed (READONLY)
  • Error_InitConnectionFailed (READONLY)
  • Error_NoResponse (READONLY)
  • Error_PasswordRequestFailed (READONLY)
  • Error_LoginFailed (READONLY)
  • Error_NoTransferMode (READONLY)
  • Error_NoPASV (READONLY)
  • Error_NoCWD (READONLY)
  • Error_NoSTOR (READONLY)
  • Error_NoTransferComplete (READONLY) 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.0
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.0
UploadURL string(:256) W The URL, as defined in [RFC3986], for the CPE to Upload to. This parameter MUST be in the form of a valid HTTP [RFC2616] or FTP [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.0
DSCP unsignedInt(0:63) W DiffServ code point for marking packets transmitted in the test. The default value SHOULD be zero. - 1.0
EthernetPriority unsignedInt(0:7) W Ethernet priority code for marking packets transmitted in the test (if applicable). The default value SHOULD be zero. - 1.0
TestFileLength unsignedInt W The size of the file (in bytes) to be uploaded to the server. The CPE MUST insure the appropriate number of bytes are sent. - 1.0
ROMTime dateTime R 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.0
BOMTime dateTime R 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.0
EOMTime dateTime R 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.0
TotalBytesSent unsignedInt R The total number of bytes sent on the Interface between BOMTime and EOMTime. - 1.0
TCPOpenRequestTime dateTime R 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.0
TCPOpenResponseTime dateTime R 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.0
InternetGatewayDevice.UDPEchoConfig. object R This object allows the CPE to be configured to perform the UDP Echo Service defined in [RFC862] and UDP Echo Plus Service defined in [Appendix A.1/TR-143]. - 1.0
Enable boolean W MUST be enabled to receive UDP echo. When enabled from a disabled state all related timestamps, statistics and UDP Echo Plus counters are cleared. - 1.0
Interface string(:256) W The value MUST be the Path Name of IP-layer interface over which the CPE MUST listen and receive UDP echo requests on. The value of this parameter MUST be either a valid interface or an empty string. An attempt to set this parameter to a different value MUST be rejected as an invalid parameter value. If an empty string is specified, the CPE MUST listen and receive UDP echo requests on all interfaces. Note: Interfaces behind a NAT MAY require port forwarding rules configured in the Gateway to enable receiving the UDP packets. - 1.0
SourceIPAddress string(:45) W [IPAddress] The Source IP address of the UDP echo packet. The CPE MUST only respond to a UDP echo from this source IP address. - 1.0
UDPPort unsignedInt W The UDP port on which the UDP server MUST listen and respond to UDP echo requests. - 1.0
EchoPlusEnabled boolean W If true the CPE will perform necessary packet processing for UDP Echo Plus packets. - 1.0
EchoPlusSupported boolean R true if UDP Echo Plus is supported. - 1.0
PacketsReceived unsignedInt R Incremented upon each valid UDP echo packet received. - 1.0
PacketsResponded unsignedInt R Incremented for each UDP echo response sent. - 1.0
BytesReceived unsignedInt R The number of UDP received bytes including payload and UDP header after the UDPEchoConfig is enabled. - 1.0
BytesResponded unsignedInt R The number of UDP responded bytes, including payload and UDP header sent after the UDPEchoConfig is enabled. - 1.0
TimeFirstPacketReceived dateTime R Time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456, The time that the server receives the first UDP echo packet after the UDPEchoConfig is enabled. - 1.0
TimeLastPacketReceived dateTime R Time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456 The time that the server receives the most recent UDP echo packet. - 1.0
InternetGatewayDevice.CaptivePortal. object R This object contains parameters relating to the captive portal configuration on the CPE. The captive portal configuration defines the CPE’s WAN-destined HTTP (port 80) traffic redirect behavior. When the captive portal is disabled, WAN-destined HTTP (port 80) traffic MUST be permitted to all destinations. When the captive portal is enabled, WAN-destined HTTP (port 80) traffic MUST be permitted only to destinations listed in the AllowedList; traffic to all other destinations MUST be redirected to the CaptivePortalURL. - 1.0
Enable boolean W Enables or disables the captive portal. - 1.0
Status string R

Indicates the status of the captive portal. Enumeration of:

  • Disabled
  • Enabled
  • Error_URLEmpty (CaptivePortalURL is an empty string)
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
- 1.0
AllowedList string[](:10000) W Comma-separated list (maximum number of characters 10000) of strings. IP addresses to which HTTP (port 80) traffic MUST always be permitted, regardless of whether the captive portal is enabled. Each entry in the list MUST be either an IP address or an IP subnet specified using variable length subnet mask (VLSM) syntax. An IP subnet is specified as an IP address followed (with no intervening white space) by “/n”, where n is an integer in the range 0-32; this is equivalent to a subnet mask consisting of n 1s followed by 32 minus n 0s. For example, 1.2.3.4 specifies a single IP address, and 1.2.3.4/24 specifies a class C subnet with subnet mask 255.255.255.0. The maximum length of a single entry (plus comma) is 19 characters so 10000 bytes is sufficient for more than 500 IP addresses and/or IP subnets. - 1.0
CaptivePortalURL string(:2000) W Captive portal URL to which WAN-destined HTTP (port 80) traffic to destinations not listed in the AllowedList will be redirected. The captive portal URL MUST be an HTTP (not HTTPS) URL. The CPE MUST permit the captive portal URL to be set to an empty string, which has the effect of disabling the captive portal (if Enable is true and the captive portal URL is an empty string, Status MUST be Error_URLEmpty). - 1.0
InternetGatewayDevice.TraceRouteDiagnostics. object R This object is defines access to an IP-layer trace-route test for the specified IP interface. - 1.0
DiagnosticsState string W

Indicates availability of diagnostic data. Enumeration of:

  • None (READONLY)
  • Requested
  • Complete (READONLY)
  • Error_CannotResolveHostName (READONLY)
  • Error_MaxHopCountExceeded (READONLY) If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the 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.
- 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 - 1.0
Host string(:256) W Host name or address of the host to find a route to - 1.0
NumberOfTries unsignedInt(1:3) W Number of tries per hop. Set prior to running Diagnostic. By default, the CPE SHOULD set this value to 3. - 1.0
Timeout unsignedInt(1:) W Timeout in milliseconds for the trace route test. By default the CPE SHOULD set this value to 5000. - 1.0
DataBlockSize unsignedInt(1:65535) W Size of the data block in bytes to be sent for each trace route. By default, the CPE SHOULD set this value to 38. - 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 0. - 1.0
MaxHopCount unsignedInt(1:64) W The maximum number of hop used in outgoing probe packets (max TTL). By default the CPE SHOULD set this value to 30. - 1.0
ResponseTime unsignedInt R Result parameter indicating the response time in milliseconds the most recent trace route test. If a route could not be determined, this value MUST be zero. - 1.0
RouteHopsNumberOfEntries unsignedInt R Number of entries in the RouteHops table. - 1.0
InternetGatewayDevice.TraceRouteDiagnostics.RouteHops.{i}. object(0:) R Contains the array of results returned. If a route could not be determined, this array will be empty - 1.0
HopHost string(:256) R Result parameter indicating the Host Name if DNS is able to resolve or IP Address of a hop along the discovered route. - 1.0
HopHostAddress string R If this parameter is not an empty string it will contain the last IP address of the host returned for this hop and the HopHost will contain the Host Name returned from the reverse DNS query. - 1.0
HopErrorCode unsignedInt R Contains the error code returned for this hop This code is directly from the ICMP CODE field. - 1.0
HopRTTimes unsignedInt[](:16) R Comma-separated list (maximum number of characters 16) of unsigned integers. Contains one or more round trip times in milliseconds (one for each repetition) for this hop. - 1.0
InternetGatewayDevice.LANInterfaces. object R 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.0
LANEthernetInterfaceNumberOfEntries unsignedInt R Number of instances of LANEthernetInterfaceConfig in this object. - 1.0
LANUSBInterfaceNumberOfEntries unsignedInt R Number of instances of LANUSBInterfaceConfig in this object. - 1.0
LANWLANConfigurationNumberOfEntries unsignedInt R Number of instances of WLANConfiguration in this object object. - 1.0
InternetGatewayDevice.LANInterfaces.LANEthernetInterfaceConfig.{i}. object(0:) R

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

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

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

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

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

- 1.0
InternetGatewayDevice.LANInterfaces.LANUSBInterfaceConfig.{i}. object(0:) R

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

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

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

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

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

- 1.0
InternetGatewayDevice.LANInterfaces.WLANConfiguration.{i}. object(0:) R

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

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

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

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

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

- 1.0
InternetGatewayDevice.User.{i}. object(0:) W

This object contains parameters relating to the user characteristics.

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

- 1.0
Alias string(:64) W

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

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

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

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

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

- 1.0
Enable boolean W Enables/disables this user object instance. If the User being configured is currently accessing the device then a disable MUST apply to the next user session and the current user session MUST NOT be abruptly terminated. false 1.0
RemoteAccessCapable boolean W Allows this user to remotely access the UserInterface via the mechanism defined in UserInterface.RemoteAccess. false 1.0
Username string(:64) W Name of the current user. MUST NOT be an empty string for an enabled entry. 1.0
Password string(:64) W

The user’s password.

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

- 1.0
Language string(:16) W String describing the default language for the local configuration interface, specified according to [RFC3066]. If an empty string, UserInterface.CurrentLanguage is used. 1.0
InternetGatewayDevice.UPnP. object R This object contains all UPnP related objects and parameters including Device and Discovery related objects and parameters. - 1.0
InternetGatewayDevice.UPnP.Device. object R This object defines the UPnP devices and UPnP services that are implemented by the CPE. - 1.0
Enable boolean W Enables/Disables UPnP support. - 1.0
UPnPMediaServer boolean W Enables/Disables UPnP Media Server. - 1.0
UPnPMediaRenderer boolean W Enables/Disables UPnP Media Renderer. - 1.0
UPnPWLANAccessPoint boolean W Enables/Disables UPnP Wireless Access Point. - 1.0
UPnPQoSDevice boolean W Enables/Disables UPnP QoS Device. - 1.0
UPnPQoSPolicyHolder boolean W Enables/Disables UPnP QoS Policy Holder. - 1.0
UPnPIGD boolean W Enables/Disables UPnP IGD. - 1.0
UPnPDMBasicMgmt boolean W Enables/Disables UPnP-DM Basic Management. - 1.0
UPnPDMConfigurationMgmt boolean W Enables/Disables UPnP-DM Configuration Management. - 1.0
UPnPDMSoftwareMgmt boolean W Enables/Disables UPnP-DM Software Management. - 1.0
InternetGatewayDevice.UPnP.Device.Capabilities. object R This object defines what UPnP capabilities this device has. - 1.0
UPnPArchitecture unsignedInt R Numeric value indicating the major version of the supported UPnP architecture. If UPnP 1.1 is supported the value is 1. If UPnP 2.0 is supported the value is 2. A value of 0 indicates no UPnP support. - 1.0
UPnPArchitectureMinorVer unsignedInt R Numeric value indicating the minor version of the supported UPnP architecture. If UPnP 1.1 is supported the value is 1. If UPnP 2.0 is supported the value is 0. If UPnPArchitecture is 0 then this parameter SHOULD be ignored. - 1.0
UPnPMediaServer unsignedInt R Numeric value indicating the supported revision for UPnP Media Server. A value of 0 indicates no support. - 1.0
UPnPMediaRenderer unsignedInt R Numeric value indicating the supported revision for UPnP Media Renderer. A value of 0 indicates no support. - 1.0
UPnPWLANAccessPoint unsignedInt R Numeric value indicating the supported revision for UPnP Wireless Access Point. A value of 0 indicates no support. - 1.0
UPnPBasicDevice unsignedInt R Numeric value indicating the supported revision for UPnP Basic Device. A value of 0 indicates no support. - 1.0
UPnPQoSDevice unsignedInt R Numeric value indicating the supported revision for UPnP Qos Device. A value of 0 indicates no support. - 1.0
UPnPQoSPolicyHolder unsignedInt R Numeric value indicating the supported revision for UPnP Qos Policy Holder. A value of 0 indicates no support. - 1.0
UPnPIGD unsignedInt R Numeric value indicating the supported revision for UPnP IGD. A value of 0 indicates no support. - 1.0
UPnPDMBasicMgmt unsignedInt R Numeric value indicating the supported revision for UPnP-DM Basic Management. A value of 0 indicates no support. - 1.0
UPnPDMConfigurationMgmt unsignedInt R Numeric value indicating the supported revision for UPnP-DM Configuration Management. A value of 0 indicates no support. - 1.0
UPnPDMSoftwareMgmt unsignedInt R Numeric value indicating the supported revision for UPnP-DM Software Management. A value of 0 indicates no support. - 1.0
InternetGatewayDevice.UPnP.Discovery. object R UPnP [UPnP-DAv1] SSDP discovered root devices, embedded devices and embedded services. The CPE MAY, but need not, retain some or all of the information in this object across reboots. - 1.0
RootDeviceNumberOfEntries unsignedInt R The number of entries in the RootDevice table. - 1.0
DeviceNumberOfEntries unsignedInt R The number of entries in the Device table. - 1.0
ServiceNumberOfEntries unsignedInt R The number of entries in the Service table. - 1.0
InternetGatewayDevice.UPnP.Discovery.RootDevice.{i}. object(0:) R

UPnP root device table. This table contains an entry for each UPnP root device that has been discovered via SSDP.

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

- 1.0
Status string R

The status of the UPnP root device. Enumeration of:

  • LeaseActive (Device is active and UPnP lease has not expired)
  • LeaseExpired (Device is inactive because UPnP lease has expired)
  • ByebyeReceived (Device is inactive because byebye message was received) The ability to list inactive UPnP root devices is OPTIONAL. The length of time an inactive device remains listed in this table is a local matter to the CPE.
- 1.0
UUID string(:36) R

This UPnP root device’s UUID (Universally Unique IDentifier) [RFC4122], extracted from any of its USN (Unique Service Name) headers. This is a 36-byte string that uniquely identifies the device, the following is an example:

  • 02c29d2a-dbfd-2d91-99c9-306d537e9856

Possible patterns:

  • [*[0-9A-Fa-f]{8}-(0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}*
- 1.0
USN string(:256) R The value of the USN (Unique Service Name) header for this UPnP root device. Three discovery messages are sent for root devices, and this SHOULD be the value of the USN header of the following form:
  • uuid:device-UUID::urn:domain-name:device:deviceType:v SSDP is an unreliable protocol and it is possible that no discovery message containing the USN header of the above form was ever received. If so, one of the other two forms MAY be used:
  • uuid:device-UUID::upnp:rootdevice
  • uuid:device-UUID (for root device UUID)
- 1.0
LeaseTime unsignedInt R The UPnP root device lease time in seconds, extracted from the CACHE-CONTROL header. - 1.0
Location string(:256) R The value of the LOCATION header for this UPnP root device, which is the URL of the root device’s DDD (Device Description Document). - 1.0
Server string(:256) R The value of the SERVER header for this UPnP root device, which is a string of the following form:
  • OS/version UPnP/udaversion product/version where UPnP is a literal string, udaversion is the version of the UPnP Device Architecture.
- 1.0
Host string(:256)[](:1024) R Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters per item 256). Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this UPnP root device. As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly. - 1.0
LastUpdate dateTime R The date and time at which the last advertisement from this RootDevice was received. - 1.0
InternetGatewayDevice.UPnP.Discovery.Device.{i}. object(0:) R

UPnP embedded device table. This table contains an entry for each UPnP embedded device that has been discovered via SSDP.

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

- 1.0
Status string R

The status of the UPnP embedded device. Enumeration of:

  • LeaseActive (Device is active and UPnP lease has not expired)
  • LeaseExpired (Device is inactive because UPnP lease has expired)
  • ByebyeReceived (Device is inactive because byebye message was received) The ability to list inactive UPnP embedded devices is OPTIONAL. The length of time an inactive device remains listed in this table is a local matter to the CPE.
- 1.0
UUID string(:36) R

This UPnP embedded device’s UUID (Universally Unique IDentifier) [RFC4122], extracted from any of its USN (Unique Service Name) headers. This is a 36-byte string that uniquely identifies the device, the following is an example:

  • 02c29d2a-dbfd-2d91-99c9-306d537e9856

Possible patterns:

  • [*[0-9A-Fa-f]{8}-(0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}*
- 1.0
USN string(:256) R The value of the USN (Unique Service Name) header for this UPnP embedded device. Two discovery messages are sent for embedded devices, and this SHOULD be the value of the USN header of the following form:
  • uuid:device-UUID::urn:domain-name:device:deviceType:v SSDP is an unreliable protocol and it is possible that no discovery message containing the USN header of the above form was ever received. If so, the other form MAY be used:
  • uuid:device-UUID
- 1.0
LeaseTime unsignedInt R The UPnP embedded device lease time in seconds, extracted from the CACHE-CONTROL header. - 1.0
Location string(:256) R The value of the LOCATION header for this UPnP embedded device, which is the URL of the root device’s DDD (Device Description Document). - 1.0
Server string(:256) R The value of the SERVER header for this UPnP embedded device, which is a string of the following form:
  • OS/version UPnP/udaversion product/version where UPnP is a literal string, udaversion is the version of the UPnP Device Architecture.
- 1.0
Host string(:256)[](:1024) R Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters per item 256). Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this UPnP embedded device. As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly. - 1.0
LastUpdate dateTime R The date and time at which the last advertisement from this Device was received. - 1.0
InternetGatewayDevice.UPnP.Discovery.Service.{i}. object(0:) R

UPnP embedded service table. This table contains an entry for each UPnP embedded service that has been discovered via SSDP.

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

- 1.0
Status string R

The status of the UPnP embedded service. Enumeration of:

  • LeaseActive (Service is active and UPnP lease has not expired)
  • LeaseExpired (Service is inactive because UPnP lease has expired)
  • ByebyeReceived (Service is inactive because byebye message was received) The ability to list inactive UPnP embedded services is OPTIONAL. The length of time an inactive service remains listed in this table is a local matter to the CPE.
- 1.0
USN string(:256) R The value of the USN (Unique Service Name) header for this UPnP embedded service. This is of the following form:
  • uuid:device-UUID::urn:domain-name:service:serviceType:v
- 1.0
LeaseTime unsignedInt R The UPnP embedded service lease time in seconds, extracted from the CACHE-CONTROL header. - 1.0
Location string(:256) R The value of the LOCATION header for this UPnP embedded service, which is the URL of the root device’s DDD (Device Description Document). - 1.0
Server string(:256) R The value of the SERVER header for this UPnP embedded service, which is a string of the following form:
  • OS/version UPnP/udaversion product/version where UPnP is a literal string, udaversion is the version of the UPnP Device Architecture.
- 1.0
Host string(:256)[](:1024) R Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters per item 256). Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this UPnP embedded service. As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly. - 1.0
LastUpdate dateTime R The date and time at which the last advertisement from this Service was received. - 1.0
ParentDevice string(:256) R The value MUST be the Path Name of the RootDevice or Device table entries that embeds this Service. If the referenced object is deleted, the parameter value MUST be set to an empty string. This parameter is populated by extracting the “device-UUID” from the service’s USN and matching the value against the root device or embedded device UUID value. - 1.0
InternetGatewayDevice.UPnP.Description. object R This object contains information from the Description Document discovered from the UPnP Devices and Services. - 1.0
DeviceDescriptionNumberOfEntries unsignedInt R The number of entries in the DeviceDescription table. - 1.0
DeviceInstanceNumberOfEntries unsignedInt R The number of entries in the DeviceInstance table. - 1.0
ServiceInstanceNumberOfEntries unsignedInt R The number of entries in the ServiceInstance table. - 1.0
InternetGatewayDevice.UPnP.Description.DeviceDescription.{i}. object(0:) R

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

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

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

The UPnP Device Architecture version extracted from the specVersion element in the Device Description Document of the discovered root device. The SpecVersion is encoded as “major revison.minor revision”. Possible patterns:

  • \d+.\d+
- 1.0
Host string(:256)[](:1024) R Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters per item 256). Each list item MUST be the Path Name of the Host table entries associated with the root device from which the device description was retrieved. If the referenced object is deleted, the corresponding item MUST be removed from the list. - 1.0
InternetGatewayDevice.UPnP.Description.DeviceInstance.{i}. object(0:) R

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

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

- 1.0
UDN string(36) R [UUID] Unique Device Name of this device represented as a UUID for the device. This value is extracted from the UDN element in the Device Description Document with the leading uuid: removed. - 1.0
ParentDevice string(:256) R The value MUST be the Path Name of a DeviceInstance table entry (if this is an embedded device) or an empty string (if this is a root device). If the referenced object is deleted, the parameter value MUST be set to an empty string. - 1.0
DiscoveryDevice string(:256) R The value MUST be the Path Name of a Discovery.RootDevice table entry (if this is a root device) or a Discovery.Device table entry (if this is an embedded device). If the referenced object is deleted, the parameter value MUST be set to an empty string. This DiscoveryDevice value can be an empty string because the referenced object has been deleted or the CPE was unable to retrieve the Description Document due to some out-of-band error. The determination to delete this DeviceInstance or use an empty string is implementation specific. - 1.0
DeviceType string(:256) R The value of the UPnP deviceType element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 1.0
FriendlyName string(:128) R The value of the UPnP friendlyName element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 1.0
Manufacturer string(:128) R The value of the UPnP manufacturer element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 1.0
ManufacturerURL string(:256) R The value of the UPnP manufacturerURL element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 1.0
ModelDescription string(:256) R The value of the UPnP modelDescription element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 1.0
ModelName string(:64) R The value of the UPnP modelName element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 1.0
ModelNumber string(:64) R The value of the UPnP modelNumber element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 1.0
ModelURL string(:256) R The value of the UPnP modelURL element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 1.0
SerialNumber string(:128) R The value of the UPnP serialNumber element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 1.0
UPC string(:12) R The value of the UPnP UPC element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 1.0
PresentationURL string(:256) R The value of the UPnP presentationURL element in the Device Description Document for this DeviceInstance and MUST be an absolute URL. The way to obtain an absolute URL from the presentationURL element is specified in [UPnP-DAv1] and [UPnP-DAv11]. If the presentationURL is not provided by the device then this value MUST be an empty string. - 1.0
InternetGatewayDevice.UPnP.Description.ServiceInstance.{i}. object(0:) R

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

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

- 1.0
ParentDevice string(:256) R The value MUST be the Path Name of a DeviceInstance table entry. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 1.0
ServiceId string(:256) R The value of the UPnP serviceId element in the Device Description Document for this ServiceInstance, or an empty string if this value is not provided by the service. If the UPnP serviceId is not provided by the UPnP service, this ServiceInstance MUST be deleted. - 1.0
ServiceDiscovery string(:256) R The value MUST be the Path Name of a Discovery.Service table entry. If the referenced object is deleted, the parameter value MUST be set to an empty string. This ServiceDiscovery value can be an empty string because the referenced object has been deleted or the CPE was unable to retrieve the Description Document due to some out-of-band error. The determination to delete this ServiceInstance or use an empty string is implementation specific. - 1.0
ServiceType string(:256) R The value of the UPnP serviceType element in the Device Description Document for this ServiceInstance, or an empty string if this value is not provided by the service. - 1.0
SCPDURL string R The value of the UPnP SCPDURL element in the Device Description Document for this ServiceInstance and MUST be an absolute URL. The way to obtain an absolute URL from the SCPDURL element is specified in [UPnP-DAv1] and [UPnP-DAv11]. If the SCPDURL is not provided by the device then this value MUST be an empty string. - 1.0
ControlURL string R The value of the UPnP controlURL element in the Device Description Document for this ServiceInstance and MUST be an absolute URL. The way to obtain an absolute URL from the controlURL element is specified in [UPnP-DAv1] and [UPnP-DAv11]. If the controlURL is not provided by the device then this value MUST be an empty string - 1.0
EventSubURL string R The value of the UPnP eventSubURL element in the Device Description Document for this ServiceInstance and MUST be an absolute URL. The way to obtain an absolute URL from the eventSubURLL element is specified in [UPnP-DAv1] and [UPnP-DAv11]. If the eventSubURL is not provided by the device then this value MUST be an empty string - 1.0
InternetGatewayDevice.DLNA. object R This object contains all DLNA related objects and parameters. - 1.0
InternetGatewayDevice.DLNA.Capabilities. object R DLNA capabilities. - 1.0
HNDDeviceClass string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Indicates the supported DLNA Home Network Device Classes [Table 4-1/DLNA-NDIG]. - 1.0
DeviceCapability string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Indicates the supported DLNA Device Capabilities [Table 4-2/DLNA-NDIG]. - 1.0
HIDDeviceClass string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Indicates the supported DLNA Home Infrastructure Device Classes [Table 4-4/DLNA-NDIG]. - 1.0
ImageClassProfileID string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Indicates the DLNA Image Class Profile IDs supported by this device, from Tables 5-2 and 5-3 of [DLNA-NDIG]. - 1.0
AudioClassProfileID string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Indicates the DLNA Audio Class Profile IDs supported by this device, from Tables 5-4 through 5-10 of [DLNA-NDIG]. - 1.0
AVClassProfileID string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Indicates the DLNA AV Class Profile IDs supported by this device, from Tables 5-11 through 5-15 of [DLNA-NDIG]. - 1.0
MediaCollectionProfileID string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Indicates the DLNA Media Collection Profile IDs supported by this device [Table 5-16/DLNA-NDIG]. - 1.0
PrinterClassProfileID string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Indicates the DLNA Printer Class Profile IDs supported by this device [Table 5-17/DLNA-NDIG]. - 1.0
InternetGatewayDevice.SmartCardReader.{i}. object(0:) R

This object describes the characteristics of the smart card reader.

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

- 1.0
Alias string(:64) W

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

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

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

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

- 1.0
Enable boolean W Enables or disables this smart card reader. - 1.0
Status string R

Indicates the status of this smart card reader. Enumeration of:

  • Disabled
  • Enabled (Indicates the smart card reader is enabled and functioning properly)
  • Error (Indicates the smart card reader is enabled and not functioning properly)
- 1.0
Name string(:256) R Human-readable name associated with this smart card reader. - 1.0
Reset boolean W

When set to true, resets the SmartCard Reader and the associated SmartCard.

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

- 1.0
ResetTime dateTime R The time at which this SmartCard Reader was reset. Reset can be caused by:
  • Status transition from Disabled to Enabled
  • Reset set to true.
  • An internal reset of the SmartCard Reader (including a reboot of the device). Unknown Time value indicates that this SmartCard Reader has never been reset, which can only happen if it has never been enabled.
- 1.0
DecryptionFailedCounter unsignedInt R Counter incremented once each time decryption cannot be carried out. This counter relates to the smart card reader, not to the smart card itself, i.e. it is reset when the Reset parameter is used and not when a Smart Card is inserted or removed. - 1.0
DecryptionFailedNoKeyCounter unsignedInt R Counter incremented once each time the key is not available to decrypt it. This is a subset of the more general DecryptionFailedCounter within the same object and thus will always be less than that parameter. This counter relates to the smart card reader, not to the smart card itself, i.e. it is reset when the Reset parameter is used and not when a Smart Card is inserted or removed. - 1.0
InternetGatewayDevice.SmartCardReader.{i}.SmartCard. object R Status of currently associated smart card. - 1.0
Status string R

Status of the Smart Card. Enumeration of:

  • None (Indicates that no Smart Card is inserted)
  • Running (Indicates a Smart Card is present and working normally)
  • Error (Indicates the Smart Card is present and in an error condition)
- 1.0
Type string R

Smart Card Type. Enumeration of:

  • CA
  • DRM
  • UICC Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a2] MUST be adhered to.
- 1.0
Application string[] R

Comma-separated list of strings. Indicates Smart Card Application(s). Application is only relevant when Type has a value of UICC, otherwise it is an empty string. Each list item is an enumeration of:

  • SIM
  • USIM
  • ISIM Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a2] MUST be adhered to.
- 1.0
SerialNumber string(:256) R The Smart Card Serial Number or an empty string if the Smart Card serial Number is not available, e.g. in the case of IPTV due to restrictions of the Service Delivery Platform. - 1.0
ATR string(:1024) R The Smart Card answer to a reset action. Issued by the Smart Card upon reset. - 1.0
InternetGatewayDevice.SelfTestDiagnostics. object R This diagnostics test is vendor-specific and MAY include testing hardware, software, and/or firmware. - 1.0
DiagnosticsState string W

Indicates availability of diagnostic data. Enumeration of:

  • None (READONLY)
  • Requested
  • Complete (READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY) If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code “8 DIAGNOSTICS COMPLETE” in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters.
- 1.0
Results string(:1024) R Results of self-test (vendor specific). - 1.0
InternetGatewayDevice.NSLookupDiagnostics. object R This object defines access to an IP-layer NS Lookup test for the specified IP interface. When initiated, the NS Lookup test will contact DNSServer and look up HostName NumberOfRepetitions times. There will be a Result instance for each time the device performs a DNS lookup, which is determined by the value of NumberOfRepetitions. Any previous Result instances are removed when a new test is initiated. - 1.0
DiagnosticsState string W

Indicates availability of diagnostic data. Enumeration of:

  • None (READONLY)
  • Requested
  • Complete (READONLY)
  • Error_DNSServerNotResolved (Unable to resolve DNSServer Name, READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY) If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code “8 DIAGNOSTICS COMPLETE” in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters.
- 1.0
Interface string(:256) W The value MUST be the Path Name of a table row. This parameter specifies the IP-layer interface over which the test is to be performed (i.e. the source IP address to use when performing the test). If an empty string is specified, the CPE MUST use its routing policy (Forwarding table entries), if necessary, to determine the appropriate interface. - 1.0
HostName string(:256) W Specifies the Host Name that NS Lookup is to look for. The current domain name MUST be used unless the name is a fully qualified name. - 1.0
DNSServer string(:256) W Specifies the DNS Server name or IP address that NS Lookup is to use for the lookup. The name of this server will be resolved using the default DNS server unless an IP address is provided. If an empty string is specified, the device’s default DNS server will be used. - 1.0
Timeout unsignedInt W Timeout in milliseconds that indicates that a request has failed. - 1.0
NumberOfRepetitions unsignedInt W The number of times the device SHOULD repeat the execution of the NSLookup using the same input parameters. If the diagnostics test fails the CPE MAY terminate the test without completing the full number of repetitions. Each repetition will use a Result instance to hold the NSLookup result data. - 1.0
SuccessCount unsignedInt R Number of successfully executed repetitions. - 1.0
ResultNumberOfEntries unsignedInt R The number of entries in the Result table. Total number of Result entries from the most recent invocation of the test. - 1.0
InternetGatewayDevice.NSLookupDiagnostics.Result.{i}. object(0:) R Results from the most recent invocation of the test, one instance per repetition. - 1.0
Status string R

Result Parameter to represent whether the NS Lookup was successful or not. Errors for individual Result instances do not get bubbled up to DiagnosticsState. A failure on a specific attempt does not mean that the overall test failed, but a failure on all attempts means that DiagnosticsState SHOULD be Error_Other. Enumeration of:

  • Success
  • Error_DNSServerNotAvailable
  • Error_HostNameNotResolved
  • Error_Timeout
  • Error_Other
- 1.0
AnswerType string R

Result parameter to represent whether the answer is Authoritative or not. Enumeration of:

  • None (Indicates that the NS Lookup failed to find the host)
  • Authoritative
  • NonAuthoritative
- 1.0
HostNameReturned string(:256) R Result parameter to represent the fully qualified name for the Host Name in the calling parameter (e.g. HostName.DomainName); if no response was provided, then this parameter is an empty string. - 1.0
IPAddresses string(:45)[:10] R [IPAddress] Comma-separated list (up to 10 items) of IP Addresses. Indicates the IP Address results returned by the NS Lookup; if no response was provided, then this parameter is an empty string. - 1.0
DNSServerIP string(:45) R [IPAddress] Result parameter to represent the actual DNS Server IP address that the NS Lookup used. - 1.0
ResponseTime unsignedInt R Response time (for the first response packet) in milliseconds, or 0 if no response was received. - 1.0
InternetGatewayDevice.Firewall. object R Firewall configuration object. - 1.0
Config string W

How this firewall is configured. Enumeration of:

  • High (The firewall implements the “Traffic Denied Inbound” and “Minimally Permit Common Services Outbound” components of the ICSA residential certification’s Required Services Security Policy [ICSA-Residential]. If DoS and vulnerability protections are implemented [ICSA-Baseline], these are enabled)
  • Low (All Outbound traffic and pinhole-defined Inbound traffic is allowed. If DoS and vulnerability protections are implemented [ICSA-Baseline], these are enabled)
  • Off (All Inbound and Outbound traffic is allowed, and the CPE is only protected by NAT settings (if supported and enabled). If DoS and vulnerability protections are implemented [ICSA-Baseline], these are disabled) Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a2] MUST be adhered to.
- 1.0
Version string(:16) R A string identifying the firewall settings version currently used in the CPE, or an empty string if the firewall settings are not associated with a version. - 1.0
LastChange dateTime R The time at which the firewall settings most recently changed. - 1.0
InternetGatewayDevice.USBHosts. object R This object models the CPE’s USB Host controllers. See [Appendix I/TR-157] for Theory of Operation. - 1.0
HostNumberOfEntries unsignedInt R The number of entries in the Host table. - 1.0
InternetGatewayDevice.USBHosts.Host.{i}. object(0:) R

Table of CPE USB Host controllers.

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

- 1.0
Alias string(:64) W

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

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

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

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

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

Type of USB Host Enumeration of:

  • OHCI (Open Host Controller Interface)
  • EHCI (Enhanced Host Controller Interface)
  • UHCI (Universal Host Controller Interface)
  • xHCI (Extensible Host Controller Interface)
- 1.0
Reset boolean W

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

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

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

Table of connected USB devices.

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

- 1.0
DeviceNumber unsignedInt R Device number on USB bus. - 1.0
USBVersion string(:4) R USB specification version with which the device complies. Example: “1.1” - 1.0
DeviceClass hexBinary(:1) R Class Code as assigned by USB-IF. When 0x00, each device specifies its own class code. When 0xFF, the class code is vendor specified. - 1.0
DeviceSubClass hexBinary(:1) R Subclass code (assigned by USB-IF). - 1.0
DeviceVersion unsignedInt(:65535) R Device release number. - 1.0
DeviceProtocol hexBinary(:1) R Protocol code (assigned by USB-IF). - 1.0
ProductID unsignedInt(:65535) R Product ID (assigned by manufacturer). - 1.0
VendorID unsignedInt(:65535) R Vendor ID (assigned by USB-IF). - 1.0
Manufacturer string(:64) R Device Manufacturer string descriptor. - 1.0
ProductClass string(:64) R Device Product Class string descriptor. - 1.0
SerialNumber string(:64) R Device SerialNumber string descriptor. - 1.0
Port unsignedInt(:255) R Hub port on parent device. 0 when no parent. - 1.0
Rate string R

Speed of the USB device. Enumeration of:

  • Low (1.5 Mbits/sec (187.5 KB/sec) defined in [USB1.0])
  • Full (12 Mbits/sec (1.5 MB/sec) defined in [USB1.0])
  • High (480 Mbits/sec (60 MB/sec) defined in [USB2.0])
  • Super (5.0 Gbits/sec (625 MB/sec) defined in [USB3.0]) Internal signaling between the connected USB device and the USB Host Controller provide the information needed to determine the negotiated rate.
- 1.0
Parent string R The value MUST be the Path Name of a row in the Device. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is a reference to the parent USB device (e.g. hub device). This is an empty string for a device connected to the Host controller (root hub). - 1.0
MaxChildren unsignedInt R Number of ports. Only applies for hub device, equal to 0 for other devices. - 1.0
IsSuspended boolean R When true the associated Device is in a suspended (i.e. low-power) state (see [Chapter 11.9/USB2.0]). When false the associated Device is in any of the other states specified by the USB 2.0 Device State Machine (see [Chapter 9.1.1/USB2.0]). - 1.0
IsSelfPowered boolean R When true the associated device is at least partly powered by a local source (see [Chapter 9.4.5/USB2.0]). When false the associated device draws all the current it needs from the USB bus. - 1.0
ConfigurationNumberOfEntries unsignedInt R The number of entries in the Configuration table. - 1.0
InternetGatewayDevice.USBHosts.Host.{i}.Device.{i}.Configuration.{i}. object(0:) R

Table of device configurations.

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

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

Table of device interface descriptors.

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

- 1.0
InterfaceNumber unsignedInt(:255) R Number of this interface (from USB interface descriptor). - 1.0
InterfaceClass hexBinary(:1) R Class Code as assigned by USB-IF. When 0x00, each interface specifies its own class code. When 0xFF, the class code is vendor specified. - 1.0
InterfaceSubClass hexBinary(:1) R Subclass code (assigned by USB-IF). - 1.0
InterfaceProtocol hexBinary(:1) R Protocol code (assigned by USB-IF). - 1.0
InternetGatewayDevice.PeriodicStatistics. object R This object configures collection of periodic statistics for the device. Periodic statistics are measured over a sample interval (which can be aligned with absolute time) and are made available to the ACS as a comma-separated list of the most recent <n> samples. This object provides a single set of global settings that affect the entire device unless overridden locally. - 1.0
MinSampleInterval unsignedInt R Minimum sample interval in seconds that the CPE is able to support. A value of 0 indicates no specific minimum sample interval. - 1.0
MaxReportSamples unsignedInt R Maximum number of samples of each statistic that the CPE is able to store and report. A value of 0 indicates no specific maximum number of samples. - 1.0
SampleSetNumberOfEntries unsignedInt R The number of entries in the SampleSet table. - 1.0
InternetGatewayDevice.PeriodicStatistics.SampleSet.{i}. object(0:) W

Periodic statistics sample set table. Each sample set has its own sample interval etc.

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

- 1.0
Alias string(:64) W

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

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

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

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

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

- 1.0
Enable boolean W Enables or disables collection of periodic statistics for this sample set. When collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately. false 1.0
Status string R

Indicates availability of Sample statistics. Enumeration of:

  • Disabled (Collection is disabled)
  • Enabled (Collection is enabled)
  • Trigger (Collection is enabled and the ACS SHOULD now fetch the collected data) The Trigger value is only used for triggering the ACS to fetch the collected data and can only be used when FetchSamples is in the range [1:ReportSamples]. The transition from Enabled to Trigger to Enabled MUST be instantaneous and so will result in only a single value change for notification purposes.
Disabled 1.0
Name string(:128) W The name of this sample set, which uniquely distinguishes each sample set. 1.0
SampleInterval unsignedInt(1:) W The sample interval in seconds. Each statistic is measured over this sample interval. The CPE MAY reject a request to set SampleInterval to less than PeriodicStatistics.MinSampleInterval. Sample intervals MUST begin every SampleInterval seconds, with no delay between samples. If SampleInterval is changed while collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately. For example, if ReportSamples is 24 and SampleInterval is 3600 (an hour), the CPE can store up to a day’s worth of samples for each statistic. 3600 1.0
ReportSamples unsignedInt(1:) W The number of samples that the CPE will store and report for each statistic. The CPE MUST permit ReportSamples to be set to at least PeriodicStatistics.MaxReportSamples. If ReportSamples is changed while collection of periodic statistics is enabled, the CPE will truncate or extend its statistics buffers as appropriate, but statistics collection MUST NOT otherwise be affected. For example, if ReportSamples is 24 and SampleInterval is 3600 (an hour), the CPE can store up to a day’s worth of samples for each statistic. 24 1.0
TimeReference dateTime W An absolute time reference in UTC to determine when sample intervals will complete. Each sample interval MUST complete at this reference time plus or minus an integer multiple of SampleInterval. TimeReference is used only to set the “phase” of the sample and fetch intervals. The actual value of TimeReference can be arbitrarily far into the past or future. This time reference also determines when the Status Enabled to Trigger to Enabled transitions that are controlled by FetchSamples will occur. If collection of periodic statistics is enabled and FetchSamples is in the range [1:ReportSamples] then each such Status transition MUST occur at this reference time plus or minus an integer multiple of FetchSamples * SampleInterval (the fetch interval). If TimeReference is changed while collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately. The Unknown Time value defined in [TR-106a2] indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and is required only to adhere to the specified sample and fetch intervals. If absolute time is not available to the CPE, its sample and fetch interval behavior MUST be the same as if the TimeReference parameter was set to the Unknown Time value. For example, if SampleInterval is 3600 (an hour) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then sample intervals will complete on each UTC hour (00:00, 01:00, 02:00 etc). If, in addition, FetchSamples is 24, then the fetch interval is 86400 (a day) and Status Enabled to Trigger to Enabled transitions will occur every day at UTC midnight. Note that, if TimeReference is set to a time other than the Unknown Time, the first sample interval (which has to begin immediately) will almost certainly be shorter than SampleInterval). This is why TimeReference is defined in terms of when sample intervals complete rather than start. 0001-01-01T00:00:00Z 1.0
FetchSamples unsignedInt W The number of sample intervals to be collected before transitioning Status from Enabled to Trigger to Enabled. If this SampleSet is enabled and FetchSamples is in the range [1:ReportSamples] then Status MUST transition from Enabled to Trigger to Enabled on completion of every FetchSamples sample intervals. Otherwise, the transition MUST NOT occur. For example, if ReportSamples is 25 and FetchSamples is 24, then the CPE will store 25 values for each monitored parameter and the above Status transition will occur as the CPE stores each 24th of 25 sample intervals, which means that the ACS could delay for up to two sample intervals before reading the stored values and would still not miss any samples (see also ForceSample). To disable this trigger mechanism and still collect sampled statistics, FetchSamples can be set to either 0 or a value greater than ReportSamples. 0 1.0
ForceSample boolean W When set to true, forces statistics for the current sample to be calculated and updated in the data model. Setting it to false has no effect. When read, this parameter returns false, regardless of the actual value. If this is the first time that ForceSample has been set to true during the current sample interval, this MUST cause a new value to be added to each of the periodic statistics comma-separated list parameters, and the ReportEndTime and all SampleSeconds parameters MUST be updated accordingly. If this is not the first time that ForceSample has been set to true during the current sample interval, then the new values that were added as described in the previous paragraph, and the ReportEndTime and all SampleSeconds parameters, MUST be updated accordingly. Note that ForceSample just provides a “sneak preview” of the current sample. It does not create a new sample and it does not interfere with the sample interval schedule. At the end of each sample interval, if ForceSample was set to true during the sample interval then the new values that were added as described above, and the ReportEndTime and all SampleSeconds parameters, will be updated accordingly. In other words, the partial sample data that was created when ForceSample was set to true will be updated one last time at the end of the sample interval. false 1.0
ReportStartTime dateTime R The absolute time at which the sample interval for the first stored sample (for each statistic) started. 1.0
ReportEndTime dateTime R The absolute time at which the sample interval for the last stored sample (for each statistic) ended. If ForceSample has been used to force statistics for the current sample to be calculated and updated in the data model, then ReportEndTime MUST be updated to reflect the actual time over which stored data was collected. 1.0
SampleSeconds unsignedInt[] R Comma-separated list of unsigned integers. Each entry indicates the number of seconds during which data was collected during the sample interval. Individual SampleSeconds values can be less than SampleInterval, for several reasons, including:
  • TimeReference has been set to a time other than the Unknown Time and the current sample interval started part of the way through a scheduled sample interval.
  • ForceSample has been used to force statistics for the current sample to be calculated and updated in the data model.
1.0
ParameterNumberOfEntries unsignedInt R The number of entries in the Parameter table. 0 1.0
InternetGatewayDevice.PeriodicStatistics.SampleSet.{i}.Parameter.{i}. object(0:) W

Periodic statistics parameter table for this sample set. This table contains entries for parameters whose values are to be sampled. Note that the comma-separated lists in this object (SampleSeconds, SuspectData and Values) only ever change (a) when first enabled, (b) when ForceSample is set to true (a “sneak preview” of the current sample), or (c) at the end of the sample interval.

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

- 1.0
Alias string(:64) W

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

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

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

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

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

- 1.0
Enable boolean W Enables or disables this object instance. false 1.0
Reference string(:256) W The value MUST be the Path Name of a parameter. This is the parameter being monitored by the Periodic Statistics mechanism. 1.0
SampleMode string W

Controls how this parameter’s value is sampled. Enumeration of:

  • Current (Sampled value is current value)
  • Change (Sampled value is change in value since start of sample interval) Parameters of non-numeric types can only support Current. The value of the SampleMode MUST be ignored for such parameters.
Current 1.0
CalculationMode string W

Controls how this parameter’s statistic is calculated from the sampled value(s). Enumeration of:

  • Latest (Statistic is sampled value at end of sample interval)
  • Minimum (Statistic is minimum sampled value during sample interval)
  • Maximum (Statistic is maximum sampled value during sample interval)
  • Average (Statistic is average (mean) sampled value during sample interval) Parameters of non-numeric types can only support Latest. The value of the CalculationMode MUST be ignored for such parameters. SampleMode MUST be applied before CalculationMode, i.e. the inputs to the calculation will have already accounted for SampleMode.
Latest 1.0
LowThreshold int W The low threshold value that controls the calculation of Failures. A value equal to HighThreshold disables the threshold/failure mechanism. Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters. 0 1.0
HighThreshold int W The high threshold value that controls the calculation of Failures. A value equal to LowThreshold disables the threshold/failure mechanism. Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters. 0 1.0
SampleSeconds unsignedInt[] R Comma-separated list of unsigned integers. Each entry indicates the number of seconds during which data was collected for this parameter during the sample interval. Individual SampleSeconds values can be less than PeriodicStatistics.SampleSet.{i}.SampleInterval, for several reasons, including: 1.0
SuspectData unsignedInt(:1)[] R Comma-separated list of unsigned integers (up to 1). Each entry is 0 if the sampled value is believed to be valid, or 1 if an event that might affect the validity of the sampled value occurred during the sample interval. For example, if the parameter value were to be reset during the sample interval then it would be appropriate to set SuspectData to 1. 1.0
Values string[] R Comma-separated list of strings. Each entry indicates the value of the referenced parameter, as determined by SampleMode, during the sample interval. The statistics values in this comma-separated lists MUST be in time order, with the oldest one first and the most recent one last. If the SampleMode parameter is not present, or is inappropriate for the referenced parameter, the statistics values MUST be collected in Current mode. 1.0
Failures unsignedInt R Counts the number of times (since this object instance was last enabled) that a newly-calculated sample value (accounting for SampleMode) transitioned from the “in range” state to the “out of range” state, or between the “out of range (low)” and “out of range (high)” states. The states are defined as follows:
  • “in range” : current value is greater than LowThreshold and less than HighThreshold.
  • “out of range” : current value is less than or equal to LowThreshold, or greater than or equal to HighThreshold.
  • “out of range (low)” : current value is less than or equal to LowThreshold.
  • “out of range (high)” : current value is greater than or equal to HighThreshold. Note that, if LowThreshold and HighThreshold are both the same, the threshold/failure mechanism is disabled, so the value of this parameter will not increment. This parameter can be incremented at any time during a sample interval, and might be incremented more than once during a single sample interval. For this reason, the CPE SHOULD place a locally specified limit on the frequency at which it will notify the ACS of such changes, as described in [Section 3.2.1/TR-069a2]. Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters.
0 1.0
InternetGatewayDevice.DownloadAvailability. object R This object contains multicast announcement and query parameters used for the purpose of downloading files. - 1.0
InternetGatewayDevice.DownloadAvailability.Announcement. object R This object contains multicast announcement parameters used to download files. - 1.0
Enable boolean W Enable/disable CPE ability to receive and use multicast announcements from a server for the purpose of downloading files. - 1.0
Status string R

The status of the announcement service. Enumeration of:

  • Disabled
  • Enabled
  • Error (MAY be used by the CPE to indicate a locally defined error condition, OPTIONAL)
- 1.0
GroupNumberOfEntries unsignedInt R The number of entries in the Group table. - 1.0
InternetGatewayDevice.DownloadAvailability.Announcement.Group.{i}. object(0:) W

Multicast groups to which the CPE SHOULD listen for announcements.

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

- 1.0
Alias string(:64) W

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

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

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

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

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

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

The status of this group table entry. Enumeration of:

  • Disabled
  • Enabled
  • Error (MAY be used by the CPE to indicate a locally defined error condition, e.g. unable to parse received announcements, OPTIONAL)
Disabled 1.0
URL string(:256) W URL [RFC3986] encoding the group address, source and port on which to listen, and other protocol information, e.g. expected announcement format. Depending on the application, the messages identified by this URL MAY directly contain the data to be downloaded, or alternatively MAY contain information informing the CPE how to obtain the data to be downloaded via a separate mechanism, which itself could involve a unicast or a multicast download protocol. Refer to [DVB-TS.102.824] for an example of a URL format that identifies a SAP [RFC2974] stream that indicates how to use either FLUTE [RFC3926] or DSM-CC [ISO-13818-6:1998] to perform the download. 1.0
InternetGatewayDevice.DownloadAvailability.Query. object R This object contains multicast query parameters used to download files. - 1.0
Enable boolean W Enable/disable CPE ability to autonomously query a server for the purpose of downloading files. - 1.0
Status string R

The status of the query service. Enumeration of:

  • Disabled
  • Enabled
  • Error (MAY be used by the CPE to indicate a locally defined error condition, e.g. unable to contact query response server, OPTIONAL)
- 1.0
URL string(:256) W URL [RFC3986] of the query response server. Depending on the application, the protocol described by this URL MAY be a SOAP interface, or MAY be any other RPC mechanism. Refer to [DVB-TS.102.824] for an example of a URL format that identifies a SOAP interface running over HTTP or HTTPS. - 1.0
InternetGatewayDevice.SoftwareModules. object R Top level object for dynamically managed software applications. - 1.0
ExecEnvNumberOfEntries unsignedInt R The number of entries in the ExecEnv table. - 1.0
DeploymentUnitNumberOfEntries unsignedInt R The number of entries in the DeploymentUnit table. - 1.0
ExecutionUnitNumberOfEntries unsignedInt R The number of entries in the ExecutionUnit table. - 1.0
InternetGatewayDevice.SoftwareModules.ExecEnv.{i}. object(0:) R

The Execution Environments that are available on the device, along with their properties and configurable settings.

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

- 1.0
Enable boolean W Indicates whether or not this ExecEnv is enabled. Disabling an enabled Execution Environment stops it, while enabling a disabled Execution Environment starts it. When an Execution Environment is disabled, Deployment Units installed to that Execution Environment will be unaffected, but any Execution Units currently running on that Execution Environment will automatically transition to Idle. If a ChangeDUState is attempted on a DeploymentUnit that is to be applied against a disabled ExecEnv, that ChangeDUState operation fails and the associated DUStateChangeComplete RPC will contain a FaultStruct for that operation. If a SetParameterValues is attempted against the ExecutionUnit.{i}.RequestedState for an ExecutionUnit that is associated with a disabled ExecEnv a CWMP Fault will be issued in response. Disabling an Execution Environment could place the device in a non-manageable state. For example, if the operating system itself was modeled as an ExecEnv and the ACS disabled it, the CWMP management agent might be terminated leaving the device unmanageable. - 1.0
Status string R

Indicates the status of this ExecEnv. Enumeration of:

  • Up
  • Error (OPTIONAL)
  • Disabled
- 1.0
Reset boolean W Setting this parameter to true causes this ExecEnv to revert back to the state it was in when the device last issued a “0 BOOTSTRAP” Inform event. The following requirements dictate what MUST happen for the reset to be complete:
  1. All Deployment Units that were installed after the last “0 BOOTSTRAP” Inform event MUST be removed
  2. All persistent storage, configuration files, and log files that were associated with the removed Deployment Units MUST be removed
  3. Any Deployment Unit that is still installed against the Execution Environment MUST be restored to the version present when the last “0 BOOTSTRAP” Inform event was issued
  4. Any Deployment Unit that was present when the last “0 BOOTSTRAP” Inform event was issued, but was subsequently uninstalled and is now not present, MUST be installed with the version that was present when the last “0 BOOTSTRAP” Inform event was issued
  5. The Execution Environment MUST be restored to the version and configuration present when the last “0 BOOTSTRAP” Inform event was issued
  6. The Execution Environment MUST be restarted after all other restoration requirements have been met
- 1.0
Alias string(:64) W

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

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

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

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

- 1.0
Name string(:32) R A Name provided by the CPE that adequately distinguishes this ExecEnv from all other ExecEnv instances. - 1.0
Type string(:64) R Indicates the complete type and specification version of this ExecEnv. - 1.0
InitialRunLevel unsignedInt(:65535) W The run level that this ExecEnv will be in upon startup (whether that is caused by a CPE Boot or the Execution Environment starting). Run levels dictate which Execution Units will be started. Execution Units will be started if CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true. If the value of CurrentRunLevel is -1, then the value of this parameter is irrelevant when read and setting its value has no impact on the Run Level of this ExecEnv. - 1.0
RequestedRunLevel int(-1:65535) W Provides a mechanism to remotely manipulate the run level of this ExecEnv, meaning that altering this parameter’s value will change the value of the CurrentRunLevel. Run levels dictate which Execution Units will be started. Execution Units will be started if CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true. Setting this value when CurrentRunLevel is -1 has no impact to the Run Level of this ExecEnv. - 1.0
CurrentRunLevel int(-1:65535) R The run level that this ExecEnv is currently operating in. This value is altered by changing the RequestedRunLevel parameter. Upon startup (whether that is caused by a CPE Boot or the Execution Environment starting) CurrentRunLevel will be equal to InitialRunLevel, unless Run Levels are not supported by this ExecEnv in which case CurrentRunLevel will be -1. Run levels dictate which Execution Units will be started. Execution Units will be started if CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true. If CurrentRunLevel is -1 then Run Levels are not supported by this ExecEnv and setting InitialRunLevel or RequestedRunLevel will not impact the Run Level of this ExecEnv. - 1.0
InitialExecutionUnitRunLevel int(-1:65535) W Indicates the initial value on creation for ExecutionUnit.{i}.RunLevel for all Execution Unit instances associated with this ExecEnv. If the value of CurrentRunLevel is -1, then the value of this parameter is irrelevant when read and setting its value has no impact on the Run Level of any Execution Unit. - 1.0
Vendor string(:128) R The vendor that produced this ExecEnv. - 1.0
Version string(:32) R The Version of this ExecEnv as specified by the Vendor that implemented this ExecEnv, not the version of the specification. - 1.0
ParentExecEnv string R The value MUST be the Path Name of a row in the ExecEnv. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Represents the parent ExecEnv of this ExecEnv. If this value is an empty string then this is the Primary Execution Environment. - 1.0
AllocatedDiskSpace int(-1:) R The amount of disk space measured in kilobytes allocated to this ExecEnv. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 1.0
AvailableDiskSpace int(-1:) R The amount of disk space measured in kilobytes currently available to this ExecEnv. This value changes as the ExecutionUnit instances associated with this ExecEnv consumes disk space. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 1.0
AllocatedMemory int(-1:) R The amount of physical RAM measured in kilobytes allocated to this ExecEnv. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 1.0
AvailableMemory int(-1:) R The amount of physical RAM measured in kilobytes currently available to this ExecEnv. This value changes as the ExecutionUnit instances associated with this ExecEnv are started/stopped and consume the physical RAM. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 1.0
ActiveExecutionUnits string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the ExecutionUnit. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the ExecutionUnit instances currently running on this ExecEnv. This parameter only contains ExecutionUnit instances that currently have a ExecutionUnit.{i}.Status of Active. - 1.0
ProcessorRefList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.Processor. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the processors that this ExecEnv has available to it. - 1.0
InternetGatewayDevice.SoftwareModules.DeploymentUnit.{i}. object(0:) R

This table serves as the Deployment Unit inventory and contains status information about each Deployment Unit. A new instance of this table gets created during the installation of a Software Module.

At most one entry in this table can exist with the same values for all of UUID, Version and ExecutionEnvRef, or with a given value for Alias.

- 1.0
UUID string(:36) R A Universally Unique Identifier either provided by the ACS, or generated by the CPE, at the time of Deployment Unit Installation. The format of this value is defined by [RFC4122] Version 3 (Name-Based) and [Annex H/TR-069a3]. This value MUST NOT be altered when the DeploymentUnit is updated. - 1.0
DUID string(:64) R Deployment Unit Identifier chosen by the targeted ExecEnv. The format of this value is Execution Environment specific. - 1.0
Alias string(:64) W

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

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

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

At most one entry in this table can exist with the same values for all of UUID, Version and ExecutionEnvRef, or with a given value for Alias.

- 1.0
Name string(:64) R Indicates the Name of this DeploymentUnit, which is chosen by the author of the Deployment Unit. The value of this parameter is used in the generation of the UUID based on the rules defined in [Annex H/TR-069a3]. - 1.0
Status string R

Indicates the status of this DeploymentUnit. Enumeration of:

  • Installing (This instance is in the process of being Installed and SHOULD transition to the Installed state)
  • Installed (This instance has been successfully Installed. The Resolved flag SHOULD also be referenced for dependency resolution)
  • Updating (This instance is in the process of being Updated and SHOULD transition to the Installed state)
  • Uninstalling (This instance is in the process of being Uninstalled and SHOULD transition to the Uninstalled state)
  • Uninstalled (This instance has been successfully Uninstalled. This status will typically not be seen within a DeploymentUnit instance)
- 1.0
Resolved boolean R Indicates whether or not this DeploymentUnit has resolved all of its dependencies. - 1.0
URL string(:1024) R Contains the URL used by the most recent ChangeDUState RPC to either Install or Update this DeploymentUnit. - 1.0
Description string(:256) R Textual description of this DeploymentUnit. The format of this value is Execution Environment specific. - 1.0
Vendor string(:128) R The author of this DeploymentUnit formatted as a domain name. The value of this parameter is used in the generation of the UUID based on the rules defined in [Annex H/TR-069a3]. - 1.0
Version string(:32) R Version of this DeploymentUnit. The format of this value is Execution Environment specific. - 1.0
VendorLogList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorLogFile. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor log files that have come into existence because of this DeploymentUnit. This does not include any vendor log files that have come into existence because of ExecutionUnit instances that are contained within this DeploymentUnit. When this DeploymentUnit is uninstalled the vendor log files referenced here SHOULD be removed from the CPE. Not all DeploymentUnit instances will actually have a corresponding vendor log file, in which case the value of this parameter will be an empty string. - 1.0
VendorConfigList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorConfigFile. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor config files that have come into existence because of this DeploymentUnit. This does not include any vendor config files that have come into existence because of ExecutionUnit instances that are contained within this DeploymentUnit. When this DeploymentUnit is uninstalled the vendor config files referenced here SHOULD be removed from the CPE. Not all DeploymentUnit instances will actually have a corresponding vendor config file, in which case the value of this parameter will be an empty string. - 1.0
ExecutionUnitList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the ExecutionUnit. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the ExecutionUnit instances that are associated with this DeploymentUnit instance. - 1.0
ExecutionEnvRef string R The value MUST be the Path Name of a row in the ExecEnv. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Represents the ExecEnv instance where this DeploymentUnit instance is installed. - 1.0
InternetGatewayDevice.SoftwareModules.ExecutionUnit.{i}. object(0:) R

This table serves as the Execution Unit inventory and contains both status information about each Execution Unit as well as configurable parameters for each Execution Unit. Each DeploymentUnit that is installed can have zero or more Execution Units. Once a Deployment Unit is installed it populates this table with its contained Execution Units. When the Deployment Unit (that caused this ExecutionUnit to come into existence) is updated, this instance MAY be removed and new instances MAY come into existence. While the Deployment Unit (that caused this ExecutionUnit to come into existence) is being updated, all ExecutionUnit instances associated with the Deployment Unit will be stopped until the update is complete at which time they will be restored to the state that they were in before the update started. When the Deployment Unit (that caused this ExecutionUnit to come into existence) is uninstalled, this instance is removed. Each ExecutionUnit MAY also contain a set of vendor specific parameters displaying status and maintaining configuration that reside under the Extensions object.

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

- 1.0
EUID string(:64) R Execution Unit Identifier chosen by the ExecEnv during installation of the associated DeploymentUnit. The format of this value is Execution Environment specific, but it MUST be unique across ExecEnv instances. Thus, it is recommended that this be a combination of the ExecEnv.{i}.Name and an Execution Environment local unique value. - 1.0
Alias string(:64) W

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

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

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

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

- 1.0
Name string(:32) R The name of this ExecutionUnit as it pertains to its associated DeploymentUnit, which SHOULD be unique across all ExecutionUnit instances contained within its associated DeploymentUnit. - 1.0
ExecEnvLabel string(:64) R The name of this ExecutionUnit as provided by the ExecEnv, which SHOULD be unique across all ExecutionUnit instances contained within a specific ExecEnv. - 1.0
Status string R

Indicates the status of this ExecutionUnit. Enumeration of:

  • Idle (This instance is in an Idle state and not running)
  • Starting (This instance is in the process of Starting and SHOULD transition to the Active state)
  • Active (This instance is currently running)
  • Stopping (This instance is in the process of Stopping and SHOULD transition to the Idle state)
- 1.0
RequestedState string W

Indicates the state transition that the ACS is requesting for this ExecutionUnit. Enumeration of:

  • Idle (If this ExecutionUnit is currently in Starting or Active the CPE will attempt to Stop the Execution Unit; otherwise this requested state is ignored)
  • Active (If this ExecutionUnit is currently in Idle the CPE will attempt to Start the Execution Unit. If this ExecutionUnit is in Stopping the request is rejected and a fault raised. Otherwise this requested state is ignored) If this ExecutionUnit is associated with an Execution Environment that is disabled and an attempt is made to alter this value, then a CWMP Fault MUST be generated.
- 1.0
ExecutionFaultCode string R

If while running or transitioning between states this ExecutionUnit identifies a fault this parameter embodies the problem. The value of NoFault MUST be used when everything is working as intended. Enumeration of:

  • NoFault
  • FailureOnStart
  • FailureOnAutoStart
  • FailureOnStop
  • FailureWhileActive
  • DependencyFailure
  • UnStartable For fault codes not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in [Section 3.3/TR-106a4].
- 1.0
ExecutionFaultMessage string(:256) R If while running or transitioning between states this ExecutionUnit identifies a fault this parameter provides a more detailed explanation of the problem. If ExecutionFaultCode has the value of NoFault then the value of this parameter MUST an empty string and ignored by the ACS. - 1.0
AutoStart boolean W If true and the RunLevel verification is also met, then this ExecutionUnit will be automatically started by the device after its ExecEnv is either rebooted or restarted. If false this ExecutionUnit will not be started after its ExecEnv is either rebooted or restarted until it is explicitly commanded to do so by either the ACS or another Execution Unit. - 1.0
RunLevel unsignedInt(:65535) W Determines when this ExecutionUnit will be started. If AutoStart is true and ExecEnv.{i}.CurrentRunLevel is greater than or equal to RunLevel, then this ExecutionUnit will be started. If the value of ExecEnv.{i}.CurrentRunLevel is -1, then the associated ExecEnv. doesn’t support Run Levels, thus the value of this parameter is irrelevant when read and setting its value has no impact to the Run Level of this ExecutionUnit. - 1.0
Vendor string(:128) R Vendor of this ExecutionUnit. - 1.0
Version string(:32) R Version of the ExecutionUnit. The format of this value is Execution Environment specific. - 1.0
Description string(:256) R Textual description of this ExecutionUnit. The format of this value is Execution Environment specific. - 1.0
DiskSpaceInUse int(-1:) R The amount of disk space measured in kilobytes currently being used by this ExecutionUnit. A value of -1 MUST be used for ExecutionUnit instances where this parameter is not applicable. - 1.0
MemoryInUse int(-1:) R The amount of physical RAM measured in kilobytes currently being used by this ExecutionUnit. A value of -1 MUST be used for ExecutionUnit instances where this parameter is not applicable. - 1.0
References string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a table row, or an empty string. Represents the instances of multi-instanced objects that are directly controlled by, and have come into existence because of, this ExecutionUnit. See [Appendix II.3.2/TR-157a3] for more description and some examples. NOTE: All other objects and parameters (i.e. not multi-instanced objects) that this ExecutionUnit has caused to come into existence can be discovered via the DeviceInfo.SupportedDataModel.{i}. table. - 1.0
AssociatedProcessList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.ProcessStatus.Process. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the system processes that are active in the system because of this ExecutionUnit. If Status is not Active it is expected that this list will be an empty string. Some ExecutionUnit instances MIGHT NOT have any system processes irrespective of the value of Status. - 1.0
VendorLogList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorLogFile. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor log files that have come into existence because of this ExecutionUnit. When the DeploymentUnit (that caused this ExecutionUnit to come into existence) is uninstalled the vendor log files referenced here SHOULD be removed from the CPE. Not all ExecutionUnit instances will actually have a corresponding vendor log file, in which case the value of this parameter will be an empty string. - 1.0
VendorConfigList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorConfigFile. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor config files that have come into existence because of this ExecutionUnit. When the DeploymentUnit (that caused this ExecutionUnit to come into existence) is uninstalled the vendor config files referenced here SHOULD be removed from the CPE. Not all ExecutionUnit instances will actually have a corresponding vendor config file, in which case the value of this parameter will be an empty string. - 1.0
SupportedDataModelList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.SupportedDataModel. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the CWMP-DT schema instances that have been introduced to this device because of the existence of this ExecutionUnit. - 1.0
ExecutionEnvRef string R The value MUST be the Path Name of a row in the ExecEnv. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Represents the ExecEnv that this ExecutionUnit is associated with. - 1.0
InternetGatewayDevice.SoftwareModules.ExecutionUnit.{i}.Extensions. object R This object proposes a general location for vendor extensions specific to this Execution Unit, which allows multiple Execution Units to expose parameters without the concern of conflicting parameter names. These vendor extensions are related to displaying status and maintaining configuration for this Execution Unit. It is also possible for the Execution Unit to expose status and configuration parameters within Service objects or as embedded objects and parameters directly within the root data model, in which case the combination of References and SupportedDataModelList will be used to determine their locations. See [Appendix II.3.2/TR-157a3] for more description and some examples. - 1.0
InternetGatewayDevice.Security. object R This object contains general information related to managing security features on the device. - 1.0
CertificateNumberOfEntries unsignedInt R The number of entries in the Certificate table. - 1.0
InternetGatewayDevice.Security.Certificate.{i}. object(0:) R

This table provides information about all types of public key-based credentials, such as X.509 certificates, see [RFC5280].

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

- 1.0
Enable boolean W Enables or disables this certificate. - 1.0
LastModif dateTime R The last modification time of this certificate. - 1.0
SerialNumber string(:64) R The Serial Number field in an X.509 certificate, see [RFC5280]. - 1.0
Issuer string(:256) R The Issuer field in an X.509 certificate, see [RFC5280]; i.e. the Distinguished Name (DN) of the entity who has signed the certificate. - 1.0
NotBefore dateTime R The beginning of the certificate validity period; i.e. the Not Before field in an X.509 certificate, see [RFC5280]. - 1.0
NotAfter dateTime R The end of the certificate validity period; i.e., the Not After field in an X.509 certificate, see [RFC5280]. - 1.0
Subject string(:256) R The Distinguished Name (DN) of the entity associated with the Public Key; i.e., the Subject field in an X.509 certificate, see [RFC5280]. - 1.0
SubjectAlt string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Each item is a DNS Name. The Subject Alternative Names extension field in an X.509 certificate, see [RFC5280]. - 1.0
SignatureAlgorithm string(:256) R The algorithm used in signing the certificate; i.e. the Signature Algorithm field in an X.509 certificate, see [RFC5280]. - 1.0
InternetGatewayDevice.FaultMgmt. object R This object contains parameters relating to Fault/Alarm Management. - 1.0
SupportedAlarmNumberOfEntries unsignedInt R The number of entries in the SupportedAlarm table. - 1.0
MaxCurrentAlarmEntries unsignedInt R The maximum number of entries allowed in the FaultMgmt.CurrentAlarm.{i}. table. - 1.0
CurrentAlarmNumberOfEntries unsignedInt R The number of entries in the CurrentAlarm table. - 1.0
HistoryEventNumberOfEntries unsignedInt R The number of entries in the HistoryEvent table. - 1.0
ExpeditedEventNumberOfEntries unsignedInt R The number of entries in the ExpeditedEvent table. - 1.0
QueuedEventNumberOfEntries unsignedInt R The number of entries in the QueuedEvent table. - 1.0
InternetGatewayDevice.FaultMgmt.SupportedAlarm.{i}. object(0:) R

Supported Alarm Entries which can be raised by the device. The instance numbers for this table SHOULD be maintained across firmware upgrades of the device.

At most one entry in this table can exist with the same values for all of EventType, ProbableCause, SpecificProblem and PerceivedSeverity.

- 1.0
EventType string(:64) R Indicates the type of event. - 1.0
ProbableCause string(:64) R Qualifies the alarm and provides further information than EventType. - 1.0
SpecificProblem string(:128) R Provides further qualification on the alarm beyond EventType and ProbableCause. This is vendor defined and will be an empty string if the device doesn’t support unique indexing of the table using SpecificProblem. The string can be set to “*” to indicate the default case if only a subset of SpecificProblem are to be contained within the table. - 1.0
PerceivedSeverity string R

Indicates the relative level of urgency for operator attention, see [ITU-X.733]. Enumeration of:

  • <Empty> (An empty string)
  • ***
  • Cleared
  • Critical
  • Major
  • Minor
  • Warning
  • Indeterminate This will be an empty string if the device doesn’t support unique indexing of the table using PerceivedSeverity. The string can be set to “*” to indicate the default case if only a subset of PerceivedSeverity are to be contained within the table.
- 1.0
ReportingMechanism string W

Indicates the reporting mechanism setting of the alarm. Enumeration of:

- 1.0
InternetGatewayDevice.FaultMgmt.CurrentAlarm.{i}. object(0:) R

Contains all currently active alarms (whose FaultMgmt.SupportedAlarm.{i}.PerceivedSeverity is not Cleared). Newly raised alarms result in a new entry in this table being added, any changes to the alarm as a result of an update event are updated in the existing table entry, and a clear event raised against an alarm results in the alarm being removed from this table.

If maximum entries as indicated by FaultMgmt.MaxCurrentAlarmEntries is reached, the next event overrides the object with the oldest AlarmChangedTime. When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the ACS (even if their new values are identical to those of the prior alarm).

At most one entry in this table can exist with a given value for AlarmIdentifier, or with the same values for all of EventType, ProbableCause and SpecificProblem.

- 1.0
AlarmIdentifier string(:64) R Identifies one Alarm Entry in the Alarm List. This value MUST be uniquely allocated by the device to the alarm instance during the lifetime of the individual alarm. - 1.0
AlarmRaisedTime dateTime R Indicates the date and time when the alarm was first raised by the device. - 1.0
AlarmChangedTime dateTime R Indicates the date and time when the alarm was last changed by the device. - 1.0
ManagedObjectInstance string(:512) R Specifies the instance of the Informational Object Class in which the alarm occurred by carrying the Distinguished Name (DN) of this object instance. The format of the DN is specific to the application that is using this CurrentAlarm. - 1.0
EventType string(:64) R Indicates the type of event. - 1.0
ProbableCause string(:64) R Qualifies the alarm and provides further information than EventType. - 1.0
SpecificProblem string(:128) R Provides further qualification on the alarm beyond EventType and ProbableCause. This is vendor defined and will be an empty string if the device doesn’t support inclusion of this information. - 1.0
PerceivedSeverity string R

Indicates the relative level of urgency for operator attention, see [ITU-X.733]. Enumeration of:

  • Critical
  • Major
  • Minor
  • Warning
  • Indeterminate
- 1.0
AdditionalText string(:256) R This provides a textual string which is vendor defined. This will be an empty string if the device doesn’t support inclusion of this information. - 1.0
AdditionalInformation string(:256) R This contains additional information about the alarm and is vendor defined. - 1.0
InternetGatewayDevice.FaultMgmt.HistoryEvent.{i}. object(0:) R

Alarm events added or updated in FaultMgmt.CurrentAlarm.{i}. are simultaneously entered into the this table. This table also contains alarm clearing events. Active alarms at the time of a power failure or reboot might not get an alarm clearing event. This object has a fixed number of entries with instance numbers from 1 to FaultMgmt.HistoryEventNumberOfEntries. If maximum instance number FaultMgmt.HistoryEventNumberOfEntries is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic “rolling” of records.

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

- 1.0
EventTime dateTime R Indicates the date and time when the alarm event occurs. - 1.0
AlarmIdentifier string(:64) R Identifies one Alarm Entry in the Alarm List. This value MUST be uniquely allocated by the device to the alarm instance during the lifetime of the individual alarm. - 1.0
NotificationType string R

Indicates the reason for the specific alarm notification event. Enumeration of:

  • NewAlarm
  • ChangedAlarm
  • ClearedAlarm
- 1.0
ManagedObjectInstance string(:512) R Specifies the instance of the Informational Object Class in which the alarm occurred by carrying the Distinguished Name (DN) of this object instance. The format of the DN is specific to the application that is using this HistoryEvent. - 1.0
EventType string(:64) R Indicates the type of event. - 1.0
ProbableCause string(:64) R Qualifies the alarm and provides further information than EventType. - 1.0
SpecificProblem string(:128) R Provides further qualification on the alarm beyond EventType and ProbableCause. This is vendor defined and will be an empty string if the device doesn’t support inclusion of this information. - 1.0
PerceivedSeverity string R

Indicates the relative level of urgency for operator attention, see [ITU-X.733]. Enumeration of:

  • Cleared
  • Critical
  • Major
  • Minor
  • Warning
  • Indeterminate
- 1.0
AdditionalText string(:256) R This provides a textual string which is vendor defined. This will be an empty string if the device doesn’t support inclusion of this information. - 1.0
AdditionalInformation string(:256) R This contains additional information about the alarm and is vendor defined. - 1.0
InternetGatewayDevice.FaultMgmt.ExpeditedEvent.{i}. object(0:) R

Alarm events added or updated in FaultMgmt.CurrentAlarm.{i}. are simultaneously entered into the this table if their corresponding entry in FaultMgmt.SupportedAlarm.{i}. has FaultMgmt.SupportedAlarm.{i}.ReportingMechanism set to 0 Expedited. This table also contains alarm clearing events. This object has a fixed number of entries with instance numbers from 1 to FaultMgmt.ExpeditedEventNumberOfEntries. Initially the table starts with all instances having EventTime set to the Unknown Time value, as defined in [TR-106a4]. If maximum instance number FaultMgmt.ExpeditedEventNumberOfEntries is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic “rolling” of records. When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the ACS (even if their new values are identical to those of the prior alarm).

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

- 1.0
EventTime dateTime R Indicates the date and time when the alarm event occurs. For an unpopulated entry, the value is the Unknown Time as defined in [TR-106a4]. - 1.0
AlarmIdentifier string(:64) R Identifies one Alarm Entry in the Alarm List. This value MUST be uniquely allocated by the device to the alarm instance during the lifetime of the individual alarm. For an unpopulated entry, the value is an empty string. - 1.0
NotificationType string R

Indicates the reason for the specific alarm notification event. Enumeration of:

  • NewAlarm
  • ChangedAlarm
  • ClearedAlarm
- 1.0
ManagedObjectInstance string(:512) R Specifies the instance of the Informational Object Class in which the alarm occurred by carrying the Distinguished Name (DN) of this object instance. The format of the DN is specific to the application that is using this ExpeditedEvent. - 1.0
EventType string(:64) R Indicates the type of event. - 1.0
ProbableCause string(:64) R Qualifies the alarm and provides further information than EventType. - 1.0
SpecificProblem string(:128) R Provides further qualification on the alarm beyond EventType and ProbableCause. This is vendor defined and will be an empty string if the device doesn’t support inclusion of this information. - 1.0
PerceivedSeverity string R

Indicates the relative level of urgency for operator attention, see [ITU-X.733]. Enumeration of:

  • Cleared
  • Critical
  • Major
  • Minor
  • Warning
  • Indeterminate
- 1.0
AdditionalText string(:256) R This provides a textual string which is vendor defined. This will be an empty string if the device doesn’t support inclusion of this information. - 1.0
AdditionalInformation string(:256) R This contains additional information about the alarm and is vendor defined. - 1.0
InternetGatewayDevice.FaultMgmt.QueuedEvent.{i}. object(0:) R

Alarm events added or updated in FaultMgmt.CurrentAlarm.{i}. are simultaneously entered into the this table if their corresponding entry in FaultMgmt.SupportedAlarm.{i}. has FaultMgmt.SupportedAlarm.{i}.ReportingMechanism set to 1 Queued. This table also contains alarm clearing events. This object has a fixed number of entries with instance numbers from 1 to FaultMgmt.QueuedEventNumberOfEntries. Initially the table starts with all instances having EventTime set to the Unknown Time value, as defined in [TR-106a4]. If maximum instance number FaultMgmt.QueuedEventNumberOfEntries is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic “rolling” of records. When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the ACS (even if their new values are identical to those of the prior alarm).

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

- 1.0
EventTime dateTime R Indicates the date and time when the alarm event occurs. For an unpopulated entry, the value is the Unknown Time as defined in [TR-106a4]. - 1.0
AlarmIdentifier string(:64) R Identifies one Alarm Entry in the Alarm List. This value MUST be uniquely allocated by the device to the alarm instance during the lifetime of the individual alarm. For an unpopulated entry, the value is an empty string. - 1.0
NotificationType string R

Indicates the reason for the specific alarm notification event. Enumeration of:

  • NewAlarm
  • ChangedAlarm
  • ClearedAlarm
- 1.0
ManagedObjectInstance string(:512) R Specifies the instance of the Informational Object Class in which the alarm occurred by carrying the Distinguished Name (DN) of this object instance. The format of the DN is specific to the application that is using this QueuedEvent. - 1.0
EventType string(:64) R Indicates the type of event. - 1.0
ProbableCause string(:64) R Qualifies the alarm and provides further information than EventType. - 1.0
SpecificProblem string(:128) R Provides further qualification on the alarm beyond EventType and ProbableCause. This is vendor defined and will be an empty string if the device doesn’t support inclusion of this information. - 1.0
PerceivedSeverity string R

Indicates the relative level of urgency for operator attention, see [ITU-X.733]. Enumeration of:

  • Cleared
  • Critical
  • Major
  • Minor
  • Warning
  • Indeterminate
- 1.0
AdditionalText string(:256) R This provides a textual string which is vendor defined. This will be an empty string if the device doesn’t support inclusion of this information. - 1.0
AdditionalInformation string(:256) R This contains additional information about the alarm and is vendor defined. - 1.0
InternetGatewayDevice.FAP. object R This object is the container for all Femto related component objects, to prevent pollution of the so-called global namespace of the BBF with FAP specific objects. - 1.0
InternetGatewayDevice.FAP.GPS. object R This object contains the parameters relating to the GPS scan. - 1.0
ScanOnBoot boolean W

Enables or disables GPS scans during the device start up.

The factory default value MUST be true.

- 1.0
ScanPeriodically boolean W

Enables or disables periodic GPS scans.

The factory default value MUST be false.

- 1.0
PeriodicInterval unsignedInt W When ScanPeriodically is true, this value indicates the interval in seconds which GPS scan is performed. - 1.0
PeriodicTime dateTime W An absolute time reference in UTC to determine when the CPE will initiate the periodic GPS scan. Each GPS scan MUST occur at (or as soon as possible after) this reference time plus or minus an integer multiple of the PeriodicInterval. PeriodicTime is used only to set the “phase” of the GPS scan. The actual value of PeriodicTime can be arbitrarily far into the past or future. For example, if PeriodicInterval is 86400 (a day) and if PeriodicTime is set to UTC midnight on some day (in the past, present, or future) then periodic GPS scans will occur every day at UTC midnight. These MUST begin on the very next midnight, even if PeriodicTime refers to a day in the future. The Unknown Time value defined in [Section 3.2/TR-106a4] indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and needs only to adhere to the specified PeriodicInformInterval. If absolute time is not available to the CPE, its periodic GPS scan behavior MUST be the same as if PeriodicTime parameter was set to the Unknown Time value. - 1.0
ContinuousGPS boolean W Whether or not the device SHOULD maintain a continuous GPS lock (e.g. as a frequency stability source). - 1.0
ScanTimeout unsignedInt W Specifies the time-out value in seconds since the scan started after which the scan will time out. A timed out scan is to be reported as Error_TIMEOUT with ErrorDetails indicating “Timed out” - 1.0
ScanStatus string R

Indicates the current status of this scan. Enumeration of:

  • Indeterminate (The scan has not been executed and there are no valid scan results available)
  • InProgress
  • Success
  • Error
  • Error_TIMEOUT
- 1.0
ErrorDetails string(:256) R Provides more detail when the ScanStatus is either Error or Error_TIMEOUT. - 1.0
LastScanTime dateTime R The date and time when the last GPS scan completed. - 1.0
LastSuccessfulScanTime dateTime R Specifies the date and time, when the GPS scan last completed successfully. This value is retained across reboot and is only reset after another scan completes successfully or GPSReset is set to true. The values for LockedLatitude, LockedLongitude and NumberOfSatellites correspond to this time. If a scan has never succeeded before, the value will be the Unknown Time value, as defined in [Section 3.2/TR-106a4]. - 1.0
LockedLatitude int(-90000000:90000000) R This parameter specifies the latitude of the device’s position in degrees, multiplied by 1 million. The positive value signifies the direction, north of the equator. The negative value signifies the direction, south of the equator. Range is from: 90d00.00’ South (-90,000,000) to 90d00.00’ North (90,000,000). Example: A latitude of 13d19.43’ N would be represented as 13,323,833, derived as (131,000,000)+((19.431,000,000)/60). Latitude of 50d00.00’ S would be represented as value -50,000,000. This value is retained across reboots and is only reset after another scan completes successfully or GPSReset is set to true. If a scan has never succeeded before, the value 0 is reported. - 1.0
LockedLongitude int(-180000000:180000000) R This parameter specifies the longitude of the device’s position in degrees, multiplied by 1 million. The positive value signifies the direction, east of the prime meridian. The negative value signifies the direction, west of the prime meridian. Range is from: 180d00.00’ West (-180,000,000) to 180d00.00’ East (180,000,000). Example: A longitude of 13d19.43’ E would be represented as 13,323,833, derived as (131,000,000)+((19.431,000,000)/60). A longitude of 50d00.00’ W would be represented as value -50,000,000. This value is retained across reboots and is only reset after another scan completes successfully or GPSReset is set to true. If a scan has never succeeded before, the value 0 is reported. - 1.0
NumberOfSatellites unsignedInt R The number of satellites that were locked during the test execution. The greater the number of satellites the better the precision of the results. This value is retained across reboots and is only reset after another scan completes successfully or GPSReset is set to true. If a scan has never succeeded before, the value 0 is reported. - 1.0
GPSReset boolean W Setting this to true will cause a reset on the GPS Hardware. Setting this to false has no effect. - 1.0
InternetGatewayDevice.FAP.GPS.ContinuousGPSStatus. object R When ContinuousGPS is true, the parameters in this object contain the GPS status as it is continuously monitored. When ContinuousGPS is false, the parameters in this object are not being updated and their values are not accurate. - 1.0
CurrentFix boolean R The value is true if the location fix is currently valid (i.e. GPS receiver is currently tracking satellite signals), otherwise it is false. After a reboot the value is false until the GPS receivers has a valid current position. - 1.0
GotFix boolean R The value is true if CurrentFix has transitioned to true at least once since ContinuousGPS was enabled, otherwise it is false. After a reboot the value is false until CurrentFix has transitioned to true again. The GPS coordinates (Latitude, Longitude, and Elevation) are not valid until GotFix has a value of true. - 1.0
TimingGood boolean R The value is true if the timing synchronization is good, otherwise it is false. After a reboot the value is false until the timing is synchronized again. - 1.0
Latitude int(-90000000:90000000) R This parameter represents the most recent latitude reading for the device’s position in degrees, multiplied by 1 million. The positive value signifies the direction, north of the equator. The negative value signifies the direction, south of the equator. Range is from: 90 deg 00.00’ South (-90,000,000) to 90 deg 00.00’ North (90,000,000). Example: A latitude of 13 deg 19.43’ N would be represented as 13,323,833, derived as (131,000,000)+((19.431,000,000)/60). Latitude of 50 deg 00.00’ S would be represented as value -50,000,000. Latitude is not valid until GotFix is true. If the parameter has never been set before, the value 0 is reported. The value SHOULD be maintained over a reboot. - 1.0
Longitude int(-180000000:180000000) R This parameter represents the most recent longitude reading for the device’s position in degrees, multiplied by 1 million. The positive value signifies the direction, east of the prime meridian. The negative value signifies the direction, west of the prime meridian. Range is from: 180d00.00’ West (-180,000,000) to 180d00.00’ East (180,000,000). Example: A longitude of 13d19.43’ E would be represented as 13,323,833, derived as (131,000,000)+((19.431,000,000)/60). A longitude of 50d00.00’ W would be represented as value -50,000,000. Longitude is not valid until GotFix is true. If the parameter has never been set before, the value 0 is reported. The value SHOULD be maintained over a reboot. - 1.0
Elevation int(-5000000:25000000) R This parameter represents the most recent elevation reading for the device’s position in millimeters, relative to the WGS84 ellipsoid. The positive value signifies the direction, above sea level. The negative value signifies the direction, below sea level. Range is from: 5,000.000 meters below sea level (-5,000,000) to 25,000.000 meters above sea level (25,000,000). Elevation is not valid until GotFix is true. If the parameter has never been set before, the value 0 is reported. The value SHOULD be maintained over a reboot. - 1.0
LastFixTime dateTime R Represents the date and time when the last GPS Fix was acquired. The Unknown Time value defined in [Section 3.2/TR-106a4] is used when GotFix is false. This applies too after a reboot of the device until a valid location is determined and GotFix transsitions to true. - 1.0
LastFixDuration unsignedInt R Number of seconds of continuous GPS fix time. After a reboot this value is reset to 0. - 1.0
FirstFixTimeout int(-1:) W Number of seconds to wait for first GPS fix before declaring a GPS fault. A value of -1 means that there is no timeout and no fault logging. - 1.0
SatellitesTracked unsignedInt R The number of satellites the receiver is tracking. - 1.0
SatelliteTrackingInterval unsignedInt(60:3600) W The interval in seconds at which the GPS tracking information gets reported. - 1.0
ReceiverStatus string(:256) R The output of the GPS receiver’s status. - 1.0
LocationType string R

Indicates whether the Latitude, Longitude, and Elevation values are determined via a GPS Fix (where the value of this parameter would be Real) or via some other means (where the value of this parameter would be Reference). Enumeration of:

  • Real
  • Reference
- 1.0
LockTimeOutDuration unsignedInt(120:86400) W The timer duration, in seconds, for which the device waits for GPS to acquire lock. - 1.0
InternetGatewayDevice.FAP.GPS.AGPSServerConfig. object R This object contains parameters for the configuration of the Assisted Global Positioning System (A-GPS) server. See also [Section 3.2/3GPP-TS.25.171] - 1.0
Enable boolean W Enables or disables the AGPSServerConfig entry. - 1.0
ServerURL string(:256) W A-GPS server host name or IP address. - 1.0
ServerPort unsignedInt(:65535) W The port to use when communicating to the A-GPS Server. - 1.0
Username string(:64) W Username to be used by the device to authenticate with the A-GPS server. This string is set to an empty string if no authentication is used. - 1.0
Password string(:64) W

Password to be used by the device to authenticate with the A-GPS server. This string is set to an empty string if no authentication is used.

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

- 1.0
ReferenceLatitude int(-90000000:90000000) W This parameter specifies the reference latitude for an A-GPS request position in degrees, multiplied by 1 million. The positive value signifies the direction, north of the equator. The negative value signifies the direction, south of the equator. Range is from: 90d00.00’ South (-90,000,000) to 90d00.00’ North (90,000,000). Example: A latitude of 13d19.43’ N would be represented as 13,323,833, derived as (131,000,000)+((19.431,000,000)/60). Latitude of 50d00.00’ S would be represented as value -50,000,000. - 1.0
ReferenceLongitude int(-180000000:180000000) W This parameter specifies the reference longitude for an A-GPS request position in degrees, multiplied by 1 million. The positive value signifies the direction, east of the prime meridian. The negative value signifies the direction, west of the prime meridian. Range is from: 180d00.00’ West (-180,000,000) to 180d00.00’ East (180,000,000). Example: A longitude of 13d19.43’ E would be represented as 13,323,833, derived as (131,000,000)+((19.431,000,000)/60). A longitude of 50d00’00* W would be represented as value -50,000,000. - 1.0
ServerInUse boolean R The value is true if the device has successfully contacted and received A-GPS info from the A-GPS server, otherwise the value is false. After a reboot the value is false until the server could be contacted again. - 1.0
InternetGatewayDevice.FAP.Tunnel. object R This object contains parameters relating to Tunneling. - 1.0
CryptoProfileNumberOfEntries unsignedInt R The number of entries in the CryptoProfile table. - 1.0
IKESANumberOfEntries unsignedInt R The number of entries in the IKESA table. - 1.0
ChildSANumberOfEntries unsignedInt R The number of entries in the ChildSA table. - 1.0
MaxVirtualInterfaces unsignedInt R The maximum number of virtual interfaces. - 1.0
VirtualInterfaceNumberOfEntries unsignedInt R The number of entries in the VirtualInterface table. - 1.0
UseForCWMP boolean W If the SecGW parameters are configured then this parameter determines whether the CWMP traffic will be sent across the IPsec tunnel(s) or outside of the IPsec tunnel(s). If false then the CWMP traffic will be sent outside of the IPsec tunnel(s). If true then the CWMP traffic will be sent across the IPsec tunnel(s). - 1.0
MaxChildSAPerIKE unsignedInt R Indicates the maximum number of child SAs per IKE session that the device is capable of supporting. - 1.0
MaxIKESessions unsignedInt R Indicates the maximum number of IKE sessions the device is capable of supporting at any given time. - 1.0
InternetGatewayDevice.FAP.Tunnel.CryptoProfile.{i}. object(0:) W

This object contains parameters relating to IKEv2 and IPsec crypto profiles, which are essentially a subset of the typical IPsec SPD. [RFC4301]. For Cdma2000 devices, see also [3GPP2-S.S0132].

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

- 1.0
Enable boolean W Enables and disables this entry. false 1.0
Alias string(:64) W

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

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

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

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

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

- 1.0
AuthMethod string(:256) W Specifies the Security mechanism and set of credentials used by the device to authenticate itself (either an instance of the .Security.Certificate. object defined in [TR-157a5] or an instance of the .Services.FAPService.{i}.Transport.Security.Secret. object defined in [TR-196i2]). The value MUST be the Path Name of a table row. If the value is an an empty string, the device chooses the authentication method based on local policy. In order to configure the device for both device and hosting-party authentication, the object is populated with an enabled instance of the .Security.Certificate.. object. 1.0
MaxChildSA unsignedInt(2,4,6,8,10) W Controls the maximum number of child SAs that can be negotiated by a single IKE session. 2 1.0
IKEEncrypt string[] W

Comma-separated list of strings. IKEv2 encryption algorithm. [RFC4307] For CDMA2000 devices, see also [3GPP2-S.S0132]. Each list item is an enumeration of:

  • 3DES-CBC
  • AES-CBC
AES-CBC 1.0
IKEPRF string[] W

Comma-separated list of strings. IKEv2 pseudo-random function. [RFC4307] For CDMA2000 devices, see also [3GPP2-S.S0132]. Each list item is an enumeration of:

  • HMAC-SHA1
  • AES-XCBC-PRF-128
HMAC-SHA1 1.0
IKEIntegrity string[] W

Comma-separated list of strings. IKEv2 integrity function. [RFC4307] For CDMA2000 devices, see also [3GPP2-S.S0132]. Each list item is an enumeration of:

  • HMAC-SHA1-96
  • AES-XCBC-MAC-96
HMAC-SHA1-96 1.0
IKEDH string[] W

Comma-separated list of strings. IKEv2 pseudo-random function. [RFC4307] For CDMA2000 devices, see also [3GPP2-S.S0132]. Each list item is an enumeration of:

  • 1024
  • 2048
2048 1.0
ESPEncrypt string[] W

Comma-separated list of strings. IPsec encryption algorithm. [Section 3.1.1/RFC4835] For CDMA2000 devices, see also [3GPP2-S.S0132]. Each list item is an enumeration of:

  • 3DES-CBC
  • AES-CBC
  • Null
AES-CBC 1.0
ESPIntegrity string[] W

Comma-separated list of strings. IPsec integrity function. [Section 3.1.1/RFC4835] For CDMA2000 devices, see also [3GPP2-S.S0132]. Each list item is an enumeration of:

  • HMAC-SHA1-96
  • AES-XCBC-MAC-96
HMAC-SHA1-96 1.0
IPsecWindowSize unsignedInt W The size of the Anti-Replay Window. If 0 Sequence Number Verification is disabled. For UMTS devices, see [3GPP-TS.32.582] and [3GPP-TS.32.584]. For LTE devices, see [3GPP-TS.32.592]. For CDMA2000 devices, see [3GPP2-S.S0132]. 0 1.0
IKERekeyLifetime unsignedInt W IKEv2 SA rekey timeout in seconds. For UMTS devices, see [3GPP-TS.32.582] and [3GPP-TS.32.584]. For LTE devices, see [3GPP-TS.32.592]. For CDMA2000 devices, see [3GPP2-S.S0132]. - 1.0
IPsecRekeyLifetimeByte unsignedInt W IPsec SA rekey timeout in Kilobytes. For UMTS devices, see [3GPP-TS.32.582] and [3GPP-TS.32.584]. For LTE devices, see [3GPP-TS.32.592]. For CDMA2000 devices, see [3GPP2-S.S0132]. - 1.0
IPsecRekeyLifetimeTime unsignedInt W IPsec SA rekey timeout in seconds. For UMTS devices, see [3GPP-TS.32.582] and [3GPP-TS.32.584]. For LTE devices, see [3GPP-TS.32.592]. For CDMA2000 devices, see [3GPP2-S.S0132]. - 1.0
DPDTimer unsignedInt W DPD timeout in seconds. For UMTS devices, see [3GPP-TS.32.582] and [3GPP-TS.32.584]. For LTE devices, see [3GPP-TS.32.592]. For CDMA2000 devices, see [3GPP2-S.S0132]. 300 1.0
NATTKeepaliveTimer unsignedInt W NAT-T keepalive timeout in seconds. For UMTS devices, see [3GPP-TS.32.582] and [3GPP-TS.32.584]. For LTE devices, see [3GPP-TS.32.592]. For CDMA2000 devices, see [3GPP2-S.S0132]. 180 1.0
SecMaxFragSize unsignedInt(256:1400) W Maximum fragment size, in bytes, from device before Encryption. For CDMA2000 devices, see also [3GPP2-S.S0132]. 1200 1.0
SecDFBit string W

Indicates if the ‘Do Not Fragment’ bit needs to be turned on/off. For CDMA2000 devices, see also [3GPP2-S.S0132]. Enumeration of:

  • On
  • Off
Off 1.0
InternetGatewayDevice.FAP.Tunnel.IKESA.{i}. object(0:) R

IKE IPsec Security Association Table. This Table is a member of the IPsec Security Association Database (SAD). [RFC4301].

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

- 1.0
Status string R

The status of this IKE SA entry. Enumeration of:

  • Disabled
  • Active
  • Completed
  • Progressing
  • Error (This value MAY be used by the CPE to indicate a locally defined error condition, OPTIONAL)
- 1.0
PeerAddress string(:45) R [IPAddress] The IP address of the peer SecGW. - 1.0
CreationTime dateTime R The time that the current IKE SA was set up. - 1.0
IPAddress string(:45) R [IPAddress] The current IP address assigned to this interface by IKEv2. - 1.0
SubnetMask string R The current subnet mask assigned to this interface by IKEv2. - 1.0
DNSServers string(:45)[](:256) R [IPAddress] Comma-separated list (maximum number of characters 256) of IP Addresses. Each item is an IP Address of a DNS server for this interface assigned to this interface by IKEv2. - 1.0
DHCPServers string(:45)[](:256) R [IPAddress] Comma-separated list (maximum number of characters 256) of IP Addresses. Each item is an IP address of a DHCP server for this interface. A non empty list instructs the CPE to send any internal DHCP request to the address contained within this parameter. - 1.0
IntegrityErrors unsignedInt R The number of inbound packets discarded by the IKE SA due to Integrity checking errors. - 1.0
OtherErrors unsignedInt R The number of inbound packets discarded by the IKE SA due to other errors, such as anti-replay errors. - 1.0
AuthErrors unsignedInt R The number of inbound packets discarded by the IKE SA due to authentication errors. - 1.0
InternetGatewayDevice.FAP.Tunnel.ChildSA.{i}. object(0:) R

Child IPsec Security Association Table. This Table is a member of the IPsec Security Association Database (SAD). [RFC4301].

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

- 1.0
ParentID string(:256) R The value MUST be the Path Name of a row in the IKESA. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 1.0
SPI unsignedInt R SPI value of the Child SA. - 1.0
DirectionOutbound boolean R Traffic Direction. If true this Child SA refers to outbound traffic. If false this Child SA refers to inbound traffic. - 1.0
CreationTime dateTime R The time that the current Child SA was set up. - 1.0
Traffic unsignedInt R The measured traffic in bytes transferred by the Child SA. - 1.0
IntegrityErrors unsignedInt R The number of inbound packets discarded by the Child SA due to integrity checking errors. - 1.0
ReplayErrors unsignedInt R The number of inbound packets discarded by the Child SA due to anti-replay errors. - 1.0
InternetGatewayDevice.FAP.Tunnel.VirtualInterface.{i}. object(0:) W

Virtual Interfaces used for associating the tunnel (ephemeral) childSA pairs with QoS Classification and Queue tables as defined in [TR-098a2] (InternetGatewayDevice.QueueManagement.Classification.{i}. and InternetGatewayDevice.QueueManagement.Queue.{i}.) or [TR-181i2] (Device.QoS.Classification.{i}. and Device.QoS.Queue.{i}.).

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

- 1.0
Enable boolean W Enables and disables this entry. false 1.0
Alias string(:64) W

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

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

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

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

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

- 1.0
CryptoProfile string(:256) W The value MUST be the Path Name of a row in the CryptoProfile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. If multiple instances of VirtualInterface point to the same CryptoProfile instance, the associated CryptoProfile.{i}.MaxChildSA determines whether a new IKE session will be created (dynamically) to negotiate the child SA(s) for each of the virtual interfaces; otherwise, they are negotiated through the same IKE session. 1.0
DSCPMarkPolicy int(-2:) W DSCP to mark the outer IP header for traffic that is associated with this virtual interface. A value of -1 indicates copy from the incoming packet. A value of -2 indicates automatic marking of DSCP as defined for the UMTS QoS class [3GPP-TS.23.107] or CDMA2000 Subscriber QoS profile [3GPP2-X.S0011]. De-tunneled packets are never re-marked. -1 1.0
InternetGatewayDevice.FAP.PerfMgmt. object R This object contains parameters relating to Performance Management in a Femto-related environment. - 1.0
ConfigNumberOfEntries unsignedInt R The number of entries in the Config table. - 1.0
InternetGatewayDevice.FAP.PerfMgmt.Config.{i}. object(0:) W

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

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

- 1.0
Enable boolean W Enables or disables this entry. If this entry is disabled then its periodic uploads are not performed. - 1.0
Alias string(:64) W

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

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

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

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

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

- 1.0
URL string(:256) W URL specifying the destination file location. HTTP and HTTPS transports MUST be supported. Other transports MAY be supported. This argument specifies only the destination file location, and does not indicate in any way the name or location of the local file to be uploaded. - 1.0
Username string(:256) W Username to be used by the device to authenticate with the file server. This string is set to an empty string if no authentication is used. - 1.0
Password string(:256) W

Password to be used by the device to authenticate with the file server. This string is set to an empty string if no authentication is used.

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

- 1.0
PeriodicUploadInterval unsignedInt(1:) W The duration in seconds of the interval for which the device MUST create a Performance File and attempt to upload the file to URL if Enable is true. - 1.0
PeriodicUploadTime dateTime W An absolute time reference in UTC to determine when the device will initiate the periodic file upload. Each file upload MUST occur at this reference time plus or minus an integer multiple of the PeriodicUploadInterval. PeriodicUploadTime is used only to set the “phase” of the periodic uploads. The actual value of PeriodicUploadTime can be arbitrarily far into the past or future. For example, if PeriodicUploadInterval is 86400 (a day) and if PeriodicUploadTime is set to UTC midnight on some day (in the past, present, or future) then periodic file uploads will occur every day at UTC midnight. These MUST begin on the very next midnight, even if PeriodicUploadTime refers to a day in the future. The Unknown Time value as defined in [Section 3.2/TR-106a4] indicates that no particular time reference is specified. That is, the device MAY locally choose the time reference, and is REQUIRED only to adhere to the specified PeriodicUploadInterval. If absolute time is not available to the device, its periodic file upload behavior MUST be the same as if the PeriodicUploadTime parameter was set to the Unknown Time value. - 1.0
InternetGatewayDevice.FAP.ApplicationPlatform. object R This object defines the data model for the following Femtozone APIs.
  • Femto Awareness
  • SMS
  • MMS
  • Terminal Location Femto Awareness, SMS, MMS, and Terminal Location APIs are defined in the Release 1 API Specifications of the Service SIG in the Femto Forum (non public document). [Appendix I/TR-262] provides the “Theory of Operation” for the usage of this object.
- 1.0
Version string(:64) R Version of Femto Application Platform running on this device - 1.0
Enable boolean W Enable or disable the Femto ApplicationPlatform - 1.0
Status string R

Current state of the Femto Application Platform. Enumeration of:

  • Disabled (The Femto Application Platform is not available)
  • Enabled (The Femto Application Platform is available)
  • Reset (The FemtoApplicationPlatform is in the process of being reset and will transition to the Disabled state when the reset operation is completed)
  • Initializing (The FemtoApplicationPlatform is being initialized and will transition to the Enabled state once the initialization is completed)
- 1.0
MaxNumberOfApplications unsignedInt R Determines how many Femtozone Applications can be supported by the Femto Application Platform simultaneously. - 1.0
CurrentNumberofApplications unsignedInt R Specifies how many Femtozone Applications are currently communicating with the Femto Application Platform. - 1.0
InternetGatewayDevice.FAP.ApplicationPlatform.Capabilities. object R This object contains parameters related to the capabilities of the Femtozone Application Platform and the Femtozone APIs. - 1.0
PresenceApplicationSupport boolean R Specifies whether the Femto Application Platform supports Presence-Based Femtozone Applications - 1.0
FemtoAwarenessAPISupport boolean R Specifies whether the Femto Awareness API is supported on this device. - 1.0
SMSAPISupport boolean R Specifies whether the SMS API is supported on this device. - 1.0
SubscribeToNotificationsOfSMSSentToApplicationSupport boolean R Specifies whether the SubscribeToNotificationsOfSMSSentToApplication functionality is supported by the FAP SMS API. - 1.0
QuerySMSDeliveryStatusSupport boolean R Specifies whether the QuerySMSDeliveryStatus functionality is supported by the FAP SMS API. - 1.0
MMSAPISupport boolean R Specifies whether the MMS API is supported on this device. - 1.0
QueryMMSDeliveryStatusSupport boolean R Specifies whether the QueryMMSDeliveryStatus functionality is supported by the FAP MMS API. - 1.0
SubscribeToNotificationsOfMMSSentToApplicationSupport boolean R Specifies whether the SubscribeToNotificationsOfMMSSentToApplication functionality is supported by the FAP MMS API. - 1.0
TerminalLocationAPISupport boolean R Specifies whether the Terminal Location API is supported on this device. - 1.0
AuthenticationMethodsSupported string[] R

Comma-separated list of strings. Specifies the supported methods that 3rd Party Applications can use to authenticate with the Femto Application Platform at initialization. Comma separated list of strings. Each list item is an enumeration of:

  • Basic
  • Digest
  • DigitalSignature
- 1.0
AccessLevelsSupported string[] R

Comma-separated list of strings. Specifies the supported access levels that 3rd Party Applications can request when authenticating with the Femto Application Platform at initialization. This access level is with respect to resources within the Femto Application Platform only (not to be confused with Access Mode parameter in .FAPService.{i}.AccessMgmt). Each list item is an enumeration of:

  • Guest
  • Standard
  • Restricted
  • Administrator
  • Debug
- 1.0
SendSMSTargetAddressType string[] R

Comma-separated list of strings. Specifies the supported types of addresses SMSs can be sent to. Each list item is an enumeration of:

  • TelUri
  • AnonymousReference
  • All
- 1.0
SendMMSTargetAddressType string[] R

Comma-separated list of strings. Specifies the supported types of addresses MMSs can be sent to. Each list item is an enumeration of:

  • TelUri
  • AnonymousReference
  • All
- 1.0
InternetGatewayDevice.FAP.ApplicationPlatform.Control. object R This object contains parameters related to the operation of the Femtozone APIs. - 1.0
AuthenticationMethod string(:256) W Specifies how 3rd Party Applications have to authenticate against Femto APIs in order to use it. The value MUST be a member of the list reported by the Capabilities.AuthenticationMethodsSupported parameter. Note: The credentials are not part of the data model and have to be supplied externally. - 1.0
TunnelInst string(:256) W This is the reference to the IPsec tunnel instance to be used by the Application Platform traffic. If InternetGatewayDevice:1 [TR-098] or Device:1 [TR-181i1]) is used as root data model the TunnelInst MUST point to a row in the .FAP.Tunnel.IKESA.{i}. table. If the root data model used is Device:2 [TR-181i2] than the TunnelInst MUST point to an tunnel instance defined in this data model. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 1.0
InternetGatewayDevice.FAP.ApplicationPlatform.Control.FemtoAwareness. object R This object contains parameters related to the Femto Awareness API. - 1.0
APIEnable boolean W Enable or disable FemtoAwareness API exposure on FAP - 1.0
QueueEnable boolean W Enable or disable Request queueing for the API - 1.0
Queueing string W

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

  • FiFo
  • Priority
- 1.0
MaxAPIUsersNumber unsignedInt(0:255) W Determines the Max Number of different Applications that can send Requests to Femto Awareness API. - 1.0
FemtozoneID string(:256) W Specifies Identifier of the Femtozone. - 1.0
NotificationsUserIdentifierMSISDN boolean W Specifies whether the Mobile Station International Subscriber Directory Number (MSISDN) has to be used as UserIdentifier in Femto Awareness Notifications. A value of true means that the MSISDN is send as user identifier, a value of false means that an anonymous reference is used. - 1.0
SubscribeToNotificationsResponseCallbackData boolean W Specifies whether the OPTIONAL Argument “Callback Data” has to be used in Responses to Requests to “Subscribe To Femto Awareness Notifications”. - 1.0
QueryFemtocellResponseTimezone boolean W Specifies whether the OPTIONAL Argument “Timezone” has to be used in Responses to Requests to “Query Femtocell Status”. - 1.0
InternetGatewayDevice.FAP.ApplicationPlatform.Control.SMS. object R This object contains parameters related to the SMS API. - 1.0
APIEnable boolean W Enable or disable SMS API exposure on FAP - 1.0
QueueEnable boolean W Enable or disable Request queueing for the API - 1.0
Queueing string W

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

  • FiFo
  • Priority
- 1.0
MaxAPIUsersNumber unsignedInt(0:255) W Determines the Max Number of different Applications that can send Requests to SMS API. - 1.0
MinSendSMSTimeInterval unsignedInt(0:3599) W Determines the Minimum Time Interval in seconds between two consecutive Send SMS Requests by the same Application. - 1.0
EnableQuerySMSDeliveryStatus boolean W Enable or disable “QuerySMSDeliveryStatus” Operation on SMS API. When disabled, QuerySMSDeliveryStatus Requests to SMS API are ignored. - 1.0
EnableSubscribeToNotificationsOfMessageSentToApplication boolean W Enable or disable “SubscribeToNotificationsOfMessageSentToApplication” Operation on SMS API. When disabled, SubscribeTo NotificationsOfMessageSentToApplication Requests to SMS API are ignored. - 1.0
InternetGatewayDevice.FAP.ApplicationPlatform.Control.MMS. object R This object contains parameters related to the MMS API. - 1.0
APIEnable boolean W Enable or disable MMS API exposure on FAP - 1.0
QueueEnable boolean W Enable or disable Request queueing for the API - 1.0
Queueing string W

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

  • FiFo
  • Priority
- 1.0
MaxAPIUsersNumber unsignedInt(0:255) W Determines the Max Number of different Applications that can send Requests to MMS API. - 1.0
MinSendMMSTimeInterval unsignedInt(0:3599) W Determines the Minimum Time Interval in seconds between two consecutive Send MMS Requests by the same Application. - 1.0
EnableQueryMMSDeliveryStatus boolean W Enable or disable “QuerySMSDeliveryStatus” Operation on MMS API. When disabled, QuerySMSDeliveryStatus Requests to MMS API are ignored. - 1.0
EnableSubscribeToNotificationsOfMessageSentToApplication boolean W Enable or disable “SubscribeTo NotificationsOfMessageSentToApplication” Operation on MMS API. When disabled, SubscribeTo NotificationsOfMessageSentToApplication Requests to MMS API are ignored. - 1.0
InternetGatewayDevice.FAP.ApplicationPlatform.Control.TerminalLocation. object R This object contains parameters related to the TerminalLocation API. - 1.0
APIEnable boolean W Enable or disable TerminalLocation API exposure on FAP - 1.0
QueueEnable boolean W Enable or disable Request queueing for the API - 1.0
Queueing string W

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

  • FiFo
  • Priority
- 1.0
MaxAPIUsersNumber unsignedInt(0:255) W Determines the Max Number of different Applications that can send Requests to TerminalLocation API. - 1.0
QueryMobileLocationResponseAddress string W

Specifies Terminal Address Format to be used in QueryMobileLocation Responses. Enumeration of:

  • TelUri
  • AnonymousReference
- 1.0
QueryMobileLocationResponseLongitudeLatitude boolean W Include or exclude FAP Longitude and Latitude arguments in Responses to QueryMobileLocation Requests. - 1.0
QueryMobileLocationResponseAltitude boolean W Include or exclude FAP Altitude argument in Responses to QueryMobileLocation Requests . - 1.0
QueryMobileLocationResponseTimestamp unsignedInt(0:86399) W Specifies Response Timestamp in seconds. - 1.0
InternetGatewayDevice.FAP.ApplicationPlatform.Monitoring. object R This object contains parameters related to the monitoring of the Femtozone Application Platform and the Femtozone APIs. - 1.0
Enable boolean W Enables and disables this entry. - 1.0
MonitoringInterval unsignedInt W Specifies the interval in seconds used to collect the monitoring measurements. - 1.0
AuthenticationRequestsReceived unsignedInt R Specifies the total number of authentication requests received by the Femto Application Platform. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 1.0
AuthenticationRequestsRejected unsignedInt R Specifies the number of authentication requests received by the Femto Application Platform that were rejected. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 1.0
InternetGatewayDevice.FAP.ApplicationPlatform.Monitoring.FemtoAwareness. object R This object contains parameters related to the Monitoring of the FemtoAwareness API. - 1.0
APIAvailable boolean R Specifies whether the FemtoAwareness API is currently available on this device (the API could be disabled or could have exhausted its resources) - 1.0
APIUsers unsignedInt(0:255) R Specifies the current number of Applications using the Femto Awareness API. - 1.0
QueueState string R

Specifies the state of the Femto Awareness API Queue. Enumeration of:

  • Disabled
  • Ready
  • Flushed
- 1.0
QueueNum unsignedInt(0:255) R Specifies the current number of requests waiting in the Femto Awareness API Queue. - 1.0
QueueReceived unsignedInt R Specifies the number of requests in the Femto Awareness API Queue that have been received. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 1.0
QueueDiscarded unsignedInt R Specifies the number of requests in the Femto Awareness API Queue that have been discarded. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 1.0
InternetGatewayDevice.FAP.ApplicationPlatform.Monitoring.SMS. object R This object contains parameters related to the Monitoring of the SMS API. - 1.0
APIAvailable boolean R Specifies whether the SMS API is currently available on this device (the API could be disabled or could have exhausted its resources).. - 1.0
APIUsers unsignedInt(0:255) R Specifies the current number of Applications using the SMS API. - 1.0
QueueState string R

Specifies the state of the SMS API Queue. Enumeration of:

  • Disabled
  • Ready
  • Flushed
- 1.0
QueueNum unsignedInt(0:255) R Specifies the current number of requests waiting in the SMS API Queue. - 1.0
QueueReceived unsignedInt R Specifies the number of requests in the SMS API Queue that have been received. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 1.0
QueueDiscarded unsignedInt R Specifies the number of requests in the SMS API Queue that have been discarded. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 1.0
InternetGatewayDevice.FAP.ApplicationPlatform.Monitoring.MMS. object R This object contains parameters related to the Monitoring of the MMS API. - 1.0
APIAvailable boolean R Specifies whether the MMS API is currently available on this device (the API could be disabled or could have exhausted its resources).. - 1.0
APIUsers unsignedInt(0:255) R Specifies the current number of Applications using the MMS API. - 1.0
QueueState string R

Specifies the state of the MMS API Queue. Enumeration of:

  • Disabled
  • Ready
  • Flushed
- 1.0
QueueNum unsignedInt(0:255) R Specifies the current number of requests waiting in the MMS API Queue. - 1.0
QueueReceived unsignedInt R Specifies the number of requests in the MMS API Queue that have been received. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 1.0
QueueDiscarded unsignedInt R Specifies the number of requests in the MMS API Queue that have been discarded. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 1.0
InternetGatewayDevice.FAP.ApplicationPlatform.Monitoring.TerminalLocation. object R This object contains parameters related to the Monitoring of the TerminalLocation API. - 1.0
APIAvailable boolean R Specifies whether the TerminalLocation API is currently available on this device (the API could be disabled or could have exhausted its resources).. - 1.0
APIUsers unsignedInt(0:255) R Specifies the current number of Applications using the Terminal Location API. - 1.0
QueueState string R

Specifies the state of the Terminal Location API Queue. Enumeration of:

  • Disabled
  • Ready
  • Flushed
- 1.0
QueueNum unsignedInt(0:255) R Specifies the current number of requests waiting in the Terminal Location API Queue. - 1.0
QueueReceived unsignedInt R Specifies the number of requests in the Terminal Location API Queue that have been received. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 1.0
QueueDiscarded unsignedInt R Specifies the number of requests in the Terminal Location API Queue that have been discarded. The counter will be reset whenever the device reboots or the Enable parameter is set to true. - 1.0
InternetGatewayDevice.BulkData. object R Bulk Data collection utilizes the IPDR solution to collect data from devices based on a service specification described in [TR-232]. Bulk Data Collection Profiles are measured over a reporting interval (which can be aligned with absolute time) and are made available to the collection server. This object provides bulk data collection capabilities and global collection settings that affect the entire device. - 1.0
Enable boolean W Enables or disables all collection profiles. If false, bulk data will not be collected or reported. - 1.0
Status string R

Indicates the status of the Bulk Data Collection mechanism. Enumeration of:

  • Enabled (Bulk Data Collection is enabled and working as intended)
  • Disabled (Bulk Data Collection is disabled)
  • Error (Bulk Data Collection is enabled, but there is an error condition preventing the successful collection of bulk data, OPTIONAL)
- 1.0
MinReportingInterval unsignedInt R Minimum reporting interval in seconds that the CPE is capable of supporting. A value of 0 indicates no minimum reporting interval. - 1.0
Protocols string[] R

Comma-separated list of strings. Represents the IPDR Protocols that this device is capable of supporting. Each list item is an enumeration of:

  • Streaming (IPDR Streaming Protocol [IPDR-SP])
  • File (IPDR File Transfer Protocol [IPDR-FTP])
- 1.0
EncodingTypes string[] R

Comma-separated list of strings. Represents the IPDR Encoding Types that this device is capable of supporting. Each list item is an enumeration of:

- 1.0
MaxNumberOfProfiles int(-1:) R The maximum number of profiles that can exist at any given time. Specifically, the maximum number of Profile.{i}. instances that the ACS can create. If the value of this parameter is -1, then it means that the CPE doesn’t have a limit to the number of profiles that can exist. - 1.0
MaxNumberOfParameterReferences int(-1:) R The maximum number of parameters that can be referenced via the bulk data collection mechanism. Specifically, the maximum number of parameters that can be referenced via Profile.{i}.Parameter.{i}.Reference across all Profile and Parameter instances (including the expansion of partial paths within the Reference parameter). If the value of this parameter is -1, then it means that the CPE doesn’t have a limit to the number of parameter that can be referenced via the bulk data collection mechanism. - 1.0
ProfileNumberOfEntries unsignedInt R The number of entries in the Profile table. - 1.0
InternetGatewayDevice.BulkData.Profile.{i}. object(0:) W

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

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

- 1.0
Enable boolean W Enables or disables this specific bulk data profile. If false, this profile will not be collected or reported. false 1.0
Alias string(:64) W

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

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

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

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.

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

- 1.0
Protocol string W The value MUST be a member of the list reported by the Protocols parameter. The IPDR Protocol being used for this collection profile. - 1.0
EncodingType string W The value MUST be a member of the list reported by the EncodingTypes parameter. The IPDR Encoding Type being used for this collection profile. - 1.0
ReportingInterval unsignedInt(1:) W The reporting interval in seconds. Each report is generated based on this interval and TimeReference. The CPE MAY reject a request to set ReportingInterval to less than MinReportingInterval. Reporting intervals MUST begin every ReportingInterval seconds. If ReportingInterval is changed while collection is enabled, the first reporting interval begins immediately. For example, if ReportingInterval is 86400 (a day) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then the CPE will generate (and transmit, if the Protocol parameter is set to Streaming) its report at midnight every 24 hours. 86400 1.0
TimeReference dateTime W An absolute time reference in UTC to determine when will be transmitted. Each reporting interval MUST complete at this reference time plus or minus an integer multiple of ReportingInterval, unless unable to due to higher prioritized operations. TimeReference is used only to set the “phase” of the reporting intervals. The actual value of TimeReference can be arbitrarily far into the past or future. If TimeReference is changed while collection of bulk data is enabled, the first reporting interval begins immediately. The Unknown Time value as defined in [TR-106a2] indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and is required only to adhere to the specified reporting intervals. If absolute time is not available to the CPE, its reporting interval behavior MUST be the same as if the TimeReference parameter was set to the Unknown Time value. For example, if ReportingInterval is 86400 (a day) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then the CPE will generate (and transmit, if in a “ITPush” mode) its report at midnight every 24 hours. Note that, if TimeReference is set to a time other than the Unknown Time, the first reporting interval (which has to begin immediately) will almost certainly be shorter than ReportingInterval). This is why TimeReference is defined in terms of when reporting intervals complete rather than start. 0001-01-01T00:00:00Z 1.0
StreamingHost string(:256) W This is the host name or IP Address of the IPDR Collector to be used by the CPE to stream bulk data records if this collection profile is configured for the IPDR Streaming Protocol [IPDR-SP] (the Protocol parameter has a value of Streaming). - 1.0
StreamingPort unsignedInt(0:65535) W This is the port number of the IPDR Collector to be used by the CPE to stream bulk data records if this collection profile is configured for the IPDR Streaming Protocol [IPDR-SP] (the Protocol parameter has a value of Streaming). 4737 1.0
StreamingSessionID unsignedInt(48:57,65:90) W This is the unique identification of an IPDR Session to be used when this collection profile is configured for the IPDR Streaming Protocol [IPDR-SP] (the Protocol parameter has a value of Streaming). An ACS MUST NOT configure multiple IPDR Streaming Protocol collection profiles with the same StreamingSessionID. Doing so MUST cause the CPE to fail the SetParameterValues. Within the IPDR Streaming Protocol specification the Session ID has a type of a single ‘char’, but we are restricting the range even further (ASCII values of ‘0’ - ‘9’ and ‘A’ - ‘Z’. - 1.0
FileTransferURL string(:256) W This is the URL within the CPE that is used by an IPDR Collector to retrieve the IPDRDocs when this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File). - 1.0
FileTransferUsername string(:64) W Username used for authentication of the FileTransferURL. This is the FileTransferUsername that the IPDR Collector uses to access the CPE when this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File). - 1.0
FileTransferPassword string(:64) W

Password used for authentication of the FileTransferURL. This is the FileTransferPassword that the IPDR Collector uses to access the CPE when this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File).

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

- 1.0
ControlFileFormat string(:128) W If this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File) then the control file names will be of the following format:
  • <ControlFilePrefix>_<ControlFilePolicy>.<ControlFileSuffix> Where the following rules apply:
  • ControlFilePrefix MUST NOT contain an underscore ‘_’ or any other character not suitable for a file name.
  • ControlFilePolicy MUST contain one or more ‘N’ characters, where the number of ‘N’ characters denotes the number of digits in the sequence number, including leading zeros as necessary to match the number of ‘N’ characters.
  • ControlFileSuffix is a file extension. For example, BulkData_NNNN.log where “BulkData” would be the prefix, “NNNN” would be the policy, and “log” would be the suffix. Files adhering to this file format would look like: BulkData_0000.log, BulkData_0001.log, etc.
- 1.0
ParameterNumberOfEntries unsignedInt R The number of entries in the Parameter table. - 1.0
InternetGatewayDevice.BulkData.Profile.{i}.Parameter.{i}. object(0:) W Bulk data parameter table. Each entry in this table represents a parameter (or set of parameters if a partial path is provided) to be collected and reported. - 1.0
Reference string(:256) W The value MUST be the Path Name of a parameter or object. Represents the parameter(s) that are part of this Bulk Data collection profile. In the case where a partial parameter path is specified all sub-objects and contained parameters will be part of the bulk data collected and reported. If the path name refers to an object then it MUST end with a ‘.’. 1.0
InternetGatewayDevice.DNS. object R Properties for Domain Name Service (DNS). It contains the Service Discovery (DNS-SD) objects. - 1.0
InternetGatewayDevice.DNS.SD. object R This object contains the DNS Service Discovery [DNS-SD] object and parameters necessary to discover services and their associated devices. Upon reboot the the contents of the service table are repopulated. When the DNS.SD service is disabled, the contents of the service table is implementation specific. - 1.0
Enable boolean W The parameter, when true, enables the discovery of DNS-SD services hosted by other devices. - 1.0
ServiceNumberOfEntries unsignedInt R The number of entries in the Service table. - 1.0
InternetGatewayDevice.DNS.SD.Service.{i}. object(0:) R

The Service table contains discovered DNS-SD services. DNS.SD service information is provided in DNS RR SRV records [RFC2782]. The Service Instance Name [Section 4.1 Structured Instance Names/DNS-SD] further specifies information about the service name (RFC2782 Service field) and domain name (RFC2782 Name field) in the form: Service Instance Name = <InstanceName> . <Service> . <Domain> <Service> = _<ApplicationProtocol> . _<TransportProtocol> RFC2782 Service field will always be equal to <InstanceName>. <Service> RFC2782 Name field will always be equal to <Domain> For example, an SSH service might have: *InstanceName = “Secure Shell (SSH))” *ApplicationProtocol = “ssh” *TransportProtocol = “TCP” *Domain = “example.com” *Port = 22 *Target = “ssh.example.com.”

At most one entry in this table can exist with the same values for all of InstanceName, ApplicationProtocol, TransportProtocol and Domain.

- 1.0
InstanceName string(:63) R Human-readable instance name [Section 4.1.1 Instance Names/DNS-SD] (i.e. The “<InstanceName>” portion of the ‘“Service Instance Name’“). - 1.0
ApplicationProtocol string(:15) R The Application Protocol, without the leading underscore, associated with the service (e.g., daap) as defined by the DNS-SD service [Section 7 Application Protocol Names/DNS-SD]. - 1.0
TransportProtocol string R

The Transport Protocol associated with the service as defined by the DNS-SD service [Section 4.1.2 Service Names/DNS-SD]. Enumeration of:

  • TCP
  • UDP
- 1.0
Domain string(:256) R The value extracted from the Name field of the DNS SRV record [RFC2782] which represents the fully qualified domain name (FQDN) associated with the service as defined by the DNS-SD service [Section 4.1.3 Domain Names/DNS-SD]. - 1.0
Port unsignedInt(:65535) R The value extracted from the Port field of the DNS SRV record [RFC2782] that is used to contact the service. - 1.0
Target string(:256) R The fully qualified domain name (FQDN) with the trailing dot “.” of the target host implementing the service as in the DNS SRV record [RFC2782]. - 1.0
Status string R

The status of the discovered Service at LastUpdate time. Enumeration of:

  • LeaseActive (The Service has received a response record with TTL > 0 and the Service.{i}.TimeToLive has not expired yet. The Service is considered active)
  • GoodbyeReceived (The device has received a response record containing TTL=0 indicating a goodbye message and the Service.{i}.TimeToLive has not expired yet. The Service is considered inactive)
  • LeaseExpired (The Service.{i}.TimeToLive has expired. The Service is considered inactive) The ability to instantiate an inactive Service is OPTIONAL. The time an inactive Service remains listed in this table is a local matter to the device.
- 1.0
LastUpdate dateTime R The date and time at which the last advertisement for this Service was received. - 1.0
Host string(:256)[](:1024) R Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters per item 256). Each list item MUST be the Path Name of all Host table entries, active or inactive, that correspond to this discovered DNS.SD service. As such, when entries are added or removed from the Host tables the value of this parameter MUST be updated accordingly. If the referenced object is deleted, the corresponding item MUST be removed from the list. - 1.0
TimeToLive unsignedInt(:2147483647) R The value extracted from the TTL field of the DNS SRV record [RFC2782]. - 1.0
Priority unsignedInt(:65535) R The value extracted from the Priority field of the DNS SRV record [RFC2782]. - 1.0
Weight unsignedInt(:65535) R A server selection mechanism. The value extracted from the Weight field of the DNS SRV record [RFC2782] that specifies the relative weight for entries with the same Priority. - 1.0
TextRecordNumberOfEntries unsignedInt R The number of entries in the TextRecord table. - 1.0
InternetGatewayDevice.DNS.SD.Service.{i}.TextRecord.{i}. object(0:) R This object maintains an instance of a (key/value pairs) of the service. The information is extracted from DNS TXT records [RFC1035] of the discovered service. When multiple instances of the TextRecord table have the same value for the Key parameter, the implementation is CPE specific. - 1.0
Key string(:255) R The key that identifies the text record - 1.0
Value string(:255) R The value of the text record. - 1.0

Inform and Notification Requirements

Forced Inform Parameters

Parameter
InternetGatewayDevice.DeviceSummary
InternetGatewayDevice.DeviceInfo.HardwareVersion
InternetGatewayDevice.DeviceInfo.SoftwareVersion
InternetGatewayDevice.DeviceInfo.SpecVersion
InternetGatewayDevice.DeviceInfo.ProvisioningCode
InternetGatewayDevice.ManagementServer.ParameterKey
InternetGatewayDevice.ManagementServer.ConnectionRequestURL
InternetGatewayDevice.ManagementServer.AliasBasedAddressing
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.ExternalIPAddress
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}.ExternalIPAddress

Forced Active Notification Parameters

Parameter
InternetGatewayDevice.DeviceInfo.SoftwareVersion
InternetGatewayDevice.DeviceInfo.ProvisioningCode

Default Active Notification Parameters

Parameter
InternetGatewayDevice.ManagementServer.ConnectionRequestURL
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.ExternalIPAddress
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}.ExternalIPAddress
InternetGatewayDevice.SoftwareModules.ExecutionUnit.{i}.Status
InternetGatewayDevice.FAP.GPS.LastScanTime
InternetGatewayDevice.FAP.Tunnel.IKESA.{i}.IPAddress

Parameters for which Active Notification MAY be Denied

Parameter
InternetGatewayDevice.DeviceInfo.
UpTime
DeviceLog
InternetGatewayDevice.DeviceInfo.VendorConfigFile.{i}.
Alias
InternetGatewayDevice.ManagementServer.
ParameterKey
InternetGatewayDevice.Time.
CurrentLocalTime
InternetGatewayDevice.Layer3Forwarding.Forwarding.{i}.
Alias
InternetGatewayDevice.IPPingDiagnostics.
DiagnosticsState
SuccessCount
FailureCount
AverageResponseTime
MaximumResponseTime
MinimumResponseTime
InternetGatewayDevice.LANDevice.{i}.
Alias
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.IPInterface.{i}.
Alias
InternetGatewayDevice.LANDevice.{i}.LANEthernetInterfaceConfig.{i}.
Alias
InternetGatewayDevice.LANDevice.{i}.LANEthernetInterfaceConfig.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
InternetGatewayDevice.LANDevice.{i}.LANUSBInterfaceConfig.{i}.
Alias
InternetGatewayDevice.LANDevice.{i}.LANUSBInterfaceConfig.{i}.Stats.
BytesSent
BytesReceived
CellsSent
CellsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.
TotalPSKFailures
TotalIntegrityFailures
ChannelsInUse
TotalBytesSent
TotalBytesReceived
TotalPacketsSent
TotalPacketsReceived
TotalAssociations
Alias
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.AssociatedDevice.{i}.
AssociatedDeviceMACAddress
AssociatedDeviceIPAddress
AssociatedDeviceAuthenticationState
LastRequestedUnicastCipher
LastRequestedMulticastCipher
LastPMKId
LastDataTransmitRate
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.WEPKey.{i}.
Alias
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.PreSharedKey.{i}.
Alias
InternetGatewayDevice.LANDevice.{i}.Hosts.Host.{i}.
LeaseTimeRemaining
InternetGatewayDevice.WANDevice.{i}.
Alias
InternetGatewayDevice.WANDevice.{i}.WANCommonInterfaceConfig.
TotalBytesSent
TotalBytesReceived
TotalPacketsSent
TotalPacketsReceived
MaximumActiveConnections
InternetGatewayDevice.WANDevice.{i}.WANCommonInterfaceConfig.Connection.{i}.
Alias
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.
UpstreamCurrRate
DownstreamCurrRate
UpstreamMaxRate
DownstreamMaxRate
UpstreamNoiseMargin
DownstreamNoiseMargin
UpstreamAttenuation
DownstreamAttenuation
UpstreamPower
DownstreamPower
TotalStart
ShowtimeStart
LastShowtimeStart
CurrentDayStart
QuarterHourStart
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.Total.
ReceiveBlocks
TransmitBlocks
CellDelin
LinkRetrain
InitErrors
InitTimeouts
LossOfFraming
ErroredSecs
SeverelyErroredSecs
FECErrors
ATUCFECErrors
HECErrors
ATUCHECErrors
CRCErrors
ATUCCRCErrors
LInit
LOF
ATUCErroredSecs
ATUCSeverelyErroredSecs
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.Showtime.
ReceiveBlocks
TransmitBlocks
CellDelin
LinkRetrain
InitErrors
InitTimeouts
LossOfFraming
ErroredSecs
SeverelyErroredSecs
FECErrors
ATUCFECErrors
HECErrors
ATUCHECErrors
CRCErrors
ATUCCRCErrors
LInit
LOF
ATUCErroredSecs
ATUCSeverelyErroredSecs
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.LastShowtime.
ReceiveBlocks
TransmitBlocks
CellDelin
LinkRetrain
InitErrors
InitTimeouts
LossOfFraming
ErroredSecs
SeverelyErroredSecs
FECErrors
ATUCFECErrors
HECErrors
ATUCHECErrors
CRCErrors
ATUCCRCErrors
LInit
LOF
ATUCErroredSecs
ATUCSeverelyErroredSecs
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.CurrentDay.
ReceiveBlocks
TransmitBlocks
CellDelin
LinkRetrain
InitErrors
InitTimeouts
LossOfFraming
ErroredSecs
SeverelyErroredSecs
FECErrors
ATUCFECErrors
HECErrors
ATUCHECErrors
CRCErrors
ATUCCRCErrors
LInit
LOF
ATUCErroredSecs
ATUCSeverelyErroredSecs
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.QuarterHour.
ReceiveBlocks
TransmitBlocks
CellDelin
LinkRetrain
InitErrors
InitTimeouts
LossOfFraming
ErroredSecs
SeverelyErroredSecs
FECErrors
ATUCFECErrors
HECErrors
ATUCHECErrors
CRCErrors
ATUCCRCErrors
LInit
LOF
ATUCErroredSecs
ATUCSeverelyErroredSecs
InternetGatewayDevice.WANDevice.{i}.WANEthernetInterfaceConfig.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
InternetGatewayDevice.WANDevice.{i}.WANDSLDiagnostics.
LoopDiagnosticsState
ACTPSDds
ACTPSDus
ACTATPds
ACTATPus
HLINSCds
HLINpsds
QLNpsds
SNRpsds
BITSpsds
GAINSpsds
HLINSCus
HLINGds
HLINGus
HLOGGds
HLOGGus
HLOGpsds
HLOGpsus
HLOGMTds
HLOGMTus
LATNpbds
LATNpbus
SATNds
SATNus
HLINpsus
QLNGds
QLNGus
QLNpsus
QLNMTds
QLNMTus
SNRGds
SNRGus
SNRpsus
SNRMTds
SNRMTus
BITSpsus
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.
Alias
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANDSLLinkConfig.
ATMTransmittedBlocks
ATMReceivedBlocks
AAL5CRCErrors
ATMCRCErrors
ATMHECErrors
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANATMF5LoopbackDiagnostics.
DiagnosticsState
SuccessCount
FailureCount
AverageResponseTime
MinimumResponseTime
MaximumResponseTime
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.
Uptime
Alias
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.PortMapping.{i}.
PortMappingLeaseDuration
Alias
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.Stats.
EthernetBytesSent
EthernetBytesReceived
EthernetPacketsSent
EthernetPacketsReceived
EthernetErrorsSent
EthernetErrorsReceived
EthernetUnicastPacketsSent
EthernetUnicastPacketsReceived
EthernetDiscardPacketsSent
EthernetDiscardPacketsReceived
EthernetMulticastPacketsSent
EthernetMulticastPacketsReceived
EthernetBroadcastPacketsSent
EthernetBroadcastPacketsReceived
EthernetUnknownProtoPacketsReceived
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}.
Uptime
CurrentMRUSize
Alias
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}.PortMapping.{i}.
PortMappingLeaseDuration
Alias
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}.Stats.
EthernetBytesSent
EthernetBytesReceived
EthernetPacketsSent
EthernetPacketsReceived
EthernetErrorsSent
EthernetErrorsReceived
EthernetUnicastPacketsSent
EthernetUnicastPacketsReceived
EthernetDiscardPacketsSent
EthernetDiscardPacketsReceived
EthernetMulticastPacketsSent
EthernetMulticastPacketsReceived
EthernetBroadcastPacketsSent
EthernetBroadcastPacketsReceived
EthernetUnknownProtoPacketsReceived
InternetGatewayDevice.Layer2Bridging.
MaxBridgeEntries
MaxFilterEntries
MaxMarkingEntries
InternetGatewayDevice.Layer2Bridging.Bridge.{i}.
Alias
InternetGatewayDevice.Layer2Bridging.Filter.{i}.
Alias
InternetGatewayDevice.Layer2Bridging.Marking.{i}.
Alias
InternetGatewayDevice.Layer2Bridging.AvailableInterface.{i}.
AvailableInterfaceKey
InterfaceType
InterfaceReference
Alias
InternetGatewayDevice.QueueManagement.
MaxQueues
MaxClassificationEntries
MaxAppEntries
MaxFlowEntries
MaxPolicerEntries
MaxQueueEntries
InternetGatewayDevice.QueueManagement.Classification.{i}.
Alias
InternetGatewayDevice.QueueManagement.App.{i}.
Alias
InternetGatewayDevice.QueueManagement.Flow.{i}.
Alias
InternetGatewayDevice.QueueManagement.Policer.{i}.
PossibleMeterTypes
CountedPackets
CountedBytes
TotalCountedPackets
TotalCountedBytes
ConformingCountedPackets
ConformingCountedBytes
PartiallyConformingCountedPackets
PartiallyConformingCountedBytes
NonConformingCountedPackets
NonConformingCountedBytes
Alias
InternetGatewayDevice.QueueManagement.Queue.{i}.
Alias
InternetGatewayDevice.ManagementServer.ManageableDevice.{i}.
ManufacturerOUI
SerialNumber
ProductClass
InternetGatewayDevice.DownloadDiagnostics.
DiagnosticsState
ROMTime
BOMTime
EOMTime
TestBytesReceived
TotalBytesReceived
TCPOpenRequestTime
TCPOpenResponseTime
InternetGatewayDevice.UploadDiagnostics.
DiagnosticsState
ROMTime
BOMTime
EOMTime
TotalBytesSent
TCPOpenRequestTime
TCPOpenResponseTime
InternetGatewayDevice.UDPEchoConfig.
PacketsReceived
PacketsResponded
BytesReceived
BytesResponded
TimeFirstPacketReceived
TimeLastPacketReceived
InternetGatewayDevice.Layer2Bridging.Bridge.{i}.Port.{i}.
Alias
InternetGatewayDevice.Layer2Bridging.Bridge.{i}.VLAN.{i}.
Alias
InternetGatewayDevice.QueueManagement.QueueStats.{i}.
OutputPackets
OutputBytes
DroppedPackets
DroppedBytes
QueueOccupancyPackets
QueueOccupancyPercentage
Alias
InternetGatewayDevice.TraceRouteDiagnostics.
DiagnosticsState
ResponseTime
RouteHopsNumberOfEntries
InternetGatewayDevice.TraceRouteDiagnostics.RouteHops.{i}.
HopHost
HopHostAddress
HopErrorCode
HopRTTimes
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.DHCPStaticAddress.{i}.
Alias
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.DHCPOption.{i}.
Alias
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.DHCPConditionalServingPool.{i}.
Alias
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.DHCPConditionalServingPool.{i}.DHCPStaticAddress.{i}.
Alias
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.DHCPConditionalServingPool.{i}.DHCPOption.{i}.
Alias
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.Stats.
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.WPS.Registrar.{i}.
Alias
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.APWMMParameter.{i}.
Alias
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.STAWMMParameter.{i}.
Alias
InternetGatewayDevice.LANInterfaces.LANEthernetInterfaceConfig.{i}.
Alias
InternetGatewayDevice.LANInterfaces.LANUSBInterfaceConfig.{i}.
Alias
InternetGatewayDevice.LANInterfaces.WLANConfiguration.{i}.
Alias
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.TestParams.
HLOGGds
HLOGGus
HLOGpsds
HLOGpsus
HLOGMTds
HLOGMTus
QLNGds
QLNGus
QLNpsds
QLNpsus
QLNMTds
QLNMTus
SNRGds
SNRGus
SNRpsds
SNRpsus
SNRMTds
SNRMTus
LATNds
LATNus
SATNds
SATNus
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPTMLinkConfig.Stats.
BytesSent
BytesReceived
FramesSent
FramesReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownProtoPacketsReceived
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.DHCPClient.SentDHCPOption.{i}.
Alias
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.DHCPClient.ReqDHCPOption.{i}.
Alias
InternetGatewayDevice.DeviceInfo.MemoryStatus.
Free
InternetGatewayDevice.DeviceInfo.ProcessStatus.
CPUUsage
InternetGatewayDevice.DeviceInfo.ProcessStatus.Process.{i}.
Size
CPUTime
State
InternetGatewayDevice.DeviceInfo.TemperatureStatus.TemperatureSensor.{i}.
Value
LastUpdate
Alias
InternetGatewayDevice.UserInterface.LocalDisplay.
PosX
PosY
Width
Height
InternetGatewayDevice.User.{i}.
Alias
InternetGatewayDevice.SmartCardReader.{i}.
DecryptionFailedCounter
DecryptionFailedNoKeyCounter
Alias
InternetGatewayDevice.SelfTestDiagnostics.
DiagnosticsState
Results
InternetGatewayDevice.NSLookupDiagnostics.
DiagnosticsState
SuccessCount
ResultNumberOfEntries
InternetGatewayDevice.NSLookupDiagnostics.Result.{i}.
Status
AnswerType
HostNameReturned
IPAddresses
DNSServerIP
ResponseTime
InternetGatewayDevice.USBHosts.Host.{i}.
Alias
InternetGatewayDevice.PeriodicStatistics.SampleSet.{i}.
SampleSeconds
Alias
InternetGatewayDevice.PeriodicStatistics.SampleSet.{i}.Parameter.{i}.
SampleSeconds
SuspectData
Values
Alias
InternetGatewayDevice.DownloadAvailability.Announcement.Group.{i}.
Alias
InternetGatewayDevice.DeviceInfo.SupportedDataModel.{i}.
Alias
InternetGatewayDevice.DeviceInfo.Processor.{i}.
Alias
InternetGatewayDevice.DeviceInfo.VendorLogFile.{i}.
Alias
InternetGatewayDevice.SoftwareModules.ExecEnv.{i}.
Alias
AvailableDiskSpace
AvailableMemory
ActiveExecutionUnits
InternetGatewayDevice.SoftwareModules.DeploymentUnit.{i}.
Alias
Status
InternetGatewayDevice.SoftwareModules.ExecutionUnit.{i}.
Alias
DiskSpaceInUse
MemoryInUse
InternetGatewayDevice.FAP.GPS.
LastSuccessfulScanTime
LockedLatitude
LockedLongitude
NumberOfSatellites
InternetGatewayDevice.FAP.GPS.ContinuousGPSStatus.
CurrentFix
GotFix
TimingGood
Latitude
Longitude
Elevation
LastFixTime
LastFixDuration
SatellitesTracked
ReceiverStatus
LocationType
InternetGatewayDevice.FAP.Tunnel.IKESA.{i}.
IntegrityErrors
OtherErrors
AuthErrors
InternetGatewayDevice.FAP.Tunnel.ChildSA.{i}.
IntegrityErrors
ReplayErrors

Profile Definitions

Notation

The following abbreviations are used to specify profile requirements:

Abbreviation Description
R Read support is REQUIRED.
W Both Read and Write support is REQUIRED. This MUST NOT be specified for a parameter that is defined as read-only.
P The object is REQUIRED to be present.
C Creation and deletion of instances of the object is REQUIRED.
A Creation of instances of the object is REQUIRED, but deletion is not REQUIRED.
D Deletion of instances of the object is REQUIRED, but creation is not REQUIRED.

Baseline:1 Profile

This table defines the Baseline:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice. P
DeviceSummary R
LANDeviceNumberOfEntries R
WANDeviceNumberOfEntries R
InternetGatewayDevice.DeviceInfo. P
Manufacturer R
ManufacturerOUI R
ModelName R
Description R
SerialNumber R
HardwareVersion R
SoftwareVersion R
SpecVersion R
ProvisioningCode W
UpTime R
DeviceLog R
InternetGatewayDevice.ManagementServer. P
URL W
Username W
Password W
PeriodicInformEnable W
PeriodicInformInterval W
PeriodicInformTime W
ParameterKey R
ConnectionRequestURL R
ConnectionRequestUsername W
ConnectionRequestPassword W
UpgradesManaged W
InternetGatewayDevice.Layer3Forwarding. P
DefaultConnectionService W
ForwardNumberOfEntries R
InternetGatewayDevice.Layer3Forwarding.Forwarding.{i}. C
Enable W
Status R
Type W
DestIPAddress W
DestSubnetMask W
SourceIPAddress W
SourceSubnetMask W
GatewayIPAddress W
Interface W
ForwardingMetric W
InternetGatewayDevice.LANConfigSecurity. P
ConfigPassword W
InternetGatewayDevice.LANDevice.{i}. P
LANEthernetInterfaceNumberOfEntries R
LANUSBInterfaceNumberOfEntries R
LANWLANConfigurationNumberOfEntries R
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement. P
DHCPServerConfigurable W
DHCPServerEnable W
DHCPRelay R
MinAddress W
MaxAddress W
ReservedAddresses W
SubnetMask W
DNSServers W
DomainName W
IPRouters W
IPInterfaceNumberOfEntries R
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.IPInterface.{i}. P
Enable W
IPInterfaceIPAddress W
IPInterfaceSubnetMask W
IPInterfaceAddressingType W
InternetGatewayDevice.LANDevice.{i}.Hosts. P
HostNumberOfEntries R
InternetGatewayDevice.LANDevice.{i}.Hosts.Host.{i}. P
IPAddress R
AddressSource R
LeaseTimeRemaining R
MACAddress R
HostName R
InterfaceType R
Active R
InternetGatewayDevice.WANDevice.{i}. P
WANConnectionNumberOfEntries R
InternetGatewayDevice.WANDevice.{i}.WANCommonInterfaceConfig. P
EnabledForInternet R
WANAccessType R
Layer1UpstreamMaxBitRate R
Layer1DownstreamMaxBitRate R
PhysicalLinkStatus R
TotalBytesSent R
TotalBytesReceived R
TotalPacketsSent R
TotalPacketsReceived R
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}. P
WANIPConnectionNumberOfEntries R
WANPPPConnectionNumberOfEntries R
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}. C
Enable W
ConnectionStatus R
PossibleConnectionTypes R
ConnectionType W
Name W
Uptime R
LastConnectionError R
RSIPAvailable R
NATEnabled W
AddressingType R
ExternalIPAddress R
SubnetMask R
DefaultGateway R
DNSEnabled R
DNSOverrideAllowed R
DNSServers R
MACAddress R
ConnectionTrigger W
RouteProtocolRx W
PortMappingNumberOfEntries R
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.PortMapping.{i}. C
PortMappingEnabled W
PortMappingLeaseDuration R
RemoteHost W
ExternalPort W
InternalPort W
PortMappingProtocol W
InternalClient W
PortMappingDescription W
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.Stats. P
EthernetBytesSent R
EthernetBytesReceived R
EthernetPacketsSent R
EthernetPacketsReceived R
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}. C
Enable W
ConnectionStatus R
PossibleConnectionTypes R
ConnectionType W
Name W
Uptime R
LastConnectionError R
RSIPAvailable R
NATEnabled W
Username W
Password W
ExternalIPAddress R
DNSEnabled R
DNSOverrideAllowed R
DNSServers R
MACAddress R
TransportType R
PPPoEACName W
PPPoEServiceName W
ConnectionTrigger W
RouteProtocolRx W
PortMappingNumberOfEntries R
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}.PortMapping.{i}. C
PortMappingEnabled W
PortMappingLeaseDuration R
RemoteHost W
ExternalPort W
InternalPort W
PortMappingProtocol W
InternalClient W
PortMappingDescription W
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}.Stats. P
EthernetBytesSent R
EthernetBytesReceived R
EthernetPacketsSent R
EthernetPacketsReceived R

EthernetLAN:1 Profile

This table defines the EthernetLAN:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.LANDevice.{i}.LANEthernetInterfaceConfig.{i}. P
Enable W
Status R
MACAddress R
MACAddressControlEnabled W
MaxBitRate W
DuplexMode W
InternetGatewayDevice.LANDevice.{i}.LANEthernetInterfaceConfig.{i}.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R

USBLAN:1 Profile

This table defines the USBLAN:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.LANDevice.{i}.LANUSBInterfaceConfig.{i}. P
Enable W
Status R
MACAddress R
MACAddressControlEnabled W
Standard R
Type R
Rate R
Power R
InternetGatewayDevice.LANDevice.{i}.LANUSBInterfaceConfig.{i}.Stats. P
BytesSent R
BytesReceived R
CellsSent R
CellsReceived R

WiFiLAN:1 Profile

This table defines the WiFiLAN:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}. P
Enable W
Status R
BSSID R
MaxBitRate W
Channel W
SSID W
BeaconType W
MACAddressControlEnabled W
Standard R
WEPKeyIndex W
KeyPassphrase W
WEPEncryptionLevel R
BasicEncryptionModes W
BasicAuthenticationMode W
WPAEncryptionModes W
WPAAuthenticationMode W
PossibleChannels R
BasicDataTransmitRates W
OperationalDataTransmitRates W
PossibleDataTransmitRates R
RadioEnabled W
AutoRateFallBackEnabled W
TotalBytesSent R
TotalBytesReceived R
TotalPacketsSent R
TotalPacketsReceived R
TotalAssociations R
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.AssociatedDevice.{i}. P
AssociatedDeviceMACAddress R
AssociatedDeviceIPAddress R
AssociatedDeviceAuthenticationState R
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.WEPKey.{i}. P
WEPKey W
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.PreSharedKey.{i}. P
PreSharedKey W
KeyPassphrase W

ADSLWAN:1 Profile

This table defines the ADSLWAN:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig. P
Enable W
Status R
UpstreamCurrRate R
DownstreamCurrRate R
UpstreamMaxRate R
DownstreamMaxRate R
UpstreamNoiseMargin R
DownstreamNoiseMargin R
UpstreamAttenuation R
DownstreamAttenuation R
UpstreamPower R
DownstreamPower R
ATURVendor R
ATURCountry R
ATUCVendor R
ATUCCountry R
TotalStart R
ShowtimeStart R
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats. P
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.Total. P
ReceiveBlocks R
TransmitBlocks R
CellDelin R
LinkRetrain R
InitErrors R
InitTimeouts R
LossOfFraming R
ErroredSecs R
SeverelyErroredSecs R
FECErrors R
ATUCFECErrors R
HECErrors R
ATUCHECErrors R
CRCErrors R
ATUCCRCErrors R
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.Stats.Showtime. P
ReceiveBlocks R
TransmitBlocks R
CellDelin R
LinkRetrain R
InitErrors R
InitTimeouts R
LossOfFraming R
ErroredSecs R
SeverelyErroredSecs R
FECErrors R
ATUCFECErrors R
HECErrors R
ATUCHECErrors R
CRCErrors R
ATUCCRCErrors R
InternetGatewayDevice.WANDevice.{i}.WANDSLConnectionManagement. P
ConnectionServiceNumberOfEntries R
InternetGatewayDevice.WANDevice.{i}.WANDSLConnectionManagement.ConnectionService.{i}. P
WANConnectionDevice R
WANConnectionService R
DestinationAddress R
LinkType R
ConnectionType R
Name R
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}. C
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANDSLLinkConfig. P
Enable W
LinkStatus R
LinkType W
AutoConfig R
DestinationAddress W
ATMTransmittedBlocks R
ATMReceivedBlocks R
AAL5CRCErrors R
ATMCRCErrors R

EthernetWAN:1 Profile

This table defines the EthernetWAN:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.WANDevice.{i}.WANEthernetInterfaceConfig. P
Enable W
Status R
MACAddress R
MaxBitRate W
DuplexMode W
InternetGatewayDevice.WANDevice.{i}.WANEthernetInterfaceConfig.Stats. P
BytesSent R
BytesReceived R
PacketsSent R
PacketsReceived R
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANEthernetLinkConfig. P
EthernetLinkStatus R

POTSWAN:1 Profile

This table defines the POTSWAN:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPOTSLinkConfig. P
Enable W
LinkStatus R
ISPPhoneNumber R
ISPInfo R
LinkType R
NumberOfRetries R
DelayBetweenRetries R

QoS:1 Profile

This table defines the QoS:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.QueueManagement. P
Enable W
MaxQueues R
MaxClassificationEntries R
ClassificationNumberOfEntries R
MaxAppEntries R
AppNumberOfEntries R
MaxFlowEntries R
FlowNumberOfEntries R
MaxPolicerEntries R
PolicerNumberOfEntries R
MaxQueueEntries R
QueueNumberOfEntries R
DefaultForwardingPolicy W
DefaultPolicer W
DefaultQueue W
DefaultDSCPMark W
DefaultEthernetPriorityMark W
AvailableAppList R
InternetGatewayDevice.QueueManagement.Classification.{i}. C
ClassificationKey R
ClassificationEnable W
ClassificationStatus R
ClassificationOrder W
ClassInterface W
DestIP W
DestMask W
DestIPExclude W
SourceIP W
SourceMask W
SourceIPExclude W
Protocol W
ProtocolExclude W
DestPort W
DestPortRangeMax W
DestPortExclude W
SourcePort W
SourcePortRangeMax W
SourcePortExclude W
SourceMACAddress W
SourceMACExclude W
DestMACAddress W
DestMACExclude W
DSCPCheck W
DSCPExclude W
DSCPMark W
EthernetPriorityCheck W
EthernetPriorityExclude W
EthernetPriorityMark W
VLANIDCheck W
VLANIDExclude W
ForwardingPolicy W
ClassPolicer W
ClassQueue W
InternetGatewayDevice.QueueManagement.Policer.{i}. C
PolicerKey R
PolicerEnable W
PolicerStatus R
CommittedRate W
CommittedBurstSize W
MeterType W
PossibleMeterTypes R
ConformingAction W
NonConformingAction W
CountedPackets R
CountedBytes R
InternetGatewayDevice.QueueManagement.Queue.{i}. C
QueueKey R
QueueEnable W
QueueStatus R
QueueInterface W
QueueBufferLength R
QueueWeight W
QueuePrecedence W
REDThreshold W
REDPercentage W
DropAlgorithm W
SchedulerAlgorithm W
ShapingRate W
ShapingBurstSize W
InternetGatewayDevice.Layer3Forwarding.Forwarding.{i}. -
ForwardingPolicy W
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}. -
ShapingRate W
ShapingBurstSize W
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}. -
ShapingRate W
ShapingBurstSize W

QoSDynamicFlow:1 Profile

This table defines the QoSDynamicFlow:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.QueueManagement.App.{i}. C
AppKey R
AppEnable W
AppStatus R
ProtocolIdentifier W
AppName W
AppDefaultForwardingPolicy W
AppDefaultPolicer W
AppDefaultQueue W
AppDefaultDSCPMark W
AppDefaultEthernetPriorityMark W
InternetGatewayDevice.QueueManagement.Flow.{i}. C
FlowKey R
FlowEnable W
FlowStatus R
FlowType W
FlowTypeParameters W
FlowName W
AppIdentifier W
FlowForwardingPolicy W
FlowPolicer W
FlowQueue W
FlowDSCPMark W
FlowEthernetPriorityMark W
InternetGatewayDevice.QueueManagement.Classification.{i}. -
ClassApp W

Bridging:1 Profile

This table defines the Bridging:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.Layer2Bridging. P
MaxBridgeEntries R
MaxFilterEntries R
MaxMarkingEntries R
BridgeNumberOfEntries R
FilterNumberOfEntries R
MarkingNumberOfEntries R
AvailableInterfaceNumberOfEntries R
InternetGatewayDevice.Layer2Bridging.Bridge.{i}. C
BridgeKey R
BridgeEnable W
BridgeStatus R
BridgeName W
VLANID W
InternetGatewayDevice.Layer2Bridging.Filter.{i}. C
FilterKey R
FilterEnable W
FilterStatus R
FilterBridgeReference W
ExclusivityOrder W
FilterInterface W
VLANIDFilter W
AdmitOnlyVLANTagged W
EthertypeFilterList W
EthertypeFilterExclude W
SourceMACAddressFilterList W
SourceMACAddressFilterExclude W
DestMACAddressFilterList W
DestMACAddressFilterExclude W
InternetGatewayDevice.Layer2Bridging.Marking.{i}. C
MarkingKey R
MarkingEnable W
MarkingStatus R
MarkingBridgeReference W
MarkingInterface W
VLANIDUntag W
VLANIDMark W
EthernetPriorityMark W
EthernetPriorityOverride W
InternetGatewayDevice.Layer2Bridging.AvailableInterface.{i}. P
AvailableInterfaceKey R
InterfaceType R
InterfaceReference R

Time:1 Profile

This table defines the Time:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.Time. P
NTPServer1 W
NTPServer2 W
CurrentLocalTime R
LocalTimeZone W
LocalTimeZoneName W
DaylightSavingsUsed W
DaylightSavingsStart W
DaylightSavingsEnd W

IPPing:1 Profile

This table defines the IPPing:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.IPPingDiagnostics. P
DiagnosticsState W
Interface W
Host W
NumberOfRepetitions W
Timeout W
DataBlockSize W
DSCP W
SuccessCount R
FailureCount R
AverageResponseTime R
MinimumResponseTime R
MaximumResponseTime R

ATMLoopback:1 Profile

This table defines the ATMLoopback:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANATMF5LoopbackDiagnostics. P
DiagnosticsState W
NumberOfRepetitions W
Timeout W
SuccessCount R
FailureCount R
AverageResponseTime R
MinimumResponseTime R
MaximumResponseTime R

DSLDiagnostics:1 Profile

This table defines the DSLDiagnostics:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.WANDevice.{i}.WANDSLDiagnostics. P
LoopDiagnosticsState W
ACTPSDds R
ACTPSDus R
ACTATPds R
ACTATPus R
HLINSCds R
HLINpsds R
QLNpsds R
SNRpsds R
BITSpsds R
GAINSpsds R

DeviceAssociation:1 Profile

This table defines the DeviceAssociation:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.ManagementServer. -
ManageableDeviceNumberOfEntries R
InternetGatewayDevice.ManagementServer.ManageableDevice.{i}. P
ManufacturerOUI R
SerialNumber R
ProductClass R

UDPConnReq:1 Profile

This table defines the UDPConnReq:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.ManagementServer. -
UDPConnectionRequestAddress R
UDPConnectionRequestAddressNotificationLimit W
STUNEnable W
STUNServerAddress W
STUNServerPort W
STUNUsername W
STUNPassword W
STUNMaximumKeepAlivePeriod W
STUNMinimumKeepAlivePeriod W
NATDetected R

Download:1 Profile

This table defines the Download:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.Capabilities.PerformanceDiagnostic. P
DownloadTransports R
InternetGatewayDevice.DownloadDiagnostics. P
DiagnosticsState W
Interface W
DownloadURL W
DSCP W
EthernetPriority W
ROMTime R
BOMTime R
EOMTime R
TestBytesReceived R
TotalBytesReceived R

DownloadTCP:1 Profile

This table defines the DownloadTCP:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.DownloadDiagnostics. P
TCPOpenRequestTime R
TCPOpenResponseTime R

Upload:1 Profile

This table defines the Upload:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.Capabilities.PerformanceDiagnostic. P
UploadTransports R
InternetGatewayDevice.UploadDiagnostics. P
DiagnosticsState W
Interface W
UploadURL W
DSCP W
EthernetPriority W
ROMTime R
BOMTime R
EOMTime R
TestFileLength R
TotalBytesSent R

UploadTCP:1 Profile

This table defines the UploadTCP:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.UploadDiagnostics. P
TCPOpenRequestTime R
TCPOpenResponseTime R

UDPEcho:1 Profile

This table defines the UDPEcho:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.UDPEchoConfig. P
Enable W
Interface W
SourceIPAddress W
UDPPort W
PacketsReceived R
PacketsResponded R
BytesReceived R
BytesResponded R
TimeFirstPacketReceived R
TimeLastPacketReceived R
EchoPlusSupported R

UDPEchoPlus:1 Profile

This table defines the UDPEchoPlus:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.UDPEchoConfig. P
EchoPlusEnabled W

Baseline:2 Profile

The Baseline:2 profile for the InternetGatewayDevice:1 data model is defined as the union of the Baseline:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.Layer3Forwarding.Forwarding.{i}. C
StaticRoute R
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement. P
MACAddress R
InternetGatewayDevice.LANDevice.{i}.Hosts.Host.{i}. P
Layer2Interface R
InternetGatewayDevice.LANInterfaces. P
LANEthernetInterfaceNumberOfEntries R
LANUSBInterfaceNumberOfEntries R
LANWLANConfigurationNumberOfEntries R
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}. C
Reset W
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.Stats. P
EthernetErrorsSent R
EthernetErrorsReceived R
EthernetUnicastPacketsSent R
EthernetUnicastPacketsReceived R
EthernetDiscardPacketsSent R
EthernetDiscardPacketsReceived R
EthernetMulticastPacketsSent R
EthernetMulticastPacketsReceived R
EthernetBroadcastPacketsSent R
EthernetBroadcastPacketsReceived R
EthernetUnknownProtoPacketsReceived R
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}. C
Reset W
PPPoESessionID R
DefaultGateway R
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPPConnection.{i}.Stats. P
EthernetErrorsSent R
EthernetErrorsReceived R
EthernetUnicastPacketsSent R
EthernetUnicastPacketsReceived R
EthernetDiscardPacketsSent R
EthernetDiscardPacketsReceived R
EthernetMulticastPacketsSent R
EthernetMulticastPacketsReceived R
EthernetBroadcastPacketsSent R
EthernetBroadcastPacketsReceived R
EthernetUnknownProtoPacketsReceived R

EthernetLAN:2 Profile

The EthernetLAN:2 profile for the InternetGatewayDevice:1 data model is defined as the union of the EthernetLAN:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.LANDevice.{i}.LANEthernetInterfaceConfig.{i}. P
Name R
InternetGatewayDevice.LANDevice.{i}.LANEthernetInterfaceConfig.{i}.Stats. P
ErrorsSent R
ErrorsReceived R
UnicastPacketsSent R
UnicastPacketsReceived R
DiscardPacketsSent R
DiscardPacketsReceived R
MulticastPacketsSent R
MulticastPacketsReceived R
BroadcastPacketsSent R
BroadcastPacketsReceived R
UnknownProtoPacketsReceived R

USBLAN:2 Profile

The USBLAN:2 profile for the InternetGatewayDevice:1 data model is defined as the union of the USBLAN:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.LANDevice.{i}.LANUSBInterfaceConfig.{i}. P
Name R
InternetGatewayDevice.LANDevice.{i}.LANUSBInterfaceConfig.{i}.Stats. P
ErrorsSent R
ErrorsReceived R
UnicastPacketsSent R
UnicastPacketsReceived R
DiscardPacketsSent R
DiscardPacketsReceived R
MulticastPacketsSent R
MulticastPacketsReceived R
BroadcastPacketsSent R
BroadcastPacketsReceived R
UnknownProtoPacketsReceived R

WiFiLAN:2 Profile

The WiFiLAN:2 profile for the InternetGatewayDevice:1 data model is defined as the union of the WiFiLAN:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}. P
Name R
AutoChannelEnable W
SSIDAdvertisementEnabled W
TransmitPowerSupported R
TransmitPower W
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.Stats. P
ErrorsSent R
ErrorsReceived R
UnicastPacketsSent R
UnicastPacketsReceived R
DiscardPacketsSent R
DiscardPacketsReceived R
MulticastPacketsSent R
MulticastPacketsReceived R
BroadcastPacketsSent R
BroadcastPacketsReceived R
UnknownProtoPacketsReceived R

WiFiWMM:1 Profile

This table defines the WiFiWMM:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}. P
WMMSupported R
UAPSDSupported R
WMMEnable W
UAPSDEnable W
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.APWMMParameter.{i}. P
AIFSN W
ECWMin W
ECWMax W
TXOP W
AckPolicy W
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.STAWMMParameter.{i}. P
AIFSN W
ECWMin W
ECWMax W
TXOP W
AckPolicy W

WiFiWPS:1 Profile

This table defines the WiFiWPS:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.WPS. P
Enable W
DeviceName R
DevicePassword W
UUID R
Version R
ConfigMethodsSupported R
ConfigMethodsEnabled W
SetupLockedState R
SetupLock W
ConfigurationState R
LastConfigurationError R
RegistrarNumberOfEntries R
RegistrarEstablished R
InternetGatewayDevice.LANDevice.{i}.WLANConfiguration.{i}.WPS.Registrar.{i}. P
Enable W
UUID R
DeviceName R

ADSL2WAN:1 Profile

This table defines the ADSL2WAN:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig. P
Enable W
Status R
LinkEncapsulationSupported R
LinkEncapsulationRequested W
LinkEncapsulationUsed R
StandardsSupported R
StandardUsed R
UpstreamMaxRate R
DownstreamMaxRate R
UpstreamNoiseMargin R
DownstreamNoiseMargin R
UpstreamPower R
DownstreamPower R
TotalStart R
ShowtimeStart R
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.TestParams. P
HLOGpsds R
HLOGpsus R
HLOGMTds R
HLOGMTus R
QLNpsds R
QLNpsus R
QLNMTds R
QLNMTus R
SNRpsds R
SNRpsus R
SNRMTds R
SNRMTus R
LATNds R
LATNus R
SATNds R
SATNus R
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}. C
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANDSLLinkConfig. P
Enable W
LinkStatus R
LinkType W
AutoConfig R
DestinationAddress W
ATMTransmittedBlocks R
ATMReceivedBlocks R
ATMCRCErrors R

VDSL2WAN:1 Profile

This table defines the VDSL2WAN:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig. P
Enable W
Status R
LinkEncapsulationSupported R
LinkEncapsulationRequested W
LinkEncapsulationUsed R
StandardsSupported R
StandardUsed R
AllowedProfiles R
CurrentProfile R
UPBOKLE R
UpstreamMaxRate R
DownstreamMaxRate R
UpstreamNoiseMargin R
DownstreamNoiseMargin R
UpstreamAttenuation R
DownstreamAttenuation R
UpstreamPower R
DownstreamPower R
TRELLISds R
TRELLISus R
ACTSNRMODEds R
ACTSNRMODEus R
ACTUALCE R
SNRMpbds R
SNRMpbus R
TotalStart R
ShowtimeStart R
InternetGatewayDevice.WANDevice.{i}.WANDSLInterfaceConfig.TestParams. P
HLOGGds R
HLOGGus R
HLOGpsds R
HLOGpsus R
HLOGMTds R
HLOGMTus R
QLNGds R
QLNGus R
QLNpsds R
QLNpsus R
QLNMTds R
QLNMTus R
SNRGds R
SNRGus R
SNRpsds R
SNRpsus R
SNRMTds R
SNRMTus R
LATNds R
LATNus R
SATNds R
SATNus R
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}. C
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANDSLLinkConfig. P
Enable W
LinkStatus R
LinkType W
AutoConfig R
DestinationAddress W
ATMTransmittedBlocks R
ATMReceivedBlocks R
ATMCRCErrors R

PTMWAN:1 Profile

This table defines the PTMWAN:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPTMLinkConfig. P
Enable W
LinkStatus R
MACAddress R
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPTMLinkConfig.Stats. P
BytesSent R
BytesReceived R
FramesSent R
FramesReceived R
OOSNearEnd R
OOSFarEnd R
ErrorsSent R
ErrorsReceived R
UnicastPacketsSent R
UnicastPacketsReceived R
DiscardPacketsSent R
DiscardPacketsReceived R
MulticastPacketsSent R
MulticastPacketsReceived R
BroadcastPacketsSent R
BroadcastPacketsReceived R
UnknownProtoPacketsReceived R

QoS:2 Profile

The QoS:2 profile for the InternetGatewayDevice:1 data model is defined as the union of the QoS:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.QueueManagement. P
DefaultTrafficClass W
InternetGatewayDevice.QueueManagement.Classification.{i}. C
ClassificationKey R1
TrafficClass W
InternetGatewayDevice.QueueManagement.Policer.{i}. C
PolicerKey R2
ExcessBurstSize W
PeakRate W
PeakBurstSize W
PartialConformingAction W
InternetGatewayDevice.QueueManagement.Queue.{i}. C
QueueKey R3
TrafficClasses W
InternetGatewayDevice.WANDevice.{i}.WANEthernetInterfaceConfig. -
ShapingRate W
ShapingBurstSize W

1 This parameter is OBSOLETED.
2 This parameter is OBSOLETED.
3 This parameter is OBSOLETED.

QoSDynamicFlow:2 Profile

The QoSDynamicFlow:2 profile for the InternetGatewayDevice:1 data model is defined as the union of the QoSDynamicFlow:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.QueueManagement.App.{i}. C
AppKey R1
AppDefaultTrafficClass W
InternetGatewayDevice.QueueManagement.Flow.{i}. C
FlowKey R2
FlowTrafficClass W

1 This parameter is OBSOLETED.
2 This parameter is OBSOLETED.

QoSStats:1 Profile

This table defines the QoSStats:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.QueueManagement. P
QueueStatsNumberOfEntries R
InternetGatewayDevice.QueueManagement.Policer.{i}. -
TotalCountedPackets R
TotalCountedBytes R
ConformingCountedPackets R
ConformingCountedBytes R
NonConformingCountedPackets R
NonConformingCountedBytes R
InternetGatewayDevice.QueueManagement.QueueStats.{i}. C
Enable W
Status R
Queue W
Interface W
OutputPackets R
OutputBytes R
DroppedPackets R
DroppedBytes R
QueueOccupancyPackets R
QueueOccupancyPercentage R

Bridging:2 Profile

The Bridging:2 profile for the InternetGatewayDevice:1 data model is defined as the union of the Bridging:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.Layer2Bridging. P
MaxDBridgeEntries R
MaxQBridgeEntries R
InternetGatewayDevice.Layer2Bridging.Bridge.{i}. C
BridgeStandard W
InternetGatewayDevice.Layer2Bridging.Marking.{i}. C
VLANIDMarkOverride W

BridgingPortVLAN:1 Profile

This table defines the BridgingPortVLAN:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.Layer2Bridging. P
MaxVLANEntries R
InternetGatewayDevice.Layer2Bridging.Bridge.{i}. P
PortNumberOfEntries R
VLANNumberOfEntries R
InternetGatewayDevice.Layer2Bridging.Bridge.{i}.Port.{i}. C
PortEnable W
PortInterface W
PortState R
PVID W
AcceptableFrameTypes W
IngressFiltering W
InternetGatewayDevice.Layer2Bridging.Bridge.{i}.VLAN.{i}. C
VLANEnable W
VLANName W
VLANID W

Time:2 Profile

The Time:2 profile for the InternetGatewayDevice:1 data model is defined as the union of the Time:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.Time. P
Enable W
Status R
LocalTimeZone W1
LocalTimeZoneName W
DaylightSavingsUsed W2
DaylightSavingsStart W3
DaylightSavingsEnd W4

1 This parameter is OBSOLETED.
2 This parameter is OBSOLETED.
3 This parameter is OBSOLETED.
4 This parameter is OBSOLETED.

CaptivePortal:1 Profile

This table defines the CaptivePortal:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.CaptivePortal. P
Enable W
Status R
AllowedList W
CaptivePortalURL W

TraceRoute:1 Profile

This table defines the TraceRoute:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.TraceRouteDiagnostics. P
DiagnosticsState W
Interface W
Host W
NumberOfTries W
Timeout W
DataBlockSize W
DSCP W
MaxHopCount W
ResponseTime R
RouteHopsNumberOfEntries R
InternetGatewayDevice.TraceRouteDiagnostics.RouteHops.{i}. P
HopHost R
HopHostAddress R
HopErrorCode R
HopRTTimes R

ADSL2DSLDiagnostics:1 Profile

This table defines the ADSL2DSLDiagnostics:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.WANDevice.{i}.WANDSLDiagnostics. P
LoopDiagnosticsState W
ACTPSDds R
ACTPSDus R
ACTATPds R
ACTATPus R
HLINSCds R
HLINSCus R
HLINpsds R
HLINpsus R
HLOGpsds R
HLOGpsus R
HLOGMTds R
HLOGMTus R
QLNpsds R
QLNpsus R
QLNMTds R
QLNMTus R
SNRpsds R
SNRpsus R
SNRMTds R
SNRMTus R
LATNpbds R
LATNpbus R
SATNds R
SATNus R

VDSL2DSLDiagnostics:1 Profile

This table defines the VDSL2DSLDiagnostics:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.WANDevice.{i}.WANDSLDiagnostics. P
LoopDiagnosticsState W
ACTPSDds R
ACTPSDus R
ACTATPds R
ACTATPus R
HLINSCds R
HLINSCus R
HLINGds R
HLINGus R
HLINpsds R
HLINpsus R
HLOGGds R
HLOGGus R
HLOGpsds R
HLOGpsus R
HLOGMTds R
HLOGMTus R
QLNGds R
QLNGus R
QLNpsds R
QLNpsus R
QLNMTds R
QLNMTus R
SNRGds R
SNRGus R
SNRpsds R
SNRpsus R
SNRMTds R
SNRMTus R
LATNpbds R
LATNpbus R
SATNds R
SATNus R

DeviceAssociation:2 Profile

The DeviceAssociation:2 profile for the InternetGatewayDevice:1 data model is defined as the union of the DeviceAssociation:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.ManagementServer.ManageableDevice.{i}. P
Host R

DHCPCondServing:1 Profile

This table defines the DHCPCondServing:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement. P
DHCPConditionalPoolNumberOfEntries R
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.DHCPConditionalServingPool.{i}. C
Enable W
PoolOrder W
SourceInterface W
VendorClassID W
ClientID W
UserClassID W
Chaddr W
ChaddrMask W
LocallyServed W
MinAddress W
MaxAddress W
ReservedAddresses W
SubnetMask W
DNSServers W
DomainName W
IPRouters W
DHCPLeaseTime W
DHCPServerIPAddress W

DHCPOption:1 Profile

This table defines the DHCPOption:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement. P
DHCPOptionNumberOfEntries R
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.DHCPOption.{i}. C
Enable W
Tag W
Value W
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.DHCPConditionalServingPool.{i}. C
DHCPOptionNumberOfEntries R
InternetGatewayDevice.LANDevice.{i}.LANHostConfigManagement.DHCPConditionalServingPool.{i}.DHCPOption.{i}. C
Enable W
Tag W
Value W
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.DHCPClient. P
SentDHCPOptionNumberOfEntries R
ReqDHCPOptionNumberOfEntries R
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.DHCPClient.SentDHCPOption.{i}. C
Enable W
Tag W
Value W
InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.DHCPClient.ReqDHCPOption.{i}. C
Enable W
Tag W
Value R

MemoryStatus:1 Profile

This table defines the MemoryStatus:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.DeviceInfo.MemoryStatus. P
Total R
Free R

ProcessStatus:1 Profile

This table defines the ProcessStatus:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.DeviceInfo.ProcessStatus. P
CPUUsage R
ProcessNumberOfEntries R
InternetGatewayDevice.DeviceInfo.ProcessStatus.Process.{i}. P
PID R
Command R
Size R
Priority R
CPUTime R
State R

TempStatus:1 Profile

This table defines the TempStatus:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.DeviceInfo.TemperatureStatus. P
TemperatureSensorNumberOfEntries R
InternetGatewayDevice.DeviceInfo.TemperatureStatus.TemperatureSensor.{i}. P
Enable W
Status R
ResetTime R
Name R
Value R
LastUpdate R
MinValue R
MinTime R
MaxValue R
MaxTime R

TempStatusAdv:1 Profile

The TempStatusAdv:1 profile for the InternetGatewayDevice:1 data model is defined as the union of the TempStatus:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.DeviceInfo.TemperatureStatus.TemperatureSensor.{i}. P
Reset W
LowAlarmValue W
LowAlarmTime R
HighAlarmValue W
HighAlarmTime R

AutonXferComplPolicy:1 Profile

This table defines the AutonXferComplPolicy:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.ManagementServer.AutonomousTransferCompletePolicy. P
Enable W
TransferTypeFilter W
FileTypeFilter W

User:1 Profile

This table defines the User:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice. P
UserNumberOfEntries R
InternetGatewayDevice.User.{i}. C
Enable W
Username W
Password W

UPnPDev:1 Profile

This table defines the UPnPDev:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.UPnP. P
InternetGatewayDevice.UPnP.Device. P
Enable W
UPnPMediaServer W
UPnPMediaRenderer W
UPnPWLANAccessPoint W
UPnPQoSDevice W
UPnPQoSPolicyHolder W
UPnPIGD W
InternetGatewayDevice.UPnP.Device.Capabilities. P
UPnPArchitecture R
UPnPMediaServer R
UPnPMediaRenderer R
UPnPWLANAccessPoint R
UPnPBasicDevice R
UPnPQoSDevice R
UPnPQoSPolicyHolder R
UPnPIGD R

UPnPDiscBasic:1 Profile

This table defines the UPnPDiscBasic:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.UPnP. P
InternetGatewayDevice.UPnP.Discovery. P
RootDeviceNumberOfEntries R
InternetGatewayDevice.UPnP.Discovery.RootDevice.{i}. P
Status R
UUID R
USN R
LeaseTime R
Location R
Server R

UPnPDiscAdv:1 Profile

The UPnPDiscAdv:1 profile for the InternetGatewayDevice:1 data model is defined as the union of the UPnPDiscBasic:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.UPnP.Discovery. P
DeviceNumberOfEntries R
ServiceNumberOfEntries R
InternetGatewayDevice.UPnP.Discovery.Device.{i}. P
Status R
UUID R
USN R
LeaseTime R
Location R
Server R
InternetGatewayDevice.UPnP.Discovery.Service.{i}. P
Status R
USN R
LeaseTime R
Location R
Server R

SelfTestDiag:1 Profile

This table defines the SelfTestDiag:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.SelfTestDiagnostics. P
DiagnosticsState W
Results R

NSLookupDiag:1 Profile

This table defines the NSLookupDiag:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.NSLookupDiagnostics. P
DiagnosticsState W
Interface W
HostName W
DNSServer W
Timeout W
NumberOfRepetitions W
SuccessCount R
ResultNumberOfEntries R
InternetGatewayDevice.NSLookupDiagnostics.Result.{i}. P
Status R
AnswerType R
HostNameReturned R
IPAddresses R
DNSServerIP R
ResponseTime R

SimpleFirewall:1 Profile

This table defines the SimpleFirewall:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.Firewall. P
Config W
Version R
LastChange R

USBHostsBasic:1 Profile

This table defines the USBHostsBasic:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.USBHosts. P
HostNumberOfEntries R
InternetGatewayDevice.USBHosts.Host.{i}. P
Enable W
Name R
Type R
USBVersion R
DeviceNumberOfEntries R
InternetGatewayDevice.USBHosts.Host.{i}.Device.{i}. P
DeviceNumber R
USBVersion R
DeviceClass R
DeviceSubClass R
DeviceVersion R
DeviceProtocol R
ProductID R
VendorID R
Manufacturer R
ProductClass R
SerialNumber R
Port R
Rate R
Parent R
MaxChildren R

USBHostsAdv:1 Profile

The USBHostsAdv:1 profile for the InternetGatewayDevice:1 data model is defined as the union of the USBHostsBasic:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.USBHosts.Host.{i}. P
Reset W
PowerManagementEnable W
InternetGatewayDevice.USBHosts.Host.{i}.Device.{i}. P
IsSuspended R
IsSelfPowered R
ConfigurationNumberOfEntries R
InternetGatewayDevice.USBHosts.Host.{i}.Device.{i}.Configuration.{i}. P
ConfigurationNumber R
InterfaceNumberOfEntries R
InternetGatewayDevice.USBHosts.Host.{i}.Device.{i}.Configuration.{i}.Interface.{i}. P
InterfaceNumber R
InterfaceClass R
InterfaceSubClass R
InterfaceProtocol R

PeriodicStatsBase:1 Profile

This table defines the PeriodicStatsBase:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.PeriodicStatistics. P
MinSampleInterval R
MaxReportSamples R
SampleSetNumberOfEntries R
InternetGatewayDevice.PeriodicStatistics.SampleSet.{i}. C
Name W
SampleInterval W
ReportSamples W
ReportStartTime R
ReportEndTime R
SampleSeconds R
ParameterNumberOfEntries R
InternetGatewayDevice.PeriodicStatistics.SampleSet.{i}.Parameter.{i}. C
Reference W
SampleSeconds R
SuspectData R
Values R

PeriodicStatsAdv:1 Profile

The PeriodicStatsAdv:1 profile for the InternetGatewayDevice:1 data model is defined as the union of the PeriodicStatsBase:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.PeriodicStatistics.SampleSet.{i}. C
Enable W
Status R
TimeReference W
FetchSamples W
ForceSample W
InternetGatewayDevice.PeriodicStatistics.SampleSet.{i}.Parameter.{i}. C
Enable W
SampleMode W
CalculationMode W
LowThreshold W
HighThreshold W
Failures R

DownloadAnnounce:1 Profile

This table defines the DownloadAnnounce:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.DownloadAvailability. P
InternetGatewayDevice.DownloadAvailability.Announcement. P
Enable W
Status R
GroupNumberOfEntries R
InternetGatewayDevice.DownloadAvailability.Announcement.Group.{i}. C
Enable W
Status R
URL W

DownloadQuery:1 Profile

This table defines the DownloadQuery:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.DownloadAvailability. P
InternetGatewayDevice.DownloadAvailability.Query. P
Enable W
Status R
URL W

SupportedDataModel:1 Profile

This table defines the SupportedDataModel:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.DeviceInfo. P
SupportedDataModelNumberOfEntries R
InternetGatewayDevice.DeviceInfo.SupportedDataModel.{i}. P
URL R
URN R
Features R

TempStatusAdv:2 Profile

The TempStatusAdv:2 profile for the InternetGatewayDevice:1 data model is defined as the union of the TempStatusAdv:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.DeviceInfo.TemperatureStatus.TemperatureSensor.{i}. P
PollingInterval W

Processors:1 Profile

This table defines the Processors:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.DeviceInfo.Processor.{i}. P
Architecture R

VendorLogFiles:1 Profile

This table defines the VendorLogFiles:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.DeviceInfo.VendorLogFile.{i}. P
Name R
MaximumSize R
Persistent R

DUStateChngComplPolicy:1 Profile

This table defines the DUStateChngComplPolicy:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.ManagementServer.DUStateChangeComplPolicy. P
Enable W
OperationTypeFilter W
ResultTypeFilter W

SM_ExecEnvs:1 Profile

This table defines the SM_ExecEnvs:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.SoftwareModules. P
ExecEnvNumberOfEntries R
InternetGatewayDevice.SoftwareModules.ExecEnv.{i}. P
Enable W
Status R
Name R
Type R
Vendor R
Version R
AllocatedDiskSpace R
AvailableDiskSpace R
AllocatedMemory R
AvailableMemory R
ActiveExecutionUnits R

SM_DeployAndExecUnits:1 Profile

This table defines the SM_DeployAndExecUnits:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.SoftwareModules. P
DeploymentUnitNumberOfEntries R
ExecutionUnitNumberOfEntries R
InternetGatewayDevice.SoftwareModules.DeploymentUnit.{i}. P
UUID R
DUID R
Name R
Status R
Resolved R
URL R
Description R
Vendor R
Version R
VendorLogList R
VendorConfigList R
ExecutionUnitList R
ExecutionEnvRef R
InternetGatewayDevice.SoftwareModules.ExecutionUnit.{i}. P
EUID R
Name R
ExecEnvLabel R
Status R
RequestedState W
ExecutionFaultCode R
ExecutionFaultMessage R
Vendor R
Version R
Description R
References R
AssociatedProcessList R
VendorLogList R
VendorConfigList R
SupportedDataModelList R
ExecutionEnvRef R
InternetGatewayDevice.SoftwareModules.ExecutionUnit.{i}.Extensions. P

SM_Baseline:1 Profile

This table defines the SM_Baseline:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.SoftwareModules. P
ExecEnvNumberOfEntries R
DeploymentUnitNumberOfEntries R
ExecutionUnitNumberOfEntries R
InternetGatewayDevice.SoftwareModules.ExecEnv.{i}. P
Enable W
Status R
Name R
Type R
Vendor R
Version R
ActiveExecutionUnits R
InternetGatewayDevice.SoftwareModules.DeploymentUnit.{i}. P
UUID R
DUID R
Name R
Status R
Resolved R
URL R
Vendor R
Version R
ExecutionUnitList R
ExecutionEnvRef R
InternetGatewayDevice.SoftwareModules.ExecutionUnit.{i}. P
EUID R
Name R
ExecEnvLabel R
Status R
RequestedState W
ExecutionFaultCode R
ExecutionFaultMessage R
Vendor R
Version R
References R
SupportedDataModelList R
InternetGatewayDevice.SoftwareModules.ExecutionUnit.{i}.Extensions. P

FaultMgmtSupportedAlarms:1 Profile

This table defines the FaultMgmtSupportedAlarms:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.FaultMgmt. P
SupportedAlarmNumberOfEntries R
InternetGatewayDevice.FaultMgmt.SupportedAlarm.{i}. P
EventType R
ProbableCause R
SpecificProblem R
PerceivedSeverity R
ReportingMechanism W

FaultMgmtActive:1 Profile

This table defines the *FaultMgmtActive:1 * profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.FaultMgmt. P
CurrentAlarmNumberOfEntries R
InternetGatewayDevice.FaultMgmt.CurrentAlarm.{i}. P
AlarmIdentifier R
AlarmRaisedTime R
AlarmChangedTime R
EventType R
ProbableCause R
PerceivedSeverity R

FaultMgmtHistory:1 Profile

This table defines the FaultMgmtHistory:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.FaultMgmt. P
HistoryEventNumberOfEntries R
InternetGatewayDevice.FaultMgmt.HistoryEvent.{i}. P
EventTime R
AlarmIdentifier R
NotificationType R
EventType R
ProbableCause R
PerceivedSeverity R

FaultMgmtExpedited:1 Profile

This table defines the FaultMgmtExpedited:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.FaultMgmt. P
ExpeditedEventNumberOfEntries R
InternetGatewayDevice.FaultMgmt.ExpeditedEvent.{i}. P
EventTime R
AlarmIdentifier R
NotificationType R
EventType R
ProbableCause R
PerceivedSeverity R

FaultMgmtQueued:1 Profile

This table defines the FaultMgmtQueued:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.FaultMgmt. P
QueuedEventNumberOfEntries R
InternetGatewayDevice.FaultMgmt.QueuedEvent.{i}. P
EventTime R
AlarmIdentifier R
NotificationType R
EventType R
ProbableCause R
PerceivedSeverity R

Location:1 Profile

This table defines the Location:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.DeviceInfo. P
LocationNumberOfEntries R
InternetGatewayDevice.DeviceInfo.Location.{i}. C
Source R
AcquiredTime R
ExternalSource R
ExternalProtocol R
DataObject W

FAP_GPS:1 Profile

This table defines the FAP_GPS:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.FAP.GPS. P
ScanOnBoot W
ScanPeriodically W
PeriodicInterval W
PeriodicTime W
ContinuousGPS W
ScanTimeout W
ScanStatus R
ErrorDetails R
LastScanTime R
LastSuccessfulScanTime R
LockedLatitude R
LockedLongitude R
NumberOfSatellites R

FAP_Tunnel:1 Profile

This table defines the FAP_Tunnel:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.FAP.Tunnel. P
IKESANumberOfEntries R
ChildSANumberOfEntries R
MaxVirtualInterfaces R
VirtualInterfaceNumberOfEntries R
UseForCWMP W
MaxChildSAPerIKE R
MaxIKESessions R
InternetGatewayDevice.FAP.Tunnel.IKESA.{i}. P
Status R
PeerAddress R
CreationTime R
IPAddress R
SubnetMask R
InternetGatewayDevice.FAP.Tunnel.ChildSA.{i}. P
ParentID R
SPI R
DirectionOutbound R
CreationTime R
InternetGatewayDevice.FAP.Tunnel.VirtualInterface.{i}. P
Enable W
CryptoProfile W
DSCPMarkPolicy W
InternetGatewayDevice.FAP.Tunnel.CryptoProfile.{i}. C
Enable W
AuthMethod W
MaxChildSA W
IKEEncrypt W
IKEPRF W
IKEIntegrity W
IKEDH W
ESPEncrypt W
ESPIntegrity W

FAP_PerfMgmt:1 Profile

This table defines the FAP_PerfMgmt:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.FAP.PerfMgmt. P
ConfigNumberOfEntries R
InternetGatewayDevice.FAP.PerfMgmt.Config.{i}. P
Enable W
URL W
Username W
Password W
PeriodicUploadInterval W
PeriodicUploadTime W

FAP_ApplicationPlatform:1 Profile

This table defines the FAP_ApplicationPlatform:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.FAP.ApplicationPlatform. P
Version R
Enable W
MaxNumberOfApplications R
InternetGatewayDevice.FAP.ApplicationPlatform.Control. P
AuthenticationMethod W
InternetGatewayDevice.FAP.ApplicationPlatform.Control.FemtoAwareness. P
APIEnable W
MaxAPIUsersNumber W
FemtozoneID W
InternetGatewayDevice.FAP.ApplicationPlatform.Control.SMS. P
APIEnable W
MaxAPIUsersNumber W
MinSendSMSTimeInterval W
InternetGatewayDevice.FAP.ApplicationPlatform.Control.MMS. P
APIEnable W
MaxAPIUsersNumber W
MinSendMMSTimeInterval W
InternetGatewayDevice.FAP.ApplicationPlatform.Control.TerminalLocation. P
APIEnable W
MaxAPIUsersNumber W
QueryMobileLocationResponseAddress W
QueryMobileLocationResponseLongitudeLatitude W

BulkDataColl:1 Profile

This table defines the BulkDataColl:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.BulkData. P
Enable W
Status R
MinReportingInterval R
Protocols R
EncodingTypes R
ProfileNumberOfEntries R
InternetGatewayDevice.BulkData.Profile.{i}. C
Enable W
Alias W
Protocol W
EncodingType W
ReportingInterval W
TimeReference W
ParameterNumberOfEntries R
InternetGatewayDevice.BulkData.Profile.{i}.Parameter.{i}. C
Reference W

BulkDataStreaming:1 Profile

The BulkDataStreaming:1 profile for the InternetGatewayDevice:1 data model is defined as the union of the BulkDataColl:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.BulkData.Profile.{i}. C
StreamingHost W
StreamingPort W
StreamingSessionID W

BulkDataFileTransfer:1 Profile

The BulkDataFileTransfer:1 profile for the InternetGatewayDevice:1 data model is defined as the union of the BulkDataColl:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.BulkData.Profile.{i}. C
FileTransferURL W
FileTransferUsername W
FileTransferPassword W
ControlFileFormat W

UPnPDiscAdv:2 Profile

The UPnPDiscAdv:2 profile for the InternetGatewayDevice:1 data model is defined as the union of the UPnPDiscAdv:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.UPnP.Discovery.Device.{i}. P
LastUpdate R
Host R
InternetGatewayDevice.UPnP.Discovery.Service.{i}. P
LastUpdate R
Host R
ParentDevice R

DNS_SD:1 Profile

This table defines the DNS_SD:1 profile for the InternetGatewayDevice:1 data model. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.DNS.SD. P
Enable W
ServiceNumberOfEntries R
InternetGatewayDevice.DNS.SD.Service.{i}. P
InstanceName R
ApplicationProtocol R
TransportProtocol R
Domain R
Port R
Target R
Priority R
Weight R
TimeToLive R
Status R
LastUpdate R
Host R
TextRecordNumberOfEntries R
InternetGatewayDevice.DNS.SD.Service.{i}.TextRecord.{i}. P
Key R
Value R

SupportedDataModel:2 Profile

The SupportedDataModel:2 profile for the InternetGatewayDevice:1 data model is defined as the union of the SupportedDataModel:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is InternetGatewayDevice:1.0.

Name Requirement
InternetGatewayDevice.DeviceInfo.SupportedDataModel.{i}. P
UUID R

Generated by Broadband Forum bbfreport v2.1.0 (2024-01-18 version) on 2024-01-18 at 11:40:51 UTC.
report.py –output <stdout> –format markdown tr-098-1-6-0.xml

Table of Contents