Broadband Forum

TR-069 Device:2 Root Data Model definition [CWMP]
tr-181-2-15-1-cwmp.xml

DATA MODEL DEFINITION

License

Copyright (c) 2010-2022, Broadband Forum

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

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

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

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

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

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

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

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

Comments or questions about this Broadband Forum data model should be directed to <info@broadband-forum.org>.

Data Types

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

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

Data Type Base Type Description
base64 -

Base64 encoded binary (no line-length limitation).

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

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

Decimal value.

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

hexBinary -

Hex encoded binary.

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

int -

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

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

long -

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

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

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

Unsigned integer in the range 0 to 4294967295, inclusive.

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

unsignedLong -

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

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

Alias string(64)

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
AmplitudeData hexBinary(0:0,2:4116)

This data type represents a sequence of spectral amplitudes. Each spectral amplitude value corresponds to a bin. The format of the bin measurement is as follows.

Sequence of:

4 bytes: ChCenterFreq
The center frequency of the upstream channel.

4 bytes: FreqSpan
The width in Hz of the band across which the spectral amplitudes characterizing the channel are measured.

4 bytes: NumberOfBins
The number of data points or bins that compose the spectral data. The leftmost bin corresponds to the lower band edge, the rightmost bin corresponds to the upper band edge, and the middle bin center is aligned with the center frequency of the analysis span.

4 bytes:
BinSpacing The frequency separation between adjacent bin centers. It is derived from the frequency span and the number of bins or data points. The bin spacing is computed as:
BinSpacing = FrequencySpan/(NumberOfBins -1)

The larger the number of bins the finer the resolution.

4 bytes: ResolutionBW
The resolution bandwidth or equivalent noise bandwidth of each bin. If spectral windowing is used (based on vendor implementation), the bin spacing and resolution bandwidth would not generally be the same.

n bytes: Amplitude (2 bytes * NumberOfBins)
A sequence of two byte elements. Each element represents the spectral amplitudes in relation to the expected received signal power of a bin, in units of 0.01dB. That is, a test CMTS input signal with square-root raised-cosine spectrum, bandwidth equal to the expected received signal bandwidth, and power equal to the expected received signal power, which is present for the entire spectrum sampling period, will exhibit a spectrum measurement of 0 dB average power in each bin of the signal passband. Each bin element amplitude value format is 2's complement which provides a range of -327.68 dB to 327.67 dB amplitude value for the bin measurement.

CmRegState string

This data type defines the CM connectivity state as reported by the CM.

  • Other (indicates any state not described below)
  • NotReady (indicates that the CM has not started the registration process yet)
  • NotSynchronized (indicates that the CM has not initiated or completed the synchronization of the downstream physical layer)
  • PhySynchronized (indicates that the CM has completed the synchronization of the downstream physical layer)
  • UsParametersAcquired (indicates that the CM has completed the upstream parameters acquisition or have completed the downstream and upstream service groups resolution, whether the CM is registering in a pre-3.0 or a 3.0 CMTS)
  • RangingComplete (indicates that the CM has completed initial ranging and received a Ranging Status of success from the CMTS in the RNG-RSP message)
  • DHCPv4Complete (indicates that the CM has received a DHCPv4 ACK message from the CMTS)
  • ToDEstablished (indicates that the CM has successfully acquired time of day. If the ToD is acquired after the CM is operational, this value should not be reported)
  • SecurityEstablished (indicates that the CM has successfully completed the BPI initialization process)
  • ConfigFileDownloadComplete (indicates that the CM has completed the config file download process)
  • RegistrationComplete (indicates that the CM has successfully completed the Registration process with the CMTS)
  • Operational (indicates that the CM has completed all necessary initialization steps and is operational)
  • AccessDenied (indicates that the CM has received a registration aborted notification from the CMTS)
  • EAEInProgress (indicates that the CM has sent an Auth Info message for EAE)
  • DHCPv4InProgress (indicates that the CM has sent a DHCPv4 DISCOVER to gain IP connectivity)
  • DHCPv6InProgress (indicates that the CM has sent an DHCPv6 Solicit message)
  • DHCPv6Complete (indicates that the CM has received a DHCPv6 Reply message from the CMTS)
  • RegistrationInProgress (indicates that the CM has sent a Registration Request (REG-REQ or REG-REQ-MP))
  • BPIInit (indicates that the CM has started the BPI initialization process as indicated in the CM config file. If the CM already performed EAE, this state is skipped by the CM)
  • ForwardingDisabled (indicates that the registration process was completed, but the network access option in the received configuration file prohibits forwarding)
  • DsTopologyResolutionInProgress (indicates that the CM is attempting to determine its MD-DS-SG)
  • RangingInProgress (indicates that the CM has initiated the ranging process)
  • RFMuteAll (indicates that the CM is instructed to mute all channels in the CM-CTRL-REQ message from CMTS)

See [CM-SP-MULPIv3.0], Cable Modem - CMTS Interaction.

Dbm1000 int The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.
DiagnosticsState string

Indicates the availability of diagnostics data. Enumeration of:

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

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

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

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

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

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

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

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

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

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

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

DocsEqualizerData hexBinary(0:0,36:260)

This data type represents the equalizer data as measured at the receiver interface. The format of the equalizer follows the structure of the Transmit Equalization Adjust RNG-RSP TLV of DOCSIS RFI v2.0.

The equalizer coefficients are considered signed 16-bit integers in the range from -32768 (0x8000) to 32767 (0x7FFF).

DOCSIS specifications require up to a maximum of 64 equalizer taps (n + m); therefore, this object size can be up to 260 bytes (4 + 4x64). The minimum object size (other than zero) for a t-spaced tap with a minimum of 8 symbols will be 36 (4 + 4x8).

See [Figure 8-23/CM-SP-RFIv2.0].

DocsisUpstreamType string

Indicates the DOCSIS Upstream Channel Type. Enumeration of:

  • Unknown (Information not available)
  • TDMA (Time Division Multiple Access)
  • ATDMA (Advanced Time Division Multiple Access)
  • SCDMA (Synchronous Code Division Multiple Access)
  • TDMAAndATDMA (Simultaneous support of TDMA and A-TDMA modes)
IEEE_EUI64 string(23)

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

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

Possible patterns:

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

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

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

  • 216.52.29.100
  • 192.168.1.254

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

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

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

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

IPPrefix string(49)

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

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

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

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

IPv4Address IPAddress(15)

IPv4 address (or subnet mask).

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

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

IPv4 address prefix.

Can be any IPv4 prefix that is permitted by the IPPrefix data type. Possible patterns:

  • <Empty> (an empty string)
  • /(3[0-2]|[012]?[0-9])
  • ((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])/(3[0-2]|[012]?[0-9])
IPv6Address IPAddress(45)

IPv6 address.

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

IPv6Prefix IPPrefix(49)

IPv6 address prefix.

Can be any IPv6 prefix that is permitted by the IPPrefix data type.

MACAddress string(17)

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

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

Comma-separated list (2 items) of unsigned integers.

  1. the Power Spectral Density (PSD) breakpoint sub-carrier index in the range [0:49152] with Df = 4.3125 kHz frequency spacing, and
  2. the value of the level of the PSD at this sub-carrier expressed in 0.1 dBm/Hz with an offset of -200 dBm/Hz. The range of valid values for PSD is -30 to -200 dBm/Hz.

Both values are represented as unsignedInt.

PSMBreakPointIndexAndLevel unsignedInt[2]

Comma-separated list (2 items) of unsigned integers.

  1. The PSM breakpoint sub-carrier index in the range [0:4095], and
  2. the value of the level of the PSM at this sub-carrier expressed in 0.1 dBm/Hz with an offset of -140 dBm/Hz.

Both values are represented as unsignedInt.

[Clause 5.2/G.9964] defines limits on PSM breakpoint levels.

RangingState string

This data type defines the CM ranging state as reported by the CMTS. The enumerated values associated with the RangingState are:

  • Other (indicates any state not described below)
  • Aborted (indicates that the CMTS has sent a ranging abort)
  • RetriesExceeded (indicates that the CM ranging retry limit has exceeded)
  • Success (indicates that the CMTS has sent a ranging success in the ranging response)
  • Continue (indicates that the CMTS has sent a ranging continue in the ranging response)
  • TimeoutT4 (indicates that the T4 timer expired on the CM)

See [CM-SP-MULPIv3.0], Cable Modem - CMTS Interaction.

SELTPAttenuationCharacteristicsIndexAndTFlog unsignedInt[2]

Comma-separated list (2 items) of unsigned integers.

  1. The paired frequency spacing index in the range [0:8191], and
  2. The transfer function log value, i.e. [i, TFlog(i * TFlogGroupSize * Df)], where the reference frequency spacing Df = 4.3125 kHz, the index i valid range is 0 to 8191, and TFlog(i * TFlogGroupSize * Df) spans a range from +6.0 dB down to -96.2 dB with units of 0.1 dB.

Both values are represented as unsignedInt.

SST string

Service Slice Type (SST). Enumeration of:

  • eMBB (5G Enhanced Mobile Broadband)
  • URLLC (Ultra-Reliable Low Latency Communications)
  • MIoT (Massive IoT)
  • V2X (Vehicle to Everything)

See [Clause 5.15.2.2/3GPP-TS.23.501].

SpectrumAnalysisWindowFunction string

This object controls the windowing function which will be used when performing the discrete Fourier transform for the analysis. Note that all window functions may not be supported by all devices. If an attempt is made to set the object to an unsupported window function, an error of inconsistentValue will be returned. Enumeration of:

  • Other
  • Hann
  • BlackmanHarris
  • Rectangular
  • Hamming
  • FlatTop
  • Gaussian
  • Chebyshev
StatsCounter32 unsignedInt

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

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

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

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

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

StatsCounter64 unsignedLong

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

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

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

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

TLV8 hexBinary(0:0,2:255)

This data type represents a single TLV encoding. This first octet represents the Type of the TLV. The second octet represents an unsigned 8-bit Length of the subsequent Value part of the TLV. The remaining octets represent the value. The Value could be an atomic value or a sequence of one or more sub-TLVs.

See [CM-SP-MULPIv3.0], Common Radio Frequency Interface Encodings Annex.

TenthdB int This data type represents power levels that are normally expressed in dB. Units are in tenths of a dB; for example, 5.1 dB will be represented as 51.
TenthdBmV int This data type represents power levels that are normally expressed in dBmV. Units are in tenths of a dBmV; for example, 5.1 dBmV will be represented as 51.
UERComplex int[2]

Comma-separated list (2 items) of integers. Pair of 32-bit signed integers a(i),b(i) with each pair representing a complex component of the uncalibrated echo response (UER);

  1. Real UER component, a(i)
  2. Imaginary UER component, b(i)

for values of i starting at i=0. Both values are represented as signed integers.

The interpretation of the UER value is as defined in [Clause A.2.2.1/G.996.2].

URL URI(2048) Uniform Resource Locator. See [RFC3986] (URI), [IANA-uri-schemes], and individual URI scheme RFCs such as [RFC7252] (coap, coaps) and [RFC7230] (http, https).
UUID string(36:36)

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

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

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

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

References

