Broadband Forum

USP Device:2.16 Root Object definition

tr-181-2-16-0-usp.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.

Data Types

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

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

Data Type Base Type Description
base64 -

Base64 encoded binary (no line-length limitation).

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

boolean - Boolean, where the allowed values are 0 or 1 (or equivalently, true or false).
dateTime - The subset of the ISO 8601 date-time format defined by the SOAP dateTime type [SOAP1.1].
decimal - Decimal TBD.
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 unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.
AmplitudeData hexBinary(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.

Enumeration of:

  • 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.
DocsEqualizerData hexBinary(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

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

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

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

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

IPv4Address IPAddress(:45)

IPv4 address (or subnet mask).

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

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

IPv4 address prefix.

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

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

IPv6 address.

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

IPv6Prefix IPPrefix(:49)

IPv6 address prefix.

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

IoTDeviceType string

Describes the type of Device that the object instance is representing. Enumeration of:

  • Alarm
  • AntiTheft
  • Bell
  • Clock
  • Door
  • Fan
  • GarageDoor
  • HVAC
  • Light
  • Lock
  • Meter
  • Motor
  • Oven
  • PowerStrip
  • Sensor
  • SensorStrip
  • Siren
  • Thermostat
IoTEnumControlType string

Describes the type of IoT Enum Controller that the object instance is representing. Enumeration of:

  • AlarmMode
  • DoorMode
  • FanMode
  • LockMode
  • OperatingMode
  • TemperatureMode
  • ThermostatMode
IoTEnumSensorType string

Describes the type of IoT Enum Sensor that the object instance is representing. Enumeration of:

  • AlarmState
  • DoorState
  • FanState
  • LockState
  • OperatingState
  • TemperatureState
  • ThermostatFanState
IoTLevelType string

Describes the type of IoT Level Controller or Sensor that the object instance is representing. Enumeration of:

  • Acceleration
  • Area
  • Battery
  • Brightness
  • Concentration
  • Conductivity
  • Distance
  • Energy
  • Flow
  • Humidity
  • Intensity
  • Luminance
  • Meter
  • Motion
  • Position
  • Power
  • Pressure
  • Radiation
  • Speed
  • Temperature
  • Volume (Amount of space that an object or substance occupies)
  • Weight
IoTUnitType string

Possible Unit types used for decimal values. Enumeration of:

  • - (Dimensionless quantity)
  • % (Percent)
  • deg (Decimal degrees)
  • degC (Celsius)
  • degF (Fahrenheit)
  • K (Kelvin [SI])
  • km (Kilometer [SI])
  • m (Meter [SI])
  • cm (Centimeter [SI])
  • mm (Millimeter [SI])
  • h (Hour)
  • min (Minute)
  • s (Second [SI])
  • ms (Millisecond)
  • sq-km (Square kilometer)
  • sq-m (Square meter)
  • sq-cm (Square cm)
  • cu-m (Cubic meter)
  • l (Liter [SI])
  • cl (Centiliter [SI])
  • ml (Milliliter [SI])
  • kg (Kilogram [SI])
  • g (Gram [SI])
  • mg (Milligram [SI])
  • Wh (Watt hour)
  • kWh (Kilowatt hour)
  • W (Watt [SI])
  • A (Ampere [SI])
  • Hz (Hertz [SI])
  • V (Volt [SI])
  • N (Newton [SI])
  • Pa (Pascal [SI])
  • C (Coulomb [SI])
  • F (Farad [SI])
  • ohm (Ohm [SI])
  • S (Siemens [SI])
  • Wb (Weber [SI])
  • T (Tesla [SI])
  • H (Henry [SI])
  • lm (Lumen [SI])
  • lx (Lux [SI])
  • mps (Meter per second)
  • cd (Candela [SI])
  • mol (Mole [SI])
  • UV (Ultraviolet index)
  • RGB (RGB color, encoded as integer value between 0 (usually represented as 0x000000) and 16777215 (usually represented as 0xFFFFFF), e.g. Blue would be 255 (usually represented as 0x0000FF))
  • ppm (Parts per million (Alternative use percent: 1ppm = 0.0001%))
  • Sv (Sievert (J/kg) [SI])
  • J (Joule [SI])
JSONObject string A JSON Object as defined in [Section 4/RFC7159].
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:2]
  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:2]
  1. The PSM breakpoint sub-carrier index in the range [0:4095], and
  2. the value of the level of the PSM at this sub-carrier expressed in 0.1 dBm/Hz with an offset of -140 dBm/Hz.

Both values are represented as unsignedInt.

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

RangingState string

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

Enumeration of:

  • 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:2]
  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,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:2]

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

