Broadband Forum

TR-069 Device:2.0 Root Object definition

tr-181-2-0-1.xml

DATA MODEL DEFINITION

License

Copyright (c) 2010-2017, Broadband Forum

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

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

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

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

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

Data Types

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

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

Data Type Base Type Description
base64 -

Base64 encoded binary (no line-length limitation).

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

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

Hex encoded binary.

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

int -

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

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

string - For strings, a minimum and maximum allowed length can be indicated using the form string(Min:Max), where Min and Max are the minimum and maximum string length in characters. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in string(Max). Multiple comma-separated ranges can be specified, in which case the string length will be in one of the ranges.
unsignedInt -

Unsigned integer in the range 0 to 4294967295, inclusive.

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

unsignedLong -

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

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

IPAddress string(:45)

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

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

  • 216.52.29.100
  • 192.168.1.254

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

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

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

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

IPPrefix string(:49)

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

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

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

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

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

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

IPv4Address IPAddress(:45)

IPv4 address (or subnet mask).

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

  • <Empty> (an empty string)
  • [((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9]).){3}(25[0-5]|2[0-4][0-9]|[01]?0-9]?[0-9])
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])

References

[802.11-2007] IEEE Std 802.11-2007, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, 2007.
[802.11a-1999] IEEE Std 802.11a-1999, High-speed Physical Layer in the 5 GHz band, IEEE, 1999.
[802.11b-1999] IEEE Std 802.11b-1999, Higher Speed Physical Layer Extension in the 2.4 GHz band, IEEE, 1999.
[802.11g-2003] IEEE Std 802.11g-2003, Further Higher Data Rate Extension in the 2.4 GHz Band, IEEE, 2003.
[802.11h-2003] IEEE Std 802.11h-2003, Spectrum and Transmit Power Management Extensions, IEEE, 2003.
[802.11n-2009] IEEE Std 802.11n-2009, Amendment 5: Enhancements for Higher Throughput, IEEE, 2009.
[802.1D-2004] IEEE Std 802.1D-2004, Media Access Control (MAC) Bridges, IEEE, 2004.
[802.1Q-2005] IEEE Std 802.1Q-2005, Virtual Bridged Local Area Networks, IEEE, 2006.
[802.1x-2004] IEEE Std 802.1x-2004, Standards for Local and Metropolitan Area Networks: Port based Network Access Control, IEEE, 2004.
[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.
[DVB-TS.102.824] TS 102 824, Digital Video Broadcasting (DVB);Remote Management and Firmware Update System for DVB IP Services, ETSI, July 2008.
[G.993.1] G.993.1, Very high speed digital subscriber line transceivers, ITU-T.
[G.9954] G.9954, Phoneline networking transceivers - Enhanced physical, media access, and link layer specifications (HPNA 3.0 and 3.1), ITU-T, 2007.
[G.997.1] G.997.1, Physical layer management for digital subscriber line (DSL) transceivers, ITU-T.
[G.998.1] G.998.1, ATM-based Multi-Pair Bonding, ITU-T, 2005.
[G.998.2] G.998.2, Ethernet-based Multi-Pair Bonding, ITU-T, 2005.
[G.998.3] G.998.3, Multi-Pair Bonding Using Time-Division Inverse Multiplexing, ITU-T, 2005.
[HPAV1.1] HomePlug™ AV Specification, Version 1.1, HomePlug Alliance, 2007.
[HTML4.01] HTML 4.01 Specification, W3C.
[IANA-uri-schemes] IANA Uniform Resource Identifier (URI) Schemes Registry, Uniform Resource Identifier (URI) Schemes, IANA.
[ICSA-Firewall] ICSA Modular Firewall Certification Criteria, Required Services Security Policy - Small/Medium Business (SMB) Category module - version 4.0, ICSA Labs.
[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.
[ISO-13818-6:1998] ISO/IEC 13818-6:1998, Information Technology - Generic coding of moving pictures and associated audio information - Part 6: Extensions for DSM-CC, ISO, 1998.
[ISO3166-1] ISO 3166-1, Codes for the representation of names of countries and their subdivisions - Part 1: Country codes, ISO, 2006.
[MOCA11-MIB] MOCA11-MIB, Remote Management of MoCA Interfaces using SNMP MIB, MoCA Alliance, 2009.
[MoCAv1.0] MoCA v1.0, MoCA MAC/PHY Specification v1.0, MoCA Alliance, 2009.
[MoCAv1.1] MoCA v1.1, MoCA MAC/PHY Specification v1.1 Extensions, MoCA Alliance, 2009.
[OUI] Organizationally Unique Identifiers (OUIs).
[RED] References on RED (Random Early Detection) Queue Management.
[RFC1323] RFC 1323, TCP Extensions for High Performance, IETF, May 1992.
[RFC1332] RFC 1332, The PPP Internet Protocol Control Protocol (IPCP), IETF, 1992.
[RFC1661] RFC 1661, The Point-to-Point Protocol (PPP), IETF, 1994.
[RFC1877] RFC 1877, PPP Internet Protocol Control Protocol Extensions for Name Server Addresses, IETF, 1995.
[RFC1974] RFC 1974, PPP Stac LZS Compression Protocol, IETF, 1996.
[RFC2131] RFC 2131, Dynamic Host Configuration Protocol, IETF.
[RFC2132] RFC 2132, DHCP Options and BOOTP Vendor Extensions, IETF.
[RFC2225] RFC 2225, Classical IP and ARP over ATM, IETF.
[RFC2364] RFC 2364, PPP Over AAL5, IETF, 1998.
[RFC2474] RFC 2474, Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers, IETF.
[RFC2581] RFC 2581, TCP Congestion Control, IETF, April 1999.
[RFC2582] RFC 2582, The NewReno Modification to TCP’s Fast Recovery Algorithm, IETF, April 1999.
[RFC2616] RFC 2616, Hypertext Transfer Protocol - HTTP/1.1, IETF, 1999.
[RFC2684] RFC 2684, Multiprotocol Encapsulation over ATM Adaptation Layer 5, IETF.
[RFC2697] RFC 2697, A Single Rate Three Color Marker, IETF.
[RFC2698] RFC 2698, A Two Rate Three Color Marker, IETF.
[RFC2818] RFC 2818, HTTP Over TLS, IETF, May 2000.
[RFC2863] RFC 2863, The Interfaces Group MIB, IETF, 2000.
[RFC2865] RFC 2865, Remote Authentication Dial In User Service (RADIUS), IETF, 2000.
[RFC2898] RFC 2898, PKCS #5: Password-Based Cryptography Specification Version 2.0, IETF.
[RFC2974] RFC 2974, Session Announcement Protocol, IETF, October 2000.
[RFC3004] RFC 3004, The User Class Option for DHCP, IETF.
[RFC3066] RFC 3066, Tags for the Identification of Languages, IETF.
[RFC3489] RFC 3489, STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network Address Translators (NATs), IETF.
[RFC3925] RFC 3925, Vendor-Identifying Vendor Options for Dynamic Host Configuration Protocol version 4 (DHCPv4), IETF.
[RFC3926] RFC 3926, FLUTE - File Delivery over Unidirectional Transport, IETF, October 2004.
[RFC3927] RFC 3927, Dynamic Configuration of IPv4 Link-Local Addresses, IETF, 2005.
[RFC3986] RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF.
[RFC4007] RFC 4007, IPv6 Scoped Address Architecture, IETF.
[RFC4122] RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.
[RFC4291] RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006.
[RFC4632] RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan, IETF, 2006.
[RFC5625] RFC 5625, DNS Proxy Implementation Guidelines, IETF, 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.
[RFC959] RFC 959, File Transfer Protocol, IETF, 1985.
[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-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-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-159] TR-159, Management Framework for xDSL Bonding, Broadband Forum, December 2008.
[TR-181i2] TR-181 Issue 2 Amendment 15, Device Data Model, Broadband Forum, January 2022.
[UPA-PLC] Universal Powerline Association, UPA.
[UPnP-DAv1] UPnP Device Architecture, UPnP Device Architecture 1.0, UPnP Forum, April 2008.
[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.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

Legend

Object definition.
Parameter definition.

Device:2.0 Data Model

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

Name Type Write Description Object Default Version
Device. object R The top-level object for a Device. - 2.0
Interface­Stack­Number­Of­Entries unsigned­Int R The number of entries in the InterfaceStack table. - 2.0
Device.­Services. object R This object contains general services information. - 2.0
Device.­Management­Server. object R This object contains parameters relating to the CPE’s association with an ACS. - 2.0
Enable­CWMP boolean W

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

The factory default value MUST be true.

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

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

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

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

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

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

- 2.0
Upgrades­Managed boolean W Indicates whether or not the ACS will manage upgrades for the CPE. If true, the CPE SHOULD NOT use other means other than the ACS to seek out available upgrades. If false, the CPE MAY use other means for this purpose. Note that an autonomous upgrade (reported via an “10 AUTONOMOUS TRANSFER COMPLETE” Inform Event code) SHOULD be regarded as a managed upgrade if it is performed according to ACS-specified policy. - 2.0
Kick­URL string­(:256) R Present only for a CPE that supports the Kicked RPC method. LAN-accessible URL, as defined in [RFC3986], from which the CPE can be kicked to initiate the Kicked RPC method call. MUST be an absolute URL including a host name or IP address as would be used on the LAN side of the CPE. - 2.0
Download­Progress­URL string­(:256) R Present only for a CPE that provides a LAN-side web page to show progress during a file download. LAN-accessible URL, as defined in [RFC3986], to which a web-server associated with the ACS MAY redirect a user’s browser on initiation of a file download to observer the status of the download. - 2.0
Default­Active­Notification­Throttle unsigned­Int W This parameter is used to control throttling of active notifications sent by the CPE to the ACS. It defines the minimum number of seconds that the CPE MUST wait since the end of the last session with the ACS before establishing a new session for the purpose of delivering an active notification. In other words, if CPE needs to establish a new session with the ACS for the sole purpose of delivering an active notification, it MUST delay establishing such a session as needed to ensure that the minimum time since the last session completion has been met. The time is counted since the last successfully completed session, regardless of whether or not it was used for active notifications or other purposes. However, if connection to the ACS is established for purposes other than just delivering active notifications, including for the purpose of retrying a failed session, such connection MUST NOT be delayed based on this parameter value, and the pending active notifications MUST be communicated during that connection. The time of the last session completion does not need to be tracked across reboots. - 2.0
CWMPRetry­Minimum­Wait­Interval unsigned­Int­(1:65535) W Configures the first session retry wait interval, in seconds, as specified in [Section 3.2.1.1/TR-069a2]. A value of 5 corresponds to the default behavior that is described in [TR-069a2]. The device MUST use a random value between CWMPRetryMinimumWaitInterval and (CWMPRetryMinimumWaitInterval * CWMPRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. - 2.0
CWMPRetry­Interval­Multiplier unsigned­Int­(1000:65535) W Configures the retry interval multiplier as specified in [Section 3.2.1.1/TR-069a2]. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. A value of 2000 corresponds to the default behavior that is described in [TR-069a2]. The device MUST use a random value between CWMPRetryMinimumWaitInterval and (CWMPRetryMinimumWaitInterval * CWMPRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. - 2.0
UDPConnection­Request­Address 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.
- 2.0
STUNEnable boolean W Enables or disables the use of STUN by the CPE. This applies only to the use of STUN in association with the ACS to allow UDP Connection Requests. - 2.0
STUNServer­Address string­(:256) W Host name or IP address of the STUN server for the CPE to send Binding Requests if STUN is enabled via STUNEnable. If is an empty string and STUNEnable is true, the CPE MUST use the address of the ACS extracted from the host portion of the ACS URL. - 2.0
STUNServer­Port unsigned­Int­(0:65535) W Port number of the STUN server for the CPE to send Binding Requests if STUN is enabled via STUNEnable. By default, this SHOULD be the equal to the default STUN port, 3478. - 2.0
STUNUsername string­(:256) W If is not an empty string, the value of the STUN USERNAME attribute to be used in Binding Requests (only if message integrity has been requested by the STUN server). If is an empty string, the CPE MUST NOT send STUN Binding Requests with message integrity. - 2.0
STUNPassword string­(:256) W

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

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

- 2.0
STUNMaximum­Keep­Alive­Period int­(-­1:) W If STUN Is enabled, the maximum period, in seconds, that STUN Binding Requests MUST be sent by the CPE for the purpose of maintaining the binding in the Gateway. This applies specifically to Binding Requests sent from the UDP Connection Request address and port. A value of -1 indicates that no maximum period is specified. - 2.0
STUNMinimum­Keep­Alive­Period unsigned­Int W If STUN Is enabled, the minimum period, in seconds, that STUN Binding Requests can be sent by the CPE for the purpose of maintaining the binding in the Gateway. This limit applies only to Binding Requests sent from the UDP Connection Request address and port, and only those that do not contain the BINDING-CHANGE attribute. This limit does not apply to retransmissions following the procedures defined in [RFC3489]. - 2.0
NATDetected boolean R When STUN is enabled, this parameter indicates whether or not the CPE has detected address and/or port mapping in use. A true value indicates that the received MAPPED-ADDRESS in the most recent Binding Response differs from the CPE’s source address and port. When STUNEnable is false, this value MUST be false. - 2.0
Manageable­Device­Number­Of­Entries unsigned­Int R The number of entries in the ManageableDevice table. - 2.0
Device.­Management­Server.­Manageable­Device.­{i}. object(0:) R

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

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

- 2.0
Alias string­(:64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object. - 2.0
Manufacturer­OUI string­(6) R

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

  • [0-9A-F]{6} The value MUST be a valid OUI as defined in [OUI].
- 2.0
Serial­Number string­(:64) R Serial number of the Device as provided to the Gateway by the Device. - 2.0
Product­Class 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. - 2.0
Host string­(:1024)[] R Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of a row in the Hosts.Host. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. References all the Hosts.Host table entries, whether active or inactive, that correspond to this physical LAN device. There can be multiple such entries if the device has more than one network interface. For example: Device.Hosts.Host.1,Device.Hosts.Host.5 - 2.0
Device.­Management­Server.­Autonomous­Transfer­Complete­Policy. object R This object allows configuration of CPE policy for notification of AUTONOMOUS TRANSFER COMPLETE events, defined in [TR-069a2]. The CPE policy determines the conditions under which the CPE notifies the ACS of the completion of file transfers that were not specifically requested by the ACS. - 2.0
Enable boolean W Enable/disable CPE notification of AUTONOMOUS TRANSFER COMPLETE events to the ACS. - 2.0
Transfer­Type­Filter string W

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

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

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

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

Comma-separated list (maximum number of characters per item 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.
- 2.0
Device.­Management­Server.­Download­Availability. object R This object contains multicast announcement and query parameters used for the purpose of downloading files. - 2.0
Device.­Management­Server.­Download­Availability.­Announcement. object R This object contains multicast announcement parameters used to download files. - 2.0
Enable boolean W Enable/disable CPE ability to receive and use multicast announcements from a server for the purpose of downloading files. - 2.0
Status string R

The status of the announcement service. Enumeration of:

  • Disabled
  • Enabled
  • Error (MAY be used by the CPE to indicate a locally defined error condition, OPTIONAL)
- 2.0
Group­Number­Of­Entries unsigned­Int R The number of entries in the Group table. - 2.0
Device.­Management­Server.­Download­Availability.­Announcement.­Group.­{i}. object(0:) W

Multicast groups to which the CPE SHOULD listen for announcements.

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

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

The status of this group table entry. Enumeration of:

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

The status of the query service. Enumeration of:

  • Disabled
  • Enabled
  • Error (MAY be used by the CPE to indicate a locally defined error condition, e.g. unable to contact query response server, OPTIONAL)
- 2.0
URL string­(:256) W URL [RFC3986] of the query response server. Depending on the application, the protocol described by this URL MAY be a SOAP interface, or MAY be any other RPC mechanism. Refer to [DVB-TS.102.824] for an example of a URL format that identifies a SOAP interface running over HTTP or HTTPS. - 2.0
Device.­Gateway­Info. object R This object contains information associated with a connected Internet Gateway Device. - 2.0
Manufacturer­OUI string­(:6) R

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

  • <Empty> (an empty string)
  • [0-9A-F]{6} an empty string indicates that there is no associated Internet Gateway Device that has been detected.
- 2.0
Product­Class string­(:64) R Identifier of the product class of the associated Internet Gateway Device. An empty string indicates either that there is no associated Internet Gateway Device that has been detected, or the Internet Gateway Device does not support the use of the product-class parameter. - 2.0
Serial­Number string­(:64) R Serial number of the associated Internet Gateway Device. An empty string indicates that there is no associated Internet Gateway Device that has been detected. - 2.0
Device.­Interface­Stack.­{i}. object(0:) R

This table contains information about the relationships between the multiple layers of interface objects ([Section 4.3/TR-181i2]). In particular, it contains information on which interfaces run on top of which other interfaces. This table is auto-generated by the CPE based on the LowerLayers parameters on individual interface objects. Each table row represents a “link” between two interface objects, a higher-layer interface object (referenced by HigherLayer) and a lower-layer interface object (referenced by LowerLayer). Consequently, if a referenced interface object is deleted, the CPE MUST delete the corresponding Device.InterfaceStack.{i}. row(s) that had referenced it.

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

- 2.0
Higher­Layer string­(:256) R A reference to the interface object corresponding to the higher layer of the relationship, i.e. the interface which runs on top of the interface identified by the corresponding instance of LowerLayer. When the referenced higher layer interface is deleted, the CPE MUST delete the table row. - 2.0
Lower­Layer string­(:256) R A reference to the interface object corresponding to the lower layer of the relationship, i.e. the interface which runs below the interface identified by the corresponding instance of HigherLayer. When the referenced lower layer interface is deleted, the CPE MUST delete the table row. - 2.0
Higher­Alias string­(:64) R The value of the Alias parameter for the interface object referenced by HigherLayer. - 2.0
Lower­Alias string­(:64) R The value of the Alias parameter for the interface object referenced by LowerLayer. - 2.0
Device.­DSL. object R This object models DSL lines, DSL channels, DSL bonding, and DSL diagnostics. The specific interface objects defined here are Line, Channel, and BondingGroup. Each Line models a layer 1 DSL Line interface, and each Channel models a layer 1 DSL Channel interface where multiple channels can run over a DSL line. In the case where bonding is configured, it is expected that BondingGroup is stacked above the Channel instances within its group. - 2.0
Line­Number­Of­Entries unsigned­Int R The number of entries in the Line table. - 2.0
Channel­Number­Of­Entries unsigned­Int R The number of entries in the Channel table. - 2.0
Bonding­Group­Number­Of­Entries unsigned­Int R The number of entries in the BondingGroup table. - 2.0
Device.­DSL.­Line.­{i}. object(0:) R

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

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

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

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863].
- 2.0
Alias string­(:64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object. - 2.0
Name string­(:64) R The textual name of the DSL line as assigned by the CPE. - 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the DSL line entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Device.DSL.Line.{i}. is a layer 1 interface, it is expected that LowerLayers will not be used. - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.0
Firmware­Version string­(:64) R A string identifying the version of the modem firmware currently installed for this interface. This is applicable only when the modem firmware is separable from the overall CPE software. - 2.0
Link­Status string R

Status of the DSL physical link. Enumeration of:

- 2.0
Standards­Supported string­[] R

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

  • G.992.1_Annex_A
  • G.992.1_Annex_B
  • G.992.1_Annex_C
  • T1.413
  • T1.413i2
  • ETSI_101_388
  • G.992.2
  • G.992.3_Annex_A
  • G.992.3_Annex_B
  • G.992.3_Annex_C
  • G.992.3_Annex_I
  • G.992.3_Annex_J
  • G.992.3_Annex_L
  • G.992.3_Annex_M
  • G.992.4
  • G.992.5_Annex_A
  • G.992.5_Annex_B
  • G.992.5_Annex_C
  • G.992.5_Annex_I
  • G.992.5_Annex_J
  • G.992.5_Annex_M
  • G.993.1
  • G.993.1_Annex_A
  • G.993.2_Annex_A
  • G.993.2_Annex_B
  • G.993.2_Annex_C Note: In G.997.1, this parameter is called “xDSL Transmission system capabilities”. See ITU-T Recommendation [G.997.1].
- 2.0
Standard­Used string R The value MUST be a member of the list reported by the StandardsSupported parameter. Indicates the standard that the Device.DSL.Line.{i}. instance is using for the connection. Note: In G.997.1, this parameter is called “xDSL Transmission system”. See ITU-T Recommendation [G.997.1]. - 2.0
Line­Encoding string R

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

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

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

  • 8a
  • 8b
  • 8c
  • 8d
  • 12a
  • 12b
  • 17a
  • 17b
  • 30a Note: In G.997.1, this parameter is called PROFILES. See ITU-T Recommendation [G.997.1]. Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be an empty string.
- 2.0
Current­Profile string R The value MUST be a member of the list reported by the AllowedProfiles parameter, or else be an empty string. Indicates which VDSL2 profile is currently in use on the line. Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be an empty string. - 2.0
Power­Management­State string R

The power management state of the line. Enumeration of:

  • L0
  • L1
  • L2
  • L3
  • L4 Note: See ITU-T Recommendation [G.997.1].
- 2.0
Success­Failure­Cause unsigned­Int­(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. Note: In G.997.1, this parameter is called “Initialization success/failure cause”. See ITU-T Recommendation [G.997.1].
- 2.0
Last­State­Transmitted­Downstream unsigned­Int R This parameter represents the last successful transmitted initialization state in the downstream direction in the last full initialization performed on the line. Initialization states are defined in the individual xDSL Recommendations and are counted from 0 (if G.994.1 is used) or 1 (if G.994.1 is not used) up to Showtime. This parameter needs to be interpreted along with the xDSL Transmission System. This parameter is available only when, after a failed full initialization, the line diagnostics procedures are activated on the line. Note: See ITU-T Recommendation [G.997.1]. - 2.0
Last­State­Transmitted­Upstream unsigned­Int R This parameter represents the last successful transmitted initialization state in the upstream direction in the last full initialization performed on the line. Initialization states are defined in the individual xDSL Recommendations and are counted from 0 (if G.994.1 is used) or 1 (if G.994.1 is not used) up to Showtime. This parameter needs to be interpreted along with the xDSL Transmission System. This parameter is available only when, after a failed full initialization, the line diagnostics procedures are activated on the line. Note: See ITU-T Recommendation [G.997.1]. - 2.0
UPBOKLE unsigned­Int­(0:1280) R This parameter contains the estimated electrical loop length expressed in 0.1dB at 1MHz (see O-UPDATE in section 12.2.4.2.1.2/G.993.2). The value SHALL be coded as an unsigned 16 bit number in the range 0 (coded as 0) to 128 dB (coded as 1280) in steps of 0.1 dB. Note: See ITU-T Recommendation [G.997.1]. - 2.0
MREFPSDds base­64(0:145) R This parameter SHALL contain the set of breakpoints exchanged in the MREFPSDds fields of the O-PRM message of G.993.2. Base64 encoded of the binary representation defined in Table 12-19/G.993.2 (maximum length is 145 octets, which requires 196 bytes for Base64 encoding). Note: See ITU-T Recommendation [G.997.1]. - 2.0
MREFPSDus base­64(0:145) R This parameter SHALL contain the set of breakpoints exchanged in the MREFPSDus fields of the R-PRM message of G.993.2. Base64 encoded of the binary representation defined in Table 12-19/G.993.2 (maximum length is 145 octets, which requires 196 bytes for Base64 encoding). Note: See ITU-T Recommendation [G.997.1]. - 2.0
LIMITMASK unsigned­Int R Indicates the enabled VDSL2 Limit PSD mask of the selected PSD mask class. Bit mask as specified in ITU-T Recommendation G.997.1. Note: For a VDSL2-capable multimode device operating in a mode other than VDSL2, the value of this parameter SHOULD be set to 0. Note: See ITU-T Recommendation [G.997.1]. - 2.0
US0MASK unsigned­Int R Indicates the allowed VDSL2 US0 PSD masks for Annex A operation. Bit mask as specified in see ITU-T Recommendation G.997.1. Note: For a VDSL2-capable multimode device operating in a mode other than VDSL2, the value of this parameter SHOULD be set to 0. Note: See ITU-T Recommendation [G.997.1]. - 2.0
TRELLISds int R Reports whether trellis coding is enabled in the downstream direction. A value of 1 indicates that trellis coding is in use, and a value of 0 indicates that the trellis is disabled. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1. - 2.0
TRELLISus int R Reports whether trellis coding is enabled in the upstream direction. A value of 1 indicates that trellis coding is in use, and a value of 0 indicates that the trellis is disabled. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1. - 2.0
ACTSNRMODEds unsigned­Int R Reports whether the OPTIONAL virtual noise mechanism is in use in the downstream direction. A value of 1 indicates the virtual noise mechanism is not in use, and a value of 2 indicates the virtual noise mechanism is in use. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 2.0
ACTSNRMODEus unsigned­Int R Reports whether the OPTIONAL virtual noise mechanism is in use in the upstream direction. A value of 1 indicates the virtual noise mechanism is not in use, and a value of 2 indicates the virtual noise mechanism is in use. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 2.0
Virtual­Noise­PSDds base­64(0:97) R Reports the virtual noise PSD for the downstream direction. Base64 encoded of the binary representation defined in G.997.1 by the parameter called TXREFVNds (maximum length is 97 octets, which requires 132 bytes for Base64 encoding). See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to an empty string. - 2.0
Virtual­Noise­PSDus base­64(0:49) R Reports the virtual noise PSD for the upstream direction. Base64 encoded of the binary representation defined in G.997.1by the parameter called TXREFVNus (maximum length is 49 octets, which requires 68 bytes for Base64 encoding). See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to an empty string. - 2.0
ACTUALCE unsigned­Int R Reports the actual cyclic extension, as the value of m, in use for the connection. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 99. - 2.0
Line­Number int­(1:) R Signifies the line pair that the modem is using to connection. LineNumber = 1 is the innermost pair. - 2.0
Upstream­Max­Bit­Rate unsigned­Int R The current maximum attainable data rate upstream (expressed in Kbps). Note: This parameter is related to the G.997.1 parameter ATTNDRus, which is measured in bits/s. See ITU-T Recommendation [G.997.1]. - 2.0
Downstream­Max­Bit­Rate unsigned­Int R The current maximum attainable data rate downstream (expressed in Kbps). Note: This parameter is related to the G.997.1 parameter ATTNDRds, which is measured in bits/s. See ITU-T Recommendation [G.997.1]. - 2.0
Upstream­Noise­Margin int R The current signal-to-noise ratio margin (expressed in 0.1dB) in the upstream direction. Note: In G.997.1, this parameter is called SNRMus. See ITU-T Recommendation [G.997.1]. - 2.0
Downstream­Noise­Margin int R The current signal-to-noise ratio margin (expressed in 0.1dB) in the downstream direction. Note: In G.997.1, this parameter is called SNRMds. See ITU-T Recommendation [G.997.1]. - 2.0
SNRMpbus string­(:24)[] R Comma-separated list (maximum number of characters per item 24) of strings. Indicates the current signal-to-noise ratio margin of each upstream band. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
SNRMpbds string­(:24)[] R Comma-separated list (maximum number of characters per item 24) of strings. Indicates the current signal-to-noise ratio margin of each band. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
INMIATOds unsigned­Int­(3:511) R The Impulse Noise Monitoring (INM) Inter Arrival Time (IAT) Offset, measured in DMT symbols, that the xTU receiver uses to determine in which bin of the IAT histogram the IAT is reported. Note: In G.997.1, this parameter is called INMIATO. See ITU-T Recommendation [G.997.1]. - 2.0
INMIATSds unsigned­Int­(0:7) R The Impulse Noise Monitoring (INM) Inter Arrival Time (IAT) Step that the xTU receiver uses to determine in which bin of the IAT histogram the IAT is reported. Note: In G.997.1, this parameter is called INMIATS. See ITU-T Recommendation [G.997.1]. - 2.0
INMCCds unsigned­Int­(0:64) R The Impulse Noise Monitoring (INM) Cluster Continuation value, measured in DMT symbols, that the xTU receiver uses in the cluster indication process. Note: In G.997.1, this parameter is called INMCC. See ITU-T Recommendation [G.997.1]. - 2.0
INMINPEQMODEds unsigned­Int­(0:3) R The Impulse Noise Monitoring (INM) Equivalent Impulse Noise Protection (INP) Mode that the xTU receiver uses in the computation of the Equivalent INP. Note: In G.997.1, this parameter is called INM_INPEQ_MODE. See ITU-T Recommendation [G.997.1]. - 2.0
Upstream­Attenuation int R The current upstream signal loss (expressed in 0.1dB). - 2.0
Downstream­Attenuation int R The current downstream signal loss (expressed in 0.1dB). - 2.0
Upstream­Power int R The current output power at the CPE’s DSL line (expressed in 0.1dBmV). - 2.0
Downstream­Power int R The current received power at the CPE’s DSL line (expressed in 0.1dBmV). - 2.0
XTURVendor hex­Binary­(4) R xTU-R vendor identifier as defined in G.994.1 and T1.413. In the case of G.994.1 this corresponds to the four-octet provider code, which MUST be represented as eight hexadecimal digits. Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, it MUST have the value “00000000”. Note: In G.997.1, this parameter is called “xTU-R G.994.1 Vendor ID”. See ITU-T Recommendation [G.997.1]. - 2.0
XTURCountry hex­Binary­(2) R T.35 country code of the xTU-R vendor as defined in G.994.1, where the two-octet value defined in G.994.1 MUST be represented as four hexadecimal digits. Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, it MUST have the value “0000”. Note: In G.997.1, this parameter is called “xTU-R G.994.1 Vendor ID”. See ITU-T Recommendation [G.997.1]. - 2.0
XTURANSIStd unsigned­Int R xTU-R T1.413 Revision Number as defined in T1.413 Issue 2. When T1.413 modulation is not in use, the parameter value SHOULD be 0. - 2.0
XTURANSIRev unsigned­Int R xTU-R Vendor Revision Number as defined in T1.413 Issue 2. When T1.413 modulation is not in use, the parameter value SHOULD be 0. - 2.0
XTUCVendor hex­Binary­(4) R xTU-C vendor identifier as defined in G.994.1 and T1.413. In the case of G.994.1 this corresponds to the four-octet provider code, which MUST be represented as eight hexadecimal digits. Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, it MUST have the value “00000000”. - 2.0
XTUCCountry hex­Binary­(2) R T.35 country code of the xTU-C vendor as defined in G.994.1, where the two-octet value defined in G.994.1 MUST be represented as four hexadecimal digits. Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, it MUST have the value “0000”. - 2.0
XTUCANSIStd unsigned­Int R xTU-C T1.413 Revision Number as defined in T1.413 Issue 2. When T1.413 modulation is not in use, the parameter value SHOULD be 0. - 2.0
XTUCANSIRev unsigned­Int R xTU-C Vendor Revision Number as defined in T1.413 Issue 2. When T1.413 modulation is not in use, the parameter value SHOULD be 0. - 2.0
Device.­DSL.­Line.­{i}.­Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Discard­Packets­Sent unsigned­Int 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. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Total­Start unsigned­Int R DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of Total statistics. Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible. Note: TotalStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
Showtime­Start unsigned­Int R DSL-specific statistic. The Number of seconds since the most recent DSL Showtime - the beginning of the period used for collection of Showtime statistics. Showtime is defined as successful completion of the DSL link establishment process. The Showtime statistics are those collected since the most recent establishment of the DSL link. Note: ShowtimeStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
Last­Showtime­Start unsigned­Int R DSL-specific statistic. The Number of seconds since the second most recent DSL Showtime-the beginning of the period used for collection of LastShowtime statistics. If the CPE has not retained information about the second most recent Showtime (e.g., on reboot), the start of LastShowtime statistics MAY temporarily coincide with the start of Showtime statistics. Note: LastShowtimeStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
Current­Day­Start unsigned­Int R DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of CurrentDay statistics. The CPE MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so. Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible. Note: CurrentDayStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
Quarter­Hour­Start unsigned­Int R DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of QuarterHour statistics. The CPE MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so. Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible. Note: QuarterHourStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
Device.­DSL.­Line.­{i}.­Stats.­Total. object R This object contains DSL line total statistics. See [Chapter 7.2.6/G.997.1]. Note: The Device.DSL.Line.{i}.Stats.Total. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
Errored­Secs unsigned­Int 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). - 2.0
Severely­Errored­Secs unsigned­Int 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). - 2.0
Device.­DSL.­Line.­{i}.­Stats.­Showtime. object R This object contains DSL line statistics accumulated since the most recent DSL Showtime. See [Chapter 7.2.6/G.997.1]. Note: The Device.DSL.Line.{i}.Stats.Showtime. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
Errored­Secs unsigned­Int 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). - 2.0
Severely­Errored­Secs unsigned­Int 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). - 2.0
Device.­DSL.­Line.­{i}.­Stats.­Last­Showtime. object R This object contains DSL line statistics accumulated since the second most recent DSL Showtime. See [Chapter 7.2.6/G.997.1]. Note: The Device.DSL.Line.{i}.Stats.LastShowtime. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
Errored­Secs unsigned­Int 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). - 2.0
Severely­Errored­Secs unsigned­Int 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). - 2.0
Device.­DSL.­Line.­{i}.­Stats.­Current­Day. object R This object contains DSL line statistics accumulated during the current day. See [Chapter 7.2.6/G.997.1]. Note: The Device.DSL.Line.{i}.Stats.CurrentDay. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
Errored­Secs unsigned­Int 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). - 2.0
Severely­Errored­Secs unsigned­Int 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). - 2.0
Device.­DSL.­Line.­{i}.­Stats.­Quarter­Hour. object R This object contains DSL line statistics accumulated during the current quarter hour. See [Chapter 7.2.6/G.997.1]. Note: The Device.DSL.Line.{i}.Stats.QuarterHour. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
Errored­Secs unsigned­Int 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). - 2.0
Severely­Errored­Secs unsigned­Int 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). - 2.0
Device.­DSL.­Line.­{i}.­Test­Params. object R This object contains the DSL line test parameters that are available during the L0 (i.e., Showtime) state. - 2.0
HLOGGds unsigned­Int 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. - 2.0
HLOGGus unsigned­Int 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. - 2.0
HLOGpsds string­(:2559)[] R Comma-separated list (maximum number of characters per item 2559) of strings. Indicates the downstream logarithmic line characteristics per sub-carrier group. The maximum number of elements is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGds but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: HLOGpsds is measured during initialization and is not updated during Showtime. - 2.0
HLOGpsus string­(:2559)[] R Comma-separated list (maximum number of characters per item 2559) of strings. Indicates the upstream logarithmic line characteristics per sub-carrier group. The maximum number of elements is 64 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: HLOGpsus is measured during initialization and is not updated during Showtime. - 2.0
HLOGMTds unsigned­Int 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. - 2.0
HLOGMTus unsigned­Int 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. - 2.0
QLNGds unsigned­Int 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. - 2.0
QLNGus unsigned­Int 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. - 2.0
QLNpsds int­(:2047)[] R Comma-separated list (maximum number of characters per item 2047) of integers. Indicates the downstream quiet line noise per subcarrier group. The maximum number of elements is 256 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of QLNGds but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: QLNpsds is measured during initialization and is not updated during Showtime. - 2.0
QLNpsus string­(:2047)[] R Comma-separated list (maximum number of characters per item 2047) of strings. Indicates the upstream quiet line noise per subcarrier group. The maximum number of elements is 64 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of QLNGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: QLNpsus is measured during initialization and is not updated during Showtime. - 2.0
QLNMTds unsigned­Int 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. - 2.0
QLNMTus unsigned­Int 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. - 2.0
SNRGds unsigned­Int 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. - 2.0
SNRGus unsigned­Int 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. - 2.0
SNRpsds int­(:2047)[] R Comma-separated list (maximum number of characters per item 2047) of integers. Indicates the downstream SNR per subcarrier group. The maximum number of elements is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of elements will depend on the value of SNRGds but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: SNRpsds is first measured during initialization and is updated during Showtime. - 2.0
SNRpsus string­(:2047)[] R Comma-separated list (maximum number of characters per item 2047) of strings. Indicates the upstream SNR per subcarrier group. The maximum number of elements is 64 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of SNRGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: SNRpsus is first measured during initialization and is updated during Showtime. - 2.0
SNRMTds unsigned­Int 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. - 2.0
SNRMTus unsigned­Int 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. - 2.0
LATNds string­(:24)[] R Comma-separated list (maximum number of characters per item 24) of strings. Indicates the downstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of LATNds is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
LATNus string­(:24)[] R Comma-separated list (maximum number of characters per item 24) of strings. Indicates the upstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of upstream bands but will exceed one only for G.993.2. Interpretation of LATNus is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
SATNds string­(:24)[] R Comma-separated list (maximum number of characters per item 24) of strings. Indicates the downstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNds is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
SATNus string­(:24)[] R Comma-separated list (maximum number of characters per item 24) of strings. Indicates the upstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNus is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
Device.­DSL.­Channel.­{i}. object(0:) R