[3GPP-HSPA] High Speed Packet data Access (HSPA), 3GPP.
[3GPP-TS.23.003] 3GPP TS 23.003, Numbering, addressing and identification, 3GPP CT WG4.
[3GPP-TS.23.501] 3GPP TS 23.501, System architecture for the 5G System (5GS); Stage 2, 3GPP SA WG2.
[3GPP-TS.24.008] 3GPP TS 24.008, Mobile radio interface Layer 3 specification; Core network protocols; Stage 3, 3GPP CT WG1.
[3GPP-TS.24.301] 3GPP TS 24.301, Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3, 3GPP CT WG1.
[3GPP-TS.24.501] 3GPP TS 24.501, Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3, 3GPP CT WG1.
[3GPP-TS.24.526] 3GPP TS 24.526, User Equipment (UE) policies for 5G System (5GS); Stage 3, 3GPP CT WG1.
[3GPP-TS.25.171] 3GPP TS 25.171, Requirements for support of Assisted Global Positioning System (A-GPS), 3GPP RAN WG4.
[802.11-2007] IEEE Std 802.11-2007, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, 2007.
[802.11-2012] IEEE Std 802.11-2012, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, March 2012.
[802.11-2016] IEEE Std 802.11-2016, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, December 2016.
[802.11-2020] IEEE Std 802.11-2020, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, December 2020.
[802.11a-1999] IEEE Std 802.11a-1999, High-speed Physical Layer in the 5 GHz band, IEEE, 1999.
[802.11ac-2013] IEEE Std 802.11ac-2013, Enhancements for Very High Throughput for Operation in Bands below 6 GHz, IEEE, December 2013.
[802.11ax] IEEE Std 802.11ax, Enhancements for High Efficiency WLAN, IEEE, May 2021.
[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.11k] IEEE Std 802.11k, Radio Resource Measurement of Wireless LANs, IEEE, May 2008.
[802.11n-2009] IEEE Std 802.11n-2009, Amendment 5: Enhancements for Higher Throughput, IEEE, 2009.
[802.1AB-2009] IEEE Std 802.1AB-2009, Station and Media Access Control Connectivity Discovery, IEEE, 2009.
[802.1ad-2005] IEEE Std 802.1ad-2005, Virtual Bridged Local Area Networks Amendment 4: Provider Bridges, IEEE, May 2005.
[802.1AX-2014] IEEE Std 802.1AX-2014, IEEE Standard for Local and metropolitan area networks -- Link Aggregation, IEEE, 2014.
[802.1D-2004] IEEE Std 802.1D-2004, Media Access Control (MAC) Bridges, IEEE, 2004.
[802.1Q-2005] IEEE Std 802.1Q-2005, Virtual Bridged Local Area Networks, IEEE, 2006.
[802.1Q-2011] IEEE Std 802.1Q-2011, MAC Bridges and Virtual Bridge Local Area Networks, IEEE, 2011.
[802.1x-2004] IEEE Std 802.1x-2004, Standards for Local and Metropolitan Area Networks: Port based Network Access Control, IEEE, 2004.
[802.3-2015] IEEE Std 802.3-2015, IEEE Standard for Ethernet, IEEE, 2015.
[802.3-2012_section6] IEEE 802.3-2012 - Section Six, IEEE Standard for Ethernet - Section Six, IEEE, December 2012.
[AMB] Agile MultiBand Specification, Wi-Fi Agile MultiBand Specification, December 2018.
[BLUE] Blue, A New Class of Active Queue Management Algorithms.
[BPF] BPF, Berkeley Packet Filter Syntax, FreeBSD.org, October 2016.
[CM-SP-CM-OSSIv3.1] CM-SP-CM-OSSIv3.1, Cable Modem Operations Support System Interface Specification, CableLabs, October 2020.
[CM-SP-MULPIv3.0] CM-SP-MULPIv3.0, DOCSIS 3.0 MAC and Upper Layer Protocols Interface Specification, CableLabs, December 2017.
[CM-SP-OSSIv3.0] CM-SP-OSSIv3.0, DOCSIS 3.0 Operations Support System Interface Specification, CableLabs, December 2017.
[CM-SP-RFIv2.0] CM-SP-RFIv2.0, Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification, CableLabs, April 2009.
[DataElements] Data Elements Specification, Wi-Fi Data Elements Specification, Wi-Fi Alliance, September 2021.
[DLNA-NDIG] DLNA Networked Device Interoperability Guidelines, DLNA Networked Device Interoperability Guidelines, Volume 2: Media Format Profiles., DLNA, October 2006.
[DNS-SD] RFC 6763, DNS-Based Service Discovery, IETF, 2013.
[DSLite] RFC 6333, Dual-Stack Lite Broadband Deployments Following IPv4 Exhaustion, IETF, 2011.
[DSLite-options] RFC 6334, Dynamic Host Configuation Protocol for IPv6 (DHCPv6) Option for Dual-Stack Lite, IETF, 2011.
[DVB-TS.102.824] TS 102 824, Digital Video Broadcasting (DVB);Remote Management and Firmware Update System for DVB IP Services, ETSI, July 2008.
[EasyConnect] Wi-Fi Easy Connect Specification, Wi-Fi Easy Connect Specification, Wi-Fi Alliance, December 2020.
[EasyMesh] EasyMesh Specification, Wi-Fi EasyMesh Specification, Wi-Fi Alliance, December 2021.
[ETSIBRAN] ETSI EN 301 893, Broadband Radio Access Networks (BRAN); 5 GHz high performance RLAN; Harmonized EN covering the essential requirements of article 3.2 of the RTTE Directive, ETSI.
[ETSIM2MFA] ETSI TS 102 690 v1.1.6, Machine-to-Machine Communications (M2M Functional Architecture), ETSI, June 2012.
[ETSIM2MInterfaces] ETSI TS 102 921 v1.1.6, M2M mIa, dIa and mId Interfaces, ETSI, August 2012.
[FWEREG] draft-allan-5g-fmc-encapsulation, 5G Wireless Wireline Convergence User Plane Encapsulation (5WE), IETF, March 2020.
[G.988] G.988, ONU management and control interface (OMCI) specification, ITU-T, 2010.
[G.9701] G.9701, Fast access to subscriber terminals (G.fast)- Physical layer specification, ITU-T, 2014.
[G.9954] G.9954, Phoneline networking transceivers - Enhanced physical, media access, and link layer specifications (HPNA 3.0 and 3.1), ITU-T, 2007.
[G.9960] G.9960, Unified high-speed wire-line based home networking transceivers - System architecture and physical layer specification, ITU-T.
[G.9961] G.9961, Unified high-speed wire-line based home networking transceivers - Data link layer specification, ITU-T.
[G.9962] G.9962, Unified high-speed wire-line based home networking transceivers - Management specification, ITU-T.
[G.9964] G.9964, Unified high-speed wire-line based home networking transceivers - Power spectral density specification, ITU-T.
[G.9973] G.9973, Protocol for identifying home network topology, ITU-T, 2011.
[G.993.1] G.993.1, Very high speed digital subscriber line transceivers, ITU-T.
[G.993.2] G.993.2, Very high speed digital subscriber line transceivers 2 (VDSL2), ITU-T.
[G.996.2] G.996.2, Single-ended line testing for digital subscriber lines (DSL), ITU-T.
[G.997.1] G.997.1, Physical layer management for digital subscriber line (DSL) transceivers, ITU-T.
[G.997.2] G.997.2, Physical layer management for FAST transceivers, ITU-T, 2015.
[G.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, 2007.
[HTML4.01] HTML 4.01 Specification, W3C.
[IANA-protocolnumbers] IANA Protocol Numbers, Protocol Numbers, IANA.
[IANA-uri-schemes] IANA Uniform Resource Identifier (URI) Schemes Registry, Uniform Resource Identifier (URI) Schemes, IANA.
[IANAifType] IANAifType, IANAifType-MIB DEFINITIONS, IANA, 2009.
[ICSA-Baseline] ICSA Baseline Modular Firewall Certification Criteria, Baseline module - version 4.1, ICSA Labs, 2008.
[ICSA-Residential] ICSA Residential Modular Firewall Certification Criteria, Required Services Security Policy - Residential Category module - version 4.1, ICSA Labs, 2008.
[IEEE1905.1a] IEEE 1905.1a, IEEE Std 1905.1a, Convergent Digital Home Network for Heterogeneous Technologies Amendment 1: Support of new MAC/PHYs and enhancements, IEEE, December 2014., IEEE, December 2014.
[IEEE_EUI64] Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, IEEE, March 1997.
[IKEv2-params] IKEv2 Parameters, Internet Key Exchange Version 2 (IKEv2) Parameters, IANA.
[IPDR-FTP] IPDR File Transfer Protocol, IPDR/File Transfer Protocol, TM Forum.
[IPDR-SP] IPDR Streaming Protocol, IPDR Streaming Protocol (IPDR/SP) Specification, TM Forum.
[IPDR-XDR] IPDR XDR Encoding Format, IPDR/XDR Encoding Format, TM Forum.
[IPDR-XML] IPDR XML File Encoding Format, IPDR/XML File Encoding Format, TM Forum.
[ISO-13818-6:1998] ISO/IEC 13818-6:1998, Information Technology - Generic coding of moving pictures and associated audio information - Part 6: Extensions for DSM-CC, ISO, 1998.
[ISO3166-1] ISO 3166-1, Codes for the representation of names of countries and their subdivisions - Part 1: Country codes, ISO, 2006.
[ISO639-1] ISO 639-1, Codes for the representation of names of Languages - Part 1: Alpha-2 code, ISO, 2002.
[ISO646-1991] ISO/IEC 646-1991, Information Technology - ISO 7-bit coded character set for information interchange, ISO, 1991.
[ITU-E.118] ITU E.118, The international telecommunication charge card, International Telecommunication Union, May 2006.
[ITU-E.164] ITU E.164, The international public telecommunication numbering plan, International Telecommunication Union, October 2010.
[ITU-X.733] ITU X.733, Information technology - Open Systems Interconnection - Systems Management: Alarm reporting function, International Telecommunication Union, February 1992.
[JJ-300.00] JJ-300.00, Home-network Topology Identifying Protocol, TTC, 2011.
[JJ-300.01] JJ-300.01, The List of Device Categories, TTC, 2011.
[LIBPCAP] Libpcap, Libpcap File Format, Wireshark, 2015.
[LMAPIFM] RFC 8193, Information Model for Large-Scale Measurement Platforms (LMAPs), IETF, August 2017.
[LMAPREG] draft-ietf-ippm-metric-registry-12, Registry for Performance Metrics, IETF, June 30, 2017.
[MOCA11-MIB] MOCA11-MIB, Remote Management of MoCA Interfaces using SNMP MIB, MoCA Alliance, 2009.
[MoCAv1.0] MoCA v1.0, MoCA MAC/PHY Specification v1.0, MoCA Alliance, 2009.
[MoCAv1.1] MoCA v1.1, MoCA MAC/PHY Specification v1.1 Extensions, MoCA Alliance, 2009.
[MQTT31] MQTT v3.1, MQ Telemetry Transport (MQTT) V3.1 Protocol Specification, 2010.
[MQTT50] MQTT Version 5.0, MQTT Version 5.0, Candidate OASIS Standard 02., OASIS Message Queuing Telemetry Transport (MQTT) TC, February 2019.
[MQTT311] MQTT Version 3.1.1, MQTT v3.1.1, OASIS Message Queuing Telemetry Transport (MQTT) TC, October 2014.
[OUI] Organizationally Unique Identifiers (OUIs).
[PCPProxy] PCP Proxy Function, Port Control Protocol (PCP) Proxy Function, IETF, September 2015.
[POSIXBase] ISO/IEC/IEEE 9945, Information technology - Portable Operating System Interface (POSIX) Base Specifications, Issue 7, ISO/IEC/IEEE, September 2009.
[RED] References on RED (Random Early Detection) Queue Management.
[RFC793] RFC 793, Transmission Control Protocol, IETF, September 1981.
[RFC862] RFC 862, Echo Protocol, IETF, 1983.
[RFC959] RFC 959, File Transfer Protocol, IETF, 1985.
[RFC1035] RFC 1035, Domain Names - Implementation and Specification, IETF, 1987.
[RFC1323] RFC 1323, TCP Extensions for High Performance, IETF, May 1992.
[RFC1332] RFC 1332, The PPP Internet Protocol Control Protocol (IPCP), IETF, 1992.
[RFC1378] RFC 1378, The PPP AppleTalk Control Protocol (ATCP), IETF, 1992.
[RFC1552] RFC 1552, The PPP Internetwork Packet Exchange Control Protocol (IPXCP), IETF, 1993.
[RFC1661] RFC 1661, The Point-to-Point Protocol (PPP), IETF, 1994.
[RFC1877] RFC 1877, PPP Internet Protocol Control Protocol Extensions for Name Server Addresses, IETF, 1995.
[RFC1974] RFC 1974, PPP Stac LZS Compression Protocol, IETF, 1996.
[RFC2080] RFC 2080, RIPng for IPv6, IETF, 1997.
[RFC2097] RFC 2097, The PPP NetBIOS Frames Control Protocol (NBFCP), IETF, 1997.
[RFC2104] RFC 2104, HMAC: Keyed-Hashing for Message Authentication, IETF, 1997.
[RFC2131] RFC 2131, Dynamic Host Configuration Protocol, IETF.
[RFC2132] RFC 2132, DHCP Options and BOOTP Vendor Extensions, IETF.
[RFC2225] RFC 2225, Classical IP and ARP over ATM, IETF.
[RFC2364] RFC 2364, PPP Over AAL5, IETF, 1998.
[RFC2474] RFC 2474, Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers, IETF.
[RFC2581] RFC 2581, TCP Congestion Control, IETF, April 1999.
[RFC2582] RFC 2582, The NewReno Modification to TCP's Fast Recovery Algorithm, IETF, April 1999.
[RFC2616] RFC 2616, Hypertext Transfer Protocol -- HTTP/1.1, IETF, 1999.
[RFC2684] RFC 2684, Multiprotocol Encapsulation over ATM Adaptation Layer 5, IETF.
[RFC2697] RFC 2697, A Single Rate Three Color Marker, IETF.
[RFC2698] RFC 2698, A Two Rate Three Color Marker, IETF.
[RFC2782] RFC 2782, A DNS RR for specifying the location of services (DNS SRV), IETF, 2000.
[RFC2784] RFC 2784, Generic Routing Encapsulation (GRE), IETF, November 2000.
[RFC2818] RFC 2818, HTTP Over TLS, IETF, May 2000.
[RFC2819] RFC 2819, Remote Network Monitoring Management Information Base, IETF, 2000.
[RFC2863] RFC 2863, The Interfaces Group MIB, IETF, 2000.
[RFC2865] RFC 2865, Remote Authentication Dial In User Service (RADIUS), IETF, 2000.
[RFC2866] RFC 2866, RADIUS Accounting, IETF, 2000.
[RFC2869] RFC 2869, RADIUS Extensions, IETF, 2000.
[RFC2890] RFC 2890, Key and Sequence Number Extensions to GRE, IETF, November 2000.
[RFC2898] RFC 2898, PKCS #5: Password-Based Cryptography Specification Version 2.0, IETF.
[RFC2974] RFC 2974, Session Announcement Protocol, IETF, October 2000.
[RFC3004] RFC 3004, The User Class Option for DHCP, IETF.
[RFC3066] RFC 3066, Tags for the Identification of Languages, IETF.
[RFC3174] RFC 3174, US Secure Hash Algorithm 1 (SHA1), IETF, September, 2001.
[RFC3232] RFC 3232, "Assigned Numbers: RFC 1700 is Replaced by an On-line Database", IETF, 2002.
[RFC3315] RFC 3315, Dynamic Host Configuration Protocol for IPv6 (DHCPv6), IETF, 2003.
[RFC3339] RFC 3339, Date and Time on the Internet: Timestamps, IETF, July, 2002.
[RFC3489] RFC 3489, STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network Address Translators (NATs), IETF.
[RFC3596] RFC 3596, DDNS Extensions to Support IP Version 6, IETF, 2003.
[RFC3633] RFC 3633, IPv6 Prefix Options for Dynamic Host Configuration Protocol (DHCP) version 6, IETF, 2003.
[RFC3646] RFC 3646, DNS Configuration options for Dynamic Host Configuration Protocol for IPv6 (DHCPv6), IETF, 2003.
[RFC3775] RFC 3775, Mobility Support in IPv6, IETF, 2004.
[RFC3925] RFC 3925, Vendor-Identifying Vendor Options for Dynamic Host Configuration Protocol version 4 (DHCPv4), IETF.
[RFC3926] RFC 3926, FLUTE - File Delivery over Unidirectional Transport, IETF, October 2004.
[RFC3927] RFC 3927, Dynamic Configuration of IPv4 Link-Local Addresses, IETF, 2005.
[RFC3931] RFC 3931, Layer Two Tunneling Protocol - Version 3 (L2TPv3), IETF, March 2005.
[RFC3948] RFC 3948, UDP Encapsulation of IPsec ESP Packets, IETF, January 2005.
[RFC3986] RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF.
[RFC4007] RFC 4007, IPv6 Scoped Address Architecture, IETF.
[RFC4122] RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.
[RFC4180] RFC4180, Common Format and MIME Type for Comma-Separated Values (CSV) Files, IETF, October 2005.
[RFC4191] RFC 4191, Default Router Preferences and More-Specific Routes, IETF, 2005.
[RFC4193] RFC 4193, Unique Local IPv6 Unicast Addresses, IETF, 2005.
[RFC4242] RFC 4242, Information Refresh Time Option for Dynamic Host Configuration Protocol for IPv6 (DHCPv6), IETF, 2005.
[RFC4291] RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006.
[RFC4292] RFC 4292, IP Forwarding Table MIB, IETF, 2006.
[RFC4293] RFC 4293, Management Information Base for the Internet Protocol (IP), IETF, 2006.
[RFC4301] RFC 4301, Security Architecture for the Internet Protocol, IETF, December 2005.
[RFC4302] RFC 4302, IP Authentication Header, IETF, December 2005.
[RFC4303] RFC 4303, IP Encapsulating Security Payload (ESP), IETF, December 2005.
[RFC4389] RFC 4389, Neighbor Discovery Proxies (ND Proxy), IETF, 2006.
[RFC4546] RFC 4546, Radio Frequency (RF) Interface Management Information Base for Data over Cable Service Interface Specifications (DOCSIS) 2.0 Compliant RF Interfaces, IETF, June 2006.
[RFC4632] RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan, IETF, 2006.
[RFC4719] RFC 4719, Transport of Ethernet Frames over Layer 2 Tunneling Protocol Version 3 (L2TPv3), IETF, November 2006.
[RFC4835] RFC 4835, Cryptographic Algorithm Implementation Requirements for Encapsulating Security Payload (ESP) and Authentication Header (AH), IETF, 2007.
[RFC4861] RFC 4861, Neighbor Discovery for IP version 6 (IPv6), IETF, 2007.
[RFC4862] RFC 4862, IPv6 Stateless Address Autoconfiguration, IETF, 2007.
[RFC4868] RFC 4868, Using HMAC-SHA-256, HMAC-SHA-384, and HMAC-SHA-512 with IPsec, IETF, 2007.
[RFC5072] RFC 5072, IP Version 6 over PPP, IETF, 2007.
[RFC5139] RFC 5139, Revised Civic Location Format For Presence Information Data Format Location Object (PIDF-LO), IETF, February 2008.
[RFC5280] RFC 5280, Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile, IETF, May 2008.
[RFC5491] RFC 5491, GEOPRIV Presence Information Data Format Location Object (PIDF-LO) Usage Clarification, Considerations, and Recommendations, IETF, March 2009.
[RFC5625] RFC 5625, DNS Proxy Implementation Guidelines, IETF, 2009.
[RFC5969] RFC 5969, IPv6 Rapid Deployment on IPv4 Infrastructures (6rd) - Protocol Specification, IETF, 2010.
[RFC5996] RFC 5996, Internet Key Exchange Protocol Version 2 (IKEv2), IETF, September 2010.
[RFC6106] RFC 6106, IPv6 Router Advertisement Option for DNS Configuration, IETF, 2010.
[RFC6120] RFC 6120, Extensible Messaging and Presence Protocol (XMPP) : Core, IETF, 2011.
[RFC6234] RFC 6234, US Secure Hash Algorithms (SHA and SHA-based HMAC and HKDF), IETF, May, 2011.
[RFC6455] RFC 6455, The WebSocket Protocol, IETF, December 2011.
[RFC6762] RFC 6762, Multicast DNS, IETF, February 2013.
[RFC6838] RFC 6838, Media Type Specifications and Registration Procedures, IETF, January 2013.
[RFC6887] RFC 6887, Port Control Protocol (PCP), IETF, 2013.
[RFC6970] RFC 6970, Universal Plug and Play (UPnP) Internet Gateway Device (IGD) - Port Control Protocol (PCP) Interworking Function, IETF, 2013.
[RFC7159] RFC7159, The JavaScript Object Notation (JSON) Data Interchange Format, IETF, March 2014.
[RFC7230] RFC 7230, Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing, IETF, June 2014.
[RFC7252] RFC 7252, The Constrained Application Protocol (CoAP), IETF, June 2014.
[RFC7291] RFC 7291, DHCP Options for the Port Control Protocol (PCP), IETF, 2014.
[RFC7348] RFC 7348, Virtual eXtensible Local Area Network (VXLAN), IETF, August 2014.
[RFC7395] RFC 7395, An Extensible Messaging and Presence Protocol (XMPP) Subprotocol for WebSocket, IETF, October 2014.
[RFC7398] RFC 7398, A Reference Path and Measurement Points for Large-Scale Measurement of Broadband Performance, IETF, February 2015.
[RFC7468] RFC 7468, Textual Encoding of PKIX, PKCS, and CMS Structures, IETF, April 2015.
[RFC7594] RFC 7594, A Framework for Large-Scale Measurement of Broadband Performance (LMAP), IETF, September 2015.
[RFC7597] RFC 7597, Mapping of Address and Port with Encapsulation (MAP), IETF, July 2015.
[RFC7598] RFC 7598, DHCPv6 Options for configuration of Softwire Address and Port Mapped Clients, IETF, July 2015.
[RFC7599] RFC 7599, Mapping of Address and Port using Translation (MAP-T), IETF, July 2015.
[RFC7693] RFC 7693, The BLAKE2 Cryptographic Hash and Message Authentication Code (MAC), IETF, November 2015.
[RFC8325] RFC 8325, Mapping Diffserv to IEEE 802.11, IETF, February 2018.
[RFC8966] RFC 8966, The Babel Routing Protocol, IETF, January 2021.
[RFC8967] RFC 8967, MAC Authentication for the Babel Routing Protocol, IETF, January 2021.
[RFC8968] RFC 8968, Babel Routing Protocol over Datagram Transport Layer Security, IETF, January 2021.
[RFC9046] RFC 9046, Babel Information Model, IETF, June 2021.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[STOMP1.2] STOMP Protocol Specification, STOMP Protocol Specification, Version 1.2.
[TR-064] TR-064 Corrigendum 1, LAN-Side DSL CPE Configuration Specification, Broadband Forum, August 2015.
[TR-069] TR-069 Amendment 6, CPE WAN Management Protocol, Broadband Forum, April 2018.
[TR-106] TR-106 Amendment 8, Data Model Template for CWMP Endpoints and USP Agents, Broadband Forum, May 2018.
[TR-124i5] TR-124 Issue 5, Functional Requirements for Broadband Residential Gateway Devices, Broadband Forum, July 2016.
[TR-124i6] TR-124 Issue 6, Functional Requirements for Broadband Residential Gateway Devices, Broadband Forum, July 2020.
[TR-143] TR-143 Amendment 3, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, May 2017.
[TR-159] TR-159, Management Framework for xDSL Bonding, Broadband Forum, December 2008.
[TR-181i2] TR-181 Issue 2 Amendment 13, Device Data Model, Broadband Forum, September 2019.
[TR-232] TR-232, Bulk Data Collection, Broadband Forum, May 2012.
[TR-262] TR-262, Femto Component Objects, Broadband Forum, November 2011.
[TR-304] TR-304, Broadband Access Service Attributes and Performance Metrics, Broadband Forum, February 2015.
[TR-369] TR-369 Issue 1 Corrigendum 2, User Services Platform, Broadband Forum, November 2018.
[TR-390] TR-390, Performance Measurement from Customer Equipment to IP Edge, Broadband Forum, May 2017.
[TR-471] TR-471, Maximum IP-Layer Capacity Metric, Related Metrics, and Measurements, Broadband Forum, December 2021.
[UPA-PLC] Universal Powerline Association, UPA.
[UPnP-DAv1] UPnP Device Architecture, UPnP Device Architecture 1.0, UPnP Forum, April 2008.
[UPnP-DAv11] UPnP Device Architecture 1.1, UPnP Device Architecture 1.1, UPnP Forum, October, 2008.
[UPnP-DM:1] UPnP Device Management:1, UPnP Device Management v1.
[UPnP-IGD:1] UPnP InternetGatewayDevice:1, InternetGatewayDevice:1 Device Template Version 1.01, UPnP, 2001.
[UPnP-IGD:2] UPnP InternetGatewayDevice:2, InternetGatewayDevice:2 Device Template Version 1.01, UPnP, 2010.
[USB1.0] USB 1.0, USB 1.0 Specification, USB-IF, January 1996.
[USB2.0] USB 2.0, USB 2.0 Specification, USB-IF, April 2000.
[USB3.0] USB 3.0, USB 3.0 Specification, USB-IF, November 2008.
[WMM] Wi-Fi Multimedia Technical Specification, Wi-Fi Multimedia Technical Specification, Wi-Fi Alliance, May 2012.
[WPS 2.0] WSC 2.0, Wi-Fi Simple Configuration Technical Specification Version 2.0.x, Wi-Fi Alliance.
[WPSv1.0] Wi-Fi Protected Setup Specification Version 1.0h, Wi-Fi Alliance, 2006.
[Z-Wave] Z-Wave, Z-Wave website.
[ZigBee] ZigBee, ZigBee Alliance website.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

Legend

Object definition.
Mountable Object definition.
Mount Point definition.
Parameter definition.
Command or Event definition.
Command Input / Output Arguments container.
Command or Event Object Input / Output Argument definition.
Command or Event Parameter Input / Output Argument definition.

Device:2.15 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 2.15, then it will indicate support for version 2.15. The version number associated with each object and parameter is shown in the Version column.

Name Type Syntax Write Description Object Default Version Spec
Device. object object​[1:1] - The top-level object for a Device. - 2.0 TR-181i2a14
RootDataModelVersion string​(32) string​(32) -

Root data model version, e.g. 2.4. For a vendor-defined root data model, this is the standard Broadband Forum model on which the vendor-defined model is based. Possible patterns:

- 2.4 TR-181i2a14
InterfaceStackNumberOfEntries unsignedInt unsignedInt - The number of entries in the InterfaceStack table. - 2.0 TR-181i2a14
Device.​Services. object object​[1:1] - This object contains general services information. - 2.0 TR-181i2a14
Device.​DeviceInfo. object object​[1:1] - This object contains general device information. - 2.0 TR-181i2a15
DeviceCategory string​[] list of string -

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

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

- 2.8 TR-181i2a15
Manufacturer string​(64) string​(64) - The manufacturer of the CPE (human readable string). - 2.0 TR-181i2a15
ManufacturerOUI string​(6:6) string​(6:6) -

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

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

This value MUST remain fixed over the lifetime of the device, including across firmware updates.

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

- 2.0 TR-181i2a15
TR-181i2a15c1
SupportedDataModelNumberOfEntries unsignedInt unsignedInt - The number of entries in the SupportedDataModel table. - 2.0 TR-181i2a15c1
ModelName string​(64) string​(64) - Model name of the CPE (human readable string). - 2.0 TR-181i2a15
ModelNumber string​(64) string​(64) -

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

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

- 2.8 TR-181i2a15
Description string​(256) string​(256) - A full description of the CPE device (human readable string). - 2.0 TR-181i2a15
ProductClass string​(64) string​(64) -

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

This value MUST remain fixed over the lifetime of the device, including across firmware updates.

- 2.0 TR-181i2a15
SerialNumber string​(64) string​(64) -

Identifier of the particular device that is unique for the indicated class of product and manufacturer.

This value MUST remain fixed over the lifetime of the device, including across firmware updates.

- 2.0 TR-181i2a15
HardwareVersion string​(64) string​(64) - A string identifying the particular CPE model and version. - 2.0 TR-181i2a15
SoftwareVersion string​(64) string​(64) -

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 TR-181i2a15
ActiveFirmwareImage string string - A full path reference to the row in the FirmwareImage table representing the currently running firmware image. - 2.12 TR-181i2a15
BootFirmwareImage string string W

A full path reference to the row in the FirmwareImage table of the firmware image that is to be loaded the next time the device boots.

This parameter value cannot be empty and must point to a valid and enabled FirmwareImage object where the (FirmwareImage.{i}.Available parameter is set to 'true'). Out of the factory, this parameter should be set to point to the firmware image the CPE will attempt to boot when first powered on.

The firmware image instance referenced by this parameter must also have an Available parameter value of 'true'. Attempting to set this parameter to point to a non-enabled firmware image MUST result in the CPE responding with a CWMP fault (9007).

In situations where the CPE cannot boot the firmware image specified by this parameter and manages to boot a different firmware image, the CPE MUST NOT modify this value to point to the alternate firmware image that is currently active.

- 2.12 TR-181i2a15
AdditionalHardwareVersion string​(64)​[] list​(64) of string - Comma-separated list (maximum number of characters 64) of strings. Each entry is an additional version. Represents any additional hardware version information the vendor might wish to supply. - 2.0 TR-181i2a15
AdditionalSoftwareVersion string​(64)​[] list​(64) of string - Comma-separated list (maximum number of characters 64) of strings. Each entry is an additional version. Represents any additional software version information the vendor might wish to supply. - 2.0 TR-181i2a15
ProvisioningCode string​(64) 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 TR-181i2a15
UpTime unsignedInt unsignedInt - Time in seconds since the CPE was last restarted. - 2.0 TR-181i2a15
FirstUseDate dateTime dateTime -

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

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

- 2.0 TR-181i2a15
FirmwareImageNumberOfEntries unsignedInt unsignedInt - The number of entries in the FirmwareImage table. - 2.12 TR-181i2a15
VendorConfigFileNumberOfEntries unsignedInt unsignedInt - The number of entries in the VendorConfigFile table. - 2.0 TR-181i2a15
ProcessorNumberOfEntries unsignedInt unsignedInt - The number of entries in the Processor table. - 2.1 TR-181i2a15
VendorLogFileNumberOfEntries unsignedInt unsignedInt - The number of entries in the VendorLogFile table. - 2.1 TR-181i2a15
LocationNumberOfEntries unsignedInt unsignedInt - The number of entries in the Location table. - 2.4 TR-181i2a15
DeviceImageNumberOfEntries unsignedInt unsignedInt - The number of entries in the DeviceImageFile table. - 2.11 TR-181i2a15
Device.​DeviceInfo.​VendorConfigFile.​{i}. object​[0:] object​[0:∞] -

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 Controller 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 TR-181i2a15
Alias string​(64) Alias W

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

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

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

Name of the vendor configuration file.

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

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

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

- 2.0 TR-181i2a15
Version string​(16) string​(16) -

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

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

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

- 2.0 TR-181i2a15
Date dateTime dateTime - Date and time when the content of the current version of this vendor configuration file was first applied by the CPE. - 2.0 TR-181i2a15
Description string​(256) string​(256) - A description of the vendor configuration file (human-readable string). - 2.0 TR-181i2a15
UseForBackupRestore boolean boolean -

When true, this parameter indicates that this VendorConfigFile instance is to be used for backup and restoration purposes.

Note: The backup and restore operations may require the use of multiple VendorConfigFile instances. In this scenario the mechanism for detemining the order and combination of VendorConfigFile instances used for backup and restoration purposes is implementation specific.

- 2.7 TR-181i2a15
Device.​DeviceInfo.​MemoryStatus. object object​[1:1] - Status of the device's physical memory. - 2.0 TR-181i2a15
Total unsignedInt unsignedInt - The total physical volatile RAM, in KiB, installed on the device. - 2.0 TR-181i2a15
Free unsignedInt unsignedInt - The free physical volatile RAM, in KiB, currently available on the device. - 2.0 TR-181i2a15
TotalPersistent unsignedInt unsignedInt - The sum total physical Non-Volatile Memory (NVM), in KiB, installed on the device. This memory persists across reboots and can be used by the system, applications, or users. - 2.15 TR-181i2a15
FreePersistent unsignedInt unsignedInt - The sum total free physical Non-Volatile Memory (NVM), in KiB, currently available on the device. This memory persists across reboots and is available for use by the system, applications, or users. - 2.15 TR-181i2a15
Device.​DeviceInfo.​ProcessStatus. object object​[1:1] - Status of the processes on the device. - 2.0 TR-181i2a15
CPUUsage unsignedInt​(:100) unsignedInt​(:100) - The total amount of the CPU, in percent, rounded up to the nearest whole percent. In the case that multiple CPU are present, this value represents the average of all CPU. - 2.0 TR-181i2a15
ProcessNumberOfEntries unsignedInt unsignedInt -

The number of entries in the Process table.

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

- 2.0 TR-181i2a15
TR-181i2a15c1
Device.​DeviceInfo.​ProcessStatus.​Process.​{i}. object​[0:] object​[0:∞] -

List of all processes running on the device.

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

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

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

- 2.0 TR-181i2a15
Device.​DeviceInfo.​SupportedDataModel.​{i}. object​[0:] object​[0:∞] -

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

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

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

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

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

- 2.0 TR-181i2a15c1
Alias string​(64) Alias W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.3 TR-181i2a15c1
URL string​(2048) URL -

The [URL] that describes some or all of the device's currently Supported Data Model.

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

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

The XML file referenced by this URL MUST NOT change while the CPE is running, and SHOULD NOT change across a CPE reboot. Note that UUID is a unique key, so the XML file referenced by this URL will never change.

The XML file MAY be located within the CPE. In this scenario the CPE MAY use the value of "localhost" as URL host portion, When the "localhost" value is used, the ACS has the responsibility to substitute the "localhost" value with the host portion of the connection request URL.

Behavior in the event of an invalid URL, failure to access the referenced XML file, or an invalid XML file, is implementation-dependent.

- 2.0 TR-181i2a15c1
UUID string​(36:36) UUID - [UUID] UUID ([RFC4122]) that is the value of the uuid attribute in the DT Instance referenced by URL. - 2.6 TR-181i2a15c1
URN string​(256) string​(256) -

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

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

- 2.0 TR-181i2a15c1
Features string​[] list of string -

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

For example, if the DT instance specified the following:

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

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

- 2.0 TR-181i2a15c1
Device.​DeviceInfo.​ProxierInfo. object object​[1:1] - Represents the associated CPE Proxier for a Proxied Device that utilizes the Virtual CWMP Device Mechanism [Annex J.2/TR-069]. - 2.3 TR-181i2a15c1
ManufacturerOUI string​(6:6) string​(6:6) -

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

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

- 2.3 TR-181i2a15c1
ProductClass string​(64) string​(64) -

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

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

- 2.3 TR-181i2a15c1
SerialNumber string​(64) string​(64) - Serial number of the associated CPE Proxier. - 2.3 TR-181i2a15c1
ProxyProtocol string string -

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

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

- 2.3 TR-181i2a15c1
Device.​DeviceInfo.​TemperatureStatus. object object​[1:1] - Status of the temperature of the device. - 2.0 TR-181i2a15
TemperatureSensorNumberOfEntries unsignedInt unsignedInt - The number of entries in the TemperatureSensor table. - 2.0 TR-181i2a15
Device.​DeviceInfo.​TemperatureStatus.​TemperatureSensor.​{i}. object​[0:] object​[0:∞] -

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

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

- 2.0 TR-181i2a15
Alias string​(64) Alias W

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

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

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

The status of this temperature sensor. Enumeration of:

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

When set to true, resets the temperature sensor.

The value of this parameter is not part of the device configuration and is always false when read.

- 2.0 TR-181i2a15c1
ResetTime dateTime dateTime -

The time at which this temperature sensor was reset.

Reset can be caused by:

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

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

- 2.0 TR-181i2a15
Name string​(256) string​(256) - Name of this temperature sensor. This text MUST be sufficient to distinguish this temperature sensor from other temperature sensors. - 2.0 TR-181i2a15
Value int​(-274:) int​(-274:) -

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

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

- 2.0 TR-181i2a15
LastUpdate dateTime dateTime -

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

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

- 2.0 TR-181i2a15
MinValue int​(-274:) int​(-274:) -

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

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

- 2.0 TR-181i2a15
MinTime dateTime dateTime -

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

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

- 2.0 TR-181i2a15
MaxValue int​(-274:) int​(-274:) -

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

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

- 2.0 TR-181i2a15
MaxTime dateTime dateTime -

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

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

- 2.0 TR-181i2a15
LowAlarmValue int​(-274:) int​(-274:) W

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

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

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

- 2.0 TR-181i2a15
LowAlarmTime dateTime dateTime -

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

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

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

- 2.0 TR-181i2a15
HighAlarmValue int​(-274:) int​(-274:) W

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

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

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

- 2.0 TR-181i2a15
PollingInterval unsignedInt unsignedInt W

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

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

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

- 2.1 TR-181i2a15
HighAlarmTime dateTime dateTime -

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

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

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

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

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

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

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

- 2.0 TR-181i2a15
Device.​DeviceInfo.​Processor.​{i}. object​[0:] object​[0:∞] -

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

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

- 2.1 TR-181i2a15
Alias string​(64) Alias W

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

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

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

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

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

- 2.1 TR-181i2a15
Device.​DeviceInfo.​VendorLogFile.​{i}. object​[0:] object​[0:∞] -

Each table entry represents a Vendor Log File.

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

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

- 2.1 TR-181i2a15
Alias string​(64) Alias W

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

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

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

Name of the log file.

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

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

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

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

- 2.1 TR-181i2a15
Device.​DeviceInfo.​Location.​{i}. object​[0:] object​[0:∞] W

This object contains Location information.

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

- 2.4 TR-181i2a15
Source string string -

Identifies the source of the location data. Enumeration of:

"External" 2.4 TR-181i2a15
AcquiredTime dateTime dateTime - The time when the location was acquired. - 2.4 TR-181i2a15
ExternalSource string string -

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

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

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

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

- 2.4 TR-181i2a15
ExternalProtocol string string -

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

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

"CWMP" 2.4 TR-181i2a15
DataObject string​(1200) string​(1200) W

The currently valid location information.

Writable only when ExternalProtocol has a value of CWMP or USP.

If obtained through the local GPS/AGPS then the location information is formatted according to [RFC5491].

If manually configured then location information will be XML-formatted according to [RFC5491] (geographical information) and [RFC5139] (civic addresses).

If obtained by an external source this is the location information as received.

If it's an XML document (e.g. CWMP, OMA-DM, UPnP, HELD, MLP) the location information will be represented as-is, otherwise it will be converted to base64.

CWMP or USP configured location information will be XML-formatted according to [RFC5491] (geographical information) and [RFC5139] (civic addresses).

Only zero or one Location object instance with value CWMP or USP MUST exist at any given time.

- 2.4 TR-181i2a15
Device.​DeviceInfo.​DeviceImageFile.​{i}. object​[0:] object​[0:∞] -

This object describes an image of the device.

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

- 2.11 TR-181i2a15
Alias string​(64) Alias W

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

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

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

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

- 2.11 TR-181i2a15
Image base64 base64 - The device image in PNG, JPEG or GIF format. - 2.11 TR-181i2a15
Device.​DeviceInfo.​FirmwareImage.​{i}. object​[0:] object​[0:∞] -

Top-level object for mapping firmware images.

This is a static table – the number of object instances in this table is defined by the firmware that is currently running.

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

- 2.12 TR-181i2a15
Alias string​(64) Alias W

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

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

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

Firmware/software image name. Descriptive text of the image or filename.

The value of Name is an empty string if Status is anything other than Active, Available, InstallationFailed, or ActivationFailed.

- 2.12 TR-181i2a15
Version string​(64) string​(64) -

A string identifying the version of the firmware image represented by this FirmwareImage. Whenever this firmware image is active (ie, the device has booted this firmware image), the value of the DeviceInfo.SoftwareVersion parameter MUST be the same as the value contained in this parameter.

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

The value of Version is an empty string if Status is anything other than Available, InstallationFailed, or ActivationFailed.

- 2.12 TR-181i2a15
Available boolean boolean W

Specifies whether or not this particular firmware image can be used by the Agent. An Agent will only attempt to boot this particular firmware image if this parameter value is set to true.

This value MUST be set to true by the device whenever a new firmware image is installed.

This value cannot be set to false if the firmware image is active or is referenced by the BootFirmwareImage parameter.

Firmware image instances cannot be deleted, so a Controller MAY use this parameter to subsequently mark a particular firmware as being invalid, which will prevent the Agent from attempting to boot it.

- 2.12 TR-181i2a15
Status string string -

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

  • NoImage (This Firmware Image instance is empty. This value could happen on an Agent that supports multiple firmware images, but only has a single image installed)
  • Active (This Firmware Image instance is the currently active image, added in v2.14)
  • Downloading (This Firmware Image instance is being downloaded)
  • Validating (This Firmware Image instance has been downloaded, and is in the process of being validated)
  • Available (This Firmware Image instance has been downloaded, validated, and installed, and is ready to be activated)
  • DownloadFailed (The Agent has attempted to download this Firmware Image instance, but ultimately failed while retrieving it from the source URL)
  • ValidationFailed (The Agent has attempted to validate a Firmware Image downloaded to this instance, but ultimately failed while validating it)
  • InstallationFailed (The Agent has attempted to install a Firmware Image downloaded and validated to this instance, but ultimately failed while installing it)
  • ActivationFailed (The Agent has attempted to active this Firmware Image instance, but ultimately failed while being activated)
- 2.12 TR-181i2a15
BootFailureLog string string -

If the Agent is unable to boot into this firmware image, when specified, the Agent can use this parameter to record some information as to why the boot failed.

If the Agent successfully boots into this firmware, the value of this parameter SHOULD be an empty string. When a new firmware image is installed into this object instance, this parameter MUST be cleared.

The length of this string is defined as implementation-specific by the Agent.

- 2.12 TR-181i2a15
Device.​ManagementServer. object object​[1:1] - This object contains parameters relating to the CPE's association with an ACS. - 2.0 TR-181i2a15c1
EnableCWMP boolean 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 TR-181i2a15
URL string​(2048) URL W

The [URL] 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 TR-181i2a15c1
Username string​(256) 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 TR-181i2a15c1
Password string​(256) 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 TR-181i2a15c1
ScheduleReboot dateTime dateTime W

An absolute date and time in UTC at which time the CPE will perform a reboot.

If a CWMP session is in progress at the specified time, the CPE MUST wait until the session has ended before performing the reboot.

If the value specifies a date and time that has already passed (i.e., a past date and time), no reboot will be performed.

- 2.10 TR-181i2a15c1
DelayReboot int​(-1:) int​(-1:) W

The number of seconds from the time the CWMP session in which this parameter value is set is ended until the CPE performs a reboot.

Whenever the CPE reboots, this value MUST be reset by the CPE to -1.

- 2.10 TR-181i2a15c1
PeriodicInformEnable boolean boolean W Whether or not the CPE MUST periodically send CPE information to the ACS using the Inform method call. - 2.0 TR-181i2a15c1
PeriodicInformInterval unsignedInt​(1:) unsignedInt​(1:) W The duration in seconds of the interval for which the CPE MUST attempt to connect with the ACS and call the Inform method if PeriodicInformEnable is true. - 2.0 TR-181i2a15c1
PeriodicInformTime dateTime dateTime W

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

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

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

The Unknown Time value defined in [Section 3.2/TR-106] 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 TR-181i2a15c1
ParameterKey string​(32) string​(32) -

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

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

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

- 2.0 TR-181i2a15c1
ConnectionRequestURL string​(2048) URL -

The HTTP [URL] for an ACS to make a Connection Request notification to the CPE.

In the form:

http://host:port/path

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

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

- 2.0 TR-181i2a15c1
ConnectionRequestUsername string​(256) string​(256) W Username used to authenticate an ACS making a Connection Request to the CPE. - 2.0 TR-181i2a15c1
ConnectionRequestPassword string​(256) 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 TR-181i2a15c1
UpgradesManaged boolean 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 TR-181i2a15c1
KickURL string​(2048) URL -

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

LAN-accessible [URL] 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 TR-181i2a15c1
DownloadProgressURL string​(2048) URL -

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

LAN-accessible [URL] 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 TR-181i2a15c1
DefaultActiveNotificationThrottle unsignedInt unsignedInt W

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

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

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

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

- 2.0 TR-181i2a15c1
CWMPRetryMinimumWaitInterval unsignedInt​(1:65535) unsignedInt​(1:65535) W

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

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

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 TR-181i2a15c1
CWMPRetryIntervalMultiplier unsignedInt​(1000:65535) unsignedInt​(1000:65535) W

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

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

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 TR-181i2a15c1
HTTPConnectionRequestEnable boolean boolean W

Enables or disables HTTP connection request handling on the CPE.

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

The factory default value MUST be true.

- 2.11 TR-181i2a15c1
UDPConnectionRequestAddress string​(256) string​(256) -

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

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

host:port
host

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

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

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

- 2.0 TR-181i2a15c1
STUNEnable boolean 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 TR-181i2a15c1
STUNServerAddress string​(256) 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 TR-181i2a15c1
STUNServerPort unsignedInt​(0:65535) unsignedInt​(0:65535) W

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

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

- 2.0 TR-181i2a15c1
STUNUsername string​(256) 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 TR-181i2a15c1
STUNPassword string​(256) 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 TR-181i2a15c1
STUNMaximumKeepAlivePeriod int​(-1:) 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 TR-181i2a15c1
STUNMinimumKeepAlivePeriod unsignedInt unsignedInt W If STUN Is enabled, the minimum period, in seconds, that STUN Binding Requests can be sent by the CPE for the purpose of maintaining the binding in the Gateway. This limit applies only to Binding Requests sent from the UDP Connection Request address and port, and only those that do not contain the BINDING-CHANGE attribute. This limit does not apply to retransmissions following the procedures defined in [RFC3489]. - 2.0 TR-181i2a15c1
NATDetected boolean boolean -

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

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

When STUNEnable is false, this value MUST be false.

- 2.0 TR-181i2a15c1
AliasBasedAddressing boolean boolean -

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

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

- 2.3 TR-181i2a15c1
InstanceMode string string W

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

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

The factory default value MUST be InstanceNumber.

- 2.3 TR-181i2a15c1
AutoCreateInstances boolean boolean W

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

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

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

The factory default value MUST be false.

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

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

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

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

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

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

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

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

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

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

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

- 2.7 TR-181i2a15c1
ConnReqJabberID string string -

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

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

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

- 2.7 TR-181i2a15c1
HTTPCompressionSupported string​[] list of string -

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

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

- 2.7 TR-181i2a15c1
HTTPCompression string string W

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

The factory default value MUST be Disabled.

- 2.7 TR-181i2a15c1
LightweightNotificationProtocolsSupported string​[] list of string -

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

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

- 2.7 TR-181i2a15c1
LightweightNotificationProtocolsUsed string​[] list of string W

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

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

- 2.7 TR-181i2a15c1
LightweightNotificationTriggerInterval unsignedInt​(0:) unsignedInt​(0:) W

The duration in seconds of the interval for which the CPE MUST attempt to deliver any pending Passive Lightweight Notifications.

A value of 0 means that the trigger interval is effectively disabled. In this case pending Passive Lightweight Notifications are only sent when triggered by an Active Lightweight Notification.

- 2.12 TR-181i2a15c1
LightweightNotificationTriggerTime dateTime dateTime W

An absolute time reference in UTC to determine when the CPE will initiate the Lightweight Notification (in the case that there are pending Passive Lightweight Notifications that need to be delivered). Each Passive Lightweight Notification (that is waiting for the Lightweight Notification Trigger mechanism for delivery) MUST occur at this reference time plus or minus an integer multiple of the LightweightNotificationTriggerInterval. LightweightNotificationTriggerTime is used only to set the phase of the Passive Lightweight Notification. The actual value of LightweightNotificationTriggerTime can be arbitrarily far into the past or future.

For example, if LightweightNotificationTriggerInterval is 86400 (a day) and if LightweightNotificationTriggerTime is set to UTC midnight on some day (in the past, present, or future) then Lightweight Notifications for pending Passive Lightweight Notifications will occur every day at UTC midnight. These MUST begin on the very next midnight, even if LightweightNotificationTriggerTime refers to a day in the future. The Unknown Time value defined in [Section 3.2/TR-106] indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and needs only to adhere to the specified LightweightNotificationTriggerInterval. If absolute time is not available to the CPE, its Lightweight Notifications behavior MUST be the same as if the LightweightNotificationTriggerTime parameter was set to the Unknown Time value.

- 2.12 TR-181i2a15c1
UDPLightweightNotificationHost string​(256) string​(256) W

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

UDPLightweightNotificationHost is only applicable when LightweightNotificationProtocolsUsed contains the UDP enumeration.

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

- 2.7 TR-181i2a15c1
UDPLightweightNotificationPort unsignedInt unsignedInt W

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

UDPLightweightNotificationPort is only applicable when LightweightNotificationProtocolsUsed contains the UDP enumeration.

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

- 2.7 TR-181i2a15c1
InstanceWildcardsSupported boolean boolean -

Indicates whether or not instance wildcards are supported.

A true value indicates that the CPE supports instance wildcards for GPV, GPN and GPA RPC calls, as defined in [TR-069].

- 2.12 TR-181i2a15c1
InformParameterNumberOfEntries unsignedInt unsignedInt - The number of entries in the InformParameter table. - 2.8 TR-181i2a15c1
Device.​ManagementServer.​ManageableDevice.​{i}. object​[0:] object​[0:∞] -

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

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

- 2.0 TR-181i2a15c1
Alias string​(64) string​(64) W
A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object.
This parameter was DEPRECATED in 2.11 because ManageableDevice is a transient object.
This parameter was OBSOLETED in 2.14.
This parameter was DELETED in 2.15.
- 2.0 TR-181i2a15c1
ManufacturerOUI string​(6:6) string​(6:6) -

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

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

- 2.0 TR-181i2a15c1
SerialNumber string​(64) string​(64) - Serial number of the Device as provided to the Gateway by the Device. - 2.0 TR-181i2a15c1
ProductClass string​(64) string​(64) -

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

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

- 2.0 TR-181i2a15c1
Host string​(1024)​[] list​(1024) of string -

Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of a row in the Hosts.Host table. If the referenced object is deleted, the corresponding item MUST be removed from the list. References all the Hosts.Host table entries, whether active or inactive, that correspond to this physical LAN device. There can be multiple such entries if the device has more than one network interface.

For example: Device.Hosts.Host.1,Device.Hosts.Host.5

- 2.0 TR-181i2a15c1
Device.​ManagementServer.​AutonomousTransferCompletePolicy. object object​[1:1] -

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

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 TR-181i2a15c1
Enable boolean boolean W Enable/disable CPE notification of AUTONOMOUS TRANSFER COMPLETE events to the ACS. - 2.0 TR-181i2a15c1
TransferTypeFilter string string W

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

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

- 2.0 TR-181i2a15c1
ResultTypeFilter string 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 TR-181i2a15c1
FileTypeFilter string​(1024)​[] list​(1024) of string W

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

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 TR-181i2a15c1
Device.​ManagementServer.​DownloadAvailability. object object​[1:1] - This object contains multicast announcement and query parameters used for the purpose of downloading files. - 2.0 TR-181i2a15c1
Device.​ManagementServer.​DownloadAvailability.​Announcement. object object​[1:1] - This object contains multicast announcement parameters used to download files. - 2.0 TR-181i2a15c1
Enable boolean boolean W Enable/disable CPE ability to receive and use multicast announcements from a server for the purpose of downloading files. - 2.0 TR-181i2a15c1
Status string string -

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 TR-181i2a15c1
GroupNumberOfEntries unsignedInt unsignedInt - The number of entries in the Group table. - 2.0 TR-181i2a15c1
Device.​ManagementServer.​DownloadAvailability.​Announcement.​Group.​{i}. object​[0:] object​[0:∞] W

Multicast groups to which the CPE SHOULD listen for announcements.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias.

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

- 2.0 TR-181i2a15c1
Alias string​(64) Alias W

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

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

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

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

- 2.3 TR-181i2a15c1
Enable boolean boolean W Enable/disable listening to this multicast group. false 2.0 TR-181i2a15c1
Status string string -

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 TR-181i2a15c1
URL string​(2048) URL W

The [URL] 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 TR-181i2a15c1
Device.​ManagementServer.​DownloadAvailability.​Query. object object​[1:1] - This object contains multicast query parameters used to download files. - 2.0 TR-181i2a15c1
Enable boolean boolean W Enable/disable CPE ability to autonomously query a server for the purpose of downloading files. - 2.0 TR-181i2a15c1
Status string string -

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 TR-181i2a15c1
URL string​(2048) URL W

The [URL] 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 TR-181i2a15c1
Device.​ManagementServer.​DUStateChangeComplPolicy. object object​[1:1] -

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

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

- 2.1 TR-181i2a15c1
Enable boolean boolean W Enables/Disables CPE notification of "12 AUTONOMOUS DU STATE CHANGE COMPLETE" events to the ACS. - 2.1 TR-181i2a15c1
OperationTypeFilter string​[] list of string W

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

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

- 2.1 TR-181i2a15c1
ResultTypeFilter string string W

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

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

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

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

- 2.1 TR-181i2a15c1
Device.​ManagementServer.​EmbeddedDevice.​{i}. object​[0:] object​[0:∞] -

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

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

- 2.3 TR-181i2a15c1
ControllerID string​(256) string​(256) -

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

An empty string indicates that this Proxied Device either:

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

Idenitfier of the Proxied Device.

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

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

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

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

- 2.3 TR-181i2a15c1
ProxyProtocolReference string string - The value MUST be the Path Name of a protocol object that uses the ProxyProtocol. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.6 TR-181i2a15c1
DiscoveryProtocol string​[] list of string -

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

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

- 2.6 TR-181i2a15c1
DiscoveryProtocolReference string​[] list of string -

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

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

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

- 2.6 TR-181i2a15c1
CommandProcessed string string -

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

- 2.3 TR-181i2a15c1
CommandProcessingErrMsg string​(1024) string​(1024) - Detailed CommandProcessed error description (vendor specific). - 2.3 TR-181i2a15c1
LastSyncTime dateTime dateTime -

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

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

- 2.3 TR-181i2a15c1
Device.​ManagementServer.​VirtualDevice.​{i}. object​[0:] object​[0:∞] -

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

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

- 2.3 TR-181i2a15c1
ManufacturerOUI string​(6:6) string​(6:6) -

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

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

- 2.3 TR-181i2a15c1
ProductClass string​(64) string​(64) - Identifier of the class of product of the associated Proxied Device for which the serial number applies. - 2.3 TR-181i2a15c1
SerialNumber string​(64) string​(64) - Serial number of the associated Proxied Device. - 2.3 TR-181i2a15c1
Host string​[:32] list​[:32] of string - Comma-separated list (up to 32 items) of strings. Each list item MUST be the Path Name of a row in the Hosts.Host table. If the referenced object is deleted, the corresponding item MUST be removed from the list. References all the Hosts.Host table entries, whether active or inactive, that correspond to this proxied LAN device. There can be multiple such entries if the Proxied Device has more than one network interface. - 2.3 TR-181i2a15c1
ProxyProtocol string string -

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

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

- 2.3 TR-181i2a15c1
ProxyProtocolReference string string - The value MUST be the Path Name of a protocol object that uses the ProxyProtocol. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.6 TR-181i2a15c1
DiscoveryProtocol string​[] list of string -

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

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

- 2.6 TR-181i2a15c1
DiscoveryProtocolReference string​[] list of string -

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

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

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

- 2.6 TR-181i2a15c1
Device.​ManagementServer.​StandbyPolicy. object object​[1:1] -

Parameters related to CPE behavior when waking up from standby. If this object is supported then the CPE MUST support the requirements of [Annex L/TR-069].

NOTE: "CR", as used in the names and descriptions of the parameters defined in this object, refers to the Connection Request concept defined in TR-069.

- 2.7 TR-181i2a15c1
CRUnawarenessMaxDuration int​(-1:) int​(-1:) W

When waking up from a non CR-Aware Standby that lasted more than this parameter's value (in seconds), the CPE MUST issue a WAKEUP Event.

If the value is -1, the CPE MUST NOT ever issue WAKEUP Events for having been non CR-aware.

The factory default value MUST be -1.

- 2.7 TR-181i2a15c1
MaxMissedPeriodic int​(-1:) int​(-1:) W

When waking up from a non fully Timer-Aware Standby that made it miss more than this parameter's value Periodic Contacts, the CPE MUST issue a WAKEUP Event.

If the value is -1, the CPE MUST NOT ever issue WAKEUP Events for exceeding that limit.

The factory default value MUST be -1.

- 2.7 TR-181i2a15c1
NotifyMissedScheduled boolean boolean W

When waking up from a non fully Timer-Aware Standby that made it miss at least one Scheduled Contact, the CPE MUST issue a WAKEUP Event if this parameter is true.

The factory default value MUST be false.

- 2.7 TR-181i2a15c1
NetworkAwarenessCapable boolean boolean - Indicates that the CPE is capable of CR-Aware Standby. - 2.7 TR-181i2a15c1
SelfTimerCapable boolean boolean - Indicates that the CPE is capable of Timer-Aware Standby. - 2.7 TR-181i2a15c1
CRAwarenessRequested boolean boolean W

If NetworkAwarenessCapable and this parameter are both true, the CPE MUST NOT go into a non CR-Aware Standby state.

The factory default value MUST be false.

- 2.7 TR-181i2a15c1
PeriodicAwarenessRequested boolean boolean W

If SelfTimerCapable and this parameter are both true, the CPE MUST NOT go into a standby state that prevents it from honoring Periodic Contacts.

The factory default value MUST be false.

- 2.7 TR-181i2a15c1
ScheduledAwarenessRequested boolean boolean W

If this parameter is true, the CPE MUST NOT go into a standby state that prevents it from honoring Scheduled Contacts. This means that, whenever the ACS has requested a Scheduled Contact:

  • if SelfTimerCapable is true and the CPE chooses to go into Standby before the Scheduled Contact has been honored, it MUST use a Timer-Aware Standby;
  • if SelfTimerCapable is false, the CPE MUST NOT go into Standby before the Scheduled Contact has been honored.
- 2.7 TR-181i2a15c1
Device.​ManagementServer.​InformParameter.​{i}. object​[0:] object​[0:∞] W

This table provides the ACS with the ability to control the Parameters that are delivered by the Inform RPC.

Any Parameter (identified by ParameterName) contained in this table MUST be included within the ParameterList argument of the Inform RPC whenever any Event within the EventList is being delivered.

This table does not include Forced Inform Parameters, and Forced Inform Parameters are not allowed to be inserted into this table. Any attempt by an ACS to configure this table to contain a Forced Inform Parameter MUST result in the failure of the SetParameterValues RPC with error code 9007.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias.

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

- 2.8 TR-181i2a15c1
Enable boolean boolean W Enables or disables this InformParameter. false 2.8 TR-181i2a15c1
Alias string​(64) Alias W

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

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

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

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

- 2.8 TR-181i2a15c1
ParameterName string​(256) string​(256) W

A pattern that describes the Parameter(s) to be included in the Inform’s ParameterList argument. Specifically, patterns with wildcards (an "*" character) in place of Instance Identifiers are allowed; any attempt to set the value otherwise MUST be rejected by the CPE.

If the pattern does not match any existing Parameters at the time that the CPE is creating the Inform RPC, then this InformParameter instance is not included in the Inform’s ParameterList argument.

<Empty> 2.8 TR-181i2a15c1
EventList string​[] list of string W

Comma-separated list of strings. Each entry in this list represents an Event for which this Parameter MUST be included within the ParameterList argument of the Inform RPC.

All Inform Events (see [Section 3.7.1.5/TR-069]), except for "4 VALUE CHANGE", are allowed as entries in this list. "4 VALUE CHANGE" is not allowed as that would violate requirements contained in [Section A.3.3.1/TR-069].

An empty string means all events except "4 VALUE CHANGE".

<Empty> 2.8 TR-181i2a15c1
Device.​ManagementServer.​HeartbeatPolicy. object object​[1:1] -

Parameters related to CPE behavior in order to issue a Heartbeat event to the ACS using the Inform method call.

If this object is supported then the CPE MUST support the requirements of [Annex O/TR-069].

- 2.12 TR-181i2a15c1
Enable boolean boolean W When true, Heartbeat events are enabled to be sent to the ACS based on the values of the ReportingInterval and InitiationTime parameters. - 2.12 TR-181i2a15c1
ReportingInterval unsignedInt​(30:) unsignedInt​(30:) W The duration in seconds of the interval for which the CPE MUST attempt to connect with the ACS and call the Inform method if Enable is true. - 2.12 TR-181i2a15c1
InitiationTime dateTime dateTime W

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

InitiationTime is used only to set the phase of the Heartbeat event Informs. The actual value of InitiationTime can be arbitrarily far into the past or future.

For example, if ReportingInterval is 60 (one minute) and if InitiationTime is set to UTC midnight on some day (in the past, present, or future) then Heartbeat Informs will occur every minute at the next UTC midnight. These MUST begin on the very next midnight, even if InitiationTime refers to a day in the future.

The Unknown Time value defined in [Section 3.2/TR-106] indicates that no particular time reference is specified. The CPE MUST locally choose a random time reference.

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

- 2.12 TR-181i2a15c1
Device.​GatewayInfo. object object​[1:1] - This object contains information associated with a connected Internet Gateway Device. - 2.0 TR-181i2a15c1
ManufacturerOUI string​(6) string​(6) -

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

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

- 2.0 TR-181i2a15c1
ProductClass string​(64) string​(64) - 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 TR-181i2a15c1
SerialNumber string​(64) string​(64) - 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 TR-181i2a15c1
Device.​Time. object object​[1:1] - This object contains parameters relating an NTP or SNTP time client in the CPE. - 2.0 TR-181i2a14
Enable boolean boolean W Enables or disables the NTP or SNTP time client. - 2.0 TR-181i2a14
Status string string -

Status of Time support on the CPE. Enumeration of:

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

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

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

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

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

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

EST+5 EDT,M4.1.0/2,M10.5.0/2
- 2.0 TR-181i2a14
Device.​UserInterface. object object​[1:1] - This object contains parameters relating to the user interface of the CPE. - 2.0 TR-181i2a14
Enable boolean boolean W

Enables and disables the CPE's user interface.

The factory default value MUST be true.

- 2.11 TR-181i2a14
PasswordRequired boolean boolean W

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

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

- 2.0 TR-181i2a14
PasswordUserSelectable boolean boolean W

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

Indicates whether or not a password to protect the local user interface of the CPE MAY be selected by the user directly (i.e. Users.User.{i}.Password), or MUST be equal to the password used by the LAN-side Auto-Configuration protocol (i.e. LANConfigSecurity.ConfigPassword).

- 2.0 TR-181i2a14
PasswordReset boolean boolean W

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

When set to true, resets LANConfigSecurity.ConfigPassword to its factory value.

The value of this parameter is not part of the device configuration and is always false when read.

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

Un-encoded binary image size in bytes.

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

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

- 2.0 TR-181i2a14
ISPMailServer string​(2048) URL W The [URL] of the ISP's mail server. - 2.0 TR-181i2a14
ISPNewsServer string​(2048) URL W The [URL] of the ISP's news server. - 2.0 TR-181i2a14
TextColor hexBinary​(3:3) hexBinary​(3:3) W The color of text on the GUI screens in RGB hexadecimal notation (e.g., FF0088). - 2.0 TR-181i2a14
BackgroundColor hexBinary​(3:3) hexBinary​(3:3) W The color of the GUI screen backgrounds in RGB hexadecimal notation (e.g., FF0088). - 2.0 TR-181i2a14
ButtonColor hexBinary​(3:3) hexBinary​(3:3) W The color of buttons on the GUI screens in RGB hexadecimal notation (e.g., FF0088). - 2.0 TR-181i2a14
ButtonTextColor hexBinary​(3:3) hexBinary​(3:3) W The color of text on buttons on the GUI screens in RGB hexadecimal notation (e.g., FF0088). - 2.0 TR-181i2a14
AutoUpdateServer string​(256) string​(256) W

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

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

- 2.0 TR-181i2a14
TR-181i2a15c1
UserUpdateServer string​(256) string​(256) W

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

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

- 2.0 TR-181i2a14
TR-181i2a15c1
AvailableLanguages string​(256)​[] list​(256) of string - Comma-separated list (maximum number of characters 256) of strings. List items represent user-interface languages that are available, where each language is specified according to [RFC3066]. - 2.0 TR-181i2a14
CurrentLanguage string​(16) string​(16) W Current user-interface language, specified according to [RFC3066]. The value MUST be a member of the list reported by the AvailableLanguages parameter. - 2.0 TR-181i2a14
Device.​UserInterface.​RemoteAccess. object object​[1:1] -

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

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

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

- 2.0 TR-181i2a14
Enable boolean boolean W Enables/Disables remotely accessing the CPE's user interface. - 2.0 TR-181i2a14
Port unsignedInt​(:65535) unsignedInt​(:65535) W Destination TCP port required for remote access connection. - 2.0 TR-181i2a14
SupportedProtocols string​[] list of string -

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

- 2.0 TR-181i2a14
Protocol string string W The value MUST be a member of the list reported by the SupportedProtocols parameter. This is the protocol currently being used for remote access. - 2.0 TR-181i2a14
Device.​UserInterface.​LocalDisplay. object object​[1:1] - This object describes how to remotely manage the initial positioning of a user interface on a device's local display. - 2.0 TR-181i2a14
Movable boolean boolean W Controls whether the user is allowed to change the GUI window position on the local CPE's display. - 2.0 TR-181i2a14
Resizable boolean boolean W Controls whether the user is allowed to resize the GUI window on the local CPE's display. - 2.0 TR-181i2a14
PosX int int W The horizontal position of the User Interface's top left corner within the local CPE's display measured from the top left corner, expressed in pixels. - 2.0 TR-181i2a14
PosY int int W The vertical position of the User Interface's top left corner within the local CPE's display measured from the top left corner, expressed in pixels. - 2.0 TR-181i2a14
Width unsignedInt unsignedInt W The width of the user interface within the local CPE's display, expressed in pixels. - 2.0 TR-181i2a14
Height unsignedInt unsignedInt W The height of the user interface within the local CPE's display, expressed in pixels. - 2.0 TR-181i2a14
DisplayWidth unsignedInt unsignedInt - The width of the local CPE's display, expressed in pixels. - 2.0 TR-181i2a14
DisplayHeight unsignedInt unsignedInt - The height of the local CPE's display, expressed in pixels. - 2.0 TR-181i2a14
Device.​UserInterface.​Messages. object object​[1:1] - Definition of user information message displays. - 2.11 TR-181i2a14
Enable boolean boolean W

Enables and displays the user information message.

The factory default value MUST be true.

- 2.11 TR-181i2a14
Title string​(128) string​(128) W Message title to be displayed. - 2.11 TR-181i2a14
SubTitle string​(128) string​(128) W Message sub title to be displayed. - 2.11 TR-181i2a14
Text string string W Message text. - 2.11 TR-181i2a14
IconType string string W

Icon to be displayed. Enumeration of:

- 2.11 TR-181i2a14
MessageColor hexBinary​(3:3) hexBinary​(3:3) W The color of message text in RGB hexadecimal notation (e.g., FF0088). - 2.11 TR-181i2a14
BackgroundColor hexBinary​(3:3) hexBinary​(3:3) W The color of the message screen background in RGB hexadecimal notation (e.g., FF0088). - 2.11 TR-181i2a14
TitleColor hexBinary​(3:3) hexBinary​(3:3) W The color of the message title in RGB hexadecimal notation (e.g., FF0088). - 2.11 TR-181i2a14
SubTitleColor hexBinary​(3:3) hexBinary​(3:3) W The color of the sub title in RGB hexadecimal notation (e.g., FF0088). - 2.11 TR-181i2a14
RequestedNumberOfRepetitions unsignedInt unsignedInt W The number of times the device SHOULD repeat the message. - 2.11 TR-181i2a14
ExecutedNumberOfRepetitions unsignedInt unsignedInt - The number of times the device repeated the message. - 2.11 TR-181i2a14
Device.​InterfaceStack.​{i}. object​[0:] object​[0:∞] -

This table contains information about the relationships between the multiple layers of interface objects ([Section 4.3/TR-181i2]). In particular, it contains information on which interfaces run on top of which other interfaces.

This table is auto-generated by the CPE based on the LowerLayers parameters on individual interface objects.

Each table row represents a "link" between two interface objects, a higher-layer interface object (referenced by HigherLayer) and a lower-layer interface object (referenced by LowerLayer). Consequently, if a referenced interface object is deleted, the CPE MUST delete the corresponding InterfaceStack row(s) that had referenced it.

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

- 2.0 TR-181i2a14
Alias string​(64) Alias W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.3 TR-181i2a14
HigherLayer string​(256) string​(256) -

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 TR-181i2a14
LowerLayer string​(256) string​(256) -

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 TR-181i2a14
HigherAlias string​(64) string​(64) - The value of the Alias parameter for the interface object referenced by HigherLayer. - 2.0 TR-181i2a14
LowerAlias string​(64) string​(64) - The value of the Alias parameter for the interface object referenced by LowerLayer. - 2.0 TR-181i2a14
Device.​DSL. object object​[1:1] - 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 TR-181i2a15
LineNumberOfEntries unsignedInt unsignedInt - The number of entries in the Line table. - 2.0 TR-181i2a15
ChannelNumberOfEntries unsignedInt unsignedInt - The number of entries in the Channel table. - 2.0 TR-181i2a15
BondingGroupNumberOfEntries unsignedInt unsignedInt - The number of entries in the BondingGroup table. - 2.0 TR-181i2a15
Device.​DSL.​Line.​{i}. object​[0:] object​[0:∞] -

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 TR-181i2a15
Enable boolean boolean W

Enables or disables the DSL line.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.0 TR-181i2a15
EnableDataGathering boolean boolean W Enables or disables data gathering on the DSL line. - 2.8 TR-181i2a15
Status string string -

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

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 TR-181i2a15
Alias string​(64) Alias W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0 TR-181i2a15
Name string​(64) string​(64) - The textual name of the DSL line as assigned by the CPE. - 2.0 TR-181i2a15
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the DSL line entered its current operational state. - 2.0 TR-181i2a15
LowerLayers string​(1024)​[] list​(1024) of string W

Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2].

