Broadband Forum

USP Device:2.12 Root Object definition
tr-181-2-12-0-usp.xml (changes)

DATA MODEL DEFINITION

License

Copyright (c) 2010-2018, Broadband Forum

The undersigned members have elected to grant the copyright to their contributed material used in this software:
Copyright (c) 2017-2018 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.

Summary

Data Types

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

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

Data Type Base Type Description
base64 -

Base64 encoded binary (no line-length limitation).

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

boolean - Boolean, where the allowed values are 0 or 1 (or equivalently, true or false).
dateTime - The subset of the ISO 8601 date-time format defined by the SOAP dateTime type.
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.

The value MUST NOT change once it's been assigned.

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

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

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

Possible patterns:

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

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

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

  • 216.52.29.100
  • 192.168.1.254

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

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

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

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

IPPrefix string(49)

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

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

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

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

IPv4Address IPAddress(15)

IPv4 address (or subnet mask).

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

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

IPv4 address prefix.

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

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

IPv6 address.

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

IPv6Prefix IPPrefix(49)

IPv6 address prefix.

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

MACAddress string(17)

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

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

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

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

Both values are represented as unsignedInt.

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

StatsCounter32 unsignedInt

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

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

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

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

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

StatsCounter64 unsignedLong

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

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

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

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

UUID string(36:36)

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

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

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

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

References