DSL Channel table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models DSL channel(s) on top of physical DSL lines.

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

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

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863].
- 2.0
Alias string­(:64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object. - 2.0
Name string­(:64) R The textual name of the channel as assigned by the CPE. - 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the channel entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] R Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. - 2.0
Link­Encapsulation­Supported string­[] R

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

  • G.992.3_Annex_K_ATM
  • G.992.3_Annex_K_PTM
  • G.993.2_Annex_K_ATM
  • G.993.2_Annex_K_PTM
  • G.994.1 (Auto)
- 2.0
Link­Encapsulation­Used string R

Indicates the link encapsulation standard that the Device.DSL.Channel.{i}. instance is using for the connection. Enumeration of:

  • G.992.3_Annex_K_ATM
  • G.992.3_Annex_K_PTM
  • G.993.2_Annex_K_ATM
  • G.993.2_Annex_K_PTM When ATM encapsulation is identified then an upper-layer ATM.Link interface MUST be used. When PTM encapsulation is identified then an upper-layer PTM.Link interface MUST be used.
- 2.0
LPATH unsigned­Int­(:3) R Reports the index of the latency path supporting the bearer channel. Note: See ITU-T Recommendation [Section 7.5.2.7/G.997.1]. - 2.0
INTLVDEPTH unsigned­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 0. - 2.0
INTLVBLOCK int R Reports the interleaver block length in use on the latency path indicated in LPATH. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1. - 2.0
Actual­Interleaving­Delay unsigned­Int R Reports the actual delay, in milliseconds, of the latency path due to interleaving. Note: In G.997.1, this parameter is called “Actual Interleaving Delay.” See ITU-T Recommendation [G.997.1]. - 2.0
ACTINP int R Reports the actual impulse noise protection (INP) provided by the latency path indicated in LPATH. The value is the actual INP in the L0 (i.e., Showtime) state. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1. - 2.0
INPREPORT boolean R Reports whether the value reported in ACTINP was computed assuming the receiver does not use erasure decoding. Valid values are 0 (computed per the formula assuming no erasure decoding) and 1 (computed by taking into account erasure decoding capabilities of receiver). Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to false. - 2.0
NFEC int R Reports the size, in octets, of the Reed-Solomon codeword in use on the latency path indicated in LPATH. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1. - 2.0
RFEC int R Reports the number of redundancy bytes per Reed-Solomon codeword on the latency path indicated in LPATH. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1. - 2.0
LSYMB int R Reports the number of bits per symbol assigned to the latency path indicated in LPATH. This value does not include overhead due to trellis coding. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to -1. - 2.0
Upstream­Curr­Rate unsigned­Int R The current physical layer aggregate data rate (expressed in Kbps) of the upstream DSL connection. Note: If the parameter is implemented but no value is available, it MUST have the value 4294967295 (the maximum for its data type). - 2.0
Downstream­Curr­Rate unsigned­Int R The current physical layer aggregate data rate (expressed in Kbps) of the downstream DSL connection. Note: If the parameter is implemented but no value is available, it MUST have the value 4294967295 (the maximum for its data type). - 2.0
Device.­DSL.­Channel.­{i}.­Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Discard­Packets­Sent unsigned­Int 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. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Total­Start unsigned­Int R DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of Total statistics. Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible. Note: TotalStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
Showtime­Start unsigned­Int R DSL-specific statistic. The Number of seconds since the most recent DSL Showtime - the beginning of the period used for collection of Showtime statistics. Showtime is defined as successful completion of the DSL link establishment process. The Showtime statistics are those collected since the most recent establishment of the DSL link. Note: ShowtimeStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
Last­Showtime­Start unsigned­Int R DSL-specific statistic. The Number of seconds since the second most recent DSL Showtime-the beginning of the period used for collection of LastShowtime statistics. If the CPE has not retained information about the second most recent Showtime (e.g., on reboot), the start of LastShowtime statistics MAY temporarily coincide with the start of Showtime statistics. Note: LastShowtimeStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
Current­Day­Start unsigned­Int R DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of CurrentDay statistics. The CPE MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so. Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible. Note: CurrentDayStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
Quarter­Hour­Start unsigned­Int R DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of QuarterHour statistics. The CPE MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so. Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible. Note: QuarterHourStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
Device.­DSL.­Channel.­{i}.­Stats.­Total. object R This object contains DSL channel total statistics [G.997.1]. Note: The Device.DSL.Channel.{i}.Stats.Total. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
XTURFECErrors unsigned­Int R Total number of FEC errors detected (FEC-C as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTUCFECErrors unsigned­Int R Total number of FEC errors detected by the ATU-C (FEC-CFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTURHECErrors unsigned­Int R Total number of HEC errors detected (HEC-P as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTUCHECErrors unsigned­Int R Total number of HEC errors detected by the ATU-C (HEC-PFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTURCRCErrors unsigned­Int R Total number of CRC errors detected (CV-C as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTUCCRCErrors unsigned­Int R Total number of CRC errors detected by the ATU-C (CV-CFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
Device.­DSL.­Channel.­{i}.­Stats.­Showtime. object R This object contains DSL channel statistics accumulated since the most recent DSL Showtime [G.997.1]. Note: The Device.DSL.Channel.{i}.Stats.Showtime. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
XTURFECErrors unsigned­Int R Number of FEC errors detected since the most recent DSL Showtime (FEC-C as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTUCFECErrors unsigned­Int R Number of FEC errors detected by the ATU-C since the most recent DSL Showtime (FEC-CFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTURHECErrors unsigned­Int R Number of HEC errors detected since the most recent DSL Showtime (HEC-P as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTUCHECErrors unsigned­Int R Number of HEC errors detected by the ATU-C since the most recent DSL Showtime (HEC-PFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTURCRCErrors unsigned­Int R Number of CRC errors detected since the most recent DSL Showtime (CV-C as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTUCCRCErrors unsigned­Int R Number of CRC errors detected by the ATU-C since the most recent DSL Showtime (CV-CFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
Device.­DSL.­Channel.­{i}.­Stats.­Last­Showtime. object R This object contains DSL channel statistics accumulated since the second most recent DSL Showtime [G.997.1]. Note: The Device.DSL.Channel.{i}.Stats.LastShowtime. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
XTURFECErrors unsigned­Int R Number of FEC errors detected since the second most recent DSL Showtime (FEC-C as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTUCFECErrors unsigned­Int R Number of FEC errors detected by the ATU-C since the second most recent DSL Showtime (FEC-CFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTURHECErrors unsigned­Int R Number of HEC errors detected since the second most recent DSL Showtime (HEC-P as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTUCHECErrors unsigned­Int R Number of HEC errors detected by the ATU-C since the second most recent DSL Showtime (HEC-PFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTURCRCErrors unsigned­Int R Number of CRC errors detected since the second most recent DSL Showtime (CV-C as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTUCCRCErrors unsigned­Int R Number of CRC errors detected by the ATU-C since the second most recent DSL Showtime (CV-CFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
Device.­DSL.­Channel.­{i}.­Stats.­Current­Day. object R This object contains DSL channel statistics accumulated during the current day [G.997.1]. Note: The Device.DSL.Channel.{i}.Stats.CurrentDay. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
XTURFECErrors unsigned­Int R Number of FEC errors detected since the second most recent DSL Showtime (FEC-C as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTUCFECErrors unsigned­Int R Number of FEC errors detected by the ATU-C since the second most recent DSL Showtime (FEC-CFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTURHECErrors unsigned­Int R Number of HEC errors detected since the second most recent DSL Showtime (HEC-P as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTUCHECErrors unsigned­Int R Number of HEC errors detected by the ATU-C since the second most recent DSL Showtime (HEC-PFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTURCRCErrors unsigned­Int R Number of CRC errors detected since the second most recent DSL Showtime (CV-C as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTUCCRCErrors unsigned­Int R Number of CRC errors detected by the ATU-C since the second most recent DSL Showtime (CV-CFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
Device.­DSL.­Channel.­{i}.­Stats.­Quarter­Hour. object R This object contains DSL channel statistics accumulated during the current quarter hour [G.997.1]. Note: The Device.DSL.Channel.{i}.Stats.QuarterHour. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
XTURFECErrors unsigned­Int R Number of FEC errors detected since the second most recent DSL Showtime (FEC-C as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTUCFECErrors unsigned­Int R Number of FEC errors detected by the ATU-C since the second most recent DSL Showtime (FEC-CFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTURHECErrors unsigned­Int R Number of HEC errors detected since the second most recent DSL Showtime (HEC-P as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTUCHECErrors unsigned­Int R Number of HEC errors detected by the ATU-C since the second most recent DSL Showtime (HEC-PFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTURCRCErrors unsigned­Int R Number of CRC errors detected since the second most recent DSL Showtime (CV-C as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
XTUCCRCErrors unsigned­Int R Number of CRC errors detected by the ATU-C since the second most recent DSL Showtime (CV-CFE as defined in ITU-T Rec. [G.997.1]). Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type). - 2.0
Device.­DSL.­Bonding­Group.­{i}. object(0:) R

DSL bonding group table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each instance is a bonding group, and is expected to be stacked above a Channel instance for each bonded channel in the group. Many of the parameters within this object, including LowerLayers, are read-only because bonding is not expected to be configured via [TR-069]. The DSL bonding data model is closely aligned with [TR-159]. Corresponds to [TR-159] oBondingGroup.

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

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

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863].
- 2.0
Alias string­(:64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object. - 2.0
Name string­(:64) R The textual name of the bonding group as assigned by the CPE. - 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the bonding group entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] R Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. LowerLayers is read-only for this object because bonding is expected to be configured by the CPE, not by the ACS. - 2.0
Group­Status string­[] R

Comma-separated list of strings. Indicates the current fault status of the DSL bonding group. Each list item is an enumeration of:

  • NoPeer (Peer physical layer is unreachable)
  • PeerPowerLoss (Local device received a “dying gasp” message (preceding a loss-of-power) from the peer device)
  • PeerBondSchemeMismatch (Operating bonding scheme of the peer port is different from the local one)
  • LowRate (Upstream or downstream data rate is at or below threshold) Corresponds to [TR-159] oBondingGroup.aGroupStatus.
- 2.0
Group­ID unsigned­Int R DSL bonding group ID. Corresponds to [TR-159] oBondingGroup.aGroupID. - 2.0
Bond­Schemes­Supported string­[] R

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

  • ATM ([G.998.1] ATM-based bonding)
  • Ethernet ([G.998.2] Ethernet-based bonding)
  • TDIM ([G.998.3] TDIM-based bonding) Corresponds to [TR-159] oBondingGroup.aGroupBondSchemesSupported.
- 2.0
Bond­Scheme string R The value MUST be a member of the list reported by the BondSchemesSupported parameter. Currently operating bonding scheme. Corresponds to [TR-159] aGroupOperBondScheme. - 2.0
Group­Capacity unsigned­Int­(1:32) R DSL bonding group capacity, i.e. the maximum number of channels that can be bonded in this group. Corresponds to [TR-159] oBondingGroup.aGroupCapacity. - 2.0
Running­Time unsigned­Int R The accumulated time in seconds for which this bonding group has been operationally up. Corresponds to [Section 11.4.2/G.998.1] Group Running Time. - 2.0
Target­Up­Rate unsigned­Int R Desired upstream data rate in bits per second for this DSL bonding group (zero indicates best effort). Corresponds to [TR-159] oBondingGroup.aGroupTargetUpRate. - 2.0
Target­Down­Rate unsigned­Int R Desired downstream data rate in bits per second for DSL bonding group (zero indicates best effort). Corresponds to [TR-159] oBondingGroup.aGroupTargetDownRate. - 2.0
Thresh­Low­Up­Rate unsigned­Int R Threshold upstream data rate in bits per second for this DSL bonding group. GroupStatus will include LowRate whenever the upstream rate is less than this threshold. Corresponds to [TR-159] oBondingGroup.aGroupThreshLowUpRate. - 2.0
Thresh­Low­Down­Rate unsigned­Int R Threshold downstream data rate in bits per second for this DSL bonding group. GroupStatus will include LowRate whenever the downstream rate is less than this threshold. Corresponds to [TR-159] oBondingGroup.aGroupThreshLowDownRate. - 2.0
Upstream­Differential­Delay­Tolerance unsigned­Int R The maximum upstream differential delay in milliseconds among member links in a bonding group. Corresponds to [Section 11.4.1/G.998.1] Differential Delay Tolerance. - 2.0
Downstream­Differential­Delay­Tolerance unsigned­Int R The maximum downstream differential delay in milliseconds among member links in a bonding group. Corresponds to [Section 11.4.1/G.998.1] Differential Delay Tolerance. - 2.0
Bonded­Channel­Number­Of­Entries unsigned­Int­(1:32) R The number of entries in the BondedChannel table. Corresponds to [TR-159] oBondingGroup.aGroupNumChannels. - 2.0
Device.­DSL.­Bonding­Group.­{i}.­Bonded­Channel.­{i}. object(0:) R

DSL bonded channel table. Each table entry represents a bonded channel within the bonding group, and is associated with exactly one Channel instance. There MUST be an instance of Device.DSL.BondingGroup.{i}.BondedChannel.{i}. for each DSL channel that is bonded. When a Channel is no longer bonded, then the CPE MUST delete the corresponding Device.DSL.BondingGroup.{i}.BondedChannel.{i}. instance. However, when a bonded Channel becomes disabled, the channel remains bonded and so the corresponding Device.DSL.BondingGroup.{i}.BondedChannel.{i}. instance MUST NOT be deleted.

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

- 2.0
Alias string­(:64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object. - 2.0
Channel string­(:256) R The value MUST be the Path Name of a row in the DSL.Channel. table.This is the channel that is being bonded. This is read-only because bonding is expected to be configured by the CPE, not by the ACS. - 2.0
Device.­DSL.­Bonding­Group.­{i}.­Bonded­Channel.­{i}.­Ethernet. object R Per-channel [G.998.2] Ethernet-based bonding parameters. This object MUST be present if, and only if, BondScheme is Ethernet. - 2.0
Device.­DSL.­Bonding­Group.­{i}.­Bonded­Channel.­{i}.­Ethernet.­Stats. object R Per-channel [G.998.2] Ethernet-based bonding statistics. These relate to the [G.998.2] PME (Physical Medium Entity) Aggregation Function (PAF) lower layer (per-channel) interfaces. The CPE MUST reset the Stats parameters either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
Underflow­Errors­Sent unsigned­Int R Number of underflow errors sent, i.e. on the transmit side of the interface. - 2.0
CRCErrors­Received unsigned­Int R Number of CRC errors received, i.e. on the receive side of the interface. - 2.0
Alignment­Errors­Received unsigned­Int R Number of alignment errors received, i.e. on the receive side of the interface. - 2.0
Short­Packets­Received unsigned­Int R Number of short packets received, i.e. on the receive side of the interface. - 2.0
Long­Packets­Received unsigned­Int R Number of long packets received, i.e. on the receive side of the interface. - 2.0
Overflow­Errors­Received unsigned­Int R Number of overflow errors received, i.e. on the receive side of the interface. - 2.0
Pause­Frames­Received unsigned­Int R Number of pause frames received, i.e. on the receive side of the interface. - 2.0
Frames­Dropped unsigned­Int R Number of frames dropped, e.g. because the receive queue is full. - 2.0
Device.­DSL.­Bonding­Group.­{i}.­Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int 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. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Total­Start unsigned­Int R DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of Total statistics. Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible. Note: TotalStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
Current­Day­Start unsigned­Int R DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of CurrentDay statistics. The CPE MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so. Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible. Note: CurrentDayStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
Quarter­Hour­Start unsigned­Int R DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of QuarterHour statistics. The CPE MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so. Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible. Note: QuarterHourStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
Device.­DSL.­Bonding­Group.­{i}.­Stats.­Total. object R Total statistics for this bonding group. Note: The Device.DSL.BondingGroup.{i}.Stats.Total. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
Failure­Reasons string­[] R

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

  • LowRate (Minimum data rate not met)
  • ExcessiveDelay (Differential delay tolerance exceeded)
  • InsufficientBuffers (Insufficient buffers on receiver)
  • Other (Other failure occurred) Corresponds to [Section 11.4.3/G.998.1] Current Group Failure Reason.
- 2.0
Upstream­Rate unsigned­Int R The achieved upstream data rate in bits per second (which might change subject to dynamic link usage conditions). Corresponds to [Section 11.4.2/G.998.1] Achieved Aggregate Data Rate. - 2.0
Downstream­Rate unsigned­Int R The achieved downstream data rate in bits per second (which might change subject to dynamic link usage conditions). Corresponds to [Section 11.4.2/G.998.1] Achieved Aggregate Data Rate. - 2.0
Upstream­Packet­Loss unsigned­Int R The total number of upstream packets that were lost at aggregation output from a bonding group during the accumulation period. Corresponds to [Section 11.4.2/G.998.1] Group Rx Cell Loss Count. - 2.0
Downstream­Packet­Loss unsigned­Int R The total number of downstream packets that were lost at aggregation output from a bonding group during the accumulation period. Corresponds to [Section 11.4.2/G.998.1] Group Rx Cell Loss Count. - 2.0
Upstream­Differential­Delay unsigned­Int R The achieved upstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0
Downstream­Differential­Delay unsigned­Int R The achieved downstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0
Failure­Count unsigned­Int R The number of times that the group was declared Unavailable during the accumulation period. Corresponds to [Section 11.4.3/G.998.1] Group Failure Count. - 2.0
Errored­Seconds unsigned­Int R The time in seconds during which the group was declared Errored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**ES. - 2.0
Severely­Errored­Seconds unsigned­Int R The time in seconds during which the group was declared SeverelyErrored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**SES. - 2.0
Unavailable­Seconds unsigned­Int R The time in seconds during which the group was declared Unavailable during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**UAS. - 2.0
Device.­DSL.­Bonding­Group.­{i}.­Stats.­Current­Day. object R Current day statistics for this bonding group. Note: The Device.DSL.BondingGroup.{i}.Stats.CurrentDay. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
Failure­Reasons string­[] R

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

  • LowRate (Minimum data rate not met)
  • ExcessiveDelay (Differential delay tolerance exceeded)
  • InsufficientBuffers (Insufficient buffers on receiver)
  • Other (Other failure occurred) Corresponds to [Section 11.4.3/G.998.1] Current Group Failure Reason.
- 2.0
Upstream­Rate unsigned­Int R The achieved upstream data rate in bits per second (which might change subject to dynamic link usage conditions). Corresponds to [Section 11.4.2/G.998.1] Achieved Aggregate Data Rate. - 2.0
Downstream­Rate unsigned­Int R The achieved downstream data rate in bits per second (which might change subject to dynamic link usage conditions). Corresponds to [Section 11.4.2/G.998.1] Achieved Aggregate Data Rate. - 2.0
Upstream­Packet­Loss unsigned­Int R The total number of upstream packets that were lost at aggregation output from a bonding group during the accumulation period. Corresponds to [Section 11.4.2/G.998.1] Group Rx Cell Loss Count. - 2.0
Downstream­Packet­Loss unsigned­Int R The total number of downstream packets that were lost at aggregation output from a bonding group during the accumulation period. Corresponds to [Section 11.4.2/G.998.1] Group Rx Cell Loss Count. - 2.0
Upstream­Differential­Delay unsigned­Int R The achieved upstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0
Downstream­Differential­Delay unsigned­Int R The achieved downstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0
Failure­Count unsigned­Int R The number of times that the group was declared Unavailable during the accumulation period. Corresponds to [Section 11.4.3/G.998.1] Group Failure Count. - 2.0
Errored­Seconds unsigned­Int R The time in seconds during which the group was declared Errored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**ES. - 2.0
Severely­Errored­Seconds unsigned­Int R The time in seconds during which the group was declared SeverelyErrored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**SES. - 2.0
Unavailable­Seconds unsigned­Int R The time in seconds during which the group was declared Unavailable during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**UAS. - 2.0
Device.­DSL.­Bonding­Group.­{i}.­Stats.­Quarter­Hour. object R Current quarter hour statistics for this bonding group. Note: The Device.DSL.BondingGroup.{i}.Stats.QuarterHour. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. - 2.0
Failure­Reasons string­[] R

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

  • LowRate (Minimum data rate not met)
  • ExcessiveDelay (Differential delay tolerance exceeded)
  • InsufficientBuffers (Insufficient buffers on receiver)
  • Other (Other failure occurred) Corresponds to [Section 11.4.3/G.998.1] Current Group Failure Reason.
- 2.0
Upstream­Rate unsigned­Int R The achieved upstream data rate in bits per second (which might change subject to dynamic link usage conditions). Corresponds to [Section 11.4.2/G.998.1] Achieved Aggregate Data Rate. - 2.0
Downstream­Rate unsigned­Int R The achieved downstream data rate in bits per second (which might change subject to dynamic link usage conditions). Corresponds to [Section 11.4.2/G.998.1] Achieved Aggregate Data Rate. - 2.0
Upstream­Packet­Loss unsigned­Int R The total number of upstream packets that were lost at aggregation output from a bonding group during the accumulation period. Corresponds to [Section 11.4.2/G.998.1] Group Rx Cell Loss Count. - 2.0
Downstream­Packet­Loss unsigned­Int R The total number of downstream packets that were lost at aggregation output from a bonding group during the accumulation period. Corresponds to [Section 11.4.2/G.998.1] Group Rx Cell Loss Count. - 2.0
Upstream­Differential­Delay unsigned­Int R The achieved upstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0
Downstream­Differential­Delay unsigned­Int R The achieved downstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0
Failure­Count unsigned­Int R The number of times that the group was declared Unavailable during the accumulation period. Corresponds to [Section 11.4.3/G.998.1] Group Failure Count. - 2.0
Errored­Seconds unsigned­Int R The time in seconds during which the group was declared Errored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**ES. - 2.0
Severely­Errored­Seconds unsigned­Int R The time in seconds during which the group was declared SeverelyErrored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**SES. - 2.0
Unavailable­Seconds unsigned­Int R The time in seconds during which the group was declared Unavailable during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**UAS. - 2.0
Device.­DSL.­Bonding­Group.­{i}.­Ethernet. object(0:1) R

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

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

- 2.0
Device.­DSL.­Bonding­Group.­{i}.­Ethernet.­Stats. object R [G.998.2] Ethernet-based bonding statistics. These relate to the [G.998.2] PME (Physical Medium Entity) Aggregation Function (PAF) and to its upper layer interface. PAF lower layer interface statistics are in the BondedChannel.{i}.Ethernet.Stats objects. The CPE MUST reset the Stats parameters either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
PAFErrors unsigned­Int R Number of PAF errors. Corresponds to [TR-159] oBondETH.aEthRxErrors. - 2.0
PAFSmall­Fragments unsigned­Int R Number of PAF Small Fragment events. Corresponds to [TR-159] oBondETH.aEthRxSmallFragments. - 2.0
PAFLarge­Fragments unsigned­Int R Number of PAF Large Fragment events. Corresponds to [TR-159] oBondETH.aEthRxLargeFragments. - 2.0
PAFBad­Fragments unsigned­Int R Number of PAF Bad Fragment events. Corresponds to [TR-159] oBondETH.aEthRxBadFragments. - 2.0
PAFLost­Fragments unsigned­Int R Number of PAF Lost Fragment events. Corresponds to [TR-159] oBondETH.aEthRxLostFragments. - 2.0
PAFLate­Fragments unsigned­Int R Number of PAF Late Fragment events. - 2.0
PAFLost­Starts unsigned­Int R Number of PAF Lost Start events. Corresponds to [TR-159] oBondETH.aEthRxLostStarts. - 2.0
PAFLost­Ends unsigned­Int R Number of PAF Lost End events. Corresponds to [TR-159] oBondETH.aEthRxLostEnds. - 2.0
PAFOverflows unsigned­Int R Number of PAF Overflow events. Corresponds to [TR-159] oBondETH.aEthRxOverflows. - 2.0
Pause­Frames­Sent unsigned­Int R Number of pause frames sent, i.e. on the transmit side of the interface. - 2.0
CRCErrors­Received unsigned­Int R Number of CRC errors received, i.e. on the receive side of the interface. - 2.0
Alignment­Errors­Received unsigned­Int R Number of alignment errors received, i.e. on the receive side of the interface. - 2.0
Short­Packets­Received unsigned­Int R Number of short packets received, i.e. on the receive side of the interface. - 2.0
Long­Packets­Received unsigned­Int R Number of long packets received, i.e. on the receive side of the interface. - 2.0
Overflow­Errors­Received unsigned­Int R Number of overflow errors received, i.e. on the receive side of the interface. - 2.0
Frames­Dropped unsigned­Int R Number of frames dropped, e.g. because the receive queue is full. - 2.0
Device.­DSL.­Diagnostics. object R The DSL Diagnostics object. - 2.0
Device.­DSL.­Diagnostics.­ADSLLine­Test. object R This object is to provide diagnostic information for a CPE with an ADSL2 or ADSL2+ modem WAN interface, but MAY also be used for ADSL. - 2.0
Diagnostics­State string W

Indicates availability of diagnostic data. Enumeration of:

  • None (READONLY)
  • Requested
  • Complete (READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY) If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test, which brings down the DSL connection while the test is operating. When writing, the only allowed value is Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the corresponding reason in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object instance) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None.
- 2.0
Interface string­(:256) W The value MUST be the Path Name of a row in the DSL.Channel. table. This is the interface over which the test is to be performed. - 2.0
ACTPSDds int R Downstream actual power spectral density. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
ACTPSDus int R Upstream actual power spectral density. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
ACTATPds int R Downstream actual aggregate transmitter power. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
ACTATPus int R Upstream actual aggregate transmitter power. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
HLINSCds int R Downstream linear representation scale. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 2.0
HLINSCus int R Scaling used to represent the upstream linear channel characteristics. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 2.0
HLINGds unsigned­Int 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. - 2.0
HLINGus unsigned­Int 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. - 2.0
HLOGGds unsigned­Int 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. - 2.0
HLOGGus unsigned­Int 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. - 2.0
HLOGpsds string­(:2559)[] R Comma-separated list (maximum number of characters per item 2559) of strings. List items represent downstream logarithmic channel characteristics per sub-carrier group. The maximum number of elements is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGds but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: HLOGpsds is measured during initialization and is not updated during Showtime. - 2.0
HLOGpsus string­(:2559)[] R Comma-separated list (maximum number of characters per item 2559) of strings. List items represent upstream logarithmic channel characteristics per sub-carrier group. The maximum number of elements is 64 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: HLOGpsus is measured during initialization and is not updated during Showtime. - 2.0
HLOGMTds unsigned­Int 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. - 2.0
HLOGMTus unsigned­Int 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. - 2.0
LATNpbds string­(:24)[] R Comma-separated list (maximum number of characters per item 24) of strings. List items represent downstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of LATNpbds is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
LATNpbus string­(:24)[] R Comma-separated list (maximum number of characters per item 24) of strings. List items represent upstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of upstream bands but will exceed one only for G.993.2. Interpretation of LATNpbus is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
SATNds string­(:24)[] R Comma-separated list (maximum number of characters per item 24) of strings. List items represent downstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNds is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
SATNus string­(:24)[] R Comma-separated list (maximum number of characters per item 24) of strings. List items represent upstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNus is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
HLINpsds int­(:61430)[] R Comma-separated list (maximum number of characters per item 61430) of integers. List items represent downstream linear channel characteristics per subcarrier group. Maximum number of complex pairs is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of pairs will depend on the value of HLINGds but will not exceed 512. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: HLIN is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. - 2.0
HLINpsus string­(:61430)[] R Comma-separated list (maximum number of characters per item 61430) of strings. List items represent upstream linear channel characteristics per sub-carrier group. Maximum number of complex pairs is 64 for G.992.3, and G.992.5. For G.993.2, the number of pairs will depend on the value of HLINGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: HLIN is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. - 2.0
QLNGds unsigned­Int 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. - 2.0
QLNGus unsigned­Int 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. - 2.0
QLNpsds int­(:61430)[] R Comma-separated list (maximum number of characters per item 61430) of integers. List items represent downstream quiet line noise per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. For G.993.2, the number of elements will depend on the value of QLNGds but will not exceed 512. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: QLN is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. - 2.0
QLNpsus string­(:61430)[] R Comma-separated list (maximum number of characters per item 61430) of strings. List items represent upstream quiet line noise per subcarrier group. The maximum number of elements is 64 for G.992.3, and G.992.5. For G.993.2, the number of elements will depend on the value of QLNGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: QLN is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. - 2.0
QLNMTds unsigned­Int 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. - 2.0
QLNMTus unsigned­Int 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. - 2.0
SNRGds unsigned­Int 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. - 2.0
SNRGus unsigned­Int 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. - 2.0
SNRpsds int­(:61430)[] R Comma-separated list (maximum number of characters per item 61430) of integers. List items represent downstream SNR per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. For G.993.2, the number of elements will depend on the value of SNRGds but will not exceed 512. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: SNRps is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. - 2.0
SNRpsus string­(:61430)[] R Comma-separated list (maximum number of characters per item 61430) of strings. List items represent upstream SNR per subcarrier group. The maximum number of elements is 64 for G.992.3, and G.992.5. For G.993.2, the number of elements will depend on the value of SNRGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: SNRps is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. - 2.0
SNRMTds unsigned­Int 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. - 2.0
SNRMTus unsigned­Int 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. - 2.0
BITSpsds int­(:61430)[] R Comma-separated list (maximum number of characters per item 61430) of integers. List items represent downstream bit allocation per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. Interpretation of the value is as defined in ITU-T Rec. [G.997.1]. - 2.0
BITSpsus string­(:61430)[] R Comma-separated list (maximum number of characters per item 61430) of strings. List items represent upstream bit allocation per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. Interpretation of the value is as defined in ITU-T Rec. [G.997.1]. - 2.0
Device.­ATM. object R Asynchronous Transfer Mode (ATM) object that contains the Link interface and Diagnostics.F5Loopback diagnostics. - 2.0
Link­Number­Of­Entries unsigned­Int R The number of entries in the Link table. - 2.0
Device.­ATM.­Link.­{i}. object(0:) W

ATM link-layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Models an ATM PVC virtual circuit and the ATM Adaption Layer (AAL). An ATM Link entry is typically stacked on top of either a DSL.Channel. or a DSL.BondingGroup. object. When an ATM Link interface is used, a lower-layer DSL.Channel interface MUST be configured with ATM encapsulation (see DSL.Channel.{i}.LinkEncapsulationUsed).

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

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

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863].
Down 2.0
Alias string­(:64) W

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

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

- 2.0
Name string­(:64) R

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

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

- 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the link entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. 2.0
Link­Type string W

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

  • EoA ([RFC2684] bridged Ethernet over ATM)
  • IPoA ([RFC2684] routed IP over ATM)
  • PPPoA ([RFC2364] PPP over ATM)
  • CIP ([RFC2225] Classical IP over ATM)
  • Unconfigured
- 2.0
Auto­Config boolean R Indicates if the CPE is currently using some auto configuration mechanisms for this connection. If this variable is true, all writable variables in this connection instance become read-only. Any attempt to change one of these variables SHOULD fail and an error SHOULD be returned. - 2.0
Destination­Address string­(:256) W

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

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

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

  • LLC
  • VCMUX
- 2.0
FCSPreserved boolean W This flag tells if a checksum SHOULD be added in the ATM payload. It does not refer to the checksum of one of the ATM cells or AALX packets. In case of LLC or VCMUX encapsulation, this ATM checksum is the FCS field described in [RFC2684]. It is only applicable in the upstream direction. - 2.0
VCSearch­List string­(:256)[] W

Comma-separated list (maximum number of characters per item 256) of strings. Ordered list of VPI/VCI pairs to search if a link using the DestinationAddress cannot be established. In the form “VPI1/VCI1, VPI2/VCI2, …”.

Each list item matches one of:

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

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

  • AAL1
  • AAL2
  • AAL3
  • AAL4
  • AAL5
- 2.0
Device.­ATM.­Link.­{i}.­Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int 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. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Transmitted­Blocks unsigned­Int R The current count of successfully transmitted cells. - 2.0
Received­Blocks unsigned­Int R The current count of successfully received cells. - 2.0
CRCErrors unsigned­Int R Count of the ATM layer cyclic redundancy check (CRC) errors. This refers to CRC errors at the ATM adaptation layer (AAL). The AAL in use is indicated by the AAL parameter. The value of the CRCErrors parameter MUST be 0 for AAL types that have no CRCs. - 2.0
HECErrors unsigned­Int R Count of the number of Header Error Check related errors at the ATM layer. - 2.0
Device.­ATM.­Link.­{i}.­Qo­S. object R The ATM Link QoS object. - 2.0
Qo­SClass string W

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

  • UBR
  • CBR
  • GFR
  • VBR-nrt
  • VBR-rt
  • UBR+
  • ABR
- 2.0
Peak­Cell­Rate unsigned­Int W Specifies the upstream peak cell rate in cells per second. - 2.0
Maximum­Burst­Size unsigned­Int W Specifies the upstream maximum burst size in cells. - 2.0
Sustainable­Cell­Rate unsigned­Int W Specifies the upstream sustainable cell rate, in cells per second. - 2.0
Device.­ATM.­Diagnostics. object R The ATM Diagnostics object. - 2.0
Device.­ATM.­Diagnostics.­F5Loopback. object R This object provides access to an ATM-layer F5 OAM loopback test. - 2.0
Diagnostics­State 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.
- 2.0
Interface string­(:256) W The value MUST be the Path Name of a row in the ATM.Link. table. This is the interface over which the test is to be performed. - 2.0
Number­Of­Repetitions unsigned­Int­(1:) W Number of repetitions of the ping test to perform before reporting the results. - 2.0
Timeout unsigned­Int­(1:) W Timeout in milliseconds for the ping test. - 2.0
Success­Count unsigned­Int 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. - 2.0
Failure­Count unsigned­Int R Result parameter indicating the number of failed pings in the most recent ping test. - 2.0
Average­Response­Time unsigned­Int 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. - 2.0
Minimum­Response­Time unsigned­Int 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. - 2.0
Maximum­Response­Time unsigned­Int 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. - 2.0
Device.­PTM. object R Packet Transfer Mode ([Annex H/G.993.1]). This object contains the Link interface. - 2.0
Link­Number­Of­Entries unsigned­Int R The number of entries in the Link table. - 2.0
Device.­PTM.­Link.­{i}. object(0:) W

PTM link-layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Models a layer 2 variable-sized packet interface. A PTM Link entry is typically stacked on top of either a DSL.Channel. or a DSL.BondingGroup. object. When a PTM Link interface is used, a lower-layer DSL.Channel interface MUST be configured with PTM encapsulation (see DSL.Channel.{i}.LinkEncapsulationUsed).

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

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

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863].
Down 2.0
Alias string­(:64) W

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

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

- 2.0
Name string­(:64) R

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

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

- 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the link entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. 2.0
MACAddress string­(:17) R [MACAddress] The MAC Address of the interface. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter. - 2.0
Device.­PTM.­Link.­{i}.­Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int 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. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Device.­Ethernet. object R Ethernet object. This object models several Ethernet interface objects, each representing a different stack layer, including: Interface, Link, and VLANTermination. Interface is media-specific and models a port, the PHY layer, and the MAC layer. Link is media-independent and models the Logical Link Control (LLC) layer. A VLANTermination, when present, is expected to be stacked on top of Link objects to receive and send frames with a configured VLANID. - 2.0
Interface­Number­Of­Entries unsigned­Int R The number of entries in the Interface table. - 2.0
Link­Number­Of­Entries unsigned­Int R The number of entries in the Link table. - 2.0
VLANTermination­Number­Of­Entries unsigned­Int R The number of entries in the VLANTermination table. - 2.0
Device.­Ethernet.­Interface.­{i}. object(0:) R

Ethernet interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models physical Ethernet ports, but in terms of the interface stack it also models the PHY and MAC level Ethernet interface.

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

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

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863].
- 2.0
Alias string­(:64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object. - 2.0
Name string­(:64) R The textual name of the interface as assigned by the CPE. - 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the interface entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Device.Ethernet.Interface.{i}. is a layer 1 interface, it is expected that LowerLayers will not be used. - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.0
MACAddress string­(:17) R [MACAddress] The MAC Address of the interface. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter. - 2.0
Max­Bit­Rate int­(-­1:) W The maximum upstream and downstream PHY bit rate supported by this interface (expressed in Mbps). A value of -1 indicates automatic selection of the maximum bit rate. - 2.0
Duplex­Mode string W

The duplex mode available to this connection. Enumeration of:

  • Half
  • Full
  • Auto
- 2.0
Device.­Ethernet.­Interface.­{i}.­Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int 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. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Device.­Ethernet.­Link.­{i}. object(0:) W

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

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

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

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863].
Down 2.0
Alias string­(:64) W

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

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

- 2.0
Name string­(:64) R

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

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

- 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the link entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. 2.0
MACAddress string­(:17) R [MACAddress] The MAC address used for packets sent via this interface. Provides the source MAC address for outgoing traffic and the destination MAC address for incoming traffic. - 2.0
Priority­Tagging boolean W Enables or disables priority tagging on this Ethernet Link. When true, egress frames leaving this interface will be priority tagged with the frame’s associated priority value, which will either be derived directly from the ingress frame or else set via QoS.Classification.{i}.EthernetPriorityMark. When false, egress frames leaving this interface will be untagged. The parameter does not affect reception of ingress frames. false 2.0
Device.­Ethernet.­Link.­{i}.­Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int 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. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Device.­Ethernet.­VLANTermination.­{i}. object(0:) W

VLAN Termination table (a stackable interface object as described in [Section 4.2/TR-181i2]). A VLAN Termination entry is typically stacked on top of a Link object to receive and send frames with the configured VLANID.

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

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

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863].
Down 2.0
Alias string­(:64) W

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

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

- 2.0
Name string­(:64) R

The textual name of the VLANTermination entry as assigned by the CPE.

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

- 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the VLANTermination entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. 2.0
VLANID unsigned­Int­(1:4094) W The VLAN ID for this Device.Ethernet.VLANTermination.{i}. entry (as defined in [802.1Q-2005]). Only ingress frames with this VLAN ID will be passed to higher protocol layers; frames sent from higher protocol layers will be tagged with this VLAN ID. - 2.0
Device.­Ethernet.­VLANTermination.­{i}.­Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int 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. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Device.­USB. object R Universal Serial Bus ([USB1.0], [USB2.0], [USB3.0]). This object contains the Interface, Port, and USBHosts objects. - 2.0
Interface­Number­Of­Entries unsigned­Int R The number of entries in the Interface table. - 2.0
Port­Number­Of­Entries unsigned­Int R The number of entries in the Port table. - 2.0
Device.­USB.­Interface.­{i}. object(0:) R

USB interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models master and slave USB physical interfaces that support carrying Ethernet frames, e.g. via the USB Communication Device Class.

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

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

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863].
- 2.0
Alias string­(:64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object. - 2.0
Name string­(:64) R The textual name of the interface as assigned by the CPE. - 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the interface entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Device.USB.Interface.{i}. is a layer 1 interface, it is expected that LowerLayers will not be used. - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.0
MACAddress string­(:17) R [MACAddress] The MAC Address of the interface. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter. - 2.0
Max­Bit­Rate unsigned­Int R The maximum PHY bit rate supported by this interface (expressed in Mbps). - 2.0
Port string­(:256) R The value MUST be the Path Name of a row in the Port. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is the USB port associated with this interface object. - 2.0
Device.­USB.­Interface.­{i}.­Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int 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. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Device.­USB.­Port.­{i}. object(0:) R

USB Port table. This table models master and slave USB physical ports on the device.

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

- 2.0
Alias string­(:64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object. - 2.0
Name string­(:64) R The textual name of the port. - 2.0
Standard string­(:4) R USB specification version supported by the Port. Example: “1.1” - 2.0
Type string R

Type of the USB connection. Enumeration of:

  • Host
  • Hub
  • Device
- 2.0
Receptacle string R

Receptacle of the port. Enumeration of:

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

Current speed of the USB connection. Enumeration of:

  • Low (1.5 Mbits/sec (187.5 KB/sec) defined in [USB1.0])
  • Full (12 Mbits/sec (1.5 MB/sec) defined in [USB1.0])
  • High (480 Mbits/sec (60 MB/sec) defined in [USB2.0])
  • Super (5.0 Gbits/sec (625 MB/sec) defined in [USB3.0])
- 2.0
Power string R

Power configuration of the USB connection. Enumeration of:

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

Table of CPE USB Host controllers.

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

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

Type of USB Host Enumeration of:

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

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

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

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

Table of connected USB devices.

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

- 2.0
Device­Number unsigned­Int R Device number on USB bus. - 2.0
USBVersion string­(:4) R USB specification version with which the device complies. Example: “1.1” - 2.0
Device­Class hex­Binary­(:1) R Class Code as assigned by USB-IF. When 0x00, each device specifies its own class code. When 0xFF, the class code is vendor specified. - 2.0
Device­Sub­Class hex­Binary­(:1) R Subclass code (assigned by USB-IF). - 2.0
Device­Version unsigned­Int­(:65535) R Device release number. - 2.0
Device­Protocol hex­Binary­(:1) R Protocol code (assigned by USB-IF). - 2.0
Product­ID unsigned­Int­(:65535) R Product ID (assigned by manufacturer). - 2.0
Vendor­ID unsigned­Int­(:65535) R Vendor ID (assigned by USB-IF). - 2.0
Manufacturer string­(:64) R Device Manufacturer string descriptor. - 2.0
Product­Class string­(:64) R Device Product Class string descriptor. - 2.0
Serial­Number string­(:64) R Device SerialNumber string descriptor. - 2.0
Port unsigned­Int­(:255) R Hub port on parent device. 0 when no parent. - 2.0
USBPort string R The value MUST be the Path Name of a row in the USB.Port. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is a reference to the USB host device to which this (external) USB device is connected. - 2.0
Rate string R

Speed of the USB device. Enumeration of:

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

Table of device configurations.

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

- 2.0
Configuration­Number unsigned­Int R The identifier for each Device Configuration. - 2.0
Interface­Number­Of­Entries unsigned­Int R The number of entries in the Interface table. - 2.0
Device.­USB.­USBHosts.­Host.­{i}.­Device.­{i}.­Configuration.­{i}.­Interface.­{i}. object(0:) R

Table of device interface descriptors.

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

- 2.0
Interface­Number unsigned­Int­(:255) R Number of this interface (from USB interface descriptor). - 2.0
Interface­Class hex­Binary­(:1) R Class Code as assigned by USB-IF. When 0x00, each interface specifies its own class code. When 0xFF, the class code is vendor specified. - 2.0
Interface­Sub­Class hex­Binary­(:1) R Subclass code (assigned by USB-IF). - 2.0
Interface­Protocol hex­Binary­(:1) R Protocol code (assigned by USB-IF). - 2.0
Device.­HPNA. object R HPNA object that contains the Interface and Diagnostics objects. The HPNA (also known as HomePNA) industry standard [G.9954] defines peer to peer communication for home networking over existing coax cables and telephone wiring within the home. - 2.0
Interface­Number­Of­Entries unsigned­Int R The number of entries in the Interface table. - 2.0
Device.­HPNA.­Interface.­{i}. object(0:) R

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

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

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

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863].
- 2.0
Alias string­(:64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object. - 2.0
Name string­(:64) R The textual name of the interface as assigned by the CPE. - 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the interface entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Device.HPNA.Interface.{i}. is a layer 1 interface, it is expected that LowerLayers will not be used. - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.0
MACAddress string­(:17) R [MACAddress] The MAC Address of the interface. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter. - 2.0
Firmware­Version string­(:64) R This interface’s firmware version. - 2.0
Node­ID unsigned­Int R The Node ID of this interface. - 2.0
Is­Master boolean R Whether this interface is the HPNA network master. - 2.0
Synced boolean R Whether this interface is synchronized with the HPNA network master. If this interface is the HPNA network master, Synced MUST be true. - 2.0
Total­Sync­Time unsigned­Int R Total time in seconds (since device reset) that this interface has been up and synchronized to the HPNA network master. - 2.0
Max­Bit­Rate unsigned­Int R The maximum HPNA PHY bit rate (expressed in Mbps) of this interface. - 2.0
Network­Utilization unsigned­Int­(0:1000) R Current HPNA network utilization (expressed in 0.1%). - 2.0
Possible­Connection­Types string­[] R

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

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

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

  • A (4-20MHz - Phone / Coax)
  • B (12-28MHz - Phone / Coax)
  • C (36-52MHz - Coax only)
  • D (4-36MHz - Coax only)
- 2.0
Spectral­Mode string W The value MUST be a member of the list reported by the PossibleSpectralModes parameter. Spectral mode for which the HPNA protocol is active. - 2.0
MTU unsigned­Int W Maximum Transmission Unit for this HPNA interface (expressed in bytes). - 2.0
Noise­Margin unsigned­Int W The desired noise margin for which the local HPNA interface has been configured (expressed in 0.1dB). - 2.0
Default­Non­LARQPER unsigned­Int W The desired packet error rate for which the local HPNA interface has been configured (expressed in 1E-8, e.g. PER of 1.27E-6 will be presented as 127). - 2.0
LARQEnable boolean W Enable or disable the Limited Automatic Repeat Request (LARQ) mechanism. - 2.0
Min­Multicast­Rate unsigned­Int W The minimum multicast (and broadcast) rate that can be negotiated on the HPNA network directly accessible via this interface (expressed in Mbps). - 2.0
Neg­Multicast­Rate unsigned­Int R The negotiated multicast (and broadcast) rate on the HPNA network directly accessible via this interface (expressed in Mbps). - 2.0
Master­Selection­Mode string W

Master selection mode. Enumeration of:

  • Automatic (Automatic master selection)
  • ForceEndpoint (Force local HPNA interface to be end point)
  • ForceMaster (Force local HPNA interface to be master)
- 2.0
Associated­Device­Number­Of­Entries unsigned­Int R The number of entries in the AssociatedDevice table. This is the number of HPNA nodes that are directly accessible via this interface. - 2.0
Device.­HPNA.­Interface.­{i}.­Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int 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. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Device.­HPNA.­Interface.­{i}.­Qo­S. object R QoS configuration object. - 2.0
Flow­Spec­Number­Of­Entries unsigned­Int R The number of entries in the FlowSpec table. - 2.0
Device.­HPNA.­Interface.­{i}.­Qo­S.­Flow­Spec.­{i}. object(0:) W

Flow specification table. The QoS.Classification table is used to classify ingress traffic, where QoS.Classification.{i}.TrafficClass is one of the classification result outputs. This TrafficClass value can be used to look up the appropriate Device.HPNA.Interface.{i}.QoS.FlowSpec.{i}. entry (i.e. the Device.HPNA.Interface.{i}.QoS.FlowSpec.{i}. entry whose TrafficClasses list contains a matching traffic class). For enabled table entries, if TrafficClasses is an empty string then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

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

The status of this entry. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 2.0
Alias string­(:64) W

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

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

- 2.0
Traffic­Classes unsigned­Int­(:256)[] W Comma-separated list (maximum number of characters per item 256) of unsigned integers. This list identifies the set of traffic classes associated with this flow spec. 2.0
Flow­Type string W

Flow type. Enumeration of:

  • CBR (Constant Bit Rate)
  • VBR (Variable Bit Rate)
  • VBR-NRT (Variable Bit Rate - Non Real Time)
  • BE (Best Effort)
BE 2.0
Priority unsigned­Int­(0:7) W Flow queue network priority. Priority 0 is the lowest priority. 0 2.0
Latency unsigned­Int­(0:999) W Maximum latency of the flow (expressed in milliseconds). Value 0 means no latency requirements. 0 2.0
Jitter unsigned­Int­(0:999) W Maximum jitter of the flow (expressed in milliseconds). Value 0 means no jitter requirements. 0 2.0
Packet­Size unsigned­Int­(0:) W Typical packet size. Value 0 means undefined packet size. 0 2.0
Min­Rate unsigned­Int W Minimum required rate in Kbps. Value 0 means no MinRate requirements. 0 2.0
Avg­Rate unsigned­Int W Average required rate in Kbps. Value 0 means no AvgRate requirements. 0 2.0
Max­Rate unsigned­Int W Maximum required rate in Kbps. Value 0 means no MaxRate requirements. 0 2.0
PER unsigned­Int W The desired packet error rate (expressed in 1E-8, e.g. PER of 1.27E-6 will be presented as 127). Value 0 means no PER requirements. 0 2.0
Timeout unsigned­Int W Flow inactivity tear down timeout (expressed in milliseconds). Value 0 means unlimited timeout. 0 2.0
Device.­HPNA.­Interface.­{i}.­Associated­Device.­{i}. object(0:) R

This table provides information about other HPNA devices that are directly accessible via this HPNA interface.

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

- 2.0
MACAddress string­(:17) R [MACAddress] The physical address of this node. - 2.0
Node­ID unsigned­Int R The Node ID of this node. - 2.0
Is­Master boolean R Whether this node is the HPNA network master. - 2.0
Synced boolean R Whether this node is synchronized with the HPNA network master. If this node is the HPNA network master, Synced MUST be true. - 2.0
Total­Sync­Time unsigned­Int R Total time in seconds (since device reset) that this node has been up and synchronized to the HPNA network master. - 2.0
Max­Bit­Rate unsigned­Int R This node’s maximum HPNA PHY bit rate (expressed in Mbps). - 2.0
PHYDiagnostics­Enable boolean W Enable / disable PHY throughput diagnostics mode on this node. All devices that are enabled will participate in the HPNA network PHY throughput diagnostics process. - 2.0
Active boolean R Whether or not this node is currently present in the HPNA network. The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE. - 2.0
Device.­HPNA.­Diagnostics. object R The HPNA Diagnostics object. - 2.0
Device.­HPNA.­Diagnostics.­PHYThroughput. object R HPNA PHY throughput diagnostics configuration and results. When diagnostics are requested, all HPNA nodes for which the Interface.{i}.AssociatedDevice.{i}.PHYDiagnosticsEnable parameter is set enter PHY diagnostics mode. - 2.0
Diagnostics­State string W

Indicates availability of diagnostic data. Enumeration of:

  • None (READONLY)
  • Requested
  • Complete (READONLY)
  • Error_FailToEnableCert (READONLY)
  • Error_CertCmdTimeout (READONLY)
  • Error_UnknownErr (READONLY)
  • Error_UnsupportedOpcode (READONLY)
  • Error_InvalidParam (READONLY)
  • Error_UnsupportedCmdSegment (READONLY)
  • Error_UnsupportedDataGen (READONLY)
  • Error_InvalidSequence (READONLY)
  • Error_InvalidFrame (READONLY)
  • Eror_InvalidOpcode (READONLY) Value is set to Requested to initiate the diagnostic test. When writing, the only allowed value is Requested. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the PHY diagnostics test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code “8 DIAGNOSTICS COMPLETE” in the Inform message.
- 2.0
Interface string­(:256) W The value MUST be the Path Name of a row in the HPNA.Interface. table. This is the interface over which the test is to be performed. - 2.0
Num­Packets­In­Burst unsigned­Int W Number of test packet in burst to be send during PHY diagnostics test from each HPNA device to other HPNA device in the HPNA network. - 2.0
Burst­Interval unsigned­Int W Test packet burst interval length (expressed in milliseconds). - 2.0
Test­Packet­Payload­Length unsigned­Int­(0:1480) W Payload length in the test packets. - 2.0
Payload­Encoding unsigned­Int W HPNA payload encoding in PHY diagnostics. 0 is used for negotiated payload between devices according to line conditions. - 2.0
Payload­Data­Gen unsigned­Int W Test packets payload data generator value. - 2.0
Payload­Type string W

Test packets payload type. Enumeration of:

  • Pattern
  • IncrementByte In Pattern mode the PayloadDataGen value is repeated pattern in the payload. In IncrementByte mode LSByte in PayloadDataGen is used as first payload and next bytes in payload are incremented.
- 2.0
Priority­Level unsigned­Int­(0:7) W Priority level of PHY diagnostics packets (0 lowest -7 highest). - 2.0
Result­Number­Of­Entries unsigned­Int R The number of entries in the Result table. This is the number of PHY diagnostics results. - 2.0
Device.­HPNA.­Diagnostics.­PHYThroughput.­Result.­{i}. object(0:) R

PHY throughput diagnostics results. Each result object corresponds to unidirectional traffic between two PHY diagnostics-enabled nodes (so there are two such objects for each such pair).

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

- 2.0
Src­MACAddress string­(:17) R [MACAddress] HPNA source MAC address. - 2.0
Dest­MACAddress string­(:17) R [MACAddress] HPNA destination MAC address. - 2.0
PHYRate unsigned­Int R PHY diagnostics HPNA PHY rate (expressed in Mbps). - 2.0
Baud­Rate unsigned­Int R PHY Baud rate (expressed in Kbaud). - 2.0
SNR unsigned­Int R PHY diagnostics SNR (expressed in 0.1dB). - 2.0
Packets­Received unsigned­Int R Number of received packets in PHY diagnostics mode. - 2.0
Attenuation unsigned­Int R Measured attenuation (expressed in 0.1dB). - 2.0
Device.­HPNA.­Diagnostics.­Performance­Monitoring. object R HPNA performance monitoring configuration and results. Performance monitoring results are sampled from all nodes in the HPNA network. All packet related counters are sampled synchronized at all nodes in the HPNA network in order to derive packet loss calculations in the HPNA network. - 2.0
Diagnostics­State string W

Indicates availability of performance monitoring data. Enumeration of:

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

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

This table MUST contain at least 1 entry.

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

- 2.0
MACAddress string­(:17) R [MACAddress] The MAC address of the HPNA node. - 2.0
Bytes­Sent unsigned­Long R The total number of bytes sent by host equipment for transmission on the HPNA interface. - 2.0
Bytes­Received unsigned­Long R The total number of received bytes on the HPNA interface destined for the host equipment. - 2.0
Packets­Sent unsigned­Long R The total number of packets sent by host equipment for transmission on the HPNA interface. Number includes also short error packets and control packets. - 2.0
Packets­Received unsigned­Long R The total number of good packets received on the HPNA interface destined for the host equipment. - 2.0
Broadcast­Packets­Sent unsigned­Long R The number of broadcast packets transmitted on the HPNA interface. - 2.0
Broadcast­Packets­Received unsigned­Long R The number of broadcast packets received on the HPNA interface. - 2.0
Multicast­Packets­Sent unsigned­Long R The number of multicast packets transmitted on the HPNA interface. - 2.0
Multicast­Packets­Received unsigned­Long R The number of multicast packets received on the HPNA interface. - 2.0
Packets­Crc­Errored unsigned­Int R The number of packets received on the HPNA interface with CRC errors. - 2.0
Packets­Crc­Errored­Host unsigned­Int R The number of CRC error packets received on the HPNA interface destined for the host equipment. - 2.0
Packets­Short­Errored unsigned­Int R The number of packets received on the HPNA interface that are too short to be valid. - 2.0
Packets­Short­Errored­Host unsigned­Int R The number packets sent by the host equipment that are too short to be valid. - 2.0
Rx­Packets­Dropped unsigned­Int R The number of received packets dropped due to lack of resources. - 2.0
Tx­Packets­Dropped unsigned­Int R The number packets sent by the host equipment for transmission on the HPNA interface but dropped due to lack of resources. - 2.0
Control­Request­Local unsigned­Int R The number of HPNA control request packets from local host. - 2.0
Control­Reply­Local unsigned­Int R The number of HPNA control reply packets to local host. - 2.0
Control­Request­Remote unsigned­Int R The number of HPNA control request packets from remote host. - 2.0
Control­Reply­Remote unsigned­Int R The number of HPNA control reply packets to remote host. - 2.0
Packets­Sent­Wire unsigned­Long R The total number of packets transmitted to wire. - 2.0
Broadcast­Packets­Sent­Wire unsigned­Long R The total number of broadcast packets transmitted to wire. - 2.0
Multicast­Packets­Sent­Wire unsigned­Long R The total number of multicast packets transmitted to wire. - 2.0
Packets­Internal­Control unsigned­Int R The number of HPNA control request packets from internal node. - 2.0
Broadcast­Packets­Internal­Control unsigned­Int R The number of HPNA broadcast control request packets from internal node. - 2.0
Packets­Received­Queued unsigned­Int R The number of received packets queued on host output queues. - 2.0
Packets­Received­Forward­Unknown unsigned­Int R The number of packets received and forwarded to unknown hosts. - 2.0
Node­Utilization unsigned­Int­(0:1000) R The node utilization (expressed in 0.1%). - 2.0
Device.­HPNA.­Diagnostics.­Performance­Monitoring.­Channels. object R Per-channel HPNA performance monitoring results. Note: channels are unidirectional. - 2.0
Time­Stamp date­Time R Time at which channel data was last collected. - 2.0
Channel­Number­Of­Entries unsigned­Int R The number of entries in the Channel table. This is the number of HPNA channels for which performance monitoring results have been collected. - 2.0
Device.­HPNA.­Diagnostics.­Performance­Monitoring.­Channels.­Channel.­{i}. object(0:) R

Per-channel HPNA performance monitoring results.

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

- 2.0
Host­Src­MACAddress string­(:17) R [MACAddress] The host source MAC address associated with the channel. - 2.0
Host­Dest­MACAddress string­(:17) R [MACAddress] The host destination MAC address associated with the channel. - 2.0
HPNASrc­MACAddress string­(:17) R [MACAddress] The HPNA source MAC address associated with the channel. - 2.0
HPNADest­MACAddress string­(:17) R [MACAddress] The HPNA destination MAC address associated with the channel. - 2.0
PHYRate unsigned­Int R Channel PHY rate (expressed in Mbps). - 2.0
Baud­Rate unsigned­Int R PHY Baud rate (expressed in Kbaud). - 2.0
SNR unsigned­Int R Channel actual SNR measured in receiver side (expressed in 0.1dB). - 2.0
Packets­Sent unsigned­Int R Number of packets sent in the channel. - 2.0
Packets­Received unsigned­Int R Pre-LARQ number of packets received in the channel. - 2.0
LARQPackets­Received unsigned­Int R Post-LARQ number of packets received in the channel. Valid only if LARQ is enabled. - 2.0
Flow­Spec string­(:256) R The value MUST be the Path Name of a row in the HPNA.Interface.{i}.QoS.FlowSpec. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Identifies the FlowSpec associated with the channel. This parameter is only used for channels that correspond to egress traffic from the local HPNA interface. An empty string means that the channel is not associated with any specified flow specification in the QoS object. - 2.0
Device.­Mo­CA. object R MoCA object that contains the Interface table [MoCAv1.0] [MoCAv1.1]. - 2.0
Interface­Number­Of­Entries unsigned­Int R The number of entries in the Interface table. - 2.0
Device.­Mo­CA.­Interface.­{i}. object(0:) R

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

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

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

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863].
- 2.0
Alias string­(:64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object. - 2.0
Name string­(:64) R The textual name of the interface as assigned by the CPE. - 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the interface entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Device.MoCA.Interface.{i}. is a layer 1 interface, it is expected that LowerLayers will not be used. - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.0
MACAddress string­(:17) R [MACAddress] The MAC Address of the interface. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter. - 2.0
Firmware­Version string­(:64) R This interface’s firmware version. This parameter is based on mocaIfSoftwareVersion from [MOCA11-MIB]. - 2.0
Max­Bit­Rate unsigned­Int R The maximum MoCA PHY bit rate (expressed in Mbps). - 2.0
Max­Ingress­BW unsigned­Int R The maximum bandwidth of this interface for flows onto the MoCA network in Mbps. This parameter is based on mocaIfMaxIngressNodeBw from [MOCA11-MIB]. - 2.0
Max­Egress­BW unsigned­Int R The maximum bandwidth of this interface for flows from the MoCA network in Mbps. This parameter is based on mocaIfMaxEgressNodeBw from [MOCA11-MIB]. - 2.0
Highest­Version string­(:64) R

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

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

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

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

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

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

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

- 2.0
Tx­Power­Limit unsigned­Int W Transmit Power attenuation in dB relative to the maximum transmit power. The MoCA interface SHOULD have Enable set to false for any change in this configuration. If the parameter is modified when Enable is true then this change might take several minutes to complete. This parameter is based on mocaIfTxPowerLimit from [MOCA11-MIB]. - 2.0
Power­Cntl­Phy­Target unsigned­Int W Target PHY rate in Mbps for the power control algorithm. The MoCA interface SHOULD have Enable set to false for any change in this configuration. If the parameter is modified when Enable is true then this change might take several minutes to complete. This parameter is based on mocaIfPowerControlTargetRate from [MOCA11-MIB]. - 2.0
Beacon­Power­Limit unsigned­Int W Beacon Transmit Power attenuation in dB relative to the maximum transmit power. The MoCA interface SHOULD have Enable set to false for any change in this configuration. If the parameter is modified when Enable is true then this change might take several minutes to complete. This parameter is based on mocaIfBeaconPowerLimit from [MOCA11-MIB]. - 2.0
Network­Taboo­Mask hex­Binary­(8) R Hexadecimal encoded 64-bit mask of MoCA taboo channels identified for the home network. This is the bit map of the spectrum that the interface supports, and each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency. This parameter is based on mocaIfTabooChannelMask from [MOCA11-MIB]. - 2.0
Node­Taboo­Mask hex­Binary­(8) R Hexadecimal encoded 64-bit mask of supported frequencies. This is the bit map of the spectrum that the interface supports, and each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency. This parameter is based on mocaIfNodeTabooChannelMask from [MOCA11-MIB]. - 2.0
Tx­Bcast­Rate unsigned­Int R The broadcast PHY transmit rate in Mbps for this interface. This parameter is based on mocaIfTxGcdRate from [MOCA11-MIB]. - 2.0
Tx­Bcast­Power­Reduction unsigned­Int R Transmit Power attenuation in dB relative to the maximum transmit power for broadcast transmissions. This parameter is based on mocaIfTxGcdPowerReduction from [MOCA11-MIB]. - 2.0
QAM256Capable boolean R Whether this interface supports the 256 QAM feature. This parameter is based on mocaIfQAM256Capable from [MOCA11-MIB]. - 2.0
Packet­Aggregation­Capability unsigned­Int­(0:10) R The packet aggregation capability supported by the interface. Standard values are 0 (no support), 6 (6 packets) or 10 (10 packets). This parameter is based on mocaIfPacketsAggrCapability from [MOCA11-MIB]. - 2.0
Associated­Device­Number­Of­Entries unsigned­Int R The number of entries in the AssociatedDevice table. - 2.0
Device.­Mo­CA.­Interface.­{i}.­Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int 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. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Device.­Mo­CA.­Interface.­{i}.­Qo­S. object R The QoS object provides information on MoCA parameterized QoS for this interface [MoCAv1.1]. - 2.0
Egress­Num­Flows unsigned­Int R The number of QoS flows that this interface has from the MoCA network. This parameter is based on mocaIfEgressNodeNumFlows from [MOCA11-MIB]. - 2.0
Ingress­Num­Flows unsigned­Int R The number of QoS flows that this interface has onto the MoCA network. This parameter is based on mocaIfIngressNodeNumFlows from [MOCA11-MIB]. - 2.0
Flow­Stats­Number­Of­Entries unsigned­Int R The number of entries in the FlowStats table. - 2.0
Device.­Mo­CA.­Interface.­{i}.­Qo­S.­Flow­Stats.­{i}. object(0:) R

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

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

- 2.0
Flow­ID unsigned­Int R The flow ID used to identify a flow in the network. This parameter is based on mocaIfFlowID from [MOCA11-MIB]. - 2.0
Packet­DA string­(:17) R [MACAddress] The Destination Address (DA) for the packets in this flow. This parameter is based on mocaIfPacketDA from [MOCA11-MIB]. - 2.0
Max­Rate unsigned­Int R Maximum required rate in Kbps. This parameter is based on mocaIfPeakDataRate from [MOCA11-MIB]. - 2.0
Max­Burst­Size unsigned­Int R Maximum burst size. This parameter is based on mocaIfBurstSize from [MOCA11-MIB]. - 2.0
Lease­Time unsigned­Int R Flow lease time (expressed in seconds). A LeaseTime of 0 means unlimited lease time. This parameter is based on mocaIfLeaseTime from [MOCA11-MIB]. - 2.0
Lease­Time­Left unsigned­Int R Flow lease time remaining (expressed in seconds). If LeaseTime is 0 then a LeaseTimeLeft of 0 means unlimited lease time; otherwise, a LeaseTimeLeft of 0 means expired. This parameter is based on mocaIfLeaseTimeLeft from [MOCA11-MIB]. - 2.0
Flow­Packets unsigned­Int R The number of packets transmitted for this flow. This parameter is based on mocaIfTxPacketsFlow from [MOCA11-MIB]. - 2.0
Device.­Mo­CA.­Interface.­{i}.­Associated­Device.­{i}. object(0:) R

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

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

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

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

  • \d+(.\d+)* This parameter is based on mocaNodeMocaVersion from [MOCA11-MIB].
- 2.0
PHYTx­Rate unsigned­Int R The PHY transmit rate (in Mbps) to this remote device. This parameter is based on mocaMeshTxRate from [MOCA11-MIB]. - 2.0
PHYRx­Rate unsigned­Int R The PHY receive rate (in Mbps) from this remote device. - 2.0
Tx­Power­Control­Reduction unsigned­Int R The reduction in transmitter level (in dB) due to power control. This parameter is based on mocaNodeTxPowerReduction from [MOCA11-MIB]. - 2.0
Rx­Power­Level unsigned­Int R The power level (in dBm) received at the MoCA interface from this remote device. This parameter is based on mocaNodeRxPower from [MOCA11-MIB]. - 2.0
Tx­Bcast­Rate unsigned­Int R The broadcast PHY transmit rate (in Mbps) from this remote device. This parameter is based on mocaNodeTxGcdRate from [MOCA11-MIB]. - 2.0
Rx­Bcast­Power­Level unsigned­Int R The power level (in dBm) received at the MoCA interface from this remote device. This parameter is based on mocaNodeRxGcdPower from [MOCA11-MIB]. - 2.0
Tx­Packets unsigned­Int R The number of packets transmitted to this remote device (Note: Includes Broadcast, Multicast and Unicast packets). - 2.0
Rx­Packets unsigned­Int R The number of packets received from this remote device (Note: Includes Broadcast, Multicast and Unicast packets). This parameter is based on mocaNodeRxPackets from [MOCA11-MIB]. - 2.0
Rx­Errored­And­Missed­Packets unsigned­Int R The number of errored and missed packets received from this remote device. This parameter is based on mocaNodeRxDrops from [MOCA11-MIB]. - 2.0
QAM256Capable boolean R Whether this remote device supports the 256 QAM feature. This parameter is based on mocaNodeQAM256Capable from [MOCA11-MIB]. - 2.0
Packet­Aggregation­Capability unsigned­Int­(0:10) R The packet aggregation capability supported by the remote device. Standard values are 0 (no support), 6 (6 packets) or 10 (10 packets). This parameter is based on mocaNodePacketsAggrCapability from [MOCA11-MIB]. - 2.0
Rx­SNR unsigned­Int R The signal to noise level (in dBm) received at this interface from this remote device. This parameter is based on mocaNodeSNR from [MOCA11-MIB]. - 2.0
Active boolean R Whether or not this remote device is currently present in the MoCA network. The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE. - 2.0
Device.­Home­Plug. object R HomePlug object that contains the Interface table. The HomePlug industry standard [HPAV1.1] defines peer to peer communication over powerline medium. - 2.0
Interface­Number­Of­Entries unsigned­Int R The number of entries in the Interface table. - 2.0
Device.­Home­Plug.­Interface.­{i}. object(0:) R

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

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

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

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863].
- 2.0
Alias string­(:64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object. - 2.0
Name string­(:64) R The textual name of the interface as assigned by the CPE. - 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the interface entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Device.HomePlug.Interface.{i}. is a layer 1 interface, it is expected that LowerLayers will not be used. - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.0
MACAddress string­(:17) R [MACAddress] The MAC Address of the interface. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter. - 2.0
Logical­Network string­(:64) W The textual name of the HomePlug Logical Network. - 2.0
Version string­(:16) R Indicates the HomePlug version of the interface. This element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example:
  • “1.0”
  • “1.1”
- 2.0
Firmware­Version string­(:64) R The firmware version of the interface. - 2.0
Force­CCo boolean W

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

The factory default value MUST be false.

- 2.0
Network­Password string­(:32) W

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

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

- 2.0
Other­Networks­Present string­(:64)[] R Comma-separated list (maximum number of characters per item 64) of strings. Indicates whether any other HomePlug networks are currently visible via this interface. Examples of valid list items include, but are not limited to:
  • “HomePlugAV”
  • “HomePlug1.0”
  • “Other”
- 2.0
Max­Bit­Rate unsigned­Int R The maximum PHY bit rate supported by this interface (expressed in Mbps). - 2.0
Associated­Device­Number­Of­Entries unsigned­Int R The number of entries in the AssociatedDevice table. - 2.0
Device.­Home­Plug.­Interface.­{i}.­Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int 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. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
MPDUTx­Ack unsigned­Long R HomePlug-specific statistic. The Number of MAC Protocol Data Units (MPDUs) Transmitted and Acknowledged. - 2.0
MPDUTx­Col unsigned­Long R HomePlug-specific statistic. The Number of MAC Protocol Data Units (MPDUs) Transmitted and Collided - 2.0
MPDUTx­Failed unsigned­Long R HomePlug-specific statistic. The Number of MAC Protocol Data Units (MPDUs) Transmitted and Failed - 2.0
MPDURx­Ack unsigned­Long R HomePlug-specific statistic. The Number of MAC Protocol Data Units (MPDUs) Received and Acknowledged - 2.0
MPDURx­Failed unsigned­Long R HomePlug-specific statistic. The Number of MAC Protocol Data Units (MPDUs) Received and Failed - 2.0
Device.­Home­Plug.­Interface.­{i}.­Associated­Device.­{i}. object(0:) R

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

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

- 2.0
MACAddress string­(:17) R [MACAddress] MAC address of remote HomePlug device. It is used to uniquely identify and easily correlate with the connected remote HomePlug device. - 2.0
Tx­Phy­Rate unsigned­Int R The PHY transmit Rate (expressed in Mbps) to this remote device. - 2.0
Rx­Phy­Rate unsigned­Int R The PHY receive Rate (expressed in Mbps) from this remote device. - 2.0
SNRPer­Tone unsigned­Int­[:1155] R Comma-separated list (up to 1155 items) of unsigned integers. List items indicate Signal to Noise Ratio (SNR) per tone from this remote device (expressed in 0.1dB). - 2.0
Avg­Attenuation unsigned­Int R Average attenuation from this remote device (expressed in 0.1dB). - 2.0
End­Station­MACs string­(:17)[:16] R [MACAddress] Comma-separated list (up to 16 items) of MAC Addresses. List items represent MAC addresses of end stations bridged by the remote HomePlug device. For example: “11:22:33:AA:BB:CC, 22:33:44:DD:EE:66” - 2.0
Active boolean R Whether or not this device is currently present in the HomePlug network. The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE. - 2.0
Device.­UPA. object R Universal Powerline Association [UPA-PLC]. This object contains the Interface and Diagnostics objects. - 2.0
Interface­Number­Of­Entries unsigned­Int R The number of entries in the Interface table. - 2.0
Device.­UPA.­Interface.­{i}. object(0:) R

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

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

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

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863].
- 2.0
Alias string­(:64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object. - 2.0
Name string­(:64) R The textual name of the interface as assigned by the CPE. - 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the interface entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Device.UPA.Interface.{i}. is a layer 1 interface, it is expected that LowerLayers will not be used. - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.0
MACAddress string­(:17) R [MACAddress] The MAC Address of the interface. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter. - 2.0
Firmware­Version string­(:64) R This interface’s firmware version. - 2.0
Max­Bit­Rate unsigned­Int R The maximum PHY bit rate supported by this interface (expressed in Mbps). - 2.0
Node­Type string W

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

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

Encryption Method used by UPA device. Enumeration of:

  • None
  • DES
  • 3DES
  • AES128
  • AES256
- 2.0
Encryption­Key string­(:36) W

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

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

- 2.0
Power­Backoff­Enabled boolean W Power back-off management feature status in the UPA device. Boolean can be true for “enabled” and false for “disabled”. - 2.0
Power­Backoff­Mechanism­Active boolean R Show if power back-off mechanism is active at that time in the UPA device. Boolean can be true for “active” and false for “not active”. - 2.0
Est­Application­Throughput unsigned­Int R The estimated application throughput (expressed in Mbps), received from the PLC link. This value can be used to indicate link quality. - 2.0
Active­Notch­Enable boolean W Enables or disables the ActiveNotch table for this interface. - 2.0
Active­Notch­Number­Of­Entries unsigned­Int R The number of entries in the ActiveNotch table. - 2.0
Associated­Device­Number­Of­Entries unsigned­Int R The number of entries in the AssociatedDevice table. - 2.0
Bridge­For­Number­Of­Entries unsigned­Int R The number of entries in the BridgeFor table. - 2.0
Device.­UPA.­Interface.­{i}.­Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int 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. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Device.­UPA.­Interface.­{i}.­Associated­Device.­{i}. object(0:) R

This table contains information about PLC connections running between this UPA interface and other UPA devices.

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

- 2.0
MACAddress string­(:17) R [MACAddress] Remote UPA device MAC address. - 2.0
Port unsigned­Int­(0:65535) R The PLC port number. - 2.0
Logical­Network string­(:20) R The name of the logical PLC network (human readable string). In the case where the associated device belongs to a different powerline network than the UPA interface, the actual network identifier of the neighboring network is not shown in LogicalNetwork. Rather, only a generic string, e.g. “Network 1”, “Network 2”, etc is stored here due to security/privacy implications. - 2.0
Phy­Tx­Throughput unsigned­Int R Physical transmission throughput (in Mbps). - 2.0
Phy­Rx­Throughput unsigned­Int R Physical reception throughput (in Mbps). - 2.0
Real­Phy­Rx­Throughput unsigned­Int R Real Physical reception throughput (in Mbps). - 2.0
Estimated­PLR unsigned­Int­(0:100) R Estimated PDU Loss Rate measurement between two devices (i.e. estimated percent of MPDUs that have been received with errors). - 2.0
Mean­Estimated­Att unsigned­Int R Mean estimated attenuation (i.e. channel loss between the local interface and the remote device). It is measured in dB. - 2.0
Smart­Route­Intermediate­PLCMAC string­(:17) R [MACAddress] Intermediate UPA adapter MAC address of the device that is acting as a relay to increase coverage in mesh scenarios. This is the MAC address of a third UPA device, with which the UPA interface is doing smart repeating in order to transmit data to the associated MACAddress UPA device. SmartRouteIntermediatePLCMAC will be empty when DirectRoute is true. - 2.0
Direct­Route boolean R Route status, where true indicates direct and false indicates indirect. - 2.0
Active boolean R Whether or not this node is currently present in the UPA network. The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE. - 2.0
Device.­UPA.­Interface.­{i}.­Active­Notch.­{i}. object(0:) W

This object contains the list of active notches of the UPA interface. A UPA device can have notches in its spectrum, where no power is transmitted in a given part of the spectrum. These notches are typically located in amateur radio bands, to avoid interference. Note: All Device.UPA.Interface.{i}.ActiveNotch.{i}. entries can be enabled/disabled as a group using the ActiveNotchEnable parameter.

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

- 2.0
Enable boolean W Enables or disables the active notch entry. false 2.0
Alias string­(:64) W

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

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

- 2.0
Start­Freq unsigned­Int W The initial frequency (in kHz) of a notch enabled in the spectrum of the local interface. - 2.0
Stop­Freq unsigned­Int W The final frequency (in kHz) of a notch enabled in the spectrum of the local interface. - 2.0
Depth unsigned­Int W The depth (in dB) of a notch enabled in the spectrum of the local interface. - 2.0
Device.­UPA.­Interface.­{i}.­Bridge­For.­{i}. object(0:) R

This object represents the bridge table of the UPA interface. Each instance is a bridge table entry. It shows the MAC addresses of the remote UPA devices with their associated port number, and the MAC addresses of the end-devices (PCs, STBs, routers, etc) connected to Ethernet port of the powerline adapters with their associated logical port. In this way the system identifies to which UPA device an external device is connected to.

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

- 2.0
Alias string­(:64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object. - 2.0
MACAddress string­(:17) R [MACAddress] MAC address of the device. - 2.0
Port unsigned­Int­(0:65535) R Internal bridge associated port. - 2.0
Device.­UPA.­Diagnostics. object R The UPA Diagnostics object. - 2.0
Device.­UPA.­Diagnostics.­Interface­Measurement. object R This object provides access to either a Signal-to-Noise-Ratio (SNR) Port Measurement test or a Channel Frequency Response (CFR) Port Measurement test. The Type parameter is used to select which type of test to perform. CFR and SNR measurements are done between a two UPA devices (a local interface and a remote device belonging to the same network). - 2.0
Diagnostics­State string W

Indicates availability of diagnostic data. Enumeration of:

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

Indicates the type of port measurement test to be carried out. Enumeration of:

  • SNR (Signal-to-Noise-Ratio)
  • CFR (Channel Frequency Response) .
- 2.0
Interface string­(:256) W The value MUST be the Path Name of a row in the UPA.Interface. table. This is the local UPA interface from which the test is to be performed. - 2.0
Port unsigned­Int­(0:65535) W PLC port being measured. This identifies which PLC connection to measure between the local interface (indicated by Interface) and the remote device (implied by Port). - 2.0
Measurements unsigned­Int­[:1536] R Comma-separated list (up to 1536 items) of unsigned integers. Result of Signal-to-Noise-Ratio measurement (if Type is SNR) or Channel Frequency Response measurement (if Type is CFR). List items indicate measurements per carrier for a PLC port (expressed in 0.1dB). - 2.0
Rx­Gain int R Reception gain of the adapter (expresssed in dB). - 2.0
Device.­Wi­Fi. object R The WiFi object is based on the WiFi Alliance 802.11 specifications ([802.11-2007]). It defines interface objects (Radio and SSID), and application objects (AccessPoint and EndPoint). - 2.0
Radio­Number­Of­Entries unsigned­Int R The number of entries in the Radio table. - 2.0
SSIDNumber­Of­Entries unsigned­Int R The number of entries in the SSID table. - 2.0
Access­Point­Number­Of­Entries unsigned­Int R The number of entries in the AccessPoint table. - 2.0
End­Point­Number­Of­Entries unsigned­Int R The number of entries in the EndPoint table. - 2.0
Device.­Wi­Fi.­Radio.­{i}. object(0:) R

This object models an 802.11 wireless radio on a device (a stackable interface object as described in [Section 4.2/TR-181i2]). If the device can establish more than one connection simultaneously (e.g. a dual radio device), a separate Device.WiFi.Radio.{i}. instance MUST be used for each physical radio of the device. See [Appendix III.1/TR-181i2] for additional information. Note: A dual-band single-radio device (e.g. an 802.11a/b/g radio) can be configured to operate at 2.4 or 5 GHz frequency bands, but only a single frequency band is used to transmit/receive at a given time. Therefore, a single Device.WiFi.Radio.{i}. instance is used even for a dual-band radio.

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

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

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863].
- 2.0
Alias string­(:64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object. - 2.0
Name string­(:64) R The textual name of the radio as assigned by the CPE. - 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the radio entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since Device.WiFi.Radio.{i}. is a layer 1 interface, it is expected that LowerLayers will not be used. - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.0
Max­Bit­Rate unsigned­Int R The maximum PHY bit rate supported by this interface (expressed in Mbps). - 2.0
Supported­Frequency­Bands string­[] R

Comma-separated list of strings. List items indicate the frequency bands at which the radio can operate. Each list item is an enumeration of:

  • 2.4GHz
  • 5GHz
- 2.0
Operating­Frequency­Band string W The value MUST be a member of the list reported by the SupportedFrequencyBands parameter. Indicates the frequency band at which the radio is operating. If the radio supports multiple bands, and OperatingFrequencyBand is changed, then all parameters whose value is not valid for the new frequency band (e.g. Channel) MUST be set to a valid value (according to some CPE vendor-specific behavior). - 2.0
Supported­Standards string­[] R

Comma-separated list of strings. List items indicate which IEEE 802.11 standards this Device.WiFi.Radio.{i}. instance can support simultaneously, in the frequency band specified by OperatingFrequencyBand. Each list item is an enumeration of:

- 2.0
Operating­Standards string­[] W Each list item MUST be a member of the list reported by the SupportedStandards parameter. Comma-separated list of strings. List items indicate which IEEE 802.11 standard this Device.WiFi.Radio.{i}. instance is configured for. Each value indicates support for the indicated standard. If OperatingFrequencyBand is set to 2.4GHz, only values b, g, n are allowed. If OperatingFrequencyBand is set to 5GHz, only values a, n are allowed. For example, a value of “g,b” (or “b,g” - order is not important) means that the 802.11g standard [802.11g-2003] is used with a backwards-compatible mode for 802.11b [802.11b-1999]. A value of “g” means that only the 802.11g standard can be used. - 2.0
Possible­Channels string­(:1024)[] R Comma-separated list (maximum number of characters per item 1024) of strings. List items represent possible radio channels for the wireless standard (a, b, g, n) and the regulatory domain. Ranges in the form “n-m” are permitted. For example, for 802.11b and North America, would be “1-11”. - 2.0
Channels­In­Use string­(:1024)[] R Comma-separated list (maximum number of characters per item 1024) of strings. List items represent channels that the radio determines to be currently in use (including any that it is using itself). Ranges in the form “n-m” are permitted. - 2.0
Channel unsigned­Int­(1:255) W The current radio channel used by the connection. To request automatic channel selection, set AutoChannelEnable to true. Whenever AutoChannelEnable is true, the value of the Channel parameter MUST be the channel selected by the automatic channel selection procedure. Note: Valid Channel values depend on the OperatingFrequencyBand and RegulatoryDomain values specified. - 2.0
Auto­Channel­Supported boolean R Indicates whether automatic channel selection is supported by this radio. If false, then AutoChannelEnable MUST be false. - 2.0
Auto­Channel­Enable boolean W Enable or disable automatic channel selection. Set to false to disable the automatic channel selection procedure, in which case the currently selected channel remains selected. Set to true to enable the automatic channel selection procedure. This procedure MUST automatically select the channel, and MAY also change it subsequently. AutoChannelEnable MUST automatically change to false whenever the channel is manually selected, i.e. whenever the Channel parameter is written. Whenever AutoChannelEnable is true, the value of the Channel parameter MUST be the channel selected by the automatic channel selection procedure. - 2.0
Auto­Channel­Refresh­Period unsigned­Int W The time period in seconds between two consecutive automatic channel selections. A value of 0 means that the automatic channel selection is done only at boot time. This parameter is significant only if AutoChannelEnable is set to true. - 2.0
Operating­Channel­Bandwidth string W

The channel bandwidth (applicable to 802.11n specifications only). Enumeration of:

  • 20MHz
  • 40MHz (wide mode)
  • Auto
- 2.0
Extension­Channel string W

The secondary extension channel position, applicable when operating in wide channel mode (i.e. when OperatingChannelBandwidth is set to 40MHz or Auto). Enumeration of:

  • AboveControlChannel
  • BelowControlChannel
  • Auto
- 2.0
Guard­Interval string W

The guard interval value between OFDM symbols (applicable to 802.11n specifications only). Enumeration of:

  • 400nsec
  • 800nsec
  • Auto
- 2.0
MCS int­(-­1:15,­16:31) W The Modulation Coding Scheme index (applicable to 802.11n specifications only). Values from 0 to 15 MUST be supported ([802.11n-2009]). A value of -1 indicates automatic selection of the MCS index. - 2.0
Transmit­Power­Supported int­(-­1:100)(:64)[] R Comma-separated list (maximum number of characters per item 64) of integers (-1 to 100). List items represent supported transmit power levels as percentage of full power. For example, “0,25,50,75,100”. A -1 item indicates auto mode (automatic decision by CPE). Auto mode allows the Radio to adjust transmit power accordingly. For example, this can be useful for power-save modes such as EU-CoC, where the Radio can adjust power according to activity in the CPE. - 2.0
Transmit­Power int­(-­1:100) W Indicates the current transmit power level as a percentage of full power. The value MUST be one of the values reported by the TransmitPowerSupported parameter. A value of -1 indicates auto mode (automatic decision by CPE). - 2.0
IEEE80211h­Supported boolean R Indicates whether IEEE 802.11h [802.11h-2003] functionality is supported by this radio. The value can be true only if the 802.11a or the 802.11n@5GHz standard is supported (i.e. SupportedFrequencyBands includes 5GHz and SupportedStandards includes a and/or n). - 2.0
IEEE80211h­Enabled boolean W Indicates whether IEEE 802.11h functionality is enabled on this radio. The value can be true only if the 802.11a or the 802.11n@5GHz standard is supported and enabled (i.e. OperatingFrequencyBand is 5GHz and OperatingStandards includes a and/or n). - 2.0
Regulatory­Domain string­(3) W

The 802.11d Regulatory Domain. First two octets are [ISO3166-1] two-character country code. The third octet is either “ “ (all environments), “O” (outside) or “I” (inside). Possible patterns:

  • [[A-Z]A-Z][ OI]
- 2.0
Device.­Wi­Fi.­Radio.­{i}.­Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Discard­Packets­Sent unsigned­Int 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. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Device.­Wi­Fi.­SSID.­{i}. object(0:) W

WiFi SSID table (a stackable interface object as described in [Section 4.2/TR-181i2]), where table entries model the MAC layer. A WiFi SSID entry is typically stacked on top of a Radio object. WiFi SSID is also a multiplexing layer, i.e. more than one Device.WiFi.SSID.{i}. can be stacked above a single Radio.

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

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

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863].
Down 2.0
Alias string­(:64) W

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

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

- 2.0
Name string­(:64) R

The textual name of the SSID entry as assigned by the CPE.

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

- 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the SSID entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. 2.0
BSSID string­(:17) R [MACAddress] The Basic Service Set ID. This is the MAC address of the access point, which can either be local (when this instance models an access point SSID) or remote (when this instance models an end point SSID). - 2.0
MACAddress string­(:17) R [MACAddress] The MAC address of this interface. If this instance models an access point SSID, MACAddress is the same as MACAddress. Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter. - 2.0
SSID string­(:32) W The current service set identifier in use by the connection. The SSID is an identifier that is attached to packets sent over the wireless LAN that functions as an ID for joining a particular radio network (BSS). - 2.0
Device.­Wi­Fi.­SSID.­{i}.­Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int 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. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Device.­Wi­Fi.­Access­Point.­{i}. object(0:) W

This object models an 802.11 connection from the perspective of a wireless access point. Each Device.WiFi.AccessPoint.{i}. entry is associated with a particular SSID interface instance via the SSIDReference parameter. For enabled table entries, if SSIDReference is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The Device.WiFi.AccessPoint.{i}. table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Device.WiFi.AccessPoint.{i}. row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending Device.WiFi.AccessPoint.{i}. row.

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

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

Indicates the status of this access point. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 2.0
Alias string­(:64) W

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

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

- 2.0
SSIDReference string­(:256) W The value MUST be the Path Name of a row in the SSID. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. 2.0
SSIDAdvertisement­Enabled boolean W Indicates whether or not beacons include the SSID name. - 2.0
Retry­Limit unsigned­Int­(0:7) W The maximum number of retransmission for a packet. This corresponds to IEEE 802.11 parameter dot11ShortRetryLimit. - 2.0
WMMCapability boolean R Indicates whether this access point supports WiFi Multimedia (WMM) Access Categories (AC). - 2.0
UAPSDCapability boolean R Indicates whether this access point supports WMM Unscheduled Automatic Power Save Delivery (U-APSD). Note: U-APSD support implies WMM support. - 2.0
WMMEnable boolean W Whether WMM support is currently enabled. When enabled, this is indicated in beacon frames. - 2.0
UAPSDEnable boolean W Whether U-APSD support is currently enabled. When enabled, this is indicated in beacon frames. Note: U-APSD can only be enabled if WMM is also enabled. - 2.0
Associated­Device­Number­Of­Entries unsigned­Int R The number of entries in the AssociatedDevice table. - 2.0
Device.­Wi­Fi.­Access­Point.­{i}.­Security. object R This object contains security related parameters that apply to a CPE acting as an Access Point [802.11-2007]. - 2.0
Modes­Supported string­[] R

Comma-separated list of strings. Indicates which security modes this instance is capable of supporting. Each list item is an enumeration of:

  • None
  • WEP-64
  • WEP-128
  • WPA-Personal
  • WPA2-Personal
  • WPA-WPA2-Personal
  • WPA-Enterprise
  • WPA2-Enterprise
  • WPA-WPA2-Enterprise
- 2.0
Mode­Enabled string W The value MUST be a member of the list reported by the ModesSupported parameter. Indicates which security mode is enabled. - 2.0
WEPKey hex­Binary­(5,­13) W

A WEP key expressed as a hexadecimal string. WEPKey is used only if ModeEnabled is set to WEP-64 or WEP-128. A 5 byte WEPKey corresponds to security mode WEP-64 and a 13 byte WEPKey corresponds to security mode WEP-128.

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

- 2.0
Pre­Shared­Key hex­Binary­(:32) W

A literal PreSharedKey (PSK) expressed as a hexadecimal string. PreSharedKey is only used if ModeEnabled is set to WPA-Personal or WPA2-Personal or WPA-WPA2-Personal. If KeyPassphrase is written, then PreSharedKey is immediately generated. The ACS SHOULD NOT set both the KeyPassphrase and the PreSharedKey directly (the result of doing this is undefined).

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

- 2.0
Key­Passphrase string­(:63) W

A passphrase from which the PreSharedKey is to be generated, for WPA-Personal or WPA2-Personal or WPA-WPA2-Personal security modes. If KeyPassphrase is written, then PreSharedKey is immediately generated. The ACS SHOULD NOT set both the KeyPassphrase and the PreSharedKey directly (the result of doing this is undefined). The key is generated as specified by WPA, which uses PBKDF2 from PKCS #5: Password-based Cryptography Specification Version 2.0 ([RFC2898]).

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

- 2.0
Rekeying­Interval unsigned­Int W The interval (expressed in seconds) in which the keys are re-generated. This is applicable to WPA, WPA2 and Mixed (WPA-WPA2) modes in Personal or Enterprise mode (i.e. when ModeEnabled is set to a value other than None or WEP-64 or WEP-128. 3600 2.0
Radius­Server­IPAddr string­(:45) W [IPAddress] The IP Address of the RADIUS server used for WLAN security. RadiusServerIPAddr is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise or WPA-WPA2-Enterprise). - 2.0
Radius­Server­Port unsigned­Int W The port number of the RADIUS server used for WLAN security. RadiusServerPort is only applicable when ModeEnabled is an Enterprise type (i.e. WPA-Enterprise, WPA2-Enterprise or WPA-WPA2-Enterprise). 1812 2.0
Radius­Secret string W

The secret used for handshaking with the RADIUS server [RFC2865].

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

- 2.0
Device.­Wi­Fi.­Access­Point.­{i}.­WPS. object R This object contains parameters related to Wi-Fi Protected Setup [WPSv1.0] for this access point. - 2.0
Enable boolean W Enables or disables WPS functionality for this access point. true 2.0
Config­Methods­Supported string­[] R

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

  • USBFlashDrive
  • Ethernet
  • ExternalNFCToken
  • IntegratedNFCToken
  • NFCInterface
  • PushButton
  • PIN This parameter corresponds directly to the “Config Methods” attribute of the WPS specification [WPSv1.0]. The PushButton and PIN methods MUST be supported.
- 2.0
Config­Methods­Enabled string­[] W Each list item MUST be a member of the list reported by the ConfigMethodsSupported parameter. Comma-separated list of strings. Indicates WPS configuration methods enabled on the device. - 2.0
Device.­Wi­Fi.­Access­Point.­{i}.­Associated­Device.­{i}. object(0:) R

A table of the devices currently associated with the access point.

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

- 2.0
MACAddress string­(:17) R [MACAddress] The MAC address of an associated device. - 2.0
Authentication­State boolean R Whether an associated device has authenticated (true) or not (false). - 2.0
Last­Data­Downlink­Rate unsigned­Int­(1000:600000) R The data transmit rate in kbps that was most recently used for transmission from the access point to the associated device. - 2.0
Last­Data­Uplink­Rate unsigned­Int­(1000:600000) R The data transmit rate in kbps that was most recently used for transmission from the associated device to the access point. - 2.0
Signal­Strength int­(-­200:0) R An indicator of radio signal strength of the uplink from the associated device to the access point, measured in dBm, as an average of the last 100 packets received from the device. - 2.0
Retransmissions unsigned­Int­(0:100) R The number of packets that had to be re-transmitted, from the last 100 packets sent to the associated device. Multiple re-transmissions of the same packet count as one. - 2.0
Active boolean R Whether or not this node is currently present in the WiFi AccessPoint network. The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE. - 2.0
Device.­Wi­Fi.­End­Point.­{i}. object(0:) W

This object models an 802.11 connection from the perspective of a wireless end point. Each Device.WiFi.EndPoint.{i}. entry is associated with a particular SSID interface instance via the SSIDReference parameter, and an associated active Profile instance via the ProfileReference parameter. The active profile is responsible for specifying the actual SSID and security settings used by the end point. For enabled table entries, if SSIDReference or ProfileReference is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The Device.WiFi.EndPoint.{i}. table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Device.WiFi.EndPoint.{i}. row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending Device.WiFi.EndPoint.{i}. row.

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

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

Indicates the status of this end point. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 2.0
Alias string­(:64) W

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

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

- 2.0
Profile­Reference string­(:256) W The value MUST be the Path Name of a row in the Profile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is the currently active profile, which specifies the SSID and security settings to be used by the end point. 2.0
SSIDReference string­(:256) R The value MUST be the Path Name of a row in the SSID. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. SSIDReference is determined based on the Profile.{i}.SSID within the associated ProfileReference) endpoint profile. SSIDReference MUST be an empty string if ProfileReference is an empty string (i.e. only when an active profile is assigned can the associated SSID interface be determined). 2.0
Profile­Number­Of­Entries unsigned­Int R The number of entries in the Profile table. - 2.0
Device.­Wi­Fi.­End­Point.­{i}.­Stats. object R Throughput statistics for this end point. - 2.0
Last­Data­Downlink­Rate unsigned­Int­(1000:600000) R The data transmit rate in kbps that was most recently used for transmission from the access point to the end point device. - 2.0
Last­Data­Uplink­Rate unsigned­Int­(1000:600000) R The data transmit rate in kbps that was most recently used for transmission from the end point to the access point device. - 2.0
Signal­Strength int­(-­200:0) R An indicator of radio signal strength of the downlink from the access point to the end point, measured in dBm, as an average of the last 100 packets received from the device. - 2.0
Retransmissions unsigned­Int­(0:100) R The number of packets that had to be re-transmitted, from the last 100 packets sent to the access point. Multiple re-transmissions of the same packet count as one. 0 2.0
Device.­Wi­Fi.­End­Point.­{i}.­Security. object R This object contains security related parameters that apply to a WiFi end point [802.11-2007]. - 2.0
Modes­Supported string­[] R

Comma-separated list of strings. Indicates which security modes this instance is capable of supporting. Each list item is an enumeration of:

  • None
  • WEP-64
  • WEP-128
  • WPA-Personal
  • WPA2-Personal
  • WPA-WPA2-Personal
  • WPA-Enterprise
  • WPA2-Enterprise
  • WPA-WPA2-Enterprise
- 2.0
Device.­Wi­Fi.­End­Point.­{i}.­Profile.­{i}. object(0:) W

EndPoint Profile table.

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

- 2.0
Enable boolean W Enables or disables this Profile. When there are multiple WiFi EndPoint Profiles, e.g. each instance supports a different SSID and/or different security configuration, this parameter can be used to control which of the instances are currently enabled. false 2.0
Status string R

Indicates the status of this Profile. Enumeration of:

  • Active
  • Available
  • Error (OPTIONAL)
  • Disabled The Active value is reserved for the instance that is actively connected. The Available value represents an instance that is not currently active, but is also not disabled or in error. The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 2.0
Alias string­(:64) W

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

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

- 2.0
SSID string­(:32) W The profile identifier in use by the connection. The SSID is an identifier that is attached to packets sent over the wireless LAN that functions as an ID for joining a particular radio network (BSS). - 2.0
Location string W Location of the profile. This value serves as a reminder from the user, describing the location of the profile. For example: “Home”, “Office”, “Neighbor House”, “Airport”, etc. An empty string is also valid. - 2.0
Priority unsigned­Int­(:255) W The profile Priority defines one of the criteria used by the End Point to automatically select the “best” AP when several APs with known profiles are simultaneously available for association. In this situation, the End Point has to select the AP with the higher priority in its profile. If there are several APs with the same priority, providing different SSID or the same SSID, then the wireless end point has to select the APs according to other criteria like signal quality, SNR, etc. 0 is the highest priority. 0 2.0
Device.­Wi­Fi.­End­Point.­{i}.­Profile.­{i}.­Security. object R This object contains security related parameters that apply to a WiFi End Point profile [802.11-2007]. - 2.0
Mode­Enabled string W The value MUST be a member of the list reported by the Security.ModesSupported parameter. Indicates which security mode is enabled. - 2.0
WEPKey hex­Binary­(5,­13) W

A WEP key expressed as a hexadecimal string. WEPKey is used only if ModeEnabled is set to WEP-64 or WEP-128. A 5 byte WEPKey corresponds to security mode WEP-64 and a 13 byte WEPKey corresponds to security mode WEP-128.

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

- 2.0
Pre­Shared­Key hex­Binary­(:32) W

A literal PreSharedKey (PSK) expressed as a hexadecimal string. PreSharedKey is only used if ModeEnabled is set to WPA-Personal or WPA2-Personal or WPA-WPA2-Personal. If KeyPassphrase is written, then PreSharedKey is immediately generated. The ACS SHOULD NOT set both the KeyPassphrase and the PreSharedKey directly (the result of doing this is undefined).

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

- 2.0
Key­Passphrase string­(:63) W

A passphrase from which the PreSharedKey is to be generated, for WPA-Personal or WPA2-Personal or WPA-WPA2-Personal security modes. If KeyPassphrase is written, then PreSharedKey is immediately generated. The ACS SHOULD NOT set both the KeyPassphrase and the PreSharedKey directly (the result of doing this is undefined). The key is generated as specified by WPA, which uses PBKDF2 from PKCS #5: Password-based Cryptography Specification Version 2.0 [RFC2898].

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

- 2.0
Device.­Wi­Fi.­End­Point.­{i}.­WPS. object R This object contains parameters related to Wi-Fi Protected Setup [WPSv1.0] for this end point. - 2.0
Enable boolean W Enables or disables WPS functionality for this end point. true 2.0
Config­Methods­Supported string­[] R

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

  • USBFlashDrive
  • Ethernet
  • ExternalNFCToken
  • IntegratedNFCToken
  • NFCInterface
  • PushButton
  • PIN This parameter corresponds directly to the “Config Methods” attribute of the WPS specification [WPSv1.0].
- 2.0
Config­Methods­Enabled string­[] W Each list item MUST be a member of the list reported by the ConfigMethodsSupported parameter. Comma-separated list of strings. Indicates the WPS configuration methods enabled on the device. - 2.0
Device.­Bridging. object R Layer 2 bridging configuration. Specifies bridges between different layer 2 interfaces. Bridges can be defined to include layer 2 filter criteria to selectively bridge traffic between interfaces. This object can be used to configure both 802.1D [802.1D-2004] and 802.1Q [802.1Q-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. - 2.0
Max­Bridge­Entries unsigned­Int R The maximum number of entries available in the Bridging.Bridge table. - 2.0
Max­DBridge­Entries unsigned­Int R The maximum number of 802.1D [802.1D-2004] entries available in the Bridging.Bridge table. A positive value for this parameter implies support for 802.1D. There is no guarantee that this many 802.1D Bridges can be configured. For example, the CPE might not be able simultaneously to support both 802.1D and 802.1Q Bridges. - 2.0
Max­QBridge­Entries unsigned­Int R The maximum number of 802.1Q [802.1Q-2005] entries available in the Bridging.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. - 2.0
Max­VLANEntries unsigned­Int R The maximum number of 802.1Q [802.1Q-2005] VLANs supported per Bridging.Bridge table entry. - 2.0
Max­Filter­Entries unsigned­Int R The maximum number of entries available in the Filter table. - 2.0
Bridge­Number­Of­Entries unsigned­Int R The number of entries in the Bridge table. - 2.0
Filter­Number­Of­Entries unsigned­Int R The number of entries in the Filter table. - 2.0
Device.­Bridging.­Bridge.­{i}. object(0:) W

Bridge table.

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

- 2.0
Enable boolean W Enables or disables this Device.Bridging.Bridge.{i}.. false 2.0
Status string R

The status of this Device.Bridging.Bridge.{i}.. Enumeration of:

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

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

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

- 2.0
Standard string W

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

- 2.0
Port­Number­Of­Entries unsigned­Int R The number of entries in the Port table. - 2.0
VLANNumber­Of­Entries unsigned­Int R The number of entries in the VLAN table. - 2.0
VLANPort­Number­Of­Entries unsigned­Int R The number of entries in the VLANPort table. - 2.0
Device.­Bridging.­Bridge.­{i}.­Port.­{i}. object(0:) W

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

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

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

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863].
Down 2.0
Alias string­(:64) W

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

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

- 2.0
Name string­(:64) R

The textual name of the bridge port as assigned by the CPE.

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

- 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the bridge port entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. When ManagementPort is set to true the CPE MUST set LowerLayers to reference all non-management bridge ports that are within the same Bridge instance (and update LowerLayers when subsequent non-management bridge ports are added or deleted on that Bridge). The ACS SHOULD NOT set LowerLayers in this case. 2.0
Management­Port boolean W If true then the entry is a management (upward facing) bridge port rather than a non-management (downward facing) bridge port. For a given Bridge instance, each management bridge port appears in the interface stack above all non-management bridge ports. The concept of Management Port is discussed in [Chapter 8/802.1Q-2005]. false 2.0
Default­User­Priority unsigned­Int­(0:7) W Bridge Port Default User Priority. - 2.0
Priority­Regeneration unsigned­Int­(0:7)[8:8] W Comma-separated list (8 items) of unsigned integers (0 to 7). List items represent user priority regeneration values for each ingress user priority on this Bridge Port. 0,­1,­2,­3,­4,­5,­6,­7 2.0
Port­State 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 2.0
PVID int­(1:4094) W PVID (or Port VID) is the VLAN ID with which an untagged or priority tagged frame that arrives on this port will be associated (i.e. default Port VLAN ID as defined in 802.1Q [802.1Q-2005]). For an 802.1D Bridge [802.1D-2004], this parameter MUST be ignored. 1 2.0
Acceptable­Frame­Types string W

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

  • AdmitAll
  • AdmitOnlyVLANTagged (OPTIONAL)
  • AdmitOnlyPrioUntagged (OPTIONAL) For an 802.1D [802.1D-2004] Bridge, the value of this parameter MUST be AdmitAll.
Admit­All 2.0
Ingress­Filtering boolean W Enables or disables Ingress Filtering as defined in 802.1Q [802.1Q-2005]. If enabled (true), causes frames arriving on this port to be discarded if the port is not in the VLAN ID’s member set (which is configured via the VLANPort table). For an 802.1D [802.1D-2004] Bridge, the value of this parameter MUST be false. false 2.0
Priority­Tagging boolean W Enables or disables priority tagging on this Bridge Port. When true, egress frames leaving this interface will be priority tagged with the frame’s associated priority value, which will either be derived directly from the ingress frame or else set via QoS.Classification.{i}.EthernetPriorityMark. When false, egress frames leaving this interface will be untagged. The parameter does not affect reception of ingress frames. Only applies on bridge ports that are untagged member of one or more VLAN’s. false 2.0
Device.­Bridging.­Bridge.­{i}.­Port.­{i}.­Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int 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. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Device.­Bridging.­Bridge.­{i}.­VLAN.­{i}. object(0:) W

Bridge VLAN table. If this table is supported, if MUST contain an entry for each VLAN known to the Bridge. This table only applies to an 802.1Q [802.1Q-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.

- 2.0
Enable boolean W Enables or disables this VLAN table entry. false 2.0
Alias string­(:64) W

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

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

- 2.0
Name string­(:64) W Human-readable name for this VLAN table entry. 2.0
VLANID int­(1:4094) W VLAN ID of the entry. - 2.0
Device.­Bridging.­Bridge.­{i}.­VLANPort.­{i}. object(0:) W

Bridge VLAN egress port and untagged port membership table. This table only applies to an 802.1Q [802.1Q-2005] Bridge. Note: The Device.Bridging.Bridge.{i}.VLANPort.{i}. table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Device.Bridging.Bridge.{i}.VLANPort.{i}. row to then violate the table’s unique key constraint; if this occurs, the CPE MUST disable the offending Device.Bridging.Bridge.{i}.VLANPort.{i}. row.

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

- 2.0
Enable boolean W Enables or disables this Device.Bridging.Bridge.{i}.VLANPort.{i}. entry. false 2.0
Alias string­(:64) W

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

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

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

Filter table containing classification filter entries, each of which expresses a set of classification criterion to classify ingress frames as member of a Bridge instance or a Bridge.{i}.VLAN instance. Bridge VLAN classification only applies for 802.1Q [802.1Q-2005] Bridges. For enabled table entries, if Bridge or Interface is an empty string then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

- 2.0
Enable boolean W Enables or disables this Filter table entry. false 2.0
Alias string­(:64) W

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

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

- 2.0
Status string R

The status of this Filter table entry. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPE to indicate a locally defined error condition. If the Bridge Port table is supported, but none of its entries correspond to Interface, or if such an entry exists but is disabled, Status MUST NOT indicate Enabled. If the Bridge VLAN table is supported, but none of its entries correspond to VLANIDFilter, or if such an entry exists but is disabled, Status MUST NOT indicate Enabled.
Disabled 2.0
Bridge string­(:256) W The value MUST be the Path Name of a Bridging.Bridge object in case of a 802.1D bridge or a Bridging.Bridge.{i}.VLAN object in case of a 802.1Q bridge. If the referenced object is deleted, the parameter value MUST be set to an empty string. Note: either way, this identifies the bridge (because each bridge has a VLAN table). Defines the Bridge or Bridge VLAN to which ingress frames will be classified based upon matches of the classification criteria. 2.0
Order unsigned­Int­(1:) W Position of the Device.Bridging.Filter.{i}. entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each ingress frame on the Interface, the highest ordered entry that matches the filter criteria is applied. All lower order entries are ignored. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a Device.Bridging.Filter.{i}. table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). - 2.0
Interface string­(:256) W The value MUST be the Path Name of a row in the Bridge.{i}.Port. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This MUST relate to the same bridge as does Bridge. Defines the Bridge Port on which ingress frame classification will occur. 2.0
VLANIDFilter unsigned­Int­(0:4094) W Classification criterion. The 802.1Q [802.1Q-2005] VLAN ID. For an 802.1D [802.1D-2004] Bridge, which has no concept of VLANs, the VLAN ID MUST be 0. 0 2.0
Ethertype­Filter­List unsigned­Int­(:256)[] W Classification criterion. Comma-separated list (maximum number of characters per item 256) of unsigned integers. Each list item represents an Ethertype value. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2005] support classification based on Ethertype. 2.0
Ethertype­Filter­Exclude 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 2.0
Source­MACAddress­Filter­List string­(:512)[] W Classification criterion. Comma-separated list (maximum number of characters per item 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. 2.0
Source­MACAddress­Filter­Exclude 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 2.0
Dest­MACAddress­Filter­List string­(:512)[] W Classification criterion. Comma-separated list (maximum number of characters per item 512) of strings. Each list item specifies a MAC Address. List items MAY optionally specify a bit-mask after the MAC Address, where matching of a packet’s MAC address is only to be done for bit positions set to one in the mask. If no mask is specified, all bits of the MAC Address are to be used for matching. For example, the list might be: 01:02:03:04:05:06, 1:22:33:00:00:00/FF:FF:FF:00:00:00, 88:77:66:55:44:33 2.0
Dest­MACAddress­Filter­Exclude boolean W If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches one of the DestMACAddressFilterList entries. If the DestMACAddressFilterList is empty, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches one of the DestMACAddressFilterList entries. If the DestMACAddressFilterList is empty, packets are admitted regardless of MAC address. true 2.0
Source­MACFrom­Vendor­Class­IDFilter string­(:65535) 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 [RFC2132]) in the most recent DHCP lease acquisition or renewal matches the specified value according to the match criterion in SourceMACFromVendorClassIDMode. Case sensitive. This is a normal string, e.g. “abc” is represented as “abc” and not “616263” hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2005] support classification based on source MAC address. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. 2.0
Source­MACFrom­Vendor­Class­IDFilter­Exclude 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 2.0
Source­MACFrom­Vendor­Class­IDMode string W

SourceMACFromVendorClassIDFilter pattern match criterion. Enumeration of:

Exact 2.0
Dest­MACFrom­Vendor­Class­IDFilter string­(:65535) 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 [RFC2132]) in the most recent DHCP lease acquisition or renewal matches the specified value according to the match criterion in DestMACFromVendorClassIDMode. Case sensitive. This is a normal string, e.g. “abc” is represented as “abc” and not say “616263” hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. 2.0
Dest­MACFrom­Vendor­Class­IDFilter­Exclude 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 2.0
Dest­MACFrom­Vendor­Class­IDMode string W

DestMACFromVendorClassIDFilter pattern match criterion. Enumeration of:

Exact 2.0
Source­MACFrom­Client­IDFilter hex­Binary­(:65535) W Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if its DHCP Client Identifier (Option 61 as defined in [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. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. 2.0
Source­MACFrom­Client­IDFilter­Exclude 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 2.0
Dest­MACFrom­Client­IDFilter hex­Binary­(:65535) W Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if its DHCP Client Identifier (Option 61 as defined in [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: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. 2.0
Dest­MACFrom­Client­IDFilter­Exclude boolean W If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromClientIDFilter. If DestMACFromClientIDFilter is an empty string, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromClientIDFilter. If the DestMACFromClientIDFilter is an empty string, packets are admitted regardless of MAC address. true 2.0
Source­MACFrom­User­Class­IDFilter hex­Binary­(:65535) W Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if its DHCP User Class Identifier (Option 77 as defined in [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. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. 2.0
Source­MACFrom­User­Class­IDFilter­Exclude 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 2.0
Dest­MACFrom­User­Class­IDFilter hex­Binary­(:65535) W Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if its DHCP User Class Identifier (Option 77 as defined in [RFC3004]) in the most recent DHCP lease acquisition or renewal was equal to the specified value. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. 2.0
Dest­MACFrom­User­Class­IDFilter­Exclude boolean W If false, on ingress to the interfaces associated with this Filter, the Bridge admits only those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromUserClassIDFilter. If DestMACFromUserClassIDFilter is an empty string, no packets are admitted. If true, on ingress to the interfaces associated with this Filter, the Bridge admits all packets except those packets whose destination MAC Address matches that of a LAN device previously identified as described in DestMACFromUserClassIDFilter. If the DestMACFromUserClassIDFilter is an empty string, packets are admitted regardless of MAC address. true 2.0
Device.­PPP. object R Point-to-Point Protocol [RFC1661]. This object contains the Interface table. - 2.0
Interface­Number­Of­Entries unsigned­Int R The number of entries in the Interface table. - 2.0
Device.­PPP.­Interface.­{i}. object(0:) W

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

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

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

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863].
Down 2.0
Alias string­(:64) W

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

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

- 2.0
Name string­(:64) R

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

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

- 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the interface entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. 2.0
Reset boolean W

When set to true, the device MUST tear down the existing PPP connection represented by this object and establish a new one. The device MUST initiate the reset after completion of the current CWMP session. The device MAY delay resetting the connection in order to avoid interruption of a user service such as an ongoing voice call. Reset on a disabled interface is a no-op (not an error).

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

false 2.0
Connection­Status string R

Current status of the connection. Enumeration of:

  • Unconfigured
  • Connecting
  • Authenticating
  • Connected
  • PendingDisconnect
  • Disconnecting
  • Disconnected
- 2.0
Last­Connection­Error string R

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

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

Password to be used for authentication.

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

- 2.0
Encryption­Protocol string R

Describes the PPP encryption protocol. Enumeration of:

  • None
  • MPPE
- 2.0
Compression­Protocol string R

Describes the PPP compression protocol. Enumeration of:

- 2.0
Authentication­Protocol string R

Describes the PPP authentication protocol. Enumeration of:

  • PAP
  • CHAP
  • MS-CHAP
- 2.0
Max­MRUSize unsigned­Int­(64:65535) W The maximum allowed size of frames sent from the remote peer. 1500 2.0
Current­MRUSize unsigned­Int­(64:65535) R The current MRU in use over this connection. - 2.0
Connection­Trigger string W

Trigger used to establish the PPP connection. Enumeration of:

  • OnDemand (If this PPP connection is disconnected for any reason, it is to remain disconnected until the CPE has one or more packets to communicate over this connection, at which time the CPE automatically attempts to reestablish the connection)
  • AlwaysOn (If this PPP connection is disconnected for any reason, the CPE automatically attempts to reestablish the connection (and continues to attempt to reestablish the connection as long it remains disconnected))
  • Manual (If this PPP connection is disconnected for any reason, it is to remain disconnected until the user of the CPE explicitly instructs the CPE to reestablish the connection) Note that the reason for a PPP connection becoming disconnected to begin with might be either external to the CPE, such as termination by the BRAS or momentary disconnection of the physical interface, or internal to the CPE, such as use of the IdleDisconnectTime and/or AutoDisconnectTime parameters in this object.
- 2.0
LCPEcho unsigned­Int R PPP LCP Echo period in seconds. - 2.0
LCPEcho­Retry unsigned­Int R Number of PPP LCP Echo retries within an echo period. - 2.0
Device.­PPP.­Interface.­{i}.­PPPo­E. object(0:1) R

PPPoE object that functionally groups PPPoE related parameters.

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

- 2.0
Session­ID unsigned­Int­(1:) R Represents the PPPoE Session ID. - 2.0
ACName string­(:256) W PPPoE Access Concentrator. - 2.0
Service­Name string­(:256) W PPPoE Service Name. - 2.0
Device.­PPP.­Interface.­{i}.­IPCP. object R IP Control Protocol (IPCP) client object for this PPP interface [RFC1332]. Device.PPP.Interface.{i}.IPCP. only applies to IPv4. - 2.0
Local­IPAddress string­(:45) R [IPv4Address] The local IPv4 address for this connection received via IPCP. 2.0
Remote­IPAddress string­(:45) R [IPv4Address] The remote IPv4 address for this connection received via IPCP. 2.0
DNSServers string­(:45)[:2] R [IPv4Address] Comma-separated list (up to 2 items) of IPv4Addresses. Items represent DNS Server IPv4 address(es) received via IPCP [RFC1877]. 2.0
Passthrough­Enable boolean W If false, the PPP Interface retrieved information is configured on the IP Interface stacked on top of this PPP Interface. If true, the PPP Interface retrieved information is propagated to the parameters in the referenced PassthroughDHCPPool object, replacing any existing configuration (including MinAddress, MaxAddress, SubnetMask, IPRouters, and DNSServers). false 2.0
Passthrough­DHCPPool string­(:256) W The value MUST be the Path Name of a row in the DHCPv4.Server.Pool. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.When PassthroughDHCPPool is set to an empty string, PassthroughEnable MUST be set to false (i.e. passthrough can not be enabled without a pool reference specified). 2.0
Device.­PPP.­Interface.­{i}.­Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int 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. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Device.­IP. object R IP object that contains the Interface, ActivePort, and Diagnostics objects. - 2.0
IPv­4Capable boolean R Indicates whether the device is IPv4 capable. - 2.0
Interface­Number­Of­Entries unsigned­Int R The number of entries in the Interface table. - 2.0
Active­Port­Number­Of­Entries unsigned­Int R The number of entries in the ActivePort table. - 2.0
Device.­IP.­Interface.­{i}. object(0:) W

IP interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the layer 3 IP interface.

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

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

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863].
Down 2.0
Alias string­(:64) W

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

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

- 2.0
Name string­(:64) R

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

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

- 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the interface entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. LowerLayers MUST be an empty string and read-only when Type is Loopback, Tunnel, or Tunneled. 2.0
Router string­(:256) W The value MUST be the Path Name of a row in the Routing.Router. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The Router instance that is associated with this IP Interface entry. 2.0
Reset boolean W

When set to true, the device MUST tear down the existing IP connection represented by this object and establish a new one. The device MUST initiate the reset after completion of the current CWMP session. The device MAY delay resetting the connection in order to avoid interruption of a user service such as an ongoing voice call. Reset on a disabled interface is a no-op (not an error).

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

false 2.0
Max­MTUSize unsigned­Int­(64:65535) W The maximum transmission unit (MTU); the largest allowed size of an IP packet (including IP headers, but excluding lower layer headers such as Ethernet, PPP, or PPPoE headers) that is allowed to be transmitted by or through this device. - 2.0
Type string R

IP interface type. Enumeration of:

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

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

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

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

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

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

- 2.0
IPAddress string­(:45) W [IPv4Address] IPv4 address. This parameter can only be modified if the AddressingType is Static. - 2.0
Subnet­Mask string­(:45) W [IPv4Address] Subnet mask. This parameter can only be modified if the AddressingType is Static. 2.0
Addressing­Type string R

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

  • DHCP
  • AutoIP
  • IPCP
  • Static
Static 2.0
Device.­IP.­Interface.­{i}.­Stats. object R Throughput statistics for this interface. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int 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. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Device.­IP.­Active­Port.­{i}. object(0:) R

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

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

- 2.0
Local­IPAddress string­(:45) R [IPAddress] Connection local IP address. - 2.0
Local­Port unsigned­Int­(0:65535) R Connection local port. - 2.0
Remote­IPAddress string­(:45) R [IPAddress] The remote IP address of the source of inbound packets. This will be an empty string for listening connections (only connections in ESTABLISHED state have remote addresses). - 2.0
Remote­Port unsigned­Int­(0:65535) R The remote port of the source of inbound packets. This will be 0 for listening connections (only connections in ESTABLISHED state have remote addresses). - 2.0
Status string R

Current operational status of the connection. Enumeration of:

  • LISTEN
  • ESTABLISHED
- 2.0
Device.­IP.­Diagnostics. object R The IP Diagnostics object. - 2.0
Device.­IP.­Diagnostics.­IPPing. object R This object provides access to an IP-layer ping test. - 2.0
Diagnostics­State 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.
- 2.0
Interface string­(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. The IP-layer interface over which the test is to be performed. This identifies the source IP address to use when performing the test. Example: Device.IP.Interface.1 If an empty string is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface. - 2.0
Host string­(:256) W Host name or address of the host to ping. - 2.0
Number­Of­Repetitions unsigned­Int­(1:) W Number of repetitions of the ping test to perform before reporting the results. - 2.0
Timeout unsigned­Int­(1:) W Timeout in milliseconds for the ping test. - 2.0
Data­Block­Size unsigned­Int­(1:65535) W Size of the data block in bytes to be sent for each ping. - 2.0
DSCP unsigned­Int­(0:63) W DiffServ codepoint to be used for the test packets. By default the CPE SHOULD set this value to zero. - 2.0
Success­Count unsigned­Int 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. - 2.0
Failure­Count unsigned­Int R Result parameter indicating the number of failed pings in the most recent ping test. - 2.0
Average­Response­Time unsigned­Int 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. - 2.0
Minimum­Response­Time unsigned­Int 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. - 2.0
Maximum­Response­Time unsigned­Int 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. - 2.0
Device.­IP.­Diagnostics.­Trace­Route. object R This object is defines access to an IP-layer trace-route test for the specified IP interface. - 2.0
Diagnostics­State 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.
- 2.0
Interface string­(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. The IP-layer interface over which the test is to be performed. This identifies the source IP address to use when performing the test. Example: Device.IP.Interface.1 - 2.0
Host string­(:256) W Host name or address of the host to find a route to. - 2.0
Number­Of­Tries unsigned­Int­(1:3) W Number of tries per hop. Set prior to running Diagnostic. By default, the CPE SHOULD set this value to 3. - 2.0
Timeout unsigned­Int­(1:) W Timeout in milliseconds for each hop of the trace route test. By default the CPE SHOULD set this value to 5000. - 2.0
Data­Block­Size unsigned­Int­(1:65535) W Size of the data block in bytes to be sent for each trace route. By default, the CPE SHOULD set this value to 38. - 2.0
DSCP unsigned­Int­(0:63) W DiffServ codepoint to be used for the test packets. By default the CPE SHOULD set this value to 0. - 2.0
Max­Hop­Count unsigned­Int­(1:64) W The maximum number of hop used in outgoing probe packets (max TTL). By default the CPE SHOULD set this value to 30. - 2.0
Response­Time unsigned­Int 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. - 2.0
Route­Hops­Number­Of­Entries unsigned­Int R The number of entries in the RouteHops table. - 2.0
Device.­IP.­Diagnostics.­Trace­Route.­Route­Hops.­{i}. object(0:) R Contains the array of hop results returned. If a route could not be determined, this array will be empty - 2.0
Host string­(:256) R Result parameter indicating the Host Name if DNS is able to resolve or IP Address of a hop along the discovered route. - 2.0
Host­Address string R If this parameter is not an empty string it will contain the last IP address of the host returned for this hop and the Host will contain the Host Name returned from the reverse DNS query. - 2.0
Error­Code unsigned­Int R Contains the error code returned for this hop. This code is directly from the ICMP CODE field. - 2.0
RTTimes unsigned­Int­(:16)[] R Comma-separated list (maximum number of characters per item 16) of unsigned integers. Each list item contains one or more round trip times in milliseconds (one for each repetition) for this hop. - 2.0
Device.­IP.­Diagnostics.­Download­Diagnostics. object R This object defines the diagnostics configuration for a HTTP and FTP DownloadDiagnostics Test. Files received in the DownloadDiagnostics do not require file storage on the CPE device. - 2.0
Diagnostics­State 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.
- 2.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. - 2.0
Download­URL string­(:256) W The URL, as defined in [RFC3986], for the CPE to perform the download on. This parameter MUST be in the form of a valid HTTP [RFC2616] or FTP [RFC959] URL.
  • When using FTP transport, FTP binary transfer MUST be used.
  • When using HTTP transport, persistent connections MUST be used and pipelining MUST NOT be used.
  • When using HTTP transport the HTTP Authentication MUST NOT be used.
- 2.0
Download­Transports string­[] R

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

  • HTTP
  • FTP (OPTIONAL)
- 2.0
DSCP unsigned­Int­(0:63) W The DiffServ code point for marking packets transmitted in the test. The default value SHOULD be zero. - 2.0
Ethernet­Priority unsigned­Int­(0:7) W Ethernet priority code for marking packets transmitted in the test (if applicable). The default value SHOULD be zero. - 2.0
ROMTime date­Time 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.
- 2.0
BOMTime date­Time 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.
- 2.0
EOMTime date­Time 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.
- 2.0
Test­Bytes­Received unsigned­Int R The test traffic received in bytes during the FTP/HTTP transaction including FTP/HTTP headers, between BOMTime and EOMTime, - 2.0
Total­Bytes­Received unsigned­Int R The total number of bytes received on the Interface between BOMTime and EOMTime. - 2.0
TCPOpen­Request­Time date­Time 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.
- 2.0
TCPOpen­Response­Time date­Time 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.
- 2.0
Device.­IP.­Diagnostics.­Upload­Diagnostics. object R This object defines the diagnostics configuration for a HTTP or FTP UploadDiagnostics test. Files sent by the UploadDiagnostics do not require file storage on the CPE device, and MAY be an arbitrary stream of bytes. - 2.0
Diagnostics­State 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.
- 2.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. - 2.0
Upload­URL string­(:256) W The URL, as defined in [RFC3986], for the CPE to Upload to. This parameter MUST be in the form of a valid HTTP [RFC2616] or FTP [RFC959] URL.
  • When using FTP transport, FTP binary transfer MUST be used.
  • When using HTTP transport, persistent connections MUST be used and pipelining MUST NOT be used.
  • When using HTTP transport the HTTP Authentication MUST NOT be used.
- 2.0
Upload­Transports string­[] R

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

  • HTTP
  • FTP (OPTIONAL)
- 2.0
DSCP unsigned­Int­(0:63) W DiffServ code point for marking packets transmitted in the test. The default value SHOULD be zero. - 2.0
Ethernet­Priority unsigned­Int­(0:7) W Ethernet priority code for marking packets transmitted in the test (if applicable). The default value SHOULD be zero. - 2.0
Test­File­Length unsigned­Int W The size of the file (in bytes) to be uploaded to the server. The CPE MUST insure the appropriate number of bytes are sent. - 2.0
ROMTime date­Time 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.
- 2.0
BOMTime date­Time 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.
- 2.0
EOMTime date­Time 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.
- 2.0
Total­Bytes­Sent unsigned­Int R The total number of bytes sent on the Interface between BOMTime and EOMTime. - 2.0
TCPOpen­Request­Time date­Time 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.
- 2.0
TCPOpen­Response­Time date­Time 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.
- 2.0
Device.­IP.­Diagnostics.­UDPEcho­Config. object R This object allows the CPE to be configured to perform the UDP Echo Service defined in [RFC862] and UDP Echo Plus Service defined in [Appendix A.1/TR-143]. - 2.0
Enable boolean W MUST be enabled to receive UDP echo. When enabled from a disabled state all related timestamps, statistics and UDP Echo Plus counters are cleared. - 2.0
Interface string­(:256) W The value MUST be the Path Name of IP-layer interface over which the CPE MUST listen and receive UDP echo requests on. The value of this parameter MUST be either a valid interface or an empty string. An attempt to set this parameter to a different value MUST be rejected as an invalid parameter value. If an empty string is specified, the CPE MUST listen and receive UDP echo requests on all interfaces. Note: Interfaces behind a NAT MAY require port forwarding rules configured in the Gateway to enable receiving the UDP packets. - 2.0
Source­IPAddress string­(:45) W [IPAddress] The Source IP address of the UDP echo packet. The CPE MUST only respond to a UDP echo from this source IP address. - 2.0
UDPPort unsigned­Int W The UDP port on which the UDP server MUST listen and respond to UDP echo requests. - 2.0
Echo­Plus­Enabled boolean W If true the CPE will perform necessary packet processing for UDP Echo Plus packets. - 2.0
Echo­Plus­Supported boolean R true if UDP Echo Plus is supported. - 2.0
Packets­Received unsigned­Int R Incremented upon each valid UDP echo packet received. - 2.0
Packets­Responded unsigned­Int R Incremented for each UDP echo response sent. - 2.0
Bytes­Received unsigned­Int R The number of UDP received bytes including payload and UDP header after the UDPEchoConfig is enabled. - 2.0
Bytes­Responded unsigned­Int R The number of UDP responded bytes, including payload and UDP header sent after the UDPEchoConfig is enabled. - 2.0
Time­First­Packet­Received date­Time 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. - 2.0
Time­Last­Packet­Received date­Time 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. - 2.0
Device.­Captive­Portal. object R This object contains parameters relating to the captive portal configuration on the CPE. The captive portal configuration defines the CPE’s upstream HTTP (port 80) traffic redirect behavior. When the captive portal is disabled, upstream HTTP (port 80) traffic MUST be permitted to all destinations. When the captive portal is enabled, upstream HTTP (port 80) traffic MUST be permitted only to destinations listed in the AllowedList; traffic to all other destinations MUST be redirected to the URL. - 2.0
Enable boolean W Enables or disables the captive portal. - 2.0
Status string R

Indicates the status of the captive portal. Enumeration of:

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

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

This table MUST contain at least 1 entry.

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

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

The status of this Router entry. Enumeration of:

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

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

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

- 2.0
IPv­4Forwarding­Number­Of­Entries unsigned­Int R The number of entries in the IPv4Forwarding table. - 2.0
Device.­Routing.­Router.­{i}.­IPv­4Forwarding.­{i}. object(0:) W

Layer 3 IPv4 forwarding table. In addition to statically configured routes, this table MUST include dynamic routes learned through layer 3 routing protocols, including RIP, 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. Note: The Device.Routing.Router.{i}.IPv4Forwarding.{i}. table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Device.Routing.Router.{i}.IPv4Forwarding.{i}. row to then violate the table’s unique key constraint; if this occurs, the CPE MUST disable the offending Device.Routing.Router.{i}.IPv4Forwarding.{i}. row.

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

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

Indicates the status of the forwarding entry. Enumeration of:

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

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

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

- 2.0
Static­Route boolean R If true, this route is a Static route. true 2.0
Dest­IPAddress string­(:45) W [IPv4Address] Destination IPv4 address. An empty string indicates no destination address is specified. A Forwarding table entry for which DestIPAddress and DestSubnetMask are both an empty string is a default route. 2.0
Dest­Subnet­Mask string­(:45) W [IPv4Address] Destination subnet mask. An empty string indicates no destination subnet mask is specified. If a destination subnet mask is specified, the DestSubnetMask is ANDed with the destination address before comparing with the DestIPAddress. Otherwise, the full destination address is used as is. A Forwarding table entry for which DestIPAddress and DestSubnetMask are both an empty string is a default route. 2.0
Forwarding­Policy int­(-­1:) W Identifier of a set of classes or flows that have the corresponding ForwardingPolicy value as defined in the Device.QoS object. A value of -1 indicates no ForwardingPolicy is specified. If specified, this forwarding entry is to apply only to traffic associated with the specified classes and flows. -­1 2.0
Gateway­IPAddress string­(:45) W [IPv4Address] IPv4 address of the gateway. Only one of GatewayIPAddress and Interface SHOULD be configured for a route. If both are configured, GatewayIPAddress and Interface MUST be consistent with each other. 2.0
Interface string­(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the egress layer 3 interface associated with this entry. Example: Device.IP.Interface.1. Only one of GatewayIPAddress and Interface SHOULD be configured for a route. If both are configured, GatewayIPAddress and Interface MUST be consistent with each other. For a route that was configured by setting GatewayIPAddress but not Interface, read access to Interface MUST return the full hierarchical parameter name for the routes egress interface. 2.0
Forwarding­Metric int­(-­1:) W Forwarding metric. A value of -1 indicates this metric is not used. -­1 2.0
Device.­Routing.­RIP. object R Routing Information Protocol (RIP) object. - 2.0
Enable boolean W Enables or disables RIP on the device. - 2.0
Supported­Modes string R

The supported RIP protocol modes. Enumeration of:

  • Send
  • Receive
  • Both
- 2.0
Interface­Setting­Number­Of­Entries unsigned­Int R The number of entries in the InterfaceSetting table. - 2.0
Device.­Routing.­RIP.­Interface­Setting.­{i}. object(0:) W

IP Interface RIP configuration table. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The Device.Routing.RIP.InterfaceSetting.{i}. table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Device.Routing.RIP.InterfaceSetting.{i}. row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending Device.Routing.RIP.InterfaceSetting.{i}. row.

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

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

The status of this entry. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 2.0
Alias string­(:64) W

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

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

- 2.0
Interface string­(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is the IP interface associated with this Device.Routing.RIP.InterfaceSetting.{i}. entry. 2.0
Version unsigned­Int­(1:2) W Defines the RIP protocol version used to accept or send over Interface. - 2.0
Accept­RA boolean W When set to true, RIP route advertisements received over Interface are accepted. When set to false, RIP route advertisements received over Interface are rejected. - 2.0
Send­RA boolean W When set to true, RIP route advertisements are to be sent over Interface. When set to false, no RIP route advertisements will be sent over Interface. - 2.0
Device.­Qo­S. object R Queue management configuration object. - 2.0
Max­Classification­Entries unsigned­Int R The maximum number of entries available in the Classification table. - 2.0
Classification­Number­Of­Entries unsigned­Int R The number of entries in the Classification table. - 2.0
Max­App­Entries unsigned­Int R The maximum number of entries available in the App table. - 2.0
App­Number­Of­Entries unsigned­Int R The number of entries in the App table. - 2.0
Max­Flow­Entries unsigned­Int R The maximum number of entries available in the Flow table. - 2.0
Flow­Number­Of­Entries unsigned­Int R The number of entries in the Flow table. - 2.0
Max­Policer­Entries unsigned­Int R The maximum number of entries available in the Policer table. - 2.0
Policer­Number­Of­Entries unsigned­Int R The number of entries in the Policer table. - 2.0
Max­Queue­Entries unsigned­Int R The maximum number of entries available in the Queue table. - 2.0
Queue­Number­Of­Entries unsigned­Int R The number of entries in the Queue table. - 2.0
Queue­Stats­Number­Of­Entries unsigned­Int R The number of entries in the QueueStats table. - 2.0
Max­Shaper­Entries unsigned­Int R The maximum number of entries available in the Shaper table. - 2.0
Shaper­Number­Of­Entries unsigned­Int R The number of entries in the Shaper table. - 2.0
Default­Forwarding­Policy unsigned­Int W Identifier of the forwarding policy associated with traffic not associated with any specified classifier. - 2.0
Default­Traffic­Class unsigned­Int W Identifier of the traffic class associated with traffic not associated with any specified classifier. - 2.0
Default­Policer string­(:256) W The value MUST be the Path Name of a row in the Policer. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates the Policer table entry for traffic not associated with any specified classifier. An empty string indicates a null policer. - 2.0
Default­Queue string­(:256) W The value MUST be the Path Name of a row in the Queue. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates the Queue table entry for traffic not associated with any specified classifier. Note: The interpretation of an empty string value is implementation specific. - 2.0
Default­DSCPMark int­(-­2:) W DSCP to mark traffic not associated with any specified classifier. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of DSCP based upon the EthernetPriority value of the incoming packet as defined in [Annex A/TR-181i2]. - 2.0
Default­Ethernet­Priority­Mark 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-181i2]. - 2.0
Available­App­List string­(:1024)[] R Comma-separated list (maximum number of characters per item 1024) of strings. List items represent URNs, each indicating a protocol supported for use as a ProtocolIdentifier in the App table. This list MAY include any of the URNs defined in [Annex A/TR-181i2] as well as other URNs defined elsewhere. - 2.0
Device.­Qo­S.­Classification.­{i}. object(0:) W

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

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

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

The status of this classifier. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 2.0
Order unsigned­Int­(1:) W Position of the Device.QoS.Classification.{i}. entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each packet, the highest ordered entry that matches the classification criteria is applied. All lower order entries are ignored. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a Device.QoS.Classification.{i}. table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). - 2.0
Alias string­(:64) W

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

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

- 2.0
Interface string­(:256) W Classification criterion. The value MUST be the Path Name of a table row. This specifies the ingress interface associated with the entry. It MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which Classifications can be instantiated is a local matter to the CPE. 2.0
All­Interfaces boolean W Classification criterion. This specifies that all ingress interfaces are associated with the entry. If true, the value of Interface is ignored since all ingress interfaces are indicated. false 2.0
Dest­IP string­(:45) W [IPAddress] Classification criterion. Destination IP address. An empty string indicates this criterion is not used for classification. 2.0
Dest­Mask string­(:49) W [IPPrefix] Destination IP address mask, but represented as an IP routing prefix using CIDR notation [RFC4632] (e.g. 192.168.0.0/16 in IPv4, and 2001:db8:3210:11aa::/64 in IPv6). If not an empty string, only the indicated 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. 2.0
Dest­IPExclude boolean W If false, the class includes only those packets that match the (masked) DestIP entry, if specified. If true, the class includes all packets except those that match the (masked) DestIP entry, if specified. false 2.0
Source­IP string­(:45) W [IPAddress] Classification criterion. Source IP address. An empty string indicates this criterion is not used for classification. 2.0
Source­Mask string­(:49) W [IPPrefix] Source IP address mask, but represented as an IP routing prefix using CIDR notation [RFC4632] (e.g. 192.168.0.0/16 in IPv4, and 2001:db8:3210:11aa::/64 in IPv6). If not an empty string, only the indicated 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. 2.0
Source­IPExclude boolean W If false, the class includes only those packets that match the (masked) SourceIP entry, if specified. If true, the class includes all packets except those that match the (masked) SourceIP entry, if specified. false 2.0
Protocol int­(-­1:) W Classification criterion. Protocol number. A value of -1 indicates this criterion is not used for classification. -­1 2.0
Protocol­Exclude boolean W If false, the class includes only those packets that match the Protocol entry, if specified. If true, the class includes all packets except those that match the Protocol entry, if specified. false 2.0
Dest­Port int­(-­1:65535) W Classification criterion. Destination port number. A value of -1 indicates this criterion is not used for classification. -­1 2.0
Dest­Port­Range­Max int­(-­1:65535) W Classification criterion. If specified, indicates the classification criterion is to include the port range from DestPort through DestPortRangeMax (inclusive). If specified, DestPortRangeMax MUST be greater than or equal to DestPort. A value of -1 indicates that no port range is specified. -­1 2.0
Dest­Port­Exclude boolean W If false, the class includes only those packets that match the DestPort entry (or port range), if specified. If true, the class includes all packets except those that match the DestPort entry (or port range), if specified. false 2.0
Source­Port int­(-­1:65535) W Classification criterion. Source port number. A value of -1 indicates this criterion is not used for classification. -­1 2.0
Source­Port­Range­Max int­(-­1:65535) W Classification criterion. If specified, indicates the classification criterion is to include the port range from SourcePort through SourcePortRangeMax (inclusive). If specified, SourcePortRangeMax MUST be greater than or equal to SourcePort. A value of -1 indicates that no port range is specified. -­1 2.0
Source­Port­Exclude boolean W If false, the class includes only those packets that match the SourcePort entry (or port range), if specified. If true, the class includes all packets except those that match the SourcePort entry (or port range), if specified. false 2.0
Source­MACAddress string­(:17) W [MACAddress] Classification criterion. Source MAC Address. An empty string indicates this criterion is not used for classification. 2.0
Source­MACMask string­(:17) W [MACAddress] Bit-mask for the MAC address, where matching of a packet’s MAC address with the SourceMACAddress is only to be done for bit positions set to one in the mask. A mask of FF:FF:FF:FF:FF:FF or an empty string indicates all bits of the SourceMACAddress are to be used for classification. 2.0
Source­MACExclude boolean W If false, the class includes only those packets that match the (masked) SourceMACAddress entry, if specified. If true, the class includes all packets except those that match the (masked) SourceMACAddress entry, if specified. false 2.0
Dest­MACAddress 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. 2.0
Dest­MACMask string­(:17) W [MACAddress] Bit-mask for the MAC address, where matching of a packet’s MAC address with the DestMACAddress is only to be done for bit positions set to one in the mask. A mask of FF:FF:FF:FF:FF:FF or an empty string indicates all bits of the DestMACAddress are to be used for classification. 2.0
Dest­MACExclude boolean W If false, the class includes only those packets that match the (masked) DestMACAddress entry, if specified. If true, the class includes all packets except those that match the (masked) DestMACAddress entry, if specified. false 2.0
Ethertype int­(-­1:) W Classification criterion. Ethertype as indicated in either the Ethernet or SNAP Type header. A value of -1 indicates this criterion is not used for classification. -­1 2.0
Ethertype­Exclude boolean W If false, the class includes only those packets that match the Ethertype entry, if specified. If true, the class includes all packets except those that match the Ethertype entry, if specified. false 2.0
SSAP int­(-­1:) W Classification criterion. SSAP element in the LLC header. A value of -1 indicates this criterion is not used for classification. -­1 2.0
SSAPExclude boolean W If false, the class includes only those packets that match the SSAP entry, if specified. If true, the class includes all packets except those that match the SSAP entry, if specified. false 2.0
DSAP int­(-­1:) W Classification criterion. DSAP element in the LLC header. A value of -1 indicates this criterion is not used for classification. -­1 2.0
DSAPExclude boolean W If false, the class includes only those packets that match the DSAP entry, if specified. If true, the class includes all packets except those that match the DSAP entry, if specified. false 2.0
LLCControl int­(-­1:) W Classification criterion. Control element in the LLC header. A value of -1 indicates this criterion is not used for classification. -­1 2.0
LLCControl­Exclude boolean W If false, the class includes only those packets that match the LLCControl entry, if specified. If true, the class includes all packets except those that match the LLCControl entry, if specified. false 2.0
SNAPOUI int­(-­1:) W Classification criterion. OUI element in the SNAP header. A value of -1 indicates this criterion is not used for classification. -­1 2.0
SNAPOUIExclude boolean W If false, the class includes only those packets that match the SNAPOUI entry, if specified. If true, the class includes all packets except those that match the SNAPOUI entry, if specified. false 2.0
Source­Vendor­Class­ID string­(:65535) W Classification criterion. Used to identify one or more LAN devices, value of the DHCP Vendor Class Identifier (Option 60) as defined in [RFC2132], matched according to the criterion in SourceVendorClassIDMode. Case sensitive. This is a normal string, e.g. “abc” is represented as “abc” and not say “616263” hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. An empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. 2.0
Source­Vendor­Class­IDExclude 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 2.0
Source­Vendor­Class­IDMode string W

SourceVendorClassID pattern match criterion. Enumeration of:

  • Exact
  • Prefix
  • Suffix
  • Substring For example, if SourceVendorClassID is “Example” then an Option 60 value of “Example device” will match with SourceVendorClassIDMode values of Prefix or Substring, but not with Exact or Suffix.
Exact 2.0
Dest­Vendor­Class­ID string­(:65535) W Classification criterion. Used to identify one or more LAN devices, value of the DHCP Vendor Class Identifier (Option 60) as defined in [RFC2132], matched according to the criterion in DestVendorClassIDMode. Case sensitive. This is a normal string, e.g. “abc” is represented as “abc” and not say “616263” hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. An empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. 2.0
Dest­Vendor­Class­IDExclude 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 2.0
Dest­Vendor­Class­IDMode string W

DestVendorClassID pattern match criterion. Enumeration of:

  • Exact
  • Prefix
  • Suffix
  • Substring For example, if DestVendorClassID is “Example” then an Option 60 value of “Example device” will match with DestVendorClassIDMode values of Prefix or Substring, but not with Exact or Suffix.
Exact 2.0
Source­Client­ID hex­Binary­(:65535) W Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Client Identifier (Option 61) as defined in [RFC2132]. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. 2.0
Source­Client­IDExclude boolean W If false, the class includes only those packets sourced from LAN devices that match the SourceClientID entry, if specified. If true, the class includes all packets except those sourced from LAN devices that match the SourceClientID entry, if specified. false 2.0
Dest­Client­ID hex­Binary­(:65535) W Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Client Identifier (Option 61) as defined in [RFC2132]. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. 2.0
Dest­Client­IDExclude boolean W If false, the class includes only those packets destined for LAN devices that match the DestClientID entry, if specified. If true, the class includes all packets except those destined for LAN devices that match the DestClientID entry, if specified. false 2.0
Source­User­Class­ID hex­Binary­(:65535) W Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP User Class Identifier (Option 77) as defined in [RFC3004]. An empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. 2.0
Source­User­Class­IDExclude boolean W If false, the class includes only those packets sourced from LAN devices that match the SourceUserClassID entry, if specified. If true, the class includes all packets except those sourced from LAN devices that match the SourceUserClassID entry, if specified. false 2.0
Dest­User­Class­ID hex­Binary­(:65535) W Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP User Class Identifier (Option 77) as defined in [RFC3004]. An empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. 2.0
Dest­User­Class­IDExclude boolean W If false, the class includes only those packets destined for LAN devices that match the DestUserClassID entry, if specified. If true, the class includes all packets except those destined for LAN devices that match the DestUserClassID entry, if specified. false 2.0
Source­Vendor­Specific­Info hex­Binary­(:65535) W Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Vendor-specific Information (Option 125) as defined in [RFC3925], matched according to the criteria in SourceVendorSpecificInfoEnterprise, SourceVendorSpecificInfoSubOption. Case sensitive. An empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. 2.0
Source­Vendor­Specific­Info­Exclude boolean W If false, the class includes only those packets sourced from LAN devices that match the SourceVendorSpecificInfo entry, if specified. If true, the class includes all packets except those sourced from LAN devices that match the SourceVendorSpecificInfo entry, if specified. false 2.0
Source­Vendor­Specific­Info­Enterprise unsigned­Int W SourceVendorSpecificInfo Enterprise Number as defined in [RFC3925]. The default value (0) is assigned to IANA and will probably need to be replaced with an appropriate enterprise number. 0 2.0
Source­Vendor­Specific­Info­Sub­Option int­(0:255) W SourceVendorSpecificInfo Sub Option Code as defined in [RFC3925]. 0 2.0
Dest­Vendor­Specific­Info hex­Binary­(:65535) W Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Vendor-specific Information (Option 125) as defined in [RFC3925], matched according to the criteria in DestVendorSpecificInfoEnterprise, DestVendorSpecificInfoSubOption. An empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. 2.0
Dest­Vendor­Specific­Info­Exclude boolean W If false, the class includes only those packets destined for LAN devices that match the DestVendorSpecificInfo entry, if specified. If true, the class includes all packets except those destined for LAN devices that match the DestVendorSpecificInfo entry, if specified. false 2.0
Dest­Vendor­Specific­Info­Enterprise unsigned­Int W DestVendorSpecificInfo Enterprise Number as defined in [RFC3925]. The default value (0) is assigned to IANA and will probably need to be replaced with an appropriate enterprise number. 0 2.0
Dest­Vendor­Specific­Info­Sub­Option int­(0:255) W DestVendorSpecificInfo Sub Option Code as defined in [RFC3925]. 0 2.0
TCPACK boolean W Classification criterion. If false, this criterion is not used for classification. If true, this criterion matches with all TCP segments that have the ACK control bit set. false 2.0
TCPACKExclude boolean W If false, the class includes only those packets that match the TCPACK entry, if specified. If true, the class includes all packets except those that match the TCPACK entry, if specified. false 2.0
IPLength­Min unsigned­Int W Classification criterion. Minimum IP Packet Length (including header) in bytes. 0 2.0
IPLength­Max unsigned­Int W Classification criterion. Maximum IP Packet Length (including header) in bytes. A value of zero indicates that no maximum is specified (an umlimited maximum length). 0 2.0
IPLength­Exclude boolean W If false, the class includes only those packets whose length (including header) falls within the inclusive range IPLengthMin through IPLengthMax. A value of zero for both IPLengthMin and IPLengthMax allows any length packet. An equal non-zero value of IPLengthMin and IPLengthMax allows only a packet with the exact length specified. If true, the class includes all packets except those whose length (including header) falls within the inclusive range IPLengthMin through IPLengthMax. false 2.0
DSCPCheck int­(-­1:) W Classification criterion. DiffServ codepoint (defined in [RFC2474]). If set to a Class Selector Codepoint (defined in [RFC2474]), all DSCP values that match the first 3 bits will be considered a valid match. A value of -1 indicates this criterion is not used for classification. -­1 2.0
DSCPExclude boolean W If false, the class includes only those packets that match the DSCPCheck entry, if specified. If true, the class includes all packets except those that match the DSCPCheck entry, if specified. false 2.0
DSCPMark int­(-­2:) W Classification result. DSCP to mark traffic with that falls into this classification entry. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of DSCP based upon the EthernetPriority value of the incoming packet as defined in [Annex A/TR-181i2]. -­1 2.0
Ethernet­Priority­Check 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 2.0
Ethernet­Priority­Exclude boolean W If false, the class includes only those packets that match the EthernetPriorityCheck entry, if specified. If true, the class includes all packets except those that match the EthernetPriorityCheck entry, if specified. false 2.0
Ethernet­Priority­Mark 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-181i2]. -­1 2.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 2.0
VLANIDExclude boolean W If false, the class includes only those packets that match the VLANIDCheck entry, if specified. If true, the class includes all packets except those that match the VLANIDCheck entry, if specified. false 2.0
Out­Of­Band­Info int­(-­1:) W Classification criterion. Allows traffic to be distinguished based on out-of-band information such as physical port or application ID. Primarily intended for, but not restricted to, locally sourced traffic. If specified, this entry applies to traffic with matching out-of-band information. A value of -1 indicates this criterion is not used for classification. -­1 2.0
Forwarding­Policy unsigned­Int W Classification result. Identifier of the forwarding policy associated with traffic that falls in this classification. 0 2.0
Traffic­Class int­(-­1:) W Classification result. Identifier of the traffic class associated with traffic that falls in this classification. If specified, at least one Queue table entry MUST include this traffic class in its Queue.{i}.TrafficClasses parameter (which is a comma-separated list). A value of -1 indicates a null traffic class. TrafficClass and App are mutually exclusive and one of the two MUST be specified. If TrafficClass is -1, App MUST be specified, and vice versa. -­1 2.0
Policer string­(:256) W Classification result. The value MUST be the Path Name of a row in the Policer. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates the Policer table entry for traffic that falls in this classification. An empty string indicates a null policer. Policer MAY optionally be specified in conjunction with TrafficClass. Policer and App are mutually exclusive. 2.0
App string­(:256) W Classification result. The value MUST be the Path Name of a row in the App. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates the App table entry for traffic that falls in this classification. An empty string indicates a null App. TrafficClass and App are mutually exclusive and one of the two MUST be specified. If TrafficClass is null, App MUST be specified, and vice versa. 2.0
Device.­Qo­S.­App.­{i}. object(0:) W

Application table.

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

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

The status of this App table entry. Enumeration of:

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

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

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

- 2.0
Protocol­Identifier string­(:256) W URN identifying the protocol associated with the given application. A set of defined URNs is given in [Annex A/TR-181i2]. 2.0
Name string­(:64) W Human-readable name associated with this entry in the App table. 2.0
Default­Forwarding­Policy unsigned­Int W Identifier of the forwarding policy associated with traffic associated with this App table entry, but not associated with any specified flow. 0 2.0
Default­Traffic­Class unsigned­Int W Identifier of the traffic class associated with traffic associated with this App table entry, but not associated with any specified flow. 0 2.0
Default­Policer string­(:256) W The value MUST be the Path Name of a row in the Policer. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates the Policer table entry for traffic associated with this Device.QoS.App.{i}. table entry, but not associated with any specified flow. An empty string indicates a null policer. 2.0
Default­DSCPMark int­(-­2:) W DSCP to mark traffic associated with this App table entry, but not associated with any specified flow. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of DSCP based upon the EthernetPriority value of the incoming packet as defined in [Annex A/TR-181i2]. -­1 2.0
Default­Ethernet­Priority­Mark 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-181i2]. -­1 2.0
Device.­Qo­S.­Flow.­{i}. object(0:) W

Flow table.

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

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

The status of this Flow table entry. Enumeration of:

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

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

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

- 2.0
Type string­(:256) W URN identifying the type of flow to be associated with the specified policer. A set of defined URNs is given in [Annex A/TR-181i2]. 2.0
Type­Parameters 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]. 2.0
Name string­(:64) W Human-readable name associated with this entry in the Flow table. 2.0
App string­(:256) W The value MUST be the Path Name of a row in the App. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates the App table entry associated with this flow. An empty string indicates the flow table is not associated with any App table entry. 2.0
Forwarding­Policy unsigned­Int W Identifier of the forwarding policy associated with this flow. 0 2.0
Traffic­Class unsigned­Int W Identifier of the traffic class associated with this flow. 0 2.0
Policer string­(:256) W The value MUST be the Path Name of a row in the Policer. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates the Policer table entry for traffic that falls in this flow. An empty string indicates a null policer. 2.0
DSCPMark int­(-­2:) W DSCP to mark traffic with that falls into this flow. A value of -1 indicates no change from the incoming packet. A value of -2 indicates automatic marking of DSCP based upon the EthernetPriority value of the incoming packet as defined in [Annex A/TR-181i2]. -­1 2.0
Ethernet­Priority­Mark 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-181i2]. -­1 2.0
Device.­Qo­S.­Policer.­{i}. object(0:) W

Policer table.

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

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

The status of this policer. Enumeration of:

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

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

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

- 2.0
Committed­Rate unsigned­Int W Committed rate allowed for this policer in bits per second. 0 2.0
Committed­Burst­Size unsigned­Int W Committed Burstsize in bytes. 0 2.0
Excess­Burst­Size unsigned­Int W Excess Burstsize in bytes. Applied for a SingleRateThreeColor meter. 0 2.0
Peak­Rate unsigned­Int W Peak rate allowed for this Meter in bits per second. Applied for TwoRateThreeColor meters. 0 2.0
Peak­Burst­Size unsigned­Int W Peak Burstsize in bytes. Applied for TwoRateThreeColor meters. 0 2.0
Meter­Type string W

The value MUST be a member of the list reported by the PossibleMeterTypes parameter. Identifies the method of traffic measurement to be used for this policer. Each list item is an enumeration of:

Simple­Token­Bucket 2.0
Possible­Meter­Types string­[] R

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

  • SimpleTokenBucket
  • SingleRateThreeColor
  • TwoRateThreeColor
- 2.0
Conforming­Action string W

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

  • Null
  • Drop
  • [[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. <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 2.0
Partial­Conforming­Action string W

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

  • Null
  • Drop
  • [[0-9]|[1-5]0-9]|6[0-3] (<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. <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 2.0
Non­Conforming­Action string W

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

  • Null
  • Drop
  • [[0-9]|[1-5]0-9]|6[0-3] (<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. <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 2.0
Total­Counted­Packets unsigned­Int R Total number of Packets counted by this policer, regardless of meter action. 0 2.0
Total­Counted­Bytes unsigned­Int R Total number of Bytes counted by this policer, regardless of meter action. 0 2.0
Conforming­Counted­Packets unsigned­Int R Number of conforming Packets counted by this policer, regardless of meter action. 0 2.0
Conforming­Counted­Bytes unsigned­Int R Number of conforming Bytes counted by this policer, regardless of meter action. 0 2.0
Partially­Conforming­Counted­Packets unsigned­Int R Number of partially conforming Packets counted by this policer, regardless of meter action. 0 2.0
Partially­Conforming­Counted­Bytes unsigned­Int R Number of partially conforming Bytes counted by this policer, regardless of meter action. 0 2.0
Non­Conforming­Counted­Packets unsigned­Int R Number of non-conforming Packets counted by this policer, regardless of meter action. 0 2.0
Non­Conforming­Counted­Bytes unsigned­Int R Number of non-conforming Bytes counted by this policer, regardless of meter action. 0 2.0
Device.­Qo­S.­Queue.­{i}. object(0:) W

Queue table. Each entry is associated with a set of traffic classes, which are specified via the TrafficClasses parameter, and is configured with weight, precedence, drop algorithm, scheduler algorithm etc as appropriate for the traffic classes. An entry can be associated either with all egress interfaces (in which case an actual queue will be instantiated on each egress interface on which traffic of that traffic class can be generated) or else with a single specified egress interface. For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

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

The status of this queue. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 2.0
Alias string­(:64) W

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

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

- 2.0
Traffic­Classes unsigned­Int­(:256)[] W Comma-separated list (maximum number of characters per item 256) of unsigned integers. Each list item identifies the set of traffic classes associated with this queue. Traffic is sent to this queue if a Classification, App or Flow table entry specifies a traffic class, e.g. via the Classification.{i}.TrafficClass parameter. If more than one queue on a given egress interface is associated with a given traffic class, the implementation will choose which queue to send traffic of this class to. 2.0
Interface string­(:256) W The value MUST be the Path Name of a table row. Specifies the egress interface for which the specified queue MUST exist. This MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which Queues can be instantiated is a local matter to the CPE. 2.0
All­Interfaces boolean W Indicates that the specified queue MUST exist for all egress interfaces (i.e. this queue entry is to apply to all egress interfaces). If true, the value of Interface is ignored since all egress interfaces are indicated. false 2.0
Hardware­Assisted boolean R Indicates whether all the queues corresponding to this table entry are hardware assisted. If any of the queues corresponding to this table entry are not hardware assisted, the parameter value MUST be false. false 2.0
Buffer­Length unsigned­Int R Number of bytes in the buffer. Queue buffer size for all egress interfaces for which this queue exists. If the buffer size is not the same for all such egress interfaces, this parameter MUST be 0. - 2.0
Weight unsigned­Int W Weight of this queue in case of WFQ or WRR, but only used for queues of equal precedence. 0 2.0
Precedence unsigned­Int­(1:) W Precedence of this queue relative to others. Lower numbers imply greater precedence. 1 2.0
REDThreshold unsigned­Int­(:100) W Random Early Detection threshold, used only when DropAlgorithm is RED. This is the minimum threshold (min_th) and is measured as a percentage of the queue size. If the value is set to zero, the CPE MUST choose a sensible value, e.g. 5 (but the value MUST still read back as zero). In this version of the data model, there is no way to set the maximum threshold (max_th). The CPE MUST choose a sensible value, e.g. three times the minimum threshold. In this version of the data model, there is no way to set the RED weight (w_q). The CPE MUST choose a sensible value, e.g. 0.002. 0 2.0
REDPercentage unsigned­Int­(:100) W Random Early Detection percentage, used only when DropAlgorithm is RED. This is the maximum value of the packet marking probability (max_p). If the value is set to zero, the CPE MUST choose a sensible value, e.g. 10 (but the value MUST still read back as zero). In this version of the data model, there is no way to set the RED weight (w_q). The CPE MUST choose a sensible value, e.g. 0.002. 0 2.0
Drop­Algorithm string W

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

  • RED (Random Early Detection [RED])
  • DT (Drop Tail)
  • WRED (Weighted RED)
  • BLUE ([BLUE])
DT 2.0
Scheduler­Algorithm string W

Scheduling Algorithm used by scheduler. Enumeration of:

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

Queue statistics table. This table is managed by the ACS, which will create entries only for those {Queue, Interface} combinations for which statistics are to be collected. Note: The Device.QoS.QueueStats.{i}. table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Device.QoS.QueueStats.{i}. row to then violate the table’s unique key constraint; if this occurs, the CPE MUST disable the offending Device.QoS.QueueStats.{i}. row.

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

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

The status of this object. Enumeration of:

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

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

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

- 2.0
Queue string­(:256) W The value MUST be the Path Name of a row in the Queue. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates Queue entry with which this object is associated. 2.0
Interface string­(:256) W The value MUST be the Path Name of a table row. Specifies the egress interface for which this object contains statistics. This MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which QueueStats can be instantiated is a local matter to the CPE. 2.0
Output­Packets unsigned­Int R Number of packets output through the queue. 0 2.0
Output­Bytes unsigned­Int R Number of bytes output through the queue. 0 2.0
Dropped­Packets unsigned­Int R Number of packets dropped by the queue. 0 2.0
Dropped­Bytes unsigned­Int R Number of bytes dropped by the queue. 0 2.0
Queue­Occupancy­Packets unsigned­Int R Queue occupancy in packets (gives a measure of queue latency). 0 2.0
Queue­Occupancy­Percentage unsigned­Int­(0:100) R Queue occupancy measured as a percent, i.e. 100 * queue occupancy in bytes / queue size in bytes (gives a measure of queue usage). 0 2.0
Device.­Qo­S.­Shaper.­{i}. object(0:) W

Shaper table. Used to shape the queue(s) associated with Interface. In case of a single queue for that interface, determines the egress rate of the queue. In case of multiple queues for that interface (possibly with per queue shaping rates), determines the aggregate egress rate on that interface. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The Device.QoS.Shaper.{i}. table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Device.QoS.Shaper.{i}. row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending Device.QoS.Shaper.{i}. row.

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

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

The status of this shaper. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 2.0
Alias string­(:64) W

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

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

- 2.0
Interface string­(:256) W The value MUST be the Path Name of a table row.The interface object associated with this Shaper entry. It MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which Shapers can be instantiated is a local matter to the CPE. 2.0
Shaping­Rate int­(-­1:) W Rate to shape the associated interface connection’s egress traffic to. For leaky bucket (constant rate shaping), this is the constant rate. For token bucket (variable rate shaping), this is the average rate. If <= 100, in percent of the rate of the highest rate-constrained layer over which the packet will travel on egress. If > 100, in bits per second. A value of -1 indicates no shaping. For example, for packets destined for a WAN DSL interface, if the ATM layer is rate-constrained, then the rate is calculated relative to this rate. Otherwise, the rate is calculated relative to the physical-layer DSL rate. -­1 2.0
Shaping­Burst­Size unsigned­Int W Burst size in bytes. For both leaky bucket (constant rate shaping) and token bucket (variable rate shaping) this is the bucket size and is therefore the maximum burst size. - 2.0
Device.­LANConfig­Security. object R This object contains generic device configuration information. - 2.0
Config­Password string­(:64) W

A password to allow LAN access to protected auto-configuration services. If the CPE supports TR-064 (LAN-side DSL CPE Configuration Protocol), this parameter is to be used as the dslf-config password (as defined in TR-064). If the CPE has a user interface with password protection enabled, this parameter is also to be used as the user password for password-protected operations. However, this parameter MUST NOT be used to set the user password if the parameter UserInterface.PasswordUserSelectable is true.

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

- 2.0
Device.­Hosts. object R This object provides information about each of the hosts on the LAN, including those whose IP address was allocated by the CPE using DHCP as well as hosts with statically allocated IP addresses. It can also include non-IP hosts. - 2.0
Host­Number­Of­Entries unsigned­Int R The number of entries in the Host table. - 2.0
Device.­Hosts.­Host.­{i}. object(0:) R

Host table.

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

- 2.0
Alias string­(:64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object. - 2.0
Phys­Address string­(:64) R Unique physical identifier of the host. For many layer 2 technologies this is typically a MAC address. - 2.0
IPAddress string­(:45) R [IPAddress] Current IP Address of the host. An empty string if no address is available. - 2.0
Address­Source string R

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

  • DHCP
  • Static
  • AutoIP
  • None
- 2.0
Lease­Time­Remaining 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. - 2.0
Layer­1Interface string­(:256) R The value MUST be the path name of a row in a layer 1 interface table. For example: Device.Ethernet.Interface.2 - 2.0
Layer­3Interface string­(:256) R The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. If the entry represents a non-IP device, then Layer3Interface will be an empty string. - 2.0
Vendor­Class­ID string­(:65535) R Vendor Class Identifier DHCP option (Option 60) of the host. This is a normal string, e.g. “abc” is represented as “abc” and not say “616263” hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. It MAY be defined when AddressSource is DHCP. An empty string indicates this option is not used. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. - 2.0
Client­ID hex­Binary­(:65535) R A hexbinary string, Client Identifier DHCP option (Option 61) for the specific IP connection of the client. The option value is binary, so an exact match is REQUIRED. It MAY be defined when AddressSource is DHCP. An empty string indicates this option is not used. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. - 2.0
User­Class­ID hex­Binary­(:65535) R A hexbinary string, User Class Identifier DHCP option (Option 77) of the host. It MAY be defined when AddressSource is DHCP. An empty string indicates this option is not used. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. - 2.0
Host­Name string­(:64) R The device’s host name or an empty string if unknown. - 2.0
Active boolean R Whether or not the host is currently present on the LAN. The method of presence detection is a local matter to the CPE. The ability to list inactive hosts is OPTIONAL. If the CPE includes inactive hosts in this table, Active MUST be set to false for each inactive host. The length of time an inactive host remains listed in this table is a local matter to the CPE. - 2.0
Device.­DNS. object R Properties for Domain Name Service (DNS). It contains the Client, Relay, and Diagnostics objects. - 2.0
Device.­DNS.­Client. object R Client properties for Domain Name Service (DNS). The DNS client resolves FQDN on behalf of device internal (client) applications. - 2.0
Enable boolean W Enables or disables the DNS client. - 2.0
Status string R

The status of the DNS client. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
- 2.0
Server­Number­Of­Entries unsigned­Int R The number of entries in the Server table. - 2.0
Device.­DNS.­Client.­Server.­{i}. object(0:) W

This table contains the DNS Server IP addresses to be used by the DHCP Client (it does not model a DNS Server). Entries are either automatically created as result of DHCP or IPCP received DNS server information, or are statically configured by the ACS.

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

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

The status of this entry. Enumeration of:

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

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

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

- 2.0
DNSServer string­(:45) W [IPAddress] DNS server IP addresses. Note: DNSServer is only writable when Type is Static; otherwise, DNSServer is automatically configured as result of DHCP or IPCP received DNS server information. - 2.0
Interface string­(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This parameter specifies the IP interface over which the DNS query is sent. If an empty string is specified, the CPE MUST use its routing policy (Forwarding table entries), if necessary, to determine the appropriate interface. Note: Interface is only writable when Type is Static; otherwise, Interface is automatically configured as result of DHCP or IPCP received DNS server information. 2.0
Type string R

Method used to assign the DNSServer address. Enumeration of:

  • DHCP
  • IPCP
  • Static Table entries that are automatically created as result of DHCP or IPCP received DNS server information will have Type set to DHCP or IPCP, as the case may be. Manually created table entires will have their Type set to Static.
Static 2.0
Device.­DNS.­Relay. object R DNS Relay object. The DNS proxy (or relay) function allows the forwarding of local network DNS queries to local or external DNS server(s) [RFC5625]. - 2.0
Enable boolean W Enables or disables the DNS Relay function. - 2.0
Status string R

The status of the DNS relay. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
- 2.0
Forward­Number­Of­Entries unsigned­Int R The number of entries in the Forwarding table. - 2.0
Device.­DNS.­Relay.­Forwarding.­{i}. object(0:) W

DNS Server forwarding policy to be used by the DHCP Relay. Entries are either automatically created as result of DHCP or IPCP received DNS server information, or are statically configured by the ACS. Note: Management of re-directing queries to the device embedded DNS server is not defined in this version of the specification.

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

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

The status of this entry. Enumeration of:

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

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

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

- 2.0
DNSServer string­(:45) W [IPAddress] DNS server IP addresses. Note: DNSServer is only writable when Type is Static; otherwise, DNSServer is automatically configured as result of DHCP or IPCP received DNS server information. - 2.0
Interface string­(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the IP interface over which the DNS query is sent. If an empty string is specified, the CPE MUST use its routing policy (IP Forwarding table entries), if necessary, to determine the appropriate interface. Note: Interface is only writable when Type is Static; otherwise, Interface is automatically configured as result of DHCP or IPCP received DNS server information. 2.0
Type string R

Method used to assign the DNSServer address. Enumeration of:

  • DHCP
  • IPCP
  • Static Table entries that are automatically created as result of DHCP or IPCP received DNS server information will have Type set to DHCP or IPCP, as the case may be. Manually created table entires will have their Type set to Static.
Static 2.0
Device.­DNS.­Diagnostics. object R The DNS Diagnostics object containing the NSLookupDiagnostics test. - 2.0
Device.­DNS.­Diagnostics.­NSLookup­Diagnostics. object R This object defines access to an IP-layer NS Lookup test for the specified IP interface. When initiated, the NS Lookup test will contact DNSServer and look up HostName NumberOfRepetitions times. There will be a Result instance for each time the device performs a DNS lookup, which is determined by the value of NumberOfRepetitions. Any previous Result instances are removed when a new test is initiated. - 2.0
Diagnostics­State 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.
- 2.0
Interface string­(:256) W The value MUST be the Path Name of a table row. This parameter specifies the IP-layer interface over which the test is to be performed (i.e. the source IP address to use when performing the test). If an empty string is specified, the CPE MUST use its routing policy (Forwarding table entries), if necessary, to determine the appropriate interface. - 2.0
Host­Name string­(:256) W Specifies the Host Name that NS Lookup is to look for. The current domain name MUST be used unless the name is a fully qualified name. - 2.0
DNSServer string­(:256) W Specifies the DNS Server name or IP address that NS Lookup is to use for the lookup. The name of this server will be resolved using the default DNS server unless an IP address is provided. If an empty string is specified, the device’s default DNS server will be used. - 2.0
Timeout unsigned­Int W Timeout in milliseconds that indicates that a request has failed. - 2.0
Number­Of­Repetitions unsigned­Int W The number of times the device SHOULD repeat the execution of the NSLookup using the same input parameters. If the diagnostics test fails the CPE MAY terminate the test without completing the full number of repetitions. Each repetition will use a Result instance to hold the NSLookup result data. - 2.0
Success­Count unsigned­Int R Number of successfully executed repetitions. - 2.0
Result­Number­Of­Entries unsigned­Int R The number of entries in the Result table. Total number of Result entries from the most recent invocation of the test. - 2.0
Device.­DNS.­Diagnostics.­NSLookup­Diagnostics.­Result.­{i}. object(0:) R Results from the most recent invocation of the test, one instance per repetition. - 2.0
Status string R

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

  • Success
  • Error_DNSServerNotAvailable
  • Error_HostNameNotResolved
  • Error_Timeout
  • Error_Other
- 2.0
Answer­Type 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
- 2.0
Host­Name­Returned 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. - 2.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. - 2.0
DNSServer­IP string­(:45) R [IPAddress] Result parameter to represent the actual DNS Server IP address that the NS Lookup used. - 2.0
Response­Time unsigned­Int R Response time (for the first response packet) in milliseconds, or 0 if no response was received. - 2.0
Device.­NAT. object R Properties for Network Address Translation (NAT). The entire Device.NAT. object only applies to IPv4. - 2.0
Interface­Setting­Number­Of­Entries unsigned­Int R The number of entries in the InterfaceSetting table. - 2.0
Port­Mapping­Number­Of­Entries unsigned­Int R The number of entries in the PortMapping table. - 2.0
Device.­NAT.­Interface­Setting.­{i}. object(0:) W

NAT settings for an associated IP Interface on which NAT is enabled. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The Device.NAT.InterfaceSetting.{i}. table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Device.NAT.InterfaceSetting.{i}. row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending Device.NAT.InterfaceSetting.{i}. row.

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

- 2.0
Enable boolean W Enables or disables the Device.NAT.InterfaceSetting.{i}. entry, indicating if NAT is enabled for the referenced IP Interface instance. On creation, an Device.NAT.InterfaceSetting.{i}. entry is disabled by default. false 2.0
Status string R

The status of this entry. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 2.0
Alias string­(:64) W

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

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

- 2.0
Interface string­(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The associated IP interface on which NAT is to be enabled. 2.0
Device.­NAT.­Port­Mapping.­{i}. object(0:) W

Port mapping table. This table MUST contain all NAT port mappings associated with this connection, including static and dynamic port mappings programmatically created via local control protocol, such as UPnP. This table MUST NOT contain dynamic NAT binding entries associated with the normal operation of NAT. If the CPE hosts a firewall, it is assumed that it will appropriately configure the firewall for the port mapping. For enabled table entries, if InternalClient is an empty string then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

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

The status of this entry. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 2.0
Alias string­(:64) W

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

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

- 2.0
Interface string­(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the IP interface to which this port mapping applies. 2.0
All­Interfaces boolean W Indicates whether this port mapping applies to all IP interfaces that support port mappings. If true, the value of Interface is ignored since all supported IP interfaces are indicated. false 2.0
Lease­Duration unsigned­Int W Determines the time to live, in seconds, of a port mapping lease, where “time to live” means the number of seconds before the port mapping expires. A value of 0 means the port mapping is static. Support for dynamic (non-static) port mappings is OPTIONAL. That is, the only value for LeaseDuration that MUST be supported is 0. For a dynamic (non-static) port mapping, when this parameter is read, the value represents the time remaining on the port mapping lease. That is, for a dynamic port mapping, the value counts down toward 0. When a dynamic port mapping lease expires, the CPE MUST automatically terminate that port mapping, and MUST automatically delete the corresponding Device.NAT.PortMapping.{i}. table entry. - 2.0
Remote­Host string W

This parameter is the IP address of the source of inbound packets. An empty string indicates a “wildcard”, i.e. any IP address (this will be an empty string in most cases). CPE are REQUIRED only to support an empty string. When RemoteHost is an empty string, all traffic sent to the ExternalPort on the WAN interface of the gateway is forwarded to the IP.Interface associated with the InternalClient on the InternalPort. When RemoteHost is specified as one external IP address, the NAT will only forward inbound packets from this RemoteHost to the InternalClient, all other packets will be dropped. If a CPE supports non-empty values for RemoteHost, it MAY additionally support the ability to have more than one port mapping with the same ExternalPort and Protocol, but with differing values of RemoteHost. When wildcard values are used for RemoteHost and/or ExternalPort, the following precedence order applies (with the highest precedence listed first):

  1. Explicit RemoteHost, explicit ExternalPort
  2. Explicit RemoteHost, zero ExternalPort
  3. Empty RemoteHost, explicit ExternalPort
  4. Empty RemoteHost, zero ExternalPort If an incoming packet matches the criteria associated with more than one entry in this table, the CPE MUST apply the port mapping associated with the highest precedence entry.
2.0
External­Port unsigned­Int­(0:65535) 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 the IP.Interface associated with the InternalClient on the InternalPort. A value of zero (0) represents a “wildcard”, i.e. any port number. If this value is 0, connection requests on all external ports (that are not otherwise mapped) will be forwarded to InternalClient, and the value(s) of InternalPort on InternalClient are ignored. When wildcard values are used for RemoteHost and/or ExternalPort, the following precedence order applies (with the highest precedence listed first):

  1. Explicit RemoteHost, explicit ExternalPort
  2. Explicit RemoteHost, zero ExternalPort
  3. Empty RemoteHost, explicit ExternalPort
  4. Empty RemoteHost, zero ExternalPort If an incoming packet matches the criteria associated with more than one entry in this table, the CPE MUST apply the port mapping associated with the highest precedence entry.
- 2.0
External­Port­End­Range unsigned­Int­(0:65535) W Indicates the last port of the external port range that starts with ExternalPort. If an external port range is specified, then the behavior described for ExternalPort applies to all ports within the range. A value of zero (0) indicates that no external port range is specified, i.e. that the range consists only of ExternalPort. If ExternalPort is zero (wildcard), the value of this parameter MUST be ignored. If specified, the value of this parameter MUST be greater than or equal to the value of ExternalPort. 0 2.0
Internal­Port unsigned­Int­(0:65535) W The port on InternalClient that the gateway SHOULD forward connection requests to. - 2.0
Protocol string W

The protocol of the port mapping. Enumeration of:

  • TCP
  • UDP
- 2.0
Internal­Client string­(:256) W The IP address or DNS host name of an internal client (on the LAN). Support for an IP address is mandatory. If InternalClient is specified as an IP address and the LAN device’s IP address subsequently changes, the port mapping MUST remain associated with the original IP address. Support for DNS host names is OPTIONAL. If InternalClient is specified as a DNS host name and the LAN device’s IP address subsequently changes, the port mapping MUST remain associated with this LAN device. In this case, it is the responsibility of the CPE to maintain the name-to-address mapping in the event of IP address changes. This can be accomplished, for example, by assigning the DNS host name via use of DHCP option 12 (Host Name) or option 81 (FQDN). Note that the ACS can learn the host name associated with a given LAN device via the Hosts.Host. table. Read access to this parameter MUST always return the exact value that was last set by the ACS. For example, if the internal client is set to a DNS host name, it MUST read back as a DNS host name and not as an IP address. It MUST be possible to set the InternalClient to the broadcast IP address 255.255.255.255 for UDP mappings. This is to enable multiple NAT clients to use the same well-known port simultaneously. 2.0
Description string­(:256) W User-readable description of this port mapping. 2.0
Device.­DHCPv­4. object R The Dynamic Host Configuration Protocol (DHCP) IPv4 object [RFC2131]. This entire object applies to IPv4 only. It contains the Client, Server, and Relay objects. - 2.0
Client­Number­Of­Entries unsigned­Int R The number of entries in the Client table. - 2.0
Device.­DHCPv­4.­Client.­{i}. object(1:) W

This object contains DHCP client settings for an associated IP Interface indicated by Interface. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The Device.DHCPv4.Client.{i}. table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Device.DHCPv4.Client.{i}. row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending Device.DHCPv4.Client.{i}. row.

This table MUST contain at least 1 entry.

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

- 2.0
Enable boolean W Enables or disables the DHCP Client entry. false 2.0
Alias string­(:64) W

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

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

- 2.0
Interface string­(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The IP Interface associated with the Client entry. 2.0
Status string R

The status of this table entry. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 2.0
DHCPStatus string R

The DHCP Client status as defined in [RFC2131]. Enumeration of:

  • Init
  • Selecting
  • Requesting
  • Rebinding
  • Bound
  • Renewing Note: This value is only relevant when the DHCP Client is operationally enabled (i.e. when Status is Enabled).
- 2.0
Renew boolean W

When set to true, the DHCP client will renew its DHCP lease.

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

false 2.0
IPAddress string­(:45) R [IPv4Address] IPv4 Address option received from the DHCP Server. An empty string when Status is not equal to Bound. 2.0
Subnet­Mask string­(:45) R [IPv4Address] Subnet mask option received from the DHCP Server. An empty string when Status is not equal to Bound. Value is information received via DHCP Option 1. 2.0
IPRouters string­(:45)(:256)[] R [IPv4Address] Comma-separated list (maximum number of characters per item 256) of IPv4Addresses. Items represent IP Router IPv4 Address(es) received from the DHCP server. An empty string when Status is not equal to Bound. Value is information received via DHCP Options 3, 33 or 121. 2.0
DNSServers string­(:45)(:256)[] R [IPv4Address] Comma-separated list (maximum number of characters per item 256) of IPv4Addresses. Items represent DNS Server IPv4 Address(es) received from the DHCP server. An empty string when Status is not equal to Bound. Value is information received via DHCP Option 6. 2.0
Lease­Time­Remaining int­(-­1:) R DHCP lease time remaining in seconds. A value of -1 indicates an infinite lease. 0 2.0
DHCPServer string­(:45) R [IPv4Address] The IPv4 address of the current DHCP server. 2.0
Passthrough­Enable boolean W If false, the DHCP Client retrieved IP address information is configured on the referenced Interface object. If true, the DHCP Client retrieved information is propagated to the parameters in the referenced PassthroughDHCPPool object, replacing any existing configuration (including MinAddress, MaxAddress, SubnetMask, IPRouters, and DNSServers). false 2.0
Passthrough­DHCPPool string­(:256) W The value MUST be the Path Name of a row in the Server.Pool. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.When PassthroughDHCPPool is set to an empty string, PassthroughEnable MUST be set to false (i.e. passthrough can not be enabled without a pool reference specified). 2.0
Sent­Option­Number­Of­Entries unsigned­Int R The number of entries in the SentOption table. - 2.0
Req­Option­Number­Of­Entries unsigned­Int R The number of entries in the ReqOption table. - 2.0
Device.­DHCPv­4.­Client.­{i}.­Sent­Option.­{i}. object(0:) W

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

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

- 2.0
Enable boolean W Enables or disables this SentOption table entry. false 2.0
Alias string­(:64) W

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

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

- 2.0
Tag unsigned­Int­(1:254) W Option tag as defined in [RFC2132]. - 2.0
Value hex­Binary­(0:255) W HexBinary encoded option value. 2.0
Device.­DHCPv­4.­Client.­{i}.­Req­Option.­{i}. object(0:) W

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

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

- 2.0
Enable boolean W Enables or disables this ReqOption table entry. false 2.0
Order unsigned­Int­(1:) W Position of the option in the DHCP client request. A value of 1 indicates the first entry. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a Device.DHCPv4.Client.{i}.ReqOption.{i}. table entry MUST be one greater than the largest current value. - 2.0
Alias string­(:64) W

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

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

- 2.0
Tag unsigned­Int­(1:254) W Option tag as defined in [RFC2132]. - 2.0
Value hex­Binary­(0:255) R HexBinary encoded most recently received DHCP option value. If no option value has been received, then the value MUST represent an empty string. Received DHCP option values MAY, but need not, persist across CPE reboots. 2.0
Device.­DHCPv­4.­Server. object R DHCP server configuration. - 2.0
Enable boolean W Enables or disables the DHCP server. - 2.0
Pool­Number­Of­Entries unsigned­Int R The number of entries in the Pool table. - 2.0
Device.­DHCPv­4.­Server.­Pool.­{i}. object(0:) W

DHCP conditional serving pool table. Each instance of this object defines a DHCP conditional serving pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCP options, and MAC address. Overlapping pool ranges MUST be supported. For enabled table entries, if Interface is not a valid reference, or MinAddress, MaxAddress, or SubnetMask is not a valid value, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

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

The status of this entry. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 2.0
Alias string­(:64) W

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

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

- 2.0
Order unsigned­Int­(1:) W Position of the Device.DHCPv4.Server.Pool.{i}. entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each DHCP request, the highest ordered entry that matches the association criteria is applied. All lower order entries are ignored. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a Device.DHCPv4.Server.Pool.{i}. table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). - 2.0
Interface string­(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The IP Interface associated with the Pool entry. 2.0
Vendor­Class­ID string­(:255) W Pool association criterion. Used to identify one or more LAN devices, value of the DHCP Vendor Class Identifier (Option 60) as defined in [RFC2132], matched according to the criterion in VendorClassIDMode. Case sensitive. This is a normal string, e.g. “abc” is represented as “abc” and not say “616263” hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. An empty string indicates this criterion is not used for conditional serving. 2.0
Vendor­Class­IDExclude boolean W If false, matching packets are those that match the VendorClassID entry, if specified. If true, matching packets are those that do not match the VendorClassID entry, if specified. false 2.0
Vendor­Class­IDMode string W

VendorClassID pattern match criterion. Enumeration of:

  • Exact
  • Prefix
  • Suffix
  • Substring For example, if VendorClassID is “Example” then an Option 60 value of “Example device” will match with VendorClassIDMode values of Prefix or Substring, but not with Exact or Suffix.
Exact 2.0
Client­ID hex­Binary­(:255) W Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Client Identifier (Option 61) as defined in [RFC2132]. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used for conditional serving. 2.0
Client­IDExclude boolean W If false, matching packets are those that match the ClientID entry, if specified. If true, matching packets are those that do not match the ClientID entry, if specified. false 2.0
User­Class­ID hex­Binary­(:255) W Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP User Class Identifier (Option 77) as defined in [RFC3004]. An empty string indicates this criterion is not used for conditional serving. 2.0
User­Class­IDExclude boolean W If false, matching packets are those that match the UserClassID entry, if specified. If true, matching packets are those that do not match the UserClassID entry, if specified. false 2.0
Chaddr string­(:17) W [MACAddress] Pool association criterion. Hardware address (MAC address) of the physical interface of the DHCP client. An empty string indicates this criterion is not used for conditional serving. 2.0
Chaddr­Mask 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. 2.0
Chaddr­Exclude boolean W If false, matching packets are those that match the (masked) Chaddr entry, if specified. If true, matching packets are those that do not match the (masked) Chaddr entry, if specified. false 2.0
Min­Address string­(:45) W [IPv4Address] Specifies first IPv4 address in the pool to be assigned by the DHCP server on the LAN interface. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with Client.{i}.PassthroughEnable or a PPP interface with PPP.Interface.{i}.IPCP.PassthroughEnable equal to true. - 2.0
Max­Address string­(:45) W [IPv4Address] Specifies last IPv4 address in the pool to be assigned by the DHCP server on the LAN interface. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with Client.{i}.PassthroughEnable or a PPP interface with PPP.Interface.{i}.IPCP.PassthroughEnable equal to true. - 2.0
Reserved­Addresses string­(:45)[:32] W [IPv4Address] Comma-separated list (up to 32 items) of IPv4Addresses. List items represent addresses marked reserved from the address allocation pool. 2.0
Subnet­Mask string­(:45) W [IPv4Address] Specifies the client’s network subnet mask. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with Client.{i}.PassthroughEnable or a PPP interface with PPP.Interface.{i}.IPCP.PassthroughEnable equal to true. - 2.0
DNSServers string­(:45)[:4] W [IPv4Address] Comma-separated list (up to 4 items) of IPv4Addresses. List items represent DNS servers offered to DHCP clients. Support for more than three DNS Servers is OPTIONAL. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with Client.{i}.PassthroughEnable or a PPP interface with PPP.Interface.{i}.IPCP.PassthroughEnable equal to true. - 2.0
Domain­Name string­(:64) W Sets the domain name to provide to clients on the LAN interface. - 2.0
IPRouters string­(:45)[:4] W [IPv4Address] Comma-separated list (up to 4 items) of IPv4Addresses. List items represent addresses of routers on this subnet. Also known as default gateway. Support for more than one Router address is OPTIONAL. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with Client.{i}.PassthroughEnable or a PPP interface with PPP.Interface.{i}.IPCP.PassthroughEnable equal to true. - 2.0
Lease­Time int­(-­1:) W Specifies the lease time in seconds of client assigned addresses. A value of -1 indicates an infinite lease. 86400 2.0
Static­Address­Number­Of­Entries unsigned­Int R The number of entries in the StaticAddress table. 0 2.0
Option­Number­Of­Entries unsigned­Int R The number of entries in the Option table. 0 2.0
Device.­DHCPv­4.­Server.­Pool.­{i}.­Static­Address.­{i}. object(0:) W

DHCP static address table. Entries in this table correspond to what [RFC2131] calls “manual allocation”, where a client’s IP address is assigned by the network administrator, and DHCP is used simply to convey the assigned address to the client. Each instance of this object specifies a hardware address (MAC address) and an IP address within the pool. When serving from this pool, this IP address MUST, if available, be assigned to the DHCP client with this hardware address, and MUST NOT be assigned to any other client. Note that it is possible that an IP address in this table is present in one or more of the other conditional serving pools, in which case it is possible that such an address will be assigned to a different client.

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

- 2.0
Enable boolean W Enables or disables the StaticAddress table entry. Disabling an entry does not return the IP address to the pool. false 2.0
Alias string­(:64) W

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

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

- 2.0
Chaddr string­(:17) W [MACAddress] Hardware address (MAC address) of the physical interface of the DHCP client. 2.0
Yiaddr string­(:45) W [IPv4Address] IPv4 address to be assigned by the DHCP server to the DHCP client with the specified hardware address (MAC address). 2.0
Device.­DHCPv­4.­Server.­Pool.­{i}.­Option.­{i}. object(0:) W

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

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

- 2.0
Enable boolean W Enables or disables this Option table entry. false 2.0
Alias string­(:64) W

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

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

- 2.0
Tag unsigned­Int­(1:254) W Option tag as defined in [RFC2132]. - 2.0
Value hex­Binary­(0:255) W HexBinary encoded option value. 2.0
Device.­DHCPv­4.­Relay. object R DHCP Relay Agent (conditional relaying). - 2.0
Enable boolean W Enables or disables the DHCP Relay Agent function. - 2.0
Status string R

The status of the DHCP relay. Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL) The Error value MAY be used by the CPE to indicate a locally defined error condition.
- 2.0
Forwarding­Number­Of­Entries unsigned­Int R The number of entries in the Forwarding table. - 2.0
Device.­DHCPv­4.­Relay.­Forwarding.­{i}. object(0:) W

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

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

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

The status of this entry. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 2.0
Alias string­(:64) W

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

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

- 2.0
Order unsigned­Int­(1:) W Position of the Device.DHCPv4.Relay.Forwarding.{i}. entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each DHCP request, the highest ordered entry that matches the association criteria is applied. All lower order entries are ignored. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a Device.DHCPv4.Relay.Forwarding.{i}. table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). - 2.0
Interface string­(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The IP Interface associated with the Forwarding entry. 2.0
Vendor­Class­ID string­(:255) W Pool association criterion. Used to identify one or more LAN devices, value of the DHCP Vendor Class Identifier (Option 60) as defined in [RFC2132], matched according to the criterion in VendorClassIDMode. Case sensitive. This is a normal string, e.g. “abc” is represented as “abc” and not say “616263” hex. However, if the value includes non-printing characters then such characters have to be represented using XML escapes, e.g. #x0a for line-feed. An empty string indicates this criterion is not used for conditional serving. 2.0
Vendor­Class­IDExclude boolean W If false, matching packets are those that match the VendorClassID entry, if specified. If true, matching packets are those that do not match the VendorClassID entry, if specified. false 2.0
Vendor­Class­IDMode string W

VendorClassID pattern match criterion. Enumeration of:

  • Exact
  • Prefix
  • Suffix
  • Substring For example, if VendorClassID is “Example” then an Option 60 value of “Example device” will match with VendorClassIDMode values of Prefix or Substring, but not with Exact or Suffix.
Exact 2.0
Client­ID hex­Binary­(:255) W Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Client Identifier (Option 61) as defined in [RFC2132]. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used for conditional serving. 2.0
Client­IDExclude boolean W If false, matching packets are those that match the ClientID entry, if specified. If true, matching packets are those that do not match the ClientID entry, if specified. false 2.0
User­Class­ID hex­Binary­(:255) W Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP User Class Identifier (Option 77) as defined in [RFC3004]. An empty string indicates this criterion is not used for conditional serving. 2.0
User­Class­IDExclude boolean W If false, matching packets are those that match the UserClassID entry, if specified. If true, matching packets are those that do not match the UserClassID entry, if specified. false 2.0
Chaddr string­(:17) W [MACAddress] Pool association criterion. Hardware address (MAC address) of the physical interface of the DHCP client. An empty string indicates this criterion is not used for conditional serving. 2.0
Chaddr­Mask 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. 2.0
Chaddr­Exclude boolean W If false, matching packets are those that match the (masked) Chaddr entry, if specified. If true, matching packets are those that do not match the (masked) Chaddr entry, if specified. false 2.0
Locally­Served boolean W If true, incoming DHCP requests will be forwarded to the CPE DHCP Server. If false, incoming DHCP requests will be forwarded to the DHCPServerIPAddress configured for this forwarding entry. false 2.0
DHCPServer­IPAddress string­(:45) W [IPv4Address] IPv4 address of the DHCP server, where the request has to be sent to when there is a conditional match with this forwarding entry and LocallyServed is false. If LocallyServed is false and this parameter is not configured, then the DHCP request is dropped. - 2.0
Device.­Users. object R Users object that contains the User table. - 2.0
User­Number­Of­Entries unsigned­Int R The number of entries in the User table. - 2.0
Device.­Users.­User.­{i}. object(0:) W

This object contains parameters relating to the user characteristics.

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

- 2.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 2.0
Remote­Access­Capable boolean W Allows this user to remotely access the UserInterface via the mechanism defined in UserInterface.RemoteAccess. false 2.0
Username string­(:64) W Name of the current user. MUST NOT be an empty string for an enabled entry. 2.0
Password string­(:64) W

The user’s password.

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

- 2.0
Language string­(:16) W String describing the default language for the local configuration interface, specified according to [RFC3066]. If an empty string, UserInterface.CurrentLanguage is used. 2.0
Device.­IEEE8021x. object R IEEE 802.1x object [802.1x-2004], where Supplicant models authentication supplicants. - 2.0
Supplicant­Number­Of­Entries unsigned­Int R The number of entries in the Supplicant table. - 2.0
Device.­IEEE8021x.­Supplicant.­{i}. object(1:) W

802.1x supplicant authentication provisioning and status information associated with an interface to be authenticated (e.g. an Ethernet.Link instance). For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The Device.IEEE8021x.Supplicant.{i}. table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Device.IEEE8021x.Supplicant.{i}. row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending Device.IEEE8021x.Supplicant.{i}. row.

This table MUST contain at least 1 entry.

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

- 2.0
Enable boolean W This parameter controls whether this resource will utilize the 802.1x protocol as a supplicant for device authentication purposes. false 2.0
Status string R

The current operational status of this 802.1x supplicant. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPE to indicate a locally defined error condition.
Disabled 2.0
Alias string­(:64) W

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

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

- 2.0
Interface string­(:256) W The value MUST be the Path Name of a table row. The interface on which authentication is to be performed. Example: Device.Ethernet.Link.1 2.0
PAEState string R

The current supplicant state machine as defined in [Section 9.5.1/802.1x-2004], Supplicant PAE (Port Access Entity) State. Enumeration of:

  • Disconnected
  • Logoff
  • Connecting
  • Authenticating
  • Authenticated
  • Held
  • Restart
  • ForceAuth
  • ForceUnauth
- 2.0
EAPIdentity string­(:256) W The identity to be exchanged between the supplicant and authenticator. - 2.0
Max­Start unsigned­Int­(1:10) W The maximum number of times the device will attempt to send an EAP start message before authentication fails as defined in [Section 9.5.1/802.1x-2004], maxStart. This is in support of [Section 8.4.6/802.1x-2004], Migration Considerations. - 2.0
Start­Period unsigned­Int­(1:) W The period in seconds a supplicant will wait before the device will attempt to re-send an EAP start message as defined in [Section 9.5.1/802.1x-2004], startPeriod. - 2.0
Held­Period unsigned­Int­(1:) W The hold-off period in seconds a supplicant will wait before re-attempting authentication as defined in [Section 9.5.1/802.1x-2004], heldPeriod. - 2.0
Auth­Period unsigned­Int W The period in seconds after which a request will be considered timed out as defined in [Section 9.5.1/802.1x-2004], authPeriod. - 2.0
Authentication­Capabilities string­[] R

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

  • EAP-TLS
  • EAP-MD5
- 2.0
Start­Failure­Policy string W

The action to be taken when authentication has failed, when the network fails to respond to the supplicant’s start message, and the retries have been exceeded (since network does not yet support 802.1x). Enumeration of:

- 2.0
Authentication­Success­Policy string W

The action to be taken when authentication succeeds and a connection has already received an address and/or policy settings. Enumeration of:

  • NoAction
  • RenewConnection
- 2.0
Reset boolean W

When set to true, the device MUST reset the session by performing an initial authentication attempt as defined in [Section 9.6.1.3/802.1x-2004], Initialize Port by sending out the EAP start message. The device MUST initiate the reset after completion of the current CWMP session. The device MAY delay resetting the resource in order to avoid interruption of a user service such as an ongoing voice call.

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

- 2.0
Disconnect boolean W

When set to true, the device MUST disconnect (forced unauthentication) the resource. The device MUST initiate the disconnect after completion of the current CWMP session. The device MAY delay re-authentication of the resource in order to avoid interruption of a user service such as an ongoing voice call.

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

- 2.0
Device.­IEEE8021x.­Supplicant.­{i}.­Stats. object R 802.1x Authentication Supplicant EAP statistics information for this resource. - 2.0
Received­Frames unsigned­Int R The number of EAPOL frames of any type that have been received by this Supplicant; [Section 9.5.2/802.1x-2004], EAPOL frames received. 0 2.0
Transmitted­Frames unsigned­Int R The number of EAPOL frames of any type that have been transmitted by this Supplicant; [Section 9.5.2/802.1x-2004], EAPOL frames transmitted. 0 2.0
Transmitted­Start­Frames unsigned­Int R The number of EAPOL Start frames that have been transmitted by this Supplicant; [Section 9.5.2/802.1x-2004], EAPOL Start frames transmitted. 0 2.0
Transmitted­Logoff­Frames unsigned­Int R The number of EAPOL Logoff frames that have been transmitted by this Supplicant; [Section 9.5.2/802.1x-2004], EAPOL Logoff frames transmitted. 0 2.0
Transmitted­Response­Id­Frames unsigned­Int R The number of EAP Resp/Id frames that have been transmitted; [Section 9.5.2/802.1x-2004], EAP Resp/Id frames transmitted. 0 2.0
Transmitted­Response­Frames unsigned­Int R The number of valid EAP Response frames (other than Resp/Id frames) that have been transmitted by this Supplicant; [Section 9.5.2/802.1x-2004], EAP Resp frames transmitted. 0 2.0
Received­Request­Id­Frames unsigned­Int R The number of EAP Req/Id frames that have been received by this Supplicant; [Section 9.5.2/802.1x-2004], EAP Req/Id frames received. 0 2.0
Received­Request­Frames unsigned­Int R The number of EAP Request frames (other than Rq/Id frames) that have been received by this Supplicant; [Section 9.5.2/802.1x-2004], EAP Req frames received. 0 2.0
Received­Invalid­Frames unsigned­Int R The number of EAPOL frames that have been received by this Supplicant in which the frame type is not recognized; [Section 9.5.2/802.1x-2004], EAP Req frames received. 0 2.0
Received­Length­Error­Frames unsigned­Int R The number of EAPOL frames that have been received by this Supplicant in which the Packet Body Length field is invalid; [Section 9.5.2/802.1x-2004], EAP length error frames received. 0 2.0
Last­Frame­Version unsigned­Int R The protocol version number carried in the most recently received EAPOL frame; [Section 9.5.2/802.1x-2004], Last EAPOL frame version - 2.0
Last­Frame­Source­MACAddress string­(:17) R [MACAddress] The source MAC address carried in the most recently received EAPOL frame; [Section 9.5.2/802.1x-2004], Last EAPOL frame source. - 2.0
Device.­IEEE8021x.­Supplicant.­{i}.­EAPMD5. object R 802.1x Authentication Supplicant provisioning information used for MD5 shared secret exchange. This object will not exist if EAP-MD5 is not a supported authentication type. - 2.0
Enable boolean W This parameter enables or disables the supplicant’s support for EAP-MD5. - 2.0
Shared­Secret string­(:256) W

The shared secret to be exchanged between the supplicant and authenticator.

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

- 2.0
Device.­IEEE8021x.­Supplicant.­{i}.­EAPTLS. object R 802.1x Authentication Supplicant provisioning information used for TLS certificate authentication. This object will not exist if the EAP-TLS is not a supported authentication type. - 2.0
Enable boolean W This parameter enables or disables the supplicant’s support for EAP-TLS. - 2.0
Mutual­Authentication­Enable boolean W The parameter controls if the supplicant will authenticate the authenticator. - 2.0
Device.­Smart­Card­Readers. object R SmartCardReaders object that contains the SmartCardReader table. - 2.0
Smart­Card­Reader­Number­Of­Entries unsigned­Int R The number of entries in the SmartCardReader table. - 2.0
Device.­Smart­Card­Readers.­Smart­Card­Reader.­{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.

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

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

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

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

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

- 2.0
Reset­Time date­Time R The time at which this SmartCard Reader was reset. Reset can be caused by:
  • Status transition from Disabled to Enabled
  • Reset set to true.
  • An internal reset of the SmartCard Reader (including a reboot of the device). Unknown Time value indicates that this SmartCard Reader has never been reset, which can only happen if it has never been enabled.
- 2.0
Decryption­Failed­Counter unsigned­Int 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. - 2.0
Decryption­Failed­No­Key­Counter unsigned­Int 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. - 2.0
Device.­Smart­Card­Readers.­Smart­Card­Reader.­{i}.­Smart­Card. object R Status of currently associated smart card. - 2.0
Status string R

Status of the Smart Card. Enumeration of:

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

Smart Card Type. Enumeration of:

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

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

  • SIM
  • USIM
  • ISIM Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a2] MUST be adhered to.
- 2.0
Serial­Number string­(:256) R The Smart Card Serial Number or an empty string if the Smart Card serial Number is not available, e.g. in the case of IPTV due to restrictions of the Service Delivery Platform. - 2.0
ATR string­(:1024) R The Smart Card answer to a reset action. Issued by the Smart Card upon reset. - 2.0
Device.­Device­Info. object R This object contains general device information. - 2.0
Manufacturer string­(:64) R The manufacturer of the CPE (human readable string). - 2.0
Manufacturer­OUI string­(6) R

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

  • [0-9A-F]{6} The value MUST be a valid OUI as defined in [OUI]. This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it’s a new device and would therefore require a BOOTSTRAP Inform.
- 2.0
Model­Name string­(:64) R Model name of the CPE (human readable string). - 2.0
Description string­(:256) R A full description of the CPE device (human readable string). - 2.0
Product­Class string­(:64) R Identifier of the class of product for which the serial number applies. That is, for a given manufacturer, this parameter is used to identify the product or class of product over which the SerialNumber parameter is unique. This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it’s a new device and would therefore require a BOOTSTRAP Inform. - 2.0
Serial­Number string­(:64) R Identifier of the particular device that is unique for the indicated class of product and manufacturer. This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it’s a new device and would therefore require a BOOTSTRAP Inform. - 2.0
Hardware­Version string­(:64) R A string identifying the particular CPE model and version. - 2.0
Software­Version string­(:64) R A string identifying the software version currently installed in the CPE (i.e. version of the overall CPE firmware). To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 3.0.21 where the components mean: Major.Minor.Build. - 2.0
Additional­Hardware­Version string­(:64)[] R Comma-separated list (maximum number of characters per item 64) of strings. Each entry is an additional version. Represents any additional hardware version information the vendor might wish to supply. - 2.0
Additional­Software­Version string­(:64)[] R Comma-separated list (maximum number of characters per item 64) of strings. Each entry is an additional version. Represents any additional software version information the vendor might wish to supply. - 2.0
Provisioning­Code string­(:64) W Identifier of the primary service provider and other provisioning information, which MAY be used by the ACS to determine service provider-specific customization and provisioning parameters. - 2.0
Up­Time unsigned­Int R Time in seconds since the CPE was last restarted. - 2.0
First­Use­Date date­Time 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. - 2.0
Vendor­Config­File­Number­Of­Entries unsigned­Int R The number of entries in the VendorConfigFile table. - 2.0
Supported­Data­Model­Number­Of­Entries unsigned­Int R The number of entries in the SupportedDataModel table. - 2.0
Device.­Device­Info.­Vendor­Config­File.­{i}. object(0:) R

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

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

- 2.0
Alias string­(:64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object. - 2.0
Name string­(:6