Note: Since Line is a layer 1 interface, it is expected that LowerLayers will not be used.

- 2.0 TR-181i2a15
Upstream boolean boolean -

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 TR-181i2a15
FirmwareVersion string​(64) string​(64) - 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 TR-181i2a15
LinkStatus string string -

Status of the DSL physical link. Enumeration of:

When LinkStatus is Up, Status is expected to be Up. When LinkStatus is Initializing or EstablishingLink or NoSignal or Disabled, Status is expected to be Down.

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

- 2.0 TR-181i2a15
StandardsSupported string​[] list of string -

Note: In G.997.1, this parameter is called "xDSL Transmission system capabilities". See ITU-T Recommendation [G.997.1].
This parameter was DEPRECATED in 2.8 because its entries are out-of-date; XTSE points to a current list. Therefore its value MAY be an empty string if (and only if) XTSE is supported.
This parameter was OBSOLETED in 2.14.
This parameter was DELETED in 2.15.
- 2.0 TR-181i2a15
XTSE hexBinary​(8:8) hexBinary​(8:8) -

This configuration parameter defines the transmission system types to be allowed by the xTU on this Line instance. Each bit is 0 if not allowed or 1 if allowed, as defined for the xTU transmission system enabling (XTSE) in ITU-T G.997.1.