URI string(:2048) Uniform Resource Identifier. See [RFC3986].
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)

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-2012_section6] IEEE 802.3-2012 - Section Six, IEEE Standard for Ethernet - Section Six, IEEE, December 2012.
[802.3-2015] IEEE Std 802.3-2015, IEEE Standard for Ethernet, IEEE, 2015.
[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.
[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.
[G.9701] G.9701, Fast access to subscriber terminals (G.fast)- Physical layer specification, ITU-T, 2014.
[G.9807.1] G.9807.1, 10-Gigabit-capable symmetric passive optical network (XGS-PON), ITU-T, June 2016.
[G.984.3] G.984.3, Gigabit-capable passive optical networks (G-PON): Transmission convergence layer specification, ITU-T, January 2010.
[G.987.3] G.987.3, 10-Gigabit-capable passive optical networks (XG-PON): Transmission convergence (TC) layer specification, ITU-T, January 2014.
[G.988] G.988, ONU management and control interface (OMCI) specification, ITU-T, 2010.
[G.989.3] G.989.3, 40-Gigabit-capable passive optical networks (NG-PON2): Transmission convergence layer specification, ITU-T, May 2021.
[G.993.1] G.993.1, Very high speed digital subscriber line transceivers, ITU-T.
[G.993.2] G.993.2, Very high speed digital subscriber line transceivers 2 (VDSL2), ITU-T.
[G.9954] G.9954, Phoneline networking transceivers - Enhanced physical, media access, and link layer specifications (HPNA 3.0 and 3.1), ITU-T, 2007.
[G.996.2] G.996.2, Single-ended line testing for digital subscriber lines (DSL), ITU-T.
[G.9960] G.9960, Unified high-speed wire-line based home networking transceivers - System architecture and physical layer specification, ITU-T.
[G.9961] G.9961, Unified high-speed wire-line based home networking transceivers - Data link layer specification, ITU-T.
[G.9962] G.9962, Unified high-speed wire-line based home networking transceivers - Management specification, ITU-T.
[G.9964] G.9964, Unified high-speed wire-line based home networking transceivers - Power spectral density specification, ITU-T.
[G.997.1] G.997.1, Physical layer management for digital subscriber line (DSL) transceivers, ITU-T.
[G.997.2] G.997.2, Physical layer management for FAST transceivers, ITU-T, 2015.
[G.9973] G.9973, Protocol for identifying home network topology, ITU-T, 2011.
[G.998.1] G.998.1, ATM-based Multi-Pair Bonding, ITU-T, 2005.
[G.998.2] G.998.2, Ethernet-based Multi-Pair Bonding, ITU-T, 2005.
[G.998.3] G.998.3, Multi-Pair Bonding Using Time-Division Inverse Multiplexing, ITU-T, 2005.
[HPAV1.1] HomePlug™ AV Specification, Version 1.1, HomePlug Alliance, 2007.
[HTML4.01] HTML 4.01 Specification, W3C.
[IANA-ipversionnumbers] IANA IP Version Numbers, IP Version Numbers, IANA.
[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.
[IANAMauMIB] IANAMauMIB, IANA-MAU-MIB DEFINITIONS, IANA, 2022.
[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.
[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.
[MQTT311] MQTT Version 3.1.1, MQTT v3.1.1, OASIS Message Queuing Telemetry Transport (MQTT) TC, October 2014.
[MQTT50] MQTT Version 5.0, MQTT Version 5.0, Candidate OASIS Standard 02., OASIS Message Queuing Telemetry Transport (MQTT) TC, February 2019.
[OUI] Organizationally Unique Identifiers (OUIs).
[PCPProxy] RFC 7648, Port Control Protocol (PCP) Proxy Function, IETF, September 2015.
[RED] References on RED (Random Early Detection) Queue Management.
[RFC1035] RFC 1035, Domain Names - Implementation and Specification, IETF, 1987.
[RFC1123] RFC 1123, Requirements for Internet Hosts – Application and Support, IETF, 1989.
[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.
[RFC2397] RFC 2397, The “data” URL scheme, 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.
[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.
[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.
[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.
[RFC4443] RFC 4443, Internet Control Message Protocol (ICMPv6) for the Internet Protocol Version 6 (IPv6) Specification, IETF, March 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.
[RFC5905] RFC 5905, Network Time Protocol Version 4: Protocol and Algorithms Specification, IETF, 2010.
[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.
[RFC7616] RFC 7616, HTTP Digest Access Authentication, IETF, September 2015.
[RFC7617] RFC 7617, The ‘Basic’ HTTP Authentication Scheme, IETF, September 2015.
[RFC7693] RFC 7693, The BLAKE2 Cryptographic Hash and Message Authentication Code (MAC), IETF, November 2015.
[RFC792] RFC 792, Internet Control Message Protocol, IETF, September 1981.
[RFC793] RFC 793, Transmission Control Protocol, IETF, September 1981.
[RFC8141] RFC 8141, Uniform Resource Names (URNs), IETF, April 2017.
[RFC8325] RFC 8325, Mapping Diffserv to IEEE 802.11, IETF, February 2018.
[RFC8349] RFC 8349, A YANG Data Model for Routing Management (NMDA Version), IETF, March 2018.
[RFC862] RFC 862, Echo Protocol, IETF, 1983.
[RFC8822] RFC 8822, 5G Wireless Wireline Convergence User Plane Encapsulation (5WE), IETF, April 2021.
[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.
[RFC9110] RFC 9110, HTTP Semantics, IETF, June 2022.
[RFC9249] RFC 9249, A YANG Data Model for NTP, IETF, July 2022.
[RFC959] RFC 959, File Transfer Protocol, IETF, 1985.
[SFF-8024] SFF-8024, SFF Module Management Reference Code Tables, SNIA, May 2021.
[SFF-8472] SFF-8472, Management Interface for SFP+, SNIA, March 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 1 Corrigendum 1, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, August 2015.
[TR-159] TR-159, Management Framework for xDSL Bonding, Broadband Forum, December 2008.
[TR-181i2] TR-181 Issue 2 Amendment 15, Device Data Model, Broadband Forum, January 2022.
[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 Amendment 2, User Services Platform, Broadband Forum, January 2022.
[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.
[WPA3v3.0] WPA3v3.0, Wi-Fi Protected Access 3 Specification Version 3.0.x, Wi-Fi Alliance.
[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.
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.16 Data Model

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

Name Type Write Description Object Default Version
Device. object R The top-level object for a Device. - 2.0
Root­Data­Model­Version string­(:32) R

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

  • 2.\d+
 - 2.4
Interface­Stack­Number­Of­Entries unsigned­Int R The number of entries in the InterfaceStack table. - 2.0
Proxied­Device­Number­Of­Entries unsigned­Int R The number of entries in the ProxiedDevice table. - 2.12
Collection­Device­Number­Of­Entries unsigned­Int R The number of entries in the CollectionDevice table. - 2.16
Reboot­() command - Reboot the entity associated with the containing Device.. - 2.12
Boot! event - Boot event indicating that the Device. was rebooted. - 2.12
⇒ Command­Key string W The command_key supplied when requesting the boot, or an empty string if the boot was not requested via a USP operation. - 2.12
⇒ Cause string W

The cause of the boot. Enumeration of:

  • LocalReboot (A Device. Event that was the result of a reboot triggered locally on the Device (NOT as a result of a Reboot() Command or other remote trigger, e.g. another remote management protocol))
  • RemoteReboot (A Device. Event that was the result of a reboot triggered via the Reboot() Command or other remote trigger, e.g. another remote management protocol)
  • FactoryReset (A Device. Event that was the result of a factory reset triggered locally on the Device or remotely (as a result of a FactoryReset() Command or other remote trigger, e.g. another remote management protocol), which is to be used when the Agent cannot differentiate between local and remote, added in 2.15)
  • LocalFactoryReset (A Device. Event that was the result of a factory reset triggered locally on the Device (NOT as a result of a FactoryReset() Command or other remote trigger, e.g. another remote management protocol))
  • RemoteFactoryReset (A Device. Event that was the result of a factory reset triggered via the FactoryReset() Command or other remote trigger, e.g. another remote management protocol)
 - 2.12
⇒ Firmware­Updated boolean W true if the firmware was updated as a result of the boot that caused this Event Notification; otherwise false. - 2.12
⇒ Parameter­Map string W

Boot parameters configured via the recipient Controller’s LocalAgent.Controller.{i}.BootParameter table.

Formatted as a [JSONObject] A JSON Object as defined in [Section 4/RFC7159].

 - 2.12
Factory­Reset­() command - Factory reset the entity associated with the containing Device.. - 2.0
Self­Test­Diagnostics­() command - [ASYNC] This diagnostics test is vendor-specific and MAY include testing hardware, software, and/or firmware. - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string W

Indicates the availability of diagnostics data. Enumeration of:

  • Complete
  • Error_Internal
  • Error_Other

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

 - 2.13
⇐ Results string­(:1024) W Results of self-test (vendor specific). - 2.12
Packet­Capture­Diagnostics­() command - [ASYNC] This diagnostic command is used to record packet capture data on a valid (layer 2 or above) interface in libpcap or pcapng format. - 2.13
⇒ Input. arguments - Input arguments. -
⇒ Interface string­(:256) R 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
⇒ Format string R

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
⇒ Duration unsigned­Int­(1:) R 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
⇒ Packet­Count unsigned­Int R 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
⇒ Byte­Count unsigned­Int R 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
⇒ File­Target string­(:2048) R The [URL] specifying the destination file location. The HTTPS transport MUST be supported, and the HTTP transport MAY be supported. Other transports MAY also be supported. - 2.13
⇒ Filter­Expression string­(:256) R A ([BPF]) formatted expression used to restrict the types of network packets that are recorded to FileTarget. - 2.13
⇒ Username string­(:256) R 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
⇒ Password string­(:256) R

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
⇐ Output. arguments - Output arguments. -
⇐ Status string W

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL)
  • Error_Internal
  • Error_Other

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

 - 2.13
⇐ Packet­Capture­Result.­{i}. object(0:) W

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.

This table’s Instance Numbers MUST be 1, 2, 3… (assigned sequentially without gaps).

 - 2.13
⇐ File­Location string­(:2048) W 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
⇐ Start­Time date­Time W The local system time at which the capture was started. - 2.13
⇐ End­Time date­Time W The local system time at which the capture was completed. - 2.13
⇐ Count unsigned­Int W The number of packets recorded to the file target. - 2.13
Schedule­Timer­() command -

[ASYNC] Schedule an async timer operation. A scheduled timer MUST persist across reboots.

NOTE: This command changed from synchronous to asynchronous in version 2.14.

 - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Delay­Seconds unsigned­Int­(1:) R [MANDATORY] The number of seconds from the time this command is invoked until the Agent responds with an OperationComplete Event notification (based on the associated subscriptions). - 2.12
Io­TCapability­Number­Of­Entries unsigned­Int R The number of entries in the IoTCapability table. - 2.13
Node­Number­Of­Entries unsigned­Int R The number of entries in the Node table. - 2.13
Device.­Services. object R This object contains general services information. - 2.0
Device.­Device­Info. object R This object contains general device information. - 2.0
Device­Category string­[] R

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

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

 - 2.8
Manufacturer string­(:64) R The manufacturer of the CPE (human readable string). - 2.0
Manufacturer­OUI string­(6) R

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

  • [0-9A-F]{6}

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

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

Any change would indicate that it’s a new Agent and would therefore require a Boot! Event with a LocalFactoryReset enumerated value in the Boot!.Cause argument.

 - 2.0
CID string­(6) R

Company identifier assigned and registered by the IEEE Registration Authority to the entity responsible for this Agent. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. Possible patterns:

  • [0-9A-F]{6}

This value MUST remain fixed over the lifetime of the Agent, including across firmware updates. Any change would indicate that it’s a new Agent and would therefore require a Boot! Event with a LocalFactoryReset enumerated value in the Boot!.Cause argument.

 - 2.0
Model­Name string­(:64) R Model name of the CPE (human readable string). - 2.0
Model­Number string­(:64) R

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

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

 - 2.8
Description string­(:256) R A full description of the CPE device (human readable string). - 2.0
Product­Class string­(:64) R

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

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

 - 2.0
Serial­Number string­(:64) R

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

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

 - 2.0
Hardware­Version string­(:64) R A string identifying the particular CPE model and version. - 2.0
Software­Version string­(:64) R

A string identifying the software version currently installed in the CPE (i.e. version of the overall CPE firmware).

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

 - 2.0
Active­Firmware­Image string R A full path reference to the row in the FirmwareImage table representing the currently running firmware image. - 2.12
Boot­Firmware­Image 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
Additional­Hardware­Version string­(:64)[] R Comma-separated list (maximum number of characters per item 64) of strings. Each entry is an additional version. Represents any additional hardware version information the vendor might wish to supply. - 2.0
Additional­Software­Version string­(:64)[] R Comma-separated list (maximum number of characters per item 64) of strings. Each entry is an additional version. Represents any additional software version information the vendor might wish to supply. - 2.0
Provisioning­Code string­(:64) W Identifier of the primary service provider and other provisioning information, which MAY be used by the ACS to determine service provider-specific customization and provisioning parameters. - 2.0
Up­Time unsigned­Int R Time in seconds since the CPE was last restarted. - 2.0
First­Use­Date date­Time R

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

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

 - 2.0
Host­Name string­(:255) W The hostname of the device [Section 2 General issues/RFC1123]. This can be either a Fully Qualified Domain Name (FQDN) or just the first component of an FQDN. For example, myhgw, myhgw.home, myhgw.home.arpa, myhgw.isp.net. - 2.16
Firmware­Image­Number­Of­Entries unsigned­Int R The number of entries in the FirmwareImage table. - 2.12
Vendor­Config­File­Number­Of­Entries unsigned­Int R The number of entries in the VendorConfigFile table. - 2.0
Processor­Number­Of­Entries unsigned­Int R The number of entries in the Processor table. - 2.1
Vendor­Log­File­Number­Of­Entries unsigned­Int R The number of entries in the VendorLogFile table. - 2.1
Location­Number­Of­Entries unsigned­Int R The number of entries in the Location table. - 2.4
Device­Image­Number­Of­Entries unsigned­Int R The number of entries in the DeviceImageFile table. - 2.11
Friendly­Name string­(:32) W

The friendly name of the device.

In [TR-369] the friendly name is used during the advertisement of an endpoint - see section IANA-Registered USP Service Names of [TR-369].

 - 2.0
PEN string­(:10) R

Private Enterprise Number assigned and registered by IANA to the entity responsible for this Agent. Represented as a decimal encoding of the IANA-assinged number.

This value MUST remain fixed over the lifetime of the Agent, including across firmware updates. Any change would indicate that it’s a new Agent and would therefore require a Boot! Event with a LocalFactoryReset enumerated value in the Boot!.Cause argument.

 - 2.0
Max­Number­Of­Activate­Time­Windows unsigned­Int­(1:5) R The maximum number of time windows in a FirmwareImage.{i}.Activate() Command that the Device supports. - 2.16
Device.­Device­Info.­Vendor­Config­File.­{i}. object(0:) R

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

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

Whenever the Agent successfully restores a configuration file as a result of the Restore() Command, the Agent MUST update this Object.

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

 - 2.0
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.0
Name string­(:64) R

Name of the vendor configuration file.

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

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

Otherwise, the value of this parameter MUST be set to the value of the Command input argument Restore().Input.TargetFileName used to restore this configuration file.

 - 2.0
Version string­(:16) R

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

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

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

 - 2.0
Date date­Time R Date and time when the content of the current version of this vendor configuration file was first applied by the CPE. - 2.0
Description string­(:256) R A description of the vendor configuration file (human-readable string). - 2.0
Use­For­Backup­Restore boolean R

When true, this parameter indicates that this Device.DeviceInfo.VendorConfigFile.{i}. instance is to be used for backup and restoration purposes.

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

 - 2.7
Backup­() command -

[ASYNC] This command is issued to upload the configuration file specified by this Device.DeviceInfo.VendorConfigFile.{i}. instance.

All results of the actual upload will be contained within the LocalAgent.TransferComplete! event.

 - 2.12
⇒ Input. arguments - Input arguments. -
⇒ URL string­(:2048) R

[MANDATORY] The [URL] specifying the destination file location. The HTTPS transport MUST be supported, and the HTTP transport MAY be supported.

This argument specifies only the destination file location, and does not indicate in any way the name or location of the local file to be uploaded.

If the Agent receives multiple upload requests with the same URL, the Agent MUST perform each upload as requested, and MUST NOT assume that the content of the file to be uploaded is the same each time.

This URL MUST NOT include the “userinfo” component, as defined in [RFC3986].

 - 2.12
⇒ Username string­(:256) R [MANDATORY] Username to be used by the Agent to authenticate with the file server. This string is set to an empty string if no authentication is required. - 2.12
⇒ Password string­(:256) R [MANDATORY] Password to be used by the Agent to authenticate with the file server. This string is set to an empty string if no authentication is required. - 2.12
Restore­() command -

[ASYNC] This command is issued to download a configuration file into this Device.DeviceInfo.VendorConfigFile.{i}. instance.

All results of the actual download will be contained within the LocalAgent.TransferComplete! event.

 - 2.12
⇒ Input. arguments - Input arguments. -
⇒ URL string­(:2048) R

[MANDATORY] The [URL] specifying the source file location. The HTTPS transport MUST be supported, and the HTTP transport MAY be supported.

If the Agent receives multiple download requests with the same source URL, the Agent MUST perform each download as requested, and MUST NOT assume that the content of the file to be downloaded is the same each time.

This URL MUST NOT include the “userinfo” component, as defined in [RFC3986].

 - 2.12
⇒ Username string­(:256) R [MANDATORY] Username to be used by the Agent to authenticate with the file server. This string is set to an empty string if no authentication is required. - 2.12
⇒ Password string­(:256) R [MANDATORY] Password to be used by the Agent to authenticate with the file server. This string is set to an empty string if no authentication is required. - 2.12
⇒ File­Size unsigned­Int R

The size of the file to be downloaded in bytes.

The FileSize argument is intended as a hint to the Agent, which the Agent MAY use to determine if it has sufficient space for the file to be downloaded, or to prepare space to accept the file.

The Controller MAY set this value to zero. The Agent MUST interpret a zero value to mean that that the Controller has provided no information about the file size. In this case, the Agent MUST attempt to proceed with the download under the presumption that sufficient space is available, though during the course of download, the Agent might determine otherwise.

The Controller SHOULD set the value of this Parameter to the exact size of the file to be downloaded. If the value is non-zero, the Agent MAY reject the ScheduleDownload request on the basis of insufficient space.

If the Agent attempts to proceed with the download based on the value of this argument, but the actual file size differs from the value of this argument, this could result in a failure of the download. However, the Agent MUST NOT cause the download to fail solely because it determines that the value of this argument is inaccurate.

 - 2.12
⇒ Target­File­Name string­(:256) R

The name of the file to be used on the target file system. This argument MAY be an empty string if the target file name can be extracted from the downloaded file itself, or from the URL argument, or if no target file name is needed.

If this argument is specified, but the target file name is also indicated by another source (for example, if it is extracted from the downloaded file itself), this argument MUST be ignored.

If the target file name is used, the downloaded file would replace any existing file of the same name (whether or not the Agent archives the replaced file is a local matter).

If present, this Parameter is treated as an opaque string with no specific requirements for its format. That is, the TargetFileName value is to be interpreted based on the Agent’s vendor-specific file naming conventions.

Note that this specification does not preclude the use of a file naming convention in which the file’s path can be specified as part of the file name.

 - 2.12
⇒ Check­Sum­Algorithm string R

The hash algorithm to use when performing a checksum validation of the downloaded file.

If the CheckSum input argument is specified, the Agent MUST validate the integrity of the downloaded file by comparing the value contained in the CheckSum input argument against a hash of the downloaded file. Enumeration of:

  • SHA-1 (As specified in [RFC3174])
  • SHA-224 (As specified in [RFC6234])
  • SHA-256 (As specified in [RFC6234])
  • SHA-384 (As specified in [RFC6234])
  • SHA-512 (As specified in [RFC6234])
 - 2.12
⇒ Check­Sum hex­Binary R

The hash value of the downloaded file used to validate the integrity of the downloaded file.

If this argument is specified, the Agent MUST validate the integrity of the downloaded file by comparing the provided value against a hash of the downloaded file using the hashing algorithm specified in the CheckSumAlgorithm input argument.

If this argument is an empty string, the Agent MUST NOT perform a checksum validation of the downloaded file.

 - 2.12
Device.­Device­Info.­Memory­Status. object R Status of the device’s physical memory. - 2.0
Total unsigned­Int R The total physical volatile RAM, in KiB, installed on the device. - 2.0
Free unsigned­Int R The free physical volatile RAM, in KiB, currently available on the device. - 2.0
Total­Persistent unsigned­Int R 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
Free­Persistent unsigned­Int R 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
Device.­Device­Info.­Process­Status. object R Status of the processes on the device. - 2.0
CPUUsage unsigned­Int­(:100) R The total amount of the CPU, in percent, rounded up to the nearest whole percent. In the case that multiple CPU are present, this value represents the average of all CPU. - 2.0
Process­Number­Of­Entries unsigned­Int R The number of entries in the Process table. - 2.0
Device.­Device­Info.­Process­Status.­Process.­{i}. object(0:) R

List of all processes running on the device.

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

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

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

  • Running
  • Sleeping
  • Stopped
  • Idle (OPTIONAL)
  • Uninterruptible (OPTIONAL)
  • Zombie (OPTIONAL)
 - 2.0
Device.­Device­Info.­Temperature­Status. object R Status of the temperature of the device. - 2.0
Temperature­Sensor­Number­Of­Entries unsigned­Int R The number of entries in the TemperatureSensor table. - 2.0
Device.­Device­Info.­Temperature­Status.­Temperature­Sensor.­{i}. object(0:) R

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

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

 - 2.0
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

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

The status of this temperature sensor. Enumeration of:

  • Disabled (The sensor is not currently sampling the temperature)
  • Enabled (The sensor is currently sampling the temperature)
  • Error (The sensor error currently prevents sampling the temperature)
 - 2.0
Reset­() command - Resets the temperature sensor. - 2.12
Reset­Time date­Time R

The time at which this temperature sensor was reset.

Reset can be caused by:

  • Status transition from Disabled to Enabled
  • Reset() command is invoked.
  • 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
Name string­(:256) R Name of this temperature sensor. This text MUST be sufficient to distinguish this temperature sensor from other temperature sensors. - 2.0
Value int­(-­274:) R

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

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

 - 2.0
Last­Update date­Time R

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
Min­Value int­(-­274:) R

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

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

 - 2.0
Min­Time date­Time R

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
Max­Value int­(-­274:) R

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

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

 - 2.0
Max­Time date­Time R

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
Low­Alarm­Value 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
Low­Alarm­Time date­Time R

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

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

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

 - 2.0
High­Alarm­Value 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
Polling­Interval unsigned­Int W

The interval, measured in seconds, in which the device polls this Device.DeviceInfo.TemperatureStatus.TemperatureSensor.{i}..

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
High­Alarm­Time date­Time R

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

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

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

 - 2.0
Device.­Device­Info.­Network­Properties. object R This object defines the parameters that describe how the device handles network traffic. - 2.0
Max­TCPWindow­Size unsigned­Int R The maximum number of bytes of outstanding data a sender can send on a particular connection prior to an acknowledgment [RFC793]. Any scaling factor SHOULD be included in this parameter [RFC1323]. - 2.0
TCPImplementation string­[] R

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

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

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

 - 2.0
Device.­Device­Info.­Processor.­{i}. object(0:) R

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

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

 - 2.1
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.3
Architecture string R

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

  • arm
  • i386
  • m68010
  • m68k
  • mipseb (big-endian)
  • mipsel (little-endian)
  • powerpc
  • sh3eb (big-endian)
  • sh3el (little-endian)
  • x86_64

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

 - 2.1
Device.­Device­Info.­Vendor­Log­File.­{i}. object(0:) R

Each table entry represents a Vendor Log File.

This table of log files is informational only and does not allow the 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
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.1
Name string­(:64) R

Name of the log file.

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

 - 2.1
Maximum­Size unsigned­Int R The maximum size of the log file in bytes. If the device doesn’t know the maximum file size then MaximumSize will be 0. - 2.1
Persistent boolean R

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

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

 - 2.1
Upload­() command -

[ASYNC] This command is issued to upload the log file specified by this Vendor Log File instance.

All results of the actual upload will be contained within the LocalAgent.TransferComplete! event.

 - 2.12
⇒ Input. arguments - Input arguments. -
⇒ URL string­(:2048) R

[MANDATORY] The [URL] specifying the destination file location. The HTTPS transport MUST be supported, and the HTTP transport MAY be supported.

This argument specifies only the destination file location, and does not indicate in any way the name or location of the local file to be uploaded.

If the Agent receives multiple upload requests with the same URL, the Agent MUST perform each upload as requested, and MUST NOT assume that the content of the file to be uploaded is the same each time.

This URL MUST NOT include the “userinfo” component, as defined in [RFC3986].

 - 2.12
⇒ Username string­(:256) R [MANDATORY] Username to be used by the Agent to authenticate with the file server. This string is set to an empty string if no authentication is required. - 2.12
⇒ Password string­(:256) R [MANDATORY] Password to be used by the Agent to authenticate with the file server. This string is set to an empty string if no authentication is required. - 2.12
Device.­Device­Info.­Location.­{i}. object(0:) W

This object contains Location information.

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

 - 2.4
Source string R

Identifies the source of the location data. Enumeration of:

  • GPS
  • AGPS
  • Manual
  • External
 External 2.4
Acquired­Time date­Time R The time when the location was acquired. - 2.4
External­Source string R

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

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

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

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

 - 2.4
External­Protocol string R

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

  • <Empty> (An empty string)
  • CWMP
  • USP (Added in 2.13)
  • OMA-DM
  • SNMP
  • UPnP
  • HELD
  • DHCPv4
  • DHCPv6
  • LLDP-MED
  • MLP
  • Other

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

 CWMP 2.4
Data­Object 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
Device.­Device­Info.­Device­Image­File.­{i}. object(0:) R

This object describes an image of the device.

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

 - 2.11
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.11
Location string R

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

  • Front
  • Back
  • Left
  • Right
  • Top
  • Bottom
 - 2.11
Image base­64 R The device image in PNG, JPEG or GIF format. - 2.11
Device.­Device­Info.­Firmware­Image.­{i}. object(0:) R

Top-level object for mapping firmware images.

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

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

 - 2.12
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.12
Name string­(:64) R

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

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

 - 2.12
Version string­(:64) R

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

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

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

 - 2.12
Available boolean W

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

This value MUST be set to true 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
Status string R

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

  • NoImage (This Firmware Image instance is empty. This value could happen on an Agent that supports multiple firmware images, but only has a single image installed)
  • Active (This Firmware Image instance is the currently active image, added in 2.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
Boot­Failure­Log string R

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

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

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

 - 2.12
Download­() command -

[ASYNC] This command is issued to download a firmware into this Firmware Image instance.

All results of the actual download will be contained within the LocalAgent.TransferComplete! event.

 - 2.12
⇒ Input. arguments - Input arguments. -
⇒ URL string­(:2048) R

[MANDATORY] The [URL] specifying the source file location. The HTTPS transport MUST be supported, and the HTTP transport MAY be supported.

If the Agent receives multiple download requests with the same source URL, the Agent MUST perform each download as requested, and MUST NOT assume that the content of the file to be downloaded is the same each time.

This URL MUST NOT include the “userinfo” component, as defined in [RFC3986].

 - 2.12
⇒ Auto­Activate boolean R

[MANDATORY] If true the Agent MUST automatically activate the firmware once it is successfully downloaded.

If false the Agent MUST NOT activate the firmware until explicitly instructed to do so by either invoking Activate() or setting BootFirmwareImage and rebooting the Agent.

 - 2.12
⇒ Username string­(:256) R Username to be used by the Agent to authenticate with the file server. This argument is omitted if no authentication is required. - 2.12
⇒ Password string­(:256) R Password to be used by the Agent to authenticate with the file server. This argument is omitted if no authentication is required. - 2.12
⇒ File­Size unsigned­Int R

The size of the file to be downloaded in bytes.

The FileSize argument is intended as a hint to the Agent, which the Agent MAY use to determine if it has sufficient space for the file to be downloaded, or to prepare space to accept the file.

The Controller MAY set this value to zero. The Agent MUST interpret a zero value to mean that that the Controller has provided no information about the file size. In this case, the Agent MUST attempt to proceed with the download under the presumption that sufficient space is available, though during the course of download, the Agent might determine otherwise.

The Controller SHOULD set the value of this Parameter to the exact size of the file to be downloaded. If the value is non-zero, the Agent MAY reject the ScheduleDownload request on the basis of insufficient space.

If the Agent attempts to proceed with the download based on the value of this argument, but the actual file size differs from the value of this argument, this could result in a failure of the download. However, the Agent MUST NOT cause the download to fail solely because it determines that the value of this argument is inaccurate.

 - 2.12
⇒ Check­Sum­Algorithm string R

The hash algorithm to use when performing a checksum validation of the downloaded file.

If the CheckSum input argument is specified, the Agent MUST validate the integrity of the downloaded file by comparing the value contained in the CheckSum input argument against a hash of the downloaded file. Enumeration of:

  • SHA-1 (As specified in [RFC3174])
  • SHA-224 (As specified in [RFC6234])
  • SHA-256 (As specified in [RFC6234])
  • SHA-384 (As specified in [RFC6234])
  • SHA-512 (As specified in [RFC6234])
 - 2.12
⇒ Check­Sum hex­Binary R

The hash value of the downloaded file used to validate the integrity of the downloaded file.

If this argument is specified, the Agent MUST validate the integrity of the downloaded file by comparing the provided value against a hash of the downloaded file using the hashing algorithm specified in the CheckSumAlgorithm input argument.

If this argument is an empty string, the Agent MUST NOT perform a checksum validation of the downloaded file.

 - 2.12
Activate­() command -

[ASYNC] This command is issued to activate this Device.DeviceInfo.FirmwareImage.{i}. instance.

A Device.DeviceInfo.FirmwareImage.{i}. instance can also be activated by setting the BootFirmwareImage parameter and causing the Agent to reboot.

A successful activation will result in a reboot of the device with this Device.DeviceInfo.FirmwareImage.{i}. as the currently running firmware image. Furthermore, this Device.DeviceInfo.FirmwareImage.{i}. will be referenced by the ActiveFirmwareImage parameter.

A failed activation will result in this Device.DeviceInfo.FirmwareImage.{i}. instance’s BootFailureLog being updated.

 - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Time­Window.­{i}. object(1:5) R

The time window(s) that dictate when the Agent activates the firmware image.

An Agent MUST be able to accept a request with either one or two TimeWindow.{i}. instances.

The time windows MUST NOT overlap, i.e. if there are two time windows, the second window’s Start value has to be greater than or equal to the first window’s End value.

This table MUST contain at least 1 and at most 5 entries. This table’s Instance Numbers MUST be 1, 2, 3… (assigned sequentially without gaps).

 - 2.12
⇒ Start unsigned­Int R [MANDATORY] Start of this time window as an offset in seconds after invoking the command. An offset is used in order to avoid a dependence on absolute time. - 2.12
⇒ End unsigned­Int R [MANDATORY] End of this time window as an offset in seconds after invoking the command. An offset is used in order to avoid a dependence on absolute time. - 2.12
⇒ Mode string R

[MANDATORY] Specifies when within this time window the Agent is permitted to activate the specified firmware image. Enumeration of:

  • AnyTime (The Agent MAY activate the firmware image at any time during the time window even if this results in interruption of service for the subscriber)
  • Immediately (The Agent MUST activate the firmware image immediately at the start of the time window even if this results in interruption of service for the subscriber)
  • WhenIdle (The Agent MUST NOT cause an interruption of service from the subscriber’s standpoint while activating the firmware image during the time window. How the Agent determines this is outside the scope of this specification)
  • ConfirmationNeeded (The Agent MUST ask for and receive confirmation before activating the firmware image. It is outside the scope of this specification how the Agent asks for and receives this confirmation. If confirmation is not received, this time window MUST NOT be used)
 - 2.12
⇒ User­Message string R

A message that informs the user of a request to activate a new firmware image.

The Agent MAY use this message when seeking confirmation from the user, e.g. when Mode is ConfirmationNeeded.

When there is no need for such a message, it SHOULD be an empty string and MUST be ignored.

 - 2.12
⇒ Max­Retries int­(-­1:10) R

The maximum number of retries for activating the firmware image before regarding the transfer as having failed. Refers only to this time window (each time window can specify its own value).

A value of 0 means “No retries are permitted”. A value of -1 means “the Agent determines the number of retries”, i.e. that the Agent can use its own retry policy, not that it has to retry forever.

Only applicable when the Mode input argument is ConfirmationNeeded, otherwise this input argument MUST be ignored.

 - 2.12
Device.­Time. object R

This object contains global parameters relating to the NTP time clients and or servers that are active in the device. This object can be used to model SNTP and NTP clients and servers.

Both NTP and SNTP have identical packet formats and use the same mathematical operations to calculate client time, clock offset, and roundtrip delay. From the perspective of an NTP or SNTP server, there is no difference between NTP and SNTP clients, and from the perspective of an NTP or SNTP client, there is no difference between NTP and SNTP servers. SNTP servers are stateless like NTP servers in non-symmetric modes and can handle numerous clients, but SNTP clients usually operate with only one server at a time, unlike most NTP clients.

 - 2.0
Enable boolean W Enables or disables all the time clients and servers. - 2.0
Status string R

Reflects the global time synchronisation status of the CPE. Enumeration of:

  • Disabled (Indicates that the CPE’s time client services are disabled)
  • Unsynchronized (Indicates that the CPE’s absolute time has not yet been set by any of the configured time clients)
  • Synchronized (Indicates that the CPE has acquired accurate absolute time; its current time is accurate. One or more time client was able to configure the time of the CPE)
  • Error_FailedToSynchronize (This enumeration was DEPRECATED in 2.16 due to the introduction of Client)
  • Error (MAY be used by the CPE to indicate a locally defined error condition. None of the configured Time clients were able to synchronize the time, OPTIONAL)
 - 2.0
NTPServer­1 string­(:64) W
First NTP timeserver. Either a host name or IP address.
This parameter was DEPRECATED in 2.16 due to the introduction of Client.
 - 2.0
NTPServer­2 string­(:64) W
Second NTP timeserver. Either a host name or IP address.
This parameter was DEPRECATED in 2.16 due to the introduction of Client.
 - 2.0
NTPServer­3 string­(:64) W
Third NTP timeserver. Either a host name or IP address.
This parameter was DEPRECATED in 2.16 due to the introduction of Client.
 - 2.0
NTPServer­4 string­(:64) W
Fourth NTP timeserver. Either a host name or IP address.
This parameter was DEPRECATED in 2.16 due to the introduction of Client.
 - 2.0
NTPServer­5 string­(:64) W
Fifth NTP timeserver. Either a host name or IP address.
This parameter was DEPRECATED in 2.16 due to the introduction of Client.
 - 2.0
Current­Local­Time date­Time R The current date and time in the CPE’s local time zone. - 2.0
Local­Time­Zone 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
Client­Number­Of­Entries unsigned­Int R The number of entries in the Client table. - 2.16
Server­Number­Of­Entries unsigned­Int R The number of entries in the Server table. - 2.16
Device.­Time.­Client.­{i}. object(0:) W

This object contains parameters relating to an time client instance.

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

 - 2.16
Enable boolean W Enables or disables the time client. - 2.16
Status string R

Status of Time support for this client. Enumeration of:

  • Disabled (Indicates that the time client service is being disabled)
  • Unsynchronized (Indicates that the time client absolute time has not yet been set)
  • Synchronized (Indicates that the time client has acquired accurate absolute time; its current time is accurate)
  • Error (MAY be used by the time client to indicate a locally defined error condition, OPTIONAL)
 - 2.16
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.16
Mode string W

Specifies in which mode the NTP client must be run. Enumeration of:

  • Unicast (Support for the NTP client in unicast mode)
  • Broadcast (Support for the NTP client in broadcast mode)
  • Multicast (Support for the NTP client in multicast mode)
  • Manycast (Support for the NTP client in manycast mode)
 - 2.16
Port unsigned­Int­(1:65535) W Specify the port used to send NTP packets. [Section 7.2/RFC5905] 123 2.16
Version unsigned­Int­(1:4) W Specifies the supported NTP version. Possible versions are 1-4. 4 2.16
Servers string­[] W Comma-separated list of strings. Points to a CSV list of NTP servers or pools. A NTP server can either be specified as an IP address or a host name. It is expected that the NTP client resolves multiple addresses which can change over time when ResolveAddresses is enabled. 2.16
Resolve­Addresses boolean W When this option is enabled the NTP client must resolve the multiple addresses associated with the host name(s) that are specified in the Servers field. false 2.16
Resolve­Max­Addresses unsigned­Int W When ResolveAddresses is enabled, This parameter specifies the maxium number of IP addresses that the NTP client can resolve. 0 means that all addresses must be resolved. 6 2.16
Peer boolean W Use symmetric active association mode. This device may provide synchronization to the configured NTP server. - 2.16
Min­Poll unsigned­Int W This is the minimum polling interval, in seconds to the power of two, allowed by any peer of the Internet system, currently set to 6 (64 seconds). [Section 7.2/RFC5905] 6 2.16
Max­Poll unsigned­Int W This is the maximum polling interval, in seconds to the power of two, allowed by any peer of the Internet system, currently set to 10 (1024 seconds) [Section 7.2/RFC5905] 10 2.16
IBurst boolean W If the IBurst parameter is enabled, and this is the first packet sent when the server has been unreachable, the client sends a burst. This is useful to quickly reduce the synchronization distance below the distance threshold and synchronize the clock. [RFC5905]. - 2.16
Burst unsigned­Int W If the Burst parameter is enabled and the server is reachable and a valid source of synchronization is available, the client sends a burst of BCOUNT (8) packets at each poll interval. The interval between packets in the burst is two seconds. This is useful to accurately measure jitter with long poll intervals. [RFC5905]. 8 2.16
Interface string­(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The IP Interface associated with the Client entry. 2.16
Bind­Type string W

Specifies how the client sockets are bound. Enumeration of:

  • Address (The client sockets are bound to a local IP address)
  • Device (The client sockets are bound to a network device. This can be useful when the local address is dynamic)
 - 2.16
Device.­Time.­Client.­{i}.­Authentication. object R This object contains parameters relating to enabling security for the time client. - 2.16
Enable boolean W Enables or disables authentication of the time client. false 2.16
Certificate string W The value MUST be the Path Name of a row in the Security.Certificate. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Points to the certificate that must be used by the NTS-KE client. 2.16
NTSPort unsigned­Int­(1:65535) W On this port the NTS Key Establishment protocol is being provided. 4460 2.16
Device.­Time.­Client.­{i}.­Stats. object R This object specifies the statistic parameters for the time client. [Chapter 8 NTP Yang Module/RFC9249] - 2.16
Packets­Sent unsigned­Int R [StatsCounter32] Specifies the number of packets that have been successfully sent from the NTP client to the NTP server. - 2.16
Packets­Sent­Failed unsigned­Int R [StatsCounter32] Specifies the number of packets that were not successfully sent to the NTP server. - 2.16
Packets­Received unsigned­Int R [StatsCounter32] Specifies the number of packets that have been successfully received by the NTP client from the NTP server. - 2.16
Packets­Dropped unsigned­Int R [StatsCounter32] Specifies the number of packets that were received by the NTP client but were not successfully processed or handled due to errors or other issues. - 2.16
Device.­Time.­Server.­{i}. object(0:) W

This object contains parameters relating to an time server instance.

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

 - 2.16
Enable boolean W Enables or disables the time server. - 2.16
Status string R

Status of Time server instance. Enumeration of:

  • Up (Indicates that the NTP server instance is enabled and working)
  • Down (Indicates that the NTP server instance is disabled and thus not working)
  • Error (MAY be used by the NTP server instance to indicate a locally defined error condition, OPTIONAL)
 - 2.16
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.16
Mode string W

Specifies in which mode the NTP server must be ran. Enumeration of:

  • Unicast (Support for the NTP server in unicast mode)
  • Broadcast (Support for the NTP server in broadcast mode)
  • Multicast (Support for the NTP server in multicast mode)
  • Manycast (Support for the NTP server in manycast mode)
 - 2.16
Version unsigned­Int­(1:4) W Specifies the supported NTP version. Possible versions are 1-4. 4 2.16
Port unsigned­Int­(1:65535) W Specify the port used to receive NTP packets. [Section 7.2/RFC5905] 123 2.16
Interface string­(:256) W The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The IP Interface associated with the Server entry. 2.16
Bind­Type string W

Specifies how the client sockets must be bounded. Enumeration of:

  • Address (The server sockets are bound to a local IP address)
  • Device (The server sockets are bound to a network device. This can be useful when the local address is dynamic)
 - 2.16
Min­Poll unsigned­Int W This is the minimum polling interval, in seconds to the power of two, allowed by any peer of the Internet system, currently set to 6 (64 seconds). [Section 7.2/RFC5905] 6 2.16
Max­Poll unsigned­Int W This is the maximum polling interval, in seconds to the power of two, allowed by any peer of the Internet system, currently set to 10 (1024 seconds) [Section 7.2/RFC5905] 10 2.16
TTL unsigned­Int­(1:255) W Specifies the time to live (TTL) for a broadcast/multicast packet. [Section 3.1/RFC5905] 255 2.16
Device.­Time.­Server.­{i}.­Authentication. object R This object contains parameters relating to enabling security for the NTP Server. - 2.16
Enable boolean W Enables or disables authentication of the NTP server. false 2.16
Certificate string W The value MUST be the Path Name of a row in the Security.Certificate. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Points to the certificate that must be used by the NTS-KE client. 2.16
NTSNTPServer string­[] W Comma-separated list of strings. Points to a CSV list of NTP servers. A NTP server can either be specified as an IP address or a host name. When used the NTS-KE server will tell the remote NTS-KE client the NTP hostname or address of the NTP server(s) that should be used. This allows to seperate the NTP server and NTS-KE server implementation. 2.16
Device.­Time.­Server.­{i}.­Stats. object R This object specifies the statistic parameters for the NTP server. [Chapter 8 NTP Yang Module/RFC9249] - 2.16
Packets­Sent unsigned­Int R [StatsCounter32] Specifies the number of packets that have been successfully sent from the NTP server to the NTP client. - 2.16
Packets­Sent­Failed unsigned­Int R [StatsCounter32] Specifies the number of packets that were not successfully sent to the NTP client. - 2.16
Packets­Received unsigned­Int R [StatsCounter32] Specifies the number of packets that have been successfully received by the NTP server from a NTP client. - 2.16
Packets­Dropped unsigned­Int R [StatsCounter32] Specifies the number of packets that were received by the NTP server but were not successfully processed or handled due to errors or other issues. - 2.16
Device.­User­Interface. object R This object contains parameters relating to the user interface of the CPE. - 2.0
Enable boolean W

Enables and disables the CPE’s user interface.

The factory default value MUST be true.

 - 2.11
Password­Required 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
Password­User­Selectable 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
Password­Reset­() command -

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

Reset LANConfigSecurity.ConfigPassword to its factory value.

 - 2.12
Upgrade­Available boolean W Indicates that a CPE upgrade is available, allowing the CPE to display this information to the user. - 2.0
Warranty­Date date­Time W Indicates the date and time in UTC that the warranty associated with the CPE is to expire. - 2.0
ISPName string­(:64) W The name of the customer’s ISP. - 2.0
ISPHelp­Desk string­(:32) W The help desk phone number of the ISP. - 2.0
ISPHome­Page string­(:2048) W The [URL] of the ISP’s home page. - 2.0
ISPHelp­Page string­(:2048) W The [URL] of the ISP’s on-line support page. - 2.0
base­64(0:4095) W Base64 encoded GIF or JPEG image. The binary image is constrained to 4095 bytes or less. - 2.0
ISPLogo­Size unsigned­Int­(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
ISPMail­Server string­(:2048) W The [URL] of the ISP’s mail server. - 2.0
ISPNews­Server string­(:2048) W The [URL] of the ISP’s news server. - 2.0
Text­Color hex­Binary­(3) W The color of text on the GUI screens in RGB hexadecimal notation (e.g., FF0088). - 2.0
Background­Color hex­Binary­(3) W The color of the GUI screen backgrounds in RGB hexadecimal notation (e.g., FF0088). - 2.0
Button­Color hex­Binary­(3) W The color of buttons on the GUI screens in RGB hexadecimal notation (e.g., FF0088). - 2.0
Button­Text­Color hex­Binary­(3) W The color of text on buttons on the GUI screens in RGB hexadecimal notation (e.g., FF0088). - 2.0
Auto­Update­Server string­(:256) W The server the CPE can check to see if an update is available for direct download to it. - 2.0
User­Update­Server string­(:256) W The server where a user can check via a web browser if an update is available for download to a PC. - 2.0
Available­Languages string­(:256)[] R Comma-separated list (maximum number of characters per item 256) of strings. List items represent user-interface languages that are available, where each language is specified according to [RFC3066]. - 2.0
Current­Language 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
HTTPAccess­Supported­Protocols string­[] R

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

 - 2.16
HTTPAccess­Number­Of­Entries unsigned­Int R The number of entries in the HTTPAccess table. - 2.16
Device.­User­Interface.­HTTPAccess.­{i}. object(0:) W

HTTPAccess is used for modeling the different web interfaces that may be either localy or remotely available in the device. For example with Software Modules it is possible to install multiple services that embed a web interface like a Video service or Photo service.

An instance of the Device.UserInterface.HTTPAccess.{i}. can model a web interface that is embedded in the device firmware or installed through a Software Modules management system.

Access to the web interface MAY require user authentication. To have access authentication the device MUST support a Users.User. object with at least one instance and an assigned relevant role in Users.User.{i}.RoleParticipation.

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

 - 2.16
Enable boolean W Enables/disables web interface. - 2.16
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.16
Order unsigned­Int­(1:) W

Position of the Device.UserInterface.HTTPAccess.{i}. entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each incoming connection, the highest ordered entry that matches the Host: HTTP header and path prefix is applied. All lower Order entries are ignored. When this value is set, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value.

A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction.

 - 2.16
Status string R

Status of web interface. Enumeration of:

  • Up (Indicates that the web interface is enabled and working)
  • Down (Indicates that the web interface is disabled and thus not working)
  • Error (MAY be used by the web interface to indicate a locally defined error condition, OPTIONAL)
 - 2.16
Access­Type string W

This parameter describes the possible access types. Enumeration of:

  • RemoteAccess (Indicates that the web interface should be used for remote access. Remote access is defined as any entity not on a local subnet attempting to connect to the device)
  • LocalAccess (Indicates that the web interface should be used for local access)
 Local­Access 2.16
Allowed­Roles string­(:256)[] W Comma-separated list of strings (maximum number of characters per item 256). Each list item MUST be the Path Name of a row in the Users.Role. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Only allow users, defined in Users.User., to access the web instance represented by this Device.UserInterface.HTTPAccess.{i}. instance that have the following roles assigned that are defined in Users.Role.. 2.16
Certificate string W The value MUST be the Path Name of a row in the Security.Certificate. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Points to the server certificate to be presented by the web interface. Only required when Protocol is set to HTTPS. 2.16
CACertificate string W The value MUST be the Path Name of a row in the Security.Certificate. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Points to the CA certificate that must be used by the web interface. The CACertificate is used to validate the web client certificate. Protocol MUST be set to HTTPS. 2.16
Interface string­(:256) W

The value MUST be the Path Name of a table row. The IP or Logical Interface associated with the Device.UserInterface.HTTPAccess.{i}. entry. Example:

  • Device.IP.Interface.1.
  • Device.Logical.Interface.1.

If the value is an empty string, the CPE MUST use its routing policy (IP Forwarding table entries), if necessary, to determine the appropriate interface.

 2.16
Port unsigned­Int­(1:65535) W Listen port number. 443 2.16
Protocol string R The value MUST be a member of the list reported by the HTTPAccessSupportedProtocols parameter. Protocol being used. - 2.16
Allowed­Hosts string­[] W

Comma-separated list of strings. Specifies which hostnames are permitted to be served by the web interface.

This could be done by comparing the Host: HTTP header in an incoming request which will result in the request being routed to this instance, in the case that the device supports Virtual Hosting.

If this string is empty then this instance acts as a “default” host, i.e. it will handle requests for which the Host header does not match any other instance.

 - 2.16
Allowed­Path­Prefixes string­[] W Comma-separated list of strings. Each string must be a partial path which will result in an incoming request being routed to this instance. / 2.16
Auto­Disable­Duration unsigned­Int W

Indicates in seconds when the web interface will be automatically disabled. When 0 is specified, the web interface will not be automatically disabled.

For example if the web interface is to be active for only 30 minutes, then this parameter would be set to 1800 seconds.

 0 2.16
Time­Left unsigned­Int R

The number of seconds remaining before the web interface will be disabled. 0 means that the web interface is disabled or no AutoDisableDuration was specified.

Example: The AutoDisableDuration parameter has been set to 1800 seconds and the web interface was enabled 600 seconds ago. This means that the TimeLeft will return 1200 seconds, which is the remaining time before the web interface will be disabled.

 - 2.16
Activation­Date date­Time R Indicates when the web interface was enabled. - 2.16
Session­Number­Of­Entries unsigned­Int R The number of entries in the Session table. - 2.16
Create­Web­Session­() command - This command creates a time-limited web session. The web session will be terminated when the life time of the session exceeds AbsoluteTimeout or when no data is transmitted or received for IdleTimeout. - 2.16
⇒ Input. arguments - Input arguments. -
⇒ Absolute­Timeout unsigned­Int R AbsoluteTimeout in seconds specifies the amount of time that a session is may be active. When 0 is specified this feature is disabled. - 2.16
⇒ Idle­Timeout unsigned­Int R IdleTimeout in seconds specifies the amount of time that a session may be idle before it is automatically terminated. When 0 is specified this feature is disabled. - 2.16
⇐ Output. arguments - Output arguments. -
⇐ Session­ID string­(:4096) W [MANDATORY] Session identifier. - 2.16
⇐ Path string W Absolute path component as defined in [Section 3.3/RFC3986] that can be used to access the session on the web interface. - 2.16
Device.­User­Interface.­HTTPAccess.­{i}.­Session.­{i}. object(0:) W

Web server session list.

At most one entry in this table can exist with a given value for SessionID. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for SessionID such that the new entry does not conflict with any existing entries.

 - 2.16
Session­ID string­(:4096) R

Session identifier.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.16
User string­(:256) W The value MUST be the Path Name of a row in the Users.User. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The user to whom the session belongs. When the user is unknown an empty string string SHOULD be used. 2.16
IPAddress string­(:45) R [IPAddress] The IP address of the remote web client, connected to the web interface. - 2.16
Port unsigned­Int­(1:65535) R Port number of the remote web client, connected to the web interface. - 2.16
Protocol string R The value MUST be a member of the list reported by the HTTPAccessSupportedProtocols parameter. Protocol being used. - 2.16
Start­Date date­Time R Indicates when the session was created. - 2.16
Delete­() command - This terminates an active session ahead of any configured timeouts. - 2.16
Device.­User­Interface.­Remote­Access. object R
This object contains parameters relating to remotely accessing the CPE’s user interface.
Remote access is defined as any entity not of a local subnet attempting to connect to the CPE.
Remote access requires user authentication. To provide remote access authentication the CPE MUST support a “User” table with at least one instance that has “RemoteAccessCapable” set to true.
This object was DEPRECATED in 2.16 due to the introduction of HTTPAccess.
 - 2.0
Enable boolean W Enables/Disables remotely accessing the CPE’s user interface. - 2.0
Port unsigned­Int­(:65535) W Destination TCP port required for remote access connection. - 2.0
Supported­Protocols string­[] R

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

 - 2.0
Protocol string W The value MUST be a member of the list reported by the SupportedProtocols parameter. This is the protocol currently being used for remote access. - 2.0
Device.­User­Interface.­Local­Display. object R This object describes how to remotely manage the initial positioning of a user interface on a device’s local display. - 2.0
Movable boolean W Controls whether the user is allowed to change the GUI window position on the local CPE’s display. - 2.0
Resizable boolean W Controls whether the user is allowed to resize the GUI window on the local CPE’s display. - 2.0
Pos­X 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
Pos­Y 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
Width unsigned­Int W The width of the user interface within the local CPE’s display, expressed in pixels. - 2.0
Height unsigned­Int W The height of the user interface within the local CPE’s display, expressed in pixels. - 2.0
Display­Width unsigned­Int R The width of the local CPE’s display, expressed in pixels. - 2.0
Display­Height unsigned­Int R The height of the local CPE’s display, expressed in pixels. - 2.0
Device.­User­Interface.­Messages. object R Definition of user information message displays. - 2.11
Enable boolean W

Enables and displays the user information message.

The factory default value MUST be true.

 - 2.11
Title string­(:128) W Message title to be displayed. - 2.11
Sub­Title string­(:128) W Message sub title to be displayed. - 2.11
Text string W Message text. - 2.11
Icon­Type string W

Icon to be displayed. Enumeration of:

  • None
  • Greeting
  • Information
  • Warning
  • Important
  • Urgent
  • Advertisement
 - 2.11
Message­Color hex­Binary­(3) W The color of message text in RGB hexadecimal notation (e.g., FF0088). - 2.11
Background­Color hex­Binary­(3) W The color of the message screen background in RGB hexadecimal notation (e.g., FF0088). - 2.11
Title­Color hex­Binary­(3) W The color of the message title in RGB hexadecimal notation (e.g., FF0088). - 2.11
Sub­Title­Color hex­Binary­(3) W The color of the sub title in RGB hexadecimal notation (e.g., FF0088). - 2.11
Requested­Number­Of­Repetitions unsigned­Int W The number of times the device SHOULD repeat the message. - 2.11
Executed­Number­Of­Repetitions unsigned­Int R The number of times the device repeated the message. - 2.11
Device.­Interface­Stack.­{i}. object(0:) R

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

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

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

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

 - 2.0
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.3
Higher­Layer string­(:256) R

A reference to the interface object corresponding to the higher layer of the relationship, i.e. the interface which runs on top of the interface identified by the corresponding instance of LowerLayer.

When the referenced higher layer interface is deleted, the CPE MUST delete the table row.

 - 2.0
Lower­Layer string­(:256) R

A reference to the interface object corresponding to the lower layer of the relationship, i.e. the interface which runs below the interface identified by the corresponding instance of HigherLayer.

When the referenced lower layer interface is deleted, the CPE MUST delete the table row.

 - 2.0
Higher­Alias string­(:64) R The value of the Alias parameter for the interface object referenced by HigherLayer. - 2.0
Lower­Alias string­(:64) R The value of the Alias parameter for the interface object referenced by LowerLayer. - 2.0
Device.­DSL. object R This object models DSL lines, DSL channels, DSL bonding, and DSL diagnostics. The specific interface objects defined here are Line, Channel, and BondingGroup. Each Line models a layer 1 DSL Line interface, and each Channel models a layer 1 DSL Channel interface where multiple channels can run over a DSL line. In the case where bonding is configured, it is expected that BondingGroup is stacked above the Channel instances within its group. - 2.0
Line­Number­Of­Entries unsigned­Int R The number of entries in the Line table. - 2.0
Channel­Number­Of­Entries unsigned­Int R The number of entries in the Channel table. - 2.0
Bonding­Group­Number­Of­Entries unsigned­Int R The number of entries in the BondingGroup table. - 2.0
Device.­DSL.­Line.­{i}. object(0:) R

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

This table models physical DSL lines.

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

 - 2.0
Enable boolean W

Enables or disables the DSL line.

This parameter is based on ifAdminStatus from [RFC2863].

 - 2.0
Enable­Data­Gathering boolean W Enables or disables data gathering on the DSL line. - 2.8
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

 - 2.0
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.0
Name string­(:64) R

The textual name of the DSL line as assigned by the CPE.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the DSL line entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W

Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2].

Note: Since Device.DSL.Line.{i}. is a layer 1 interface, it is expected that LowerLayers will not be used.

 - 2.0
Upstream boolean R

Indicates whether the interface points towards the Internet (true) or towards End Devices (false).

For example:

  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
 - 2.0
Firmware­Version string­(:64) R A string identifying the version of the modem firmware currently installed for this interface. This is applicable only when the modem firmware is separable from the overall CPE software. - 2.0
Link­Status string R

Status of the DSL physical link. Enumeration of:

  • Up
  • Initializing
  • EstablishingLink
  • NoSignal
  • Disabled
  • Error (OPTIONAL)

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
Standards­Supported string­[] R

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

  • G.992.1_Annex_A
  • G.992.1_Annex_B
  • G.992.1_Annex_C
  • T1.413
  • T1.413i2
  • ETSI_101_388
  • G.992.2
  • G.992.3_Annex_A
  • G.992.3_Annex_B
  • G.992.3_Annex_C
  • G.992.3_Annex_I
  • G.992.3_Annex_J
  • G.992.3_Annex_L
  • G.992.3_Annex_M
  • G.992.4
  • G.992.5_Annex_A
  • G.992.5_Annex_B
  • G.992.5_Annex_C
  • G.992.5_Annex_I
  • G.992.5_Annex_J
  • G.992.5_Annex_M
  • G.993.1
  • G.993.1_Annex_A
  • G.993.2_Annex_A
  • G.993.2_Annex_B
  • G.993.2_Annex_C
Note: In G.997.1, this parameter is called “xDSL Transmission system capabilities”. See ITU-T Recommendation [G.997.1].
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
XTSE hex­Binary­(8) R

This configuration parameter defines the transmission system types to be allowed by the xTU on this Device.DSL.Line.{i}. 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
Standard­Used string R
The value MUST be a member of the list reported by the StandardsSupported parameter. Indicates the standard that the Device.DSL.Line.{i}. instance is using for the connection.
Note: In G.997.1, this parameter is called “xDSL Transmission system”. See ITU-T Recommendation [G.997.1].
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
XTSUsed hex­Binary­(8) R This parameter indicates which DSL standard and recommendation are currently in use by the Device.DSL.Line.{i}. instance. Only one bit is set, as defined for the xTU transmission system enabling (XTSE) in ITU-T G.997.1. - 2.8
Line­Encoding string R

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

  • DMT
  • CAP
  • 2B1Q
  • 43BT
  • PAM
  • QAM

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

 - 2.0
Allowed­Profiles string­[] R

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

  • 8a
  • 8b
  • 8c
  • 8d
  • 12a
  • 12b
  • 17a
  • 17b (This enumeration was DELETED in 2.12 because the value is not defined in G997.1)
  • 30a
  • 35b

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

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

 - 2.0
Current­Profile string R

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

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

 - 2.0
Power­Management­State string R

The power management state of the line. Enumeration of:

  • L0
  • L1
  • L2
  • L3
  • L4

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

 - 2.0
Success­Failure­Cause unsigned­Int­(0:6) R

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

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

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

 - 2.0
UPBOKLER unsigned­Int­(0:1280) R

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

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

 - 2.8
UPBOKLEPb unsigned­Int­(0:1280,­2047)[] R

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

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

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

 - 2.8
UPBOKLERPb unsigned­Int­(0:1280,­2047)[] R

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

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

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

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

 - 2.8
RXTHRSHds int­(-­640:0) R

UPBO downstream receiver signal level threshold.

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

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

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

 - 2.8
ACTRAMODEds unsigned­Int­(1:4) R

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

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

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

 - 2.8
ACTRAMODEus unsigned­Int­(1:4) R

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

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

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

 - 2.8
ACTINPROCds unsigned­Int R

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

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

 - 2.8
ACTINPROCus unsigned­Int R

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

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

 - 2.8
SNRMROCds unsigned­Int R

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

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

 - 2.8
SNRMROCus unsigned­Int R

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

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

 - 2.8
Last­State­Transmitted­Downstream unsigned­Int R

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

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

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

 - 2.0
Last­State­Transmitted­Upstream unsigned­Int R

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

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

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

 - 2.0
UPBOKLE unsigned­Int­(0:1280) R

This parameter contains the estimated electrical loop length expressed in 0.1dB at 1MHz (see O-UPDATE in section 12.2.4.2.1.2/G.993.2). The value SHALL be coded as an unsigned 16 bit number in the range 0 (coded as 0) to 128 dB (coded as 1280) in steps of 0.1 dB.

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

 - 2.0
MREFPSDds base­64(0:145) R

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

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

 - 2.0
MREFPSDus base­64(0:145) R

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

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

 - 2.0
LIMITMASK unsigned­Int R

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

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

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

 - 2.0
US0MASK unsigned­Int R

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

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

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

 - 2.0
TRELLISds int R

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

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

 - 2.0
TRELLISus int R

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

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

 - 2.0
ACTSNRMODEds unsigned­Int R

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

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

 - 2.0
ACTSNRMODEus unsigned­Int R

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

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

 - 2.0
Virtual­Noise­PSDds base­64(0:97) R

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

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

 - 2.0
Virtual­Noise­PSDus base­64(0:49) R

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

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

 - 2.0
ACTUALCE unsigned­Int R

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

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

 - 2.0
Line­Number int­(1:) R Signifies the line pair that the modem is using to connection. LineNumber = 1 is the innermost pair. - 2.0
Upstream­Max­Bit­Rate unsigned­Int R

The current maximum attainable data rate upstream (expressed in Kbps).

Note: This parameter is related to the G.997.1 parameter ATTNDRus, which is measured in bits/s. See ITU-T Recommendation [G.997.1].

 - 2.0
Downstream­Max­Bit­Rate unsigned­Int R

The current maximum attainable data rate downstream (expressed in Kbps).

Note: This parameter is related to the G.997.1 parameter ATTNDRds, which is measured in bits/s. See ITU-T Recommendation [G.997.1].

 - 2.0
Upstream­Noise­Margin int R

The current signal-to-noise ratio margin (expressed in 0.1dB) in the upstream direction.

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

 - 2.0
Downstream­Noise­Margin int R

The current signal-to-noise ratio margin (expressed in 0.1dB) in the downstream direction.

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

 - 2.0
SNRMpbus string­(:24)[] R

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

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

 - 2.0
SNRMpbds string­(:24)[] R

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

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

 - 2.0
INMIATOds unsigned­Int­(3:511) R

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

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

 - 2.0
INMIATSds unsigned­Int­(0:7) R

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

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

 - 2.0
INMCCds unsigned­Int­(0:64) R

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

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

 - 2.0
INMINPEQMODEds unsigned­Int­(0:3) R

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

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

 - 2.0
Upstream­Attenuation int R

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

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

 - 2.0
Downstream­Attenuation int R

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

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

 - 2.0
Upstream­Power int R The current output power at the CPE’s DSL line (expressed in 0.1dBmV). - 2.0
Downstream­Power int R The current received power at the CPE’s DSL line (expressed in 0.1dBmV). - 2.0
XTURVendor hex­Binary­(4) R

xTU-R vendor identifier as defined in G.994.1 and T1.413. In the case of G.994.1 this corresponds to the four-octet provider code, which MUST be represented as eight hexadecimal digits.

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, it MUST have the value “00000000”.

Note: In G.997.1, this parameter is called “xTU-R G.994.1 Vendor ID”. See ITU-T Recommendation [G.997.1].

 - 2.0
XTURCountry hex­Binary­(2) R

T.35 country code of the xTU-R vendor as defined in G.994.1, where the two-octet value defined in G.994.1 MUST be represented as four hexadecimal digits.

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, it MUST have the value “0000”.

Note: In G.997.1, this parameter is called “xTU-R G.994.1 Vendor ID”. See ITU-T Recommendation [G.997.1].

 - 2.0
XTURANSIStd unsigned­Int R

xTU-R T1.413 Revision Number as defined in T1.413 Issue 2.

When T1.413 modulation is not in use, the parameter value SHOULD be 0.

 - 2.0
XTURANSIRev unsigned­Int R

xTU-R Vendor Revision Number as defined in T1.413 Issue 2.

When T1.413 modulation is not in use, the parameter value SHOULD be 0.

 - 2.0
XTUCVendor hex­Binary­(4) R

xTU-C vendor identifier as defined in G.994.1 and T1.413. In the case of G.994.1 this corresponds to the four-octet provider code, which MUST be represented as eight hexadecimal digits.

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, it MUST have the value “00000000”.

 - 2.0
XTUCCountry hex­Binary­(2) R

T.35 country code of the xTU-C vendor as defined in G.994.1, where the two-octet value defined in G.994.1 MUST be represented as four hexadecimal digits.

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, it MUST have the value “0000”.

 - 2.0
XTUCANSIStd unsigned­Int R

xTU-C T1.413 Revision Number as defined in T1.413 Issue 2.

When T1.413 modulation is not in use, the parameter value SHOULD be 0.

 - 2.0
XTUCANSIRev unsigned­Int R

xTU-C Vendor Revision Number as defined in T1.413 Issue 2.

When T1.413 modulation is not in use, the parameter value SHOULD be 0.

 - 2.0
Device.­DSL.­Line.­{i}.­Stats. object R

Throughput statistics for this interface.

The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

 - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Discard­Packets­Sent unsigned­Int R The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Total­Start unsigned­Int R

DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of Total statistics.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

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

 - 2.0
Showtime­Start unsigned­Int R

DSL-specific statistic. The Number of seconds since the most recent DSL Showtime - the beginning of the period used for collection of Showtime statistics.

Showtime is defined as successful completion of the DSL link establishment process. The Showtime statistics are those collected since the most recent establishment of the DSL link.

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

 - 2.0
Last­Showtime­Start unsigned­Int R

DSL-specific statistic. The Number of seconds since the second most recent DSL Showtime-the beginning of the period used for collection of LastShowtime statistics.

If the CPE has not retained information about the second most recent Showtime (e.g., on reboot), the start of LastShowtime statistics MAY temporarily coincide with the start of Showtime statistics.

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

 - 2.0
Current­Day­Start unsigned­Int R

DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of CurrentDay statistics.

The CPE MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

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

 - 2.0
Quarter­Hour­Start unsigned­Int R

DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of QuarterHour statistics.

The CPE MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

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

 - 2.0
Device.­DSL.­Line.­{i}.­Stats.­Total. object R

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

Note: The Device.DSL.Line.{i}.Stats.Total. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

 - 2.0
Errored­Secs unsigned­Int R

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

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

 - 2.0
Severely­Errored­Secs unsigned­Int R

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

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

 - 2.0
Device.­DSL.­Line.­{i}.­Stats.­Showtime. object R

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

Note: The Device.DSL.Line.{i}.Stats.Showtime. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

 - 2.0
Errored­Secs unsigned­Int R

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

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

 - 2.0
Severely­Errored­Secs unsigned­Int R

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

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

 - 2.0
Device.­DSL.­Line.­{i}.­Stats.­Last­Showtime. object R

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

Note: The Device.DSL.Line.{i}.Stats.LastShowtime. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

 - 2.0
Errored­Secs unsigned­Int R

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

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

 - 2.0
Severely­Errored­Secs unsigned­Int R

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

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

 - 2.0
Device.­DSL.­Line.­{i}.­Stats.­Current­Day. object R

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

Note: The Device.DSL.Line.{i}.Stats.CurrentDay. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

 - 2.0
Errored­Secs unsigned­Int R

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

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

 - 2.0
Severely­Errored­Secs unsigned­Int R

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

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

 - 2.0
Device.­DSL.­Line.­{i}.­Stats.­Quarter­Hour. object R

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

Note: The Device.DSL.Line.{i}.Stats.QuarterHour. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

 - 2.0
Errored­Secs unsigned­Int R

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

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

 - 2.0
Severely­Errored­Secs unsigned­Int R

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

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

 - 2.0
Device.­DSL.­Line.­{i}.­Test­Params. object R This object contains the DSL line test parameters that are available during the L0 (i.e., Showtime) state. - 2.0
HLOGGds unsigned­Int R

Number of sub-carriers per sub-carrier group in the downstream direction for HLOGpsds. Valid values are 1, 2, 4, 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
HLOGGus unsigned­Int R

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

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

 - 2.0
HLOGpsds string­(:2559)[] R

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

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

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

 - 2.0
HLOGpsus string­(:2559)[] R

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

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

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

 - 2.0
HLOGMTds unsigned­Int R

Indicates the number of symbols over which HLOGpsds was measured.

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

 - 2.0
HLOGMTus unsigned­Int R

Indicates the number of symbols over which HLOGpsus was measured.

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

 - 2.0
QLNGds unsigned­Int R

Number of sub-carriers per sub-carrier group in the downstream direction for QLNpsds. Valid values are 1, 2, 4, 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
QLNGus unsigned­Int R

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

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

 - 2.0
QLNpsds int­(:2047)[] R

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

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

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

 - 2.0
QLNpsus string­(:2047)[] R

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

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

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

 - 2.0
QLNMTds unsigned­Int R

Indicates the number of symbols over which QLNpsds was measured.

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

 - 2.0
QLNMTus unsigned­Int R

Indicates the number of symbols over which QLNpsus was measured.

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

 - 2.0
SNRGds unsigned­Int R

Number of sub-carriers per sub-carrier group in the downstream direction for SNRpsds. Valid values are 1, 2, 4, 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
SNRGus unsigned­Int R

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

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

 - 2.0
SNRpsds int­(:2047)[] R

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

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

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

 - 2.0
SNRpsus string­(:2047)[] R

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

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

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

 - 2.0
SNRMTds unsigned­Int R

Indicates the number of symbols over which SNRpsds was measured.

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

 - 2.0
SNRMTus unsigned­Int R

Indicates the number of symbols over which SNRpsus was measured.

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

 - 2.0
LATNds string­(:35)[] R

Comma-separated list (maximum number of characters per item 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
LATNus string­(:35)[] R

Comma-separated list (maximum number of characters per item 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
SATNds string­(:35)[] R

Comma-separated list (maximum number of characters per item 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
SATNus string­(:35)[] R

Comma-separated list (maximum number of characters per item 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
Device.­DSL.­Line.­{i}.­Data­Gathering. object R

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

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

 - 2.8
Logging­Depth­R unsigned­Int R

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

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

 - 2.8
Act­Logging­Depth­Reporting­R unsigned­Int R

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

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

 - 2.8
Event­Trace­Buffer­R string­(:256) R

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

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

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

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

 - 2.8
Device.­DSL.­Channel.­{i}. object(0:) R

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

This table models DSL channel(s) on top of physical DSL lines.

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

 - 2.0
Enable boolean W

Enables or disables the channel.

This parameter is based on ifAdminStatus from [RFC2863].

 - 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

 - 2.0
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.0
Name string­(:64) R

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

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

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

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

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

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

  • G.992.3_Annex_K_ATM
  • G.992.3_Annex_K_PTM
  • G.993.2_Annex_K_ATM
  • G.993.2_Annex_K_PTM

When ATM encapsulation is identified then an upper-layer ATM.Link interface MUST be used.

When PTM encapsulation is identified then an upper-layer PTM.Link interface MUST be used.

 - 2.0
LPATH unsigned­Int­(:3) R

Reports the index of the latency path supporting the bearer channel.

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

 - 2.0
INTLVDEPTH unsigned­Int R

Reports the interleaver depth D for the latency path indicated in LPATH.

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

 - 2.0
INTLVBLOCK int R

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

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

 - 2.0
Actual­Interleaving­Delay unsigned­Int R

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

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

 - 2.0
ACTINP int R

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

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

 - 2.0
INPREPORT boolean R

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

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

 - 2.0
NFEC int R

Reports the size, in octets, of the Reed-Solomon codeword in use on the latency path indicated in LPATH.

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

 - 2.0
RFEC int R

Reports the number of redundancy bytes per Reed-Solomon codeword on the latency path indicated in LPATH.

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

 - 2.0
LSYMB int R

Reports the number of bits per symbol assigned to the latency path indicated in LPATH. This value does not include overhead due to trellis coding.

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

 - 2.0
Upstream­Curr­Rate unsigned­Int R

The current physical layer aggregate data rate (expressed in Kbps) of the upstream DSL connection.

Note: If the parameter is implemented but no value is available, it MUST have the value 4294967295 (the maximum for its data type).

 - 2.0
Downstream­Curr­Rate unsigned­Int R

The current physical layer aggregate data rate (expressed in Kbps) of the downstream DSL connection.

Note: If the parameter is implemented but no value is available, it MUST have the value 4294967295 (the maximum for its data type).

 - 2.0
ACTNDR unsigned­Int R

Actual net data rate expressed in Kbps. Independent whether retransmission is used or not in a given transmit direction:

  • In L0 state, this parameter reports the net data rate (as specified in [ITU T G.992.3], [ITU T G.992.5] or [ITU T G.993.2]) at which the bearer channel is operating.
  • In L2 state, the parameter contains the net data rate (as specified in [ITU T G.992.3], [ITU T G.992.5] or [ITU T G.993.2]) in the previous L0 state.

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

 - 2.8
ACTINPREIN unsigned­Int­(0:255) R

Actual impulse noise protection against REIN, expressed in 0.1 DMT symbols.

If retransmission is used in a given transmit direction, this parameter reports the actual impulse noise protection (INP) against REIN (under specific conditions detailed in [ITU T G.998.4]) on the bearer channel in the L0 state. In the L2 state, the parameter contains the INP in the previous L0 state.

The value is coded in fractions of DMT symbols with a granularity of 0.1 symbols.

The range is from 0 to 25.4. A special value of 25.5 indicates an ACTINP_REIN of 25.5 or higher.

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

 - 2.8
Device.­DSL.­Channel.­{i}.­Stats. object R

Throughput statistics for this interface.

The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

 - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Discard­Packets­Sent unsigned­Int R The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Total­Start unsigned­Int R

DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of Total statistics.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

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

 - 2.0
Showtime­Start unsigned­Int R

DSL-specific statistic. The Number of seconds since the most recent DSL Showtime - the beginning of the period used for collection of Showtime statistics.

Showtime is defined as successful completion of the DSL link establishment process. The Showtime statistics are those collected since the most recent establishment of the DSL link.

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

 - 2.0
Last­Showtime­Start unsigned­Int R

DSL-specific statistic. The Number of seconds since the second most recent DSL Showtime-the beginning of the period used for collection of LastShowtime statistics.

If the CPE has not retained information about the second most recent Showtime (e.g., on reboot), the start of LastShowtime statistics MAY temporarily coincide with the start of Showtime statistics.

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

 - 2.0
Current­Day­Start unsigned­Int R

DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of CurrentDay statistics.

The CPE MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

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

 - 2.0
Quarter­Hour­Start unsigned­Int R

DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of QuarterHour statistics.

The CPE MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

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

 - 2.0
Device.­DSL.­Channel.­{i}.­Stats.­Total. object R

This object contains DSL channel total statistics [G.997.1].

Note: The Device.DSL.Channel.{i}.Stats.Total. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

 - 2.0
XTURFECErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTUCFECErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTURHECErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTUCHECErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTURCRCErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTUCCRCErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
Device.­DSL.­Channel.­{i}.­Stats.­Showtime. object R

This object contains DSL channel statistics accumulated since the most recent DSL Showtime [G.997.1].

Note: The Device.DSL.Channel.{i}.Stats.Showtime. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

 - 2.0
XTURFECErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTUCFECErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTURHECErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTUCHECErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTURCRCErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTUCCRCErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
Device.­DSL.­Channel.­{i}.­Stats.­Last­Showtime. object R

This object contains DSL channel statistics accumulated since the second most recent DSL Showtime [G.997.1].

Note: The Device.DSL.Channel.{i}.Stats.LastShowtime. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

 - 2.0
XTURFECErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTUCFECErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTURHECErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTUCHECErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTURCRCErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTUCCRCErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
Device.­DSL.­Channel.­{i}.­Stats.­Current­Day. object R

This object contains DSL channel statistics accumulated during the current day [G.997.1].

Note: The Device.DSL.Channel.{i}.Stats.CurrentDay. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

 - 2.0
XTURFECErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTUCFECErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTURHECErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTUCHECErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTURCRCErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTUCCRCErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
Device.­DSL.­Channel.­{i}.­Stats.­Quarter­Hour. object R

This object contains DSL channel statistics accumulated during the current quarter hour [G.997.1].

Note: The Device.DSL.Channel.{i}.Stats.QuarterHour. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

 - 2.0
XTURFECErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTUCFECErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTURHECErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTUCHECErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTURCRCErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
XTUCCRCErrors unsigned­Int R

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

Note: If the parameter is implemented but no value is available, its value MUST be 4294967295 (the maximum for its data type).

 - 2.0
Device.­DSL.­Bonding­Group.­{i}. object(0:) R

DSL bonding group table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each instance is a bonding group, and is expected to be stacked above a Channel instance 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
Enable boolean W

Enables or disables the bonding group.

This parameter is based on ifAdminStatus from [RFC2863].

 - 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

 - 2.0
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.0
Name string­(:64) R

The textual name of the bonding group as assigned by the CPE.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the bonding group entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] R

Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2].

LowerLayers is read-only for this object because bonding is expected to be configured by the CPE, not by the Controller.

 - 2.0
Group­Status string­[] R

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

  • NoPeer (Peer physical layer is unreachable)
  • PeerPowerLoss (Local device received a “dying gasp” message (preceding a loss-of-power) from the peer device)
  • PeerBondSchemeMismatch (Operating bonding scheme of the peer port is different from the local one)
  • LowRate (Upstream or downstream data rate is at or below threshold)

Corresponds to [TR-159] oBondingGroup.aGroupStatus.

 - 2.0
Group­ID unsigned­Int R DSL bonding group ID. Corresponds to [TR-159] oBondingGroup.aGroupID. - 2.0
Bond­Schemes­Supported string­[] R

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

  • ATM ([G.998.1] ATM-based bonding)
  • Ethernet ([G.998.2] Ethernet-based bonding)
  • TDIM ([G.998.3] TDIM-based bonding)

Corresponds to [TR-159] oBondingGroup.aGroupBondSchemesSupported.

 - 2.0
Bond­Scheme string R

The value MUST be a member of the list reported by the BondSchemesSupported parameter. Currently operating bonding scheme. Corresponds to [TR-159] aGroupOperBondScheme.

This parameter discriminates between the Ethernet union objects.

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

DSL bonded channel table. Each table entry represents a bonded channel within the bonding group, and is associated with exactly one Channel instance or one FAST.Line instance. There MUST be an instance of Device.DSL.BondingGroup.{i}.BondedChannel.{i}. for each DSL channel or FAST line that is bonded.

When a Channel or FAST.Line is no longer bonded, then the CPE MUST delete the corresponding Device.DSL.BondingGroup.{i}.BondedChannel.{i}. instance. However, when a bonded Channel or FAST.Line becomes disabled, the channel remains bonded and so the corresponding Device.DSL.BondingGroup.{i}.BondedChannel.{i}. instance MUST NOT be deleted.

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

 - 2.0
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.0
Channel string­(:256) R

The value MUST be the Path Name of a row in the 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
Device.­DSL.­Bonding­Group.­{i}.­Bonded­Channel.­{i}.­Ethernet. object R Per-channel [G.998.2] Ethernet-based bonding parameters. - 2.0
Device.­DSL.­Bonding­Group.­{i}.­Bonded­Channel.­{i}.­Ethernet.­Stats. object R

Per-channel [G.998.2] Ethernet-based bonding statistics.

These relate to the [G.998.2] PME (Physical Medium Entity) Aggregation Function (PAF) lower layer (per-channel) interfaces.

The CPE MUST reset the Stats parameters either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

 - 2.0
Underflow­Errors­Sent unsigned­Int R Number of underflow errors sent, i.e. on the transmit side of the interface. - 2.0
CRCErrors­Received unsigned­Int R Number of CRC errors received, i.e. on the receive side of the interface. - 2.0
Alignment­Errors­Received unsigned­Int R Number of alignment errors received, i.e. on the receive side of the interface. - 2.0
Short­Packets­Received unsigned­Int R Number of short packets received, i.e. on the receive side of the interface. - 2.0
Long­Packets­Received unsigned­Int R Number of long packets received, i.e. on the receive side of the interface. - 2.0
Overflow­Errors­Received unsigned­Int R Number of overflow errors received, i.e. on the receive side of the interface. - 2.0
Pause­Frames­Received unsigned­Int R Number of pause frames received, i.e. on the receive side of the interface. - 2.0
Frames­Dropped unsigned­Int R Number of frames dropped, e.g. because the receive queue is full. - 2.0
Device.­DSL.­Bonding­Group.­{i}.­Stats. object R

Throughput statistics for this interface.

The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

 - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int R The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Total­Start unsigned­Int R

DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of Total statistics.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

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

 - 2.0
Current­Day­Start unsigned­Int R

DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of CurrentDay statistics.

The CPE MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

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

 - 2.0
Quarter­Hour­Start unsigned­Int R

DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of QuarterHour statistics.

The CPE MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

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

 - 2.0
Device.­DSL.­Bonding­Group.­{i}.­Stats.­Total. object R

Total statistics for this bonding group.

Note: The Device.DSL.BondingGroup.{i}.Stats.Total. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

 - 2.0
Failure­Reasons string­[] R

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

  • LowRate (Minimum data rate not met)
  • ExcessiveDelay (Differential delay tolerance exceeded)
  • InsufficientBuffers (Insufficient buffers on receiver)
  • Other (Other failure occurred)

Corresponds to [Section 11.4.3/G.998.1] Current Group Failure Reason.

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

Current day statistics for this bonding group.

Note: The Device.DSL.BondingGroup.{i}.Stats.CurrentDay. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

 - 2.0
Failure­Reasons string­[] R

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

  • LowRate (Minimum data rate not met)
  • ExcessiveDelay (Differential delay tolerance exceeded)
  • InsufficientBuffers (Insufficient buffers on receiver)
  • Other (Other failure occurred)

Corresponds to [Section 11.4.3/G.998.1] Current Group Failure Reason.

 - 2.0
Upstream­Rate unsigned­Int R The achieved upstream data rate in bits per second (which might change subject to dynamic link usage conditions). Corresponds to [Section 11.4.2/G.998.1] Achieved Aggregate Data Rate. - 2.0
Downstream­Rate unsigned­Int R The achieved downstream data rate in bits per second (which might change subject to dynamic link usage conditions). Corresponds to [Section 11.4.2/G.998.1] Achieved Aggregate Data Rate. - 2.0
Upstream­Packet­Loss unsigned­Int R The total number of upstream packets that were lost at aggregation output from a bonding group during the accumulation period. Corresponds to [Section 11.4.2/G.998.1] Group Rx Cell Loss Count. - 2.0
Downstream­Packet­Loss unsigned­Int R The total number of downstream packets that were lost at aggregation output from a bonding group during the accumulation period. Corresponds to [Section 11.4.2/G.998.1] Group Rx Cell Loss Count. - 2.0
Upstream­Differential­Delay unsigned­Int R The achieved upstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0
Downstream­Differential­Delay unsigned­Int R The achieved downstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.0
Failure­Count unsigned­Int R The number of times that the group was declared Unavailable during the accumulation period. Corresponds to [Section 11.4.3/G.998.1] Group Failure Count. - 2.0
Errored­Seconds unsigned­Int R The time in seconds during which the group was declared Errored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**ES. - 2.0
Severely­Errored­Seconds unsigned­Int R The time in seconds during which the group was declared SeverelyErrored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**SES. - 2.0
Unavailable­Seconds unsigned­Int R The time in seconds during which the group was declared Unavailable during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**UAS. - 2.0
Device.­DSL.­Bonding­Group.­{i}.­Stats.­Quarter­Hour. object R

Current quarter hour statistics for this bonding group.

Note: The Device.DSL.BondingGroup.{i}.Stats.QuarterHour. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

 - 2.0
Failure­Reasons string­[] R

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

  • LowRate (Minimum data rate not met)
  • ExcessiveDelay (Differential delay tolerance exceeded)
  • InsufficientBuffers (Insufficient buffers on receiver)
  • Other (Other failure occurred)

Corresponds to [Section 11.4.3/G.998.1] Current Group Failure Reason.

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

Ethernet-based bonding parameters [G.998.2].

This object MUST be present if, and only if, BondScheme is Ethernet.

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

 - 2.0
Device.­DSL.­Bonding­Group.­{i}.­Ethernet.­Stats. object R

[G.998.2] Ethernet-based bonding statistics.

These relate to the [G.998.2] PME (Physical Medium Entity) Aggregation Function (PAF) and to its upper layer interface. PAF lower layer interface statistics are in the BondedChannel.{i}.Ethernet.Stats objects.

The CPE MUST reset the Stats parameters either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

 - 2.0
PAFErrors unsigned­Int R Number of PAF errors. Corresponds to [TR-159] oBondETH.aEthRxErrors. - 2.0
PAFSmall­Fragments unsigned­Int R Number of PAF Small Fragment events. Corresponds to [TR-159] oBondETH.aEthRxSmallFragments. - 2.0
PAFLarge­Fragments unsigned­Int R Number of PAF Large Fragment events. Corresponds to [TR-159] oBondETH.aEthRxLargeFragments. - 2.0
PAFBad­Fragments unsigned­Int R Number of PAF Bad Fragment events. Corresponds to [TR-159] oBondETH.aEthRxBadFragments. - 2.0
PAFLost­Fragments unsigned­Int R Number of PAF Lost Fragment events. Corresponds to [TR-159] oBondETH.aEthRxLostFragments. - 2.0
PAFLate­Fragments unsigned­Int R Number of PAF Late Fragment events. - 2.0
PAFLost­Starts unsigned­Int R Number of PAF Lost Start events. Corresponds to [TR-159] oBondETH.aEthRxLostStarts. - 2.0
PAFLost­Ends unsigned­Int R Number of PAF Lost End events. Corresponds to [TR-159] oBondETH.aEthRxLostEnds. - 2.0
PAFOverflows unsigned­Int R Number of PAF Overflow events. Corresponds to [TR-159] oBondETH.aEthRxOverflows. - 2.0
Pause­Frames­Sent unsigned­Int R Number of pause frames sent, i.e. on the transmit side of the interface. - 2.0
CRCErrors­Received unsigned­Int R Number of CRC errors received, i.e. on the receive side of the interface. - 2.0
Alignment­Errors­Received unsigned­Int R Number of alignment errors received, i.e. on the receive side of the interface. - 2.0
Short­Packets­Received unsigned­Int R Number of short packets received, i.e. on the receive side of the interface. - 2.0
Long­Packets­Received unsigned­Int R Number of long packets received, i.e. on the receive side of the interface. - 2.0
Overflow­Errors­Received unsigned­Int R Number of overflow errors received, i.e. on the receive side of the interface. - 2.0
Frames­Dropped unsigned­Int R Number of frames dropped, e.g. because the receive queue is full. - 2.0
Device.­DSL.­Diagnostics. object R The DSL Diagnostics object. - 2.0
ADSLLine­Test­() command - [ASYNC] This command is to provide diagnostic information for a CPE with an ADSL2 or ADSL2+ modem WAN interface, but MAY also be used for ADSL. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Interface string­(:256) R [MANDATORY] 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.12
⇐ Output. arguments - Output arguments. -
⇐ Status string W

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL)
  • Error_Internal
  • Error_Other

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

 - 2.13
⇐ ACTPSDds int W

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.12
⇐ ACTPSDus int W

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.12
⇐ ACTATPds int W

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.12
⇐ ACTATPus int W

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.12
⇐ HLINSCds int W

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.12
⇐ HLINSCus int W

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.12
⇐ HLINGds unsigned­Int W

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.12
⇐ HLINGus unsigned­Int W

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.12
⇐ HLOGGds unsigned­Int W

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.12
⇐ HLOGGus unsigned­Int W

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.12
⇐ HLOGpsds string­(:2559)[] W

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

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

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

 - 2.12
⇐ HLOGpsus string­(:2559)[] W

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

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

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

 - 2.12
⇐ HLOGMTds unsigned­Int W

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.12
⇐ HLOGMTus unsigned­Int W

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.12
⇐ LATNpbds string­(:24)[] W

Comma-separated list (maximum number of characters per item 24) of strings. List items represent downstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of LATNpbds is as defined in ITU-T Rec. G.997.1.

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

 - 2.12
⇐ LATNpbus string­(:24)[] W

Comma-separated list (maximum number of characters per item 24) of strings. List items represent upstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of upstream bands but will exceed one only for G.993.2. Interpretation of LATNpbus is as defined in ITU-T Rec. G.997.1.

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

 - 2.12
⇐ SATNds string­(:24)[] W

Comma-separated list (maximum number of characters per item 24) of strings. List items represent downstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNds is as defined in ITU-T Rec. G.997.1.

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

 - 2.12
⇐ SATNus string­(:24)[] W

Comma-separated list (maximum number of characters per item 24) of strings. List items represent upstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNus is as defined in ITU-T Rec. G.997.1.

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

 - 2.12
⇐ HLINpsds int­(:61430)[] W

Comma-separated list (maximum number of characters per item 61430) of integers. List items represent downstream linear channel characteristics per subcarrier group. Maximum number of complex pairs is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of pairs will depend on the value of HLINGds but will not exceed 512. Interpretation of the value is as defined in ITU-T Rec. G.997.1.

Note: HLIN is not applicable in PLOAM for G.992.1 or G.992.2.

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

 - 2.12
⇐ HLINpsus string­(:61430)[] W

Comma-separated list (maximum number of characters per item 61430) of strings. List items represent upstream linear channel characteristics per sub-carrier group. Maximum number of complex pairs is 64 for G.992.3, and G.992.5. For G.993.2, the number of pairs will depend on the value of HLINGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

Note: HLIN is not applicable in PLOAM for G.992.1 or G.992.2.

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

 - 2.12
⇐ QLNGds unsigned­Int W

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.12
⇐ QLNGus unsigned­Int W

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.12
⇐ QLNpsds int­(:61430)[] W

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

Note: QLN is not applicable in PLOAM for G.992.1 or G.992.2.

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

 - 2.12
⇐ QLNpsus string­(:61430)[] W

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

Note: QLN is not applicable in PLOAM for G.992.1 or G.992.2.

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

 - 2.12
⇐ QLNMTds unsigned­Int W

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.12
⇐ QLNMTus unsigned­Int W

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.12
⇐ SNRGds unsigned­Int W

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.12
⇐ SNRGus unsigned­Int W

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.12
⇐ SNRpsds int­(:61430)[] W

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

Note: SNRps is not applicable in PLOAM for G.992.1 or G.992.2.

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

 - 2.12
⇐ SNRpsus string­(:61430)[] W

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

Note: SNRps is not applicable in PLOAM for G.992.1 or G.992.2.

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

 - 2.12
⇐ SNRMTds unsigned­Int W

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.12
⇐ SNRMTus unsigned­Int W

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.12
⇐ BITSpsds int­(:61430)[] W Comma-separated list (maximum number of characters per item 61430) of integers. List items represent downstream bit allocation per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. Interpretation of the value is as defined in ITU-T Rec. [G.997.1]. - 2.12
⇐ BITSpsus string­(:61430)[] W Comma-separated list (maximum number of characters per item 61430) of strings. List items represent upstream bit allocation per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. Interpretation of the value is as defined in ITU-T Rec. [G.997.1]. - 2.12
SELTUER() command -

[ASYNC] This command performs a DSL Single Ended Line Test - Physical Medium Dependent (SELT-PMD) Uncalibrated Echo Response (UER).

This command 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
⇒ Input. arguments - Input arguments. -
⇒ Interface string­(:256) R 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
⇒ UERMax­Measurement­Duration unsigned­Int­(5:240) R

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
⇐ Output. arguments - Output arguments. -
⇐ Status string W

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL)

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

 - 2.13
⇐ Extended­Bandwidth­Operation boolean W

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
⇐ UER int­[1:4096] W

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.

[UERComplex] 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/(231))(a(i)+jb(i))/(231) 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
⇐ UERScale­Factor unsigned­Int W

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
⇐ UERGroup­Size unsigned­Int­(1:2,­12) W

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
⇐ UERVar int­[0:4096] W

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**UERGroupSizeDf is VAR(iUERGroupSize**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
SELTQLN() command -

[ASYNC] This command performs a DSL Single Ended Line Test - Physical Medium Dependent (SELT-PMD) Quiet Line Noise (QLN).

This command 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
⇒ Input. arguments - Input arguments. -
⇒ Interface string­(:256) R 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
⇒ QLNMax­Measurement­Duration unsigned­Int­(1:240) R

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
⇐ Output. arguments - Output arguments. -
⇐ Status string W

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL)

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

 - 2.13
⇐ Extended­Bandwidth­Operation boolean W

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
⇐ QLN int­(:61430)[] W

Comma-separated list (maximum number of characters per item 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**QLNGroupSizeDf with Df=4.3125 kHz is defined as QLN(iQLNGroupSize**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
⇐ QLNGroup­Size unsigned­Int­(1:2,­12) W

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
SELTP() command -

[ASYNC] This command performs a DSL Single-Ended Line Test - Processed (SELT-P).

This command is for the CPE, aka the Transmission Unit - Remote end (TU-R).

Reference: ITU-T Recommendation [G.996.2].

 - 2.13
⇒ Input. arguments - Input arguments. -
⇒ Interface string­(:256) R 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
⇒ Capacity­Estimate­Enabling boolean R

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
⇒ Capacity­Signal­PSD unsigned­Int­[1:48] R

The capacity estimate signal Power Spectral Density (PSD):

Comma-separated list (1 to 48 items) of PSDBreak Point Index And Levels, with each list item consisting of the following.

[PSDBreakPointIndexAndLevel] 1. the Power Spectral Density (PSD) breakpoint sub-carrier index in the range [0:49152] with Df = 4.3125 kHz frequency spacing, and

  1. 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
⇒ Capacity­Noise­PSD unsigned­Int­[1:48] R

The capacity estimate noise Power Spectral Density (PSD):

Comma-separated list (1 to 48 items) of PSDBreak Point Index And Levels, with each list item consisting of the following.

[PSDBreakPointIndexAndLevel] 1. the Power Spectral Density (PSD) breakpoint sub-carrier index in the range [0:49152] with Df = 4.3125 kHz frequency spacing, and

  1. 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
⇒ Capacity­Target­Margin unsigned­Int­(0:310) R

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
⇐ Output. arguments - Output arguments. -
⇐ Status string W

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL)

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

 - 2.13
⇐ Loop­Termination string W

Loop termination indicator. Enumeration of:

  • Open
  • Short
  • Powered on DSLAM/DPU (This enumeration was OBSOLETED in 2.14 because it’s been removed from the ITU-T Recommendation. This enumeration was DELETED in 2.16)
  • Powered on CPE
  • Unknown

This parameter is defined as LOOP-TERM in ITU-T Recommendation [Clause B.1.1.1/G.996.2].

 - 2.13
⇐ Loop­Length unsigned­Int­(0:16383) W

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
⇐ Loop­Topology string­(:256)[] W

Comma-separated list (maximum number of characters per item 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
⇐ Attenuation­Characteristics unsigned­Int­[0:8191] W

Specifies the list of attenuation characteristics.

Comma-separated list (0 to 8191 items) of SELTPAttenuation Characteristics Index And TFlogs, with each list item consisting of the following.

[SELTPAttenuationCharacteristicsIndexAndTFlog] 1. The paired frequency spacing index in the range [0:8191], and

  1. 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
⇐ TFlog­Group­Size unsigned­Int­(1:2,­12) W

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
⇐ Missing­Filter boolean W

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
⇐ Capacity­Estimate unsigned­Int­[1:2] W

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
Device.­FAST. object R This object models FAST (defined in ITU Recommendation [G.9701]) lines. Each Line models a layer 1 FAST Line interface. - 2.11
Line­Number­Of­Entries unsigned­Int R The number of entries in the Line table. - 2.11
Device.­FAST.­Line.­{i}. object(0:) R

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

This table models physical FAST lines.

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

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

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

 - 2.11
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.11
Name string­(:64) R

The textual name of the FAST line as assigned by the CPE.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.11
Last­Change unsigned­Int R The accumulated time in seconds since the FAST line entered its current operational state. - 2.11
Lower­Layers string­(:1024)[] W

Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2].

Note: Since Device.FAST.Line.{i}. is a layer 1 interface, it is expected that LowerLayers will not be used.

 - 2.11
Upstream boolean R

Indicates whether the interface points towards the Internet (true) or towards End Devices (false).

For example:

  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
 - 2.11
Firmware­Version string­(:64) R A string identifying the version of the modem firmware currently installed for this interface. This is applicable only when the modem firmware is separable from the overall CPE software. - 2.11
Link­Status string R

Status of the FAST physical link. Enumeration of:

  • Up
  • Initializing
  • EstablishingLink
  • NoSignal
  • Disabled
  • Error (OPTIONAL)

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
Allowed­Profiles string­[] R

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

  • 106a
  • 212a

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

 - 2.11
Current­Profile string R The value MUST be a member of the list reported by the AllowedProfiles parameter, or else be an empty string. Indicates which FAST profile is currently in use on the line. - 2.11
Power­Management­State string R

The power management state of the line. Enumeration of:

  • L0
  • L2.1
  • L2.2
  • L3

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

 - 2.11
Success­Failure­Cause unsigned­Int­(0:5) R

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

  • 0: Successful
  • 1: Configuration error. Configuration error. This error occurs if the line cannot reach L0 state due to a mismatch of configuration and FTU capabilities.
  • 2: Configuration not feasible on the line. This error occurs if the line cannot reach the L0 state due to a mismatch of configuration of line and noise characteristics.
  • 3: Communication problem. This error occurs, for example, due to corrupted messages or bad syntax messages or if no common mode can be selected in the G.994.1 handshaking procedure or due to a timeout.
  • 4: No far-end FTU detected. This error occurs if the far-end FTU is not powered or not connected or if the line is too long to allow detection of a far-end FTU.
  • 5: Any other or unknown initialization failure cause.

Note: In G.997.2, this parameter is called “Initialization success/failure cause”. See Clause 7.20.2.1 of ITU-T

Recommendation [G.997.2].

 - 2.11
UPBOKLER unsigned­Int­(0:1280) R

This parameter reports the estimate of the electrical length expressed in 0.1 dB, as determined by the FTU-R (see clause 7.3.1.4.2.1/[G.9701]) and conveyed in the R-MSG1 initialization message (see clause 12.3.3.2.3/[G.9701]). The value is coded as an unsignedInt in the range 0 (coded as 0) to 128 dB (coded as 1280) in steps of 0.1 dB.

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

 - 2.11
Last­Transmitted­Downstream­Signal unsigned­Int­(0:21) R

This parameter reports the downstream signal count of the last transmitted initialization signal in the last full or short initialization performed on the line. The valid values are 0..21. The downstream signal count is defined in clause 12.3.1/[G.9701].

Note: See clause 7.10.2.2 ITU-T Recommendation [G.997.2].

 - 2.11
Last­Transmitted­Upstream­Signal unsigned­Int­(0:21) R

This parameter reports the upstream signal count of the last transmitted initialization signal in the last full or short initialization performed on the line. The valid values are 0..21. The upstream signal count is defined in clause 12.3.1/[G.9701].

Note: See clause 7.10.2.3 ITU-T Recommendation [G.997.2].

 - 2.11
UPBOKLE unsigned­Int­(0:1280) R

This parameter reports the electrical length expressed in 0.1dB, 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
Line­Number int­(1:) R Signifies the line pair that the modem is using to connection. LineNumber = 1 is the innermost pair. - 2.11
Upstream­Max­Bit­Rate unsigned­Int R

This parameter reports the attainable net data rate expressed in Kbps as defined in clause 11.4.1.1.2/[G.9701].

Note: This parameter is related to the G.997.2 parameter ATTNDRus. See clause 7.11.2.1 ITU-T Recommendation [G.997.2].

 - 2.11
Downstream­Max­Bit­Rate unsigned­Int R

This parameter reports the attainable net data rate expressed in Kbps as defined in clause 11.4.1.1.2/[G.9701].

Note: This parameter is related to the G.997.2 parameter ATTNDRds. See clause 7.11.2.1 ITU-T Recommendation [G.997.2].

 - 2.11
Upstream­Noise­Margin int R

This parameter reports the signal-to-noise ratio margin (as defined in clause 9.8.3.2/[G.9701] and 11.4.1.3/[G.9701]) in the upstream direction. A special value indicates that the signal-to-noise ratio margin is out of the range to be represented. The parameter is expressed in 0.1dB.

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

 - 2.11
Downstream­Noise­Margin int R

This parameter reports the signal-to-noise ratio margin (as defined in clause 9.8.3.2/[G.9701] and 11.4.1.3/[G.9701]) in the upstream direction. A special value indicates that the signal-to-noise ratio margin is out of the range to be represented. The parameter is expressed in 0.1dB.

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

 - 2.11
Upstream­Attenuation int R The current upstream signal loss (expressed in 0.1dB). - 2.11
Downstream­Attenuation int R The current downstream signal loss (expressed in 0.1dB). - 2.11
Upstream­Power int R The current output power at the CPE’s FAST line (expressed in 0.1dBmV). - 2.11
Downstream­Power int R The current received power at the CPE’s FAST line (expressed in 0.1dBmV). - 2.11
SNRMRMCds int R This parameter reports the signal-to-noise margin for the robust management channel (RMC) in the downstream direction (express in 0.1dB). A special value (-512) indicates that the signal-to-noise ratio margin for the RMC is out of the range to be represented. This parameter is defined in clauses 7.10.12.1 of ITU-T Recommendation [G.997.2]. - 2.11
SNRMRMCus int R This parameter reports the signal-to-noise margin for the robust management channel (RMC) in the upstream direction (express in 0.1dB). A special value (-512) indicates that the signal-to-noise ratio margin for the RMC is out of the range to be represented. This parameter is defined in clauses 7.10.12.2 of ITU-T Recommendation [G.997.2]. - 2.11
BITSRMCpsds int­(:4610)[] R Comma-separated list (maximum number of characters per item 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
BITSRMCpsus int­(:4610)[] R Comma-separated list (maximum number of characters per item 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
FEXTCANCELds boolean R This indicates whether FEXT cancellation in the downstream direction from all the other vectored lines into the line in the vectored group is enabled (TRUE) or disabled (FALSE). This parameter is defined as FEXT_TO_CANCEL_ENABLEds in clause 7.1.7.1 of ITU Recommendation [G.997.2]. - 2.11
FEXTCANCELus boolean R This indicates whether FEXT cancellation in the upstream direction from all the other vectored lines into the line in the vectored group is enabled (TRUE) or disabled (FALSE). This parameter is defined as FEXT_TO_CANCEL_ENABLEds in clause 7.1.7.1 of ITU Recommendation [G.997.2]. - 2.11
ETRds unsigned­Int R This parameter reports the expected throughput rate expressed in Kbps as defined in clause 7.11.1.2 of ITU-T Recommendation [G.997.2] - 2.11
ETRus unsigned­Int R This parameter reports the expected throughput rate expressed in Kbps as defined in clause 7.11.1.2 of ITU-T Recommendation [G.997.2] - 2.11
ATTETRds unsigned­Int R This parameter reports the attainable expected throughput expressed in Kbps as defined in clause 7.11.2.2 of ITU-T Recommendation [G.997.2] - 2.11
ATTETRus unsigned­Int R This parameter reports the attainable expected throughput expressed in Kbps as defined in clause 7.11.2.2 of ITU-T Recommendation [G.997.2] - 2.11
MINEFTR unsigned­Int R This parameter reports the minimum error free throughput value expressed in Kbps computed from power up as defined in clause 11.4.1.1.3 of ITU-T Recommendation [G.9701] - 2.11
Device.­FAST.­Line.­{i}.­Stats. object R

Throughput statistics for this interface.

The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

 - 2.11
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.11
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.11
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.11
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.11
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.11
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.11
Discard­Packets­Sent unsigned­Int R The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.11
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.11
Total­Start unsigned­Int R

FAST-specific statistic. The Number of seconds since the beginning of the period used for collection of Total statistics.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

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

 - 2.11
Showtime­Start unsigned­Int R

FAST-specific statistic. The Number of seconds since the most recent DSL Showtime - the beginning of the period used for collection of Showtime statistics.

Showtime is defined as successful completion of the DSL link establishment process. The Showtime statistics are those collected since the most recent establishment of the DSL link.

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

 - 2.11
Last­Showtime­Start unsigned­Int R

FAST-specific statistic. The Number of seconds since the second most recent DSL Showtime-the beginning of the period used for collection of LastShowtime statistics.

If the CPE has not retained information about the second most recent Showtime (e.g., on reboot), the start of LastShowtime statistics MAY temporarily coincide with the start of Showtime statistics.

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

 - 2.11
Current­Day­Start unsigned­Int R

FAST-specific statistic. The Number of seconds since the beginning of the period used for collection of CurrentDay statistics.

The CPE MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

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

 - 2.11
Quarter­Hour­Start unsigned­Int R

FAST-specific statistic. The Number of seconds since the beginning of the period used for collection of QuarterHour statistics.

The CPE MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so.

Statistics SHOULD continue to be accumulated across CPE reboots, though this might not always be possible.

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

 - 2.11
Device.­FAST.­Line.­{i}.­Stats.­Total. object R

This object contains DSL line total statistics.

Note: The Device.FAST.Line.{i}.Stats.Total. parameters SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle.

 - 2.11
Errored­Secs unsigned­Int R Total number of errored seconds as defined in ITU-T Rec. [G.997.2]. An errored second (ES) is declared if, during a 1-second interval, there are one or more crc anomalies, or one or more los defects, or one or more lor defects, or one or more lpr primitives. - 2.11
Severely­Errored­Secs unsigned­Int R Total number of severely errored seconds as defined in ITU-T Rec. [G.997.2]. - 2.11
LOSS unsigned­Int R Total number of loss of signal seconds (LOSS) as defined in ITU-T Rec. [G.997.2]. A LOSS is declared if, during a 1-second interval, there are one or more los defects. - 2.11
LORS unsigned­Int R Total number of loss of RMC seconds (LORS) as defined in ITU-T Rec. [G.997.2]. A LORS is declared if, during a 1-second interval, there are one or more lor defects. - 2.11
UAS unsigned­Int R Total number of unavailable seconds (UAS) as defined in ITU-T Rec. [G.997.2]. - 2.11
RTXUC unsigned­Int R This parameter reports a count of uncorrected DTU anomalies (rtx_uc). This parameter is defined in clause 7.8.5 of ITU-T Rec. [G.997.2]. - 2.11
RTXTX unsigned­Int R This parameter reports a count of retransmitted DTU anomalies (rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec. [G.997.2]. - 2.11
Success­BSW unsigned­Int R This parameter reports a count of the successful bit swap (BSW) primitives. This parameter is defined as success_BSW in clause 7.7.20 of ITU-T Rec. [G.997.2]. - 2.11
Success­SRA unsigned­Int R This parameter reports a count of the successful autonomous SRA (seamless rate adaptation) primitives. This parameter is defined as success_SRA in clause 7.7.21 of ITU-T Rec. [G.997.2]. - 2.11
Success­FRA unsigned­Int R This parameter reports a count of the successful FRA (fast rate adaptation) primitives. This parameter is defined as success_FRA in clause 7.7.22 of ITU-T Rec. [G.997.2]. - 2.11
Success­RPA unsigned­Int R This parameter reports a count of the successful RPA (RMC parameter adjustment) primitives. This parameter is defined as success_RPA in clause 7.7.23 of ITU-T Rec. [G.997.2]. - 2.11
Success­TIGA unsigned­Int R This parameter reports a count of the successful TIGA (transmitter initiated gain adjustment) primitives. This parameter is defined as success_TIGA in clause 7.7.24 of ITU-T Rec. [G.997.2]. - 2.11
Device.­FAST.­Line.­{i}.­Stats.­Showtime. object R

This object contains FAST line statistics since the most recent showtime.

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

 - 2.11
Errored­Secs unsigned­Int R Total number of errored seconds as defined in ITU-T Rec. [G.997.2]. An errored second (ES) is declared if, during a 1-second interval, there are one or more crc anomalies, or one or more los defects, or one or more lor defects, or one or more lpr primitives. - 2.11
Severely­Errored­Secs unsigned­Int R Total number of severely errored seconds as defined in ITU-T Rec. [G.997.2]. - 2.11
LOSS unsigned­Int R Total number of loss of signal seconds (LOSS) as defined in ITU-T Rec. [G.997.2]. A LOSS is declared if, during a 1-second interval, there are one or more los defects. - 2.11
LORS unsigned­Int R Total number of loss of RMC seconds (LORS) as defined in ITU-T Rec. [G.997.2]. A LORS is declared if, during a 1-second interval, there are one or more lor defects. - 2.11
UAS unsigned­Int R Total number of unavailable seconds (UAS) as defined in ITU-T Rec. [G.997.2]. - 2.11
RTXUC unsigned­Int R This parameter reports a count of uncorrected DTU anomalies (rtx_uc). This parameter is defined in clause 7.8.5 of ITU-T Rec. [G.997.2]. - 2.11
RTXTX unsigned­Int R This parameter reports a count of retransmitted DTU anomalies (rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec. [G.997.2]. - 2.11
Success­BSW unsigned­Int R This parameter reports a count of the successful bit swap (BSW) primitives. This parameter is defined as success_BSW in clause 7.7.20 of ITU-T Rec. [G.997.2]. - 2.11
Success­SRA unsigned­Int R This parameter reports a count of the successful autonomous SRA (seamless rate adaptation) primitives. This parameter is defined as success_SRA in clause 7.7.21 of ITU-T Rec. [G.997.2]. - 2.11
Success­FRA unsigned­Int R This parameter reports a count of the successful FRA (fast rate adaptation) primitives. This parameter is defined as success_FRA in clause 7.7.22 of ITU-T Rec. [G.997.2]. - 2.11
Success­RPA unsigned­Int R This parameter reports a count of the successful RPA (RMC parameter adjustment) primitives. This parameter is defined as success_RPA in clause 7.7.23 of ITU-T Rec. [G.997.2]. - 2.11
Success­TIGA unsigned­Int R This parameter reports a count of the successful TIGA (transmitter initiated gain adjustment) primitives. This parameter is defined as success_TIGA in clause 7.7.24 of ITU-T Rec. [G.997.2]. - 2.11
Device.­FAST.­Line.­{i}.­Stats.­Last­Showtime. object R

This object contains FAST line statistics since the second most recent showtime.

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

 - 2.11
Errored­Secs unsigned­Int R Total number of errored seconds as defined in ITU-T Rec. [G.997.2]. An errored second (ES) is declared if, during a 1-second interval, there are one or more crc anomalies, or one or more los defects, or one or more lor defects, or one or more lpr primitives. - 2.11
Severely­Errored­Secs unsigned­Int R Total number of severely errored seconds as defined in ITU-T Rec. [G.997.2]. - 2.11
LOSS unsigned­Int R Total number of loss of signal seconds (LOSS) as defined in ITU-T Rec. [G.997.2]. A LOSS is declared if, during a 1-second interval, there are one or more los defects. - 2.11
LORS unsigned­Int R Total number of loss of RMC seconds (LORS) as defined in ITU-T Rec. [G.997.2]. A LORS is declared if, during a 1-second interval, there are one or more lor defects. - 2.11
UAS unsigned­Int R Total number of unavailable seconds (UAS) as defined in ITU-T Rec. [G.997.2]. - 2.11
RTXUC unsigned­Int R This parameter reports a count of uncorrected DTU anomalies (rtx_uc). This parameter is defined in clause 7.8.5 of ITU-T Rec. [G.997.2]. - 2.11
RTXTX unsigned­Int R This parameter reports a count of retransmitted DTU anomalies (rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec. [G.997.2]. - 2.11
Success­BSW unsigned­Int R This parameter reports a count of the successful bit swap (BSW) primitives. This parameter is defined as success_BSW in clause 7.7.20 of ITU-T Rec. [G.997.2]. - 2.11
Success­SRA unsigned­Int R This parameter reports a count of the successful autonomous SRA (seamless rate adaptation) primitives. This parameter is defined as success_SRA in clause 7.7.21 of ITU-T Rec. [G.997.2]. - 2.11
Success­FRA unsigned­Int R This parameter reports a count of the successful FRA (fast rate adaptation) primitives. This parameter is defined as success_FRA in clause 7.7.22 of ITU-T Rec. [G.997.2]. - 2.11
Success­RPA unsigned­Int R This parameter reports a count of the successful RPA (RMC parameter adjustment) primitives. This parameter is defined as success_RPA in clause 7.7.23 of ITU-T Rec. [G.997.2]. - 2.11
Success­TIGA unsigned­Int R This parameter reports a count of the successful TIGA (transmitter initiated gain adjustment) primitives. This parameter is defined as success_TIGA in clause 7.7.24 of ITU-T Rec. [G.997.2]. - 2.11
Device.­FAST.­Line.­{i}.­Stats.­Current­Day. object R

This object contains FAST line statistics accumulated during the current day.

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

 - 2.11
Errored­Secs unsigned­Int R Total number of errored seconds as defined in ITU-T Rec. [G.997.2]. An errored second (ES) is declared if, during a 1-second interval, there are one or more crc anomalies, or one or more los defects, or one or more lor defects, or one or more lpr primitives. - 2.11
Severely­Errored­Secs unsigned­Int R Total number of severely errored seconds as defined in ITU-T Rec. [G.997.2]. - 2.11
LOSS unsigned­Int R Total number of loss of signal seconds (LOSS) as defined in ITU-T Rec. [G.997.2]. A LOSS is declared if, during a 1-second interval, there are one or more los defects. - 2.11
LORS unsigned­Int R Total number of loss of RMC seconds (LORS) as defined in ITU-T Rec. [G.997.2]. A LORS is declared if, during a 1-second interval, there are one or more lor defects. - 2.11
UAS unsigned­Int R Total number of unavailable seconds (UAS) as defined in ITU-T Rec. [G.997.2]. - 2.11
RTXUC unsigned­Int R This parameter reports a count of uncorrected DTU anomalies (rtx_uc). This parameter is defined in clause 7.8.5 of ITU-T Rec. [G.997.2]. - 2.11
RTXTX unsigned­Int R This parameter reports a count of retransmitted DTU anomalies (rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec. [G.997.2]. - 2.11
Success­BSW unsigned­Int R This parameter reports a count of the successful bit swap (BSW) primitives. This parameter is defined as success_BSW in clause 7.7.20 of ITU-T Rec. [G.997.2]. - 2.11
Success­SRA unsigned­Int R This parameter reports a count of the successful autonomous SRA (seamless rate adaptation) primitives. This parameter is defined as success_SRA in clause 7.7.21 of ITU-T Rec. [G.997.2]. - 2.11
Success­FRA unsigned­Int R This parameter reports a count of the successful FRA (fast rate adaptation) primitives. This parameter is defined as success_FRA in clause 7.7.22 of ITU-T Rec. [G.997.2]. - 2.11
Success­RPA unsigned­Int R This parameter reports a count of the successful RPA (RMC parameter adjustment) primitives. This parameter is defined as success_RPA in clause 7.7.23 of ITU-T Rec. [G.997.2]. - 2.11
Success­TIGA unsigned­Int R This parameter reports a count of the successful TIGA (transmitter initiated gain adjustment) primitives. This parameter is defined as success_TIGA in clause 7.7.24 of ITU-T Rec. [G.997.2]. - 2.11
Device.­FAST.­Line.­{i}.­Stats.­Quarter­Hour. object R

This object contains FAST line statistics accumulated during the current quarter hour.

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

 - 2.11
Errored­Secs unsigned­Int R Total number of errored seconds as defined in ITU-T Rec. [G.997.2]. An errored second (ES) is declared if, during a 1-second interval, there are one or more crc anomalies, or one or more los defects, or one or more lor defects, or one or more lpr primitives. - 2.11
Severely­Errored­Secs unsigned­Int R Total number of severely errored seconds as defined in ITU-T Rec. [G.997.2]. - 2.11
LOSS unsigned­Int R Total number of loss of signal seconds (LOSS) as defined in ITU-T Rec. [G.997.2]. A LOSS is declared if, during a 1-second interval, there are one or more los defects. - 2.11
LORS unsigned­Int R Total number of loss of RMC seconds (LORS) as defined in ITU-T Rec. [G.997.2]. A LORS is declared if, during a 1-second interval, there are one or more lor defects. - 2.11
UAS unsigned­Int R Total number of unavailable seconds (UAS) as defined in ITU-T Rec. [G.997.2]. - 2.11
RTXUC unsigned­Int R This parameter reports a count of uncorrected DTU anomalies (rtx_uc). This parameter is defined in clause 7.8.5 of ITU-T Rec. [G.997.2]. - 2.11
RTXTX unsigned­Int R This parameter reports a count of retransmitted DTU anomalies (rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec. [G.997.2]. - 2.11
Success­BSW unsigned­Int R This parameter reports a count of the successful bit swap (BSW) primitives. This parameter is defined as success_BSW in clause 7.7.20 of ITU-T Rec. [G.997.2]. - 2.11
Success­SRA unsigned­Int R This parameter reports a count of the successful autonomous SRA (seamless rate adaptation) primitives. This parameter is defined as success_SRA in clause 7.7.21 of ITU-T Rec. [G.997.2]. - 2.11
Success­FRA unsigned­Int R This parameter reports a count of the successful FRA (fast rate adaptation) primitives. This parameter is defined as success_FRA in clause 7.7.22 of ITU-T Rec. [G.997.2]. - 2.11
Success­RPA unsigned­Int R This parameter reports a count of the successful RPA (RMC parameter adjustment) primitives. This parameter is defined as success_RPA in clause 7.7.23 of ITU-T Rec. [G.997.2]. - 2.11
Success­TIGA unsigned­Int R This parameter reports a count of the successful TIGA (transmitter initiated gain adjustment) primitives. This parameter is defined as success_TIGA in clause 7.7.24 of ITU-T Rec. [G.997.2]. - 2.11
Device.­FAST.­Line.­{i}.­Test­Params. object R This object contains the FAST line test parameters that are available during the L0 (i.e., Showtime) state. - 2.11
SNRGds unsigned­Int R

Reports the number of sub-carriers in any one sub-carrier group used to represent the downstream SNR(f) values. Valid values are 1, 2, 4, and 8.

Note: In ITU-T G.9701-2014, the only valid value is G = 1. See clause 7.10.8.2 ITU-T Recommendation [G.997.2].

 - 2.11
SNRGus unsigned­Int R

Reports the number of sub-carriers in any one sub-carrier group used to represent the upstream SNR(f) values. Valid values are 1, 2, 4, and 8.

Note: In ITU-T G.9701-2014, the only valid value is G = 1. See clause 7.10.8.5 ITU-T Recommendation [G.997.2].

 - 2.11
SNRpsds int­(:2047)[] R

Comma-separated list (maximum number of characters per item 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
SNRpsus string­(:2047)[] R

Comma-separated list (maximum number of characters per item 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
SNRMTds unsigned­Int R

Reports the number of symbols used to measure the downstream SNR(f) values. The valid values 0..65535.

Note: See clause 7.10.8.1 of ITU-T Recommendation [G.997.2].

 - 2.11
SNRMTus unsigned­Int R

Reports the number of symbols used to measure the upstream SNR(f) values. The valid values 0..65535.

Note: See clause 7.10.8.4 of ITU-T Recommendation [G.997.2].

 - 2.11
ACTINP unsigned­Int R

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

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

 - 2.11
NFEC unsigned­Int R

Reports the DTU FEC codeword length (expressed in 1 byte unit) as defined in clause 9.3/[G.9701]. The valid range is 32..255.

Note: See clause 7.11.4.1 ITU-T Recommendation [G.997.2].

 - 2.11
RFEC int R

Reports the DTU FEC codeword redundancy as defined in clause 9.3/[G.9701].

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

 - 2.11
Upstream­Curr­Rate unsigned­Int R

Reports the current physical layer aggregate data rate (expressed in Kbps) of the upstream FAST as defined in clause 11.4.1.1.1/[G.9701].

The current physical layer aggregate data rate (expressed in Kbps) of the upstream FAST connection. The valid values are 0..4294967295(0 to 232-1 kbit/s).

 - 2.11
Downstream­Curr­Rate unsigned­Int R

Reports the current physical layer aggregate data rate (expressed in Kbps) of the upstream FAST as defined in clause 11.4.1.1.1/[G.9701].

The current physical layer aggregate data rate (expressed in Kbps) of the downstream FAST connection. The valid values are 0..4294967295(0 to 232-1 kbit/s).

 - 2.11
ACTINPREIN unsigned­Int R Reports the actual INP against REIN as defined in clause 11.4.1.1.8/[G.9701]. A special value indicates an actual INP against REIN of 63 symbols or higher. The valid range is 0..62 symbols, and 63 is the special value. - 2.11
Device.­Optical. object R

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
Interface­Number­Of­Entries unsigned­Int R The number of entries in the Interface table. - 2.4
Device.­Optical.­Interface.­{i}. object(0:) R

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

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

 - 2.4
Enable boolean W

Enables or disables the optical interface.

This parameter is based on ifAdminStatus from [RFC2863].

 - 2.4
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

 - 2.4
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.4
Name string­(:64) R

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

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.4
Last­Change unsigned­Int R The accumulated time in seconds since the optical interface entered its current operational state. - 2.4
Lower­Layers string­(:1024)[] W

Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2].

Note: Since Device.Optical.Interface.{i}. is a layer 1 interface, it is expected that LowerLayers will not be used.

 - 2.4
Upstream boolean R

Indicates whether the interface points towards the Internet (true) or towards End Devices (false).

For example:

  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
 - 2.4
Optical­Signal­Level int R

Current measurement of total downstream optical signal level.

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

Valid values are -65.536 dBm (coded as -65536), to 65.534 dBm (coded as 65534) in 0.002 dB increments.

This parameter is based on Optical signal level from [Section 9.2.1/G.988].

 - 2.4
Lower­Optical­Threshold int R
Optical level that is used to declare the downstream low received optical power alarm.
[Dbm1000] The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.
Valid values are -127.5 dBm (coded as -127500) to 0 dBm (coded as 0) in 0.5 dB increments. The value -127500 indicates the device’s internal policy.
This parameter is based on Lower optical threshold from [Section 9.2.1/G.988].
This parameter was DEPRECATED in 2.15 because it is not intended for the device to raise an optical power alarm.
 - 2.4
Upper­Optical­Threshold int R
Optical level that is used to declare the downstream high received optical power alarm.
[Dbm1000] The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.
Valid values are -127.5 dBm (coded as -127500) to 0 dBm (coded as 0) in 0.5 dB increments. The value -127500 indicates the device’s internal policy.
This parameter is based on Upper optical threshold from [Section 9.2.1/G.988].
This parameter was DEPRECATED in 2.15 because it is not intended for the device to raise an optical power alarm.
 - 2.4
Transmit­Optical­Level int R

Current measurement of mean optical launch power.

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

Valid values are -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
Lower­Transmit­Power­Threshold int R
Minimum mean optical launch power that is used to declare the low transmit optical power alarm.
[Dbm1000] The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.
Valid values are -63.5 dBm (coded as -63500) to +63.5 dBm (coded as 63500) in 0.5 dB increments. The value -63500 indicates the device’s internal policy.
This parameter is based on Lower transmit power threshold from [Section 9.2.1/G.988].
This parameter was DEPRECATED in 2.15 because it is not intended for the device to raise an optical power alarm.
 - 2.4
Upper­Transmit­Power­Threshold int R
Maximum mean optical launch power that is used to declare the high transmit optical power alarm.
[Dbm1000] The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.
Valid values are -63.5 dBm (coded as -63500) to +63.5 dBm (coded as 63500) in 0.5 dB increments. The value -63500 indicates the device’s internal policy.
This parameter is based on Upper transmit power threshold from [Section 9.2.1/G.988].
This parameter was DEPRECATED in 2.15 because it is not intended for the device to raise an optical power alarm.
 - 2.4
Device.­Optical.­Interface.­{i}.­Stats. object R

Throughput statistics for this interface.

The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

 - 2.4
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.4
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.4
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.4
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.4
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.4
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.4
Discard­Packets­Sent unsigned­Int R The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.4
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.4
Device.­Cellular. object R This object models cellular interfaces and access points. - 2.8
Roaming­Enabled boolean W Enables or disables roaming. - 2.8
Roaming­Status string R

Current roaming status. Enumeration of:

  • Home
  • Roaming
 - 2.8
Interface­Number­Of­Entries unsigned­Int R The number of entries in the Interface table. - 2.8
Access­Point­Number­Of­Entries unsigned­Int R The number of entries in the AccessPoint table. - 2.8
Device.­Cellular.­Interface.­{i}. object(0:) R

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

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

 - 2.8
Enable boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

 - 2.8
Status string R

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

  • Up (Corresponds to GPRS, UMTS, LTE etc ATTACHED status)
  • Down
  • Unknown
  • Dormant
  • NotPresent (Corresponds to GPRS, UMTS, LTE etc DETACHED status)
  • LowerLayerDown
  • Error (OPTIONAL)

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status

  • SHOULD change to Up if and only if the interface is able to transmit and receive network traffic.
  • SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed)
  • SHOULD remain in the Error state if there is an error or other fault condition detected on the interface
  • SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

Because the interface includes layer 1 the LowerLayerDown value SHOULD never be used.

This parameter is based on ifOperStatus from [RFC2863].

 - 2.8
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.8
Name string­(:64) R

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

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.8
Last­Change unsigned­Int R The accumulated time in seconds since the interface entered its current operational state. - 2.8
Lower­Layers string­(:1024)[] W

Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2].

Note: Since Device.Cellular.Interface.{i}. is a layer 1 interface, it is expected that LowerLayers will not be used.

 - 2.8
Upstream boolean R

Indicates whether the interface points towards the Internet (true) or towards End Devices (false).

For example:

  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
 - 2.8
IMEI string­(15) R

International Mobile Station Equipment Identity number, represented as a 15 digit string (digits 0-9). Possible patterns:

  • [0-9]{15,15}
 - 2.8
Supported­Access­Technologies string­[] R

Comma-separated list of strings. Access technologies supported by the interface. Each list item is an enumeration of:

  • GPRS (GSM with GPRS)
  • EDGE (GSM with EDGE)
  • UMTS
  • UMTSHSPA (UMTS with High Speed Packet Access (HSPA [3GPP-HSPA]))
  • CDMA2000OneX
  • CDMA2000HRPD
  • LTE
  • NR (5G New Radio, added in 2.14)
 - 2.8
Preferred­Access­Technology 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
Current­Access­Technology string R The value MUST be a member of the list reported by the SupportedAccessTechnologies parameter. Access technology that is currently in use. - 2.8
Available­Networks string­(:64)[] R Comma-separated list of strings (maximum number of characters per item 64). List of available networks. - 2.8
Network­Requested string­(:64) W

Name of the network which will be used, or an empty string if the network is selected automatically.

The factory default value MUST be an empty string.

 - 2.8
Network­In­Use string­(:64) R The value MUST be a member of the list reported by the AvailableNetworks parameter, or else be an empty string. The value is an empty string if no network is found, or if the network specified in NetworkRequested is not found. - 2.8
RSSI int R

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

  • For GPRS, EDGE the range is -111 dBm to -49 dBm
  • For UMTS, UMTSHSPA the range is -117 dBm to -54 dBm
  • For LTE, 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
RSRP int R

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
RSRQ int R

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
Upstream­Max­Bit­Rate unsigned­Int R The current maximum attainable data rate upstream (expressed in Kbps). - 2.8
Downstream­Max­Bit­Rate unsigned­Int R The current maximum attainable data rate downstream (expressed in Kbps). - 2.8
Device.­Cellular.­Interface.­{i}.­USIM. object R USIM (Universal Subscriber Identity Module or SIM card) parameters for the interface. - 2.8
Status string R

The current status of the USIM card. Enumeration of:

  • None (No card available)
  • Available (Card is available but not verified)
  • Valid (Card can be used; either valid PIN was entered, or PIN check is deactivated)
  • Blocked (USIM is blocked because the maximum number of invalid PIN entries was exceeded)
  • Error (An error was detected with the card, OPTIONAL)
 - 2.8
IMSI string­(14:15) R

International Mobile Subscriber Identity represented as a string with either 14 or 15 digits (digits 0-9). The first 3 digits are the mobile country code (MCC), which are followed by the mobile network code (MNC), either 2 digits (European standard) or 3 digits (North American standard), followed by the mobile subscription identification number (MSIN). Possible patterns:

  • [0-9]{14,15}
 - 2.8
ICCID string­(6:20) R

Integrated Circuit Card Identifier represented as a string of up to 20 digits (digits 0-9). The number is composed of the following parts:

  • Major industry identifier (MII), 2 fixed digits, 89 for telecommunication purposes.
  • Country code, 1–3 digits, as defined by ITU-T recommendation [ITU-E.164].
  • identifier, 1–4 digits.
  • Individual account identification number. Its length is variable, but every number under one IIN will have the same length.
  • Single check digit calculated from the other digits using the Luhn algorithm.

For cards using an ICCID according to [ITU-E.118] the maximum length is 19 Digits, for GSM cards 20 digits. Possible patterns:

  • [0-9]{6,20}
 - 2.8
MSISDN string­(14:15) R

Mobile Subscriber Integrated Service Digital Network Number, a number uniquely identifying a subscription in a GSM, UMTS, or LTE mobile network. [ITU-E.164] Possible patterns:

  • [0-9]{14,15}
 - 2.8
PINCheck string W

Controls the PIN verification of the USIM card. Enumeration of:

  • OnNetworkAccess (Check the PIN with each access to a new network)
  • Reboot (Check the PIN with first access after (re)boot)
  • Off (Disable the PIN check)
 - 2.8
PIN string­(:4) W

Allows the 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
Device.­Cellular.­Interface.­{i}.­Stats. object R

Throughput statistics for this interface.

The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

 - 2.8
Bytes­Sent unsigned­Long R [StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters. - 2.8
Bytes­Received unsigned­Long R [StatsCounter64] The total number of bytes received on the interface, including framing characters. - 2.8
Packets­Sent unsigned­Long R [StatsCounter64] The total number of packets transmitted out of the interface. - 2.8
Packets­Received unsigned­Long R [StatsCounter64] The total number of packets received on the interface. - 2.8
Errors­Sent unsigned­Long R [StatsCounter64] The total number of outbound packets that could not be transmitted because of errors. - 2.8
Errors­Received unsigned­Long R [StatsCounter64] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.8
Unicast­Packets­Sent unsigned­Long R [StatsCounter64] The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.8
Unicast­Packets­Received unsigned­Long R [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.8
Discard­Packets­Sent unsigned­Long R [StatsCounter64] The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.8
Discard­Packets­Received unsigned­Long R [StatsCounter64] The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.8
Multicast­Packets­Sent unsigned­Long R [StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.8
Multicast­Packets­Received unsigned­Long R [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.8
Broadcast­Packets­Sent unsigned­Long R [StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.8
Broadcast­Packets­Received unsigned­Long R [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.8
Unknown­Proto­Packets­Received unsigned­Long R [StatsCounter64] The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.8
Device.­Cellular.­Access­Point.­{i}. object(0:) W

Cellular Access Point table. Each entry is identified by an APN (Access Point Name) that identifies a gateway between the mobile network and another computer network.

At most one entry in this table can exist with a given value for Alias, or with a given value for APN, or with a given value for Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, APN and Interface such that the new entry does not conflict with any existing entries.

 - 2.8
Enable boolean W Enables or disables the Access Point. - 2.8
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.8
APN string­(:64) W

Access Point Name.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

 - 2.8
Username string­(:256) W Username used to authenticate the CPE when making a connection to the Access Point. - 2.8
Password string­(:256) W

Password used to authenticate the CPE when making a connection to the Access Point.

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

 - 2.8
Proxy string­(:45) W [IPAddress] Proxy server IP address. - 2.8
Proxy­Port unsigned­Int­(1:65535) W Proxy server port. - 2.8
Interface string W

The value MUST be the Path Name of a row in the Interface. table. Reference to the interface with which the access point is associated.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

 - 2.8
Device.­ATM. object R Asynchronous Transfer Mode (ATM) object that contains the Link interface and Diagnostics.F5Loopback() diagnostics. - 2.0
Link­Number­Of­Entries unsigned­Int R The number of entries in the Link table. - 2.0
Device.­ATM.­Link.­{i}. object(0:) W

ATM link-layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Models an ATM PVC virtual circuit and the ATM Adaption Layer (AAL). An ATM Link entry is typically stacked on top of either a DSL.Channel or a DSL.BondingGroup object.

When an ATM Link interface is used, a lower-layer DSL.Channel interface MUST be configured with ATM encapsulation (see DSL.Channel.{i}.LinkEncapsulationUsed).

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

 - 2.0
Enable boolean W

Enables or disables the link.

This parameter is based on ifAdminStatus from [RFC2863].

 false 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

 Down 2.0
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.0
Name string­(:64) R

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

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

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

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

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

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

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

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

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

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

  • \d+/\d+

Example:

  • 0/35, 8/35, 1/35
 - 2.0
AAL string R

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

  • AAL1
  • AAL2
  • AAL3
  • AAL4
  • AAL5
 - 2.0
Device.­ATM.­Link.­{i}.­Stats. object R

Throughput statistics for this interface.

The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

 - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int R The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Transmitted­Blocks unsigned­Int R The current count of successfully transmitted cells. - 2.0
Received­Blocks unsigned­Int R The current count of successfully received cells. - 2.0
CRCErrors unsigned­Int R

Count of the ATM layer cyclic redundancy check (CRC) errors.

This refers to CRC errors at the ATM adaptation layer (AAL). The AAL in use is indicated by the AAL parameter. The value of the CRCErrors parameter MUST be 0 for AAL types that have no CRCs.

 - 2.0
HECErrors unsigned­Int R Count of the number of Header Error Check related errors at the ATM layer. - 2.0
Device.­ATM.­Link.­{i}.­Qo­S. object R The ATM Link QoS object. - 2.0
Qo­SClass string W

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

  • UBR
  • CBR
  • GFR
  • VBR-nrt
  • VBR-rt
  • UBR+
  • ABR
 - 2.0
Peak­Cell­Rate unsigned­Int W Specifies the upstream peak cell rate in cells per second. - 2.0
Maximum­Burst­Size unsigned­Int W Specifies the upstream maximum burst size in cells. - 2.0
Sustainable­Cell­Rate unsigned­Int W Specifies the upstream sustainable cell rate, in cells per second. - 2.0
Device.­ATM.­Diagnostics. object R The ATM Diagnostics object. - 2.0
F5Loopback­() command - [ASYNC] This command provides access to an ATM-layer F5 OAM loopback test. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Interface string­(:256) R [MANDATORY] The value MUST be the Path Name of a row in the ATM.Link. table. This is the interface over which the test is to be performed. - 2.12
⇒ Number­Of­Repetitions unsigned­Int­(1:) R [MANDATORY] Number of repetitions of the ping test to perform before reporting the results. - 2.12
⇒ Timeout unsigned­Int­(1:) R [MANDATORY] Timeout in milliseconds for the ping test. - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string W

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL)
  • Error_Internal
  • Error_Other

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

 - 2.13
⇐ Success­Count unsigned­Int W Result parameter indicating the number of successful pings (those in which a successful response was received prior to the timeout) in the most recent ping test. - 2.12
⇐ Failure­Count unsigned­Int W Result parameter indicating the number of failed pings in the most recent ping test. - 2.12
⇐ Average­Response­Time unsigned­Int W Result parameter indicating the average response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 2.12
⇐ Minimum­Response­Time unsigned­Int W Result parameter indicating the minimum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 2.12
⇐ Maximum­Response­Time unsigned­Int W Result parameter indicating the maximum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 2.12
Device.­DOCSIS. object R DOCSIS object. This object models the DOCSIS 3.x cable interface objects. - 2.15
Capabilities­Req hex­Binary­(0,­2:255) R

[docsIf3CmCapabilitiesReq/1.3.6.1.4.1.4491.2.1.20.1.21.1] [TLV8] This attribute contains the TLV encoding for TLV-5 sent in a REG-REQ. The first byte of this encoding is expected to be 0x05.

See [CM-SP-MULPIv3.0], Modem Capabilities Encoding in the Common Radio Frequency Interface Encodings Annex.

 - 2.15
Capabilities­Rsp hex­Binary­(0,­2:255) R

[docsIf3CmCapabilitiesRsp/1.3.6.1.4.1.4491.2.1.20.1.21.2] [TLV8] This attribute contains the TLV encoding for TLV-5 received in a REG-RSP. The first byte of this encoding is expected to be 0x05.

See [CM-SP-MULPIv3.0], Modem Capabilities Encoding in the Common Radio Frequency Interface Encodings Annex.

 - 2.15
Downstream­Number­Of­Entries unsigned­Int R The number of entries in the Downstream table. - 2.15
Upstream­Number­Of­Entries unsigned­Int R The number of entries in the Upstream table. - 2.15
Downstream­Channel­Number­Of­Entries unsigned­Int R The number of entries in the DownstreamChannel table. - 2.15
Upstream­Channel­Number­Of­Entries unsigned­Int R The number of entries in the UpstreamChannel table. - 2.15
Interface­Number­Of­Entries unsigned­Int R The number of entries in the Interface table. - 2.15
Device.­DOCSIS.­Downstream.­{i}. object(0:) R

DOCSIS Downstream interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the PHY DOCSIS Downstream interface.

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

 - 2.15
Enable boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

 - 2.15
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

 - 2.15
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.15
Name string­(:64) R

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

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.15
Last­Change unsigned­Int R The accumulated time in seconds since the interface entered its current operational state. - 2.15
Lower­Layers string­(:1024)[] W

Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2].

Note: Since Device.DOCSIS.Downstream.{i}. is a layer 1 interface, it is expected that LowerLayers will not be used.

 - 2.15
Upstream boolean R

Indicates whether the interface points towards the Internet (true) or towards End Devices (false).

For example:

  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
 - 2.15
Max­Bit­Rate int­(-­1:) W

The maximum upstream and downstream PHY bit rate supported by this interface (expressed in Mbps).

A value of -1 indicates automatic selection of the maximum bit rate.

 - 2.15
Current­Bit­Rate unsigned­Int R

The current upstream and downstream PHY bit rate on this interface (expressed in Mbps).

A value of 0 indicates that the current bit rate is unknown.

 - 2.15
Downstream­Channel­List string­(:1024)[] W Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of a row in the DownstreamChannel. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Downstream Channels associated with this Device.DOCSIS.Downstream.{i}. interface. - 2.15
Device.­DOCSIS.­Downstream.­{i}.­Stats. object R

Throughput statistics for this interface.

The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

 - 2.15
Bytes­Sent unsigned­Long R [StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters. - 2.15
Bytes­Received unsigned­Long R [StatsCounter64] The total number of bytes received on the interface, including framing characters. - 2.15
Packets­Sent unsigned­Long R [StatsCounter64] The total number of packets transmitted out of the interface. - 2.15
Packets­Received unsigned­Long R [StatsCounter64] The total number of packets received on the interface. - 2.15
Errors­Sent unsigned­Int R [StatsCounter32] The total number of outbound packets that could not be transmitted because of errors. - 2.15
Errors­Received unsigned­Int R [StatsCounter32] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.15
Unicast­Packets­Sent unsigned­Long R [StatsCounter64] The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.15
Unicast­Packets­Received unsigned­Long R [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.15
Discard­Packets­Sent unsigned­Int R [StatsCounter32] The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.15
Discard­Packets­Received unsigned­Int R [StatsCounter32] The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.15
Multicast­Packets­Sent unsigned­Long R [StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.15
Multicast­Packets­Received unsigned­Long R [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.15
Broadcast­Packets­Sent unsigned­Long R [StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.15
Broadcast­Packets­Received unsigned­Long R [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.15
Unknown­Proto­Packets­Received unsigned­Int R [StatsCounter32] The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.15
Device.­DOCSIS.­Upstream.­{i}. object(0:) R

DOCSIS Upstream interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the PHY DOCSIS Upstream interface.

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

 - 2.15
Enable boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

 - 2.15
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

 - 2.15
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.15
Name string­(:64) R

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

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.15
Last­Change unsigned­Int R The accumulated time in seconds since the interface entered its current operational state. - 2.15
Lower­Layers string­(:1024)[] W

Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2].

Note: Since Device.DOCSIS.Upstream.{i}. is a layer 1 interface, it is expected that LowerLayers will not be used.

 - 2.15
Upstream boolean R

Indicates whether the interface points towards the Internet (true) or towards End Devices (false).

For example:

  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
 - 2.15
Max­Bit­Rate int­(-­1:) W

The maximum upstream and downstream PHY bit rate supported by this interface (expressed in Mbps).

A value of -1 indicates automatic selection of the maximum bit rate.

 - 2.15
Current­Bit­Rate unsigned­Int R

The current upstream and downstream PHY bit rate on this interface (expressed in Mbps).

A value of 0 indicates that the current bit rate is unknown.

 - 2.15
Upstream­Channel­List string­(:1024)[] W Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of a row in the UpstreamChannel. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Upstream Channels associated with this Device.DOCSIS.Upstream.{i}. interface. - 2.15
Device.­DOCSIS.­Upstream.­{i}.­Stats. object R

Throughput statistics for this interface.

The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

 - 2.15
Bytes­Sent unsigned­Long R [StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters. - 2.15
Bytes­Received unsigned­Long R [StatsCounter64] The total number of bytes received on the interface, including framing characters. - 2.15
Packets­Sent unsigned­Long R [StatsCounter64] The total number of packets transmitted out of the interface. - 2.15
Packets­Received unsigned­Long R [StatsCounter64] The total number of packets received on the interface. - 2.15
Errors­Sent unsigned­Int R [StatsCounter32] The total number of outbound packets that could not be transmitted because of errors. - 2.15
Errors­Received unsigned­Int R [StatsCounter32] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.15
Unicast­Packets­Sent unsigned­Long R [StatsCounter64] The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.15
Unicast­Packets­Received unsigned­Long R [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.15
Discard­Packets­Sent unsigned­Int R [StatsCounter32] The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.15
Discard­Packets­Received unsigned­Int R [StatsCounter32] The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.15
Multicast­Packets­Sent unsigned­Long R [StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.15
Multicast­Packets­Received unsigned­Long R [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.15
Broadcast­Packets­Sent unsigned­Long R [StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.15
Broadcast­Packets­Received unsigned­Long R [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.15
Unknown­Proto­Packets­Received unsigned­Int R [StatsCounter32] The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.15
Device.­DOCSIS.­Downstream­Channel.­{i}. object(0:) R

[docsIfDownstreamChannelTable/1.3.6.1.2.1.10.127.1.1.1.1] This table describes the attributes of downstream channels (frequency bands).

See [Tables 6-16, and 6-17/CM-SP-RFIv2.0].

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

 - 2.15
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.15
ID unsigned­Int­(0:255) R [docsIfDownChannelId/1.3.6.1.2.1.10.127.1.1.1.1.1] The Cable Modem Termination System identification of the downstream channel within this particular MAC interface. if the interface is down, the object returns the most current value. If the downstream channel ID is unknown, this object returns a value of 0. - 2.15
Frequency int­(0:1000000000) R

[docsIfDownChannelFrequency/1.3.6.1.2.1.10.127.1.1.1.1.2] The center of the downstream frequency associated with this channel. This object will return the current tuner frequency, measured in Hz.

See [Section 6.3.3/CM-SP-RFIv2.0].

 - 2.15
Width int­(0:16000000) R

[docsIfDownChannelWidth/1.3.6.1.2.1.10.127.1.1.1.1.3] The bandwidth in Hz of this downstream channel. Most implementations are expected to support a channel width of 6 MHz (North America) and/or 8 MHz (Europe).

See [Table 6-17/CM-SP-RFIv2.0].

 - 2.15
Modulation string R

[docsIfDownChannelModulation/1.3.6.1.2.1.10.127.1.1.1.1.4] The modulation type associated with this downstream channel. If the interface is down, this object either returns the configured value (from the CMTS), the most current value (from the CM), or the value of Unknown. See the reference for specifics on the modulation profiles implied by QAM64 and QAM256.

Enumeration of:

  • Unknown
  • Other
  • QAM64
  • QAM256

See [Table 6-17./CM-SP-RFIv2.0]

 - 2.15
Interleave string R

[docsIfDownChannelInterleave/1.3.6.1.2.1.10.127.1.1.1.1.5] The Forward Error Correction (FEC) interleaving used for this downstream channel.

The value Taps12increment17 is supported by EuroDOCSIS cable systems only, and the others by DOCSIS cable systems.

If the interface is down, this object either returns the configured value (from the CMTS), the most current value (from the CM), or the value of Unknown. The value of Other is returned if the interleave is known but not defined in the above list. See the reference for the FEC configuration described by the setting of this object.

Enumeration of:

  • Unknown
  • Other
  • Taps8Increment16 (Protection 5.9/4.1 usec, latency .22/.15 msec)
  • Taps16Increment8 (Protection 12/8.2 usec, latency .48/.33 msec)
  • Taps32Increment4 (Protection 24/16 usec, latency .98/.68 msec)
  • Taps64Increment2 (Protection 47/33 usec, latency 2/1.4 msec)
  • Taps128Increment1 (Protection 95/66 usec, latency 4/2.8 msec)
  • Taps12increment17 (Protection 18/14 usec, latency 0.43/0.32 msec)

See [Table 6-15/CM-SP-RFIv2.0].

 - 2.15
Power int R

[docsIfDownChannelPower/1.3.6.1.2.1.10.127.1.1.1.1.6] [TenthdBmV] The received power level. If the interface is down, this object either returns the configured value (from the CMTS), the most current value (from the CM) or the value of 0. See the reference for recommended and required power levels.

See [Tables 6-16, 6-17/CM-SP-RFIv2.0].

 - 2.15
Annex string R

[docsIfDownChannelAnnex/1.3.6.1.2.1.10.127.1.1.1.1.7] The value of this object indicates the conformance of the implementation to important regional cable standards.

Enumeration of:

  • Unknown
  • Other
  • AnnexA (Annex A from ITU-T J.83 is used (equivalent to EN 300 429))
  • AnnexB (Annex B from ITU-T J.83 is used)
  • AnnexC (Annex C from ITU-T J.83 is used)

See [Sections 6.3.1, and H.3.1/CM-SP-RFIv2.0].

 - 2.15
Device.­DOCSIS.­Downstream­Channel.­{i}.­Signal­Quality. object R [docsIfSignalQualityTable/1.3.6.1.2.1.10.127.1.1.4.1] Describes the PHY signal quality of downstream channels. - 2.15
Signal­Noise int R

[docsIfSigQSignalNoise/1.3.6.1.2.1.10.127.1.1.4.1.5] [TenthdB] Signal/Noise ratio as perceived for this channel. Describes the Signal/Noise of the downstream channel, measured in TenthdB.

See [Tables 4-1 and 4-2/CM-SP-RFIv2.0].

 - 2.15
Microreflections int­(0:255) R

[docsIfSigQMicroreflections/1.3.6.1.2.1.10.127.1.1.4.1.6] Microreflections, including in-channel response as perceived on this interface, measured in -dBc (i.e., dBc below the signal level). This object is not assumed to return an absolutely accurate value, but it gives a rough indication of microreflections received on this interface. It is up to the implementer to provide information as accurately as possible.

See [Tables 4-1 and 4-2/CM-SP-RFIv2.0].

 - 2.15
Equalization­Data hex­Binary­(0,­36:260) R

[docsIfSigQEqualizationData/1.3.6.1.2.1.10.127.1.1.4.1.7] [DocsEqualizerData] Returns the equalization data for the downstream channel.

  • An equalization value indicating an equalization average for the upstream channel. Those values have vendor-dependent interpretations.
  • Return a zero-length OCTET STRING to indicate that the value is unknown or if there is no equalization data available or defined.

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

 - 2.15
Ext­Unerroreds unsigned­Long R

[docsIfSigQExtUnerroreds/1.3.6.1.2.1.10.127.1.1.4.1.8] [StatsCounter64] Codewords received on this channel without error. This includes all codewords, whether or not they were part of frames destined for this device. Discontinuities in the value of this counter can occur at reinitialization of the managed system.

See [Sections 6.2.4, and 6.3.6/CM-SP-RFIv2.0].

 - 2.15
Ext­Correcteds unsigned­Long R

[docsIfSigQExtCorrecteds/1.3.6.1.2.1.10.127.1.1.4.1.9] [StatsCounter64] Codewords received on this channel with correctable errors. This includes all codewords, whether or not they were part of frames destined for this device. Discontinuities in the value of this counter can occur at reinitialization of the managed system.

See [Sections 6.2.4, and 6.3.6/CM-SP-RFIv2.0].

 - 2.15
Ext­Uncorrectables unsigned­Long R

[docsIfSigQExtUncorrectables/1.3.6.1.2.1.10.127.1.1.4.1.10] [StatsCounter64] Codewords received on this channel with uncorrectable errors. This includes all codewords, whether or not they were part of frames destined for this device. Discontinuities in the value of this counter can occur at reinitialization of the managed system.

See [Sections 6.2.4, 6.3.6/CM-SP-RFIv2.0].

 - 2.15
Device.­DOCSIS.­Downstream­Channel.­{i}.­Signal­Quality­Ext. object R [docsIf3SignalQualityExtTable/1.3.6.1.4.1.4491.2.1.20.1.24.1] Describes the received modulation error ratio of each downstream channel. - 2.15
Rx­MER int R

[docsIf3SignalQualityExtRxMER/1.3.6.1.4.1.4491.2.1.20.1.24.1.1] [TenthdB] RxMER provides an in-channel received Modulation Error Ratio (MER), measured in TenthdB. RxMER is defined as an estimate, provided by the demodulator, of the ratio: (average constellation energy with equally likely symbols) / (average squared magnitude of error vector)

RxMER is measured just prior to FEC (trellis/Reed-Solomon) decoding. RxMER includes the effects of the HFC channel as well as implementation effects of the modulator and demodulator. Error vector estimation may vary among demodulator implementations. In the case of S-CDMA mode, RxMER is measured on the de-spread signal.

 - 2.15
Rx­Mer­Samples unsigned­Int R [docsIf3SignalQualityExtRxMerSamples/1.3.6.1.4.1.4491.2.1.20.1.24.1.2] RxMerSamples is a statistically significant number of symbols processed to arrive at the RxMER value. - 2.15
Fbe­Normalization­Coefficient int R [docsIf3SignalQualityExtFbeNormalizationCoefficient/1.3.6.1.4.1.4491.2.1.20.1.24.1.3] The Downstream Adaptive Decision Feedback Equalizer (DFE) is implemented as a Feedforward Equalizer (FFE) and a Feedback Equalizer (FBE). In order to evaluate the composite DFE response it is necessary to normalize the FBE coefficients to 1 and then evaluate the FFT(hffe)/FFT(1,hfbe), where the hfbe coefficients have been normalized to 1 using FbeNormalizationCoefficient. The complex data representing the hffe and hfbe coefficients is contained in the EqualizationData MIB. It is possible to implement the DFE such that the response is evaluated as FFT(hffe)/FFT(1,-hfbe). In this case the FbeNormalizationCoefficient will be reported as a negative number and the response will be evaluated as FFT(hffe)/FFT(1,hfbe). - 2.15
Device.­DOCSIS.­Upstream­Channel.­{i}. object(0:) W

[docsIfUpstreamChannelTable/1.3.6.1.2.1.10.127.1.1.2.1] This table describes the attributes of attached upstream channels.

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

 - 2.15
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.15
ID int­(0:255) R [docsIfUpChannelId/1.3.6.1.2.1.10.127.1.1.2.1.1] The CMTS identification of the upstream channel. - 2.15
Frequency int­(0:1000000000) R

[docsIfUpChannelFrequency/1.3.6.1.2.1.10.127.1.1.2.1.2] The center of the frequency band associated with this upstream interface. This object returns 0 if the frequency is undefined or unknown. Minimum permitted upstream frequency is 5,000,000 Hz for current technology.

See [Table 4-2/CM-SP-RFIv2.0].

 - 2.15
Width int­(0:64000000) R

[docsIfUpChannelWidth/1.3.6.1.2.1.10.127.1.1.2.1.3] The bandwidth in Hz of this upstream interface. This object returns 0 if the interface width is undefined or unknown. Minimum permitted interface width is currently 200,000 Hz.

See [Table 6-5/CM-SP-RFIv2.0].

 - 2.15
Slot­Size unsigned­Int R

[docsIfUpChannelSlotSize/1.3.6.1.2.1.10.127.1.1.2.1.5] Applicable to TDMA and ATDMA channel types only. The number of 6.25 microsecond ticks in each upstream mini-slot. Returns zero if the value is undefined or unknown or in case of an SCDMA channel.

See [Section 8.1.2.4/CM-SP-RFIv2.0].

 - 2.15
Tx­Timing­Offset unsigned­Int R

[docsIfUpChannelTxTimingOffset/1.3.6.1.2.1.10.127.1.1.2.1.6] A measure of the current round trip time obtained from the ranging offset (initial ranging offset + ranging offset adjustments). Used for timing of CM upstream transmissions to ensure synchronized arrivals at the CMTS. Units are one 64th fraction of 6.25 microseconds.

See [Section 6.2.19/CM-SP-RFIv2.0].

 - 2.15
Ranging­Backoff­Start int­(0:16) R

[docsIfUpChannelRangingBackoffStart/1.3.6.1.2.1.10.127.1.1.2.1.7] The initial random backoff window to use when retrying Ranging Requests. Expressed as a power of 2. A value of 16 at the CMTS indicates that a proprietary adaptive retry mechanism is to be used.

See [Sections 8.3.4, and 9.4/CM-SP-RFIv2.0].

 - 2.15
Ranging­Backoff­End int­(0:16) R

[docsIfUpChannelRangingBackoffEnd/1.3.6.1.2.1.10.127.1.1.2.1.8] The final random backoff window to use when retrying Ranging Requests. Expressed as a power of 2. A value of 16 at the CMTS indicates that a proprietary adaptive retry mechanism is to be used.

See [Section 8.3.4, and 9.4/CM-SP-RFIv2.0].

 - 2.15
Tx­Backoff­Start int­(0:16) R

[docsIfUpChannelTxBackoffStart/1.3.6.1.2.1.10.127.1.1.2.1.9] The initial random backoff window to use when retrying transmissions. Expressed as a power of 2. A value of 16 at the CMTS indicates that a proprietary adaptive retry mechanism is to be used.

See [Section 8.3.4, and 9.4/CM-SP-RFIv2.0].

 - 2.15
Tx­Backoff­End int­(0:16) R

[docsIfUpChannelTxBackoffEnd/1.3.6.1.2.1.10.127.1.1.2.1.10] The final random backoff window to use when retrying transmissions. Expressed as a power of 2. A value of 16 at the CMTS indicates that a proprietary adaptive retry mechanism is to be used.

See [Section 8.3.4, and 9.4/CM-SP-RFIv2.0].

 - 2.15
Device.­DOCSIS.­Upstream­Channel.­{i}.­Status. object R [docsIf3CmStatusUsTable/1.3.6.1.4.1.4491.2.1.20.1.2.1] This object provides Upstream channel information previously available in the SNMP table docsIfCmStatusTable. - 2.15
Tx­Power int R [docsIf3CmStatusUsTxPower/1.3.6.1.4.1.4491.2.1.20.1.2.1.1] [TenthdBmV] This attribute represents the operational CM transmit power for this SC-QAM upstream channel, in TenthdBmV. In order for this attribute to provide consistent information under all circumstances, a 3.1 CM will report the average total power for the SC-QAM channel the same as was done for DOCSIS 3.0, regardless of whether it is operating with a 3.1 or a 3.0 CMTS. The value that is reported was referred to as Pr in the DOCSIS 3.0 PHY Spec. - 2.15
T3Timeouts unsigned­Int R

[docsIf3CmStatusUsT3Timeouts/1.3.6.1.4.1.4491.2.1.20.1.2.1.2] [StatsCounter32] This attribute denotes the number of times counter T3 expired in the CM for this upstream channel. Discontinuities in the value of this counter can occur at re-initialization of the managed system.

See [RFC2863].

 - 2.15
T4Timeouts unsigned­Int R

[docsIf3CmStatusUsT4Timeouts/1.3.6.1.4.1.4491.2.1.20.1.2.1.3] [StatsCounter32] This attribute denotes the number of times counter T4 expired in the CM for this upstream channel. Discontinuities in the value of this counter can occur at re-initialization of the managed system.

See [RFC2863].

 - 2.15
Ranging­Aborteds unsigned­Int R

[docsIf3CmStatusUsRangingAborteds/1.3.6.1.4.1.4491.2.1.20.1.2.1.4] [StatsCounter32] This attribute denotes the number of times the ranging process was aborted by the CMTS. Discontinuities in the value of this counter can occur at re-initialization of the managed system.

See [RFC2863].

 - 2.15
Modulation­Type string R

[docsIf3CmStatusUsModulationType/1.3.6.1.4.1.4491.2.1.20.1.2.1.5] [DocsisUpstreamType] This attribute indicates modulation type status currently used by the CM for this upstream channel. Since this object specifically identifies PHY Layer mode, the shared upstream channel type “tdmaAndAtdma” is not permitted.

See [RFC2863].

 - 2.15
Eq­Data hex­Binary­(0,­36:260) R

[docsIf3CmStatusUsEqData/1.3.6.1.4.1.4491.2.1.20.1.2.1.6] [DocsEqualizerData] This attribute indicates the pre-equalization data for the specified upstream Channel on this CM after convolution with data indicated in the RNG-RSP. This data is valid when docsIfUpChannelPreEqEnable RFC 4546 is set to true.

See [RFC2863] and [RFC4546].

 - 2.15
T3Exceededs unsigned­Int R

[docsIf3CmStatusUsT3Exceededs/1.3.6.1.4.1.4491.2.1.20.1.2.1.7] [StatsCounter32] This attribute denotes the number of times for excessive T3 timeouts. Discontinuities in the value of this counter can occur at re-initialization of the managed system.

See [RFC2863].

 - 2.15
Is­Muted boolean R

[docsIf3CmStatusUsIsMuted/1.3.6.1.4.1.4491.2.1.20.1.2.1.8] This attribute denotes whether the upstream channel is muted.

See [CM-SP-MULPIv3.0], Media Access Control specification.

 - 2.15
Ranging­Status string R

[docsIf3CmStatusUsRangingStatus/1.3.6.1.4.1.4491.2.1.20.1.2.1.9] [RangingState] This attribute denotes the ranging state of the CM.

See [CM-SP-MULPIv3.0], Media Access Control specification.

 - 2.15
Device.­DOCSIS.­Interface.­{i}. object(0:) R

DOCSIS Layer 2 (MAC) interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the MAC level DOCSIS interface.

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

 - 2.15
Enable boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

 - 2.15
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

 - 2.15
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.15
Name string­(:64) R

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

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

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

[docsIfCmCmtsAddress/1.3.6.1.2.1.10.127.1.2.1.1.1] [MACAddress] Identifies the CMTS that is believed to control this MAC domain. This will be the source address from SYNC, MAP, and other MAC-layer messages. If the CMTS is unknown, returns 00-00-00-00-00-00.

See [Section 8.2.2/CM-SP-RFIv2.0].

 - 2.15
Capabilities string­[] R

[docsIfCmCapabilities/1.3.6.1.2.1.10.127.1.2.1.1.2] Comma-separated list of strings. Identifies the capabilities of the MAC implementation at this interface. Note that packet transmission is always supported. Therefore, there is no specific bit required to explicitly indicate this capability. Each list item is an enumeration of:

  • ATMCells
  • Concatenation
 - 2.15
Firmware­Version string­(:64) R A string identifying the version of the modem firmware currently installed for this interface. This is applicable only when the modem firmware is separable from the overall CPE software. - 2.15
DOCSISVersion string R

[docsIfDocsisBaseCapability/1.3.6.1.2.1.10.127.1.1.5] Indication of the DOCSIS capability of the device.

See [Annex G/CM-SP-RFIv2.0]. Enumeration of:

  • DOCSIS10
  • DOCSIS11
  • DOCSIS20
  • DOCSIS30
  • DOCSIS31
 - 2.15
Md­Cfg­Ip­Prov­Mode string R

[docsIf3CmMdCfgIpProvMode/1.3.6.1.4.1.4491.2.1.20.1.31.1.1] MdCfgIpProvMode specifies how the IP provisioning mode is configured. The CM relies upon the CMTS to facilitate the successful IP address acquisition independently of the MDD.

Enumeration of:

  • IPv4Only (The Cable Modem will initiate the acquisition of a single IPv4 address for the Cable Modem management stack)
  • IPv6Only (The Cable Modem will initiate the acquisition of a single IPv6 address for the Cable Modem management stack)
  • HonorMDD (The Cable Modem will initiate the acquisition of an IPv6 or IPv4 address as directed by the MDD message for provisioning and operation)

See [CM-SP-MULPIv3.0], IP Initialization Parameters TLV Section.

 - 2.15
Device.­DOCSIS.­Interface.­{i}.­Stats. object R

Throughput statistics for this interface.

The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

 - 2.15
Bytes­Sent unsigned­Long R [StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters. - 2.15
Bytes­Received unsigned­Long R [StatsCounter64] The total number of bytes received on the interface, including framing characters. - 2.15
Packets­Sent unsigned­Long R [StatsCounter64] The total number of packets transmitted out of the interface. - 2.15
Packets­Received unsigned­Long R [StatsCounter64] The total number of packets received on the interface. - 2.15
Errors­Sent unsigned­Int R [StatsCounter32] The total number of outbound packets that could not be transmitted because of errors. - 2.15
Errors­Received unsigned­Int R [StatsCounter32] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.15
Unicast­Packets­Sent unsigned­Long R [StatsCounter64] The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.15
Unicast­Packets­Received unsigned­Long R [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.15
Discard­Packets­Sent unsigned­Long R [StatsCounter64] The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.15
Discard­Packets­Received unsigned­Long R [StatsCounter64] The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.15
Multicast­Packets­Sent unsigned­Long R [StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.15
Multicast­Packets­Received unsigned­Long R [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.15
Broadcast­Packets­Sent unsigned­Long R [StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.15
Broadcast­Packets­Received unsigned­Long R [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.15
Unknown­Proto­Packets­Received unsigned­Long R [StatsCounter64] The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.15
Device.­DOCSIS.­Interface.­{i}.­Connectivity­Status. object R

[docsIf3CmStatusTable/1.3.6.1.4.1.4491.2.1.20.1.1.1] This object defines attributes of the CM connectivity status. This object provides CM connectivity status information of the CM previously available in the SNMP table docsIfCmStatusTable.

See [RFC4546].

 - 2.15
Value string R

[docsIf3CmStatusValue/1.3.6.1.4.1.4491.2.1.20.1.1.1.1] [CmRegState] This attribute denotes the current CM connectivity state. For the case of IP acquisition related states, this attribute reflects states for the current CM provisioning mode, not the Other DHCP process associated with dual stack operation.

See [CM-SP-MULPIv3.0], Establishing IP Connectivity.

 - 2.15
Status­Code string­(0,­5:7) R

[docsIf3CmStatusCode/1.3.6.1.4.1.4491.2.1.20.1.1.1.2] This attribute denotes the status code for CM as defined in the OSSI Specification. The status code consists of a single character indicating error groups, followed by a two-or three-digit number indicating the status condition, followed by a decimal. An example of a returned value could be “T101.0”. The zero-length hex string indicates no status code yet registered.

See [CM-SP-OSSIv3.0], Format and Content for Event, Syslog, and SNMP Notification Annex.

 - 2.15
Resets unsigned­Int R

[docsIf3CmStatusResets/1.3.6.1.4.1.4491.2.1.20.1.1.1.3] [StatsCounter32] This attribute denotes the number of times the CM reset or initialized this interface. Discontinuities in the value of this counter can occur at re-initialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the CM MAC Domain interface.

See [RFC2863].

 - 2.15
Lost­Syncs unsigned­Int R

[docsIf3CmStatusLostSyncs/1.3.6.1.4.1.4491.2.1.20.1.1.1.4] [StatsCounter32] This attribute denotes the number of times the CM lost synchronization with the downstream channel. Discontinuities in the value of this counter can occur at re-initialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the CM MAC Domain interface.

See [RFC2863].

 - 2.15
Invalid­Maps unsigned­Int R

[docsIf3CmStatusInvalidMaps/1.3.6.1.4.1.4491.2.1.20.1.1.1.5] [StatsCounter32] This attribute denotes the number of times the CM received invalid MAP messages. Discontinuities in the value of this counter can occur at re-initialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the CM MAC Domain interface.

See [RFC2863].

 - 2.15
Invalid­Ucds unsigned­Int R

[docsIf3CmStatusInvalidUcds/1.3.6.1.4.1.4491.2.1.20.1.1.1.6] [StatsCounter32] This attribute denotes the number of times the CM received invalid UCD messages. Discontinuities in the value of this counter can occur at re-initialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the CM MAC Domain interface.

See [RFC2863].

 - 2.15
Invalid­Ranging­Rsps unsigned­Int R

[docsIf3CmStatusInvalidRangingRsps/1.3.6.1.4.1.4491.2.1.20.1.1.1.7] [StatsCounter32] This attribute denotes the number of times the CM received invalid ranging response messages. Discontinuities in the value of this counter can occur at re-initialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the CM MAC Domain interface.

See [RFC2863].

 - 2.15
Invalid­Reg­Rsps unsigned­Int R

[docsIf3CmStatusInvalidRegRsps/1.3.6.1.4.1.4491.2.1.20.1.1.1.8] [StatsCounter32] This attribute denotes the number of times the CM received invalid registration response messages. Discontinuities in the value of this counter can occur at re-initialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the CM MAC Domain interface.

See [RFC2863].

 - 2.15
T1Timeouts unsigned­Int R

[docsIf3CmStatusT1Timeouts/1.3.6.1.4.1.4491.2.1.20.1.1.1.9] [StatsCounter32] This attribute denotes the number of times counter T1 expired in the CM. Discontinuities in the value of this counter can occur at re-initialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the CM MAC Domain interface.

See [RFC2863].

 - 2.15
T2Timeouts unsigned­Int R

[docsIf3CmStatusT2Timeouts/1.3.6.1.4.1.4491.2.1.20.1.1.1.10] [StatsCounter32] This attribute denotes the number of times counter T2 expired in the CM. Discontinuities in the value of this counter can occur at re-initialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the CM MAC Domain interface.

See [RFC2863].

 - 2.15
Device.­DOCSIS.­Spectrum­Analysis. object R - 2.15
Enable boolean W

[docsIf3CmSpectrumAnalysisCtrlCmdEnable/1.3.6.1.4.1.4491.2.1.20.1.34.1] This attribute is used to enable or disable the spectrum analyzer feature. Setting this attribute to true triggers the CM to initiate measurements for the spectrum analyzer feature based on the other configuration attributes for the feature. By default, the feature is disabled unless explicitly enabled.

Note that the feature may be disabled by the system under certain circumstances if the spectrum analyzer would affect critical services. In such a case, the attribute will return false when read, and will reject sets to true with an error. Once the feature is enabled, any change to this object’s configuration might not be effective until the feature is re-enabled again.

See [CM-SP-CM-OSSIv3.1], Proactive Network Maintenance Information Model.

The factory default value MUST be false.

 - 2.15
Inactivity­Timeout int­(0:86400) W

[docsIf3CmSpectrumAnalysisCtrlCmdInactivityTimeout/1.3.6.1.4.1.4491.2.1.20.1.34.2] This attribute controls the length of time (in seconds) after the last spectrum analysis measurement before the feature is automatically disabled. If set to a value of 0, the feature will remain enabled until it is explicitly disabled.

See [CM-SP-CM-OSSIv3.1], Proactive Network Maintenance Information Model.

The factory default value MUST be 300.

 - 2.15
First­Segment­Center­Frequency unsigned­Int W

[docsIf3CmSpectrumAnalysisCtrlCmdFirstSegmentCenterFrequency/1.3.6.1.4.1.4491.2.1.20.1.34.3] This attribute controls the center frequency (in Hz) of the first segment for the spectrum analysis measurement. The frequency bins for this segment lie symmetrically to the left and right of this center frequency.

If the number of bins in a segment is odd, the segment center frequency lies directly on the center bin.

If the number of bins in a segment is even, the segment center frequency lies halfway between two bins.

Changing the value of this attribute may result in changes to the Result table. Note that if this parameter is set to an invalid value, the device may return an error, or may adjust the value of the parameter to the closest valid value.

See [CM-SP-CM-OSSIv3.1], Proactive Network Maintenance Information Model.

The factory default value MUST be 93000000.

 - 2.15
Last­Segment­Center­Frequency unsigned­Int W

[docsIf3CmSpectrumAnalysisCtrlCmdLastSegmentCenterFrequency/1.3.6.1.4.1.4491.2.1.20.1.34.4] This attribute controls the center frequency (in Hz) of the last segment of the spectrum analysis measurement.

The frequency bins for this segment lie symmetrically to the left and right of this center frequency. If the number of bins in a segment is odd, the segment center frequency lies directly on the center bin. If the number of bins in a segment is even, the segment center frequency lies halfway between two bins.

The value of the LastSegmentCenterFrequency should be equal to the FirstSegmentCenterFrequency plus and integer number of segment spans as determined by the SegmentFrequencySpan.

Changing the value of this attribute may result in changes to the Result table.

Note that if this parameter is set to an invalid value, the device may return an error, or may adjust the value of the parameter to the closest valid value.

See [CM-SP-CM-OSSIv3.1], Proactive Network Maintenance Information Model.

The factory default value MUST be 993000000.

 - 2.15
Segment­Frequency­Span unsigned­Int­(1000000:900000000) W

[docsIf3CmSpectrumAnalysisCtrlCmdSegmentFrequencySpan/1.3.6.1.4.1.4491.2.1.20.1.34.5] This attribute controls the frequency span (in Hz) of each segment (instance) of the Result.{i} table.

If set to a value of 0, then a default span will be chosen based on the hardware capabilities of the device. Segments are contiguous from the FirstSegmentCenterFrequency to the LastSegmentCenterFrequency and the center frequency for each successive segment is incremented by the SegmentFrequencySpan. The number of segments is (LastSegmentCenterFrequency - FirstSegmentCenterFrequency)/SegmentFrequencySpan + 1. A segment is equivalent to an instance in the Result table. The chosen SegmentFrequencySpan affects the number of entries in Result table. A more granular SegmentFrequencySpan may adversely affect the amount of time needed to query the table entries in addition to possibly increasing the acquisition time.

Changing the value of this attribute may result in changes to Result table.

Note that if this parameter is set to an invalid value, the device may return an error, or may adjust the value of the parameter to the closest valid value.

See [CM-SP-CM-OSSIv3.1], Proactive Network Maintenance Information Model.

The factory default value MUST be 7500000.

 - 2.15
Num­Bins­Per­Segment unsigned­Int­(2:2048) W

[docsIf3CmSpectrumAnalysisCtrlCmdNumBinsPerSegment/1.3.6.1.4.1.4491.2.1.20.1.34.6] This parameter controls the number of bins collected by the measurement performed for each segment (instance) in the Result table.

Note that if this parameter is set to an invalid value, the device may return an error, or may adjust the value of the parameter to the closest valid value.

See [CM-SP-CM-OSSIv3.1], Proactive Network Maintenance Information Model.

The factory default value MUST be 256.

 - 2.15
Equivalent­Noise­Bandwidth unsigned­Int­(50:500) W

[docsIf3CmSpectrumAnalysisCtrlCmdEquivalentNoiseBandwidth/1.3.6.1.4.1.4491.2.1.20.1.34.7] This parameter allows the user to request an equivalent noise bandwidth (measured in hundredthsbin) for the resolution bandwidth filter used in the spectrum analysis. This corresponds to the spectral width of the window function used when performing a discrete Fourier transform for the analysis.

The window function which corresponds to a value written to this parameter may be obtained by reading the value of WindowFunction.

If an unsupported value is requested, the device may return an error, or choose the closest valid value to the one which is requested. If the closest value is chosen, then a subsequent read of this parameter will return the actual value which is in use.

See [CM-SP-CM-OSSIv3.1], Proactive Network Maintenance Information Model.

The factory default value MUST be 150.

 - 2.15
Window­Function string W

[docsIf3CmSpectrumAnalysisCtrlCmdWindowFunction/1.3.6.1.4.1.4491.2.1.20.1.34.8] [SpectrumAnalysisWindowFunction] This parameter controls or indicates the windowing function which will be used when performing the discrete Fourier transform for the analysis. The WindowFunction and the Equivalent Noise Bandwidth are related. If a particular WindowFunction is selected, then the EquivalentNoiseBandwidth for the function which is in use, will be reported by the EquivalentNoiseBandwidth parameter. Alternatively if an EquivalentNoiseBandwidth value is chosen then if a WindowFunction function representing that EquivalentNoiseBandwidth is defined in the CM, that value will be reported in WindowFunction, or a value of Other will be reported. Use of “modern” windowing functions not yet defined will likely be reported as Other.

Enumeration of:

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

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, or if writing of the WindowFunction is not supported, an error will be returned.

See [CM-SP-CM-OSSIv3.1], Proactive Network Maintenance Information Model.

 - 2.15
Number­Of­Averages unsigned­Int­(1:1000) W

[docsIf3CmSpectrumAnalysisCtrlCmdNumberOfAverages/1.3.6.1.4.1.4491.2.1.20.1.34.9] This parameter controls the number of averages that will be performed on spectral bins. The average will be computed using the ‘leaky integrator’ method, where: reported bin value = alpha*accumulated bin values + (1-alpha)*current bin value.

Alpha is one minus the reciprocal of the number of averages. For example, if N=25, then alpha = 0.96. A value of 1 indicates no averaging. Re-writing the number of averages will restart the averaging process. If there are no accumulated values, the accumulators are made equal to the first measured bin amplitudes.

If an attempt is made to set the parameter to an unsupported number of averages, an error will be returned.

See [CM-SP-CM-OSSIv3.1], Proactive Network Maintenance Information Model.

The factory default value MUST be 1.

 - 2.15
Result­Number­Of­Entries unsigned­Int R The number of entries in the Result table. - 2.15
Device.­DOCSIS.­Spectrum­Analysis.­Result.­{i}. object(0:) R

[docsIf3CmSpectrumAnalysisMeasTable/1.3.6.1.4.1.4491.2.1.20.1.35.1] This table provides a list of spectral analysis measurements as performed across a range of center frequencies. The table is capable of representing a full scan of the spectrum.

Each Device.DOCSIS.SpectrumAnalysis.Result.{i}. instance represents the spectral analysis around a single center frequency point in the spectrum.

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

 - 2.15
Frequency int­(-­2147483648:2147483647) R [docsIf3CmSpectrumAnalysisMeasFrequency/1.3.6.1.4.1.4491.2.1.20.1.35.1.1] The center frequency (in Hz) of the spectral analysis span which is represented by this instance. - 2.15
Amplitude­Data hex­Binary­(0,­2:4116) R

[docsIf3CmSpectrumAnalysisMeasAmplitudeData/1.3.6.1.4.1.4491.2.1.20.1.35.1.2] [AmplitudeData] This parameter provides a list of the spectral amplitudes as measured at the center frequency specified by the Frequency.

The frequency bins are ordered from lowest to highest frequencies covering the frequency span. Information about the center frequency, frequency span, number of bins and resolution bandwidth are included to provide context to the measurement point.

 - 2.15
Total­Segment­Power int R [docsIf3CmSpectrumAnalysisMeasTotalSegmentPower/1.3.6.1.4.1.4491.2.1.20.1.35.1.3] [TenthdB] This parameter provides the total RF power present in the segment with the center frequency equal to the Frequency and the span equal to the SegmentFrequencySpan. The value represents the sum of the spectrum power in all of the associated bins. The value is computed by summing power (not dB) values and converting the final sum to TenthdB. - 2.15
Device.­PTM. object R Packet Transfer Mode ([Annex H/G.993.1]). This object contains the Link interface. - 2.0
Link­Number­Of­Entries unsigned­Int R The number of entries in the Link table. - 2.0
Device.­PTM.­Link.­{i}. object(0:) W

PTM link-layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Models a layer 2 variable-sized packet interface. A PTM Link entry is typically stacked on top of either a FAST.Line, DSL.Channel, or a DSL.BondingGroup object.

When a PTM Link interface is used, a lower-layer DSL.Channel interface MUST be configured with PTM encapsulation (see DSL.Channel.{i}.LinkEncapsulationUsed).

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

 - 2.0
Enable boolean W

Enables or disables the link.

This parameter is based on ifAdminStatus from [RFC2863].

 false 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

 Down 2.0
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.0
Name string­(:64) R

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

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

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

[MACAddress] The MAC Address of the interface.

Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter.

 - 2.0
Device.­PTM.­Link.­{i}.­Stats. object R

Throughput statistics for this interface.

The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

 - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int R The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Device.­Ethernet. object R Ethernet object. This object models several Ethernet interface objects, each representing a different stack layer, including: Interface, Link, and VLANTermination. Interface is media-specific and models a port, the PHY layer, and the Channel Access Method (CAM) part of the MAC layer. Link is media-independent and models the Logical Link Control (LLC) layer. An “outer” VLANTermination, when present, is expected to be stacked on top of Link objects to receive and send frames with a configured VLANID. - 2.0
Wo­LSupported boolean R Indicates that WoL (Wake on LAN) over Ethernet is supported. - 2.13
Flow­Control­Supported boolean R Indicates that Flow Control over Ethernet is supported, as per [802.3-2015]. - 2.14
Interface­Number­Of­Entries unsigned­Int R The number of entries in the Interface table. - 2.0
Link­Number­Of­Entries unsigned­Int R The number of entries in the Link table. - 2.0
VLANTermination­Number­Of­Entries unsigned­Int R The number of entries in the VLANTermination table. - 2.0
RMONStats­Number­Of­Entries unsigned­Int R The number of entries in the RMONStats table. - 2.4
LAGNumber­Of­Entries unsigned­Int R The number of entries in the LAG table. - 2.12
Device.­Ethernet.­Interface.­{i}. object(0:) R

Ethernet interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models physical Ethernet ports, but in terms of the interface stack it only models the PHY and Connection Access Method of the Ethernet interface MAC. A {{object: argument unnecessary when referring to current object}} is also required to model a full Ethernet device.

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

 - 2.0
Enable boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

 - 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

 - 2.0
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.0
Name string­(:64) R

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

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the interface entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W

Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2].

Note: Since Device.Ethernet.Interface.{i}. is a layer 1 interface, it is expected that LowerLayers will not be used.

 - 2.0
Upstream boolean R

Indicates whether the interface points towards the Internet (true) or towards End Devices (false).

For example:

  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
 - 2.0
MACAddress string­(:17) R

[MACAddress] The unique manufacturer-assigned Ethernet hardware address of the interface, also referred to as burned-in MAC address.

Note: This is not necessarily the same as the MAC address used for higher-level protocols, which is modeled via the Link.{i}.MACAddress parameter. Its main purpose is the identification of a specific Ethernet interface; the information can also can be used to perform Wake on LAN.

 - 2.0
Supported­Link­Modes unsigned­Int­[] R

Comma-separated list of unsigned integers. Reports the supported link modes. MUST be reported in a compliant way as defined in [IANAifMauTypeListBits/IANAMauMIB]. For example, IANAifMauTypeListBits defines the following link mode types:

  • 11 (10BASE-T full duplex mode)
  • 14 (100BASE-T4)
  • 15 (100BASE-TX half duplex mode)
  • 16 (100BASE-TX full duplex mode)
 - 2.16
Max­Bit­Rate int­(-­1:) W

The maximum upstream and downstream PHY bit rate supported by this interface (expressed in Mbps).

A value of -1 indicates automatic selection of the maximum bit rate.

 - 2.0
Current­Bit­Rate unsigned­Int R

The current upstream and downstream PHY bit rate on this interface (expressed in Mbps).

A value of 0 indicates that the current bit rate is unknown.

 - 2.7
Duplex­Mode string W

The duplex mode available to this connection. Enumeration of:

  • Half
  • Full
  • Auto
 - 2.0
EEECapability boolean R Indicates whether this physical ethernet port supports Energy Efficient Ethernet as specified in [Section 78/802.3-2012_section6]. - 2.8
EEEEnable boolean W Whether Energy Efficient Ethernet [Section 78/802.3-2012_section6] support is currently enabled. When enabled, this ethernet port will be capable of entering or exiting Low Power Idle (LPI) mode. - 2.8
Device.­Ethernet.­Interface.­{i}.­Stats. object R

Throughput statistics for this interface.

The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

 - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of Ethernet frames transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of Ethernet frames received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound Ethernet frames that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound Ethernet frames that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of Ethernet frames requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of Ethernet frames packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int R The total number of outbound Ethernet frames which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound Ethernet frames which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of Ethernet frames that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received Ethernet frames, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of Ethernet frames that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received Ethernet frames, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of Ethernet frames received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Device.­Ethernet.­Link.­{i}. object(0:) W

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

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

 - 2.0
Enable boolean W

Enables or disables the link.

This parameter is based on ifAdminStatus from [RFC2863].

 false 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

 Down 2.0
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.0
Name string­(:64) R

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

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

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

[MACAddress] The MAC address used for packets sent via this interface. Provides the source MAC address for outgoing traffic and the destination MAC address for incoming traffic.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

 - 2.0
Priority­Tagging boolean W

Enables or disables priority tagging on this Ethernet Link.

When true, egress frames leaving this interface will be priority tagged with the frame’s associated priority value, which will either be derived directly from the ingress frame or else set via QoS.Classification.{i}.EthernetPriorityMark or QoS.Classification.{i}.InnerEthernetPriorityMark.

When false, egress frames leaving this interface will be untagged.

The parameter does not affect reception of ingress frames.

 false 2.0
Flow­Control boolean W Configures Flow Control on given Ethernet port. When set to true, it activates the exchange of pause-resume flow control frames. false 2.14
Device.­Ethernet.­Link.­{i}.­Stats. object R

Throughput statistics for this link.

The CPE MUST reset the link’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the link becomes operationally down due to a previous administrative down (i.e. the link’s Status parameter transitions to a down state after the link is disabled) or when the link becomes administratively up (i.e. the link’s Enable parameter transitions from false to true). Administrative and operational link status is discussed in [Section 4.2.2/TR-181i2].

 - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the link, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the link, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of Ethernet frames transmitted out of the link. - 2.0
Packets­Received unsigned­Long R The total number of Ethernet frames received on the link. - 2.0
Errors­Sent unsigned­Int R The total number of outbound Ethernet frames that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound Ethernet frames that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of Ethernet frames requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received Ethernet frames, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int R The total number of outbound Ethernet frames which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound Ethernet frames which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of Ethernet frames that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received Ethernet frames, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of Ethernet frames that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received Ethernet frames, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of Ethernet frames received via the link which were discarded because of an unknown or unsupported protocol. - 2.0
Device.­Ethernet.­VLANTermination.­{i}. object(0:) W

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

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

 - 2.0
Enable boolean W

Enables or disables the VLANTermination entry.

This parameter is based on ifAdminStatus from [RFC2863].

 false 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

 Down 2.0
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.0
Name string­(:64) R

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

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the VLANTermination entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. 2.0
VLANID unsigned­Int­(1:4094) W The VLAN ID for this Device.Ethernet.VLANTermination.{i}. entry (as defined in [802.1Q-2011]). Only ingress frames with this VLAN ID will be passed to higher protocol layers; frames sent from higher protocol layers will be tagged with this VLAN ID. - 2.0
TPID unsigned­Int W

The Tag Protocol Identifier (TPID) assigned to this Device.Ethernet.VLANTermination.{i}.. The TPID is an EtherType value used to identify the frame as a tagged frame.

Standard [Table 9.1/802.1Q-2011] TPID values are:

*S-TAG 0x88A8 = 34984

*C-TAG 0x8100 = 33024

Non-Standard TPID values are:

*S-TAG 0x9100 = 37120

 33024 2.7
Device.­Ethernet.­VLANTermination.­{i}.­Stats. object R

Throughput statistics for this interface.

The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

 - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int R The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Device.­Ethernet.­RMONStats.­{i}. object(0:) W

Ethernet statistics based on the [RFC2819] RMON-MIB etherStatsTable, with some extensions inspired by [Section 9.3.32/G.988].

Each instance is associated with an interface capable of transporting Ethernet-encapsulated packets, and contains a set of unidirectional Ethernet statistics.

The statistics are sampled either on ingress or on egress. This is determined as follows:

  • If the instance is associated with an egress queue (or queues) via the Queue parameter or by setting AllQueues to true then data is sampled on egress. In this case Bytes etc measure the data that has been sent on the interface, possibly filtered by Queue or VLANID.
  • Otherwise data is sampled on ingress. In this case Bytes etc measure the data that has been received on the interface, possibly filtered by VLANID.

When sampling on egress, the term received means received by the queuing sub-system.

Multiple instances can be associated with a single interface: individual instances can be configured to collect data associated with the entire interface, or with a particular VLAN and/or queue.

The CPE MUST reset each instances’s Stats parameters whenever the instance is disabled and re-enabled. Whether this reset occurs when the instance becomes operationally disabled (Status = Disabled) or administratively enabled (Enable = true) is a local matter to the CPE. This is similar to the behavior of interface statistics, e.g. as specified for Interface.{i}.Stats. Furthermore, this instance’s Stats parameters MUST be reset whenever the referenced interface’s Stats parameters are reset, or when the referenced queue or VLAN is disabled and re-enabled.

For enabled table entries, if Interface references an interface that is not capable of transporting Ethernet-encapsulated packets, or if Queue references a queue that is not instantiated on Interface, or if Queue is not a valid reference and AllQueues is false, the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

Note: The Device.Ethernet.RMONStats.{i}. table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Device.Ethernet.RMONStats.{i}. row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending Device.Ethernet.RMONStats.{i}. row.

At most one entry in this table can exist with a given value for Alias, or with the same values for all of Interface, VLANID and Queue. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.4
Enable boolean W Enables or disables this instance. false 2.4
Status string R

The status of this instance. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL)

The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid.

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

 Disabled 2.4
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.4
Name string­(:64) R The textual name of the Device.Ethernet.RMONStats.{i}. entry as assigned by the CPE. - 2.4
Interface string W

The interface associated with this instance. The value MUST be the Path Name of an interface that is capable of transporting Ethernet-encapsulated packets.

The term “capable of transporting Ethernet-encapsulated packets” means “has an Ethernet header” and therefore refers to any interface that is at or below an Ethernet.Link instance in the interface stack.

 2.4
VLANID unsigned­Int­(0:4094) W

Filter criterion.

The VLAN ID for which statistics are to be collected.

A zero value indicates that all packets, whether or not they have a VLAN header, will be considered.

A non-zero value indicates that only packets that have the the specified VLAN ID will be considered.

 0 2.4
Queue string W

The value MUST be the Path Name of a row in the QoS.Queue. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Filter criterion.

The egress queue with which this instance is associated.

Only packets that are sent to the referenced queue will be considered.

 2.4
All­Queues boolean W Indicates whether this instance applies to all queues. If true, the value of Queue is ignored since all egress queues are indicated. false 2.4
Drop­Events unsigned­Int R

The total number of events in which packets were dropped due to lack of resources. Note that this number is not necessarily the number of packets dropped; it is just the number of times this condition has been detected.

This parameter is based on etherStatsDropEvents from [RFC2819].

 0 2.4
Bytes unsigned­Long R

The total number of bytes (including those in bad packets) received (excluding framing bits but including FCS bytes).

This parameter is based on etherStatsOctets from [RFC2819].

 0 2.4
Packets unsigned­Long R

The total number of packets (including bad packets, broadcast packets, and multicast packets) received.

This parameter is based on etherStatsPkts from [RFC2819].

 0 2.4
Broadcast­Packets unsigned­Long R

The total number of good packets received that were directed to the broadcast address. Note that this does not include multicast packets.

This parameter is based on etherStatsBroadcastPkts from [RFC2819].

 0 2.4
Multicast­Packets unsigned­Long R

The total number of good packets received that were directed to a multicast address. Note that this number does not include packets directed to the broadcast address.

This parameter is based on etherStatsMulticastPkts from [RFC2819].

 0 2.4
CRCErrored­Packets unsigned­Int R

The total number of packets received that had a length (excluding framing bits, but including FCS bytes) of between 64 and 1518 bytes, inclusive, but had either a bad Frame Check Sequence (FCS) with an integral number of bytes (FCS Error) or a bad FCS with a non-integral number of bytes (Alignment Error).

This parameter is based on etherStatsCRCAlignErrors from [RFC2819].

 0 2.4
Undersize­Packets unsigned­Int R

The total number of packets received that were less than 64 bytes long (excluding framing bits, but including FCS bytes) and were otherwise well formed.

This parameter is based on etherStatsUndersizePkts from [RFC2819].

 0 2.4
Oversize­Packets unsigned­Int R

The total number of packets received that were longer than 1518 bytes (excluding framing bits, but including FCS bytes) and were otherwise well formed.

This parameter is based on etherStatsOversizePkts from [RFC2819].

 0 2.4
Packets­64Bytes unsigned­Long R

The total number of packets (including bad packets) received that were 64 bytes in length (excluding framing bits but including FCS bytes).

This parameter is based on etherStatsPkts64Octets from [RFC2819].

 0 2.4
Packets­65to­127Bytes unsigned­Long R

The total number of packets (including bad packets) received that were between 65 and 127 bytes in length inclusive (excluding framing bits but including FCS bytes).

This parameter is based on etherStatsPkts65to127Octets from [RFC2819].

 0 2.4
Packets­128to­255Bytes unsigned­Long R

The total number of packets (including bad packets) received that were between 128 and 255 bytes in length inclusive (excluding framing bits but including FCS bytes).

This parameter is based on etherStatsPkts6128to255Octets from [RFC2819].

 0 2.4
Packets­256to­511Bytes unsigned­Long R

The total number of packets (including bad packets) received that were between 256 and 511 bytes in length inclusive (excluding framing bits but including FCS bytes).

This parameter is based on etherStatsPkts256to511Octets from [RFC2819].

 0 2.4
Packets­512to­1023Bytes unsigned­Long R

The total number of packets (including bad packets) received that were between 512 and 1023 bytes in length inclusive (excluding framing bits but including FCS bytes).

This parameter is based on etherStatsPkts512to1023Octets from [RFC2819].

 0 2.4
Packets­1024to­1518Bytes unsigned­Long R

The total number of packets (including bad packets) received that were between 1024 and 1518 bytes in length inclusive (excluding framing bits but including FCS bytes).

This parameter is based on etherStatsPkts1024to1518Octets from [RFC2819].

 0 2.4
Device.­Ethernet.­Wo­L. object R This object provides access to the WoL (Wake on LAN) funtionality. - 2.13
Send­Magic­Packet­() command - This command sends a magic packet over the CPE active Ethernet interfaces. - 2.13
⇒ Input. arguments - Input arguments. -
⇒ MACAddress string­(:17) R [MACAddress] MAC address target of the magic packet. - 2.13
⇒ Password string R The SecureOn password. The parameter value can be empty or, if present, can contain either 4 bytes or 6 bytes. - 2.13
Device.­Ethernet.­LAG.­{i}. object(0:) W

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

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 MACAddress. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, Name and MACAddress such that the new entry does not conflict with any existing entries.

 - 2.12
Enable boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

 - 2.12
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

 - 2.12
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.12
Name string­(:64) R

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

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.12
Last­Change unsigned­Int R The accumulated time in seconds since the interface entered its current operational state. - 2.12
Lower­Layers string­(:1024)[] W

Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string.. See [Section 4.2.1/TR-181i2].

LowerLayers must reference to Device.Ethernet.Interface instances where Link Aggregation Group is configured by the CPE.

For example, “Device.Ethernet.Interface.1, Device.Ethernet.Interface.2”

 - 2.12
MACAddress string­(:17) W

[MACAddress] MAC address of the Link Aggregation Interface.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

 - 2.12
Device.­Ethernet.­LAG.­{i}.­Stats. object R

Throughput statistics for this interface.

The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

 - 2.12
Bytes­Sent unsigned­Long R [StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters. - 2.12
Bytes­Received unsigned­Long R [StatsCounter64] The total number of bytes received on the interface, including framing characters. - 2.12
Packets­Sent unsigned­Long R [StatsCounter64] The total number of packets transmitted out of the interface. - 2.12
Packets­Received unsigned­Long R [StatsCounter64] The total number of packets received on the interface. - 2.12
Errors­Sent unsigned­Int R [StatsCounter32] The total number of outbound packets that could not be transmitted because of errors. - 2.12
Errors­Received unsigned­Int R [StatsCounter32] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.12
Unicast­Packets­Sent unsigned­Long R [StatsCounter64] The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.12
Unicast­Packets­Received unsigned­Long R [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.12
Discard­Packets­Sent unsigned­Int R [StatsCounter32] The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.12
Discard­Packets­Received unsigned­Int R [StatsCounter32] The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.12
Multicast­Packets­Sent unsigned­Long R [StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.12
Multicast­Packets­Received unsigned­Long R [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.12
Broadcast­Packets­Sent unsigned­Long R [StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.12
Broadcast­Packets­Received unsigned­Long R [StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.12
Unknown­Proto­Packets­Received unsigned­Int R [StatsCounter32] The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.12
Device.­USB. object R Universal Serial Bus ([USB1.0], [USB2.0], [USB3.0]). This object contains the Interface, Port, and USBHosts objects. - 2.0
Interface­Number­Of­Entries unsigned­Int R The number of entries in the Interface table. - 2.0
Port­Number­Of­Entries unsigned­Int R The number of entries in the Port table. - 2.0
Device.­USB.­Interface.­{i}. object(0:) R

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

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

 - 2.0
Enable boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

 - 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

 - 2.0
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.0
Name string­(:64) R

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

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the interface entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W

Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2].

Note: Since Device.USB.Interface.{i}. is a layer 1 interface, it is expected that LowerLayers will not be used.

 - 2.0
Upstream boolean R

Indicates whether the interface points towards the Internet (true) or towards End Devices (false).

For example:

  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
 - 2.0
MACAddress string­(:17) R

[MACAddress] The MAC Address of the interface.

Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter.

 - 2.0
Max­Bit­Rate unsigned­Int R The maximum PHY bit rate supported by this interface (expressed in Mbps). - 2.0
Port string­(:256) R The value MUST be the Path Name of a row in the Port. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is the USB port associated with this interface object. - 2.0
Device.­USB.­Interface.­{i}.­Stats. object R

Throughput statistics for this interface.

The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

 - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int R The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Device.­USB.­Port.­{i}. object(0:) R

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

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

 - 2.0
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.0
Name string­(:64) R The textual name of the port. - 2.0
Standard string­(:4) R USB specification version supported by the Port. Example: “1.1” - 2.0
Type string R

Type of the USB connection. Enumeration of:

  • Host
  • Hub
  • Device
 - 2.0
Receptacle string R

Receptacle of the port. Enumeration of:

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

Current speed of the USB connection. Enumeration of:

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

Power configuration of the USB connection. Enumeration of:

  • Self
  • Bus
  • Unknown

Only applies when Type is Device. In other cases value is Unknown.

 - 2.0
Device.­USB.­USBHosts. object R

This object models the CPE’s USB Host controllers.

See [Appendix XVII/TR-181i2] for Theory of Operation.

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

Table of CPE USB Host controllers.

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

 - 2.0
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

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

Type of USB Host Enumeration of:

  • OHCI (Open Host Controller Interface)
  • EHCI (Enhanced Host Controller Interface)
  • UHCI (Universal Host Controller Interface)
  • xHCI (Extensible Host Controller Interface)
 - 2.0
Reset­() command - Reset the Host Controller and apply the reset signaling (see [Chapter 7.1.7.5/USB2.0]) to all of the Host Controller Hub downstream ports. - 2.12
Power­Management­Enable boolean W

When set to true, PowerManagementEnable enables the Host Controller to invoke Power Management policy, i.e. controlled Suspend (see [USB2.0], Chapters 4.3.2, 7.1.7.6, and 11.9).

When set to false PowerManagementEnable immediately disables the Host controller Power Management policy.

 - 2.0
USBVersion string­(:4) R USB specification version with which the controller complies. Example: “1.1” - 2.0
Device­Number­Of­Entries unsigned­Int R The number of entries in the Device table. - 2.0
Device.­USB.­USBHosts.­Host.­{i}.­Device.­{i}. object(0:) R

Table of connected USB devices.

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

 - 2.0
Device­Number unsigned­Int R Device number on USB bus. - 2.0
USBVersion string­(:4) R USB specification version with which the device complies. Example: “1.1” - 2.0
Device­Class hex­Binary­(:1) R

Class Code as assigned by USB-IF.

When 0x00, each device specifies its own class code. When 0xFF, the class code is vendor specified.

 - 2.0
Device­Sub­Class hex­Binary­(:1) R Subclass code (assigned by USB-IF). - 2.0
Device­Version unsigned­Int­(:65535) R Device release number. - 2.0
Device­Protocol hex­Binary­(:1) R Protocol code (assigned by USB-IF). - 2.0
Product­ID unsigned­Int­(:65535) R Product ID (assigned by manufacturer). - 2.0
Vendor­ID unsigned­Int­(:65535) R Vendor ID (assigned by USB-IF). - 2.0
Manufacturer string­(:64) R Device Manufacturer string descriptor. - 2.0
Product­Class string­(:64) R Device Product Class string descriptor. - 2.0
Serial­Number string­(:64) R Device SerialNumber string descriptor. - 2.0
Port unsigned­Int­(:255) R

Hub port on parent device.

0 when no parent.

 - 2.0
USBPort string R The value MUST be the Path Name of a row in the Port. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is a reference to the USB host device to which this (external) USB device is connected. - 2.0
Rate string R

Speed of the USB device. Enumeration of:

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

Internal signaling between the connected USB device and the USB Host Controller provide the information needed to determine the negotiated rate.

 - 2.0
Parent string R

The value MUST be the Path Name of a row in the Device. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is a reference to the parent USB device (e.g. hub device).

This is an empty string for a device connected to the Host controller (root hub).

 - 2.0
Max­Children unsigned­Int R Number of ports. Only applies for hub device, equal to 0 for other devices. - 2.0
Is­Suspended boolean R

When true the associated Device is in a suspended (i.e. low-power) state (see [Chapter 11.9/USB2.0]).

When false the associated Device is in any of the other states specified by the USB 2.0 Device State Machine (see [Chapter 9.1.1/USB2.0]).

 - 2.0
Is­Self­Powered boolean R

When true the associated device is at least partly powered by a local source (see [Chapter 9.4.5/USB2.0]).

When false the associated device draws all the current it needs from the USB bus.

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

Table of device configurations.

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

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

Table of device interface descriptors.

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

 - 2.0
Interface­Number unsigned­Int­(:255) R Number of this interface (from USB interface descriptor). - 2.0
Interface­Class hex­Binary­(:1) R

Class Code as assigned by USB-IF.

When 0x00, each interface specifies its own class code. When 0xFF, the class code is vendor specified.

 - 2.0
Interface­Sub­Class hex­Binary­(:1) R Subclass code (assigned by USB-IF). - 2.0
Interface­Protocol hex­Binary­(:1) R Protocol code (assigned by USB-IF). - 2.0
Device.­HPNA. object R HPNA object that contains the Interface and Diagnostics objects. The HPNA (also known as HomePNA) industry standard [G.9954] defines peer to peer communication for home networking over existing coax cables and telephone wiring within the home. - 2.0
Interface­Number­Of­Entries unsigned­Int R The number of entries in the Interface table. - 2.0
Device.­HPNA.­Interface.­{i}. object(0:) R

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

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

 - 2.0
Enable boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

 - 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

 - 2.0
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.0
Name string­(:64) R

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

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the interface entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W

Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2].

Note: Since Device.HPNA.Interface.{i}. is a layer 1 interface, it is expected that LowerLayers will not be used.

 - 2.0
Upstream boolean R

Indicates whether the interface points towards the Internet (true) or towards End Devices (false).

For example:

  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
 - 2.0
MACAddress string­(:17) R

[MACAddress] The MAC Address of the interface.

Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter.

 - 2.0
Firmware­Version string­(:64) R This interface’s firmware version. - 2.0
Node­ID unsigned­Int R The Node ID of this interface. - 2.0
Is­Master boolean R Whether this interface is the HPNA network master. - 2.0
Synced boolean R Whether this interface is synchronized with the HPNA network master. If this interface is the HPNA network master, Synced MUST be true. - 2.0
Total­Sync­Time unsigned­Int R Total time in seconds (since device reset) that this interface has been up and synchronized to the HPNA network master. - 2.0
Max­Bit­Rate unsigned­Int R The maximum HPNA PHY bit rate (expressed in Mbps) of this interface. - 2.0
Network­Utilization unsigned­Int­(0:1000) R Current HPNA network utilization (expressed in 0.1%). - 2.0
Possible­Connection­Types string­[] R

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

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

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

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

Master selection mode. Enumeration of:

  • Automatic (Automatic master selection)
  • ForceEndpoint (Force local HPNA interface to be end point)
  • ForceMaster (Force local HPNA interface to be master)
 - 2.0
Associated­Device­Number­Of­Entries unsigned­Int R The number of entries in the AssociatedDevice table. This is the number of HPNA nodes that are directly accessible via this interface. - 2.0
Device.­HPNA.­Interface.­{i}.­Stats. object R

Throughput statistics for this interface.

The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

 - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int R The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Device.­HPNA.­Interface.­{i}.­Qo­S. object R QoS configuration object. - 2.0
Flow­Spec­Number­Of­Entries unsigned­Int R The number of entries in the FlowSpec table. - 2.0
Device.­HPNA.­Interface.­{i}.­Qo­S.­Flow­Spec.­{i}. object(0:) W

Flow specification table.

The QoS.Classification table is used to classify ingress traffic, where QoS.Classification.{i}.TrafficClass is one of the classification result outputs. This TrafficClass value can be used to look up the appropriate Device.HPNA.Interface.{i}.QoS.FlowSpec.{i}. entry (i.e. the Device.HPNA.Interface.{i}.QoS.FlowSpec.{i}. entry whose TrafficClasses list contains a matching traffic class).

For enabled table entries, if TrafficClasses is an empty string then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

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

The status of this entry. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL)

The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid.

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

 Disabled 2.0
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

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

Flow type. Enumeration of:

  • CBR (Constant Bit Rate)
  • VBR (Variable Bit Rate)
  • VBR-NRT (Variable Bit Rate - Non Real Time)
  • BE (Best Effort)
 BE 2.0
Priority unsigned­Int­(0:7) W

Flow queue network priority.

Priority 0 is the lowest priority.

 0 2.0
Latency unsigned­Int­(0:999) W

Maximum latency of the flow (expressed in milliseconds).

Value 0 means no latency requirements.

 0 2.0
Jitter unsigned­Int­(0:999) W

Maximum jitter of the flow (expressed in milliseconds).

Value 0 means no jitter requirements.

 0 2.0
Packet­Size unsigned­Int­(0:) W

Typical packet size.

Value 0 means undefined packet size.

 0 2.0
Min­Rate unsigned­Int W

Minimum required rate in Kbps.

Value 0 means no MinRate requirements.

 0 2.0
Avg­Rate unsigned­Int W

Average required rate in Kbps.

Value 0 means no AvgRate requirements.

 0 2.0
Max­Rate unsigned­Int W

Maximum required rate in Kbps.

Value 0 means no MaxRate requirements.

 0 2.0
PER unsigned­Int W

The desired packet error rate (expressed in 1E-8, e.g. PER of 1.27E-6 will be presented as 127).

Value 0 means no PER requirements.

 0 2.0
Timeout unsigned­Int W

Flow inactivity tear down timeout (expressed in milliseconds).

Value 0 means unlimited timeout.

 0 2.0
Device.­HPNA.­Interface.­{i}.­Associated­Device.­{i}. object(0:) R

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

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

 - 2.0
MACAddress string­(:17) R [MACAddress] The physical address of this node. - 2.0
Node­ID unsigned­Int R The Node ID of this node. - 2.0
Is­Master boolean R Whether this node is the HPNA network master. - 2.0
Synced boolean R Whether this node is synchronized with the HPNA network master. If this node is the HPNA network master, Synced MUST be true. - 2.0
Total­Sync­Time unsigned­Int R Total time in seconds (since device reset) that this node has been up and synchronized to the HPNA network master. - 2.0
Max­Bit­Rate unsigned­Int R This node’s maximum HPNA PHY bit rate (expressed in Mbps). - 2.0
PHYDiagnostics­Enable boolean W Enable / disable PHY throughput diagnostics mode on this node. All devices that are enabled will participate in the HPNA network PHY throughput diagnostics process. - 2.0
Active boolean R

Whether or not this node is currently present in the HPNA network.

The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE.

 - 2.0
Device.­HPNA.­Diagnostics. object R The HPNA Diagnostics object. - 2.0
PHYThroughput­() command -

[ASYNC] HPNA PHY throughput diagnostics configuration and results.

When diagnostics are requested, all HPNA nodes for which the Interface.{i}.AssociatedDevice.{i}.PHYDiagnosticsEnable parameter is set enter PHY diagnostics mode.

 - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Interface string­(:256) R [MANDATORY] The value MUST be the Path Name of a row in the HPNA.Interface. table. This is the interface over which the test is to be performed. - 2.12
⇒ Num­Packets­In­Burst unsigned­Int R [MANDATORY] Number of test packet in burst to be send during PHY diagnostics test from each HPNA device to other HPNA device in the HPNA network. - 2.12
⇒ Burst­Interval unsigned­Int R [MANDATORY] Test packet burst interval length (expressed in milliseconds). - 2.12
⇒ Test­Packet­Payload­Length unsigned­Int­(0:1480) R [MANDATORY] Payload length in the test packets. - 2.12
⇒ Payload­Encoding unsigned­Int R [MANDATORY] HPNA payload encoding in PHY diagnostics. 0 is used for negotiated payload between devices according to line conditions. - 2.12
⇒ Payload­Data­Gen unsigned­Int R [MANDATORY] Test packets payload data generator value. - 2.12
⇒ Payload­Type string R

[MANDATORY] Test packets payload type. Enumeration of:

  • Pattern
  • IncrementByte

In Pattern mode the PayloadDataGen value is repeated pattern in the payload.

In IncrementByte mode LSByte in PayloadDataGen is used as first payload and next bytes in payload are incremented.

 - 2.12
⇒ Priority­Level unsigned­Int­(0:7) R [MANDATORY] Priority level of PHY diagnostics packets (0 lowest -7 highest). - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string W

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL)
  • Error_FailToEnableCert
  • Error_CertCmdTimeout
  • Error_UnknownErr
  • Error_UnsupportedOpcode
  • Error_InvalidParam
  • Error_UnsupportedCmdSegment
  • Error_UnsupportedDataGen
  • Error_InvalidSequence
  • Error_InvalidFrame
  • Eror_InvalidOpcode

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

 - 2.13
⇐ Result.­{i}. object(0:) W

PHY throughput diagnostics results.

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

This table’s Instance Numbers MUST be 1, 2, 3… (assigned sequentially without gaps).

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

 - 2.12
⇐ Src­MACAddress string­(:17) W [MACAddress] HPNA source MAC address. - 2.12
⇐ Dest­MACAddress string­(:17) W [MACAddress] HPNA destination MAC address. - 2.12
⇐ PHYRate unsigned­Int W PHY diagnostics HPNA PHY rate (expressed in Mbps). - 2.12
⇐ Baud­Rate unsigned­Int W PHY Baud rate (expressed in Kbaud). - 2.12
⇐ SNR unsigned­Int W PHY diagnostics SNR (expressed in 0.1dB). - 2.12
⇐ Packets­Received unsigned­Int W Number of received packets in PHY diagnostics mode. - 2.12
⇐ Attenuation unsigned­Int W Measured attenuation (expressed in 0.1dB). - 2.12
Performance­Monitoring­() command -

[ASYNC] HPNA performance monitoring configuration and results.

Performance monitoring results are sampled from all nodes in the HPNA network. All packet related counters are sampled synchronized at all nodes in the HPNA network in order to derive packet loss calculations in the HPNA network.

 - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Interface string­(:256) R [MANDATORY] The value MUST be the Path Name of a row in the HPNA.Interface. table. This is the interface over which the test is to be performed. - 2.12
⇒ Sample­Interval unsigned­Int R

[MANDATORY] Time in seconds between automatic collection of performance monitoring data. A value of zero disables automatic collection of data.

The CPE MAY impose a minimum sample interval, in which case an attempt to set a (non-zero) interval that is less than this minimum MUST set the interval to the minimum and MUST NOT be regarded as an error.

If SampleInterval is a simple fraction of a day, e.g. 900 (a quarter of an hour) or 3600 (an hour), the CPE MAY choose to align sample intervals with time of day, but is not required to do so.

 - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string W

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL)
  • Error_SampleIntervalTooSmall

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

 - 2.13
⇐ Nodes. object W

Per-node HPNA performance monitoring results.

When automatic collection is enabled, i.e. SampleInterval is non-zero, the “current” interval is defined by the most recent automatic sample and the most recent subsequent manual sample, if any.

When automatic collection is disabled, i.e. SampleInterval is zero, the “current” interval is defined by the three most recent manual samples.

Note: Packets in statistics counters are Ethernet packets.

 - 2.12
⇐ Current­Start date­Time W

Start time for the current interval.

When automatic collection is enabled, i.e. SampleInterval is non-zero, the current interval started at the most recent automatic sample.

When automatic collection is disabled, i.e. SampleInterval is zero, the current interval started two manual samples ago.

 - 2.12
⇐ Current­End date­Time W

End time for the current interval.

When automatic collection is enabled, i.e. SampleInterval is non-zero, the current interval ended at the most recent manual sample since the most recent automatic sample. If there has been no such manual sample, the current interval is empty.

When automatic collection is disabled, i.e. SampleInterval is zero, the current interval ended at the most recent manual sample.

 - 2.12
⇐ Nodes.­Node.­{i}. object(1:) W

Per-node HPNA performance monitoring results during the current sample interval. Each table entry contains the results collected between an HPNA node (as indicated by MACAddress) and the local HPNA interface (as indicated by Interface).

Note: Packet counters indicate the number of packets received between CurrentStart and CurrentEnd.

This table MUST contain at least 1 entry. This table’s Instance Numbers MUST be 1, 2, 3… (assigned sequentially without gaps).

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

 - 2.12
⇐ MACAddress string­(:17) W [MACAddress] The MAC address of the HPNA node. - 2.12
⇐ Bytes­Sent unsigned­Long W The total number of bytes sent by host equipment for transmission on the HPNA interface. - 2.12
⇐ Bytes­Received unsigned­Long W The total number of received bytes on the HPNA interface destined for the host equipment. - 2.12
⇐ Packets­Sent unsigned­Long W The total number of packets sent by host equipment for transmission on the HPNA interface. Number includes also short error packets and control packets. - 2.12
⇐ Packets­Received unsigned­Long W The total number of good packets received on the HPNA interface destined for the host equipment. - 2.12
⇐ Broadcast­Packets­Sent unsigned­Long W The number of broadcast packets transmitted on the HPNA interface. - 2.12
⇐ Broadcast­Packets­Received unsigned­Long W The number of broadcast packets received on the HPNA interface. - 2.12
⇐ Multicast­Packets­Sent unsigned­Long W The number of multicast packets transmitted on the HPNA interface. - 2.12
⇐ Multicast­Packets­Received unsigned­Long W The number of multicast packets received on the HPNA interface. - 2.12
⇐ Packets­Crc­Errored unsigned­Int W The number of packets received on the HPNA interface with CRC errors. - 2.12
⇐ Packets­Crc­Errored­Host unsigned­Int W The number of CRC error packets received on the HPNA interface destined for the host equipment. - 2.12
⇐ Packets­Short­Errored unsigned­Int W The number of packets received on the HPNA interface that are too short to be valid. - 2.12
⇐ Packets­Short­Errored­Host unsigned­Int W The number packets sent by the host equipment that are too short to be valid. - 2.12
⇐ Rx­Packets­Dropped unsigned­Int W The number of received packets dropped due to lack of resources. - 2.12
⇐ Tx­Packets­Dropped unsigned­Int W The number packets sent by the host equipment for transmission on the HPNA interface but dropped due to lack of resources. - 2.12
⇐ Control­Request­Local unsigned­Int W The number of HPNA control request packets from local host. - 2.12
⇐ Control­Reply­Local unsigned­Int W The number of HPNA control reply packets to local host. - 2.12
⇐ Control­Request­Remote unsigned­Int W The number of HPNA control request packets from remote host. - 2.12
⇐ Control­Reply­Remote unsigned­Int W The number of HPNA control reply packets to remote host. - 2.12
⇐ Packets­Sent­Wire unsigned­Long W The total number of packets transmitted to wire. - 2.12
⇐ Broadcast­Packets­Sent­Wire unsigned­Long W The total number of broadcast packets transmitted to wire. - 2.12
⇐ Multicast­Packets­Sent­Wire unsigned­Long W The total number of multicast packets transmitted to wire. - 2.12
⇐ Packets­Internal­Control unsigned­Int W The number of HPNA control request packets from internal node. - 2.12
⇐ Broadcast­Packets­Internal­Control unsigned­Int W The number of HPNA broadcast control request packets from internal node. - 2.12
⇐ Packets­Received­Queued unsigned­Int W The number of received packets queued on host output queues. - 2.12
⇐ Packets­Received­Forward­Unknown unsigned­Int W The number of packets received and forwarded to unknown hosts. - 2.12
⇐ Node­Utilization unsigned­Int­(0:1000) W The node utilization (expressed in 0.1%). - 2.12
⇐ Channels. object W

Per-channel HPNA performance monitoring results.

Note: channels are unidirectional.

 - 2.12
⇐ Time­Stamp date­Time W Time at which channel data was last collected. - 2.12
⇐ Channels.­Channel.­{i}. object(0:) W

Per-channel HPNA performance monitoring results.

This table’s Instance Numbers MUST be 1, 2, 3… (assigned sequentially without gaps).

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

 - 2.12
⇐ Host­Src­MACAddress string­(:17) W [MACAddress] The host source MAC address associated with the channel. - 2.12
⇐ Host­Dest­MACAddress string­(:17) W [MACAddress] The host destination MAC address associated with the channel. - 2.12
⇐ HPNASrc­MACAddress string­(:17) W [MACAddress] The HPNA source MAC address associated with the channel. - 2.12
⇐ HPNADest­MACAddress string­(:17) W [MACAddress] The HPNA destination MAC address associated with the channel. - 2.12
⇐ PHYRate unsigned­Int W Channel PHY rate (expressed in Mbps). - 2.12
⇐ Baud­Rate unsigned­Int W PHY Baud rate (expressed in Kbaud). - 2.12
⇐ SNR unsigned­Int W Channel actual SNR measured in receiver side (expressed in 0.1dB). - 2.12
⇐ Packets­Sent unsigned­Int W Number of packets sent in the channel. - 2.12
⇐ Packets­Received unsigned­Int W Pre-LARQ number of packets received in the channel. - 2.12
⇐ LARQPackets­Received unsigned­Int W Post-LARQ number of packets received in the channel. Valid only if LARQ is enabled. - 2.12
⇐ Flow­Spec string­(:256) W

The value MUST be the Path Name of a row in the HPNA.Interface.{i}.QoS.FlowSpec. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Identifies the FlowSpec associated with the channel. This parameter is only used for channels that correspond to egress traffic from the local HPNA interface.

An empty string means that the channel is not associated with any specified flow specification in the QoS object.

 - 2.12
Device.­Mo­CA. object R MoCA object that contains the Interface table [MoCAv1.0] [MoCAv1.1]. - 2.0
Interface­Number­Of­Entries unsigned­Int R The number of entries in the Interface table. - 2.0
Device.­Mo­CA.­Interface.­{i}. object(0:) R

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

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

 - 2.0
Enable boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

 - 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

 - 2.0
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.0
Name string­(:64) R

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

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.0
Last­Change unsigned­Int R The accumulated time in seconds since the interface entered its current operational state. - 2.0
Lower­Layers string­(:1024)[] W

Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2].

Note: Since Device.MoCA.Interface.{i}. is a layer 1 interface, it is expected that LowerLayers will not be used.

 - 2.0
Upstream boolean R

Indicates whether the interface points towards the Internet (true) or towards End Devices (false).

For example:

  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
 - 2.0
MACAddress string­(:17) R

[MACAddress] The MAC Address of the interface.

Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter.

 - 2.0
Firmware­Version string­(:64) R

This interface’s firmware version.

This parameter is based on mocaIfSoftwareVersion from [MOCA11-MIB].

 - 2.0
Max­Bit­Rate unsigned­Int R The maximum MoCA PHY bit rate (expressed in Mbps). - 2.0
Max­Ingress­BW unsigned­Int R

The maximum bandwidth of this interface for flows onto the MoCA network in Mbps.

This parameter is based on mocaIfMaxIngressNodeBw from [MOCA11-MIB].

 - 2.0
Max­Egress­BW unsigned­Int R

The maximum bandwidth of this interface for flows from the MoCA network in Mbps.

This parameter is based on mocaIfMaxEgressNodeBw from [MOCA11-MIB].

 - 2.0
Highest­Version string­(:64) R

Identifies the highest MoCA version that this interface supports.

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

  • \d+(.\d+)*

This parameter is based on mocaIfMocaVersion from [MOCA11-MIB].

 - 2.0
Current­Version string­(:64) R

Identifies the MoCA version that the MoCA network is currently running.

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

  • \d+(.\d+)*

This parameter is based on mocaIfNetworkVersion from [MOCA11-MIB].

 - 2.0
Network­Coordinator unsigned­Int R

The Node ID of the current Network Coordinator (NC) for the MoCA network.

This parameter is based on mocaIfNC from [MOCA11-MIB].

 - 2.0
Node­ID unsigned­Int R

The Node ID of this interface.

This parameter is based on mocaIfNodeID from [MOCA11-MIB].

 - 2.0
Max­Nodes boolean R The maximum network node capability supported by the interface. If MaxNodes is true then the interface supports 16 nodes (the maximum for a MoCA 1.1 network). If MaxNodes is false then the interface supports 8 nodes (the maximum for a MoCA 1.0 network). - 2.0
Preferred­NC boolean W

Whether this interface is a preferred Network Coordinator (NC).

This parameter is based on mocaIfPreferredNC from [MOCA11-MIB].

 - 2.0
Backup­NC unsigned­Int R

The Node ID of the backup Network Coordinator node.

This parameter is based on mocaIfBackupNC from [MOCA11-MIB].

 - 2.0
Privacy­Enabled­Setting boolean W

The configured privacy mode. This indicates whether link-layer security is enabled (true) or disabled (false) for network admission.

The configured privacy setting MAY NOT match the current operational state (PrivacyEnabled), since this setting is only applied during network formation or admission.

 - 2.0
Privacy­Enabled boolean R

Indicates whether link-layer security is enabled or disabled.

This parameter is based on mocaIfPrivacyEnable from [MOCA11-MIB].

 - 2.0
Freq­Capability­Mask hex­Binary­(8) R

Hexadecimal encoded 64-bit mask of supported frequencies. This is the bit map of the spectrum that the interface supports, and each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency.

For example, an interface that supports 1150 MHz through 1500 MHz would have a value of 0x000000001FFFC000.

This parameter is based on mocaIfCapabilityMask from [MOCA11-MIB].

 - 2.0
Freq­Current­Mask­Setting hex­Binary­(8) W

The configured hexadecimal encoded 64-bit mask of enabled frequencies for network admission.

The configured frequencies MAY NOT match the current operational state (FreqCurrentMask), since this setting is only applied during network formation or admission.

 - 2.0
Freq­Current­Mask hex­Binary­(8) R

Hexadecimal encoded 64-bit mask of used frequencies. This is the bit map of the spectrum that can be used and is a subset of the FreqCapabilityMask. Each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency.

This parameter is based on mocaIfChannelMask from [MOCA11-MIB].

 - 2.0
Current­Oper­Freq unsigned­Int R

Current Operational Frequency. The RF frequency in Hz to which the MoCA interface is currently tuned. This parameter is only valid when Status is Up.

This parameter is based on mocaIfRFChannel from [MOCA11-MIB].

 - 2.0
Last­Oper­Freq unsigned­Int R

Last Operational Frequency. The RF frequency in Hz to which the MoCA interface was tuned when last in the Up state.

This parameter is based on mocaIfLOF from [MOCA11-MIB].

 - 2.0
Key­Passphrase string­(12:17) W

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

  • \d+

This parameter is based on mocaIfPassword from [MOCA11-MIB].

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

 - 2.0
Tx­Power­Limit unsigned­Int W

Transmit Power attenuation in dB relative to the maximum transmit power.

The MoCA interface SHOULD have Enable set to false for any change in this configuration. If the parameter is modified when Enable is true then this change might take several minutes to complete.

This parameter is based on mocaIfTxPowerLimit from [MOCA11-MIB].

 - 2.0
Power­Cntl­Phy­Target unsigned­Int W

Target PHY rate in Mbps for the power control algorithm.

The MoCA interface SHOULD have Enable set to false for any change in this configuration. If the parameter is modified when Enable is true then this change might take several minutes to complete.

This parameter is based on mocaIfPowerControlTargetRate from [MOCA11-MIB].

 - 2.0
Beacon­Power­Limit unsigned­Int W

Beacon Transmit Power attenuation in dB relative to the maximum transmit power.

The MoCA interface SHOULD have Enable set to false for any change in this configuration. If the parameter is modified when Enable is true then this change might take several minutes to complete.

This parameter is based on mocaIfBeaconPowerLimit from [MOCA11-MIB].

 - 2.0
Network­Taboo­Mask hex­Binary­(8) R

Hexadecimal encoded 64-bit mask of MoCA taboo channels identified for the home network. This is the bit map of the spectrum that the interface supports, and each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency.

This parameter is based on mocaIfTabooChannelMask from [MOCA11-MIB].

 - 2.0
Node­Taboo­Mask hex­Binary­(8) R

Hexadecimal encoded 64-bit mask of supported frequencies. This is the bit map of the spectrum that the interface supports, and each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency.

This parameter is based on mocaIfNodeTabooChannelMask from [MOCA11-MIB].

 - 2.0
Tx­Bcast­Rate unsigned­Int R

The broadcast PHY transmit rate in Mbps for this interface.

This parameter is based on mocaIfTxGcdRate from [MOCA11-MIB].

 - 2.0
Tx­Bcast­Power­Reduction unsigned­Int R

Transmit Power attenuation in dB relative to the maximum transmit power for broadcast transmissions.

This parameter is based on mocaIfTxGcdPowerReduction from [MOCA11-MIB].

 - 2.0
QAM256Capable boolean R

Whether this interface supports the 256 QAM feature.

This parameter is based on mocaIfQAM256Capable from [MOCA11-MIB].

 - 2.0
Packet­Aggregation­Capability unsigned­Int­(0:10) R

The packet aggregation capability supported by the interface. Standard values are 0 (no support), 6 (6 packets) or 10 (10 packets).

This parameter is based on mocaIfPacketsAggrCapability from [MOCA11-MIB].

 - 2.0
Associated­Device­Number­Of­Entries unsigned­Int R The number of entries in the AssociatedDevice table. - 2.0
Device.­Mo­CA.­Interface.­{i}.­Stats. object R

Throughput statistics for this interface.

The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

 - 2.0
Bytes­Sent unsigned­Long R The total number of bytes transmitted out of the interface, including framing characters. - 2.0
Bytes­Received unsigned­Long R The total number of bytes received on the interface, including framing characters. - 2.0
Packets­Sent unsigned­Long R The total number of packets transmitted out of the interface. - 2.0
Packets­Received unsigned­Long R The total number of packets received on the interface. - 2.0
Errors­Sent unsigned­Int R The total number of outbound packets that could not be transmitted because of errors. - 2.0
Errors­Received unsigned­Int R The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.0
Unicast­Packets­Sent unsigned­Long R The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.0
Unicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.0
Discard­Packets­Sent unsigned­Int R The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Discard­Packets­Received unsigned­Int R The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.0
Multicast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.0
Multicast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.0
Broadcast­Packets­Sent unsigned­Long R The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.0
Broadcast­Packets­Received unsigned­Long R The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.0
Unknown­Proto­Packets­Received unsigned­Int R The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.0
Device.­Mo­CA.­Interface.­{i}.­Qo­S. object R The QoS object provides information on MoCA parameterized QoS for this interface [MoCAv1.1]. - 2.0
Egress­Num­Flows unsigned­Int R

The number of QoS flows that this interface has from the MoCA network.

This parameter is based on mocaIfEgressNodeNumFlows from [MOCA11-MIB].

 - 2.0
Ingress­Num­Flows unsigned­Int R

The number of QoS flows that this interface has onto the MoCA network.

This parameter is based on mocaIfIngressNodeNumFlows from [MOCA11-MIB].

 - 2.0
Flow­Stats­Number­Of­Entries unsigned­Int R The number of entries in the FlowStats table. - 2.0
Device.­Mo­CA.­Interface.­{i}.­Qo­S.­Flow­Stats.­{i}. object(0:) R

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

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

 - 2.0
Flow­ID unsigned­Int R

The flow ID used to identify a flow in the network.

This parameter is based on mocaIfFlowID from [MOCA11-MIB].

 - 2.0
Packet­DA string­(:17) R

[MACAddress] The Destination Address (DA) for the packets in this flow.

This parameter is based on mocaIfPacketDA from [MOCA11-MIB].

 - 2.0
Max­Rate unsigned­Int R

Maximum required rate in Kbps.

This parameter is based on mocaIfPeakDataRate from [MOCA11-MIB].

 - 2.0
Max­Burst­Size unsigned­Int R

Maximum burst size.

This parameter is based on mocaIfBurstSize from [MOCA11-MIB].

 - 2.0
Lease­Time unsigned­Int R

Flow lease time (expressed in seconds).

A LeaseTime of 0 means unlimited lease time.

This parameter is based on mocaIfLeaseTime from [MOCA11-MIB].

 - 2.0
Lease­Time­Left unsigned­Int R

Flow lease time remaining (expressed in seconds).

If LeaseTime is 0 then a LeaseTimeLeft of 0 means unlimited lease time; otherwise, a LeaseTimeLeft of 0 means expired.

This parameter is based on mocaIfLeaseTimeLeft from [MOCA11-MIB].

 - 2.0
Flow­Packets unsigned­Int R

The number of packets transmitted for this flow.

This parameter is based on mocaIfTxPacketsFlow from [MOCA11-MIB].

 - 2.0
Device.­Mo­CA.­Interface.­{i}.­Associated­Device.­{i}. object(0:) R

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

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

 - 2.0
MACAddress string­(:17) R [MACAddress] The MAC address of the associated device’s MoCA interface. - 2.0
Node­ID unsigned­Int R

The Node ID of this remote device.

This parameter is based on mocaNodeIndex from [MOCA11-MIB].

 - 2.0
Preferred­NC boolean R

Whether this remote device is a preferred Network Coordinator (NC).

This parameter is based on mocaNodePreferredNC from [MOCA11-MIB].

 - 2.0
Highest­Version string­(:64) R

Identifies the highest MoCA version that this remote device supports.

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

  • \d+(.\d+)*

This parameter is based on mocaNodeMocaVersion from [MOCA11-MIB].

 - 2.0
PHYTx­Rate unsigned­Int R

The PHY transmit rate (in Mbps) to this remote device.

This parameter is based on mocaMeshTxRate from [MOCA11-MIB].

 - 2.0
PHYRx­Rate unsigned­Int R The PHY receive rate (in Mbps) from this remote device. - 2.0
Tx­Power­Control­Reduction unsigned­Int R

The reduction in transmitter level (in dB) due to power control.

This parameter is based on mocaNodeTxPowerReduction from [MOCA11-MIB].

 - 2.0
Rx­Power­Level unsigned­Int R

The power level (in dBm) received at the MoCA interface from this remote device.

This parameter is based on mocaNodeRxPower from [MOCA11-MIB].

 - 2.0
Tx­Bcast­Rate unsigned­Int R

The broadcast PHY transmit rate (in Mbps) from this remote device.

This parameter is based on mocaNodeTxGcdRate from [MOCA11-MIB].

 - 2.0
Rx­Bcast­Power­Level unsigned­Int R

The power level (in dBm) received at the MoCA interface from this remote device.

This parameter is based on mocaNodeRxGcdPower from [MOCA11-MIB].

 - 2.0
Tx­Packets unsigned­Int R The number of packets transmitted to this remote device (Note: Includes Broadcast, Multicast and Unicast packets). - 2.0
Rx­Packets unsigned­Int R

The number of packets received from this remote device (Note: Includes Broadcast, Multicast and Unicast packets).

This parameter is based on mocaNodeRxPackets from [MOCA11-MIB].

 - 2.0
Rx­Errored­And­Missed­Packets unsigned­Int R

The number of errored and missed packets received from this remote device.

This parameter is based on mocaNodeRxDrops from [MOCA11-MIB].

 - 2.0
QAM256Capable boolean R

Whether this remote device supports the 256 QAM feature.

This parameter is based on mocaNodeQAM256Capable from [MOCA11-MIB].

 - 2.0
Packet­Aggregation­Capability unsigned­Int­(0:10) R

The packet aggregation capability supported by the remote device. Standard values are 0 (no support), 6 (6 packets) or 10 (10 packets).

This parameter is based on mocaNodePacketsAggrCapability from [MOCA11-MIB].

 - 2.0
Rx­SNR unsigned­Int R

The signal to noise level (in dBm) received at this interface from this remote device.

This parameter is based on mocaNodeSNR from [MOCA11-MIB].

 - 2.0
Active boolean R

Whether or not this remote device is currently present in the MoCA network.

The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE.

 - 2.0
Device.­Ghn. object R G.hn object that contains an Interface table for G.hn supported CPE. The ITU-T G.hn specifications [G.9960] and [G.9961] define Physical and MAC Layers for communication between two or more G.hn nodes in the home network over multiple wired media such as power line, phone line and coaxial cable. - 2.4
Interface­Number­Of­Entries unsigned­Int R The number of entries in the Interface table. - 2.4
Device.­Ghn.­Interface.­{i}. object(0:) R

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

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

 - 2.4
Enable boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

 - 2.4
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

 - 2.4
Alias string­(:64) W

[Alias] A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.4
Name string­(:64) R

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

This is a non-functional key and its value MUST NOT change once it’s been assigned by the Controller or set internally by the Agent.

 - 2.4
Last­Change unsigned­Int R The accumulated time in seconds since the interface entered its current operational state. - 2.4
Lower­Layers string­(:1024)[] W

Comma-separated list (maximum number of characters per item 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2].

Note: Since Device.Ghn.Interface.{i}. is a layer 1 interface, it is expected that LowerLayers will not be used.

 - 2.4
Upstream boolean R

Indicates whether the interface points towards the Internet (true) or towards End Devices (false).

For example:

  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
 - 2.4
MACAddress string­(:17) R

[MACAddress] The MAC Address of the interface, denoted as node MAC address or REGID in [G.9961].

Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter.

 - 2.4
Firmware­Version string­(:64) R The firmware version of the interface. - 2.4
Connection­Type string R
This parameter was DEPRECATED in 2.8 because it has been replaced by MediumType.
This parameter was OBSOLETED in 2.14.

This parameter was DELETED in 2.15. Enumeration of:

  • Powerline
  • Phone
  • Coax
 - 2.4
Max­Transmit­Rate unsigned­Int R The maximum PHY data rate that the interface is capable of transmitting (expressed in Mbps). - 2.8
Target­Domain­Names string­(:32)(:1024)[] W Comma-separated list (maximum number of characters per item 1024) of strings (maximum number of characters per item 32). Identifies the target domains configured by the user, as described in [Section 8.6.1/G.9961]. When registering or re-registering, the G.hn interface SHOULD try to register to one of these domains in the given order. - 2.4
Domain­Name string­(:32) R

This is the domain name to which the interface is currently registered.

An empty string indicates that the interface is currently not registered.

 - 2.4
Domain­Name­Identifier unsigned­Int R The Domain Name Identifier, a shortened version of DomainName, denoted as DNI in [Section 8.6.11.2.1/G.9961]. - 2.4
Domain­Id unsigned­Int R The Domain Identifier of the domain to which the interface is registered, denoted as DOD in [G.9961]. - 2.4
Device­Id unsigned­Int R

The Device Identifier assigned by the Domain Master, denoted as DEVICE_ID in [G.9961].

The value 0 indicates that the device is not currently registered.

 - 2.4
Max­Bit­Rate unsigned­Int R The maximum PHY bit rate supported by this interface (expressed in Mbps). - 2.4
Node­Type­DMCapable boolean R Indicates whether this interface has the capability to act as Domain Master in the G.hn domain. - 2.4
DMRequested boolean W Indicates a request to force the role of the G.hn interface to Domain Master (DM) for the G.hn domain it is connected to. The selection of the Domain Master follows the procedures described in [Clause 8.6.6/G.9961]. - 2.8
Is­DM boolean R Indicates whether this G.hn interface is currently the Domain Master (DM) for the G.hn domain it is connected to, as described in [Clause 8.6/G.9961]. - 2.8
Node­Type­SCCapable boolean R Indicates whether this interface has the capability to act as Security Controller in the G.hn domain. - 2.4
SCRequested boolean W Indicates a request to force the role of the G.hn interface to Security Controller (SC) for the G.hn domain it is connected to. The selection of the Security Controller follows the procedures described in [Clause 9.2/G.9961]. - 2.8
Is­SC boolean R Indicates whether this G.hn interface is currently the Security Controller (SC) for the G.hn domain it is connected to, as described in [Clause 9.2/G.9961]. - 2.8
Standard­Versions string­[] R

Comma-separated list of strings. The standard versions that the interface supports. The list MUST have an even number of items. The first item of each pair represents an ITU-T G.hn Recommendation while the second element of each pair represents the amendment version of the indicated Recommendation that this interface supports (the value 0 corresponds to the base Recommendation).

For example, to indicate support for the G.9960 base document and G.9961 amendment 1, the corresponding list would be “G9960,0,G9961,1”.

 - 2.8
Max­Band­Plan unsigned­Int R The largest bandplan that the interface can support, as defined in [Clause 8.8.5.5/G.9961]. - 2.8
Medium­Type string R

The medium type that the interface currently operates on. Refer to [Table 7-5/G.9962]. Enumeration of:

  • PowerLineBaseband
  • PhoneLineBaseband
  • CoaxBaseband
  • CoaxRF
  • PlasticOpticalFiber
 - 2.8
TAIFG unsigned­Int R The Acknowledgement InterFrame Gap, or TAIFG, as defined in [Clause 8.4/G.9961]. It is represented as multiples of 1.28 microseconds. - 2.8
Notched­Amateur­Radio­Bands hex­Binary­(:2) W

A bit map representing usage of international amateur bands (0 = masked, 1 = unmasked). The LSB represents the lowest band (1.8-2.0 MHz), the second LSB represents the second lowest band (3.5-4.0 MHz), and so on. The maximum value for this parameter is 0x03FF, i.e. it is a 10-bit quantity represented in 16 bits and the top 6 bits are always zero.

International Radio amateur bands are described in [Table D-1/G.9964] and conveyed by the Domain Master in the Amateur radio band descriptor (see [Table 8-77/G.9961]).

 - 2.8
PHYThroughput­Diagnostics­Enable unsigned­Int­[] W Comma-separated list of DeviceIDs of nodes that need to enable their PHY throughput diagnostics mode. All devices that are enabled will participate in the G.hn network PHY throughput diagnostics process. - 2.8
Performance­Monitoring­Diagnostics­Enable unsigned­Int­[] W Comma-separated list of DeviceIDs of nodes that need to enable their Performance Monitoring diagnostics mode on this node. All devices that are enabled will participate in the G.hn network Performance Monitoring diagnostics process. - 2.8
SMMasked­Band­Number­Of­Entries unsigned­Int R The number of entries in the SMMaskedBand table. - 2.8
Node­Type­DMConfig boolean W

Requests the interface to become the Domain Master in the G.hn domain.

This parameter is valid only if NodeTypeDMCapable is true.

Note that, if more than one node is configured to act as Domain Master, G.hn specifies a protocol to ensure only one device actually becomes DM.

 - 2.4
Node­Type­DMStatus boolean R

Indicates whether the interface is acting as Domain Master (true) or not (false).

See Note in NodeTypeDMConfig regarding the possibility of more than one node being configured with NodeTypeDMConfig = true.

 - 2.4
Node­Type­SCStatus boolean R Indicates whether the interface is acting as Security Controller (true) or not (false). - 2.4
Associated­Device­Number­Of­Entries unsigned­Int R The number of entries in the AssociatedDevice table. - 2.4
PSM unsigned­Int­[2:32] W

Specifies the list of PSD shaping mask (PSM) breakpoints to be applied to the G.hn interface.

Comma-separated list (2 to 32 items) of PSMBreak Point Index And Levels, with each list item consisting of the following.

[PSMBreakPointIndexAndLevel] 1. The PSM breakpoint sub-carrier index in the range [0:4095], and

  1. the value of the level of the PSM at this sub-carrier expressed in 0.1 dBm/Hz with an offset of -140 dBm/Hz.

Both values are represented as unsignedInt.

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

The PSM level is 0.1*(the value of the level of the PSM) - 140 dBm/Hz.

For example, a PSM defined by two breakpoints (subcarrier 450, PSM level -80 dBm/Hz) and (subcarrier 1050, PSM level -90 dBm/Hz) is represented by PSM [450,600],[1050,500] .

 - 2.12
Device.­Ghn.­Interface.­{i}.­Stats. object R

Throughput statistics for this interface at the different G.hn reference points described in [Clause 8.1/G.9961].

The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

 - 2.4
Bytes­Sent unsigned­Long R

[StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters.

More specifically, this is the total number of MPDU bytes transmitted or retransmitted by the node through a physical medium (i.e., PMI defined in [Clause 5.2.1/G.9960]), which correspond to data LPDUs (i.e., data packets) and framing overhead (e.g., LFH, LPH, LPCS defined in [Clause 8.1/G.9961]). It does not include transmitted bytes contributed by management LPDUs (i.e., management packets).

Note: LPDUs in mixed LLC frame blocks are considered data LPDUs.

 - 2.4
Bytes­Received unsigned­Long R

[StatsCounter64] The total number of bytes received on the interface, including framing characters.

More specifically, this is the total number of MPDU bytes received by the node through a physical medium, which correspond to data LPDUs and framing overhead. It does not include received bytes contributed by management LPDUs. It can include blocks with errors.

Note: LPDUs in mixed LLC frame blocks are considered data LPDUs.

 - 2.4
Packets­Sent unsigned­Long R

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

More specifically, this is the total number of APDUs requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]) that were transmitted by the node through the physical medium. It does not include transmitted LCDUs.

 - 2.4
Packets­Received unsigned­Long R

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

More specifically, this is the total number of APDUs delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) that were received by the node through the physical medium. It does not include received LCDUs.

 - 2.4
Errors­Sent unsigned­Int R

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

More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]) but could not be transmitted because of errors (e.g., APDUs containing CRC errors).

 - 2.4
Errors­Received unsigned­Int R

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

More specifically, this is the total number of received APDUs that contained errors preventing them from being delivered to a higher layer (i.e., inbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]). The possible causes of error are: incorrect CRC, incorrect MIC, incorrect MIC size, and incorrect size of packet.

 - 2.4
Unicast­Packets­Sent unsigned­Long R

[StatsCounter64] The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent.

More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer. It includes APDUs that were discarded or not sent.

 - 2.4
Unicast­Packets­Received unsigned­Long R

[StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer.

More specifically, this is the total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer.

 - 2.4
Discard­Packets­Sent unsigned­Int R

[StatsCounter32] The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space.

More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) but chosen to be discarded even though no errors had been detected to prevent their being transmitted (e.g., buffer overflow).

 - 2.4
Discard­Packets­Received unsigned­Int R

[StatsCounter32] The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space.

More specifically, this is the total number of received APDUs that were chosen to be discarded even though no errors had been detected to prevent their being delivered.

 - 2.4
Multicast­Packets­Sent unsigned­Long R

[StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent.

More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer. It includes APDUs that were discarded or not sent.

 - 2.4
Multicast­Packets­Received unsigned­Long R

[StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer.

More specifically, this is the total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer.

 - 2.4
Broadcast­Packets­Sent unsigned­Long R

[StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent.

More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer. It includes APDUs that were discarded or not sent.

 - 2.4
Broadcast­Packets­Received unsigned­Long R

[StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer.

More specifically, this is the total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer.

 - 2.4
Unknown­Proto­Packets­Received unsigned­Int R

[StatsCounter32] The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol.

More specifically, this is the total number of APDUs received by the management that were discarded because of an unknown or unsupported protocol.

 - 2.4
Mgmt­Bytes­Sent unsigned­Long R [StatsCounter64] The total number of MPDU bytes transmitted by the node through a physical medium, which correspond to management LPDUs and framing overhead. - 2.8
Mgmt­Bytes­Received unsigned­Long R [StatsCounter64] The total number of MPDU bytes received by the node through a physical medium, which correspond to management LPDUs and framing overhead. - 2.8
Mgmt­Packets­Sent unsigned­Long R [StatsCounter64] The total number of LCDUs requested for transmission by a management layer (i.e., outbound LCDUs generated in LLC defined in [Clause 8.1.3/G.9961]) that were transmitted by the node through a physical medium. - 2.8
Mgmt­Packets­Received unsigned­Long R [StatsCounter64] The total number of LCDUs delivered to a management layer (i.e., inbound LCDUs) that were received by the node through a physical medium. - 2.8
Blocks­Sent unsigned­Long R [StatsCounter64] The total number of LPDUs that were transmitted by the node through a physical medium, regardless of new or retransmitted LPDUs. - 2.8
Blocks­Received unsigned­Long R [StatsCounter64] The total number of LPDUs that were received by the node through a physical medium, with or without errors. - 2.8
Blocks­Resent unsigned­Int R [StatsCounter32] The total number of LPDUs that were retransmitted. - 2.8
Blocks­Errors­Received unsigned­Int R

[StatsCounter32] The total number of received LPDUs that contained errors.

Note the following relationships hold:

  • PacketsSent + ErrorsSent + DiscardPacketsSent = UnicastPacketsSent

    • MulticastPacketsSent + BroadcastPacketsSent.

  • PacketsReceived = UnicastPacketsReceived + MulticastPacketsReceived

    • BroadcastPacketsReceived.
  • Retransmission rate = BlocksResent / BlocksSent.
  • Block error rate = BlocksErrorReceived / BlocksReceived.
 - 2.8
Device.­Ghn.­Interface.­{i}.­Associated­Device.­{i}. object(0:) R

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

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

 - 2.4
MACAddress string­(:17) R

[MACAddress] MAC address of remote G.hn device.

This is denoted as REGID in [G.9961].

 - 2.4
Device­Id unsigned­Int R Device Id (as defined in G.hn) for the remote G.hn device, denoted as DEVICE_ID in [G.9961]. - 2.4
Tx­Phy­Rate unsigned­Int R

The PHY transmit Rate (expressed in Mbps) to this remote device, denoted as PHY data rate in [G.9961].

Refer to Note 1 of [Table 8-48/G.9961]. To convert from the value in the table, divide by 32K (32768) and round down.

 - 2.4
Rx­Phy­Rate unsigned­Int R

The PHY receive Rate (expressed in Mbps) from this remote device, denoted as PHY data rate in [G.9961].

Refer to Note 1 of [Table 8-48/G.9961]. To convert from the value in the table, divide by 32K (32768) and round down.

 - 2.4
Active boolean R

Whether or not this device is currently present in the G.hn domain.

The ability to list inactive nodes is OPTIONAL. If the CPE includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE.

If Active is true, it indicates that the Status of the remote device is 0, 1, or 2 (see [Table 7-3/G.9961]).

 - 2.4
Device.­Ghn.­Interface.­{i}.­DMInfo. object R This object specifies management parameters pertaining to the domain functionality (Domain Master function; see [Clause 8.6/G.9961]). The object exists only on G.hn interfaces that are currently the Domain Master, i.e. for which parameter IsDM is true. - 2.8
Domain­Name hex­Binary­(:32) W This is the domain name to which the interface is currently registered. An empty string indicates that the interface is currently not registered. - 2.8
Domain­Name­Identifier hex­Binary­(:2) R The Domain Name Identifier, a shortened version of DomainName, denoted as DNI in [Section 8.6.11.2.1/G.9961]. - 2.8
Domain­Id unsigned­Int R The Domain Identifier of the domain to which the interface is registered, denoted as DOD in [G.9961]. - 2.8
MACCycle­Duration unsigned­Int­(0,­10:200) W The MAC cycle duration, as specified in [Clause 8.4/G.9961]. It is represented as multiples of 0.5 msec. In the case of power line, writing to this parameter has no effect and it reads back as 0, which is a special value indicating that the MAC cycle is synchronized with 2 AC cycles as defined in [Clause 8.6.3.1/G.9961]. - 2.8
SCDevice­Id unsigned­Int W The DEVICE_ID of the Security Controller selected by the Domain Master. - 2.8
SCMACAddress string­(:17) W [MACAddress] The REGID of the Security Controller selected by the Domain Master. - 2.8
Reregistration­Time­Period unsigned­Int­(5:63) W The time interval for periodic re-registration, as specified in [Clause 8.8.5.8/G.9961]. It is represented as multiples of 2 seconds. - 2.8
Topology­Periodic­Interval unsigned­Int­(0:255) W The time interval that a node sends out the periodic topology update using TM_NodeTopologyChange.ind message, as specified in [Clause 8.8.5.8.1/G.9961]. It is represented as multiples of 0.1 sec. The special value 0 represents an infinite interval (i.e., no periodic topology update). - 2.8
Min­Supported­Bandplan unsigned­Int W Indicates the value of the minimal bandplan capability for a node that is allowed to register to the domain. - 2.8
Max­Supported­Bandplan unsigned­Int W Indicates the value of the minimal bandplan capability for a node that is allowed to register to the domain. - 2.8
Device.­Ghn.­Interface.­{i}.­SCInfo. object R This object specifies management parameters pertaining to the Security Controller functionality (Security Controller function; see [Clause 9.2/G.9961]). The object exists only on G.hn interfaces that are currently the Security Controller, i.e. for which parameter IsSC is true. - 2.8
Modes­Supported string­[] R

Comma-separated list of strings. The security modes that the Security Controller can support. Refer to [Clause 9.2/G.9961]. Each list item is an enumeration of:

  • NN (Node-to-Node)
  • NMK (Network Membership Key)
 - 2.8
Mode­Enabled string W The value MUST be a member of the list reported by the ModesSupported parameter, or else be Disabled. The security mode in which the Security Controller is operating. - 2.8
MICSize string W

The selected MIC size used in the domain. Enumeration of:

  • 4-byte MIC
  • 8-byte MIC
  • 16-byte MIC
 - 2.8
Location boolean R Indicates whether the Security Controller is above the L1 reference point. It is set to true if the Security Controller is above the L1 reference point, and set to false otherwise. - 2.8
Device.­Ghn.­Interface.­{i}.­SMMasked­Band.­{i}. object(0:32) W

Specifies the list of masked bands to be applied to the G.hn interface. This information is conveyed by the Domain Master in the SM descriptor as specified in [Table 8-77/G.9961].

Instances of this object are expected to exist only on G.hn interfaces that are currently the Domain Master, i.e. for which parameter IsDM is true.

This table MUST contain at least 0 and at most 32 entries.

At most one entry in this table can exist with a given value for BandNumber. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for BandNumber such that the new entry does not conflict with any existing entries.

 - 2.8
Enable boolean W Enables or disables the Device.Ghn.Interface.{i}.SMMaskedBand.{i}.. - 2.8
Band­Number unsigned­Int W

The masked band number.

If the value isn’t assigned by the Controller on creation, the Agent MUST choose an initial value that doesn’t conflict with any existing entries.

 - 2.8
Start­Sub­Carrier unsigned­Int W Index of the lowest frequency sub-carrier in the band to be masked as specified in [Table 8-79/G.9961]. This parameter is writable only on the interface which acts as the Domain Master. - 2.8
Stop­Sub­Carrier unsigned­Int W Index of the highest frequency sub-carrier in the band to be masked as specified in Table 8-79 in [G.9961]. This parameter is writable only on the interface which acts as the Domain Master. - 2.8
Device.­Ghn.­Diagnostics. object R The G.hn Diagnostics object. - 2.8
PHYThroughput­() command -

[ASYNC] G.hn PHY throughput diagnostics configuration and results.

When diagnostics are requested, all G.hn nodes for which the Interface.{i}.PHYThroughputDiagnosticsEnable parameter is set enter PHY diagnostics mode.

 - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Interface string R [MANDATORY] The value MUST be the Path Name of a row in the Ghn.Interface. table. The interface over which the test is to be performed. - 2.12
⇒ Diagnose­MACAddress string­(:17) R

[MANDATORY] [MACAddress] The MAC address of the originating G.hn interface of the link that is being diagnosed.

Note: This MAC address might belong to another node of the domain.

 - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string W

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL)

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

 - 2.13
⇐ Result.­{i}. object(0:) W

PHY throughput diagnostics results.

This table’s Instance Numbers MUST be 1, 2, 3… (assigned sequentially without gaps).

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

 - 2.12
⇐ Destination­MACAddress string­(:17) W [MACAddress] MAC address of the destination node of the link being measured. - 2.12
⇐ Link­State string W

Indicates the state of the link between the G.hn Interface with MAC address DiagnoseMACAddress and the G.hn Interface with MAC address DestinationMACAddress. Enumeration of:

 - 2.12
⇐ Tx­Phy­Rate unsigned­Int W PHY data rate in transmit direction in the link between the G.hn Interface with MAC address DiagnoseMACAddress and the G.hn Interface with MAC address DestinationMACAddress. It is represented in Mbps as defined in Note 1 to [Table 8-48/G.9961]. To convert from the value in the table, divide by 32K (32768) and round down. - 2.12
⇐ Rx­Phy­Rate unsigned­Int W PHY data rate in receive direction in the link between the G.hn Interface with MAC address DiagnoseMACAddress and the G.hn Interface with MAC address DestinationMACAddress. It is represented in Mbps as defined in Note 1 to [Table 8-48/G.9961]. To convert from the value in the table, divide by 32K (32768) and round down. - 2.12
Performance­Monitoring­() command -

[ASYNC] G.hn Performance Monitoring diagnostics configuration and results.

When diagnostics are requested, all G.hn nodes for which the Interface.{i}.PerformanceMonitoringDiagnosticsEnable parameter is set enter PHY diagnostics mode.

 - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Interface string R [MANDATORY] The value MUST be the Path Name of a row in the Ghn.Interface. table. The interface over which the test is to be performed. - 2.12
⇒ Diagnose­MACAddress string­(:17) R

[MANDATORY] [MACAddress] The MAC address of the originating G.hn interface of the link that is being diagnosed.

Note: This MAC address might belong to another node of the domain.

 - 2.12
⇒ Sample­Interval unsigned­Int R

[MANDATORY] Time in seconds between automatic collection of performance monitoring data. A value of zero disables automatic collection of data.

The node MAY impose a minimum sample interval, in which case an attempt to set a (non-zero) interval that is less than this minimum MUST set the interval to the minimum and MUST NOT be regarded as an error.

If SampleInterval is a simple fraction of a day, e.g. 900 (a quarter of an hour) or 3600 (an hour), the device MAY choose to align sample intervals with time of day, but is not required to do so.

 - 2.12
⇒ SNRGroup­Length unsigned­Int­(1,­2,­4,­8,­16,­32,­64,­128,­256) R [MANDATORY] The number of sub-carriers in a group to be used for averaging SNR values when providing SNR information for a channel. - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string W

Indicates the availability of diagnostics data. Enumeration of:

  • Canceled (OPTIONAL)
  • Complete
  • Error (OPTIONAL)

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

 - 2.13
⇐ Nodes. object W

Per-node G.hn performance monitoring results.

When automatic collection is enabled, i.e. SampleInterval is non-zero, the “current” interval is defined by the most recent automatic sample and the most recent subsequent manual sample, if any.

When automatic collection is disabled, i.e. SampleInterval is zero, the “current” interval is defined by the three most recent manual samples.

Note: Packets in statistics counters are Ethernet packets.

 - 2.12
⇐ Current­Start date­Time W

Start time for the current interval.

When automatic collection is enabled, i.e. SampleInterval is non-zero, the current interval started at the most recent automatic sample.

When automatic collection is disabled, i.e. SampleInterval is zero, the current interval started two manual samples ago.

 - 2.12
⇐ Current­End date­Time W

End time for the current interval.

When automatic collection is enabled, i.e. SampleInterval is non-zero, the current interval ended at the most recent manual sample since the most recent automatic sample. If there has been no such manual sample, the current interval is empty.

When automatic collection is disabled, i.e. SampleInterval is zero, the current interval ended at the most recent manual sample.

 - 2.12
⇐ Nodes.­Node.­{i}. object(1:) W

Per-node G.hn performance monitoring results during the current sample interval. Each table entry contains the results collected between the G.hn nodes with MAC addresses DiagnoseMACAddress) and DestinationMACAddress).

Note: Packet counters indicate the number of packets received between CurrentStart and CurrentEnd.

This table MUST contain at least 1 entry. This table’s Instance Numbers MUST be 1, 2, 3… (assigned sequentially without gaps).

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

 - 2.12
⇐ Destination­MACAddress string­(:17) W [MACAddress] MAC address of the destination node of the link being measured. - 2.12
⇐ Bytes­Sent unsigned­Long W

[StatsCounter64] The total number of MPDU bytes transmitted or retransmitted by the node through a physical medium (i.e., PMI defined in [Clause 5.2.1/G.9960]), which correspond to data LPDUs (i.e., data packets) and framing overhead (e.g., LFH, LPH, LPCS defined in [Clause 8.1/G.9961]). It does not include transmitted bytes contributed by management LPDUs (i.e., management packets).

Note: LPDUs in mixed LLC frame blocks are considered data LPDUs.

 - 2.12
⇐ Bytes­Received unsigned­Long W

[StatsCounter64] The total number of MPDU bytes received by the node through a physical medium, which correspond to data LPDUs and framing overhead. It does not include received bytes contributed by management LPDUs. It might include blocks with errors.

Note: LPDUs in mixed LLC frame blocks are consider