[3GPP-HSPA] High Speed Packet data Access (HSPA), 3GPP.
[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.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.11b-1999] IEEE Std 802.11b-1999, Higher Speed Physical Layer Extension in the 2.4 GHz band, IEEE, 1999.
[802.11g-2003] IEEE Std 802.11g-2003, Further Higher Data Rate Extension in the 2.4 GHz Band, IEEE, 2003.
[802.11h-2003] IEEE Std 802.11h-2003, Spectrum and Transmit Power Management Extensions, IEEE, 2003.
[802.11n-2009] IEEE Std 802.11n-2009, Amendment 5: Enhancements for Higher Throughput, IEEE, 2009.
[802.1AB-2009] IEEE Std 802.1AB-2009, Station and Media Access Control Connectivity Discovery, IEEE, 2009.
[802.1ad-2005] IEEE Std 802.1ad-2005, Virtual Bridged Local Area Networks Amendment 4: Provider Bridges, IEEE, May 2005.
[802.1AX-2014] IEEE Std 802.1AX-2014, IEEE Standard for Local and metropolitan area networks -- Link Aggregation, IEEE, 2014.
[802.1D-2004] IEEE Std 802.1D-2004, Media Access Control (MAC) Bridges, IEEE, 2004.
[802.1Q-2005] IEEE Std 802.1Q-2005, Virtual Bridged Local Area Networks, IEEE, 2006.
[802.1Q-2011] IEEE Std 802.1Q-2011, MAC Bridges and Virtual Bridge Local Area Networks, IEEE, 2011.
[802.1x-2004] IEEE Std 802.1x-2004, Standards for Local and Metropolitan Area Networks: Port based Network Access Control, IEEE, 2004.
[802.3-2015] IEEE Std 802.3-2015, IEEE Standard for Ethernet, IEEE, 2015.
[802.3-2012_section6] IEEE 802.3-2012 - Section Six, IEEE Standard for Ethernet - Section Six, IEEE, December 2012.
[BLUE] Blue, A New Class of Active Queue Management Algorithms.
[DLNA-NDIG] DLNA Networked Device Interoperability Guidelines, DLNA Networked Device Interoperability Guidelines, Volume 2: Media Format Profiles., DLNA, October 2006.
[DNS-SD] RFC 6763, DNS-Based Service Discovery, IETF, 2013.
[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.
[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.988] G.988, ONU management and control interface (OMCI) specification, ITU-T, 2010.
[G.9701] G.9701, Fast access to subscriber terminals (G.fast)- Physical layer specification, ITU-T, 2014.
[G.9954] G.9954, Phoneline networking transceivers - Enhanced physical, media access, and link layer specifications (HPNA 3.0 and 3.1), ITU-T, 2007.
[G.9960] G.9960, Unified high-speed wire-line based home networking transceivers - System architecture and physical layer specification, ITU-T.
[G.9961] G.9961, Unified high-speed wire-line based home networking transceivers - Data link layer specification, ITU-T.
[G.9962] G.9962, Unified high-speed wire-line based home networking transceivers - Management specification, ITU-T.
[G.9964] G.9964, Unified high-speed wire-line based home networking transceivers - Power spectral density specification, ITU-T.
[G.9973] G.9973, Protocol for identifying home network topology, ITU-T, 2011.
[G.993.1] G.993.1, Very high speed digital subscriber line transceivers, ITU-T.
[G.993.2] G.993.2, Very high speed digital subscriber line transceivers 2 (VDSL2), ITU-T.
[G.997.1] G.997.1, Physical layer management for digital subscriber line (DSL) transceivers, ITU-T.
[G.997.2] G.997.2, Physical layer management for FAST transceivers, ITU-T, 2015.
[G.998.1] G.998.1, ATM-based Multi-Pair Bonding, ITU-T, 2005.
[G.998.2] G.998.2, Ethernet-based Multi-Pair Bonding, ITU-T, 2005.
[G.998.3] G.998.3, Multi-Pair Bonding Using Time-Division Inverse Multiplexing, ITU-T, 2005.
[HPAV1.1] HomePlug AV Specification, Version 1.1, HomePlug, 2007.
[HTML4.01] HTML 4.01 Specification, W3C.
[IANA-protocolnumbers] IANA Protocol Numbers, Protocol Numbers, IANA.
[IANAifType] IANAifType, IANAifType-MIB DEFINITIONS, IANA, 2009.
[ICSA-Baseline] ICSA Baseline Modular Firewall Certification Criteria, Baseline module - version 4.1, ICSA Labs, 2008.
[ICSA-Residential] ICSA Residential Modular Firewall Certification Criteria, Required Services Security Policy - Residential Category module - version 4.1, ICSA Labs, 2008.
[IEEE1905.1a] IEEE 1905.1a, IEEE Std 1905.1a, Convergent Digital Home Network for Heterogeneous Technologies Amendment 1: Support of new MAC/PHYs and enhancements, IEEE, December 2014., IEEE, December 2014.
[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.
[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.
[OUI] Organizationally Unique Identifiers (OUIs).
[PCPProxy] PCP Proxy Function, Port Control Protocol (PCP) Proxy Function, IETF, September 2015.
[RED] References on RED (Random Early Detection) Queue Management.
[RFC793] RFC 793, Transmission Control Protocol, IETF, September 1981.
[RFC862] RFC 862, Echo Protocol, IETF, 1983.
[RFC959] RFC 959, File Transfer Protocol, IETF, 1985.
[RFC1035] RFC 1035, Domain Names - Implementation and Specification, IETF, 1987.
[RFC1323] RFC 1323, TCP Extensions for High Performance, IETF, May 1992.
[RFC1332] RFC 1332, The PPP Internet Protocol Control Protocol (IPCP), IETF, 1992.
[RFC1378] RFC 1378, The PPP AppleTalk Control Protocol (ATCP), IETF, 1992.
[RFC1552] RFC 1552, The PPP Internetwork Packet Exchange Control Protocol (IPXCP), IETF, 1993.
[RFC1661] RFC 1661, The Point-to-Point Protocol (PPP), IETF, 1994.
[RFC1877] RFC 1877, PPP Internet Protocol Control Protocol Extensions for Name Server Addresses, IETF, 1995.
[RFC1974] RFC 1974, PPP Stac LZS Compression Protocol, IETF, 1996.
[RFC2080] RFC 2080, RIPng for IPv6, IETF, 1997.
[RFC2097] RFC 2097, The PPP NetBIOS Frames Control Protocol (NBFCP), IETF, 1997.
[RFC2131] RFC 2131, Dynamic Host Configuration Protocol, IETF.
[RFC2132] RFC 2132, DHCP Options and BOOTP Vendor Extensions, IETF.
[RFC2225] RFC 2225, Classical IP and ARP over ATM, IETF.
[RFC2364] RFC 2364, PPP Over AAL5, IETF, 1998.
[RFC2474] RFC 2474, Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers, IETF.
[RFC2581] RFC 2581, TCP Congestion Control, IETF, April 1999.
[RFC2582] RFC 2582, The NewReno Modification to TCP's Fast Recovery Algorithm, IETF, April 1999.
[RFC2616] RFC 2616, Hypertext Transfer Protocol -- HTTP/1.1, IETF, 1999.
[RFC2684] RFC 2684, Multiprotocol Encapsulation over ATM Adaptation Layer 5, IETF.
[RFC2697] RFC 2697, A Single Rate Three Color Marker, IETF.
[RFC2698] RFC 2698, A Two Rate Three Color Marker, IETF.
[RFC2782] RFC 2782, A DNS RR for specifying the location of services (DNS SRV), IETF, 2000.
[RFC2784] RFC 2784, Generic Routing Encapsulation (GRE), IETF, November 2000.
[RFC2818] RFC 2818, HTTP Over TLS, IETF, May 2000.
[RFC2819] RFC 2819, Remote Network Monitoring Management Information Base, IETF, 2000.
[RFC2863] RFC 2863, The Interfaces Group MIB, IETF, 2000.
[RFC2865] RFC 2865, Remote Authentication Dial In User Service (RADIUS), IETF, 2000.
[RFC2866] RFC 2866, RADIUS Accounting, IETF, 2000.
[RFC2869] RFC 2869, RADIUS Extensions, IETF, 2000.
[RFC2890] RFC 2890, Key and Sequence Number Extensions to GRE, IETF, November 2000.
[RFC2898] RFC 2898, PKCS #5: Password-Based Cryptography Specification Version 2.0, IETF.
[RFC3004] RFC 3004, The User Class Option for DHCP, IETF.
[RFC3066] RFC 3066, Tags for the Identification of Languages, IETF.
[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.
[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.
[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.
[RFC5072] RFC 5072, IP Version 6 over PPP, IETF, 2007.
[RFC5139] RFC 5139, Revised Civic Location Format For Presence Information Data Format Location Object (PIDF-LO), IETF, February 2008.
[RFC5280] RFC 5280, Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile, IETF, May 2008.
[RFC5491] RFC 5491, GEOPRIV Presence Information Data Format Location Object (PIDF-LO) Usage Clarification, Considerations, and Recommendations, IETF, March 2009.
[RFC5625] RFC 5625, DNS Proxy Implementation Guidelines, IETF, 2009.
[RFC5969] RFC 5969, IPv6 Rapid Deployment on IPv4 Infrastructures (6rd) - Protocol Specification, IETF, 2010.
[RFC5996] RFC 5996, Internet Key Exchange Protocol Version 2 (IKEv2), IETF, September 2010.
[RFC6106] RFC 6106, IPv6 Router Advertisement Option for DNS Configuration, IETF, 2010.
[RFC6120] RFC 6120, Extensible Messaging and Presence Protocol (XMPP) : Core, IETF, 2011.
[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.
[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.
[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.
[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-069a2] TR-069 Amendment 2, CPE WAN Management Protocol, Broadband Forum, December 2007.
[TR-069a5] TR-069 Amendment 5, CPE WAN Management Protocol, Broadband Forum, December 2013.
[TR-098] TR-098 Amendment 2 Corrigendum 1, Internet Gateway Device Data Model for TR-069, Broadband Forum, December 2014.
[TR-106] TR-106 Amendment 8, Data Model Template for CWMP Endpoints and USP Agents, Broadband Forum, May 2018.
[TR-106a2] TR-106 Amendment 2, Data Model Template for TR-069-Enabled Devices, Broadband Forum, November 2008.
[TR-106a4] TR-106 Amendment 4, Data Model Template for TR-069-Enabled Devices, Broadband Forum, February 2010.
[TR-106a7] TR-106 Amendment 7, Data Model Template for TR-069-Enabled Devices, Broadband Forum, September 2013.
[TR-143] TR-143 Amendment 3, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, May 2017.
[TR-143a1] TR-143 Amendment 1, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, December 2014.
[TR-157] TR-157 Amendment 10, Component Objects for CWMP, Broadband Forum, November 2015.
[TR-157a10] TR-157 Amendment 10, Component Objects for CWMP, Broadband Forum, November 2015.
[TR-159] TR-159, Management Framework for xDSL Bonding, Broadband Forum, December 2008.
[TR-181i1] TR-181 Issue 1, Device Data Model for TR-069, Broadband Forum, February 2010.
[TR-181i2] TR-181 Issue 2 Amendment 13, Device Data Model, Broadband Forum, September 2019.
[TR-181i2a2] TR-181 Issue 2 Amendment 2, Device Data Model for TR-069, Broadband Forum, February 2011.
[TR-181i2a5] TR-181 Issue 2 Amendment 5, Device Data Model for TR-069, Broadband Forum, 2012.
[TR-181i2a8] TR-181 Issue 2 Amendment 8, Device Data Model for TR-069, Broadband Forum, September 2014.
[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-390] TR-390, Performance Measurement from Customer Equipment to IP Edge, Broadband Forum, May 2017.
[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-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.
[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.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

Legend

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

Device:2.12 Data Model ​(changes)

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

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

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

- 2.12 TR-181i2a12
InterfaceStackNumberOfEntries unsignedInt unsignedInt - The number of entries in the InterfaceStack table. - 2.12 TR-181i2a12
ProxiedDeviceNumberOfEntries unsignedInt unsignedInt - The number of entries in the ProxiedDevice table. - 2.12 TR-181i2a12
Reboot​() command object - Reboot the entity associated with the containing Device. - 2.12 TR-181i2a12
Boot! event object - Boot event indicating that the Device was rebooted. - 2.12 TR-181i2a12
⇒ CommandKey string string - The command_key supplied when requesting the boot, or an empty string if the boot was not requested via a USP operation. - 2.12 TR-181i2a12
⇒ Cause string string -

The cause of the boot. Enumeration of:

- 2.12 TR-181i2a12
⇒ FirmwareUpdated boolean boolean - true if the firmware was updated as a result of the boot that caused this Event Notification; otherwise false. - 2.12 TR-181i2a12
⇒ ParameterMap string JSONObject -

[JSONObject] Boot parameters configured via the recipient Controller's LocalAgent.Controller.{i}.BootParameter table.

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

- 2.12 TR-181i2a12
FactoryReset​() command object - Factory reset the entity associated with the containing Device. - 2.12 TR-181i2a12
SelfTestDiagnostics​() command object - [ASYNC] This diagnostics test is vendor-specific and MAY include testing hardware, software, and/or firmware. - 2.12 TR-181i2a12
⇐ Output. arguments object - Output arguments. -
⇐ Results string​(1024) string​(1024) - Results of self-test (vendor specific). - 2.12 TR-181i2a12
Device.​Services. object object​[1:1] - This object contains general services information. - 2.12 TR-181i2a12
Device.​DeviceInfo. object object​[1:1] - This object contains general device information. - 2.12 TR-181i2a12
DeviceCategory string​[] list of string -

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

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

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

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

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

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

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

- 2.12 TR-181i2a12
CID string​(6:6) string​(6:6) -

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:

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.12 TR-181i2a12
PEN string​(10) string​(10) -

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.12 TR-181i2a12
FriendlyName string​(32) 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.12 TR-181i2a12
ModelName string​(64) string​(64) - Model name of the CPE (human readable string). - 2.12 TR-181i2a12
ModelNumber string​(64) string​(64) -

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

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

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

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

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

- 2.12 TR-181i2a12
SerialNumber string​(64) string​(64) -

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

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

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

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

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

For CPEs that support multiple firmware images, the value for this parameter MUST be the software version of the active firmware image.

- 2.12 TR-181i2a12
ActiveFirmwareImage string string - A full path reference to the row in the FirmwareImage table representing the currently running firmware image. - 2.12 TR-181i2a12
BootFirmwareImage string string W

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

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

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

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

- 2.12 TR-181i2a12
AdditionalHardwareVersion string​(64)​[] list​(64) of string - Comma-separated list (maximum number of characters 64) of strings. Each entry is an additional version. Represents any additional hardware version information the vendor might wish to supply. - 2.12 TR-181i2a12
AdditionalSoftwareVersion string​(64)​[] list​(64) of string - Comma-separated list (maximum number of characters 64) of strings. Each entry is an additional version. Represents any additional software version information the vendor might wish to supply. - 2.12 TR-181i2a12
ProvisioningCode string​(64) string​(64) W Identifier of the primary service provider and other provisioning information, which MAY be used by the ACS to determine service provider-specific customization and provisioning parameters. - 2.12 TR-181i2a12
UpTime unsignedInt unsignedInt - Time in seconds since the CPE was last restarted. - 2.12 TR-181i2a12
FirstUseDate dateTime dateTime -

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

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

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

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

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

Whenever the CPE successfully downloads a configuration file as a result of the Download RPC with the FileType argument of 3 Vendor Configuration File, the CPE MUST update this table.

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

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Name string​(64) string​(64) -

Name of the vendor configuration file.

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

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

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

- 2.12 TR-181i2a12
Version string​(16) string​(16) -

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

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

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

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

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

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

- 2.12 TR-181i2a12
Backup​() command object -

[ASYNC] This command is issued to upload the configuration file specified by this VendorConfigFile instance.

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

- 2.12 TR-181i2a12
⇒ Input. arguments object - Input arguments. -
⇒ URL string​(256) string​(256) W

[MANDATORY] URL, as defined in [RFC3986], specifying the destination file location. HTTP and HTTPS transports MUST 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 TR-181i2a12
⇒ Username string​(256) string​(256) W [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 TR-181i2a12
⇒ Password string​(256) string​(256) W [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 TR-181i2a12
Restore​() command object -

[ASYNC] This command is issued to download a configuration file into this VendorConfigFile instance.

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

- 2.12 TR-181i2a12
⇒ Input. arguments object - Input arguments. -
⇒ URL string​(256) string​(256) W

[MANDATORY] URL, as defined in [RFC3986], specifying the source file location. HTTP and HTTPS transports MUST 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 TR-181i2a12
⇒ Username string​(256) string​(256) W [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 TR-181i2a12
⇒ Password string​(256) string​(256) W [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 TR-181i2a12
⇒ FileSize unsignedInt unsignedInt W

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 TR-181i2a12
⇒ TargetFileName string​(256) string​(256) W

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 TR-181i2a12
⇒ CheckSumAlgorithm string string W

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:

- 2.12 TR-181i2a12
⇒ CheckSum hexBinary hexBinary W

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 TR-181i2a12
Device.​DeviceInfo.​MemoryStatus. object object​[1:1] - Status of the device's volatile physical memory. - 2.12 TR-181i2a12
Total unsignedInt unsignedInt - The total physical RAM, in kilobytes, installed on the device. - 2.12 TR-181i2a12
Free unsignedInt unsignedInt - The free physical RAM, in kilobytes, currently available on the device. - 2.12 TR-181i2a12
Device.​DeviceInfo.​ProcessStatus. object object​[1:1] - Status of the processes on the device. - 2.12 TR-181i2a12
CPUUsage unsignedInt​(:100) unsignedInt​(:100) - The total amount of the CPU, in percent, rounded up to the nearest whole percent. In the case that multiple CPU are present, this value represents the average of all CPU. - 2.12 TR-181i2a12
ProcessNumberOfEntries unsignedInt unsignedInt -

The number of entries in the Process table.

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

- 2.12 TR-181i2a12
Device.​DeviceInfo.​ProcessStatus.​Process.​{i}. object​[0:] object​[0:∞] -

List of all processes running on the device.

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

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

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

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

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

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

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Enable boolean boolean W Indicates whether or not the temperature sensor is enabled. - 2.12 TR-181i2a12
Status string string -

The status of this temperature sensor. Enumeration of:

  • Disabled (The sensor is not currently sampling the temperature)
  • Enabled (The sensor is currently sampling the temperature)
  • Error (The sensor error currently prevents sampling the temperature)
- 2.12 TR-181i2a12
Reset​() command object - Resets the temperature sensor. - 2.12 TR-181i2a12
ResetTime dateTime dateTime -

The time at which this temperature sensor was reset.

Reset can be caused by:

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

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

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

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

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

- 2.12 TR-181i2a12
LastUpdate dateTime dateTime -

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

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

- 2.12 TR-181i2a12
MinValue int​(-274:) int​(-274:) -

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

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

- 2.12 TR-181i2a12
MinTime dateTime dateTime -

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

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

- 2.12 TR-181i2a12
MaxValue int​(-274:) int​(-274:) -

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

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

- 2.12 TR-181i2a12
MaxTime dateTime dateTime -

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

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

- 2.12 TR-181i2a12
LowAlarmValue int​(-274:) int​(-274:) W

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

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

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

- 2.12 TR-181i2a12
LowAlarmTime dateTime dateTime -

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

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

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

- 2.12 TR-181i2a12
HighAlarmValue int​(-274:) int​(-274:) W

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

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

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

- 2.12 TR-181i2a12
PollingInterval unsignedInt unsignedInt W

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

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

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

- 2.12 TR-181i2a12
HighAlarmTime dateTime dateTime -

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

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

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

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

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

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

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

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

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

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

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Architecture string string -

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

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

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

Each table entry represents a Vendor Log File.

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

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

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Name string​(64) string​(64) -

Name of the log file.

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

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 TR-181i2a12
MaximumSize unsignedInt unsignedInt - The maximum size of the log file in bytes. If the device doesn't know the maximum file size then MaximumSize will be 0. - 2.12 TR-181i2a12
Persistent boolean boolean -

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

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

- 2.12 TR-181i2a12
Upload​() command object -

[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 Device.LocalAgent.TransferComplete! event.

- 2.12 TR-181i2a12
⇒ Input. arguments object - Input arguments. -
⇒ URL string​(256) string​(256) W

[MANDATORY] URL, as defined in [RFC3986], specifying the destination file location. HTTP and HTTPS transports MUST 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 TR-181i2a12
⇒ Username string​(256) string​(256) W [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 TR-181i2a12
⇒ Password string​(256) string​(256) W [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 TR-181i2a12
Device.​DeviceInfo.​Location.​{i}. object​[0:] object​[0:∞] W

This object contains Location information.

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

- 2.12 TR-181i2a12
Source string string -

Identifies the source of the location data. Enumeration of:

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

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

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

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

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 TR-181i2a12
ExternalProtocol string string -

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

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

"CWMP" 2.12 TR-181i2a12
DataObject string​(1200) string​(1200) W

The currently valid location information.

Writable only when ExternalProtocol has a value of CWMP.

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

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

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

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

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

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

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

This object describes an image of the device.

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

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Location string string -

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

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

Top-level object for mapping firmware images.

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

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

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Name string​(64) string​(64) -

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

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

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

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

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

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

- 2.12 TR-181i2a12
Available boolean boolean W

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

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

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

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

- 2.12 TR-181i2a12
Status string string -

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

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

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

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

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

- 2.12 TR-181i2a12
Download​() command object -

[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 Device.LocalAgent.TransferComplete! event.

- 2.12 TR-181i2a12
⇒ Input. arguments object - Input arguments. -
⇒ URL string​(256) string​(256) W

[MANDATORY] URL, as defined in [RFC3986], specifying the source file location. HTTP and HTTPS transports MUST 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 TR-181i2a12
⇒ AutoActivate boolean boolean W

[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 TR-181i2a12
⇒ Username string​(256) string​(256) W Username to be used by the Agent to authenticate with the file server. This argument is omitted if no authentication is required. - 2.12 TR-181i2a12
⇒ Password string​(256) string​(256) W Password to be used by the Agent to authenticate with the file server. This argument is omitted if no authentication is required. - 2.12 TR-181i2a12
⇒ FileSize unsignedInt unsignedInt W

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 TR-181i2a12
⇒ CheckSumAlgorithm string string W

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:

- 2.12 TR-181i2a12
⇒ CheckSum hexBinary hexBinary W

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 TR-181i2a12
Activate​() command object -

[ASYNC] This command is issued to activate this FirmwareImage instance.

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

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

A failed activation will result in this FirmwareImage instance's BootFailureLog being updated.

- 2.12 TR-181i2a12
⇒ Input. arguments object - Input arguments. -
⇒ TimeWindow.​{i}. object​[1:5] object​[1:5] W

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 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 TR-181i2a12
⇒ Start unsignedInt unsignedInt W [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 TR-181i2a12
⇒ End unsignedInt unsignedInt W [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 TR-181i2a12
⇒ Mode string string W

[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 TR-181i2a12
⇒ UserMessage string string W

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 TR-181i2a12
⇒ MaxRetries int​(-1:10) int​(-1:10) W

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 TR-181i2a12
Device.​LocalAgent. object object​[1:1] -

This object contains general information about the USP Agent itself. For information related to the Device that hosts the Agent, please reference the DeviceInfo object.

NOTE: The Vendor Log File table (DeviceInfo.VendorLogFile) details are located on the DeviceInfo object.

- 2.12 TR-181i2a12
EndpointID string string - The unique USP identifier for this USP Agent. - 2.12 TR-181i2a12
SoftwareVersion string​(64) string​(64) -

The current USP Agent software version; not the version of the overall device firmware, which is located in DeviceInfo.SoftwareVersion.

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.12 TR-181i2a12
UpTime unsignedInt unsignedInt - Time in seconds since the USP Agent was last restarted (either via a reset of the software or reboot of the underlying device). - 2.12 TR-181i2a12
Periodic! event object - Periodic event configured via the recipient Controller's Controller.{i}.PeriodicNotifInterval and Controller.{i}.PeriodicNotifTime parameters. - 2.12 TR-181i2a12
WakeUp! event object - Wake-up event. - 2.12 TR-181i2a12
TransferComplete! event object -

Indicates that a file has been transferred to or from the Device. The event is sent when the transfer has either completed successfully (in which case FaultCode will be zero), or else has failed (in which case FaultCode will be non-zero and FaultString will give further details).

The file transfer can be requested via a USP operation or via some other mechanism. If it's requested via a USP operation Command, CommandKey and Requestor give further details.

- 2.12 TR-181i2a12
⇒ Command string string - The Path Name of the command that requested the transfer, or an empty string if the transfer was not requested via a USP operation. - 2.12 TR-181i2a12
⇒ CommandKey string string - The command_key supplied when requesting the transfer, or an empty string if the transfer was not requested via a USP operation. <Empty> 2.12 TR-181i2a12
⇒ Requestor string string - The Endpoint ID of the Controller that requested the transfer, or an empty string if no Controller requested it. <Empty> 2.12 TR-181i2a12
⇒ TransferType string string -

The type (direction) of the transfer. Enumeration of:

  • Download (Downstream transfer; to the Agent)
  • Upload (Upstream transfer; from the Agent)
"Download" 2.12 TR-181i2a12
⇒ Affected string string - The Path Name of the Object or Object Instance that was affected by the transfer, or an empty string if no data model object was affected by the transfer. <Empty> 2.12 TR-181i2a12
⇒ TransferURL string​(1024) string​(1024) - The URL from or to which this transfer was performed, or an empty string if no such URL is available. <Empty> 2.12 TR-181i2a12
⇒ StartTime dateTime dateTime - The date and time in UTC at which the transfer was started. The Device SHOULD record this information and report it in this argument, but if this information is not available, the value of this argument MUST be set to the Unknown Time value. 0001-01-01T00:00:00Z 2.12 TR-181i2a12
⇒ CompleteTime dateTime dateTime - The date and time in UTC at which the transfer was fully completed. This need only be filled in if the transfer has been fully completed. The Device SHOULD record this information and report it in this argument, but if this information is not available or the transfer has not completed, the value of this argument MUST be set to the Unknown Time value. 0001-01-01T00:00:00Z 2.12 TR-181i2a12
⇒ FaultCode unsignedInt unsignedInt - The numerical fault code as defined in [TR-369]. A value of 0 (zero) indicates no fault. 0 2.12 TR-181i2a12
⇒ FaultString string​(256) string​(256) - A human-readable text description of the fault. This field SHOULD be an empty string if the FaultCode equals 0 (zero). <Empty> 2.12 TR-181i2a12
AddCertificate​() command object - This command is issued to allow a Controller (with the proper permissions) to add a new certificate to Certificate.{i}. This does not automatically produce a trust relationship with the host identified by the Certificate. To produce a trust relationship, an entry is required to exist in Controller.{i}.Credential or ControllerTrust.Credential.{i}.Credential that references the new Certificate.{i} entry. The Agent will use the Serial Number and Issuer fields from the input Certificate to populate the Certificate.{i}.SerialNumber and Certificate.{i}.Issuer parameters. If Certificate already has an instance with the same Certificate.{i}.SerialNumber and Certificate.{i}.Issuer parameters, this command will fail. To replace an instance with the same Certificate.{i}.SerialNumber and Certificate.{i}.Issuer, the existing instance must first be deleted. - 2.12 TR-181i2a12
⇒ Input. arguments object - Input arguments. -
⇒ Alias string​(64) Alias W [Alias] An optional input the Controller can use to specify the Certificate.{i}.Alias value for the added entry. If provided as an input and the value already exists in Certificate.{i}, this commmand will fail. - 2.12 TR-181i2a12
⇒ Certificate string​(65535) string​(65535) W [MANDATORY] The X.509 certificate in Privacy-enhanced Electronic Mail (PEM) format. - 2.12 TR-181i2a12
SupportedProtocols string​[1:] list​[1:] of string -

Comma-separated list (at least 1 items) of strings. USP Message Transfer Protocols supported by this USP Agent. The USP Agent MUST support at least one Protocol. Each list item is an enumeration of:

- 2.12 TR-181i2a12
SupportedFingerprintAlgorithms string​[] list of string -

Comma-separated list of strings, each entry is an algorithm for calculating firgerprints that is supported by the Agent.

Each list item is an enumeration of:

- 2.12 TR-181i2a12
AdvertisedDeviceSubtypes string​[] list of string W Comma-separated list of strings, each entry is a subtype component of the service type that is advertised for the device using mDNS as defined in [RFC6762]. - 2.12 TR-181i2a12
MaxSubscriptionChangeAdoptionTime unsignedInt​(5:) unsignedInt​(5:) W

The acceptable amount of time in seconds between the alteration of the Agent's Subscriptions (e.g. updated subscription, new subscription, removed subscription, etc.) and the notifications related to those subscriptions being delivered.

For example, if this parameter is set to 30 seconds, then once a Subscription has been updated, the Agent has 30 seconds before it needs to start delivering notifications based on the updated version of the Subscription (instead of the old version of the Subscription).

- 2.12 TR-181i2a12
MTPNumberOfEntries unsignedInt unsignedInt - The number of entries in the MTP table. - 2.12 TR-181i2a12
ControllerNumberOfEntries unsignedInt unsignedInt - The number of entries in the Controller table. - 2.12 TR-181i2a12
SubscriptionNumberOfEntries unsignedInt unsignedInt - The number of entries in the Subscription table. - 2.12 TR-181i2a12
RequestNumberOfEntries unsignedInt unsignedInt - The number of entries in the Request table. - 2.12 TR-181i2a12
CertificateNumberOfEntries unsignedInt unsignedInt - The number of entries in the Certificate table. - 2.12 TR-181i2a12
Device.​LocalAgent.​MTP.​{i}. object​[0:] object​[0:∞] W

Each instance of this table represents a MTP used by the local Agent.

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

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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

Enable/Disable this MTP instance.

If this MTP instance is to be disabled and currently used for communication with the requesting controller, the agent has to send the request response first, before disabling it.

false 2.12 TR-181i2a12
Status string string -

The current operational state of the MTP instance. Enumeration of:

  • Up
  • Down (Value when this MTP instance cannot establish communication)
  • Error (Value when this MTP instance is misconfigured, OPTIONAL)
- 2.12 TR-181i2a12
Protocol string string W The value MUST be a member of the list reported by the Device.LocalAgent.SupportedProtocols parameter. The Message Transport Protocol (MTP) to be used for communications by a USP Endpoint. "Co­AP" 2.12 TR-181i2a12
EnableMDNS boolean boolean W

This parameter, when true, enables the advertisement of DNS-SD services defined for this MTP instance using mDNS as defined in [RFC6762].

This parameter cannot be set to true if there are multiple MTP instances with the same value of the Protocol parameter.

When true, the hostname advertised in the SRV record MUST be a Fully Qualified Domain Name (FQDN).

The interfaces that advertise these DNS-SD services are restriced to the set of interfaces associated with this MTP instance and the interfaces defined by the DNS.SD.AdvertisedInterfaces parameter.

true 2.12 TR-181i2a12
Device.​LocalAgent.​MTP.​{i}.​CoAP. object object​[1:1] - If the USP Endpoint uses the CoAP Message Transport Protocol (MTP), then this object contains CoAP specific configuration parameters. - 2.12 TR-181i2a12
Interfaces string​[] list of string W

Comma-separated list of strings. Each list item MUST be the Path Name of the IP.Interface object instance that this server will use as its host address to receive USP messages. If the referenced object is deleted, the corresponding item MUST be removed from the list.

An empty string will bind this server to all interfaces for this device.

- 2.12 TR-181i2a12
Port unsignedInt​(1:65535) unsignedInt​(1:65535) W The port number used by the CoAP Server to receive USP messages. 5683 2.12 TR-181i2a12
Path string string W The path that is used by the CoAP Server in order to receive USP messages. - 2.12 TR-181i2a12
IsEncrypted boolean boolean - This parameter represents whether or not communications that utilize this CoAP object instance are encrypted. - 2.12 TR-181i2a12
EnableEncryption boolean boolean W When true, encryption is used for this MTP instance. true 2.12 TR-181i2a12
Device.​LocalAgent.​MTP.​{i}.​STOMP. object object​[1:1] - If the USP Endpoint uses the STOMP Message Transport Protocol (MTP), then this object contains STOMP Client specific configuration parameters related to how the Agent communicates with the STOMP Server. - 2.12 TR-181i2a12
Reference string string W The value MUST be the Path Name of a row in the STOMP.Connection table. If the referenced object is deleted, the parameter value MUST be set to an empty string. A reference to the STOMP Connection used by this Agent when communicating via the STOMP MTP. <Empty> 2.12 TR-181i2a12
Destination string string W The STOMP destination where the Agent will be listening to incoming USP messages. <Empty> 2.12 TR-181i2a12
DestinationFromServer string string -

The STOMP destination contained in the subscribe-dest header of the CONNECTED STOMP Frame.

If the Agent doesn't receive a subscribe-dest header in the CONNECTED STOMP Frame, then the value of this Parameter is an empty string.

If this parameter's value is not empty then this is the STOMP destination address for this Agent, but if the value is empty the Destination Parameter contains the STOMP destination address for this Agent.

<Empty> 2.12 TR-181i2a12
Device.​LocalAgent.​MTP.​{i}.​WebSocket. object object​[1:1] - If the USP Endpoint uses the WebSocket Message Transport Protocol (MTP) as a WebSocket server, then this object contains WebSocket specific configuration parameters. - 2.12 TR-181i2a12
Interfaces string​[] list of string W

Comma-separated list of strings. Each list item MUST be the Path Name of the IP.Interface object instance that this server will use as its host address to receive USP messages. If the referenced object is deleted, the corresponding item MUST be removed from the list.

An empty string will bind this server to all interfaces for this device.

- 2.12 TR-181i2a12
Port unsignedInt​(1:65535) unsignedInt​(1:65535) W The port number used by the WebSocket Server to receive USP messages. 5683 2.12 TR-181i2a12
Path string string W The path that is used by the WebSocket Server in order to receive USP messages. - 2.12 TR-181i2a12
Device.​LocalAgent.​Controller.​{i}. object​[0:] object​[0:∞] W

Each instance of this table represents a USP Controller that has access to this USP Agent.

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

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
EndpointID string string W The unique USP identifier for this USP Controller. <Empty> 2.12 TR-181i2a12
ControllerCode string​(128) string​(128) W

Information about the configuration state of an Agent as it pertains to the Controller instance. This is not information related to an operator's installation or usage of the protocol, that information is maintained in ProvisioningCode.

This parameter could be used in scenarios where the Controller needs to perform some kind of initialization or periodic configuration monitoring. For example, a Controller might perform some initial configuration of an Agent on first contact (perhaps to configure the Subscriptions). The Controller could inspect this parameter to determine the current state of the Agent's configuration, allowing the Controller to streamline the configuration process.

<Empty> 2.12 TR-181i2a12
ProvisioningCode string​(64) string​(64) W Identifying information which MAY be used by the Controller instance to determine Controller instance specific customization and provisioning parameters. <Empty> 2.12 TR-181i2a12
Enable boolean boolean W

Enable/Disable this Controller instance.

When false, messages (notifications) are not sent to the remote endpoint represented by this Controller instance.

false 2.12 TR-181i2a12
AssignedRole string​[] list of string W Each list item MUST be the Path Name of a row in the Device.LocalAgent.ControllerTrust.Role table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Comma-separated list of strings, each entry is a Role that has been assigned to this Controller instance by means other than the LocalAgent.ControllerTrust.Credential.{i}.Role parameter. - 2.12 TR-181i2a12
InheritedRole string​[] list of string - Each list item MUST be the Path Name of a row in the Device.LocalAgent.ControllerTrust.Role table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Comma-separated list of strings, each entry is a Role that has been assigned to this Controller instance from the LocalAgent.ControllerTrust.Credential.{i}.Role parameter associated with the CA credential (LocalAgent.ControllerTrust.Credential.{i}.Credential) used to validate the Controller certificate. - 2.12 TR-181i2a12
Credential string string W

The value MUST be the Path Name of a row in the Certificate table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

Comma-separated list of strings, the set of certificates from Certificate.{i} that a Controller can present for use in authenticating the identity of this Controller instance.

- 2.12 TR-181i2a12
PeriodicNotifInterval unsignedInt​(1:) unsignedInt​(1:) W If a Periodic Event Notification Subscription instance is associated with this USP Controller, then this is the duration in seconds of the interval for which the USP Agent MUST attempt to issue a Periodic Notification to the USP Controller. - 2.12 TR-181i2a12
PeriodicNotifTime dateTime dateTime W

If a Periodic Event Notification Subscription instance is associated with this USP Controller, then this is an absolute time reference in UTC to determine when the USP Agent will issue a Periodic Notification. Each Periodic Notification MUST occur at this reference time plus or minus an integer multiple of the PeriodicNotifInterval.

PeriodicNotifTime is used only to set the phase of the Periodic Event Notifications. The actual value of PeriodicNotifTime can be arbitrarily far into the past or future.

For example, if PeriodicNotifInterval is 86400 (a day) and if PeriodicNotifTime is set to UTC midnight on some day (in the past, present, or future) then Periodic Notifications will be sent every day at UTC midnight. These MUST begin on the very next midnight, even if PeriodicNotifTime refers to a day in the future.

The Unknown Time value defined in [Section 3.2/TR-106a2] indicates that no particular time reference is specified. That is, the USP Agent MAY locally choose the time reference, and needs only to adhere to the specified PeriodicNotifInterval.

If absolute time is not available to the USP Agent, its Periodic Notification behavior MUST be the same as if the PeriodicNotifTime parameter was set to the Unknown Time value.

- 2.12 TR-181i2a12
USPNotifRetryMinimumWaitInterval unsignedInt​(1:65535) unsignedInt​(1:65535) W

This parameter is related to the retry mechanism for Notifications.

Configures the first retry wait interval, in seconds, as specified in [Section "Responses to Notifications and Notification Retry"/TR-369].

A value of 5 corresponds to the default behavior.

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

5 2.12 TR-181i2a12
USPNotifRetryIntervalMultiplier unsignedInt​(1000:65535) unsignedInt​(1000:65535) W

This parameter is related to the retry mechanism for Notifications.

Configures the retry interval multiplier as specified in [Section "Responses to Notifications and Notification Retry"/TR-369].

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

A value of 2000 corresponds to the default behavior.

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

2000 2.12 TR-181i2a12
ScheduleTimer​() command object - Schedule a Timer! event on the associated Controller. - 2.12 TR-181i2a12
⇒ Input. arguments object - Input arguments. -
⇒ DelaySeconds unsignedInt​(1:) unsignedInt​(1:) W [MANDATORY] The number of seconds from the time this command is invoked until the Agent initiates a Timer! Event notification (based on the associated subscriptions). 0 2.12 TR-181i2a12
Timer! event object - Timer event requested via a ScheduleTimer() command invoked on the same Controller instance via an Operate USP message. - 2.12 TR-181i2a12
⇒ CommandKey string string - The command_key supplied when requesting the timer event. - 2.12 TR-181i2a12
AddMyCertificate​() command object - This command is issued to allow a Controller to add a new certificate for itself. This can be useful when the current certificate is expiring or has become compromised. This command creates a new entry in Certificate and adds a reference to the new entry to the Controller's Controller.{i}.Credential. The Agent will use the Serial Number and Issuer fields from the input Certificate to populate the Certificate.{i}.SerialNumber and Certificate.{i}.Issuer parameters. If Certificate already has an instance with the same Certificate.{i}.SerialNumber and Certificate.{i}.Issuer parameters, this command will fail. To replace an instance with the same Certificate.{i}.SerialNumber and Certificate.{i}.Issuer, the existing instance must first be deleted. - 2.12 TR-181i2a12
⇒ Input. arguments object - Input arguments. -
⇒ Alias string​(64) Alias W [Alias] An optional input the Controller can use to specify the Certificate.{i}.Alias value for the added entry. If provided as an input and the value already exists in Certificate.{i}, this commmand will fail. - 2.12 TR-181i2a12
⇒ Certificate string​(65535) string​(65535) W [MANDATORY] The X.509 certificate in Privacy-enhanced Electronic Mail (PEM) format. - 2.12 TR-181i2a12
SendOnBoardRequest​() command object - Requests the Agent to send an OnBoardRequest notification to this Controller. - 2.12 TR-181i2a12
BootParameterNumberOfEntries unsignedInt unsignedInt - The number of entries in the BootParameter table. - 2.12 TR-181i2a12
MTPNumberOfEntries unsignedInt unsignedInt - The number of entries in the MTP table. - 2.12 TR-181i2a12
Device.​LocalAgent.​Controller.​{i}.​MTP.​{i}. object​[0:] object​[0:∞] W

Each instance of this table represents a MTP used by this Controller.

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

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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

Enable/Disable this MTP instance.

If this MTP instance is to be disabled and currently used for communication with the requesting controller, the agent has to send the request response first, before disabling it.

false 2.12 TR-181i2a12
Protocol string string W The value MUST be a member of the list reported by the Device.LocalAgent.SupportedProtocols parameter. The Message Transport Protocol (MTP) to be used for communications by a USP Endpoint. "Co­AP" 2.12 TR-181i2a12
Device.​LocalAgent.​Controller.​{i}.​MTP.​{i}.​CoAP. object object​[1:1] - If the USP Endpoint uses the CoAP Message Transport Protocol (MTP), then this object contains CoAP specific configuration parameters. - 2.12 TR-181i2a12
Host string​(256) string​(256) W The hostname or IP Address of the Controller's CoAP server. - 2.12 TR-181i2a12
Port unsignedInt​(1:65535) unsignedInt​(1:65535) W The port number used by the Controller's CoAP Server to receive USP messages. - 2.12 TR-181i2a12
Path string string W The path that is used by the Controller's CoAP Server in order to receive USP messages. - 2.12 TR-181i2a12
EnableEncryption boolean boolean W When true, encryption is used as specified in [Section "MTP Message Encryption"/TR-369]. true 2.12 TR-181i2a12
Device.​LocalAgent.​Controller.​{i}.​MTP.​{i}.​STOMP. object object​[1:1] - If the USP Endpoint uses the STOMP Message Transport Protocol (MTP), then this object contains STOMP Client specific configuration parameters related to how this Controller communicates with the STOMP Server. - 2.12 TR-181i2a12
Reference string string W The value MUST be the Path Name of a row in the STOMP.Connection table. If the referenced object is deleted, the parameter value MUST be set to an empty string. A reference to the STOMP Connection used by this Controller when communicating via the STOMP MTP. <Empty> 2.12 TR-181i2a12
Destination string string W The STOMP destination where the Controller will be listening to incoming USP messages. <Empty> 2.12 TR-181i2a12
Device.​LocalAgent.​Controller.​{i}.​MTP.​{i}.​WebSocket. object object​[1:1] - If the USP Endpoint uses the WebSocket Message Transport Protocol (MTP) as a WebSocket client, then this object contains WebSocket specific configuration parameters. - 2.12 TR-181i2a12
Host string​(256) string​(256) W The hostname or IP Address of the Controller's WebSocket server. - 2.12 TR-181i2a12
Port unsignedInt​(1:65535) unsignedInt​(1:65535) W The port number used by the Controller's WebSocket server to receive USP messages. - 2.12 TR-181i2a12
Path string string W The path that is used by the Controller's WebSocket server in order to receive USP messages. - 2.12 TR-181i2a12
IsEncrypted boolean boolean - This parameter represents whether or not communications that utilize this WebSocket object instance are encrypted. - 2.12 TR-181i2a12
KeepAliveInterval unsignedInt​(1:) unsignedInt​(1:) W The the duration in seconds between when WebSocket ping control frames are transmitted by the Agent to the WebSocket server for the USP Controller. - 2.12 TR-181i2a12
CurrentRetryCount unsignedInt unsignedInt - The current retry count of the session. When zero (0), the session is not in a retry state. - 2.12 TR-181i2a12
SessionRetryMinimumWaitInterval unsignedInt​(1:65535) unsignedInt​(1:65535) W

Configures the first retry wait interval, in seconds, as specified in [Section "WebSocket Session Retry"/TR-369].

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

5 2.12 TR-181i2a12
SessionRetryIntervalMultiplier unsignedInt​(1000:65535) unsignedInt​(1000:65535) W

Configures the retry interval multiplier as specified in [Section "WebSocket Session Retry"/TR-369].

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

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

2000 2.12 TR-181i2a12
Reset​() command object - [ASYNC] If enabled, this command will either request to start or restart an WebSocket session with the Controller. - 2.12 TR-181i2a12
Device.​LocalAgent.​Controller.​{i}.​TransferCompletePolicy. object object​[1:1] - The policy defined in this object determines the conditions under which the USP Agent notifies a USP Controller, that has an appropriate Subscription, of the completion of file transfers. - 2.12 TR-181i2a12
ResultTypeFilter string string W

Indicates the transfer results that MUST be included when the USP Agent notifies a USP Controller of file transfers. Transfer results omitted from this list MUST NOT be included when the USP Agent notifies a USP Controller. Enumeration of:

- 2.12 TR-181i2a12
Device.​LocalAgent.​Controller.​{i}.​BootParameter.​{i}. object​[0:] object​[0:∞] W

This table provides the Controller with the ability to dictate the Parameters that are delivered via Boot! events.

Any Parameter (identified by ParameterName) contained in this table MUST be included within the param_map element of the Boot! event.

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

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Enable boolean boolean W Enables or disables this BootParameter. false 2.12 TR-181i2a12
ParameterName string​(256) string​(256) W

A pattern that describes the Parameter(s) to be included in the param_map element of a Boot! event. Specifically, patterns with wildcards (an "*" character) in place of Instance Identifiers are allowed.

If the pattern does not match any existing Parameters at the time that the Agent is creating the Boot! event, then this BootParameter instance is not included in the param_map of the Boot! event.

<Empty> 2.12 TR-181i2a12
Device.​LocalAgent.​Controller.​{i}.​E2ESession. object object​[1:1] - The E2ESession object represents the End to End (E2E) Session Context functionality for this Controller.{i} object instance. - 2.12 TR-181i2a12
Enable boolean boolean W

Enable/Disable this E2ESession instance.

When true, Session Context is used when exchanging USP Records with the remote endpoint represented by this Controller.{i} object instance.

When false, Session Context is not used when exchanging USP Records with the remote endpoint represented by this Controller.{i} object instance.

false 2.12 TR-181i2a12
Status string string -

The current status of the Session Context. Enumeration of:

  • Up
  • Negotiating (A new Session Context is being negotiated (i.e., a USP Record with sequence_id of 0 and session_id not previously used with this remote endpoint was sent and response has not yet been received), OPTIONAL)
  • Down
- 2.12 TR-181i2a12
SessionExpiration unsignedInt​(0:) unsignedInt​(0:) W

The duration in seconds in which the current Session Context will expire since the last session-related activity (e.g., Message sent or received, Session Context start or restart).

A value of 0 means session expiration is disabled.

0 2.12 TR-181i2a12
SessionRetryMinimumWaitInterval unsignedInt​(1:65535) unsignedInt​(1:65535) W

Configures the first retry wait interval, in seconds, as specified in [Section "Failure Handling in the Session Context"/TR-369].

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

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

5 2.12 TR-181i2a12
SessionRetryIntervalMultiplier unsignedInt​(1000:65535) unsignedInt​(1000:65535) W

Configures the retry interval multiplier as specified in [Section "Failure Handling in the Session Context"/TR-369].

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

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

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

2000 2.12 TR-181i2a12
CurrentRetryCount unsignedInt unsignedInt - The current retry count of the Session Context. When zero (0), the Session Context is not in a retry state. - 2.12 TR-181i2a12
SegmentedPayloadChunkSize unsignedInt​(0,512:) unsignedInt​(0,512:) W

The maximum size, in bytes, of the Record (payload(s) and headers) that can be transmitted to the remote endpoint. The smallest size, which can be configured is 512 bytes.

A value of 0 means that the segmentation function is effectively disabled.

0 2.12 TR-181i2a12
MaxRetransmitTries int​(-1:10) int​(-1:10) W

The maximum times that a USP Endpoint attempts to retransmit the requested USP Record to the remote endpoint.

If the maximum tries is met for any requested USP Record, the USP Endpoint will restart the E2E Session.

A value of -1 means that the USP Endpoint will always attempt to retransmit the requested USP Record.

A value of 0 means that the USP Endpoint will not attempt to retransmit the requested USP Record and will restart the E2E Session.

0 2.12 TR-181i2a12
PayloadSecurity string string W

The security mechanism to use when exchanging the payload of the Record with the remote endpoint. Enumeration of:

  • Plaintext
  • TLS (The payload is encrypted at the originating endpoint and decrypted at the receiving endpoint using TLS. The procedures for using TLS in a Session Context is defined in [TR-369])
"TLS" 2.12 TR-181i2a12
Reset​() command object -

[ASYNC] If the E2ESession is enabled then this command will either request to start or restart a Session Context with the remote endpoint.

If the E2ESession is not enabled and there is an active Session Context then this command will terminate that Session Context with the remote endpoint.

If the E2ESession is not enabled and there is no active Session Context then this command does nothing.

- 2.12 TR-181i2a12
Device.​LocalAgent.​Subscription.​{i}. object​[0:] object​[0:∞] W

A Subscription dictates how a USP Agent issues USP Notification Messages to a USP Controller.

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

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Enable boolean boolean W Enables/disables this Subscription. A disabled entry MUST NOT be processed by the USP Agent. false 2.12 TR-181i2a12
Recipient string string -

The value MUST be the Path Name of the Controller instance that will receive the Notification associated with this Subscription. If the referenced object is deleted, this instance MUST also be deleted (so the parameter value will never be an empty string).

The value of this parameter is automatically populated by the USP Agent upon Subscription creation using the reference to the USP Controller that created the instance.

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

Unique identifier of the Subscription itself, which is specific to the USP Controller that creates the instance of the Subscription.

This value is also populated in the subscription_id element of every Notification message sent from a USP Agent to a USP Controller.

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.

<Empty> 2.12 TR-181i2a12
CreationDate dateTime dateTime -

The date and time when this instance of Subscription was created. This is internally used by the TimeToLive parameter to determine the expiration of this Subscription instance.

The value of this parameter is automatically populated by the USP Agent upon Subscription creation.

- 2.12 TR-181i2a12
NotifType string string W

Type of Notification message that will be sent to the USP Controller specified by Recipient when this Subscription is triggered. Enumeration of:

- 2.12 TR-181i2a12
ReferenceList string​[]​(256) list of string​(256) W

Comma-separated list of strings (maximum number of characters 256). Each entry in the list is a parameter path that determines the element of the data model that the Subscription is applicable to.

Different values of the NotifType parameter will cause the Subscription to interact with ReferenceList differently. For example, an instance of Subscription with ValueChange will utilize the value of this parameter differently than an instance with Event.

Expressions are allowed in the list items, but in some cases could cause a dynamic set of instances to be monitored in order to fulfill the Subscription's requirements.

Once the value of the ReferenceList is written, the value cannot be changed as the Subscription instance is considered to be immutable. If the value of a non-empty ReferenceList parameter needs to change, the Subscription instance MUST be deleted and a new Subscription instance created.

- 2.12 TR-181i2a12
Persistent boolean boolean W

Determines whether or not this Subscription remains after the USP Agent is restarted (either via a reset of the software or reboot of the underlying device).

If true, this Subscription stays in existence until either a Delete message removes it or the TimeToLive parameter expires.

If false, this Subscription is automatically removed by the USP Agent whenever it is restarted.

false 2.12 TR-181i2a12
TimeToLive unsignedInt unsignedInt W

Specifies the duration of time (in seconds) that this Subscription remains in existence. After TimeToLive has expired, this Subscription instance is automatically removed by the USP Agent.

If the value of TimeToLive is 0, then this parameter is ignored and this Subscription stays in existence until either a Delete message removes it or the Persistent parameter determines that it needs to be removed.

If the value of TimeToLive is greater than 0, then this parameter determines the length of time (from Subscription creation) until it will be automatically removed by the USP Agent (unless the Persistent parameter is false and the USP Agent is restarted, in which case it will be removed before the TimeToLive expiration). NOTE: This paramater does not count down as time moves forward; it will always read back with the same value that it was last set to.

If the USP Agent is incapable of maintaining absolute time then TimeToLive will automatically expire if the USP Agent is restarted (either via a reset of the software or reboot of the underlying device) before TimeToLive expiration.

0 2.12 TR-181i2a12
NotifRetry boolean boolean W

Specifies whether or not the USP Agent attempts to re-deliver the Notification in the event that it could not be delivered to the USP Controller.

When NotifRetry is true, the USP Agent MUST retry the delivery of the Notification. This implies that the Notification MUST be generated with the "send_resp" flag set to true such that the USP Agent knows when the Notification has been successfully delivered. The retry attempt(s) are performed using the retry algorithm defined in [Section "Responses to Notifications and Notification Retry"/TR-369].

When NotifRetry is false, the USP Agent MUST NOT retry the delivery of the Notification, and SHOULD generate the notification with "send_resp" flag set to false.

false 2.12 TR-181i2a12
NotifExpiration unsignedInt unsignedInt W

Specifies the duration of time (in seconds) that the Notification associated with this Subscription will continue to be retried. After NotifExpiration has expired, if the Notification has still not been successfully delivered then the USP Agent MUST stop attempting to re-deliver the Notification.

If NotifRetry is set to false then this parameter is ignored.

If NotifRetry is set to true and the value of NotifExpiration is 0, then the USP Agent will attempt to re-deliver the Notification until it has been successfully delivered or until the USP Agent is restarted (either via a reset of the software or reboot of the underlying device).

If NotifRetry is set to true and the value of NotifExpiration is greater than 0, then the USP Agent will attempt to re-deliver the Notification until either it has been successfully delivered, until the length of time (from the time tha the Notification was initially attempted to be delivered) specified in this parameter expires, or until the USP Agent is restarted (either via a reset of the software or reboot of the underlying device).

NOTE: This paramater does not count down as time moves forward; it will always read back with the same value that it was last set to.

0 2.12 TR-181i2a12
Device.​LocalAgent.​Request.​{i}. object​[0:] object​[0:∞] -

Request instances are created using USP Operate messages. Only Operate messages with async=true will create a Request instance in the data model.

When the command of the Operate completes, then this Request instance is removed from this table.

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

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Originator string string - The USP Endpoint Identifier that originated the command. - 2.12 TR-181i2a12
Command string string -

The command to be executed. This parameter is a Path Name that addresses a Command in an Object or Object Instance.

The command is a result of the evaluation of the command argument of an Operate message.

- 2.12 TR-181i2a12
CommandKey string string - The command_key from the USP Operate message. - 2.12 TR-181i2a12
Status string string -

The operational status of the request to execute the command. Enumeration of:

  • Requested (The command has been requested but is currently not executing)
  • Active (The command is currently executing)
  • Canceling (The command has been requested to be canceled)
  • Canceled (The command has successfully been canceled)
  • Success (The command has successfully been completed its execution)
  • Error (The command has unsuccessfully completed its execution or has unsuccessfully been canceled)
- 2.12 TR-181i2a12
Cancel​() command object -

Request cancelation of this Request's command.

This command completes immediately. If successful, Status will immediately change to Canceling and will change to Canceled when the cancelation is complete.

- 2.12 TR-181i2a12
Device.​LocalAgent.​Certificate.​{i}. object​[0:] object​[0:∞] -

Each instance of this table represents information related to a X.509 certificate (see [RFC5280]) of a Controller or Certificate Authority. Instances are referenced from LocalAgent.Controller.{i}.Credential and LocalAgent.ControllerTrust.Credential.{i}.Credential.

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

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Enable boolean boolean W Enable/Disable this Certificate instance. - 2.12 TR-181i2a12
SerialNumber string​(64) string​(64) - The Serial Number field in an X.509 certificate, see [RFC5280]. - 2.12 TR-181i2a12
Issuer string​(256) string​(256) - The Issuer field in an X.509 certificate, see [RFC5280]; i.e. the Distinguished Name (DN) of the entity who has signed the certificate. - 2.12 TR-181i2a12
Delete​() command object - This command is issued to allow a Controller (with the proper permissions) to delete an entry from the Certificate.{i}. It also removes references to the Certificate in LocalAgent.Controller.{i}.Credential or LocalAgent.ControllerTrust.Credential.{i}.Credential and removes any X.509 certificate data the Agent had stored related to the entry. - 2.12 TR-181i2a12
GetFingerprint​() command object - This command is issued to allow a Controller to request the value of a fingerprint calculated for the specified table entry using the input FingerprintAlgorithm. - 2.12 TR-181i2a12
⇒ Input. arguments object - Input arguments. -
⇒ FingerprintAlgorithm string string W

[MANDATORY] The algorithm to be used to calculate the requested fingerprint. The value MUST be one the Agent supports, as noted in SupportedFingerprintAlgorithms. Enumeration of:

- 2.12 TR-181i2a12
⇐ Output. arguments object - Output arguments. -
⇐ Fingerprint hexBinary​(128) hexBinary​(128) - The value of the fingerprint. - 2.12 TR-181i2a12
Device.​LocalAgent.​ControllerTrust. object object​[1:1] - This object contains information that an Agent applies when establishing a trust relationship with a Controller. - 2.12 TR-181i2a12
UntrustedRole string​[:1] list​[:1] of string W

Each list item MUST be the Path Name of a row in the Role table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Comma-separated list (up to 1 items) of strings, each entry is a Role that is associated with Controllers whose identity cannot be authenticated. The value of the UntrustedRole parameter is appended to the LocalAgent.Controller.{i}.AssignedRole parameter.

In some instances, this policy is set by the Agent and cannot be modified by Controllers. If the Agent does not allow modification of this parameter, the Agent MUST respond with an error to the request to set this parameter.

- 2.12 TR-181i2a12
BannedRole string string W

The value MUST be the Path Name of a row in the Role table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The Role that is associated with Controllers indicate banned access.

When assigned to a Controller or associated with an entry in the Credential table, this MUST be the only value of the BannedRole parameter of the LocalAgent.Controller.{i}.AssignedRole parameter.

The Agent SHOULD refuse to accept USP messages from, or send USP messages to, any Controller that has this Role.

- 2.12 TR-181i2a12
TOFUAllowed boolean boolean W When true, Agent has active policy that allows for self-signed certificates and certificates from unknown Certificate Authorities (CAs) to be trusted on first use (TOFU). - 2.12 TR-181i2a12
TOFUInactivityTimer unsignedInt unsignedInt W

Inactivity timer in seconds.

This timer is started when trust on first use (TOFU) policy is used to accept a Controller certificate. If no USP Message is received before this timer elapses, the Agent MUST tear down the MTP connection and underlying (D)TLS session.

A value of 0 means that the TOFU inactivity timer is effectively disabled.

- 2.12 TR-181i2a12
RequestChallenge​() command object -

This command is issued to retrieve the instruction for the referenced challenge.

There is at most one (1) outstanding RequestChallenge for a requesting Controller.

As such, any new challenges with a different value of the ChallengeRef parameter are denied until a successful response to the outstanding challenge is received by the Agent or the current RequestChallenge expires.

When the value of the ChallengeRef parameter defined in the RequestChallenge does not exist, the Agent returns an "Invalid Value" error.

- 2.12 TR-181i2a12
⇒ Input. arguments object - Input arguments. -
⇒ ChallengeRef string string W [MANDATORY] The value MUST be the Path Name of the Challenge object instance for this request. - 2.12 TR-181i2a12
⇒ RequestExpiration int​(0:) int​(0:) W

The expiration period, in seconds, where the Controller request that this challenge request expire (times-out).

A value of zero indicates that the challenge request will never expire. The default is 900 seconds.

- 2.12 TR-181i2a12
⇐ Output. arguments object - Output arguments. -
⇐ Instruction base64 base64 - The value of the Challenge.{i}.Instruction parameter associated with the requested challenge in the #.Input.ChallengeRef parameter. - 2.12 TR-181i2a12
⇐ InstructionType string string -

The media type with a format as defined by [RFC6838] of the content of the Instruction parameter.

The allowable values of the media type are defined by the Challenge.{i}.InstructionType parameter.

- 2.12 TR-181i2a12
⇐ ValueType string string -

The media type with a format as defined by [RFC6838] of the content of the Challenge.{i}.Value parameter.

The allowable values of the media type are defined by the Challenge.{i}.ValueType parameter.

- 2.12 TR-181i2a12
⇐ ChallengeID string string - The challenge identifier the Controller uses in the ChallengeResponse command to correlate this request with a response. - 2.12 TR-181i2a12
ChallengeResponse​() command object - This command is issued to return the response of challenge. - 2.12 TR-181i2a12
⇒ Input. arguments object - Input arguments. -
⇒ ChallengeID string string W [MANDATORY] The challenge identifier the Controller uses to correlate the challenge request with a response. - 2.12 TR-181i2a12
⇒ Value base64 base64 W [MANDATORY] The value of the challenge that is specific to the type of challenge. The challenge value is provided by the external party to the Controller. - 2.12 TR-181i2a12
RoleNumberOfEntries unsignedInt unsignedInt - The number of entries in the Role table. - 2.12 TR-181i2a12
CredentialNumberOfEntries unsignedInt unsignedInt - The number of entries in the Credential table. - 2.12 TR-181i2a12
ChallengeNumberOfEntries unsignedInt unsignedInt - The number of entries in the Challenge table. - 2.12 TR-181i2a12
Device.​LocalAgent.​ControllerTrust.​Role.​{i}. object​[0:] object​[0:∞] W

Each instance of this table represents a Role that can be assigned to or inherited by a Controller via the Controller Trust mechanism. The Role contains a set of permissions that determine how the Controller can interact with the data model.

If multiple permission entries associated with this table contain a Target that evaluates to the same instantiated Object/Parameter for multiple Roles, then the permissions to be used are a union of the identified permissions.

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

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Enable boolean boolean W Enable/Disable this Role instance. false 2.12 TR-181i2a12
Name string string W

The Role assigned to this Role instance.

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 TR-181i2a12
PermissionNumberOfEntries unsignedInt unsignedInt - The number of entries in the Permission table. - 2.12 TR-181i2a12
Device.​LocalAgent.​ControllerTrust.​Role.​{i}.​Permission.​{i}. object​[0:] object​[0:∞] W

Each instance of this table represents the permissions that are extended to a set of Targets for a specified Role.

If there are multiple entries in this table for a specific Role where the Targets overlap, the permissions for the entry with the highest value takes priority over all others.

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

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Enable boolean boolean W Enable/Disable this Permission instance. false 2.12 TR-181i2a12
Order unsignedInt unsignedInt W

The order (relative priority) to use when determining the permissions for overlapping Targets that are contained within the same Role.

The larger value of this parameter takes priority over a permission with a smaller value (i.e., 0 has the lowest priority).

0 2.12 TR-181i2a12
Targets string​[] list of string W

Comma-separated list of strings, each entry is a target to which the value of the permissions parameters are assigned.

When an entry is a value of a Partial Path, the permissions are associated to that Object and any child Object/Parameter.

When the value of an entry is an Object instance then the permissions are associated to all Parameters of the Object instance.

When an entry is a value of a Search Path as defined in [TR-369] that resolves to zero or more Parameter Paths, then all Parameter Paths that result from the evaluation of the Search Path are subject to the permissions assigned by this Permission instance.

<Empty> 2.12 TR-181i2a12
Param string​(4:4) string​(4:4) W

The permissions of a Role for the specified Targets.

A string of 4 characters where each character represents a permission ("r" for Read, "w" for Write, "x" for Execute", and "n" for Notify).

The string is always in the same order (rwxn) and the lack of a permission is signified by a "-" character (e.g., r--n).

The following describes the meaning of the permissions for Parameter type of Targets:

  1. Read: Grants the capability to read the value of the Parameter via Get and read the meta-information of the Parameter via GetSupportedDM.
  2. Write: Grants the capability to update the value of the Parameter via Add or Set.
  3. Execute: Grants no capabilities; Parameters can not be executed.
  4. Notify: Grants the capability to use this Parameter in the ReferenceList of a ValueChange Subscription.
---- 2.12 TR-181i2a12
Obj string​(4:4) string​(4:4) W

The permissions of a Role for the specified Targets.

A string of 4 characters where each character represents a permission ("r" for Read, "w" for Write, "x" for Execute", and "n" for Notify).

The string is always in the same order (rwxn) and the lack of a permission is signified by a "-" character (e.g., r--n).

The following describes the meaning of the permissions for Object type of Targets:

  1. Read: Grants the capability to read the meta-information of the Object via GetSupportedDM.
  2. Write: Grants no capabilities for Static Objects. Grants the capability to create a new instance of a Multi-Instanced Object via Add (e.g. Device.LocalAgent.Controller.).
  3. Execute: Grants no capabilities; Objects are not executable and Commands are controlled by the CommandEventPermissions.
  4. Notify: Grants the capability to use this Object in the ReferenceList of an ObjectCreation (for multi-instance objects only) Subscription.
---- 2.12 TR-181i2a12
InstantiatedObj string​(4:4) string​(4:4) W

The permissions of a Role for the specified Targets.

A string of 4 characters where each character represents a permission ("r" for Read, "w" for Write, "x" for Execute", and "n" for Notify).

The string is always in the same order (rwxn) and the lack of a permission is signified by a "-" character (e.g., r--n).

The following describes the meaning of the permissions for Instantiated Object type of Targets:

  1. Read: Grants the capability to read the instance numbers and unique keys of the Instantiated Object via GetInstances.
  2. Write: Grants the capability to remove an existing instance of an Instantiated Object via Delete (e.g. Device.LocalAgent.Controller.1.).
  3. Execute: Grants no capabilities; Object Instances are not executable and Commands are controlled by the CommandEventPermissions.
  4. Notify: Grants the capability to use this Instantiated Object in the ReferenceList of an ObjectDeletion Subscription.
---- 2.12 TR-181i2a12
CommandEvent string​(4:4) string​(4:4) W

The permissions of a Role for the specified Targets.

A string of 4 characters where each character represents a permission ("r" for Read, "w" for Write, "x" for Execute", and "n" for Notify).

The string is always in the same order (rwxn) and the lack of a permission is signified by a "-" character (e.g., r--n).

The following describes the meaning of the permissions for Command and Event type of Targets:

  1. Read: Grants the capability to read the meta-information of the Command (including input and output arguments) and Event (including arguments) via GetSupportedDM.
  2. Write: Grants no capabilities; Commands are executed instead of written to and Events are read only.
  3. Execute: Grants the capability to execute the Command via Operate, but grants no capabilities to an Event.
  4. Notify: Grants the capability to use this Event or Command in the ReferenceList of an Event or OperationComplete Subscription.
---- 2.12 TR-181i2a12
Device.​LocalAgent.​ControllerTrust.​Credential.​{i}. object​[0:] object​[0:∞] W

Each instance of this table represents a trusted credential. The credential can be that of a certificate authority (CA) for a Controller whose EndpointID is unknown.

When a credential is supplied to the Agent by a Controller during authentication, the credentials in this table are used to determine if any of the supplied certificates (including those in the chain of trust) are considered "trusted".

If the Controller authenticated via an entry in this table is not previously known to the Agent, the associated Role entry is automatically applied to the Controller.

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

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Enable boolean boolean W Enable/Disable this Credential instance. false 2.12 TR-181i2a12
Role string​[] list of string W

Each list item MUST be the Path Name of a row in the Role table. If the referenced object is deleted, the corresponding item MUST be removed from the list.

Comma-separated list of strings, the (set of) Role(s) applied to a Controller authenticated through this Credential instance.

The roles are added to the Controller's current list of Roles by replacing the value of the LocalAgent.Controller.{i}.InheritedRole parameter.

If the Controller is already known to the Agent, with an associated Role, this parameter has no impact.

- 2.12 TR-181i2a12
Credential string string W

The value MUST be the Path Name of a row in the Certificate table. If the referenced object is deleted, the parameter value MUST be set to an empty string. A reference to the Certificate.{i} instance for use in the authentication of certificates provided by a Controller and authorization of Controllers, and for authentication of certificates used for MTP encryption.

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 TR-181i2a12
AllowedUses string string W

Identifies what usages the Certificate Authority (CA) authenticated by the associated credential is trusted to authorize. Enumeration of:

  • MTP-only (The CA can only authorize MTP (domain) connectivity, and cannot authenticate Controllers)
  • MTP-and-USP (The CA can authorize MTP (domain) connectivity and authenticate Controllers)
  • MTP-and-broker (The CA can authorize MTP (domain) connectivity and the presenter of this certificate is trusted to have authenticated the identity of Endpoints whose Records it transmits such that the from_id can be trusted without additional authentication. See ["Authentication and Authorization"/TR-369] for additional description of the Trusted Broker function)
- 2.12 TR-181i2a12
Device.​LocalAgent.​ControllerTrust.​Challenge.​{i}. object​[0:] object​[0:∞] W

Each instance of this table represents information that is used to challenge a Controller in order to assign a Role to the Controller or to determine the authenticity of a Certificate.

The Controller requests a type of challenge from an Agent using the RequestChallenge command.

The Agent returns the value of the Instruction for that type of challenge to the Controller which the Controller then provides a third-party.

The third-party responds to the Instruction which the Controller then sends to the Agent using the ChallengeResponse command.

The Agent verifies the response to the Challenges and executes an implementation specific Agent logic in order to establish trust with the Controller.

This could include (but is not limited to):

  • Assignment of roles to the Controller is done by appending the non-duplicate roles of the Role parameter to the value of the LocalAgent.Controller.{i}.AssignedRole parameter.
  • Use the Controller's certificate to which the challenge response was received in order to authenticate the identity of the Controller.

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

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Description string string W The description of this Challenge instance. - 2.12 TR-181i2a12
Role string​[] list of string W

Each list item MUST be the Path Name of a row in the Role table. If the referenced object is deleted, the corresponding item MUST be removed from the list.

Comma-separated list of strings, the (set of) role(s) appended (non-duplicate values only) to the value of the LocalAgent.Controller.{i}.AssignedRole parameter.

- 2.12 TR-181i2a12
Enable boolean boolean W Enable/Disable this Challenge instance. false 2.12 TR-181i2a12
Type string string W

The type of challenge that will be verified from the challenge response provided by the third-party through the Controller. Enumeration of:

  • Passphrase (The challenge uses a passphrase the third-party is expected to match)
- 2.12 TR-181i2a12
Value base64 base64 W

The value of the challenge that is specific to the type of challenge.

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

- 2.12 TR-181i2a12
ValueType string string W

The media type with a format as defined by [RFC6838] of the content of the Value parameter. Enumeration of:

- 2.12 TR-181i2a12
Instruction base64 base64 W The instruction that is provided to the external party by the Controller requesting the challenge. - 2.12 TR-181i2a12
InstructionType string string W

The media type with a format as defined by [RFC6838] of the content of the Instruction parameter. Enumeration of:

- 2.12 TR-181i2a12
Retries unsignedInt unsignedInt W The number of times a challenge is retried before the challenge procedure is terminated. - 2.12 TR-181i2a12
LockoutPeriod int​(0:) int​(0:) W

The time, in seconds that a Controller that has failed the challenge is locked out (based on the value of the Retries parameter) prior to being provided the challenge again.

A value of zero means that a LockoutPeriod doesn't apply and the challenge can be provided indefinitely.

30 2.12 TR-181i2a12
Device.​STOMP. object object​[1:1] - The STOMP represents the STOMP capabilities of the device as described in [TR-369]. - 2.12 TR-181i2a12
ConnectionNumberOfEntries unsignedInt unsignedInt - The number of entries in the Connection table. - 2.12 TR-181i2a12
Device.​STOMP.​Connection.​{i}. object​[0:] object​[0:∞] W

The Connection represents a STOMP connection between the Agent and a STOMP server.

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

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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

Enables or disables this Connection.

This parameter is based on ifAdminStatus from [RFC2863].

false 2.12 TR-181i2a12
Status string string -

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

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

When Enable is changed to true then Status SHOULD change to Enabled if and only if the interface is able to transmit and receive PDUs; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

- 2.12 TR-181i2a12
LastChangeDate dateTime dateTime - The date and time at which this Connection entered into its current operational state. - 2.12 TR-181i2a12
Host string​(256) string​(256) W

The hostname or IP Address of the STOMP Server.

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

- 2.12 TR-181i2a12
Port unsignedInt​(1:65535) unsignedInt​(1:65535) W The port number of the STOMP Server. 61613 2.12 TR-181i2a12
Username string​(256) string​(256) W

The username part of the credentials to be used when authenticating this Connection during connection establishment with the STOMP Server.

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

- 2.12 TR-181i2a12
Password string​(256) string​(256) W

The password part of the credentials to be used when authenticating this Connection during connection establishment with the STOMP Server.

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

- 2.12 TR-181i2a12
VirtualHost string​(256) string​(256) W

The Virtual Host to use when establishing the connection.

Some STOMP Server implementations utilize virtual hosts to place a context around credentials, permissions, and internal resources.

<Empty> 2.12 TR-181i2a12
EnableHeartbeats boolean boolean W

Enable or disable the STOMP Heart-beating mechanism as described in STOMP (for this Connection).

When the STOMP Heart-beat mechanism is enabled, OutgoingHeartbeat and IncomingHeartbeat determine how the heart-beat header within the CONNECT frame is formatted.

When the STOMP Heart-beat mechanism is disabled, OutgoingHeartbeat and IncomingHeartbeat are ignored and the CONNECT frame MUST NOT contain a heart-beat header element.

Any changes to this parameter will not take effect until the next connection.

false 2.12 TR-181i2a12
OutgoingHeartbeat unsignedInt unsignedInt W

Represents the Outgoing heart-beat timing of the STOMP Heart-beating mechanism as described in STOMP (for this Connection).

The Outgoing heart-beat represents what the sender of the frame can do. A value of 0 means that it cannot send heart-beats.

Any changes to this parameter will not take effect until the next connection.

0 2.12 TR-181i2a12
IncomingHeartbeat unsignedInt unsignedInt W

Represents the Incoming heart-beat timing of the STOMP Heart-beating mechanism as described in STOMP (for this Connection).

The Incoming heart-beat represents what the sender of the frame would like to get. A value of 0 means that it does not want to receive heart-beats.

Any changes to this parameter will not take effect until the next connection.

0 2.12 TR-181i2a12
ServerRetryInitialInterval unsignedInt​(1:65535) unsignedInt​(1:65535) W

The maximum first reconnection wait interval, in seconds, as specified in [TR-369].

The Device MUST use a random value between 0 and ServerRetryInitialInterval as the first reconnection wait interval.

60 2.12 TR-181i2a12
ServerRetryIntervalMultiplier unsignedInt​(1000:65535) unsignedInt​(1000:65535) W

The reconnection interval multiplier as specified in [TR-369]. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535.

For the nth reconnection wait interval, the Device MUST use a random value, in seconds, between 0 and ServerRetryInitialInterval * (ServerRetryIntervalMultiplier / 1000) ** (n - 1).

2000 2.12 TR-181i2a12
ServerRetryMaxInterval unsignedInt​(1:) unsignedInt​(1:) W

The maximum reconnection wait interval, in seconds.

If the nth reconnection wait interval calculated from ServerRetryInitialInterval and ServerRetryIntervalMultiplier exceeds the value of this parameter, then the Agent MUST use the value of this parameter as the next reconnection wait interval.

30720 2.12 TR-181i2a12
IsEncrypted boolean boolean - This parameter represents whether or not communications that utilize this Connection object instance are encrypted. - 2.12 TR-181i2a12
Device.​Standby. object object​[1:1] - Capabilities of a Device as it pertains to entering a standby state. - 2.12 TR-181i2a12
NetworkAware boolean boolean - Indicates that the device is capable of maintaining a network connection and responding to communications via the network connection while in a standby state. - 2.12 TR-181i2a12
TimerAware boolean boolean - Indicates that the device is capable of maintaining and responding to timers while in a standby state. - 2.12 TR-181i2a12
Device.​SoftwareModules. object object​[1:1] - Top level object for dynamically managed software applications. - 2.12 TR-181i2a12
InstallDU​() command object - [ASYNC] Install one or more Deployment Units (DUs) to the associated SoftwareModules. - 2.12 TR-181i2a12
⇒ Input. arguments object - Input arguments. -
⇒ URL string​(256) string​(256) W

[MANDATORY] The URL, as defined in [RFC3986], that specifies the location of the DU to be installed.

The URL MUST NOT include the "userinfo" component, as defined in [RFC3986].

HTTP and HTTPS transports MUST be supported. Other optional transports MAY be supported.

- 2.12 TR-181i2a12
⇒ UUID string​(36:36) UUID W

[UUID] The UUID (see [RFC4122]) of the DU to be installed.

If this parameter is an empty string the device MUST generate the UUID based on the rules defined in [RFC4122] and [Annex H/TR-069].

- 2.12 TR-181i2a12
⇒ Username string​(256) string​(256) W Username to be used by the device to authenticate with the file server, if authentication is required. <Empty> 2.12 TR-181i2a12
⇒ Password string​(256) string​(256) W Password to be used by the device to authenticate with the file server, if authentication is required. <Empty> 2.12 TR-181i2a12
⇒ ExecutionEnvRef string​(256) string​(256) W

The value MUST be the Path Name of a row in the SoftwareModules.ExecutionUnit table. A reference to the Execution Environment upon which the DU to be installed.

If an empty string the device MUST choose the Execution Environment to use.

- 2.12 TR-181i2a12
DUStateChange! event object -

This event informs a Controller of the completion (successful or unsuccessful) of a DU state change.

When used, this event MUST be issued after the device has completed any file transfers and carried out all operations related to the DU State Change.

This event MAY contain the results from multiple DU state changes; it is implementation specific how the device chooses to aggregate the DU state changes, although the device MUST notify the Controller of any DU state changes within 24 hours of the time the operations were completed by the device.

The device SHOULD make every attempt to aggregate, as much as possible, the DU State Change notifications to the Controller in the interest of scalability.

- 2.12 TR-181i2a12
⇒ UUID string​(36:36) UUID - [UUID] The UUID as defined in [RFC4122] of the DU that affected by the state change. - 2.12 TR-181i2a12
⇒ DeploymentUnitRef string string - The value MUST be the Path Name of a row in the SoftwareModules.DeploymentUnit table. A reference to the DU that was affected by the state change. - 2.12 TR-181i2a12
⇒ Version string​(32) string​(32) -

In the case of an Install, this will be the version of the DU created. In the case of an Update, it will be the updated version of the DU. In the case of an Uninstall, it will be the version of the uninstalled DU.

This MUST match the SoftwareModules.DeploymentUnit.{i}.Version Parameter contained within the instance of the DeploymentUnit that is contained within the DeploymentUnitRef argument.

- 2.12 TR-181i2a12
⇒ CurrentState string string -

The current state of the created DU. Enumeration of:

  • Installed (The DU is in an Installed state due to one of the following: successful Install, successful Update, failed Update, or failed Uninstall. In the case of a failed Update or failed Uninstall the Fault argument will contain an explanation of the failure)
  • UnInstalled (The DU was successfully uninstalled from the device)
  • Failed (The DU could not be installed in which case a DU instance MUST NOT be created in the Data Model)
- 2.12 TR-181i2a12
⇒ Resolved boolean boolean -

Whether or not the DU operation resolved all of its dependencies.

In the case of a successful Uninstall, this value is meaningless and should be true.

- 2.12 TR-181i2a12
⇒ ExecutionUnitRefList string​[] list of string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the SoftwareModules.ExecutionUnit table. The Execution Units affected by this operation.

In the case of an Install, this will be the list of EUs that were created as a result of the DU’s installation.

In the case an Update, this will be the list of all EUs currently associated with the updated DU, including those that were created through the initial DU installation and any updates that had already occurred but not including any EUs that no longer exist on the device because of this or previous updates.

In the case of an Uninstall, this will be the list of the EUs removed from the device due to the DU being removed.

- 2.12 TR-181i2a12
⇒ StartTime dateTime dateTime - The date and time transfer was started in UTC. The device SHOULD record this information and report it in this argument, but if this information is not available, the value of this argument MUST be set to the Unknown Time value. - 2.12 TR-181i2a12
⇒ CompleteTime dateTime dateTime - The date and time the transfer was fully completed and applied in UTC. This need only be filled in if the transfer has been fully completed and applied. The device SHOULD record this information and report it in this argument, but if this information is not available or the transfer has not completed, the value of this argument MUST be set to the Unknown Time value. - 2.12 TR-181i2a12
⇒ OperationPerformed string string -

The operation that was performed against the DU causing the DU state change. Enumeration of:

  • Install (The operation attempted was the Installation of a DU)
  • Update (The operation attempted was the Update of an existing DU)
  • Uninstall (The operation attempted was the Un-Installation of an existing DU)
- 2.12 TR-181i2a12
⇒ Fault. object object​[1:1] - Fault Structure. If the operation was successful, the FaultCode MUST be zero. Otherwise a non-zero FaultCode is specified along with a FaultString indicating the failure reason. - 2.12 TR-181i2a12
⇒ FaultCode unsignedInt unsignedInt -

The numerical fault code. Valid values are:

  • If the operation was successful, the fault code is 0.
  • If the device cannot complete the operation for some unknown reason, it SHOULD reject the operation with a 9001 (Request Denied) fault code.
  • If the device detects the presence of the "userinfo" component in the file source URL, it SHOULD reject the operation with a 9003 (Invalid Arguments) fault code.
  • If the device cannot find the Execution Environment specified in the Install or Update command, it SHOULD reject the operation with a 9023 (Unknown Execution Environment) fault code.
  • If the device determines that the Deployment Unit being installed does not match either the Execution Environment specified or any Execution Environment on the device, it SHOULD reject the operation with a 9025 (Deployment Unit to Execution Environment Mismatch) fault code
  • If the device detects that the Deployment Unit being installed already has the same version as one already installed on the same Execution Environment, it SHOULD reject the operation with a 9026 (Duplicate Deployment Unit) fault code.
  • If the device detects that that there are no more system resources (disk space, memory, etc.) to perform the Install or Update of a Deployment Unit, it SHOULD reject the operation with a 9027 (System Resources Exceeded) fault code.
  • If a requested operation attempts to alter the State of a Deployment Unit in a manner that conflicts with the Deployment Unit State Machine Diagram [Appendix I "Software Module Management"/TR-369], it SHOULD reject the operation with a 9029 (Invalid Deployment Unit State) fault code.
  • If a requested operation attempts to Uninstall a DU that caused an EE to come into existence, where that EE has at least 1 installed DU or at least 1 child EE, then the device SHOULD reject the operation with a 9029 (Invalid Deployment Unit State) fault code.
- 2.12 TR-181i2a12
⇒ FaultString string​(256) string​(256) - A human-readable text description of the fault. This field SHOULD be empty if the FaultCode equals 0 (zero). - 2.12 TR-181i2a12
ExecEnvNumberOfEntries unsignedInt unsignedInt - The number of entries in the ExecEnv table. - 2.12 TR-181i2a12
DeploymentUnitNumberOfEntries unsignedInt unsignedInt - The number of entries in the DeploymentUnit table. - 2.12 TR-181i2a12
ExecutionUnitNumberOfEntries unsignedInt unsignedInt - The number of entries in the ExecutionUnit table. - 2.12 TR-181i2a12
Device.​SoftwareModules.​ExecEnv.​{i}. object​[0:] object​[0:∞] -

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

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

- 2.12 TR-181i2a12
Enable boolean boolean W

Indicates whether or not this ExecEnv is enabled.

Disabling an enabled Execution Environment stops it, while enabling a disabled Execution Environment starts it.

When an Execution Environment is disabled, Deployment Units installed to that Execution Environment will be unaffected, but any Execution Units currently running on that Execution Environment will automatically transition to Idle.

If an Update or Uninstall operation is attempted on a DeploymentUnit that is to be applied against a disabled ExecEnv, that operation fails and the associated event will contain a FaultStruct for that operation.

Disabling an Execution Environment could place the device in a non-manageable state. For example, if the operating system itself was modeled as an ExecEnv and a Controller disabled it, the Agent might be terminated leaving the device unmanageable.

- 2.12 TR-181i2a12
Status string string -

Indicates the status of this ExecEnv. Enumeration of:

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Name string​(32) string​(32) -

A Name provided by the device that adequately distinguishes this ExecEnv from all other ExecEnv instances.

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 TR-181i2a12
Type string​(64) string​(64) - Indicates the complete type and specification version of this ExecEnv. - 2.12 TR-181i2a12
InitialRunLevel unsignedInt​(:65535) unsignedInt​(:65535) W

The run level that this ExecEnv will be in upon startup (whether that is caused by a device Boot or the Execution Environment starting).

Run levels dictate which Execution Units will be started. Execution Units will be started if CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true.

If the value of CurrentRunLevel is -1, then the value of this parameter is irrelevant when read and setting its value has no impact on the Run Level of this ExecEnv.

- 2.12 TR-181i2a12
CurrentRunLevel int​(-1:65535) int​(-1:65535) -

The run level that this ExecEnv is currently operating in. This value is altered by executing the SetRunLevel() command.

Upon startup (whether that is caused by a device Boot or the Execution Environment starting) CurrentRunLevel will be equal to InitialRunLevel, unless Run Levels are not supported by this ExecEnv in which case CurrentRunLevel will be -1.

Run levels dictate which Execution Units will be started. Execution Units will be started if CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true.

If CurrentRunLevel is -1 then Run Levels are not supported by this ExecEnv and setting InitialRunLevel or executing the command SetRunLevel() will not impact the Run Level of this ExecEnv.

- 2.12 TR-181i2a12
InitialExecutionUnitRunLevel int​(-1:65535) int​(-1:65535) W

Indicates the initial value on creation for ExecutionUnit.{i}.RunLevel for all Execution Unit instances associated with this ExecEnv.

If the value of CurrentRunLevel is -1, then the value of this parameter is irrelevant when read and setting its value has no impact on the Run Level of any Execution Unit.

- 2.12 TR-181i2a12
Vendor string​(128) string​(128) - The vendor that produced this ExecEnv. - 2.12 TR-181i2a12
Version string​(32) string​(32) - The Version of this ExecEnv as specified by the Vendor that implemented this ExecEnv, not the version of the specification. - 2.12 TR-181i2a12
ParentExecEnv string string -

The value MUST be the Path Name of a row in the ExecEnv table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Represents the parent ExecEnv of this ExecEnv.

If this value is an empty string then this is the Primary Execution Environment.

- 2.12 TR-181i2a12
AllocatedDiskSpace int​(-1:) int​(-1:) - The amount of disk space measured in kilobytes allocated to this ExecEnv. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 2.12 TR-181i2a12
AvailableDiskSpace int​(-1:) int​(-1:) - The amount of disk space measured in kilobytes currently available to this ExecEnv. This value changes as the ExecutionUnit instances associated with this ExecEnv consumes disk space. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 2.12 TR-181i2a12
AllocatedMemory int​(-1:) int​(-1:) - The amount of physical RAM measured in kilobytes allocated to this ExecEnv. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 2.12 TR-181i2a12
AvailableMemory int​(-1:) int​(-1:) - The amount of physical RAM measured in kilobytes currently available to this ExecEnv. This value changes as the ExecutionUnit instances associated with this ExecEnv are started/stopped and consume the physical RAM. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. - 2.12 TR-181i2a12
ActiveExecutionUnits string​[] list of string - Comma-separated list of strings. Each list item MUST be the Path Name of a row in the ExecutionUnit table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the ExecutionUnit instances currently running on this ExecEnv. This parameter only contains ExecutionUnit instances that currently have a ExecutionUnit.{i}.Status of Active. - 2.12 TR-181i2a12
ProcessorRefList string​[] list of string - Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.Processor table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the processors that this ExecEnv has available to it. - 2.12 TR-181i2a12
SetRunLevel​() command object -

Provides a mechanism to remotely manipulate the run level of this ExecEnv, meaning that altering this comand will change the value of the CurrentRunLevel.

Run levels dictate which Execution Units will be started. Execution Units will be started if CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true.

- 2.12 TR-181i2a12
⇒ Input. arguments object - Input arguments. -
⇒ RequestedRunLevel int​(-1:65535) int​(-1:65535) W

This parameter will request to change the value of the CurrentRunLevel to the value of this parameter.

Setting this value when CurrentRunLevel is -1 has no impact to the Run Level of this instance of the SoftwareModules object.

- 2.12 TR-181i2a12
Reset​() command object -

This command causes this ExecEnv to revert back to the state it was in when the device last issued a Boot event with a cause of a local or remote factory reset.

The following requirements dictate what MUST happen for the reset to be complete:

  1. All Deployment Units that were installed after the last Boot (with cause of a factory reset) event MUST be removed
  2. All persistent storage, configuration files, and log files that were associated with the removed Deployment Units MUST be removed
  3. Any Deployment Unit that is still installed against the Execution Environment MUST be restored to the version present when the last Boot (with cause of a factory reset) event event was issued
  4. Any Deployment Unit that was present when the last Boot (with cause of a factory reset) eventevent was issued, but was subsequently uninstalled and is now not present, MUST be installed with the version that was present when the last "0 BOOTSTRAP" Inform event was issued
  5. The Execution Environment MUST be restored to the version and configuration present when the last Boot (with cause of a factory reset) eventevent was issued
  6. The Execution Environment MUST be restarted after all other restoration requirements have been met
- 2.12 TR-181i2a12
Device.​SoftwareModules.​DeploymentUnit.​{i}. object​[0:] object​[0:∞] -

This table serves as the Deployment Unit inventory and contains status information about each Deployment Unit.

A new instance of this table gets created during the installation of a Software Module.

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

- 2.12 TR-181i2a12
UUID string​(36) string​(36) -

A Universally Unique Identifier either provided by the Controller, or generated by the device, at the time of Deployment Unit Installation.

The format of this value is defined by [RFC4122] Version 5 (Name-Based) and [Appendix TBD/TR-181i2a12].

This value MUST NOT be altered when the DeploymentUnit is updated.

- 2.12 TR-181i2a12
DUID string​(64) string​(64) - Deployment Unit Identifier chosen by the targeted ExecEnv. The format of this value is Execution Environment specific. - 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Name string​(64) string​(64) -

Indicates the Name of this DeploymentUnit, which is chosen by the author of the Deployment Unit.

The value of this parameter is used in the generation of the UUID based on the rules defined in [Annex H/TR-069].

- 2.12 TR-181i2a12
Status string string -

Indicates the status of this DeploymentUnit. Enumeration of:

  • Installing (This instance is in the process of being Installed and SHOULD transition to the Installed state)
  • Installed (This instance has been successfully Installed. The Resolved flag SHOULD also be referenced for dependency resolution)
  • Updating (This instance is in the process of being Updated and SHOULD transition to the Installed state)
  • Uninstalling (This instance is in the process of being Uninstalled and SHOULD transition to the Uninstalled state)
  • Uninstalled (This instance has been successfully Uninstalled. This status will typically not be seen within a DeploymentUnit instance)
- 2.12 TR-181i2a12
Resolved boolean boolean - Indicates whether or not this DeploymentUnit has resolved all of its dependencies. - 2.12 TR-181i2a12
URL string​(1024) string​(1024) - Contains the URL used by the most recent ChangeDUState RPC to either Install or Update this DeploymentUnit. - 2.12 TR-181i2a12
Description string​(256) string​(256) - Textual description of this DeploymentUnit. The format of this value is Execution Environment specific. - 2.12 TR-181i2a12
Vendor string​(128) string​(128) -

The author of this DeploymentUnit formatted as a domain name.

The value of this parameter is used in the generation of the UUID based on the rules defined in [Annex H/TR-069a3].

- 2.12 TR-181i2a12
Version string​(32) string​(32) - Version of this DeploymentUnit. The format of this value is Execution Environment specific. - 2.12 TR-181i2a12
VendorLogList string​[] list of string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorLogFile table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor log files that have come into existence because of this DeploymentUnit.

This does not include any vendor log files that have come into existence because of ExecutionUnit instances that are contained within this DeploymentUnit.

When this DeploymentUnit is uninstalled the vendor log files referenced here SHOULD be removed from the device.

Not all DeploymentUnit instances will actually have a corresponding vendor log file, in which case the value of this parameter will be an empty string.

- 2.12 TR-181i2a12
VendorConfigList string​[] list of string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorConfigFile table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor config files that have come into existence because of this DeploymentUnit.

This does not include any vendor config files that have come into existence because of ExecutionUnit instances that are contained within this DeploymentUnit.

When this DeploymentUnit is uninstalled the vendor config files referenced here SHOULD be removed from the device.

Not all DeploymentUnit instances will actually have a corresponding vendor config file, in which case the value of this parameter will be an empty string.

- 2.12 TR-181i2a12
ExecutionUnitList string​[] list of string - Comma-separated list of strings. Each list item MUST be the Path Name of a row in the ExecutionUnit table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the ExecutionUnit instances that are associated with this DeploymentUnit instance. - 2.12 TR-181i2a12
ExecutionEnvRef string string - The value MUST be the Path Name of a row in the ExecEnv table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Represents the ExecEnv instance where this DeploymentUnit instance is installed. - 2.12 TR-181i2a12
Update​() command object - [ASYNC] Update the associated DeploymentUnit. - 2.12 TR-181i2a12
⇒ Input. arguments object - Input arguments. -
⇒ URL string​(256) string​(256) W

The URL, as defined in [RFC3986], that specifies the location of the DU to be installed.

The URL MUST NOT include the "userinfo" component, as defined in [RFC3986].

HTTP and HTTPS transports MUST be supported. Other optional transports MAY be supported.

If the device receives an Update command with the same source URL as a previous Update or Install comamnd, the device MUST perform each Update as requested, and MUST NOT assume that the content of the file to be downloaded is the same each time.

- 2.12 TR-181i2a12
⇒ Username string​(256) string​(256) W Username to be used by the device to authenticate with the file server, if authentication is required. <Empty> 2.12 TR-181i2a12
⇒ Password string​(256) string​(256) W Password to be used by the device to authenticate with the file server, if authentication is required. <Empty> 2.12 TR-181i2a12
Uninstall​() command object - [ASYNC] Uninstall the associated DeploymentUnit. - 2.12 TR-181i2a12
Device.​SoftwareModules.​ExecutionUnit.​{i}. object​[0:] object​[0:∞] -

This table serves as the Execution Unit inventory and contains both status information about each Execution Unit as well as configurable parameters for each Execution Unit.

Each DeploymentUnit that is installed can have zero or more Execution Units.

Once a Deployment Unit is installed it populates this table with its contained Execution Units.

When the Deployment Unit (that caused this ExecutionUnit to come into existence) is updated, this instance MAY be removed and new instances MAY come into existence. While the Deployment Unit (that caused this ExecutionUnit to come into existence) is being updated, all ExecutionUnit instances associated with the Deployment Unit will be stopped until the update is complete at which time they will be restored to the state that they were in before the update started.

When the Deployment Unit (that caused this ExecutionUnit to come into existence) is uninstalled, this instance is removed.

Each ExecutionUnit MAY also contain a set of vendor specific parameters displaying status and maintaining configuration that reside under the Extensions object.

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

- 2.12 TR-181i2a12
EUID string​(64) string​(64) -

Execution Unit Identifier chosen by the ExecEnv during installation of the associated DeploymentUnit.

The format of this value is Execution Environment specific, but it MUST be unique across ExecEnv instances. Thus, it is recommended that this be a combination of the ExecEnv.{i}.Name and an Execution Environment local unique value.

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Name string​(32) string​(32) - The name of this ExecutionUnit as it pertains to its associated DeploymentUnit, which SHOULD be unique across all ExecutionUnit instances contained within its associated DeploymentUnit. - 2.12 TR-181i2a12
ExecEnvLabel string​(64) string​(64) - The name of this ExecutionUnit as provided by the ExecEnv, which SHOULD be unique across all ExecutionUnit instances contained within a specific ExecEnv. - 2.12 TR-181i2a12
Status string string -

Indicates the status of this ExecutionUnit. Enumeration of:

  • Idle (This instance is in an Idle state and not running)
  • Starting (This instance is in the process of Starting and SHOULD transition to the Active state)
  • Active (This instance is currently running)
  • Stopping (This instance is in the process of Stopping and SHOULD transition to the Idle state)
- 2.12 TR-181i2a12
ExecutionFaultCode string string -

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

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

- 2.12 TR-181i2a12
ExecutionFaultMessage string​(256) string​(256) -

If while running or transitioning between states this ExecutionUnit identifies a fault this parameter provides a more detailed explanation of the problem.

If ExecutionFaultCode has the value of NoFault then the value of this parameter MUST an empty string and ignored by the Controller.

- 2.12 TR-181i2a12
AutoStart boolean boolean W

If true and the RunLevel verification is also met, then this ExecutionUnit will be automatically started by the device after its ExecEnv is either rebooted or restarted.

If false this ExecutionUnit will not be started after its ExecEnv is either rebooted or restarted until it is explicitly commanded to do so by either the Controller or another Execution Unit.

- 2.12 TR-181i2a12
RunLevel unsignedInt​(:65535) unsignedInt​(:65535) W

Determines when this ExecutionUnit will be started.

If AutoStart is true and ExecEnv.{i}.CurrentRunLevel is greater than or equal to RunLevel, then this ExecutionUnit will be started.

If the value of ExecEnv.{i}.CurrentRunLevel is -1, then the associated ExecEnv. doesn't support Run Levels, thus the value of this parameter is irrelevant when read and setting its value has no impact to the Run Level of this ExecutionUnit.

- 2.12 TR-181i2a12
Vendor string​(128) string​(128) - Vendor of this ExecutionUnit. - 2.12 TR-181i2a12
Version string​(32) string​(32) - Version of the ExecutionUnit. The format of this value is Execution Environment specific. - 2.12 TR-181i2a12
Description string​(256) string​(256) - Textual description of this ExecutionUnit. The format of this value is Execution Environment specific. - 2.12 TR-181i2a12
DiskSpaceInUse int​(-1:) int​(-1:) - The amount of disk space measured in kilobytes currently being used by this ExecutionUnit. A value of -1 MUST be used for ExecutionUnit instances where this parameter is not applicable. - 2.12 TR-181i2a12
MemoryInUse int​(-1:) int​(-1:) - The amount of physical RAM measured in kilobytes currently being used by this ExecutionUnit. A value of -1 MUST be used for ExecutionUnit instances where this parameter is not applicable. - 2.12 TR-181i2a12
References string​[] list of string -

Comma-separated list of strings. Each list item MUST be the Path Name of a table row. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the instances of multi-instanced objects that are directly controlled by, and have come into existence because of, this ExecutionUnit.

NOTE: All other objects and parameters (i.e. not multi-instanced objects) that this ExecutionUnit has caused to come into existence can be discovered via the GetSupportedDM and GetInstances USP messages.

- 2.12 TR-181i2a12
AssociatedProcessList string​[] list of string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.ProcessStatus.Process table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the system processes that are active in the system because of this ExecutionUnit.

If Status is not Active it is expected that this list will be an empty string. Some ExecutionUnit instances MIGHT NOT have any system processes irrespective of the value of Status.

- 2.12 TR-181i2a12
VendorLogList string​[] list of string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorLogFile table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor log files that have come into existence because of this ExecutionUnit.

When the DeploymentUnit (that caused this ExecutionUnit to come into existence) is uninstalled the vendor log files referenced here SHOULD be removed from the device.

Not all ExecutionUnit instances will actually have a corresponding vendor log file, in which case the value of this parameter will be an empty string.

- 2.12 TR-181i2a12
VendorConfigList string​[] list of string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorConfigFile table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor config files that have come into existence because of this ExecutionUnit.

When the DeploymentUnit (that caused this ExecutionUnit to come into existence) is uninstalled the vendor config files referenced here SHOULD be removed from the device.

Not all ExecutionUnit instances will actually have a corresponding vendor config file, in which case the value of this parameter will be an empty string.

- 2.12 TR-181i2a12
ExecutionEnvRef string string - The value MUST be the Path Name of a row in the ExecEnv table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Represents the ExecEnv that this ExecutionUnit is associated with. - 2.12 TR-181i2a12
SetRequestedState​() command object -

Set the state transition that the Controller is requesting for this instance of the ExecutionUnit object.

If this instance of the ExecutionUnit object is associated with an Execution Environment that is disabled and an attempt is made to alter this value, then a error message MUST be generated.

- 2.12 TR-181i2a12
⇒ Input. arguments object - Input arguments. -
⇒ RequestedState string string W

Indicates the requested state to transition this instance of the SoftwareModules object. Enumeration of:

- 2.12 TR-181i2a12
Device.​SoftwareModules.​ExecutionUnit.​{i}.​Extensions. object object​[1:1] -

This object proposes a general location for vendor extensions specific to this Execution Unit, which allows multiple Execution Units to expose parameters without the concern of conflicting parameter names. These vendor extensions are related to displaying status and maintaining configuration for this Execution Unit.

It is also possible for the Execution Unit to expose status and configuration parameters within Service objects or as embedded objects and parameters directly within the root data model, in which case the combination of References and use of GetSupportDM and GetInstances USP messages will be used to determine their locations.

- 2.12 TR-181i2a12
Device.​ProxiedDevice.​{i}. object​[0:] object​[0:∞] -

Each entry in the table is a ProxiedDevice object that is a mount point. Each ProxiedDevice represents distinct hardware Devices. ProxiedDevice objects are virtual and abstracted representation of functionality, that exists on hardware other than that which the Agent is running.

This object is a mount point, under which mountable objects can be mounted.

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

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Device.​Time. object object​[1:1] - This object contains parameters relating an NTP or SNTP time client in the CPE. - 2.12 TR-181i2a12
Enable boolean boolean W Enables or disables the NTP or SNTP time client. - 2.12 TR-181i2a12
Status string string -

Status of Time support on the CPE. Enumeration of:

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

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

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

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

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

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

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

Enables and disables the CPE's user interface.

The factory default value MUST be true.

- 2.12 TR-181i2a12
PasswordRequired boolean boolean W

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

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

- 2.12 TR-181i2a12
PasswordUserSelectable boolean boolean W

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

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

- 2.12 TR-181i2a12
PasswordReset​() command object -

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

Un-encoded binary image size in bytes.

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

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

- 2.12 TR-181i2a12
ISPMailServer string​(256) string​(256) W The URL of the ISP's mail server. - 2.12 TR-181i2a12
ISPNewsServer string​(256) string​(256) W The URL of the ISP's news server. - 2.12 TR-181i2a12
TextColor hexBinary​(3:3) hexBinary​(3:3) W The color of text on the GUI screens in RGB hexadecimal notation (e.g., FF0088). - 2.12 TR-181i2a12
BackgroundColor hexBinary​(3:3) hexBinary​(3:3) W The color of the GUI screen backgrounds in RGB hexadecimal notation (e.g., FF0088). - 2.12 TR-181i2a12
ButtonColor hexBinary​(3:3) hexBinary​(3:3) W The color of buttons on the GUI screens in RGB hexadecimal notation (e.g., FF0088). - 2.12 TR-181i2a12
ButtonTextColor hexBinary​(3:3) hexBinary​(3:3) W The color of text on buttons on the GUI screens in RGB hexadecimal notation (e.g., FF0088). - 2.12 TR-181i2a12
AutoUpdateServer string​(256) string​(256) W The server the CPE can check to see if an update is available for direct download to it. - 2.12 TR-181i2a12
UserUpdateServer string​(256) string​(256) W The server where a user can check via a web browser if an update is available for download to a PC. - 2.12 TR-181i2a12
AvailableLanguages string​(256)​[] list​(256) of string - Comma-separated list (maximum number of characters 256) of strings. List items represent user-interface languages that are available, where each language is specified according to [RFC3066]. - 2.12 TR-181i2a12
CurrentLanguage string​(16) string​(16) W Current user-interface language, specified according to [RFC3066]. The value MUST be a member of the list reported by the AvailableLanguages parameter. - 2.12 TR-181i2a12
Device.​UserInterface.​RemoteAccess. object object​[1:1] -

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

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

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

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

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

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

Enables and displays the user information message.

The factory default value MUST be true.

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

Icon to be displayed. Enumeration of:

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

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

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

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

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

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
HigherLayer string​(256) string​(256) -

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

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

- 2.12 TR-181i2a12
LowerLayer string​(256) string​(256) -

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

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

- 2.12 TR-181i2a12
HigherAlias string​(64) string​(64) - The value of the Alias parameter for the interface object referenced by HigherLayer. - 2.12 TR-181i2a12
LowerAlias string​(64) string​(64) - The value of the Alias parameter for the interface object referenced by LowerLayer. - 2.12 TR-181i2a12
Device.​DSL. object object​[1:1] - This object models DSL lines, DSL channels, DSL bonding, and DSL diagnostics. The specific interface objects defined here are Line, Channel, and BondingGroup. Each Line models a layer 1 DSL Line interface, and each Channel models a layer 1 DSL Channel interface where multiple channels can run over a DSL line. In the case where bonding is configured, it is expected that BondingGroup is stacked above the Channel instances within its group. - 2.12 TR-181i2a12
LineNumberOfEntries unsignedInt unsignedInt - The number of entries in the Line table. - 2.12 TR-181i2a12
ChannelNumberOfEntries unsignedInt unsignedInt - The number of entries in the Channel table. - 2.12 TR-181i2a12
BondingGroupNumberOfEntries unsignedInt unsignedInt - The number of entries in the BondingGroup table. - 2.12 TR-181i2a12
Device.​DSL.​Line.​{i}. object​[0:] object​[0:∞] -

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

This table models physical DSL lines.

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

- 2.12 TR-181i2a12
Enable boolean boolean W

Enables or disables the DSL line.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.12 TR-181i2a12
EnableDataGathering boolean boolean W Enables or disables data gathering on the DSL line. - 2.12 TR-181i2a12
Status string string -

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

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

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

This parameter is based on ifOperStatus from [RFC2863].

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Name string​(64) string​(64) -

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.12 TR-181i2a12
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the DSL line entered its current operational state. - 2.12 TR-181i2a12
LowerLayers string​(1024)​[] list​(1024) of string W

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

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

- 2.12 TR-181i2a12
Upstream boolean boolean -

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

For example:

  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.12 TR-181i2a12
FirmwareVersion string​(64) string​(64) - A string identifying the version of the modem firmware currently installed for this interface. This is applicable only when the modem firmware is separable from the overall CPE software. - 2.12 TR-181i2a12
LinkStatus string string -

Status of the DSL physical link. Enumeration of:

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

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

- 2.12 TR-181i2a12
StandardsSupported string​[] list of string -

Note: In G.997.1, this parameter is called "xDSL Transmission system capabilities". See ITU-T Recommendation [G.997.1].
This parameter is DEPRECATED 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.
- 2.12 TR-181i2a12
XTSE hexBinary​(8:8) hexBinary​(8:8) -

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

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

- 2.12 TR-181i2a12
StandardUsed string string -
The value MUST be a member of the list reported by the StandardsSupported parameter. Indicates the standard that the Line instance is using for the connection.
Note: In G.997.1, this parameter is called "xDSL Transmission system". See ITU-T Recommendation [G.997.1].
This parameter is DEPRECATED 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.
- 2.12 TR-181i2a12
XTSUsed hexBinary​(8:8) hexBinary​(8:8) - This parameter indicates which DSL standard and recommendation are currently in use by the Line instance. Only one bit is set, as defined for the xTU transmission system enabling (XTSE) in ITU-T G.997.1. - 2.12 TR-181i2a12
LineEncoding string string -

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

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

- 2.12 TR-181i2a12
AllowedProfiles string​[] list of string -

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

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

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

- 2.12 TR-181i2a12
CurrentProfile string string -

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

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

- 2.12 TR-181i2a12
PowerManagementState string string -

The power management state of the line. Enumeration of:

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

- 2.12 TR-181i2a12
SuccessFailureCause unsignedInt​(0:6) unsignedInt​(0:6) -

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

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

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

- 2.12 TR-181i2a12
UPBOKLER unsignedInt​(0:1280) unsignedInt​(0:1280) -

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

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

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

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

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

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

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

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

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

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

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

- 2.12 TR-181i2a12
RXTHRSHds int​(-640:0) int​(-640:0) -

UPBO downstream receiver signal level threshold.

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

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

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

- 2.12 TR-181i2a12
ACTRAMODEds unsignedInt​(1:4) unsignedInt​(1:4) -

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

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

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

- 2.12 TR-181i2a12
ACTRAMODEus unsignedInt​(1:4) unsignedInt​(1:4) -

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

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

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

- 2.12 TR-181i2a12
ACTINPROCds unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
ACTINPROCus unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
SNRMROCds unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
SNRMROCus unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
LastStateTransmittedDownstream unsignedInt unsignedInt -

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

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

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

- 2.12 TR-181i2a12
LastStateTransmittedUpstream unsignedInt unsignedInt -

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

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

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

- 2.12 TR-181i2a12
UPBOKLE unsignedInt​(0:1280) unsignedInt​(0:1280) -

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

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

- 2.12 TR-181i2a12
MREFPSDds base64​(0:145) base64​(0:145) -

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

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

- 2.12 TR-181i2a12
MREFPSDus base64​(0:145) base64​(0:145) -

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

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

- 2.12 TR-181i2a12
LIMITMASK unsignedInt unsignedInt -

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

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

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

- 2.12 TR-181i2a12
US0MASK unsignedInt unsignedInt -

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

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

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

- 2.12 TR-181i2a12
TRELLISds int int -

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

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

- 2.12 TR-181i2a12
TRELLISus int int -

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

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

- 2.12 TR-181i2a12
ACTSNRMODEds unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
ACTSNRMODEus unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
VirtualNoisePSDds base64​(0:97) base64​(0:97) -

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

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

- 2.12 TR-181i2a12
VirtualNoisePSDus base64​(0:49) base64​(0:49) -

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

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

- 2.12 TR-181i2a12
ACTUALCE unsignedInt unsignedInt -

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

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

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

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

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

- 2.12 TR-181i2a12
DownstreamMaxBitRate unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
UpstreamNoiseMargin int int -

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

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

- 2.12 TR-181i2a12
DownstreamNoiseMargin int int -

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

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

- 2.12 TR-181i2a12
SNRMpbus string​(24)​[] list​(24) of string -

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

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

- 2.12 TR-181i2a12
SNRMpbds string​(24)​[] list​(24) of string -

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

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

- 2.12 TR-181i2a12
INMIATOds unsignedInt​(3:511) unsignedInt​(3:511) -

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

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

- 2.12 TR-181i2a12
INMIATSds unsignedInt​(0:7) unsignedInt​(0:7) -

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

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

- 2.12 TR-181i2a12
INMCCds unsignedInt​(0:64) unsignedInt​(0:64) -

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

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

- 2.12 TR-181i2a12
INMINPEQMODEds unsignedInt​(0:3) unsignedInt​(0:3) -

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

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

- 2.12 TR-181i2a12
UpstreamAttenuation int int -

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

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

- 2.12 TR-181i2a12
DownstreamAttenuation int int -

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

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

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

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

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

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

- 2.12 TR-181i2a12
XTURCountry hexBinary​(2:2) hexBinary​(2:2) -

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

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

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

- 2.12 TR-181i2a12
XTURANSIStd unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTURANSIRev unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTUCVendor hexBinary​(4:4) hexBinary​(4:4) -

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

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

- 2.12 TR-181i2a12
XTUCCountry hexBinary​(2:2) hexBinary​(2:2) -

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

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

- 2.12 TR-181i2a12
XTUCANSIStd unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTUCANSIRev unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
Device.​DSL.​Line.​{i}.​Stats. object object​[1:1] -

Throughput statistics for this interface.

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

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

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

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

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

- 2.12 TR-181i2a12
ShowtimeStart unsignedInt unsignedInt -

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

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

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

- 2.12 TR-181i2a12
LastShowtimeStart unsignedInt unsignedInt -

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

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

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

- 2.12 TR-181i2a12
CurrentDayStart unsignedInt unsignedInt -

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

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

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

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

- 2.12 TR-181i2a12
QuarterHourStart unsignedInt unsignedInt -

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

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

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

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

- 2.12 TR-181i2a12
Device.​DSL.​Line.​{i}.​Stats.​Total. object object​[1:1] -

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

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

- 2.12 TR-181i2a12
ErroredSecs unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
SeverelyErroredSecs unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
Device.​DSL.​Line.​{i}.​Stats.​Showtime. object object​[1:1] -

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

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

- 2.12 TR-181i2a12
ErroredSecs unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
SeverelyErroredSecs unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
Device.​DSL.​Line.​{i}.​Stats.​LastShowtime. object object​[1:1] -

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

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

- 2.12 TR-181i2a12
ErroredSecs unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
SeverelyErroredSecs unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
Device.​DSL.​Line.​{i}.​Stats.​CurrentDay. object object​[1:1] -

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

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

- 2.12 TR-181i2a12
ErroredSecs unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
SeverelyErroredSecs unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
Device.​DSL.​Line.​{i}.​Stats.​QuarterHour. object object​[1:1] -

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

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

- 2.12 TR-181i2a12
ErroredSecs unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
SeverelyErroredSecs unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
Device.​DSL.​Line.​{i}.​TestParams. object object​[1:1] - This object contains the DSL line test parameters that are available during the L0 (i.e., Showtime) state. - 2.12 TR-181i2a12
HLOGGds unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
HLOGGus unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
HLOGpsds string​(2559)​[] list​(2559) of string -

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

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

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

- 2.12 TR-181i2a12
HLOGpsus string​(2559)​[] list​(2559) of string -

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

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

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

- 2.12 TR-181i2a12
HLOGMTds unsignedInt unsignedInt -

Indicates the number of symbols over which HLOGpsds was measured.

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

- 2.12 TR-181i2a12
HLOGMTus unsignedInt unsignedInt -

Indicates the number of symbols over which HLOGpsus was measured.

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

- 2.12 TR-181i2a12
QLNGds unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
QLNGus unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
QLNpsds int​(2047)​[] list​(2047) of int -

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

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

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

- 2.12 TR-181i2a12
QLNpsus string​(2047)​[] list​(2047) of string -

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

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

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

- 2.12 TR-181i2a12
QLNMTds unsignedInt unsignedInt -

Indicates the number of symbols over which QLNpsds was measured.

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

- 2.12 TR-181i2a12
QLNMTus unsignedInt unsignedInt -

Indicates the number of symbols over which QLNpsus was measured.

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

- 2.12 TR-181i2a12
SNRGds unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
SNRGus unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
SNRpsds int​(2047)​[] list​(2047) of int -

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

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

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

- 2.12 TR-181i2a12
SNRpsus string​(2047)​[] list​(2047) of string -

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

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

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

- 2.12 TR-181i2a12
SNRMTds unsignedInt unsignedInt -

Indicates the number of symbols over which SNRpsds was measured.

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

- 2.12 TR-181i2a12
SNRMTus unsignedInt unsignedInt -

Indicates the number of symbols over which SNRpsus was measured.

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

- 2.12 TR-181i2a12
LATNds string​(35)​[] list​(35) of string -

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

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

- 2.12 TR-181i2a12
LATNus string​(35)​[] list​(35) of string -

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

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

- 2.12 TR-181i2a12
SATNds string​(35)​[] list​(35) of string -

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

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

- 2.12 TR-181i2a12
SATNus string​(35)​[] list​(35) of string -

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

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

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

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

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

- 2.12 TR-181i2a12
LoggingDepthR unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
ActLoggingDepthReportingR unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
EventTraceBufferR string​(256) string​(256) -

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

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

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

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

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

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

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

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

- 2.12 TR-181i2a12
Enable boolean boolean W

Enables or disables the channel.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.12 TR-181i2a12
Status string string -

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

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

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

This parameter is based on ifOperStatus from [RFC2863].

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Name string​(64) string​(64) -

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.12 TR-181i2a12
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the channel entered its current operational state. - 2.12 TR-181i2a12
LowerLayers string​(1024)​[] list​(1024) of string - Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2]. - 2.12 TR-181i2a12
LinkEncapsulationSupported string​[] list of string -

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

- 2.12 TR-181i2a12
LinkEncapsulationUsed string string -

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

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

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

- 2.12 TR-181i2a12
LPATH unsignedInt​(:3) unsignedInt​(:3) -

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

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

- 2.12 TR-181i2a12
INTLVDEPTH unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
INTLVBLOCK int int -

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

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

- 2.12 TR-181i2a12
ActualInterleavingDelay unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
ACTINP int int -

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

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

- 2.12 TR-181i2a12
INPREPORT boolean boolean -

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

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

- 2.12 TR-181i2a12
NFEC int int -

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

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

- 2.12 TR-181i2a12
RFEC int int -

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

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

- 2.12 TR-181i2a12
LSYMB int int -

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

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

- 2.12 TR-181i2a12
UpstreamCurrRate unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
DownstreamCurrRate unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
ACTNDR unsignedInt unsignedInt -

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

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

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

- 2.12 TR-181i2a12
ACTINPREIN unsignedInt​(0:255) unsignedInt​(0:255) -

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

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

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

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

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

- 2.12 TR-181i2a12
Device.​DSL.​Channel.​{i}.​Stats. object object​[1:1] -

Throughput statistics for this interface.

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

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

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

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

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

- 2.12 TR-181i2a12
ShowtimeStart unsignedInt unsignedInt -

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

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

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

- 2.12 TR-181i2a12
LastShowtimeStart unsignedInt unsignedInt -

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

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

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

- 2.12 TR-181i2a12
CurrentDayStart unsignedInt unsignedInt -

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

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

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

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

- 2.12 TR-181i2a12
QuarterHourStart unsignedInt unsignedInt -

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

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

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

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

- 2.12 TR-181i2a12
Device.​DSL.​Channel.​{i}.​Stats.​Total. object object​[1:1] -

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

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

- 2.12 TR-181i2a12
XTURFECErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTUCFECErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTURHECErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTUCHECErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTURCRCErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTUCCRCErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
Device.​DSL.​Channel.​{i}.​Stats.​Showtime. object object​[1:1] -

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

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

- 2.12 TR-181i2a12
XTURFECErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTUCFECErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTURHECErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTUCHECErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTURCRCErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTUCCRCErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
Device.​DSL.​Channel.​{i}.​Stats.​LastShowtime. object object​[1:1] -

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

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

- 2.12 TR-181i2a12
XTURFECErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTUCFECErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTURHECErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTUCHECErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTURCRCErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTUCCRCErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
Device.​DSL.​Channel.​{i}.​Stats.​CurrentDay. object object​[1:1] -

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

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

- 2.12 TR-181i2a12
XTURFECErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTUCFECErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTURHECErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTUCHECErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTURCRCErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTUCCRCErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
Device.​DSL.​Channel.​{i}.​Stats.​QuarterHour. object object​[1:1] -

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

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

- 2.12 TR-181i2a12
XTURFECErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTUCFECErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTURHECErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTUCHECErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTURCRCErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
XTUCCRCErrors unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
Device.​DSL.​BondingGroup.​{i}. object​[0:] object​[0:∞] -

DSL bonding group table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each instance is a bonding group, and is expected to be stacked above a DSL.Channel instance or a FAST.Line instance for each bonded channel in the group.

Many of the parameters within this object, including LowerLayers, are read-only because bonding is not expected to be configured via [TR-069].

The DSL bonding data model is closely aligned with [TR-159]. Corresponds to [TR-159] oBondingGroup.

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

- 2.12 TR-181i2a12
Enable boolean boolean W

Enables or disables the bonding group.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.12 TR-181i2a12
Status string string -

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

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

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

This parameter is based on ifOperStatus from [RFC2863].

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Name string​(64) string​(64) -

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.12 TR-181i2a12
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the bonding group entered its current operational state. - 2.12 TR-181i2a12
LowerLayers string​(1024)​[] list​(1024) of string -

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

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

- 2.12 TR-181i2a12
GroupStatus string​[] list of string -

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

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

Corresponds to [TR-159] oBondingGroup.aGroupStatus.

- 2.12 TR-181i2a12
GroupID unsignedInt unsignedInt - DSL bonding group ID. Corresponds to [TR-159] oBondingGroup.aGroupID. - 2.12 TR-181i2a12
BondSchemesSupported string​[] list of string -

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

Corresponds to [TR-159] oBondingGroup.aGroupBondSchemesSupported.

- 2.12 TR-181i2a12
BondScheme string string - The value MUST be a member of the list reported by the BondSchemesSupported parameter. Currently operating bonding scheme. Corresponds to [TR-159] aGroupOperBondScheme. - 2.12 TR-181i2a12
GroupCapacity unsignedInt​(1:32) unsignedInt​(1:32) - DSL bonding group capacity, i.e. the maximum number of channels that can be bonded in this group. Corresponds to [TR-159] oBondingGroup.aGroupCapacity. - 2.12 TR-181i2a12
RunningTime unsignedInt unsignedInt - The accumulated time in seconds for which this bonding group has been operationally up. Corresponds to [Section 11.4.2/G.998.1] Group Running Time. - 2.12 TR-181i2a12
TargetUpRate unsignedInt unsignedInt - Desired upstream data rate in bits per second for this DSL bonding group (zero indicates best effort). Corresponds to [TR-159] oBondingGroup.aGroupTargetUpRate. - 2.12 TR-181i2a12
TargetDownRate unsignedInt unsignedInt - Desired downstream data rate in bits per second for DSL bonding group (zero indicates best effort). Corresponds to [TR-159] oBondingGroup.aGroupTargetDownRate. - 2.12 TR-181i2a12
ThreshLowUpRate unsignedInt unsignedInt - Threshold upstream data rate in bits per second for this DSL bonding group. GroupStatus will include LowRate whenever the upstream rate is less than this threshold. Corresponds to [TR-159] oBondingGroup.aGroupThreshLowUpRate. - 2.12 TR-181i2a12
ThreshLowDownRate unsignedInt unsignedInt - Threshold downstream data rate in bits per second for this DSL bonding group. GroupStatus will include LowRate whenever the downstream rate is less than this threshold. Corresponds to [TR-159] oBondingGroup.aGroupThreshLowDownRate. - 2.12 TR-181i2a12
UpstreamDifferentialDelayTolerance unsignedInt unsignedInt - The maximum upstream differential delay in milliseconds among member links in a bonding group. Corresponds to [Section 11.4.1/G.998.1] Differential Delay Tolerance. - 2.12 TR-181i2a12
DownstreamDifferentialDelayTolerance unsignedInt unsignedInt - The maximum downstream differential delay in milliseconds among member links in a bonding group. Corresponds to [Section 11.4.1/G.998.1] Differential Delay Tolerance. - 2.12 TR-181i2a12
BondedChannelNumberOfEntries unsignedInt​(1:32) unsignedInt​(1:32) - The number of entries in the BondedChannel table. Corresponds to [TR-159] oBondingGroup.aGroupNumChannels. - 2.12 TR-181i2a12
Device.​DSL.​BondingGroup.​{i}.​BondedChannel.​{i}. object​[0:] object​[0:∞] -

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

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

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

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Channel string​(256) string​(256) -

The value MUST be the Path Name of a row in the DSL.Channel or FAST.Line tables. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is the channel that is being bonded.

This is read-only because bonding is expected to be configured by the CPE, not by the ACS.

- 2.12 TR-181i2a12
Device.​DSL.​BondingGroup.​{i}.​BondedChannel.​{i}.​Ethernet. object object​[1:1] -

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

This object MUST be present if, and only if, BondScheme is Ethernet.

- 2.12 TR-181i2a12
Device.​DSL.​BondingGroup.​{i}.​BondedChannel.​{i}.​Ethernet.​Stats. object object​[1:1] -

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

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

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

- 2.12 TR-181i2a12
UnderflowErrorsSent unsignedInt unsignedInt - Number of underflow errors sent, i.e. on the transmit side of the interface. - 2.12 TR-181i2a12
CRCErrorsReceived unsignedInt unsignedInt - Number of CRC errors received, i.e. on the receive side of the interface. - 2.12 TR-181i2a12
AlignmentErrorsReceived unsignedInt unsignedInt - Number of alignment errors received, i.e. on the receive side of the interface. - 2.12 TR-181i2a12
ShortPacketsReceived unsignedInt unsignedInt - Number of short packets received, i.e. on the receive side of the interface. - 2.12 TR-181i2a12
LongPacketsReceived unsignedInt unsignedInt - Number of long packets received, i.e. on the receive side of the interface. - 2.12 TR-181i2a12
OverflowErrorsReceived unsignedInt unsignedInt - Number of overflow errors received, i.e. on the receive side of the interface. - 2.12 TR-181i2a12
PauseFramesReceived unsignedInt unsignedInt - Number of pause frames received, i.e. on the receive side of the interface. - 2.12 TR-181i2a12
FramesDropped unsignedInt unsignedInt - Number of frames dropped, e.g. because the receive queue is full. - 2.12 TR-181i2a12
Device.​DSL.​BondingGroup.​{i}.​Stats. object object​[1:1] -

Throughput statistics for this interface.

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

- 2.12 TR-181i2a12
BytesSent unsignedLong unsignedLong - The total number of bytes transmitted out of the interface, including framing characters. - 2.12 TR-181i2a12
BytesReceived unsignedLong unsignedLong - The total number of bytes received on the interface, including framing characters. - 2.12 TR-181i2a12
PacketsSent unsignedLong unsignedLong - The total number of packets transmitted out of the interface. - 2.12 TR-181i2a12
PacketsReceived unsignedLong unsignedLong - The total number of packets received on the interface. - 2.12 TR-181i2a12
ErrorsSent unsignedInt unsignedInt - The total number of outbound packets that could not be transmitted because of errors. - 2.12 TR-181i2a12
ErrorsReceived unsignedInt unsignedInt - The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.12 TR-181i2a12
UnicastPacketsSent unsignedLong unsignedLong - The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.12 TR-181i2a12
UnicastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.12 TR-181i2a12
DiscardPacketsSent unsignedInt unsignedInt - The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.12 TR-181i2a12
DiscardPacketsReceived unsignedInt unsignedInt - The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.12 TR-181i2a12
MulticastPacketsSent unsignedLong unsignedLong - The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.12 TR-181i2a12
MulticastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.12 TR-181i2a12
BroadcastPacketsSent unsignedLong unsignedLong - The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.12 TR-181i2a12
BroadcastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.12 TR-181i2a12
UnknownProtoPacketsReceived unsignedInt unsignedInt - The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.12 TR-181i2a12
TotalStart unsignedInt unsignedInt -

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

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

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

- 2.12 TR-181i2a12
CurrentDayStart unsignedInt unsignedInt -

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

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

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

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

- 2.12 TR-181i2a12
QuarterHourStart unsignedInt unsignedInt -

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

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

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

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

- 2.12 TR-181i2a12
Device.​DSL.​BondingGroup.​{i}.​Stats.​Total. object object​[1:1] -

Total statistics for this bonding group.

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

- 2.12 TR-181i2a12
FailureReasons string​[] list of string -

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

Corresponds to [Section 11.4.3/G.998.1] Current Group Failure Reason.

- 2.12 TR-181i2a12
UpstreamRate unsignedInt unsignedInt - The achieved upstream data rate in bits per second (which might change subject to dynamic link usage conditions). Corresponds to [Section 11.4.2/G.998.1] Achieved Aggregate Data Rate. - 2.12 TR-181i2a12
DownstreamRate unsignedInt unsignedInt - The achieved downstream data rate in bits per second (which might change subject to dynamic link usage conditions). Corresponds to [Section 11.4.2/G.998.1] Achieved Aggregate Data Rate. - 2.12 TR-181i2a12
UpstreamPacketLoss unsignedInt unsignedInt - The total number of upstream packets that were lost at aggregation output from a bonding group during the accumulation period. Corresponds to [Section 11.4.2/G.998.1] Group Rx Cell Loss Count. - 2.12 TR-181i2a12
DownstreamPacketLoss unsignedInt unsignedInt - The total number of downstream packets that were lost at aggregation output from a bonding group during the accumulation period. Corresponds to [Section 11.4.2/G.998.1] Group Rx Cell Loss Count. - 2.12 TR-181i2a12
UpstreamDifferentialDelay unsignedInt unsignedInt - The achieved upstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.12 TR-181i2a12
DownstreamDifferentialDelay unsignedInt unsignedInt - The achieved downstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.12 TR-181i2a12
FailureCount unsignedInt unsignedInt - The number of times that the group was declared Unavailable during the accumulation period. Corresponds to [Section 11.4.3/G.998.1] Group Failure Count. - 2.12 TR-181i2a12
ErroredSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared Errored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**ES. - 2.12 TR-181i2a12
SeverelyErroredSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared SeverelyErrored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**SES. - 2.12 TR-181i2a12
UnavailableSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared Unavailable during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**UAS. - 2.12 TR-181i2a12
Device.​DSL.​BondingGroup.​{i}.​Stats.​CurrentDay. object object​[1:1] -

Current day statistics for this bonding group.

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

- 2.12 TR-181i2a12
FailureReasons string​[] list of string -

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

Corresponds to [Section 11.4.3/G.998.1] Current Group Failure Reason.

- 2.12 TR-181i2a12
UpstreamRate unsignedInt unsignedInt - The achieved upstream data rate in bits per second (which might change subject to dynamic link usage conditions). Corresponds to [Section 11.4.2/G.998.1] Achieved Aggregate Data Rate. - 2.12 TR-181i2a12
DownstreamRate unsignedInt unsignedInt - The achieved downstream data rate in bits per second (which might change subject to dynamic link usage conditions). Corresponds to [Section 11.4.2/G.998.1] Achieved Aggregate Data Rate. - 2.12 TR-181i2a12
UpstreamPacketLoss unsignedInt unsignedInt - The total number of upstream packets that were lost at aggregation output from a bonding group during the accumulation period. Corresponds to [Section 11.4.2/G.998.1] Group Rx Cell Loss Count. - 2.12 TR-181i2a12
DownstreamPacketLoss unsignedInt unsignedInt - The total number of downstream packets that were lost at aggregation output from a bonding group during the accumulation period. Corresponds to [Section 11.4.2/G.998.1] Group Rx Cell Loss Count. - 2.12 TR-181i2a12
UpstreamDifferentialDelay unsignedInt unsignedInt - The achieved upstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.12 TR-181i2a12
DownstreamDifferentialDelay unsignedInt unsignedInt - The achieved downstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.12 TR-181i2a12
FailureCount unsignedInt unsignedInt - The number of times that the group was declared Unavailable during the accumulation period. Corresponds to [Section 11.4.3/G.998.1] Group Failure Count. - 2.12 TR-181i2a12
ErroredSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared Errored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**ES. - 2.12 TR-181i2a12
SeverelyErroredSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared SeverelyErrored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**SES. - 2.12 TR-181i2a12
UnavailableSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared Unavailable during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**UAS. - 2.12 TR-181i2a12
Device.​DSL.​BondingGroup.​{i}.​Stats.​QuarterHour. object object​[1:1] -

Current quarter hour statistics for this bonding group.

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

- 2.12 TR-181i2a12
FailureReasons string​[] list of string -

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

Corresponds to [Section 11.4.3/G.998.1] Current Group Failure Reason.

- 2.12 TR-181i2a12
UpstreamRate unsignedInt unsignedInt - The achieved upstream data rate in bits per second (which might change subject to dynamic link usage conditions). Corresponds to [Section 11.4.2/G.998.1] Achieved Aggregate Data Rate. - 2.12 TR-181i2a12
DownstreamRate unsignedInt unsignedInt - The achieved downstream data rate in bits per second (which might change subject to dynamic link usage conditions). Corresponds to [Section 11.4.2/G.998.1] Achieved Aggregate Data Rate. - 2.12 TR-181i2a12
UpstreamPacketLoss unsignedInt unsignedInt - The total number of upstream packets that were lost at aggregation output from a bonding group during the accumulation period. Corresponds to [Section 11.4.2/G.998.1] Group Rx Cell Loss Count. - 2.12 TR-181i2a12
DownstreamPacketLoss unsignedInt unsignedInt - The total number of downstream packets that were lost at aggregation output from a bonding group during the accumulation period. Corresponds to [Section 11.4.2/G.998.1] Group Rx Cell Loss Count. - 2.12 TR-181i2a12
UpstreamDifferentialDelay unsignedInt unsignedInt - The achieved upstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.12 TR-181i2a12
DownstreamDifferentialDelay unsignedInt unsignedInt - The achieved downstream differential delay in milliseconds (which might change subject to dynamic link usage conditions). - 2.12 TR-181i2a12
FailureCount unsignedInt unsignedInt - The number of times that the group was declared Unavailable during the accumulation period. Corresponds to [Section 11.4.3/G.998.1] Group Failure Count. - 2.12 TR-181i2a12
ErroredSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared Errored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**ES. - 2.12 TR-181i2a12
SeverelyErroredSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared SeverelyErrored during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**SES. - 2.12 TR-181i2a12
UnavailableSeconds unsignedInt unsignedInt - The time in seconds during which the group was declared Unavailable during the accumulation period. Corresponds to [TR-159] oBondingGroup.aGroupPerf**UAS. - 2.12 TR-181i2a12
Device.​DSL.​BondingGroup.​{i}.​Ethernet. object​[0:1] object​[0:1] -

Ethernet-based bonding parameters [G.998.2].

This object MUST be present if, and only if, BondScheme is Ethernet.

- 2.12 TR-181i2a12
Device.​DSL.​BondingGroup.​{i}.​Ethernet.​Stats. object object​[1:1] -

[G.998.2] Ethernet-based bonding statistics.

These relate to the [G.998.2] PME (Physical Medium Entity) Aggregation Function (PAF) and to its upper layer interface. PAF lower layer interface statistics are in the BondedChannel.{i}.Ethernet.Stats objects.

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

- 2.12 TR-181i2a12
PAFErrors unsignedInt unsignedInt - Number of PAF errors. Corresponds to [TR-159] oBondETH.aEthRxErrors. - 2.12 TR-181i2a12
PAFSmallFragments unsignedInt unsignedInt - Number of PAF Small Fragment events. Corresponds to [TR-159] oBondETH.aEthRxSmallFragments. - 2.12 TR-181i2a12
PAFLargeFragments unsignedInt unsignedInt - Number of PAF Large Fragment events. Corresponds to [TR-159] oBondETH.aEthRxLargeFragments. - 2.12 TR-181i2a12
PAFBadFragments unsignedInt unsignedInt - Number of PAF Bad Fragment events. Corresponds to [TR-159] oBondETH.aEthRxBadFragments. - 2.12 TR-181i2a12
PAFLostFragments unsignedInt unsignedInt - Number of PAF Lost Fragment events. Corresponds to [TR-159] oBondETH.aEthRxLostFragments. - 2.12 TR-181i2a12
PAFLateFragments unsignedInt unsignedInt - Number of PAF Late Fragment events. - 2.12 TR-181i2a12
PAFLostStarts unsignedInt unsignedInt - Number of PAF Lost Start events. Corresponds to [TR-159] oBondETH.aEthRxLostStarts. - 2.12 TR-181i2a12
PAFLostEnds unsignedInt unsignedInt - Number of PAF Lost End events. Corresponds to [TR-159] oBondETH.aEthRxLostEnds. - 2.12 TR-181i2a12
PAFOverflows unsignedInt unsignedInt - Number of PAF Overflow events. Corresponds to [TR-159] oBondETH.aEthRxOverflows. - 2.12 TR-181i2a12
PauseFramesSent unsignedInt unsignedInt - Number of pause frames sent, i.e. on the transmit side of the interface. - 2.12 TR-181i2a12
CRCErrorsReceived unsignedInt unsignedInt - Number of CRC errors received, i.e. on the receive side of the interface. - 2.12 TR-181i2a12
AlignmentErrorsReceived unsignedInt unsignedInt - Number of alignment errors received, i.e. on the receive side of the interface. - 2.12 TR-181i2a12
ShortPacketsReceived unsignedInt unsignedInt - Number of short packets received, i.e. on the receive side of the interface. - 2.12 TR-181i2a12
LongPacketsReceived unsignedInt unsignedInt - Number of long packets received, i.e. on the receive side of the interface. - 2.12 TR-181i2a12
OverflowErrorsReceived unsignedInt unsignedInt - Number of overflow errors received, i.e. on the receive side of the interface. - 2.12 TR-181i2a12
FramesDropped unsignedInt unsignedInt - Number of frames dropped, e.g. because the receive queue is full. - 2.12 TR-181i2a12
Device.​DSL.​Diagnostics. object object​[1:1] - The DSL Diagnostics object. - 2.12 TR-181i2a12
ADSLLineTest​() command object - [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 TR-181i2a12
⇒ Input. arguments object - Input arguments. -
⇒ Interface string​(256) string​(256) W [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 TR-181i2a12
⇐ Output. arguments object - Output arguments. -
⇐ ACTPSDds int int -

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

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

- 2.12 TR-181i2a12
⇐ ACTPSDus int int -

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

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

- 2.12 TR-181i2a12
⇐ ACTATPds int int -

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

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

- 2.12 TR-181i2a12
⇐ ACTATPus int int -

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

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

- 2.12 TR-181i2a12
⇐ HLINSCds int int -

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

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

- 2.12 TR-181i2a12
⇐ HLINSCus int int -

Scaling used to represent the upstream linear channel characteristics. Interpretation of the value is as defined in ITU-T Rec. G.997.1.

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

- 2.12 TR-181i2a12
⇐ HLINGds unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
⇐ HLINGus unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
⇐ HLOGGds unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
⇐ HLOGGus unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
⇐ HLOGpsds string​(2559)​[] list​(2559) of string -

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

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

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

- 2.12 TR-181i2a12
⇐ HLOGpsus string​(2559)​[] list​(2559) of string -

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

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

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

- 2.12 TR-181i2a12
⇐ HLOGMTds unsignedInt unsignedInt -

Indicates the number of symbols over which HLOGpsds was measured.

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

- 2.12 TR-181i2a12
⇐ HLOGMTus unsignedInt unsignedInt -

Indicates the number of symbols over which HLOGpsus was measured.

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

- 2.12 TR-181i2a12
⇐ LATNpbds string​(24)​[] list​(24) of string -

Comma-separated list (maximum number of characters 24) of strings. List items represent downstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of LATNpbds is as defined in ITU-T Rec. G.997.1.

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

- 2.12 TR-181i2a12
⇐ LATNpbus string​(24)​[] list​(24) of string -

Comma-separated list (maximum number of characters 24) of strings. List items represent upstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of upstream bands but will exceed one only for G.993.2. Interpretation of LATNpbus is as defined in ITU-T Rec. G.997.1.

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

- 2.12 TR-181i2a12
⇐ SATNds string​(24)​[] list​(24) of string -

Comma-separated list (maximum number of characters 24) of strings. List items represent downstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNds is as defined in ITU-T Rec. G.997.1.

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

- 2.12 TR-181i2a12
⇐ SATNus string​(24)​[] list​(24) of string -

Comma-separated list (maximum number of characters 24) of strings. List items represent upstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNus is as defined in ITU-T Rec. G.997.1.

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

- 2.12 TR-181i2a12
⇐ HLINpsds int​(61430)​[] list​(61430) of int -

Comma-separated list (maximum number of characters 61430) of integers. List items represent downstream linear channel characteristics per subcarrier group. Maximum number of complex pairs is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of pairs will depend on the value of HLINGds but will not exceed 512. Interpretation of the value is as defined in ITU-T Rec. G.997.1.

Note: HLIN is not applicable in PLOAM for G.992.1 or G.992.2.

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

- 2.12 TR-181i2a12
⇐ HLINpsus string​(61430)​[] list​(61430) of string -

Comma-separated list (maximum number of characters 61430) of strings. List items represent upstream linear channel characteristics per sub-carrier group. Maximum number of complex pairs is 64 for G.992.3, and G.992.5. For G.993.2, the number of pairs will depend on the value of HLINGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1.

Note: HLIN is not applicable in PLOAM for G.992.1 or G.992.2.

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

- 2.12 TR-181i2a12
⇐ QLNGds unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
⇐ QLNGus unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
⇐ QLNpsds int​(61430)​[] list​(61430) of int -

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

Note: QLN is not applicable in PLOAM for G.992.1 or G.992.2.

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

- 2.12 TR-181i2a12
⇐ QLNpsus string​(61430)​[] list​(61430) of string -

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

Note: QLN is not applicable in PLOAM for G.992.1 or G.992.2.

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

- 2.12 TR-181i2a12
⇐ QLNMTds unsignedInt unsignedInt -

Indicates the number of symbols over which QLNpsds was measured.

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

- 2.12 TR-181i2a12
⇐ QLNMTus unsignedInt unsignedInt -

Indicates the number of symbols over which QLNpsus was measured.

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

- 2.12 TR-181i2a12
⇐ SNRGds unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
⇐ SNRGus unsignedInt unsignedInt -

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

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

- 2.12 TR-181i2a12
⇐ SNRpsds int​(61430)​[] list​(61430) of int -

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

Note: SNRps is not applicable in PLOAM for G.992.1 or G.992.2.

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

- 2.12 TR-181i2a12
⇐ SNRpsus string​(61430)​[] list​(61430) of string -

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

Note: SNRps is not applicable in PLOAM for G.992.1 or G.992.2.

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

- 2.12 TR-181i2a12
⇐ SNRMTds unsignedInt unsignedInt -

Indicates the number of symbols over which SNRpsds was measured.

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

- 2.12 TR-181i2a12
⇐ SNRMTus unsignedInt unsignedInt -

Indicates the number of symbols over which SNRpsus was measured.

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

- 2.12 TR-181i2a12
⇐ BITSpsds int​(61430)​[] list​(61430) of int - Comma-separated list (maximum number of characters 61430) of integers. List items represent downstream bit allocation per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. Interpretation of the value is as defined in ITU-T Rec. [G.997.1]. - 2.12 TR-181i2a12
⇐ BITSpsus string​(61430)​[] list​(61430) of string - Comma-separated list (maximum number of characters 61430) of strings. List items represent upstream bit allocation per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. Interpretation of the value is as defined in ITU-T Rec. [G.997.1]. - 2.12 TR-181i2a12
Device.​FAST. object object​[1:1] - This object models FAST (defined in ITU Recommendation [G.9701]) lines. Each Line models a layer 1 FAST Line interface. - 2.12 TR-181i2a12
LineNumberOfEntries unsignedInt unsignedInt - The number of entries in the Line table. - 2.12 TR-181i2a12
Device.​FAST.​Line.​{i}. object​[0:] object​[0:∞] -

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

This table models physical FAST lines.

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

- 2.12 TR-181i2a12
Enable boolean boolean W Enables or disables the FAST line. This parameter is based on ifAdminStatus from [RFC2863]. - 2.12 TR-181i2a12
Status string string -

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

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

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

This parameter is based on ifOperStatus from [RFC2863].

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Name string​(64) string​(64) -

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.12 TR-181i2a12
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the FAST line entered its current operational state. - 2.12 TR-181i2a12
LowerLayers string​(1024)​[] list​(1024) of string W

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

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

- 2.12 TR-181i2a12
Upstream boolean boolean -

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

For example:

  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces.
- 2.12 TR-181i2a12
FirmwareVersion string​(64) string​(64) - A string identifying the version of the modem firmware currently installed for this interface. This is applicable only when the modem firmware is separable from the overall CPE software. - 2.12 TR-181i2a12
LinkStatus string string -

Status of the FAST physical link. Enumeration of:

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

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

- 2.12 TR-181i2a12
AllowedProfiles string​[] list of string -

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

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

- 2.12 TR-181i2a12
CurrentProfile string string - The value MUST be a member of the list reported by the AllowedProfiles parameter, or else be an empty string. Indicates which FAST profile is currently in use on the line. - 2.12 TR-181i2a12
PowerManagementState string string -

The power management state of the line. Enumeration of:

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

- 2.12 TR-181i2a12
SuccessFailureCause unsignedInt​(0:5) unsignedInt​(0:5) -

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

  • 0: Successful
  • 1: Configuration error. Configuration error. This error occurs if the line cannot reach L0 state due to a mismatch of configuration and FTU capabilities.
  • 2: Configuration not feasible on the line. This error occurs if the line cannot reach the L0 state due to a mismatch of configuration of line and noise characteristics.
  • 3: Communication problem. This error occurs, for example, due to corrupted messages or bad syntax messages or if no common mode can be selected in the G.994.1 handshaking procedure or due to a timeout.
  • 4: No far-end FTU detected. This error occurs if the far-end FTU is not powered or not connected or if the line is too long to allow detection of a far-end FTU.
  • 5: Any other or unknown initialization failure cause.

Note: In G.997.2, this parameter is called "Initialization success/failure cause". See Clause 7.20.2.1 of ITU-T

Recommendation [G.997.2].

- 2.12 TR-181i2a12
UPBOKLER unsignedInt​(0:1280) unsignedInt​(0:1280) -

This parameter reports the estimate of the electrical length expressed in 0.1 dB, as determined by the FTU-R (see clause 7.3.1.4.2.1/[G.9701]) and conveyed in the R-MSG1 initialization message (see clause 12.3.3.2.3/[G.9701]). The value is coded as an unsignedInt in the range 0 (coded as 0) to 128 dB (coded as 1280) in steps of 0.1 dB.

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

- 2.12 TR-181i2a12
LastTransmittedDownstreamSignal unsignedInt​(0:21) unsignedInt​(0:21) -

This parameter reports the downstream signal count of the last transmitted initialization signal in the last full or short initialization performed on the line. The valid values are 0..21. The downstream signal count is defined in clause 12.3.1/[G.9701].

Note: See clause 7.10.2.2 ITU-T Recommendation [G.997.2].

- 2.12 TR-181i2a12
LastTransmittedUpstreamSignal unsignedInt​(0:21) unsignedInt​(0:21) -

This parameter reports the upstream signal count of the last transmitted initialization signal in the last full or short initialization performed on the line. The valid values are 0..21. The upstream signal count is defined in clause 12.3.1/[G.9701].

Note: See clause 7.10.2.3 ITU-T Recommendation [G.997.2].

- 2.12 TR-181i2a12
UPBOKLE unsignedInt​(0:1280) unsignedInt​(0:1280) -

This parameter reports the electrical length that would have been sent from the FTU-O to the FTU-R if the electrical length was not forced by the DPU-MIB. If the electrical length is not forced by the DPU-MIB, then this object reports the final electrical length, as determined by the FTU-O (see clause 7.3.1.4.2.1/[G.9701]) and conveyed in the O-UPDATE initialization message (see clause 12.3.3.2.4/[G.9701]).

Note: See clause 7.10.4.1 in ITU-T Recommendation [G.997.2].

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

This parameter reports the attainable net data rate expressed in Kbps as defined in clause 11.4.1.1.2/[G.9701].

Note: This parameter is related to the G.997.2 parameter ATTNDRus. See clause 7.11.2.1 ITU-T Recommendation [G.997.2].

- 2.12 TR-181i2a12
DownstreamMaxBitRate unsignedInt unsignedInt -

This parameter reports the attainable net data rate expressed in Kbps as defined in clause 11.4.1.1.2/[G.9701].

Note: This parameter is related to the G.997.2 parameter ATTNDRds. See clause 7.11.2.1 ITU-T Recommendation [G.997.2].

- 2.12 TR-181i2a12
UpstreamNoiseMargin int int -

This parameter reports the signal-to-noise ratio margin (as defined in clause 9.8.3.2/[G.9701] and 11.4.1.3/[G.9701]) in the upstream direction. A special value indicates that the signal-to-noise ratio margin is out of the range to be represented. The parameter is expressed in 0.1dB.

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

- 2.12 TR-181i2a12
DownstreamNoiseMargin int int -

This parameter reports the signal-to-noise ratio margin (as defined in clause 9.8.3.2/[G.9701] and 11.4.1.3/[G.9701]) in the upstream direction. A special value indicates that the signal-to-noise ratio margin is out of the range to be represented. The parameter is expressed in 0.1dB.

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

- 2.12 TR-181i2a12
UpstreamAttenuation int int - The current upstream signal loss (expressed in 0.1dB). - 2.12 TR-181i2a12
DownstreamAttenuation int int - The current downstream signal loss (expressed in 0.1dB). - 2.12 TR-181i2a12
UpstreamPower int int - The current output power at the CPE's FAST line (expressed in 0.1dBmV). - 2.12 TR-181i2a12
DownstreamPower int int - The current received power at the CPE's FAST line (expressed in 0.1dBmV). - 2.12 TR-181i2a12
SNRMRMCds int int - This parameter reports the signal-to-noise margin for the robust management channel (RMC) in the downstream direction (express in 0.1dB). A special value (-512) indicates that the signal-to-noise ratio margin for the RMC is out of the range to be represented. This parameter is defined in clauses 7.10.12.1 of ITU-T Recommendation [G.997.2]. - 2.12 TR-181i2a12
SNRMRMCus int int - This parameter reports the signal-to-noise margin for the robust management channel (RMC) in the upstream direction (express in 0.1dB). A special value (-512) indicates that the signal-to-noise ratio margin for the RMC is out of the range to be represented. This parameter is defined in clauses 7.10.12.2 of ITU-T Recommendation [G.997.2]. - 2.12 TR-181i2a12
BITSRMCpsds int​(4610)​[] list​(4610) of int - Comma-separated list (maximum number of characters 4610) of integers. List items report the bit allocation values on RMC sub-carriers in RMC symbols in the downstream direction. Each pair composes of a sub-carrier index from 0..4095 and an 8 bit allocation value. There are maximum 512 pairs. This parameter is defined in clause 7.10.12.3 of ITU-T Recommendation [G.997.2]. - 2.12 TR-181i2a12
BITSRMCpsus int​(4610)​[] list​(4610) of int - Comma-separated list (maximum number of characters 4610) of integers. List items report the bit allocation values on RMC sub-carriers in RMC symbols in the upstream direction. Each pair composes of a sub-carrier index from 0..4095 and an 8 bit allocation value. There are maximum 512 pairs. This parameter is defined in clause 7.10.12.4 of ITU-T Recommendation [G.997.2]. - 2.12 TR-181i2a12
FEXTCANCELds boolean boolean - This indicates whether FEXT cancellation in the downstream direction from all the other vectored lines into the line in the vectored group is enabled (TRUE) or disabled (FALSE). This parameter is defined as FEXT_TO_CANCEL_ENABLEds in clause 7.1.7.1 of ITU Recommendation [G.997.2]. - 2.12 TR-181i2a12
FEXTCANCELus boolean boolean - This indicates whether FEXT cancellation in the upstream direction from all the other vectored lines into the line in the vectored group is enabled (TRUE) or disabled (FALSE). This parameter is defined as FEXT_TO_CANCEL_ENABLEds in clause 7.1.7.1 of ITU Recommendation [G.997.2]. - 2.12 TR-181i2a12
ETRds unsignedInt unsignedInt - This parameter reports the expected throughput rate expressed in Kbps as defined in clause 7.11.1.2 of ITU-T Recommendation [G.997.2] - 2.12 TR-181i2a12
ETRus unsignedInt unsignedInt - This parameter reports the expected throughput rate expressed in Kbps as defined in clause 7.11.1.2 of ITU-T Recommendation [G.997.2] - 2.12 TR-181i2a12
ATTETRds unsignedInt unsignedInt - This parameter reports the attainable expected throughput expressed in Kbps as defined in clause 7.11.2.2 of ITU-T Recommendation [G.997.2] - 2.12 TR-181i2a12
ATTETRus unsignedInt unsignedInt - This parameter reports the attainable expected throughput expressed in Kbps as defined in clause 7.11.2.2 of ITU-T Recommendation [G.997.2] - 2.12 TR-181i2a12
MINEFTR unsignedInt unsignedInt - This parameter reports the minimum error free throughput value expressed in Kbps computed from power up as defined in clause 11.4.1.1.3 of ITU-T Recommendation [G.9701] - 2.12 TR-181i2a12
Device.​FAST.​Line.​{i}.​Stats. object object​[1:1] -

Throughput statistics for this interface.

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

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

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

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

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

- 2.12 TR-181i2a12
ShowtimeStart unsignedInt unsignedInt -

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

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

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

- 2.12 TR-181i2a12
LastShowtimeStart unsignedInt unsignedInt -

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

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

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

- 2.12 TR-181i2a12
CurrentDayStart unsignedInt unsignedInt -

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

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

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

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

- 2.12 TR-181i2a12
QuarterHourStart unsignedInt unsignedInt -

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

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

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

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

- 2.12 TR-181i2a12
Device.​FAST.​Line.​{i}.​Stats.​Total. object object​[1:1] -

This object contains DSL line total statistics.

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

- 2.12 TR-181i2a12
ErroredSecs unsignedInt unsignedInt - Total number of errored seconds as defined in ITU-T Rec. [G.997.2]. An errored second (ES) is declared if, during a 1-second interval, there are one or more crc anomalies, or one or more los defects, or one or more lor defects, or one or more lpr primitives. - 2.12 TR-181i2a12
SeverelyErroredSecs unsignedInt unsignedInt - Total number of severely errored seconds as defined in ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
LOSS unsignedInt unsignedInt - Total number of loss of signal seconds (LOSS) as defined in ITU-T Rec. [G.997.2]. A LOSS is declared if, during a 1-second interval, there are one or more los defects. - 2.12 TR-181i2a12
LORS unsignedInt unsignedInt - Total number of loss of RMC seconds (LORS) as defined in ITU-T Rec. [G.997.2]. A LORS is declared if, during a 1-second interval, there are one or more lor defects. - 2.12 TR-181i2a12
UAS unsignedInt unsignedInt - Total number of unavailable seconds (UAS) as defined in ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
RTXUC unsignedInt unsignedInt - This parameter reports a count of uncorrected DTU anomalies (rtx_uc). This parameter is defined in clause 7.8.5 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
RTXTX unsignedInt unsignedInt - This parameter reports a count of retransmitted DTU anomalies (rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessBSW unsignedInt unsignedInt - This parameter reports a count of the successful bit swap (BSW) primitives. This parameter is defined as success_BSW in clause 7.7.20 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessSRA unsignedInt unsignedInt - This parameter reports a count of the successful autonomous SRA (seamless rate adaptation) primitives. This parameter is defined as success_SRA in clause 7.7.21 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessFRA unsignedInt unsignedInt - This parameter reports a count of the successful FRA (fast rate adaptation) primitives. This parameter is defined as success_FRA in clause 7.7.22 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessRPA unsignedInt unsignedInt - This parameter reports a count of the successful RPA (RMC parameter adjustment) primitives. This parameter is defined as success_RPA in clause 7.7.23 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessTIGA unsignedInt unsignedInt - This parameter reports a count of the successful TIGA (transmitter initiated gain adjustment) primitives. This parameter is defined as success_TIGA in clause 7.7.24 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
Device.​FAST.​Line.​{i}.​Stats.​Showtime. object object​[1:1] -

This object contains FAST line statistics since the most recent showtime.

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

- 2.12 TR-181i2a12
ErroredSecs unsignedInt unsignedInt - Total number of errored seconds as defined in ITU-T Rec. [G.997.2]. An errored second (ES) is declared if, during a 1-second interval, there are one or more crc anomalies, or one or more los defects, or one or more lor defects, or one or more lpr primitives. - 2.12 TR-181i2a12
SeverelyErroredSecs unsignedInt unsignedInt - Total number of severely errored seconds as defined in ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
LOSS unsignedInt unsignedInt - Total number of loss of signal seconds (LOSS) as defined in ITU-T Rec. [G.997.2]. A LOSS is declared if, during a 1-second interval, there are one or more los defects. - 2.12 TR-181i2a12
LORS unsignedInt unsignedInt - Total number of loss of RMC seconds (LORS) as defined in ITU-T Rec. [G.997.2]. A LORS is declared if, during a 1-second interval, there are one or more lor defects. - 2.12 TR-181i2a12
UAS unsignedInt unsignedInt - Total number of unavailable seconds (UAS) as defined in ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
RTXUC unsignedInt unsignedInt - This parameter reports a count of uncorrected DTU anomalies (rtx_uc). This parameter is defined in clause 7.8.5 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
RTXTX unsignedInt unsignedInt - This parameter reports a count of retransmitted DTU anomalies (rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessBSW unsignedInt unsignedInt - This parameter reports a count of the successful bit swap (BSW) primitives. This parameter is defined as success_BSW in clause 7.7.20 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessSRA unsignedInt unsignedInt - This parameter reports a count of the successful autonomous SRA (seamless rate adaptation) primitives. This parameter is defined as success_SRA in clause 7.7.21 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessFRA unsignedInt unsignedInt - This parameter reports a count of the successful FRA (fast rate adaptation) primitives. This parameter is defined as success_FRA in clause 7.7.22 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessRPA unsignedInt unsignedInt - This parameter reports a count of the successful RPA (RMC parameter adjustment) primitives. This parameter is defined as success_RPA in clause 7.7.23 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessTIGA unsignedInt unsignedInt - This parameter reports a count of the successful TIGA (transmitter initiated gain adjustment) primitives. This parameter is defined as success_TIGA in clause 7.7.24 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
Device.​FAST.​Line.​{i}.​Stats.​LastShowtime. object object​[1:1] -

This object contains FAST line statistics since the second most recent showtime.

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

- 2.12 TR-181i2a12
ErroredSecs unsignedInt unsignedInt - Total number of errored seconds as defined in ITU-T Rec. [G.997.2]. An errored second (ES) is declared if, during a 1-second interval, there are one or more crc anomalies, or one or more los defects, or one or more lor defects, or one or more lpr primitives. - 2.12 TR-181i2a12
SeverelyErroredSecs unsignedInt unsignedInt - Total number of severely errored seconds as defined in ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
LOSS unsignedInt unsignedInt - Total number of loss of signal seconds (LOSS) as defined in ITU-T Rec. [G.997.2]. A LOSS is declared if, during a 1-second interval, there are one or more los defects. - 2.12 TR-181i2a12
LORS unsignedInt unsignedInt - Total number of loss of RMC seconds (LORS) as defined in ITU-T Rec. [G.997.2]. A LORS is declared if, during a 1-second interval, there are one or more lor defects. - 2.12 TR-181i2a12
UAS unsignedInt unsignedInt - Total number of unavailable seconds (UAS) as defined in ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
RTXUC unsignedInt unsignedInt - This parameter reports a count of uncorrected DTU anomalies (rtx_uc). This parameter is defined in clause 7.8.5 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
RTXTX unsignedInt unsignedInt - This parameter reports a count of retransmitted DTU anomalies (rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessBSW unsignedInt unsignedInt - This parameter reports a count of the successful bit swap (BSW) primitives. This parameter is defined as success_BSW in clause 7.7.20 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessSRA unsignedInt unsignedInt - This parameter reports a count of the successful autonomous SRA (seamless rate adaptation) primitives. This parameter is defined as success_SRA in clause 7.7.21 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessFRA unsignedInt unsignedInt - This parameter reports a count of the successful FRA (fast rate adaptation) primitives. This parameter is defined as success_FRA in clause 7.7.22 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessRPA unsignedInt unsignedInt - This parameter reports a count of the successful RPA (RMC parameter adjustment) primitives. This parameter is defined as success_RPA in clause 7.7.23 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessTIGA unsignedInt unsignedInt - This parameter reports a count of the successful TIGA (transmitter initiated gain adjustment) primitives. This parameter is defined as success_TIGA in clause 7.7.24 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
Device.​FAST.​Line.​{i}.​Stats.​CurrentDay. object object​[1:1] -

This object contains FAST line statistics accumulated during the current day.

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

- 2.12 TR-181i2a12
ErroredSecs unsignedInt unsignedInt - Total number of errored seconds as defined in ITU-T Rec. [G.997.2]. An errored second (ES) is declared if, during a 1-second interval, there are one or more crc anomalies, or one or more los defects, or one or more lor defects, or one or more lpr primitives. - 2.12 TR-181i2a12
SeverelyErroredSecs unsignedInt unsignedInt - Total number of severely errored seconds as defined in ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
LOSS unsignedInt unsignedInt - Total number of loss of signal seconds (LOSS) as defined in ITU-T Rec. [G.997.2]. A LOSS is declared if, during a 1-second interval, there are one or more los defects. - 2.12 TR-181i2a12
LORS unsignedInt unsignedInt - Total number of loss of RMC seconds (LORS) as defined in ITU-T Rec. [G.997.2]. A LORS is declared if, during a 1-second interval, there are one or more lor defects. - 2.12 TR-181i2a12
UAS unsignedInt unsignedInt - Total number of unavailable seconds (UAS) as defined in ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
RTXUC unsignedInt unsignedInt - This parameter reports a count of uncorrected DTU anomalies (rtx_uc). This parameter is defined in clause 7.8.5 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
RTXTX unsignedInt unsignedInt - This parameter reports a count of retransmitted DTU anomalies (rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessBSW unsignedInt unsignedInt - This parameter reports a count of the successful bit swap (BSW) primitives. This parameter is defined as success_BSW in clause 7.7.20 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessSRA unsignedInt unsignedInt - This parameter reports a count of the successful autonomous SRA (seamless rate adaptation) primitives. This parameter is defined as success_SRA in clause 7.7.21 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessFRA unsignedInt unsignedInt - This parameter reports a count of the successful FRA (fast rate adaptation) primitives. This parameter is defined as success_FRA in clause 7.7.22 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessRPA unsignedInt unsignedInt - This parameter reports a count of the successful RPA (RMC parameter adjustment) primitives. This parameter is defined as success_RPA in clause 7.7.23 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessTIGA unsignedInt unsignedInt - This parameter reports a count of the successful TIGA (transmitter initiated gain adjustment) primitives. This parameter is defined as success_TIGA in clause 7.7.24 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
Device.​FAST.​Line.​{i}.​Stats.​QuarterHour. object object​[1:1] -

This object contains FAST line statistics accumulated during the current quarter hour.

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

- 2.12 TR-181i2a12
ErroredSecs unsignedInt unsignedInt - Total number of errored seconds as defined in ITU-T Rec. [G.997.2]. An errored second (ES) is declared if, during a 1-second interval, there are one or more crc anomalies, or one or more los defects, or one or more lor defects, or one or more lpr primitives. - 2.12 TR-181i2a12
SeverelyErroredSecs unsignedInt unsignedInt - Total number of severely errored seconds as defined in ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
LOSS unsignedInt unsignedInt - Total number of loss of signal seconds (LOSS) as defined in ITU-T Rec. [G.997.2]. A LOSS is declared if, during a 1-second interval, there are one or more los defects. - 2.12 TR-181i2a12
LORS unsignedInt unsignedInt - Total number of loss of RMC seconds (LORS) as defined in ITU-T Rec. [G.997.2]. A LORS is declared if, during a 1-second interval, there are one or more lor defects. - 2.12 TR-181i2a12
UAS unsignedInt unsignedInt - Total number of unavailable seconds (UAS) as defined in ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
RTXUC unsignedInt unsignedInt - This parameter reports a count of uncorrected DTU anomalies (rtx_uc). This parameter is defined in clause 7.8.5 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
RTXTX unsignedInt unsignedInt - This parameter reports a count of retransmitted DTU anomalies (rtx_tx). This parameter is defined in clause 7.8.6 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessBSW unsignedInt unsignedInt - This parameter reports a count of the successful bit swap (BSW) primitives. This parameter is defined as success_BSW in clause 7.7.20 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessSRA unsignedInt unsignedInt - This parameter reports a count of the successful autonomous SRA (seamless rate adaptation) primitives. This parameter is defined as success_SRA in clause 7.7.21 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessFRA unsignedInt unsignedInt - This parameter reports a count of the successful FRA (fast rate adaptation) primitives. This parameter is defined as success_FRA in clause 7.7.22 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessRPA unsignedInt unsignedInt - This parameter reports a count of the successful RPA (RMC parameter adjustment) primitives. This parameter is defined as success_RPA in clause 7.7.23 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
SuccessTIGA unsignedInt unsignedInt - This parameter reports a count of the successful TIGA (transmitter initiated gain adjustment) primitives. This parameter is defined as success_TIGA in clause 7.7.24 of ITU-T Rec. [G.997.2]. - 2.12 TR-181i2a12
Device.​FAST.​Line.​{i}.​TestParams. object object​[1:1] - This object contains the FAST line test parameters that are available during the L0 (i.e., Showtime) state. - 2.12 TR-181i2a12
SNRGds unsignedInt unsignedInt -

Reports the number of sub-carriers in any one sub-carrier group used to represent the downstream SNR(f) values. Valid values are 1, 2, 4, and 8.

Note: In ITU-T G.9701-2014, the only valid value is G = 1. See clause 7.10.8.2 ITU-T Recommendation [G.997.2].

- 2.12 TR-181i2a12
SNRGus unsignedInt unsignedInt -

Reports the number of sub-carriers in any one sub-carrier group used to represent the upstream SNR(f) values. Valid values are 1, 2, 4, and 8.

Note: In ITU-T G.9701-2014, the only valid value is G = 1. See clause 7.10.8.5 ITU-T Recommendation [G.997.2].

- 2.12 TR-181i2a12
SNRpsds int​(2047)​[] list​(2047) of int -

Comma-separated list (maximum number of characters 2047) of integers. Reports the downstream SNR(f) values. A special value indicates that no measurement could be done for this sub-carrier group because it is out of the downstream MEDLEY set or its transmit power is zero. The number of elements will depend on the value of SNRGds. Interpretation of the values is as defined in clause 11.4.1.2.2.of ITU-T Rec. [G.9701].

Note: See clause 7.10.8.3 of ITU-T Recommendation [G.997.2].

- 2.12 TR-181i2a12
SNRpsus string​(2047)​[] list​(2047) of string -

Comma-separated list (maximum number of characters 2047) of strings. Reports the upstream SNR(f) values. A special value indicates that no measurement could be done for this sub-carrier group because it is out of the downstream MEDLEY set or its transmit power is zero. The number of elements will depend on the value of SNRGds. Interpretation of the values is as defined in clause 11.4.1.2.2.of ITU-T Rec. [G.9701].

Note: See clause 7.10.8.6 of ITU-T Recommendation [G.997.2].

- 2.12 TR-181i2a12
SNRMTds unsignedInt unsignedInt -

Reports the number of symbols used to measure the downstream SNR(f) values. The valid values 0..65535.

Note: See clause 7.10.8.1 of ITU-T Recommendation [G.997.2].

- 2.12 TR-181i2a12
SNRMTus unsignedInt unsignedInt -

Reports the number of symbols used to measure the upstream SNR(f) values. The valid values 0..65535.

Note: See clause 7.10.8.4 of ITU-T Recommendation [G.997.2].

- 2.12 TR-181i2a12
ACTINP unsignedInt unsignedInt -

Reports the actual INP against SHINE as defined in clause 11.4.1.1.7/[G.9701]. A special value indicates an actual INP against SHINE of 2047 symbols or higher. The valid values are 0..2046 and 2047 is the special value.

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

- 2.12 TR-181i2a12
NFEC unsignedInt unsignedInt -

Reports the DTU FEC codeword length (expressed in 1 byte unit) as defined in clause 9.3/[G.9701]. The valid range is 32..255.

Note: See clause 7.11.4.1 ITU-T Recommendation [G.997.2].

- 2.12 TR-181i2a12
RFEC int int -

Reports the DTU FEC codeword redundancy as defined in clause 9.3/[G.9701].

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

- 2.12 TR-181i2a12
UpstreamCurrRate unsignedInt unsignedInt -

Reports the current physical layer aggregate data rate (expressed in Kbps) of the upstream FAST as defined in clause 11.4.1.1.1/[G.9701].

The current physical layer aggregate data rate (expressed in Kbps) of the upstream FAST connection. The valid values are 0..4294967295(0 to 232-1 kbit/s).

- 2.12 TR-181i2a12
DownstreamCurrRate unsignedInt unsignedInt -

Reports the current physical layer aggregate data rate (expressed in Kbps) of the upstream FAST as defined in clause 11.4.1.1.1/[G.9701].

The current physical layer aggregate data rate (expressed in Kbps) of the downstream FAST connection. The valid values are 0..4294967295(0 to 232-1 kbit/s).

- 2.12 TR-181i2a12
ACTINPREIN unsignedInt unsignedInt - Reports the actual INP against REIN as defined in clause 11.4.1.1.8/[G.9701]. A special value indicates an actual INP against REIN of 63 symbols or higher. The valid range is 0..62 symbols, and 63 is the special value. - 2.12 TR-181i2a12
Device.​Optical. object object​[1:1] - This object models optical interface technologies. It defines an Interface object that models a layer 1 optical interface that is capable of transporting Ethernet packets. The data model definition is based on parts of [G.988]. - 2.12 TR-181i2a12
InterfaceNumberOfEntries unsignedInt unsignedInt - The number of entries in the Interface table. - 2.12 TR-181i2a12
Device.​Optical.​Interface.​{i}. object​[0:] object​[0:∞] -

Optical interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models physical optical interfaces.

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

- 2.12 TR-181i2a12
Enable boolean boolean W

Enables or disables the optical interface.

This parameter is based on ifAdminStatus from [RFC2863].

- 2.12 TR-181i2a12
Status string string -

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

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

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

This parameter is based on ifOperStatus from [RFC2863].

- 2.12 TR-181i2a12
Alias string​(64) Alias 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.

The value MUST NOT change once it's been assigned.

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 TR-181i2a12
Name string​(64) string​(64) -

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.12 TR-181i2a12
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the optical interface entered its current operational state. - 2.12 TR-181i2a12
LowerLayers string​(1024)​[] list​(1024) of string W

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