Note: This parameter is defined as xDSL Transmission system enabling (XTSE) in ITU-T G.997.1. For a full definition, see Clause 7.3.1.1.1 of ITU-T Recommendation [G.997.1].

- 2.8 TR-181i2a15
StandardUsed string string -
The value MUST be a member of the list reported by the StandardsSupported parameter. Indicates the standard that the Line instance is using for the connection.
Note: In G.997.1, this parameter is called "xDSL Transmission system". See ITU-T Recommendation [G.997.1].
This parameter was DEPRECATED in 2.8 because its entries are out-of-date; XTSE points to a current list. Therefore its value MAY be an empty string if (and only if) XTSUsed is supported..
This parameter was OBSOLETED in 2.14.
This parameter was DELETED in 2.15.
- 2.0 TR-181i2a15
XTSUsed hexBinary​(8:8) hexBinary​(8:8) - This parameter indicates which DSL standard and recommendation are currently in use by the Line instance. Only one bit is set, as defined for the xTU transmission system enabling (XTSE) in ITU-T G.997.1. - 2.8 TR-181i2a15
LineEncoding string string -

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

Note: Generally speaking, this variable does not change after provisioning.

- 2.0 TR-181i2a15
AllowedProfiles string​[] list of string -

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

Note: In G.997.1, this parameter is called PROFILES. See ITU-T Recommendation [G.997.1].

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be an empty string.

- 2.0 TR-181i2a15
CurrentProfile string string -

The value MUST be a member of the list reported by the AllowedProfiles parameter, or else be an empty string. Indicates which VDSL2 profile is currently in use on the line.

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, its value MUST be an empty string.

- 2.0 TR-181i2a15
PowerManagementState string string -

The power management state of the line. Enumeration of:

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
SuccessFailureCause unsignedInt​(0:6) unsignedInt​(0:6) -

The success failure cause of the initialization. An enumeration of the following integer values:

  • 0: Successful
  • 1: Configuration error. This error occurs with inconsistencies in configuration parameters, e.g. when the line is initialized in an xDSL Transmission system where an xTU does not support the configured Maximum Delay or the configured Minimum or Maximum Data Rate for one or more bearer channels.
  • 2: Configuration not feasible on the line. This error occurs if the Minimum Data Rate cannot be reached on the line with the Minimum Noise Margin, Maximum PSD level, Maximum Delay and Maximum Bit Error Ratio for one or more bearer channels.
  • 3: Communication problem. This error occurs, for example, due to corrupted messages or bad syntax messages or if no common mode can be selected in the G.994.1 handshaking procedure or due to a timeout.
  • 4: No peer xTU detected. This error occurs if the peer xTU is not powered or not connected or if the line is too long to allow detection of a peer xTU.
  • 5: Any other or unknown Initialization Failure cause.
  • 6: ITU T G.998.4 retransmission mode was not selected while RTX_MODE = FORCED or with RTX_MODE = RTX_TESTMODE.

Note: In G.997.1, this parameter is called "Initialization success/failure cause". See Clause 7.5.1.6 of ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
UPBOKLER unsignedInt​(0:1280) unsignedInt​(0:1280) -

This parameter contains the estimated electrical loop length estimated by the VTU-R expressed in 0.1 dB at 1MHz (see O-UPDATE in section 12.2.4.2.1.2/G.993.2). The value is coded as an unsignedInt in the range 0 (coded as 0) to 128 dB (coded as 1280) in steps of 0.1 dB.

Note: This parameter is defined as UPBOKLE-R in Clause 7.5.1.23.2 of ITU-T Recommendation [G.997.1].

- 2.8 TR-181i2a15
UPBOKLEPb unsignedInt​[]​(0:1280,2047) list of unsignedInt​(0:1280,2047) -

Comma-separated list of unsigned integers (value 0 to 1280, or 2047). VTU-O estimated upstream power back-off electrical length per band.

This parameter is a vector of UPBO electrical length per-band estimates for each supported downstream band, expressed in 0.1 dB at 1 MHz (kl0) calculated by the VTU-R, based on separate measurements in the supported upstream bands. The value of each list element ranges from 0 to 128 dB in steps of 0.1 dB, with special value 204.7 which indicates that the estimate is greater than 128 dB. This parameter is required for the alternative electrical length estimation method (ELE-M1).

Note: This parameter is defined as UPBOKLE-pb in Clause 7.5.1.23.3 of ITU-T Recommendation [G.997.1].

- 2.8 TR-181i2a15
UPBOKLERPb unsignedInt​[]​(0:1280,2047) list of unsignedInt​(0:1280,2047) -

Comma-separated list of unsigned integers (value 0 to 1280, or 2047). VTU-R estimated upstream power back-off electrical length per band.

This parameter is a vector of UPBO electrical length per-band estimates for each supported downstream band, expressed in 0.1 dB at 1 MHz (kl0) calculated by the VTU-R, based on separate measurements in the supported downstream bands. The value of each list element ranges from 0 to 128 dB in steps of 0.1 dB, with special value 204.7 which indicates that the estimate is greater than 128 dB. This parameter is required for the alternative electrical length estimation method (ELE-M1).

The value of each list element is coded as an unsigned 16 bit number in the range 0 (coded as 0) to 128 dB (coded as 1280) in steps of 0.1 dB.

Note: This parameter is defined as UPBOKLE-R-pb in Clause 7.5.1.23.4 of ITU-T Recommendation [G.997.1].

- 2.8 TR-181i2a15
RXTHRSHds int​(-640:0) int​(-640:0) -

UPBO downstream receiver signal level threshold.

This parameter reports the downstream received signal level threshold value used in the alternative electrical length estimation method (ELE-M1). This parameter represents an offset from -100 dBm/Hz, and ranges from -64 dB to 0 dB in steps of 0.1 dB.

The value is coded as a 16 bit number in the range -64 (coded as -640) to 0 dB (coded as 0) in steps of 0.1 dB.

Note: See ITU-T Recommendation [G.997.1].

- 2.8 TR-181i2a15
ACTRAMODEds unsignedInt​(1:4) unsignedInt​(1:4) -

This parameter indicates the actual active rate adaptation mode in the downstream direction.

  • If ACTRAMODEds equals 1, the link is operating in RA-MODE 1 (MANUAL).
  • If ACTRAMODEds equals 2, the link is operating in RA-MODE 2 (AT_INIT).
  • If ACTRAMODEds equals 3, the link is operating in RA-MODE 3 (DYNAMIC).
  • If ACTRAMODEds equals 4, the link is operating in RA-MODE 4 (DYNAMIC with SOS).

Note: This parameter is defined as ACT-RA-MODEds in Clause 7.5.1.33.1 of ITU-T Recommendation [G.997.1].

- 2.8 TR-181i2a15
ACTRAMODEus unsignedInt​(1:4) unsignedInt​(1:4) -

This parameter indicates the actual active rate adaptation mode in the upstream direction.

  • If ACTRAMODEus equals 1, the link is operating in RA-MODE 1 (MANUAL).
  • If ACTRAMODEus equals 2, the link is operating in RA-MODE 2 (AT_INIT).
  • If ACTRAMODEus equals 3, the link is operating in RA-MODE 3 (DYNAMIC).
  • If ACTRAMODEus equals 4, the link is operating in RA-MODE 4 (DYNAMIC with SOS).

Note: This parameter is defined as ACT-RA-MODEus in Clause 7.5.1.33.2 of ITU-T Recommendation [G.997.1].

- 2.8 TR-181i2a15
ACTINPROCds unsignedInt unsignedInt -

This parameter reports the actual impulse noise protection (INP) of the robust overhead channel (ROC) in the downstream direction. The format and usage is identical to the channel status parameter Channel.{i}.ACTINP.

Note: This parameter is defined as ACTINP-ROC-ds in Clause 7.5.1.34.1 of ITU-T Recommendation [G.997.1].

- 2.8 TR-181i2a15
ACTINPROCus unsignedInt unsignedInt -

This parameter reports the actual impulse noise protection (INP) of the robust overhead channel (ROC) in the upstream direction. The format and usage is identical to the channel status parameter Channel.{i}.ACTINP.

Note: This parameter is defined as ACTINP-ROC-us in Clause 7.5.1.34.2 ITU-T Recommendation [G.997.1].

- 2.8 TR-181i2a15
SNRMROCds unsignedInt unsignedInt -

This parameter reports the actual signal-to-noise margin of the robust overhead channel (ROC) in the downstream direction (expressed in 0.1 dB). The format is identical to the format of the line status parameter SNRM margin DownstreamNoiseMargin.

Note: This parameter is defined as SNRM-ROC-ds in Clause 7.5.1.35.1 ITU-T Recommendation [G.997.1].

- 2.8 TR-181i2a15
SNRMROCus unsignedInt unsignedInt -

This parameter reports the actual signal-to-noise margin of the robust overhead channel (ROC) in the upstream direction (expressed in 0.1 dB). The format is identical to the format of the line status parameter SNRM margin (UpstreamNoiseMargin).

Note: This parameter is defined as SNRM-ROC-us in Clause 7.5.1.35.2 ITU-T Recommendation [G.997.1].

- 2.8 TR-181i2a15
LastStateTransmittedDownstream unsignedInt unsignedInt -

This parameter represents the last successful transmitted initialization state in the downstream direction in the last full initialization performed on the line. Initialization states are defined in the individual xDSL Recommendations and are counted from 0 (if G.994.1 is used) or 1 (if G.994.1 is not used) up to Showtime. This parameter needs to be interpreted along with the xDSL Transmission System.

This parameter is available only when, after a failed full initialization, the line diagnostics procedures are activated on the line.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
LastStateTransmittedUpstream unsignedInt unsignedInt -

This parameter represents the last successful transmitted initialization state in the upstream direction in the last full initialization performed on the line. Initialization states are defined in the individual xDSL Recommendations and are counted from 0 (if G.994.1 is used) or 1 (if G.994.1 is not used) up to Showtime. This parameter needs to be interpreted along with the xDSL Transmission System.

This parameter is available only when, after a failed full initialization, the line diagnostics procedures are activated on the line.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
UPBOKLE unsignedInt​(0:1280) unsignedInt​(0:1280) -

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 TR-181i2a15
MREFPSDds base64​(0:145) base64​(0:145) -

This parameter SHALL contain the set of breakpoints exchanged in the MREFPSDds fields of the O-PRM message of G.993.2. Base64 encoded of the binary representation defined in Table 12-19/G.993.2 (maximum length is 145 octets, which requires 196 bytes for Base64 encoding).

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
MREFPSDus base64​(0:145) base64​(0:145) -

This parameter SHALL contain the set of breakpoints exchanged in the MREFPSDus fields of the R-PRM message of G.993.2. Base64 encoded of the binary representation defined in Table 12-19/G.993.2 (maximum length is 145 octets, which requires 196 bytes for Base64 encoding).

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
LIMITMASK unsignedInt unsignedInt -

Indicates the enabled VDSL2 Limit PSD mask of the selected PSD mask class. Bit mask as specified in ITU-T Recommendation G.997.1.

Note: For a VDSL2-capable multimode device operating in a mode other than VDSL2, the value of this parameter SHOULD be set to 0.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
US0MASK unsignedInt unsignedInt -

Indicates the allowed VDSL2 US0 PSD masks for Annex A operation. Bit mask as specified in see ITU-T Recommendation G.997.1.

Note: For a VDSL2-capable multimode device operating in a mode other than VDSL2, the value of this parameter SHOULD be set to 0.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
TRELLISds int int -

Reports whether trellis coding is enabled in the downstream direction. A value of 1 indicates that trellis coding is in use, and a value of 0 indicates that the trellis is disabled.

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

- 2.0 TR-181i2a15
TRELLISus int int -

Reports whether trellis coding is enabled in the upstream direction. A value of 1 indicates that trellis coding is in use, and a value of 0 indicates that the trellis is disabled.

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

- 2.0 TR-181i2a15
ACTSNRMODEds unsignedInt unsignedInt -

Reports whether the OPTIONAL virtual noise mechanism is in use in the downstream direction. A value of 1 indicates the virtual noise mechanism is not in use, and a value of 2 indicates the virtual noise mechanism is in use.

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

- 2.0 TR-181i2a15
ACTSNRMODEus unsignedInt unsignedInt -

Reports whether the OPTIONAL virtual noise mechanism is in use in the upstream direction. A value of 1 indicates the virtual noise mechanism is not in use, and a value of 2 indicates the virtual noise mechanism is in use.

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

- 2.0 TR-181i2a15
VirtualNoisePSDds base64​(0:97) base64​(0:97) -

Reports the virtual noise PSD for the downstream direction. Base64 encoded of the binary representation defined in G.997.1 by the parameter called TXREFVNds (maximum length is 97 octets, which requires 132 bytes for Base64 encoding).

See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to an empty string.

- 2.0 TR-181i2a15
VirtualNoisePSDus base64​(0:49) base64​(0:49) -

Reports the virtual noise PSD for the upstream direction. Base64 encoded of the binary representation defined in G.997.1by the parameter called TXREFVNus (maximum length is 49 octets, which requires 68 bytes for Base64 encoding).

See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to an empty string.

- 2.0 TR-181i2a15
ACTUALCE unsignedInt unsignedInt -

Reports the actual cyclic extension, as the value of m, in use for the connection.

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

- 2.0 TR-181i2a15
LineNumber int​(1:) int​(1:) - Signifies the line pair that the modem is using to connection. LineNumber = 1 is the innermost pair. - 2.0 TR-181i2a15
UpstreamMaxBitRate unsignedInt unsignedInt -

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 TR-181i2a15
DownstreamMaxBitRate unsignedInt unsignedInt -

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 TR-181i2a15
UpstreamNoiseMargin int int -

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 TR-181i2a15
DownstreamNoiseMargin int int -

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 TR-181i2a15
SNRMpbus string​(24)​[] list​(24) of string -

Comma-separated list (maximum number of characters 24) of strings. Indicates the current signal-to-noise ratio margin of each upstream band. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
SNRMpbds string​(24)​[] list​(24) of string -

Comma-separated list (maximum number of characters 24) of strings. Indicates the current signal-to-noise ratio margin of each band. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
INMIATOds unsignedInt​(3:511) unsignedInt​(3:511) -

The Impulse Noise Monitoring (INM) Inter Arrival Time (IAT) Offset, measured in DMT symbols, that the xTU receiver uses to determine in which bin of the IAT histogram the IAT is reported.

Note: In G.997.1, this parameter is called INMIATO. See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
INMIATSds unsignedInt​(0:7) unsignedInt​(0:7) -

The Impulse Noise Monitoring (INM) Inter Arrival Time (IAT) Step that the xTU receiver uses to determine in which bin of the IAT histogram the IAT is reported.

Note: In G.997.1, this parameter is called INMIATS. See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
INMCCds unsignedInt​(0:64) unsignedInt​(0:64) -

The Impulse Noise Monitoring (INM) Cluster Continuation value, measured in DMT symbols, that the xTU receiver uses in the cluster indication process.

Note: In G.997.1, this parameter is called INMCC. See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
INMINPEQMODEds unsignedInt​(0:3) unsignedInt​(0:3) -

The Impulse Noise Monitoring (INM) Equivalent Impulse Noise Protection (INP) Mode that the xTU receiver uses in the computation of the Equivalent INP.

Note: In G.997.1, this parameter is called INM_INPEQ_MODE. See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
UpstreamAttenuation int int -

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

Doesn't apply to VDSL2 [G.993.2]. Otherwise has the same value as the single element of TestParams.SATNus.

- 2.0 TR-181i2a15
DownstreamAttenuation int int -

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

Doesn't apply to VDSL2 [G.993.2]. Otherwise has the same value as the single element of TestParams.SATNds.

- 2.0 TR-181i2a15
UpstreamPower int int - The current output power at the CPE's DSL line (expressed in 0.1dBmV). - 2.0 TR-181i2a15
DownstreamPower int int - The current received power at the CPE's DSL line (expressed in 0.1dBmV). - 2.0 TR-181i2a15
XTURVendor hexBinary​(4:4) hexBinary​(4:4) -

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 TR-181i2a15
XTURCountry hexBinary​(2:2) hexBinary​(2:2) -

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 TR-181i2a15
XTURANSIStd unsignedInt unsignedInt -

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 TR-181i2a15
XTURANSIRev unsignedInt unsignedInt -

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 TR-181i2a15
XTUCVendor hexBinary​(4:4) hexBinary​(4:4) -

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 TR-181i2a15
XTUCCountry hexBinary​(2:2) hexBinary​(2:2) -

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 TR-181i2a15
XTUCANSIStd unsignedInt unsignedInt -

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 TR-181i2a15
XTUCANSIRev unsignedInt unsignedInt -

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 TR-181i2a15
Device.​DSL.​Line.​{i}.​Stats. object object​[1:1] -

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 TR-181i2a15
BytesSent unsignedLong unsignedLong - The total number of bytes transmitted out of the interface, including framing characters. - 2.0 TR-181i2a15
BytesReceived unsignedLong unsignedLong - The total number of bytes received on the interface, including framing characters. - 2.0 TR-181i2a15
PacketsSent unsignedLong unsignedLong - The total number of packets transmitted out of the interface. - 2.0 TR-181i2a15
PacketsReceived unsignedLong unsignedLong - The total number of packets received on the interface. - 2.0 TR-181i2a15
ErrorsSent unsignedInt unsignedInt - The total number of outbound packets that could not be transmitted because of errors. - 2.0 TR-181i2a15
ErrorsReceived unsignedInt unsignedInt - The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0 TR-181i2a15
DiscardPacketsSent unsignedInt unsignedInt - The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.0 TR-181i2a15
DiscardPacketsReceived unsignedInt unsignedInt - 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 TR-181i2a15
TotalStart unsignedInt unsignedInt -

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 TR-181i2a15
ShowtimeStart unsignedInt unsignedInt -

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 TR-181i2a15
LastShowtimeStart unsignedInt unsignedInt -

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 TR-181i2a15
CurrentDayStart unsignedInt unsignedInt -

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 TR-181i2a15
QuarterHourStart unsignedInt unsignedInt -

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 TR-181i2a15
Device.​DSL.​Line.​{i}.​Stats.​Total. object object​[1:1] -

This object contains DSL line total statistics. See [Chapter 7.2.6/G.997.1].

Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2a15
ErroredSecs unsignedInt unsignedInt -

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 TR-181i2a15
SeverelyErroredSecs unsignedInt unsignedInt -

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 TR-181i2a15
Device.​DSL.​Line.​{i}.​Stats.​Showtime. object object​[1:1] -

This object contains DSL line statistics accumulated since the most recent DSL Showtime. See [Chapter 7.2.6/G.997.1].

Note: The Showtime parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2a15
ErroredSecs unsignedInt unsignedInt -

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 TR-181i2a15
SeverelyErroredSecs unsignedInt unsignedInt -

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 TR-181i2a15
Device.​DSL.​Line.​{i}.​Stats.​LastShowtime. object object​[1:1] -

This object contains DSL line statistics accumulated since the second most recent DSL Showtime. See [Chapter 7.2.6/G.997.1].

Note: The LastShowtime parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2a15
ErroredSecs unsignedInt unsignedInt -

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 TR-181i2a15
SeverelyErroredSecs unsignedInt unsignedInt -

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 TR-181i2a15
Device.​DSL.​Line.​{i}.​Stats.​CurrentDay. object object​[1:1] -

This object contains DSL line statistics accumulated during the current day. See [Chapter 7.2.6/G.997.1].

Note: The CurrentDay parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2a15
ErroredSecs unsignedInt unsignedInt -

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 TR-181i2a15
SeverelyErroredSecs unsignedInt unsignedInt -

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 TR-181i2a15
Device.​DSL.​Line.​{i}.​Stats.​QuarterHour. object object​[1:1] -

This object contains DSL line statistics accumulated during the current quarter hour. See [Chapter 7.2.6/G.997.1].

Note: The QuarterHour parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2a15
ErroredSecs unsignedInt unsignedInt -

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 TR-181i2a15
SeverelyErroredSecs unsignedInt unsignedInt -

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 TR-181i2a15
Device.​DSL.​Line.​{i}.​TestParams. object object​[1:1] - This object contains the DSL line test parameters that are available during the L0 (i.e., Showtime) state. - 2.0 TR-181i2a15
HLOGGds unsignedInt unsignedInt -

Number of sub-carriers per sub-carrier group in the downstream direction for HLOGpsds. Valid values are 1, 2, 4, 8, and 16.

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

- 2.0 TR-181i2a15
HLOGGus unsignedInt unsignedInt -

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 TR-181i2a15
HLOGpsds string​(2559)​[] list​(2559) of string -

Comma-separated list (maximum number of characters 2559) of strings. Indicates the downstream logarithmic line characteristics per sub-carrier group. The maximum number of elements is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGds but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

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

Note: HLOGpsds is measured during initialization and is not updated during Showtime.

- 2.0 TR-181i2a15
HLOGpsus string​(2559)​[] list​(2559) of string -

Comma-separated list (maximum number of characters 2559) of strings. Indicates the upstream logarithmic line characteristics per sub-carrier group. The maximum number of elements is 64 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

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

Note: HLOGpsus is measured during initialization and is not updated during Showtime.

- 2.0 TR-181i2a15
HLOGMTds unsignedInt unsignedInt -

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 TR-181i2a15
HLOGMTus unsignedInt unsignedInt -

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 TR-181i2a15
QLNGds unsignedInt unsignedInt -

Number of sub-carriers per sub-carrier group in the downstream direction for QLNpsds. Valid values are 1, 2, 4, 8, and 16.

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

- 2.0 TR-181i2a15
QLNGus unsignedInt unsignedInt -

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 TR-181i2a15
QLNpsds int​(2047)​[] list​(2047) of int -

Comma-separated list (maximum number of characters 2047) of integers. Indicates the downstream quiet line noise per subcarrier group. The maximum number of elements is 256 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of QLNGds but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

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

Note: QLNpsds is measured during initialization and is not updated during Showtime.

- 2.0 TR-181i2a15
QLNpsus string​(2047)​[] list​(2047) of string -

Comma-separated list (maximum number of characters 2047) of strings. Indicates the upstream quiet line noise per subcarrier group. The maximum number of elements is 64 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of QLNGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

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

Note: QLNpsus is measured during initialization and is not updated during Showtime.

- 2.0 TR-181i2a15
QLNMTds unsignedInt unsignedInt -

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 TR-181i2a15
QLNMTus unsignedInt unsignedInt -

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 TR-181i2a15
SNRGds unsignedInt unsignedInt -

Number of sub-carriers per sub-carrier group in the downstream direction for SNRpsds. Valid values are 1, 2, 4, 8, and 16.

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

- 2.0 TR-181i2a15
SNRGus unsignedInt unsignedInt -

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 TR-181i2a15
SNRpsds int​(2047)​[] list​(2047) of int -

Comma-separated list (maximum number of characters 2047) of integers. Indicates the downstream SNR per subcarrier group. The maximum number of elements is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of elements will depend on the value of SNRGds but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

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

Note: SNRpsds is first measured during initialization and is updated during Showtime.

- 2.0 TR-181i2a15
SNRpsus string​(2047)​[] list​(2047) of string -

Comma-separated list (maximum number of characters 2047) of strings. Indicates the upstream SNR per subcarrier group. The maximum number of elements is 64 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of SNRGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

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

Note: SNRpsus is first measured during initialization and is updated during Showtime.

- 2.0 TR-181i2a15
SNRMTds unsignedInt unsignedInt -

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 TR-181i2a15
SNRMTus unsignedInt unsignedInt -

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 TR-181i2a15
LATNds string​(35)​[] list​(35) of string -

Comma-separated list (maximum number of characters 35) of strings. Indicates the downstream line attenuation averaged across all sub-carriers in the frequency band, as computed during initialization. Number of elements is dependent on the number of downstream bands but will exceed one only for ITU-T G.993.2. Interpretation of LATNds is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
LATNus string​(35)​[] list​(35) of string -

Comma-separated list (maximum number of characters 35) of strings. Indicates the upstream line attenuation averaged across all sub-carriers in the frequency band, as computed during initialization. Number of elements is dependent on the number of upstream bands but will exceed one only for ITU-T G.993.2. Interpretation of LATNus is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
SATNds string​(35)​[] list​(35) of string -

Comma-separated list (maximum number of characters 35) of strings. Indicates the downstream signal attenuation averaged across all active sub-carriers in the frequency band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for ITU-T G.993.2. Interpretation of SATNds is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
SATNus string​(35)​[] list​(35) of string -

Comma-separated list (maximum number of characters 35) of strings. Indicates the upstream signal attenuation averaged across all active sub-carriers in the frequency band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for ITU-T G.993.2. Interpretation of SATNus is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
Device.​DSL.​Line.​{i}.​DataGathering. object object​[1:1] -

This object models the DSL data gathering function at the VTU-R. This only applies to VDSL2.

Note: see ITU-T Recommendation [G.993.2].

- 2.8 TR-181i2a15
LoggingDepthR unsignedInt unsignedInt -

This parameter is the maximum depth of the entire data gathering event buffer at the VTU-R, in number of records, where each of the records consists of 6 bytes indicating a data gathering event as defined in [G.993.2].

Note: This parameter is defined as LOGGING_DEPTH_R in Clause 7.5.3.2 of ITU-T Recommendation [G.997.1].

- 2.8 TR-181i2a15
ActLoggingDepthReportingR unsignedInt unsignedInt -

This parameter is actual logging depth that is used for reporting the VTU-R event trace buffer over the eoc channel, in number of records, where each of the records consists of 6 bytes indicating a data gathering event as defined in [G.993.2].

Note: This parameter is defined as ACT_LOGGING_DEPTH_REPORTING_R in Clause 7.5.3.4 of ITU-T Recommendation [G.997.1].

- 2.8 TR-181i2a15
EventTraceBufferR string​(256) string​(256) -

The value MUST be the Path Name of a row in the DeviceInfo.VendorLogFile table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This parameter identifies the log file of the the data gathering event trace buffer containing the event records that originated at the VTU-R.

This indicates the table entry that represents a Vendor Log File that contains the data gathering buffer at the VTU-R in the DeviceInfo.VendorLogFile table.

This data gathering buffer MAY be retrieved wia an upload RPC of the identified Vendor Log File.

Note: This parameter is defined as EVENT_TRACE_BUFFER_R in Clause 7.5.3.6 of ITU-T Recommendation [G.997.1] and Clause 11.5 of ITU-T Recommendation [G.993.2].

- 2.8 TR-181i2a15
Device.​DSL.​Channel.​{i}. object​[0:] object​[0:∞] -

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 TR-181i2a15
Enable boolean boolean W

Enables or disables the channel.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.0 TR-181i2a15
Status string string -

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

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 TR-181i2a15
Alias string​(64) Alias W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0 TR-181i2a15
Name string​(64) string​(64) - The textual name of the channel as assigned by the CPE. - 2.0 TR-181i2a15
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the channel entered its current operational state. - 2.0 TR-181i2a15
LowerLayers string​(1024)​[] list​(1024) of string - Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2]. - 2.0 TR-181i2a15
LinkEncapsulationSupported string​[] list of string -

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

- 2.0 TR-181i2a15
LinkEncapsulationUsed string string -

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

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 TR-181i2a15
LPATH unsignedInt​(:3) unsignedInt​(:3) -

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 TR-181i2a15
INTLVDEPTH unsignedInt unsignedInt -

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 TR-181i2a15
INTLVBLOCK int int -

Reports the interleaver block length in use on the latency path indicated in LPATH.

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

- 2.0 TR-181i2a15
ActualInterleavingDelay unsignedInt unsignedInt -

Reports the actual delay, in milliseconds, of the latency path due to interleaving.

Note: In G.997.1, this parameter is called "Actual Interleaving Delay." See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
ACTINP int int -

Reports the actual impulse noise protection (INP) provided by the latency path indicated in LPATH. The value is the actual INP in the L0 (i.e., Showtime) state.

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

- 2.0 TR-181i2a15
INPREPORT boolean boolean -

Reports whether the value reported in ACTINP was computed assuming the receiver does not use erasure decoding. Valid values are 0 (computed per the formula assuming no erasure decoding) and 1 (computed by taking into account erasure decoding capabilities of receiver).

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

- 2.0 TR-181i2a15
NFEC int int -

Reports the size, in octets, of the Reed-Solomon codeword in use on the latency path indicated in LPATH.

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

- 2.0 TR-181i2a15
RFEC int int -

Reports the number of redundancy bytes per Reed-Solomon codeword on the latency path indicated in LPATH.

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

- 2.0 TR-181i2a15
LSYMB int int -

Reports the number of bits per symbol assigned to the latency path indicated in LPATH. This value does not include overhead due to trellis coding.

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

- 2.0 TR-181i2a15
UpstreamCurrRate unsignedInt unsignedInt -

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 TR-181i2a15
DownstreamCurrRate unsignedInt unsignedInt -

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 TR-181i2a15
ACTNDR unsignedInt unsignedInt -

Actual net data rate expressed in Kbps. Independent whether retransmission is used or not in a given transmit direction:

  • In L0 state, this parameter reports the net data rate (as specified in [ITU T G.992.3], [ITU T G.992.5] or [ITU T G.993.2]) at which the bearer channel is operating.
  • In L2 state, the parameter contains the net data rate (as specified in [ITU T G.992.3], [ITU T G.992.5] or [ITU T G.993.2]) in the previous L0 state.

Note: See ITU-T Recommendation [G.997.1].

- 2.8 TR-181i2a15
ACTINPREIN unsignedInt​(0:255) unsignedInt​(0:255) -

Actual impulse noise protection against REIN, expressed in 0.1 DMT symbols.

If retransmission is used in a given transmit direction, this parameter reports the actual impulse noise protection (INP) against REIN (under specific conditions detailed in [ITU T G.998.4]) on the bearer channel in the L0 state. In the L2 state, the parameter contains the INP in the previous L0 state.

The value is coded in fractions of DMT symbols with a granularity of 0.1 symbols.

The range is from 0 to 25.4. A special value of 25.5 indicates an ACTINP_REIN of 25.5 or higher.

Note: This parameter is defined as ACTINP_REIN in Clause 7.5.2.9 of ITU-T Recommendation [G.997.1].

- 2.8 TR-181i2a15
Device.​DSL.​Channel.​{i}.​Stats. object object​[1:1] -

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 TR-181i2a15
BytesSent unsignedLong unsignedLong - The total number of bytes transmitted out of the interface, including framing characters. - 2.0 TR-181i2a15
BytesReceived unsignedLong unsignedLong - The total number of bytes received on the interface, including framing characters. - 2.0 TR-181i2a15
PacketsSent unsignedLong unsignedLong - The total number of packets transmitted out of the interface. - 2.0 TR-181i2a15
PacketsReceived unsignedLong unsignedLong - The total number of packets received on the interface. - 2.0 TR-181i2a15
ErrorsSent unsignedInt unsignedInt - The total number of outbound packets that could not be transmitted because of errors. - 2.0 TR-181i2a15
ErrorsReceived unsignedInt unsignedInt - The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0 TR-181i2a15
DiscardPacketsSent unsignedInt unsignedInt - The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.0 TR-181i2a15
DiscardPacketsReceived unsignedInt unsignedInt - 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 TR-181i2a15
TotalStart unsignedInt unsignedInt -

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 TR-181i2a15
ShowtimeStart unsignedInt unsignedInt -

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 TR-181i2a15
LastShowtimeStart unsignedInt unsignedInt -

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 TR-181i2a15
CurrentDayStart unsignedInt unsignedInt -

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 TR-181i2a15
QuarterHourStart unsignedInt unsignedInt -

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 TR-181i2a15
Device.​DSL.​Channel.​{i}.​Stats.​Total. object object​[1:1] -

This object contains DSL channel total statistics [G.997.1].

Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2a15
XTURFECErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTUCFECErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTURHECErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTUCHECErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTURCRCErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTUCCRCErrors unsignedInt unsignedInt -

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 TR-181i2a15
Device.​DSL.​Channel.​{i}.​Stats.​Showtime. object object​[1:1] -

This object contains DSL channel statistics accumulated since the most recent DSL Showtime [G.997.1].

Note: The Showtime parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2a15
XTURFECErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTUCFECErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTURHECErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTUCHECErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTURCRCErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTUCCRCErrors unsignedInt unsignedInt -

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 TR-181i2a15
Device.​DSL.​Channel.​{i}.​Stats.​LastShowtime. object object​[1:1] -

This object contains DSL channel statistics accumulated since the second most recent DSL Showtime [G.997.1].

Note: The LastShowtime parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2a15
XTURFECErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTUCFECErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTURHECErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTUCHECErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTURCRCErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTUCCRCErrors unsignedInt unsignedInt -

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 TR-181i2a15
Device.​DSL.​Channel.​{i}.​Stats.​CurrentDay. object object​[1:1] -

This object contains DSL channel statistics accumulated during the current day [G.997.1].

Note: The CurrentDay parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2a15
XTURFECErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTUCFECErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTURHECErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTUCHECErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTURCRCErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTUCCRCErrors unsignedInt unsignedInt -

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 TR-181i2a15
Device.​DSL.​Channel.​{i}.​Stats.​QuarterHour. object object​[1:1] -

This object contains DSL channel statistics accumulated during the current quarter hour [G.997.1].

Note: The QuarterHour parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2a15
XTURFECErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTUCFECErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTURHECErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTUCHECErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTURCRCErrors unsignedInt unsignedInt -

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 TR-181i2a15
XTUCCRCErrors unsignedInt unsignedInt -

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 TR-181i2a15
Device.​DSL.​BondingGroup.​{i}. object​[0:] object​[0:∞] -

DSL bonding group table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each instance is a bonding group, and is expected to be stacked above a DSL.Channel instance or a FAST.Line instance for each bonded channel in the group.

Many of the parameters within this object, including LowerLayers, are read-only because bonding is not expected to be configured by a Controller.

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 TR-181i2a15
Enable boolean boolean W

Enables or disables the bonding group.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.0 TR-181i2a15
Status string string -

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

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 TR-181i2a15
Alias string​(64) Alias W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0 TR-181i2a15
Name string​(64) string​(64) - The textual name of the bonding group as assigned by the CPE. - 2.0 TR-181i2a15
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the bonding group entered its current operational state. - 2.0 TR-181i2a15
LowerLayers string​(1024)​[] list​(1024) of string -

Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object. If the referenced object is deleted, the corresponding item MUST be removed from the list. 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 Controller.

- 2.0 TR-181i2a15
GroupStatus string​[] list of string -

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

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

Corresponds to [TR-159] oBondingGroup.aGroupBondSchemesSupported.

- 2.0 TR-181i2a15
BondScheme string string -

The value MUST be a member of the list reported by the BondSchemesSupported parameter. Currently operating bonding scheme. Corresponds to [TR-159] aGroupOperBondScheme.

This parameter discriminates between the Ethernet union objects.

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

DSL bonded channel table. Each table entry represents a bonded channel within the bonding group, and is associated with exactly one DSL.Channel instance or one FAST.Line instance. There MUST be an instance of BondedChannel for each DSL channel or FAST line that is bonded.

When a DSL.Channel or FAST.Line is no longer bonded, then the CPE MUST delete the corresponding BondedChannel instance. However, when a bonded DSL.Channel or FAST.Line becomes disabled, the channel remains bonded and so the corresponding BondedChannel instance MUST NOT be deleted.

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

- 2.0 TR-181i2a15
Alias string​(64) Alias W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0 TR-181i2a15
Channel string​(256) string​(256) -

The value MUST be the Path Name of a row in the BondedChannel, DSL.Channel or FAST.Line tables. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is the channel that is being bonded.

This is read-only because bonding is expected to be configured by the CPE, not by the Controller.

- 2.0 TR-181i2a15
Device.​DSL.​BondingGroup.​{i}.​BondedChannel.​{i}.​Ethernet. object object​[1:1] - Per-channel [G.998.2] Ethernet-based bonding parameters. - 2.0 TR-181i2a15
Device.​DSL.​BondingGroup.​{i}.​BondedChannel.​{i}.​Ethernet.​Stats. object object​[1:1] -

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 TR-181i2a15
UnderflowErrorsSent unsignedInt unsignedInt - Number of underflow errors sent, i.e. on the transmit side of the interface. - 2.0 TR-181i2a15
CRCErrorsReceived unsignedInt unsignedInt - Number of CRC errors received, i.e. on the receive side of the interface. - 2.0 TR-181i2a15
AlignmentErrorsReceived unsignedInt unsignedInt - Number of alignment errors received, i.e. on the receive side of the interface. - 2.0 TR-181i2a15
ShortPacketsReceived unsignedInt unsignedInt - Number of short packets received, i.e. on the receive side of the interface. - 2.0 TR-181i2a15
LongPacketsReceived unsignedInt unsignedInt - Number of long packets received, i.e. on the receive side of the interface. - 2.0 TR-181i2a15
OverflowErrorsReceived unsignedInt unsignedInt - Number of overflow errors received, i.e. on the receive side of the interface. - 2.0 TR-181i2a15
PauseFramesReceived unsignedInt unsignedInt - Number of pause frames received, i.e. on the receive side of the interface. - 2.0 TR-181i2a15
FramesDropped unsignedInt unsignedInt - Number of frames dropped, e.g. because the receive queue is full. - 2.0 TR-181i2a15
Device.​DSL.​BondingGroup.​{i}.​Stats. object object​[1:1] -

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 TR-181i2a15
BytesSent unsignedLong unsignedLong - The total number of bytes transmitted out of the interface, including framing characters. - 2.0 TR-181i2a15
BytesReceived unsignedLong unsignedLong - The total number of bytes received on the interface, including framing characters. - 2.0 TR-181i2a15
PacketsSent unsignedLong unsignedLong - The total number of packets transmitted out of the interface. - 2.0 TR-181i2a15
PacketsReceived unsignedLong unsignedLong - The total number of packets received on the interface. - 2.0 TR-181i2a15
ErrorsSent unsignedInt unsignedInt - The total number of outbound packets that could not be transmitted because of errors. - 2.0 TR-181i2a15
ErrorsReceived unsignedInt unsignedInt - The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0 TR-181i2a15
UnicastPacketsSent unsignedLong unsignedLong - 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 TR-181i2a15
UnicastPacketsReceived unsignedLong unsignedLong - 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 TR-181i2a15
DiscardPacketsSent unsignedInt unsignedInt - The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.0 TR-181i2a15
DiscardPacketsReceived unsignedInt unsignedInt - 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 TR-181i2a15
MulticastPacketsSent unsignedLong unsignedLong - 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 TR-181i2a15
MulticastPacketsReceived unsignedLong unsignedLong - 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 TR-181i2a15
BroadcastPacketsSent unsignedLong unsignedLong - 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 TR-181i2a15
BroadcastPacketsReceived unsignedLong unsignedLong - 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 TR-181i2a15
UnknownProtoPacketsReceived unsignedInt unsignedInt - The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0 TR-181i2a15
TotalStart unsignedInt unsignedInt -

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 TR-181i2a15
CurrentDayStart unsignedInt unsignedInt -

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 TR-181i2a15
QuarterHourStart unsignedInt unsignedInt -

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 TR-181i2a15
Device.​DSL.​BondingGroup.​{i}.​Stats.​Total. object object​[1:1] -

Total statistics for this bonding group.

Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2a15
FailureReasons string​[] list of string -

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

Corresponds to [Section 11.4.3/G.998.1] Current Group Failure Reason.

- 2.0 TR-181i2a15
UpstreamRate unsignedInt unsignedInt - 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 TR-181i2a15
DownstreamRate unsignedInt unsignedInt - 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 TR-181i2a15
UpstreamPacketLoss unsignedInt unsignedInt - 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 TR-181i2a15
DownstreamPacketLoss unsignedInt unsignedInt - 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 TR-181i2a15
UpstreamDifferentialDelay unsignedInt unsignedInt - The achieved upstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0 TR-181i2a15
DownstreamDifferentialDelay unsignedInt unsignedInt - The achieved downstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0 TR-181i2a15
FailureCount unsignedInt unsignedInt - 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 TR-181i2a15
ErroredSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared Errored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**ES. - 2.0 TR-181i2a15
SeverelyErroredSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared SeverelyErrored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**SES. - 2.0 TR-181i2a15
UnavailableSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared Unavailable during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**UAS. - 2.0 TR-181i2a15
Device.​DSL.​BondingGroup.​{i}.​Stats.​CurrentDay. object object​[1:1] -

Current day statistics for this bonding group.

Note: The CurrentDay parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2a15
FailureReasons string​[] list of string -

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

Corresponds to [Section 11.4.3/G.998.1] Current Group Failure Reason.

- 2.0 TR-181i2a15
UpstreamRate unsignedInt unsignedInt - 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 TR-181i2a15
DownstreamRate unsignedInt unsignedInt - 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 TR-181i2a15
UpstreamPacketLoss unsignedInt unsignedInt - 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 TR-181i2a15
DownstreamPacketLoss unsignedInt unsignedInt - 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 TR-181i2a15
UpstreamDifferentialDelay unsignedInt unsignedInt - The achieved upstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0 TR-181i2a15
DownstreamDifferentialDelay unsignedInt unsignedInt - The achieved downstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0 TR-181i2a15
FailureCount unsignedInt unsignedInt - 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 TR-181i2a15
ErroredSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared Errored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**ES. - 2.0 TR-181i2a15
SeverelyErroredSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared SeverelyErrored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**SES. - 2.0 TR-181i2a15
UnavailableSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared Unavailable during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**UAS. - 2.0 TR-181i2a15
Device.​DSL.​BondingGroup.​{i}.​Stats.​QuarterHour. object object​[1:1] -

Current quarter hour statistics for this bonding group.

Note: The QuarterHour parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.0 TR-181i2a15
FailureReasons string​[] list of string -

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

Corresponds to [Section 11.4.3/G.998.1] Current Group Failure Reason.

- 2.0 TR-181i2a15
UpstreamRate unsignedInt unsignedInt - 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 TR-181i2a15
DownstreamRate unsignedInt unsignedInt - 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 TR-181i2a15
UpstreamPacketLoss unsignedInt unsignedInt - 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 TR-181i2a15
DownstreamPacketLoss unsignedInt unsignedInt - 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 TR-181i2a15
UpstreamDifferentialDelay unsignedInt unsignedInt - The achieved upstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0 TR-181i2a15
DownstreamDifferentialDelay unsignedInt unsignedInt - The achieved downstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0 TR-181i2a15
FailureCount unsignedInt unsignedInt - 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 TR-181i2a15
ErroredSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared Errored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**ES. - 2.0 TR-181i2a15
SeverelyErroredSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared SeverelyErrored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**SES. - 2.0 TR-181i2a15
UnavailableSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared Unavailable during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**UAS. - 2.0 TR-181i2a15
Device.​DSL.​BondingGroup.​{i}.​Ethernet. object​[0:1] object​[0:1] -

Ethernet-based bonding parameters [G.998.2].

This object MUST be present if, and only if, BondScheme is Ethernet.

- 2.0 TR-181i2a15
Device.​DSL.​BondingGroup.​{i}.​Ethernet.​Stats. object object​[1:1] -

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

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

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

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

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

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

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

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

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

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

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

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

- 2.0 TR-181i2a15c1
Interface string​(256) 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 TR-181i2a15
ACTPSDds int int -

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 TR-181i2a15
ACTPSDus int int -

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 TR-181i2a15
ACTATPds int int -

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 TR-181i2a15
ACTATPus int int -

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 TR-181i2a15
HLINSCds int int -

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 TR-181i2a15
HLINSCus int int -

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 TR-181i2a15
HLINGds unsignedInt unsignedInt -

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 TR-181i2a15
HLINGus unsignedInt unsignedInt -

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 TR-181i2a15
HLOGGds unsignedInt unsignedInt -

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 TR-181i2a15
HLOGGus unsignedInt unsignedInt -

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 TR-181i2a15
HLOGpsds string​(2559)​[] list​(2559) of string -

Comma-separated list (maximum number of characters 2559) of strings. List items represent downstream logarithmic channel characteristics per sub-carrier group. The maximum number of elements is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGds but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

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

Note: HLOGpsds is measured during initialization and is not updated during Showtime.

- 2.0 TR-181i2a15
HLOGpsus string​(2559)​[] list​(2559) of string -

Comma-separated list (maximum number of characters 2559) of strings. List items represent upstream logarithmic channel characteristics per sub-carrier group. The maximum number of elements is 64 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

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

Note: HLOGpsus is measured during initialization and is not updated during Showtime.

- 2.0 TR-181i2a15
HLOGMTds unsignedInt unsignedInt -

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 TR-181i2a15
HLOGMTus unsignedInt unsignedInt -

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 TR-181i2a15
LATNpbds string​(24)​[] list​(24) of string -

Comma-separated list (maximum number of characters 24) of strings. List items represent downstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of LATNpbds is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
LATNpbus string​(24)​[] list​(24) of string -

Comma-separated list (maximum number of characters 24) of strings. List items represent upstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of upstream bands but will exceed one only for G.993.2. Interpretation of LATNpbus is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
SATNds string​(24)​[] list​(24) of string -

Comma-separated list (maximum number of characters 24) of strings. List items represent downstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNds is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
SATNus string​(24)​[] list​(24) of string -

Comma-separated list (maximum number of characters 24) of strings. List items represent upstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNus is as defined in ITU-T Rec. G.997.1.

Note: See ITU-T Recommendation [G.997.1].

- 2.0 TR-181i2a15
HLINpsds int​(61430)​[] list​(61430) of int -

Comma-separated list (maximum number of characters 61430) of integers. List items represent downstream linear channel characteristics per subcarrier group. Maximum number of complex pairs is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of pairs will depend on the value of HLINGds but will not exceed 512. Interpretation of the value is as defined in ITU-T Rec. G.997.1.

Note: HLIN is not applicable in PLOAM for G.992.1 or G.992.2.

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

- 2.0 TR-181i2a15
HLINpsus string​(61430)​[] list​(61430) of string -

Comma-separated list (maximum number of characters 61430) of strings. List items represent upstream linear channel characteristics per sub-carrier group. Maximum number of complex pairs is 64 for G.992.3, and G.992.5. For G.993.2, the number of pairs will depend on the value of HLINGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

Note: HLIN is not applicable in PLOAM for G.992.1 or G.992.2.

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

- 2.0 TR-181i2a15
QLNGds unsignedInt unsignedInt -

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 TR-181i2a15
QLNGus unsignedInt unsignedInt -

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 TR-181i2a15
QLNpsds int​(61430)​[] list​(61430) of int -

Comma-separated list (maximum number of characters 61430) of integers. List items represent downstream quiet line noise per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. For G.993.2, the number of elements will depend on the value of QLNGds but will not exceed 512. Interpretation of the value is as defined in ITU-T Rec. G.997.1.

Note: QLN is not applicable in PLOAM for G.992.1 or G.992.2.

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

- 2.0 TR-181i2a15
QLNpsus string​(61430)​[] list​(61430) of string -

Comma-separated list (maximum number of characters 61430) of strings. List items represent upstream quiet line noise per subcarrier group. The maximum number of elements is 64 for G.992.3, and G.992.5. For G.993.2, the number of elements will depend on the value of QLNGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

Note: QLN is not applicable in PLOAM for G.992.1 or G.992.2.

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

- 2.0 TR-181i2a15
QLNMTds unsignedInt unsignedInt -

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 TR-181i2a15
QLNMTus unsignedInt unsignedInt -

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 TR-181i2a15
SNRGds unsignedInt unsignedInt -

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 TR-181i2a15
SNRGus unsignedInt unsignedInt -

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 TR-181i2a15
SNRpsds int​(61430)​[] list​(61430) of int -

Comma-separated list (maximum number of characters 61430) of integers. List items represent downstream SNR per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. For G.993.2, the number of elements will depend on the value of SNRGds but will not exceed 512. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Interpretation of the value is as defined in ITU-T Rec. G.997.1.

Note: SNRps is not applicable in PLOAM for G.992.1 or G.992.2.

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

- 2.0 TR-181i2a15
SNRpsus string​(61430)​[] list​(61430) of string -

Comma-separated list (maximum number of characters 61430) of strings. List items represent upstream SNR per subcarrier group. The maximum number of elements is 64 for G.992.3, and G.992.5. For G.993.2, the number of elements will depend on the value of SNRGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

Note: SNRps is not applicable in PLOAM for G.992.1 or G.992.2.

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

- 2.0 TR-181i2a15
SNRMTds unsignedInt unsignedInt -

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 TR-181i2a15
SNRMTus unsignedInt unsignedInt -

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 TR-181i2a15
BITSpsds int​(61430)​[] list​(61430) of int - Comma-separated list (maximum number of characters 61430) of integers. List items represent downstream bit allocation per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. Interpretation of the value is as defined in ITU-T Rec. [G.997.1]. - 2.0 TR-181i2a15
BITSpsus string​(61430)​[] list​(61430) of string - Comma-separated list (maximum number of characters 61430) of strings. List items represent upstream bit allocation per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. Interpretation of the value is as defined in ITU-T Rec. [G.997.1]. - 2.0 TR-181i2a15
Device.​DSL.​Diagnostics.​SELTUER. object object​[1:1] -

This object contains DSL Single Ended Line Test - Physical Medium Dependent (SELT-PMD) Uncalibrated Echo Response (UER) diagnostics parameters.

This object is for the CPE, aka the Transmission Unit - Remote end (TU-R).

Reference: ITU-T Recommendation [Clause A.2, SELT-PMD management entity/G.996.2].

- 2.13 TR-181i2a15c1
DiagnosticsState string DiagnosticsState W

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

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

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

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

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

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

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

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

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

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

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

- 2.13 TR-181i2a15c1
Interface string​(256) string​(256) W The value MUST be the Path Name of a row in the DSL.Line table. This is the interface over which the test is to be performed. - 2.13 TR-181i2a15
UERMaxMeasurementDuration unsignedInt​(5:240) unsignedInt​(5:240) W

This parameter is the SELT UER maximum measurement duration (MMD) measured in seconds.

This parameter is defined as SELT_UER_MMD_R in ITU-T Recommendation [Clause A.2.1.1/G.996.2].

- 2.13 TR-181i2a15
ExtendedBandwidthOperation boolean boolean -

This parameter indicates if the option for extended bandwidth SELT is applied (true) or not applied (false).

If the option for extended bandwidth SELT is applied to UER, then UERGroupSize has three valid values: 1, 2 and 12.

If the option for extended bandwidth SELT is not applied to UER, then UERGroupSize has two valid values: 1 and 2.

UERGroupSize is reported if the option for extended bandwidth UER SELT is supported; otherwise, reporting of the group size is optional.

- 2.13 TR-181i2a15
UER int​[1:4096]​[2] list​[1:4096] of UERComplex -

[UERComplex] The Uncalibrated Echo Response (UER) [a(0),b(0)], [a(1),b(1)], ...

Comma-separated list (1 to 4096 items) of UERComplexs, with each list item consisting of the following.

Pair of 32-bit signed integers a(i),b(i) with each pair representing a complex component of the uncalibrated echo response (UER);

  1. Real UER component, a(i)
  2. Imaginary UER component, b(i)

for values of i starting at i=0. Both values are represented as signed integers.

The interpretation of the UER value is as defined in [Clause A.2.2.1/G.996.2].

The value of UER at frequency i*UERGroupSize*Df = (UERScaleFactor/(2^31))*(a(i)+j*b(i))/(2^31) where Df = 4.3125 kHz.

This parameter is defined as CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation [Clause A.2.2.1/G.996.2].

- 2.13 TR-181i2a15
UERScaleFactor unsignedInt unsignedInt -

The Uncalibrated Echo Response (UER) scale factor.

This parameter is defined as part of the CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation [Clause A.2.2.1/G.996.2].

Note that the scale factor is chosen such that max(abs(a(i)), abs(b(i))) over all i is equal to 2^31 - 1, which doesn't allow UERScaleFactor to be zero.

- 2.13 TR-181i2a15
UERGroupSize unsignedInt​(1:2,12) unsignedInt​(1:2,12) -

The Uncalibrated Echo Response (UER) group size, UER_G. In units of subcarriers.

This parameter is defined as part of the CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation [Clause A.2.2.2/G.996.2].

- 2.13 TR-181i2a15
UERVar int​[0:4096] list​[0:4096] of int -

Comma-separated list (0 to 4096 items) of integers. This parameter represents the variance of the UER. List items represent v(i), for values of i starting at i=0. The variance of the uncalibrated echo response for frequency i*UERGroupSize*Df is VAR(i*UERGroupSize*Df) = 3 - v(i)/2 dB where Df = 4.3125 kHz.

This parameter is defined as SELT variance of uncalibrated echo response R (SELT UER-VAR-R) in [Clause A.2.2.2/G.996.2].

- 2.13 TR-181i2a15
Device.​DSL.​Diagnostics.​SELTQLN. object object​[1:1] -

This object contains DSL Single Ended Line Test - Physical Medium Dependent (SELT-PMD) Quiet Line Noise (QLN) diagnostics parameters.

This object is for the CPE, aka the Transmission Unit - Remote end (TU-R).

Reference: ITU-T Recommendation [Clause A.2, SELT-PMD management entity/G.996.2].

- 2.13 TR-181i2a15c1
DiagnosticsState string DiagnosticsState W

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

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

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

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

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

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

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

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

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

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

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

- 2.13 TR-181i2a15c1
Interface string​(256) string​(256) W The value MUST be the Path Name of a row in the DSL.Line table. This is the interface over which the test is to be performed. - 2.13 TR-181i2a15
QLNMaxMeasurementDuration unsignedInt​(1:240) unsignedInt​(1:240) W

This parameter is the SELT QLN maximum measurement duration (MMD) measured in seconds.

This parameter is defined as SELT_QLN_MMD_R in ITU-T Recommendation [Clause A.2.1.2/G.996.2].

- 2.13 TR-181i2a15
ExtendedBandwidthOperation boolean boolean -

This parameter indicates if the option for extended bandwidth SELT is applied (true) or not applied (false).

If the option for extended bandwidth SELT is applied to QLN, then QLNGroupSize has three valid values: 1, 2 and 12.

If the option for extended bandwidth SELT is not applied to QLN, then QLNGroupSize has two valid values: 1 and 2.

QLNGroupSize is reported if the option for extended bandwidth QLN SELT is supported; otherwise, reporting of the group size is optional.

- 2.13 TR-181i2a15
QLN int​(61430)​[] list​(61430) of int -

Comma-separated list (maximum number of characters 61430) of integers. List items represent SELT quiet line noise (QLN) per subcarrier group.

Each list element is n(i), with i starting at 0. The value of QLN at frequency i*QLNGroupSize*Df with Df=4.3125 kHz is defined as QLN(i*QLNGroupSize*Df) = -23 - (n(i)/2) dBm/Hz. This data format supports a QLN granularity of 0.5 dB and an dynamic range of -150 to -23 dBm/Hz.

Interpretation of the SELT_QLN_R value is defined in [Clause A.2.2.3/G.996.2].

- 2.13 TR-181i2a15
QLNGroupSize unsignedInt​(1:2,12) unsignedInt​(1:2,12) -

This parameter represents the Quiet Line Noise (QLN) group size. In units of subcarriers.

This parameter is defined as part of the SELT_QLN_R in ITU-T Recommendation [Clause A.2.2.4/G.996.2].

- 2.13 TR-181i2a15
Device.​DSL.​Diagnostics.​SELTP. object object​[1:1] -

This object contains DSL Single-Ended Line Test - Processed (SELT-P) diagnostics parameters.

This object is for the CPE, aka the Transmission Unit - Remote end (TU-R).

Reference: ITU-T Recommendation [G.996.2].

- 2.13 TR-181i2a15c1
DiagnosticsState string DiagnosticsState W

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

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

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

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

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

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

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

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

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

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

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

- 2.13 TR-181i2a15c1
Interface string​(256) string​(256) W The value MUST be the Path Name of a row in the DSL.Line table. This is the interface over which the test is to be performed. - 2.13 TR-181i2a15
CapacityEstimateEnabling boolean boolean W

Capacity estimate calculation enabling: This parameter is expressed as a boolean and takes the value false if xDSL performance estimation is not required, true otherwise.

The capacity estimate calculation enabling parameter is defined in [Clause B.2.1.1/G.996.2].

- 2.13 TR-181i2a15
CapacitySignalPSD unsignedInt​[1:48]​[2] list​[1:48] of PSDBreakPointIndexAndLevel W

[PSDBreakPointIndexAndLevel] The capacity estimate signal Power Spectral Density (PSD):

Comma-separated list (1 to 48 items) of PSDBreakPointIndexAndLevels, with each list item consisting of the following.

  1. the Power Spectral Density (PSD) breakpoint sub-carrier index in the range [0:49152] with Df = 4.3125 kHz frequency spacing, and
  2. the value of the level of the PSD at this sub-carrier expressed in 0.1 dBm/Hz with an offset of -200 dBm/Hz. The range of valid values for PSD is -30 to -200 dBm/Hz.

Both values are represented as unsignedInt.

This capacity estimate signal PSD parameter is defined in ITU-T Recommendation [Clause B.2.1.2/G.996.2].

- 2.13 TR-181i2a15
CapacityNoisePSD unsignedInt​[1:48]​[2] list​[1:48] of PSDBreakPointIndexAndLevel W

[PSDBreakPointIndexAndLevel] The capacity estimate noise Power Spectral Density (PSD):

Comma-separated list (1 to 48 items) of PSDBreakPointIndexAndLevels, with each list item consisting of the following.

  1. the Power Spectral Density (PSD) breakpoint sub-carrier index in the range [0:49152] with Df = 4.3125 kHz frequency spacing, and
  2. the value of the level of the PSD at this sub-carrier expressed in 0.1 dBm/Hz with an offset of -200 dBm/Hz. The range of valid values for PSD is -30 to -200 dBm/Hz.

Both values are represented as unsignedInt.

This capacity estimate noise PSD parameter is defined in ITU-T Recommendation [Clause B.2.1.3/G.996.2].

- 2.13 TR-181i2a15
CapacityTargetMargin unsignedInt​(0:310) unsignedInt​(0:310) W

The capacity estimate target noise margin. The range of valid values is 0 to 31 dB, in steps of 0.1 dB.

This capacity estimate target noise margin parameter is defined in ITU-T Recommendation [Clause B.2.1.4/G.996.2].

- 2.13 TR-181i2a15
LoopTermination string string -

Loop termination indicator. Enumeration of:

This parameter is defined as LOOP-TERM in ITU-T Recommendation [Clause B.1.1.1/G.996.2].

- 2.13 TR-181i2a15
LoopLength unsignedInt​(0:16383) unsignedInt​(0:16383) -

This parameter is the loop length with units of meters.

This parameter is defined as the loop length parameter LOOP_LEN in ITU-T Recommendation [Clause B.1.1.2/G.996.2].

- 2.13 TR-181i2a15
LoopTopology string​(256)​[] list​(256) of string -

Comma-separated list (maximum number of characters 256) of strings. List items represent paired parameters [LOOP_SEG_LEN, LOOP_SEG_BTAP] representing a concatenation of loop segment types, where LOOP_SEG_LEN represents the length of the segment in meters; and LOOP_SEG_BTAP is a string that identifies the segment type as either "in series" or "bridged tap".

The first loop segment in the list shall be the segment connected to the SELT-PMD block, subsequent loop segments in the list shall describe the loop in the direction toward the far-end loop termination.

This Loop Topology parameter is defined in ITU-T Recommendation [Clause B.1.1.3/G.996.2].

- 2.13 TR-181i2a15
AttenuationCharacteristics unsignedInt​[0:8191]​[2] list​[0:8191] of SELTPAttenuationCharacteristicsIndexAndTFlog -

[SELTPAttenuationCharacteristicsIndexAndTFlog] Specifies the list of attenuation characteristics.

Comma-separated list (0 to 8191 items) of SELTPAttenuationCharacteristicsIndexAndTFlogs, with each list item consisting of the following.

  1. The paired frequency spacing index in the range [0:8191], and
  2. The transfer function log value, i.e. [i, TFlog(i * TFlogGroupSize * Df)], where the reference frequency spacing Df = 4.3125 kHz, the index i valid range is 0 to 8191, and TFlog(i * TFlogGroupSize * Df) spans a range from +6.0 dB down to -96.2 dB with units of 0.1 dB.

Both values are represented as unsignedInt.

TFlog(i * TFlogGroupSize * Df) is represented by an integer k, 0 <= k <= 1022, where TFlog(i * TFlogGroupSize * Df) = 6.0 - k * 0.1. The special value of k of 1023 is used to indicate that no measurement could be done for this subcarrier because the attenuation is out of the range that can be represented.

The attenuation characteristics TFlog(f) parameter is defined in ITU-T Recommendation [Clause B.1.1.6/G.996.2].

- 2.13 TR-181i2a15
TFlogGroupSize unsignedInt​(1:2,12) unsignedInt​(1:2,12) -

This parameter represents the Transfer Function Log (TFlog) group size. In units of subcarriers.

This parameter is defined as part of the SELT attenuation characteristics, AttenuationCharacteristics, defined in ITU-T Recommendation [Clause B.1.1.6/G.996.2].

- 2.14 TR-181i2a15
MissingFilter boolean boolean -

Missing micro-filter or splitter: This parameter is a binary indication of a missing or incorrectly installed splitter or micro-filter at the U-R reference point. A value of true represents a missing splitter.

The missing micro-filter or splitter parameter is defined in [Clause B.1.1.4/G.996.2].

- 2.13 TR-181i2a15
CapacityEstimate unsignedInt​[1:2] list​[1:2] of unsignedInt -

Capacity Estimate: Comma-separated list (1 to 2 items) of unsigned integers. This parameter represents the downstream and/or upstream capacity estimates in kbit/s.

If only one value is supplied, then it's not specified whether it's the downstream value, the upstream value or some combination of the two. If two values are supplied, then the first is the downstream value and the second is the upstream value.

The capacity estimate parameters are defined in [Clause B.1.1.7/G.996.2].

- 2.13 TR-181i2a15
Device.​PacketCaptureDiagnostics. object object​[1:1] - The PacketCaptureDiagnostics object. This diagnostic is used to record packet capture data on a valid (layer 2 or above) interface in libpcap or pcapng format. - 2.13 TR-181i2a15c1
DiagnosticsState string DiagnosticsState W

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

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

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

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

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

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

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

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

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

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

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

- 2.13 TR-181i2a15c1
Interface string​(256) string​(256) W The value MUST be the Path Name of a table row. A reference to a (layer 2 or above) interface object that will be the target of this packet capture diagnostic. - 2.13 TR-181i2a15
Format string string -

This indicates whether the network trace will be recorded in libpcap [LIBPCAP] or pcapng format, and is dependent on the underlying method of performing a network trace. Enumeration of:

  • libpcap (The packet data is recorded in libpcap [LIBPCAP] format)
  • pcapng (The packet data is recorded in pcapng format)
- 2.13 TR-181i2a15
Duration unsignedInt​(1:) unsignedInt​(1:) W The duration in seconds to copy packets to the file target. The diagnostic completes when either the Duration, PacketCount, or ByteCount conditions are met. - 2.13 TR-181i2a15
PacketCount unsignedInt unsignedInt W The maximum number of packets to record to the file target. A value of zero (0) indicates no limit. The diagnostic completes when the Duration, ByteCount, or PacketCount conditions are met. - 2.13 TR-181i2a15
ByteCount unsignedInt unsignedInt W The maximum number of bytes to record to the file target. A value of zero (0) indicates no limit. The diagnostic completes when Duration, PacketCount or ByteCount conditions are met. - 2.13 TR-181i2a15
FileTarget string​(2048) URL W The [URL] specifying the destination file location. HTTP and HTTPS transports MUST be supported. Other transports MAY be supported. - 2.13 TR-181i2a15
FilterExpression string​(256) string​(256) W A ([BPF]) formatted expression used to restrict the types of network packets that are recorded to FileTarget. - 2.13 TR-181i2a15
Username string​(256) string​(256) W Username to be used by the Agent to authenticate with the file location. This string is set to an empty string if no authentication is required. - 2.13 TR-181i2a15
Password string​(256) string​(256) W

Password to be used by the Agent to authenticate with the file location. This string is set to an empty string if no authentication is required.

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

- 2.13 TR-181i2a15
PacketCaptureResultNumberOfEntries unsignedInt unsignedInt - The number of entries in the PacketCaptureResult table. - 2.13 TR-181i2a15
Device.​PacketCaptureDiagnostics.​PacketCaptureResult.​{i}. object​[0:] object​[0:∞] - Results for individual packet capture diagnostics. Packet capture files whose FileLocation is local to the system SHOULD be deleted when the next diagnostic is run, or upon a system reboot. - 2.13 TR-181i2a15
FileLocation string​(2048) URL - The [URL] specifying the resulting file location of the packet capture record that triggered this result. This MAY be different than the location specified in FileTarget. - 2.13 TR-181i2a15
StartTime dateTime dateTime - The local system time at which the capture was started. - 2.13 TR-181i2a15
EndTime dateTime dateTime - The local system time at which the capture was completed. - 2.13 TR-181i2a15
Count unsignedInt unsignedInt - The number of packets recorded to the file target. - 2.13 TR-181i2a15
Device.​FAST. object object​[1:1] - This object models FAST (defined in ITU Recommendation [G.9701]) lines. Each Line models a layer 1 FAST Line interface. - 2.11 TR-181i2a14
LineNumberOfEntries unsignedInt unsignedInt - The number of entries in the Line table. - 2.11 TR-181i2a14
Device.​FAST.​Line.​{i}. object​[0:] object​[0:∞] -

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

This table models physical FAST lines.

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

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

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

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

- 2.11 TR-181i2a14
Alias string​(64) Alias W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.11 TR-181i2a14
Name string​(64) string​(64) - The textual name of the FAST line as assigned by the CPE. - 2.11 TR-181i2a14
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the FAST line entered its current operational state. - 2.11 TR-181i2a14
LowerLayers string​(1024)​[] list​(1024) of string W

Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2].

Note: Since Line is a layer 1 interface, it is expected that LowerLayers will not be used.

- 2.11 TR-181i2a14
Upstream boolean boolean -

Indicates whether the interface points towards the Internet (true) or towards End Devices (false).

For example:

  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.11 TR-181i2a14
FirmwareVersion string​(64) string​(64) - A string identifying the version of the modem firmware currently installed for this interface. This is applicable only when the modem firmware is separable from the overall CPE software. - 2.11 TR-181i2a14
LinkStatus string string -

Status of the FAST physical link. Enumeration of:

When LinkStatus is Up, Status is expected to be Up. When LinkStatus is Initializing or EstablishingLink or NoSignal or Disabled, Status is expected to be Down.

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

- 2.11 TR-181i2a14
AllowedProfiles string​[] list of string -

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

Note: In G.997.2, this parameter is called PROFILES. See ITU-T Recommendation [G.997.2].

- 2.11 TR-181i2a14
CurrentProfile string string - The value MUST be a member of the list reported by the AllowedProfiles parameter, or else be an empty string. Indicates which FAST profile is currently in use on the line. - 2.11 TR-181i2a14
PowerManagementState string string -

The power management state of the line. Enumeration of:

Note: See ITU-T Recommendation [G.9701].

- 2.11 TR-181i2a14
SuccessFailureCause unsignedInt​(0:5) unsignedInt​(0:5) -

The success failure cause of the initialization. An enumeration of the following integer values:

  • 0: Successful
  • 1: Configuration error. Configuration error. This error occurs if the line cannot reach L0 state due to a mismatch of configuration and FTU capabilities.
  • 2: Configuration not feasible on the line. This error occurs if the line cannot reach the L0 state due to a mismatch of configuration of line and noise characteristics.
  • 3: Communication problem. This error occurs, for example, due to corrupted messages or bad syntax messages or if no common mode can be selected in the G.994.1 handshaking procedure or due to a timeout.
  • 4: No far-end FTU detected. This error occurs if the far-end FTU is not powered or not connected or if the line is too long to allow detection of a far-end FTU.
  • 5: Any other or unknown initialization failure cause.

Note: In G.997.2, this parameter is called "Initialization success/failure cause". See Clause 7.20.2.1 of ITU-T

Recommendation [G.997.2].

- 2.11 TR-181i2a14
UPBOKLER unsignedInt​(0:1280) unsignedInt​(0:1280) -

This parameter reports the estimate of the electrical length expressed in 0.1 dB, as determined by the FTU-R (see clause 7.3.1.4.2.1/[G.9701]) and conveyed in the R-MSG1 initialization message (see clause 12.3.3.2.3/[G.9701]). The value is coded as an unsignedInt in the range 0 (coded as 0) to 128 dB (coded as 1280) in steps of 0.1 dB.

Note: This parameter is defined as UPBOKLE-R in Clause 7.10.4.2 of ITU-T Recommendation [G.997.2].

- 2.11 TR-181i2a14
LastTransmittedDownstreamSignal unsignedInt​(0:21) unsignedInt​(0:21) -

This parameter reports the downstream signal count of the last transmitted initialization signal in the last full or short initialization performed on the line. The valid values are 0..21. The downstream signal count is defined in clause 12.3.1/[G.9701].

Note: See clause 7.10.2.2 ITU-T Recommendation [G.997.2].

- 2.11 TR-181i2a14
LastTransmittedUpstreamSignal unsignedInt​(0:21) unsignedInt​(0:21) -

This parameter reports the upstream signal count of the last transmitted initialization signal in the last full or short initialization performed on the line. The valid values are 0..21. The upstream signal count is defined in clause 12.3.1/[G.9701].

Note: See clause 7.10.2.3 ITU-T Recommendation [G.997.2].

- 2.11 TR-181i2a14
UPBOKLE unsignedInt​(0:1280) unsignedInt​(0:1280) -

This parameter reports the electrical length that would have been sent from the FTU-O to the FTU-R if the electrical length was not forced by the DPU-MIB. If the electrical length is not forced by the DPU-MIB, then this object reports the final electrical length, as determined by the FTU-O (see clause 7.3.1.4.2.1/[G.9701]) and conveyed in the O-UPDATE initialization message (see clause 12.3.3.2.4/[G.9701]).

Note: See clause 7.10.4.1 in ITU-T Recommendation [G.997.2].

- 2.11 TR-181i2a14
LineNumber int​(1:) int​(1:) - Signifies the line pair that the modem is using to connection. LineNumber = 1 is the innermost pair. - 2.11 TR-181i2a14
UpstreamMaxBitRate unsignedInt unsignedInt -

This parameter reports the attainable net data rate expressed in Kbps as defined in clause 11.4.1.1.2/[G.9701].

Note: This parameter is related to the G.997.2 parameter ATTNDRus. See clause 7.11.2.1 ITU-T Recommendation [G.997.2].

- 2.11 TR-181i2a14
DownstreamMaxBitRate unsignedInt unsignedInt -

This parameter reports the attainable net data rate expressed in Kbps as defined in clause 11.4.1.1.2/[G.9701].

Note: This parameter is related to the G.997.2 parameter ATTNDRds. See clause 7.11.2.1 ITU-T Recommendation [G.997.2].

- 2.11 TR-181i2a14
UpstreamNoiseMargin int int -

This parameter reports the signal-to-noise ratio margin (as defined in clause 9.8.3.2/[G.9701] and 11.4.1.3/[G.9701]) in the upstream direction. A special value indicates that the signal-to-noise ratio margin is out of the range to be represented. The parameter is expressed in 0.1dB.

Note: In G.997.2, this parameter is called SNRMus. See ITU-T Recommendation [G.997.2].

- 2.11 TR-181i2a14
DownstreamNoiseMargin int int -

This parameter reports the signal-to-noise ratio margin (as defined in clause 9.8.3.2/[G.9701] and 11.4.1.3/[G.9701]) in the upstream direction. A special value indicates that the signal-to-noise ratio margin is out of the range to be represented. The parameter is expressed in 0.1dB.

Note: In G.997.2, this parameter is called SNRMds. See ITU-T Recommendation [G.997.2].

- 2.11 TR-181i2a14
UpstreamAttenuation int int - The current upstream signal loss (expressed in 0.1dB). - 2.11 TR-181i2a14
DownstreamAttenuation int int - The current downstream signal loss (expressed in 0.1dB). - 2.11 TR-181i2a14
UpstreamPower int int - The current output power at the CPE's FAST line (expressed in 0.1dBmV). - 2.11 TR-181i2a14
DownstreamPower int int - The current received power at the CPE's FAST line (expressed in 0.1dBmV). - 2.11 TR-181i2a14
SNRMRMCds int int - This parameter reports the signal-to-noise margin for the robust management channel (RMC) in the downstream direction (express in 0.1dB). A special value (-512) indicates that the signal-to-noise ratio margin for the RMC is out of the range to be represented. This parameter is defined in clauses 7.10.12.1 of ITU-T Recommendation [G.997.2]. - 2.11 TR-181i2a14
SNRMRMCus int int - This parameter reports the signal-to-noise margin for the robust management channel (RMC) in the upstream direction (express in 0.1dB). A special value (-512) indicates that the signal-to-noise ratio margin for the RMC is out of the range to be represented. This parameter is defined in clauses 7.10.12.2 of ITU-T Recommendation [G.997.2]. - 2.11 TR-181i2a14
BITSRMCpsds int​(4610)​[] list​(4610) of int - Comma-separated list (maximum number of characters 4610) of integers. List items report the bit allocation values on RMC sub-carriers in RMC symbols in the downstream direction. Each pair composes of a sub-carrier index from 0..4095 and an 8 bit allocation value. There are maximum 512 pairs. This parameter is defined in clause 7.10.12.3 of ITU-T Recommendation [G.997.2]. - 2.11 TR-181i2a14
BITSRMCpsus int​(4610)​[] list​(4610) of int - Comma-separated list (maximum number of characters 4610) of integers. List items report the bit allocation values on RMC sub-carriers in RMC symbols in the upstream direction. Each pair composes of a sub-carrier index from 0..4095 and an 8 bit allocation value. There are maximum 512 pairs. This parameter is defined in clause 7.10.12.4 of ITU-T Recommendation [G.997.2]. - 2.11 TR-181i2a14
FEXTCANCELds boolean boolean - This indicates whether FEXT cancellation in the downstream direction from all the other vectored lines into the line in the vectored group is enabled (TRUE) or disabled (FALSE). This parameter is defined as FEXT_TO_CANCEL_ENABLEds in clause 7.1.7.1 of ITU Recommendation [G.997.2]. - 2.11 TR-181i2a14
FEXTCANCELus boolean boolean - This indicates whether FEXT cancellation in the upstream direction from all the other vectored lines into the line in the vectored group is enabled (TRUE) or disabled (FALSE). This parameter is defined as FEXT_TO_CANCEL_ENABLEds in clause 7.1.7.1 of ITU Recommendation [G.997.2]. - 2.11 TR-181i2a14
ETRds unsignedInt unsignedInt - This parameter reports the expected throughput rate expressed in Kbps as defined in clause 7.11.1.2 of ITU-T Recommendation [G.997.2] - 2.11 TR-181i2a14
ETRus unsignedInt unsignedInt - This parameter reports the expected throughput rate expressed in Kbps as defined in clause 7.11.1.2 of ITU-T Recommendation [G.997.2] - 2.11 TR-181i2a14
ATTETRds unsignedInt unsignedInt - This parameter reports the attainable expected throughput expressed in Kbps as defined in clause 7.11.2.2 of ITU-T Recommendation [G.997.2] - 2.11 TR-181i2a14
ATTETRus unsignedInt unsignedInt - This parameter reports the attainable expected throughput expressed in Kbps as defined in clause 7.11.2.2 of ITU-T Recommendation [G.997.2] - 2.11 TR-181i2a14
MINEFTR unsignedInt unsignedInt - This parameter reports the minimum error free throughput value expressed in Kbps computed from power up as defined in clause 11.4.1.1.3 of ITU-T Recommendation [G.9701] - 2.11 TR-181i2a14
Device.​FAST.​Line.​{i}.​Stats. object object​[1:1] -

Throughput statistics for this interface.

The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

- 2.11 TR-181i2a14
BytesSent unsignedLong unsignedLong - The total number of bytes transmitted out of the interface, including framing characters. - 2.11 TR-181i2a14
BytesReceived unsignedLong unsignedLong - The total number of bytes received on the interface, including framing characters. - 2.11 TR-181i2a14
PacketsSent unsignedLong unsignedLong - The total number of packets transmitted out of the interface. - 2.11 TR-181i2a14
PacketsReceived unsignedLong unsignedLong - The total number of packets received on the interface. - 2.11 TR-181i2a14
ErrorsSent unsignedInt unsignedInt - The total number of outbound packets that could not be transmitted because of errors. - 2.11 TR-181i2a14
ErrorsReceived unsignedInt unsignedInt - The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.11 TR-181i2a14
DiscardPacketsSent unsignedInt unsignedInt - The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.11 TR-181i2a14
DiscardPacketsReceived unsignedInt unsignedInt - 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.11 TR-181i2a14
TotalStart unsignedInt unsignedInt -

FAST-specific statistic. The Number of seconds since the beginning of the period used for collection of Total statistics.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

Note: TotalStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.11 TR-181i2a14
ShowtimeStart unsignedInt unsignedInt -

FAST-specific statistic. The Number of seconds since the most recent DSL Showtime - the beginning of the period used for collection of Showtime statistics.

Showtime is defined as successful completion of the DSL link establishment process. The Showtime statistics are those collected since the most recent establishment of the DSL link.

Note: ShowtimeStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.11 TR-181i2a14
LastShowtimeStart unsignedInt unsignedInt -

FAST-specific statistic. The Number of seconds since the second most recent DSL Showtime-the beginning of the period used for collection of LastShowtime statistics.

If the CPE has not retained information about the second most recent Showtime (e.g., on reboot), the start of LastShowtime statistics MAY temporarily coincide with the start of Showtime statistics.

Note: LastShowtimeStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.11 TR-181i2a14
CurrentDayStart unsignedInt unsignedInt -

FAST-specific statistic. The Number of seconds since the beginning of the period used for collection of CurrentDay statistics.

The CPE MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

Note: CurrentDayStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.11 TR-181i2a14
QuarterHourStart unsignedInt unsignedInt -

FAST-specific statistic. The Number of seconds since the beginning of the period used for collection of QuarterHour statistics.

The CPE MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

Note: QuarterHourStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.11 TR-181i2a14
Device.​FAST.​Line.​{i}.​Stats.​Total. object object​[1:1] -

This object contains DSL line total statistics.

Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.11 TR-181i2a14
ErroredSecs unsignedInt unsignedInt - Total number of errored seconds as defined in ITU-T Rec. [G.997.2]. An errored second (ES) is declared if, during a 1-second interval, there are one or more crc anomalies, or one or more los defects, or one or more lor defects, or one or more lpr primitives. - 2.11 TR-181i2a14
SeverelyErroredSecs unsignedInt unsignedInt - Total number of severely errored seconds as defined in ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
LOSS unsignedInt unsignedInt - Total number of loss of signal seconds (LOSS) as defined in ITU-T Rec. [G.997.2]. A LOSS is declared if, during a 1-second interval, there are one or more los defects. - 2.11 TR-181i2a14
LORS unsignedInt unsignedInt - Total number of loss of RMC seconds (LORS) as defined in ITU-T Rec. [G.997.2]. A LORS is declared if, during a 1-second interval, there are one or more lor defects. - 2.11 TR-181i2a14
UAS unsignedInt unsignedInt - Total number of unavailable seconds (UAS) as defined in ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
RTXUC unsignedInt unsignedInt - This parameter reports a count of uncorrected DTU anomalies (rtx_uc). This parameter is defined in clause 7.8.5 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
RTXTX unsignedInt unsignedInt - This parameter reports a count of retransmitted DTU anomalies (rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessBSW unsignedInt unsignedInt - This parameter reports a count of the successful bit swap (BSW) primitives. This parameter is defined as success_BSW in clause 7.7.20 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessSRA unsignedInt unsignedInt - This parameter reports a count of the successful autonomous SRA (seamless rate adaptation) primitives. This parameter is defined as success_SRA in clause 7.7.21 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessFRA unsignedInt unsignedInt - This parameter reports a count of the successful FRA (fast rate adaptation) primitives. This parameter is defined as success_FRA in clause 7.7.22 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessRPA unsignedInt unsignedInt - This parameter reports a count of the successful RPA (RMC parameter adjustment) primitives. This parameter is defined as success_RPA in clause 7.7.23 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessTIGA unsignedInt unsignedInt - This parameter reports a count of the successful TIGA (transmitter initiated gain adjustment) primitives. This parameter is defined as success_TIGA in clause 7.7.24 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
Device.​FAST.​Line.​{i}.​Stats.​Showtime. object object​[1:1] -

This object contains FAST line statistics since the most recent showtime.

Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.11 TR-181i2a14
ErroredSecs unsignedInt unsignedInt - Total number of errored seconds as defined in ITU-T Rec. [G.997.2]. An errored second (ES) is declared if, during a 1-second interval, there are one or more crc anomalies, or one or more los defects, or one or more lor defects, or one or more lpr primitives. - 2.11 TR-181i2a14
SeverelyErroredSecs unsignedInt unsignedInt - Total number of severely errored seconds as defined in ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
LOSS unsignedInt unsignedInt - Total number of loss of signal seconds (LOSS) as defined in ITU-T Rec. [G.997.2]. A LOSS is declared if, during a 1-second interval, there are one or more los defects. - 2.11 TR-181i2a14
LORS unsignedInt unsignedInt - Total number of loss of RMC seconds (LORS) as defined in ITU-T Rec. [G.997.2]. A LORS is declared if, during a 1-second interval, there are one or more lor defects. - 2.11 TR-181i2a14
UAS unsignedInt unsignedInt - Total number of unavailable seconds (UAS) as defined in ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
RTXUC unsignedInt unsignedInt - This parameter reports a count of uncorrected DTU anomalies (rtx_uc). This parameter is defined in clause 7.8.5 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
RTXTX unsignedInt unsignedInt - This parameter reports a count of retransmitted DTU anomalies (rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessBSW unsignedInt unsignedInt - This parameter reports a count of the successful bit swap (BSW) primitives. This parameter is defined as success_BSW in clause 7.7.20 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessSRA unsignedInt unsignedInt - This parameter reports a count of the successful autonomous SRA (seamless rate adaptation) primitives. This parameter is defined as success_SRA in clause 7.7.21 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessFRA unsignedInt unsignedInt - This parameter reports a count of the successful FRA (fast rate adaptation) primitives. This parameter is defined as success_FRA in clause 7.7.22 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessRPA unsignedInt unsignedInt - This parameter reports a count of the successful RPA (RMC parameter adjustment) primitives. This parameter is defined as success_RPA in clause 7.7.23 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessTIGA unsignedInt unsignedInt - This parameter reports a count of the successful TIGA (transmitter initiated gain adjustment) primitives. This parameter is defined as success_TIGA in clause 7.7.24 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
Device.​FAST.​Line.​{i}.​Stats.​LastShowtime. object object​[1:1] -

This object contains FAST line statistics since the second most recent showtime.

Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.11 TR-181i2a14
ErroredSecs unsignedInt unsignedInt - Total number of errored seconds as defined in ITU-T Rec. [G.997.2]. An errored second (ES) is declared if, during a 1-second interval, there are one or more crc anomalies, or one or more los defects, or one or more lor defects, or one or more lpr primitives. - 2.11 TR-181i2a14
SeverelyErroredSecs unsignedInt unsignedInt - Total number of severely errored seconds as defined in ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
LOSS unsignedInt unsignedInt - Total number of loss of signal seconds (LOSS) as defined in ITU-T Rec. [G.997.2]. A LOSS is declared if, during a 1-second interval, there are one or more los defects. - 2.11 TR-181i2a14
LORS unsignedInt unsignedInt - Total number of loss of RMC seconds (LORS) as defined in ITU-T Rec. [G.997.2]. A LORS is declared if, during a 1-second interval, there are one or more lor defects. - 2.11 TR-181i2a14
UAS unsignedInt unsignedInt - Total number of unavailable seconds (UAS) as defined in ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
RTXUC unsignedInt unsignedInt - This parameter reports a count of uncorrected DTU anomalies (rtx_uc). This parameter is defined in clause 7.8.5 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
RTXTX unsignedInt unsignedInt - This parameter reports a count of retransmitted DTU anomalies (rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessBSW unsignedInt unsignedInt - This parameter reports a count of the successful bit swap (BSW) primitives. This parameter is defined as success_BSW in clause 7.7.20 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessSRA unsignedInt unsignedInt - This parameter reports a count of the successful autonomous SRA (seamless rate adaptation) primitives. This parameter is defined as success_SRA in clause 7.7.21 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessFRA unsignedInt unsignedInt - This parameter reports a count of the successful FRA (fast rate adaptation) primitives. This parameter is defined as success_FRA in clause 7.7.22 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessRPA unsignedInt unsignedInt - This parameter reports a count of the successful RPA (RMC parameter adjustment) primitives. This parameter is defined as success_RPA in clause 7.7.23 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessTIGA unsignedInt unsignedInt - This parameter reports a count of the successful TIGA (transmitter initiated gain adjustment) primitives. This parameter is defined as success_TIGA in clause 7.7.24 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
Device.​FAST.​Line.​{i}.​Stats.​CurrentDay. object object​[1:1] -

This object contains FAST line statistics accumulated during the current day.

Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.11 TR-181i2a14
ErroredSecs unsignedInt unsignedInt - Total number of errored seconds as defined in ITU-T Rec. [G.997.2]. An errored second (ES) is declared if, during a 1-second interval, there are one or more crc anomalies, or one or more los defects, or one or more lor defects, or one or more lpr primitives. - 2.11 TR-181i2a14
SeverelyErroredSecs unsignedInt unsignedInt - Total number of severely errored seconds as defined in ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
LOSS unsignedInt unsignedInt - Total number of loss of signal seconds (LOSS) as defined in ITU-T Rec. [G.997.2]. A LOSS is declared if, during a 1-second interval, there are one or more los defects. - 2.11 TR-181i2a14
LORS unsignedInt unsignedInt - Total number of loss of RMC seconds (LORS) as defined in ITU-T Rec. [G.997.2]. A LORS is declared if, during a 1-second interval, there are one or more lor defects. - 2.11 TR-181i2a14
UAS unsignedInt unsignedInt - Total number of unavailable seconds (UAS) as defined in ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
RTXUC unsignedInt unsignedInt - This parameter reports a count of uncorrected DTU anomalies (rtx_uc). This parameter is defined in clause 7.8.5 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
RTXTX unsignedInt unsignedInt - This parameter reports a count of retransmitted DTU anomalies (rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessBSW unsignedInt unsignedInt - This parameter reports a count of the successful bit swap (BSW) primitives. This parameter is defined as success_BSW in clause 7.7.20 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessSRA unsignedInt unsignedInt - This parameter reports a count of the successful autonomous SRA (seamless rate adaptation) primitives. This parameter is defined as success_SRA in clause 7.7.21 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessFRA unsignedInt unsignedInt - This parameter reports a count of the successful FRA (fast rate adaptation) primitives. This parameter is defined as success_FRA in clause 7.7.22 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessRPA unsignedInt unsignedInt - This parameter reports a count of the successful RPA (RMC parameter adjustment) primitives. This parameter is defined as success_RPA in clause 7.7.23 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessTIGA unsignedInt unsignedInt - This parameter reports a count of the successful TIGA (transmitter initiated gain adjustment) primitives. This parameter is defined as success_TIGA in clause 7.7.24 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
Device.​FAST.​Line.​{i}.​Stats.​QuarterHour. object object​[1:1] -

This object contains FAST line statistics accumulated during the current quarter hour.

Note: The Total parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

- 2.11 TR-181i2a14
ErroredSecs unsignedInt unsignedInt - Total number of errored seconds as defined in ITU-T Rec. [G.997.2]. An errored second (ES) is declared if, during a 1-second interval, there are one or more crc anomalies, or one or more los defects, or one or more lor defects, or one or more lpr primitives. - 2.11 TR-181i2a14
SeverelyErroredSecs unsignedInt unsignedInt - Total number of severely errored seconds as defined in ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
LOSS unsignedInt unsignedInt - Total number of loss of signal seconds (LOSS) as defined in ITU-T Rec. [G.997.2]. A LOSS is declared if, during a 1-second interval, there are one or more los defects. - 2.11 TR-181i2a14
LORS unsignedInt unsignedInt - Total number of loss of RMC seconds (LORS) as defined in ITU-T Rec. [G.997.2]. A LORS is declared if, during a 1-second interval, there are one or more lor defects. - 2.11 TR-181i2a14
UAS unsignedInt unsignedInt - Total number of unavailable seconds (UAS) as defined in ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
RTXUC unsignedInt unsignedInt - This parameter reports a count of uncorrected DTU anomalies (rtx_uc). This parameter is defined in clause 7.8.5 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
RTXTX unsignedInt unsignedInt - This parameter reports a count of retransmitted DTU anomalies (rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessBSW unsignedInt unsignedInt - This parameter reports a count of the successful bit swap (BSW) primitives. This parameter is defined as success_BSW in clause 7.7.20 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessSRA unsignedInt unsignedInt - This parameter reports a count of the successful autonomous SRA (seamless rate adaptation) primitives. This parameter is defined as success_SRA in clause 7.7.21 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessFRA unsignedInt unsignedInt - This parameter reports a count of the successful FRA (fast rate adaptation) primitives. This parameter is defined as success_FRA in clause 7.7.22 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessRPA unsignedInt unsignedInt - This parameter reports a count of the successful RPA (RMC parameter adjustment) primitives. This parameter is defined as success_RPA in clause 7.7.23 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
SuccessTIGA unsignedInt unsignedInt - This parameter reports a count of the successful TIGA (transmitter initiated gain adjustment) primitives. This parameter is defined as success_TIGA in clause 7.7.24 of ITU-T Rec. [G.997.2]. - 2.11 TR-181i2a14
Device.​FAST.​Line.​{i}.​TestParams. object object​[1:1] - This object contains the FAST line test parameters that are available during the L0 (i.e., Showtime) state. - 2.11 TR-181i2a14
SNRGds unsignedInt unsignedInt -

Reports the number of sub-carriers in any one sub-carrier group used to represent the downstream SNR(f) values. Valid values are 1, 2, 4, and 8.

Note: In ITU-T G.9701-2014, the only valid value is G = 1. See clause 7.10.8.2 ITU-T Recommendation [G.997.2].

- 2.11 TR-181i2a14
SNRGus unsignedInt unsignedInt -

Reports the number of sub-carriers in any one sub-carrier group used to represent the upstream SNR(f) values. Valid values are 1, 2, 4, and 8.

Note: In ITU-T G.9701-2014, the only valid value is G = 1. See clause 7.10.8.5 ITU-T Recommendation [G.997.2].

- 2.11 TR-181i2a14
SNRpsds int​(2047)​[] list​(2047) of int -

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

Note: See clause 7.10.8.3 of ITU-T Recommendation [G.997.2].

- 2.11 TR-181i2a14
SNRpsus string​(2047)​[] list​(2047) of string -

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

Note: See clause 7.10.8.6 of ITU-T Recommendation [G.997.2].

- 2.11 TR-181i2a14
SNRMTds unsignedInt unsignedInt -

Reports the number of symbols used to measure the downstream SNR(f) values. The valid values 0..65535.

Note: See clause 7.10.8.1 of ITU-T Recommendation [G.997.2].

- 2.11 TR-181i2a14
SNRMTus unsignedInt unsignedInt -

Reports the number of symbols used to measure the upstream SNR(f) values. The valid values 0..65535.

Note: See clause 7.10.8.4 of ITU-T Recommendation [G.997.2].

- 2.11 TR-181i2a14
ACTINP unsignedInt unsignedInt -

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

Note: See ITU-T Recommendation [G.997.2].

- 2.11 TR-181i2a14
NFEC unsignedInt unsignedInt -

Reports the DTU FEC codeword length (expressed in 1 byte unit) as defined in clause 9.3/[G.9701]. The valid range is 32..255.

Note: See clause 7.11.4.1 ITU-T Recommendation [G.997.2].

- 2.11 TR-181i2a14
RFEC int int -

Reports the DTU FEC codeword redundancy as defined in clause 9.3/[G.9701].

Note: See ITU-T Recommendation [G.997.2].

- 2.11 TR-181i2a14
UpstreamCurrRate unsignedInt unsignedInt -

Reports the current physical layer aggregate data rate (expressed in Kbps) of the upstream FAST as defined in clause 11.4.1.1.1/[G.9701].

The current physical layer aggregate data rate (expressed in Kbps) of the upstream FAST connection. The valid values are 0..4294967295(0 to 232-1 kbit/s).

- 2.11 TR-181i2a14
DownstreamCurrRate unsignedInt unsignedInt -

Reports the current physical layer aggregate data rate (expressed in Kbps) of the upstream FAST as defined in clause 11.4.1.1.1/[G.9701].

The current physical layer aggregate data rate (expressed in Kbps) of the downstream FAST connection. The valid values are 0..4294967295(0 to 232-1 kbit/s).

- 2.11 TR-181i2a14
ACTINPREIN unsignedInt unsignedInt - Reports the actual INP against REIN as defined in clause 11.4.1.1.8/[G.9701]. A special value indicates an actual INP against REIN of 63 symbols or higher. The valid range is 0..62 symbols, and 63 is the special value. - 2.11 TR-181i2a14
Device.​Optical. object object​[1:1] -

This object models a generic optical interface. It defines an Interface object that models a layer 1 optical interface that is capable of transporting Ethernet packets. For historical reasons, the data model definition is based on parts of [G.988]. However, it is not intended to model anything specific to IEEE PON or ITU-T PON technologies.

Note that this object is not intended to model the optical transceiver either.

- 2.4 TR-181i2a15
InterfaceNumberOfEntries unsignedInt unsignedInt - The number of entries in the Interface table. - 2.4 TR-181i2a15
Device.​Optical.​Interface.​{i}. object​[0:] object​[0:∞] -

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

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

- 2.4 TR-181i2a15
Enable boolean boolean W

Enables or disables the optical interface.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.4 TR-181i2a15
Status string string -

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

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

- 2.4 TR-181i2a15
Alias string​(64) Alias W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.4 TR-181i2a15
Name string​(64) string​(64) - The textual name of the optical interface as assigned by the CPE. - 2.4 TR-181i2a15
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the optical interface entered its current operational state. - 2.4 TR-181i2a15
LowerLayers string​(1024)​[] list​(1024) of string W

Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2].

Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used.

- 2.4 TR-181i2a15
Upstream boolean boolean -

Indicates whether the interface points towards the Internet (true) or towards End Devices (false).

For example:

  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.4 TR-181i2a15
OpticalSignalLevel int​(-65536:65534 step 2) Dbm1000​(-65536:65534 step 2) -

[Dbm1000] Current measurement of total downstream optical signal level.

The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.

Valid values are -65.536 dBm (coded as -65536), to 65.534 dBm (coded as 65534) in 0.002 dB increments.

This parameter is based on Optical signal level from [Section 9.2.1/G.988].

- 2.4 TR-181i2a15
LowerOpticalThreshold int​(-127000:0 step 500) Dbm1000​(-127000:0 step 500) -
[Dbm1000] Optical level that is used to declare the downstream low received optical power alarm.
The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.
Valid values are -127.5 dBm (coded as -127500) to 0 dBm (coded as 0) in 0.5 dB increments. The value -127500 indicates the device's internal policy.
This parameter is based on Lower optical threshold from [Section 9.2.1/G.988].
This parameter was DEPRECATED in 2.15 because it is not intended for the device to raise an optical power alarm..
- 2.4 TR-181i2a15
UpperOpticalThreshold int​(-127000:0 step 500) Dbm1000​(-127000:0 step 500) -
[Dbm1000] Optical level that is used to declare the downstream high received optical power alarm.
The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.
Valid values are -127.5 dBm (coded as -127500) to 0 dBm (coded as 0) in 0.5 dB increments. The value -127500 indicates the device's internal policy.
This parameter is based on Upper optical threshold from [Section 9.2.1/G.988].
This parameter was DEPRECATED in 2.15 because it is not intended for the device to raise an optical power alarm..
- 2.4 TR-181i2a15
TransmitOpticalLevel int​(-65536:65534 step 2) Dbm1000​(-65536:65534 step 2) -

[Dbm1000] Current measurement of mean optical launch power.

The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.

Valid values are -65.536 dBm (coded as -65536), to 65.534 dBm (coded as 65534) in 0.002 dB increments.

This parameter is based on Transmit optical level from [Section 9.2.1/G.988].

- 2.4 TR-181i2a15
LowerTransmitPowerThreshold int​(-63500:63500 step 500) Dbm1000​(-63500:63500 step 500) -
[Dbm1000] Minimum mean optical launch power that is used to declare the low transmit optical power alarm.
The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.
Valid values are -63.5 dBm (coded as -63500) to +63.5 dBm (coded as 63500) in 0.5 dB increments. The value -63500 indicates the device's internal policy.
This parameter is based on Lower transmit power threshold from [Section 9.2.1/G.988].
This parameter was DEPRECATED in 2.15 because it is not intended for the device to raise an optical power alarm..
- 2.4 TR-181i2a15
UpperTransmitPowerThreshold int​(-63500:63500 step 500) Dbm1000​(-63500:63500 step 500) -
[Dbm1000] Maximum mean optical launch power that is used to declare the high transmit optical power alarm.
The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.
Valid values are -63.5 dBm (coded as -63500) to +63.5 dBm (coded as 63500) in 0.5 dB increments. The value -63500 indicates the device's internal policy.
This parameter is based on Upper transmit power threshold from [Section 9.2.1/G.988].
This parameter was DEPRECATED in 2.15 because it is not intended for the device to raise an optical power alarm..
- 2.4 TR-181i2a15
Device.​Optical.​Interface.​{i}.​Stats. object object​[1:1] -

Throughput statistics for this interface.

The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

- 2.4 TR-181i2a15
BytesSent unsignedLong unsignedLong - The total number of bytes transmitted out of the interface, including framing characters. - 2.4 TR-181i2a15
BytesReceived unsignedLong unsignedLong - The total number of bytes received on the interface, including framing characters. - 2.4 TR-181i2a15
PacketsSent unsignedLong unsignedLong - The total number of packets transmitted out of the interface. - 2.4 TR-181i2a15
PacketsReceived unsignedLong unsignedLong - The total number of packets received on the interface. - 2.4 TR-181i2a15
ErrorsSent unsignedInt unsignedInt - The total number of outbound packets that could not be transmitted because of errors. - 2.4 TR-181i2a15
ErrorsReceived unsignedInt unsignedInt - The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.4 TR-181i2a15
DiscardPacketsSent unsignedInt unsignedInt - The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.4 TR-181i2a15
DiscardPacketsReceived unsignedInt unsignedInt - 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.4 TR-181i2a15
Device.​Cellular. object object​[1:1] - This object models cellular interfaces and access points. - 2.8 TR-181i2a14
RoamingEnabled boolean boolean W Enables or disables roaming. - 2.8 TR-181i2a14
RoamingStatus string string -

Current roaming status. Enumeration of:

- 2.8 TR-181i2a14
InterfaceNumberOfEntries unsignedInt unsignedInt - The number of entries in the Interface table. - 2.8 TR-181i2a14
AccessPointNumberOfEntries unsignedInt unsignedInt - The number of entries in the AccessPoint table. - 2.8 TR-181i2a14
Device.​Cellular.​Interface.​{i}. object​[0:] object​[0:∞] -

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

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

- 2.8 TR-181i2a14
Enable boolean boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.8 TR-181i2a14
Status string string -

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

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status

  • SHOULD change to Up if and only if the interface is able to transmit and receive network traffic.
  • SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed)
  • SHOULD remain in the Error state if there is an error or other fault condition detected on the interface
  • SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

Because the interface includes layer 1 the LowerLayerDown value SHOULD never be used.

This parameter is based on ifOperStatus from [RFC2863].

- 2.8 TR-181i2a14
Alias string​(64) Alias W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.8 TR-181i2a14
Name string​(64) string​(64) - The textual name of the interface as assigned by the CPE. - 2.8 TR-181i2a14
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the interface entered its current operational state. - 2.8 TR-181i2a14
LowerLayers string​(1024)​[] list​(1024) of string W

Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2].

Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used.

- 2.8 TR-181i2a14
Upstream boolean boolean -

Indicates whether the interface points towards the Internet (true) or towards End Devices (false).

For example:

  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.8 TR-181i2a14
IMEI string​(15:15) string​(15:15) -

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

- 2.8 TR-181i2a14
SupportedAccessTechnologies string​[] list of string -

Comma-separated list of strings. Access technologies supported by the interface. Each list item is an enumeration of:

- 2.8 TR-181i2a14
PreferredAccessTechnology string string W

The value MUST be a member of the list reported by the SupportedAccessTechnologies parameter, or else be Auto. Preferred access technology.

The factory default value MUST be Auto.

- 2.8 TR-181i2a14
CurrentAccessTechnology string string - The value MUST be a member of the list reported by the SupportedAccessTechnologies parameter. Access technology that is currently in use. - 2.8 TR-181i2a14
AvailableNetworks string​[]​(64) list of string​(64) - Comma-separated list of strings (maximum number of characters 64). List of available networks. - 2.8 TR-181i2a14
NetworkRequested string​(64) string​(64) W

Name of the network which will be used, or an empty string if the network is selected automatically.

The factory default value MUST be <Empty>.

- 2.8 TR-181i2a14
NetworkInUse string​(64) string​(64) - The value MUST be a member of the list reported by the AvailableNetworks parameter, or else be an empty string. The value is an empty string if no network is found, or if the network specified in NetworkRequested is not found. - 2.8 TR-181i2a14
RSSI int int -

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

  • For GPRS, EDGE the range is -111 dBm to -49 dBm
  • For UMTS, UMTSHSPA the range is -117 dBm to -54 dBm
  • For LTE, NR the range is -117 dBm to -25 dBm

Note: An undetectable signal is indicated by the appropriate lower limit, e.g. -117 dBm for LTE.

- 2.8 TR-181i2a14
RSRP int int -

The Reference Signal Received Power in dBm for LTE, NR values of CurrentAccessTechnology:

  • The valid range of RSRP values from worst to best is -140 dBm to -44 dBm
- 2.14 TR-181i2a14
RSRQ int int -

The Reference Signal Received Quality in dBm for LTE, NR values of CurrentAccessTechnology:

  • RSRQ is calculated using RSSI and RSRP values using RSRQ = (N*RSRP)/RSSI where N is the number of resource blocks (bandwidth).
  • The valid range of RSRP values from worst to best is -20 dBm to -3 dBm
- 2.14 TR-181i2a14
UpstreamMaxBitRate unsignedInt unsignedInt - The current maximum attainable data rate upstream (expressed in Kbps). - 2.8 TR-181i2a14
DownstreamMaxBitRate unsignedInt unsignedInt - The current maximum attainable data rate downstream (expressed in Kbps). - 2.8 TR-181i2a14
Device.​Cellular.​Interface.​{i}.​USIM. object object​[1:1] - USIM (Universal Subscriber Identity Module or SIM card) parameters for the interface. - 2.8 TR-181i2a14
Status string string -

The current status of the USIM card. Enumeration of:

  • None (No card available)
  • Available (Card is available but not verified)
  • Valid (Card can be used; either valid PIN was entered, or PIN check is deactivated)
  • Blocked (USIM is blocked because the maximum number of invalid PIN entries was exceeded)
  • Error (An error was detected with the card, OPTIONAL)
- 2.8 TR-181i2a14
IMSI string​(14:15) string​(14:15) -

International Mobile Subscriber Identity represented as a string with either 14 or 15 digits (digits 0-9). The first 3 digits are the mobile country code (MCC), which are followed by the mobile network code (MNC), either 2 digits (European standard) or 3 digits (North American standard), followed by the mobile subscription identification number (MSIN). Possible patterns:

- 2.8 TR-181i2a14
ICCID string​(6:20) string​(6:20) -

Integrated Circuit Card Identifier represented as a string of up to 20 digits (digits 0-9). The number is composed of the following parts:

  • Major industry identifier (MII), 2 fixed digits, 89 for telecommunication purposes.
  • Country code, 1–3 digits, as defined by ITU-T recommendation [ITU-E.164].
  • identifier, 1–4 digits.
  • Individual account identification number. Its length is variable, but every number under one IIN will have the same length.
  • Single check digit calculated from the other digits using the Luhn algorithm.

For cards using an ICCID according to [ITU-E.118] the maximum length is 19 Digits, for GSM cards 20 digits. Possible patterns:

- 2.8 TR-181i2a14
MSISDN string​(14:15) string​(14:15) -

Mobile Subscriber Integrated Service Digital Network Number, a number uniquely identifying a subscription in a GSM, UMTS, or LTE mobile network. [ITU-E.164]

Possible patterns:

- 2.8 TR-181i2a14
PINCheck string string W

Controls the PIN verification of the USIM card. Enumeration of:

  • OnNetworkAccess (Check the PIN with each access to a new network)
  • Reboot (Check the PIN with first access after (re)boot)
  • Off (Disable the PIN check)
- 2.8 TR-181i2a14
PIN string​(4) string​(4) W

Allows the Controller to change the USIM PIN used for SIM card activation.

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

- 2.8 TR-181i2a14
Device.​Cellular.​Interface.​{i}.​Stats. object object​[1:1] -

Throughput statistics for this interface.

The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

- 2.8 TR-181i2a14
BytesSent unsignedLong StatsCounter64 - [StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters. - 2.8 TR-181i2a14
BytesReceived unsignedLong StatsCounter64 - [StatsCounter64] The total number of bytes received on the interface, including framing characters. - 2.8 TR-181i2a14
PacketsSent unsignedLong Stats