Broadband Forum

    DATA MODEL DEFINITION


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

License

Copyright (c) 2010-2019, Broadband Forum

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

Table of Contents

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
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 [EUI64]. The IEEE defined 64-bit extended unique identifier (EUI-64) is a concatenation of:

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

Possible patterns:

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

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

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

  • 216.52.29.100
  • 192.168.1.254

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

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

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

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

IPPrefix string(49)

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

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

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

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

IPv4Address IPAddress(15)

IPv4 address (or subnet mask).

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

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

IPv4 address prefix.

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

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

IPv6 address.

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

IPv6Prefix IPPrefix(49)

IPv6 address prefix.

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

MACAddress string(17)

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

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

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

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

Both values are represented as unsignedInt.

PSMBreakPointIndexAndLevel unsignedInt

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.

UERComplex int

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

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

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

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

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}
base64 -

Base64 encoded binary (no line-length limitation).

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

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

Decimal value.

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

hexBinary -

Hex encoded binary.

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

int -

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

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

long -

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

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

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

Unsigned integer in the range 0 to 4294967295, inclusive.

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

unsignedLong -

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

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

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.11-2016] IEEE Std 802.11-2016, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, December 2016.
[802.11a-1999] IEEE Std 802.11a-1999, High-speed Physical Layer in the 5 GHz band, IEEE, 1999.
[802.11ac-2013] IEEE Std 802.11ac-2013, Enhancements for Very High Throughput for Operation in Bands below 6 GHz, IEEE, December 2013.
[802.11ax] IEEE Std 802.11ax, IEEE.
[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.
[BPF] BPF, Berkeley Packet Filter Syntax, FreeBSD.org, October 2016.
[DataElements-v1.0] Data Elements Specification, Data Elements Specification Version 1.0, January 2019.
[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.996.2] G.996.2, Single-ended line testing for digital subscriber lines (DSL), ITU-T.
[G.997.1] G.997.1, Physical layer management for digital subscriber line (DSL) transceivers, ITU-T.
[G.997.2] G.997.2, Physical layer management for FAST transceivers, ITU-T, 2015.
[G.998.1] G.998.1, ATM-based Multi-Pair Bonding, ITU-T, 2005.
[G.998.2] G.998.2, Ethernet-based Multi-Pair Bonding, ITU-T, 2005.
[G.998.3] G.998.3, Multi-Pair Bonding Using Time-Division Inverse Multiplexing, ITU-T, 2005.
[HPAV1.1] HomePlug AV Specification, Version 1.1, HomePlug, 2007.
[HTML4.01] HTML 4.01 Specification, W3C.
[IANA-protocolnumbers] IANA Protocol Numbers, Protocol Numbers, IANA.
[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.
[LIBPCAP] Libpcap, Libpcap File Format, Wireshark, 2015.
[LMAPIFM] RFC 8193, Information Model for Large-Scale Measurement Platforms (LMAPs), IETF, August 2017.
[LMAPREG] draft-ietf-ippm-metric-registry-12, Registry for Performance Metrics, IETF, June 30, 2017.
[MAPv1.0] Multi-AP Specification, Multi-AP Specification Version 1.0, June 2018.
[MOCA11-MIB] MOCA11-MIB, Remote Management of MoCA Interfaces using SNMP MIB, MoCA Alliance, 2009.
[MoCAv1.0] MoCA v1.0, MoCA MAC/PHY Specification v1.0, MoCA Alliance, 2009.
[MoCAv1.1] MoCA v1.1, MoCA MAC/PHY Specification v1.1 Extensions, MoCA Alliance, 2009.
[MQTT31] MQTT v3.1, MQ Telemetry Transport (MQTT) V3.1 Protocol Specification, 2010.
[MQTT50] MQTT Version 5.0, MQTT Version 5.0, Candidate OASIS Standard 02., OASIS Message Queuing Telemetry Transport (MQTT) TC, February 2019.
[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-106] TR-106 Amendment 8, Data Model Template for CWMP Endpoints and USP Agents, Broadband Forum, May 2018.
[TR-143] TR-143 Amendment 3, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, May 2017.
[TR-159] TR-159, Management Framework for xDSL Bonding, Broadband Forum, December 2008.
[TR-181i2] TR-181 Issue 2 Amendment 13, Device Data Model, Broadband Forum, September 2019.
[TR-232] TR-232, Bulk Data Collection, Broadband Forum, May 2012.
[TR-262] TR-262, Femto Component Objects, Broadband Forum, November 2011.
[TR-304] TR-304, Broadband Access Service Attributes and Performance Metrics, Broadband Forum, February 2015.
[TR-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.

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

Name Type Write Description Object Default Version
Device. object - The top-level object for a Device. - 2.0
FactoryReset() command - Factory reset the entity associated with the containing Device. - 2.13
SelfTestDiagnostics() command - [ASYNC] This diagnostics test is vendor-specific and MAY include testing hardware, software, and/or firmware. - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string -

Indicates the availability of diagnostics data. Enumeration of:

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

- 2.13
PacketCaptureDiagnostics() command - [ASYNC] This diagnostic command is used to record packet capture data on a valid (layer 2 or above) interface in libpcap or pcapng format. - 2.13
⇒ Input. arguments - Input arguments. -
⇒ Interface string­(256) W The value MUST be the Path Name of a table row. A reference to a (layer 2 or above) interface object that will be the target of this packet capture diagnostic. - 2.13
⇒ Format string W

This indicates whether the network trace will be recorded in libpcap [LIBPCAP] or pcapng format, and is dependent on the underlying method of performing a network trace. Enumeration of:

  • libpcap (The packet data is recorded in libpcap [LIBPCAP] format)
  • pcapng (The packet data is recorded in pcapng format)
- 2.13
⇒ Duration unsignedInt­[1:] W The duration in seconds to copy packets to the file target. The diagnostic completes when either the Duration, PacketCount, or ByteCount conditions are met. - 2.13
⇒ PacketCount unsignedInt W The maximum number of packets to record to the file target. A value of zero (0) indicates no limit. The diagnostic completes when the Duration, ByteCount, or PacketCount conditions are met. - 2.13
⇒ ByteCount unsignedInt W The maximum number of bytes to record to the file target. A value of zero (0) indicates no limit. The diagnostic completes when Duration, PacketCount or ByteCount conditions are met. - 2.13
⇒ FileTarget string­(2048) W URL, as defined in [RFC3986], specifying the destination file location. HTTP and HTTPS transports MUST be supported. Other transports MAY be supported. - 2.13
⇒ FilterExpression string­(256) W A ([BPF]) formatted expression used to restrict the types of network packets that are recorded to FileTarget. - 2.13
⇒ Username string­(256) W Username to be used by the Agent to authenticate with the file location. This string is set to an empty string if no authentication is required. - 2.13
⇒ Password string­(256) W

Password to be used by the Agent to authenticate with the file location. This string is set to an empty string if no authentication is required. When read, this parameter returns an empty string, regardless of the actual value.

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

- 2.13
⇐ Output. arguments - Output arguments. -
⇐ Status string -

Indicates the availability of diagnostics data. Enumeration of:

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

- 2.13
⇐ PacketCaptureResult.{i}. object -

Results for individual packet capture diagnostics. Packet capture files whose FileLocation is local to the system SHOULD be deleted when the next diagnostic is run, or upon a system reboot.

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

- 2.13
⇐ FileLocation string­(2048) - URL, as defined in [RFC3986], specifying the resulting file location of the packet capture record that triggered this result. This MAY be different than the location specified in FileTarget. - 2.13
⇐ StartTime dateTime - The local system time at which the capture was started. - 2.13
⇐ EndTime dateTime - The local system time at which the capture was completed. - 2.13
⇐ Count unsignedInt - The number of packets recorded to the file target. - 2.13
IoTCapabilityNumberOfEntries unsignedInt - The number of entries in the IoTCapability table. - 2.13
NodeNumberOfEntries unsignedInt - The number of entries in the Node table. - 2.13
Device.DSL. object - This object models DSL lines, DSL channels, DSL bonding, and DSL diagnostics. The specific interface objects defined here are Line, Channel, and BondingGroup. Each Line models a layer 1 DSL Line interface, and each Channel models a layer 1 DSL Channel interface where multiple channels can run over a DSL line. In the case where bonding is configured, it is expected that BondingGroup is stacked above the Channel instances within its group. - 2.0
Device.DSL.Diagnostics. object - The DSL Diagnostics object. - 2.0
ADSLLineTest() command - [ASYNC] This command is to provide diagnostic information for a CPE with an ADSL2 or ADSL2+ modem WAN interface, but MAY also be used for ADSL. - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string -

Indicates the availability of diagnostics data. Enumeration of:

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

- 2.13
SELTUER() command -

[ASYNC] This command performs a DSL Single Ended Line Test - Physical Medium Dependent (SELT-PMD) Uncalibrated Echo Response (UER).

This command is for the CPE, aka the Transmission Unit - Remote end (TU-R).

Reference: ITU-T Recommendation [Clause A.2, SELT-PMD management entity/G.996.2].

- 2.13
⇒ Input. arguments - Input arguments. -
⇒ Interface string­(256) W The value MUST be the Path Name of a row in the DSL.Line table. This is the interface over which the test is to be performed. - 2.13
⇒ UERMaxMeasurementDuration unsignedInt­[5:240] W

This parameter is the SELT UER maximum measurement duration (MMD) measured in seconds.

This parameter is defined as SELT_UER_MMD_R in ITU-T Recommendation [Clause A.2.1.1/G.996.2].

- 2.13
⇐ Output. arguments - Output arguments. -
⇐ Status string -

Indicates the availability of diagnostics data. Enumeration of:

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

- 2.13
⇐ ExtendedBandwidthOperation boolean -

This parameter indicates if the option for extended bandwidth SELT is applied (true) or not applied (false).

If the option for extended bandwidth SELT is applied to UER, then UERGroupSize has three valid values: 1, 2 and 12.

If the option for extended bandwidth SELT is not applied to UER, then UERGroupSize has two valid values: 1 and 2.

UERGroupSize is reported if the option for extended bandwidth UER SELT is supported; otherwise, reporting of the group size is optional.

- 2.13
⇐ UER string -

The Uncalibrated Echo Response (UER) [a(0),b(0)], [a(1),b(1)], ...

Comma-separated list (1 to 4096 items) of UERComplexs, with each list item consisting of:.

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

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

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

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

The value of UER at frequency i*UERGroupSize*Df = (UERScaleFactor/(2^31))*(a(i)+j*b(i))/(2^31) where Df = 4.3125 kHz.

This parameter is defined as CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation [Clause A.2.2.1/G.996.2].

- 2.13
⇐ UERScaleFactor unsignedInt -

The Uncalibrated Echo Response (UER) scale factor.

This parameter is defined as part of the CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation [Clause A.2.2.1/G.996.2].

- 2.13
⇐ UERGroupSize unsignedInt­[1:2, 12] -

The Uncalibrated Echo Response (UER) group size, UER_G. In units of subcarriers.

This parameter is defined as part of the CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation [Clause A.2.2.1/G.996.2].

- 2.13
⇐ UERVar string -

Comma-separated list (0 to 4096 items) of integers. This parameter represents the variance of the UER. List items represent v(i), for values of i starting at i=0. The variance of the uncalibrated echo response for frequency i*UERGroupSize*Df is VAR(i*UERGroupSize*Df) = 3 - v(i)/2 dB where Df = 4.3125 kHz.

This parameter is defined as SELT variance of uncalibrated echo response R (SELT UER-VAR-R) in [Clause A.2.2.2/G.996.2].

- 2.13
SELTQLN() command -

[ASYNC] This command performs a DSL Single Ended Line Test - Physical Medium Dependent (SELT-PMD) Quiet Line Noise (QLN).

This command is for the CPE, aka the Transmission Unit - Remote end (TU-R).

Reference: ITU-T Recommendation [Clause A.2, SELT-PMD management entity/G.996.2].

- 2.13
⇒ Input. arguments - Input arguments. -
⇒ Interface string­(256) W The value MUST be the Path Name of a row in the DSL.Line table. This is the interface over which the test is to be performed. - 2.13
⇒ QLNMaxMeasurementDuration unsignedInt­[1:240] W

This parameter is the SELT QLN maximum measurement duration (MMD) measured in seconds.

This parameter is defined as SELT_QLN_MMD_R in ITU-T Recommendation [Clause A.2.1.2/G.996.2].

- 2.13
⇐ Output. arguments - Output arguments. -
⇐ Status string -

Indicates the availability of diagnostics data. Enumeration of:

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

- 2.13
⇐ ExtendedBandwidthOperation boolean -

This parameter indicates if the option for extended bandwidth SELT is applied (true) or not applied (false).

If the option for extended bandwidth SELT is applied to QLN, then QLNGroupSize has three valid values: 1, 2 and 12.

If the option for extended bandwidth SELT is not applied to QLN, then QLNGroupSize has two valid values: 1 and 2.

QLNGroupSize is reported if the option for extended bandwidth QLN SELT is supported; otherwise, reporting of the group size is optional.

- 2.13
⇐ QLN string­(61430) -

Comma-separated list (maximum list length 61430) of integers. List items represent SELT quiet line noise (QLN) per subcarrier group.

Each list element is n(i), with i starting at 0. The value of QLN at frequency i*QLNGroupSize*Df with Df=4.3125 kHz is defined as QLN(i*QLNGroupSize*Df) = -23 - (n(i)/2) dBm/Hz. This data format supports a QLN granularity of 0.5 dB and an dynamic range of -150 to -23 dBm/Hz.

Interpretation of the SELT_QLN_R value is defined in [Clause A.2.2.3/G.996.2].

- 2.13
⇐ QLNGroupSize unsignedInt­[1:2, 12] -

This parameter represents the Quiet Line Noise (QLN) group size. In units of subcarriers.

This parameter is defined as part of the SELT_QLN_R in ITU-T Recommendation [Clause A.2.2.3/G.996.2].

- 2.13
SELTP() command -

[ASYNC] This command performs a DSL Single-Ended Line Test - Processed (SELT-P).

This command is for the CPE, aka the Transmission Unit - Remote end (TU-R).

Reference: ITU-T Recommendation [G.996.2].

- 2.13
⇒ Input. arguments - Input arguments. -
⇒ Interface string­(256) W The value MUST be the Path Name of a row in the DSL.Line table. This is the interface over which the test is to be performed. - 2.13
⇒ CapacityEstimateEnabling boolean W

Capacity estimate calculation enabling: This parameter is expressed as a boolean and takes the value false if xDSL performance estimation is not required, true otherwise.

The capacity estimate calculation enabling parameter is defined in [Clause B.2.1.1/G.996.2].

- 2.13
⇒ CapacitySignalPSD string W

The capacity estimate signal Power Spectral Density (PSD):

Comma-separated list (1 to 48 items) of PSDBreakPointIndexAndLevels, with each list item consisting of:.

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

Both values are represented as unsignedInt.

This capacity estimate signal PSD parameter is defined in ITU-T Recommendation [Clause B.2.1.2/G.996.2].

- 2.13
⇒ CapacityNoisePSD string W

The capacity estimate noise Power Spectral Density (PSD):

Comma-separated list (1 to 48 items) of PSDBreakPointIndexAndLevels, with each list item consisting of:.

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

Both values are represented as unsignedInt.

This capacity estimate noise PSD parameter is defined in ITU-T Recommendation [Clause B.2.1.3/G.996.2].

- 2.13
⇒ CapacityTargetMargin unsignedInt­[0:310] W

The capacity estimate target noise margin. The range of valid values is 0 to 31 dB, in steps of 0.1 dB.

This capacity estimate target noise margin parameter is defined in ITU-T Recommendation [Clause B.2.1.4/G.996.2].

- 2.13
⇐ Output. arguments - Output arguments. -
⇐ Status string -

Indicates the availability of diagnostics data. Enumeration of:

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

- 2.13
⇐ LoopTermination string­(21) -

Loop termination indicator, one of the following state indications:

'Open'

'Short'

'Powered on DSLAM/DPU'

'Unknown'

This parameter is defined as LOOP-TERM in ITU-T Recommendation [Clause B.1.1.1/G.996.2].

- 2.13
⇐ LoopLength unsignedInt­[0:16383] -

This parameter is the loop length with units of meters.

This parameter is defined as the loop length parameter LOOP_LEN in ITU-T Recommendation [Clause B.1.1.2/G.996.2].

- 2.13
⇐ LoopTopology string­(256) -

Comma-separated list (maximum list length 256) of strings. List items represent paired parameters [LOOP_SEG_LEN, LOOP_SEG_BTAP] representing a concatenation of loop segment types, where LOOP_SEG_LEN represents the length of the segment in meters; and LOOP_SEG_BTAP is a string that identifies the segment type as either "in series" or "bridged tap".

The first loop segment in the list shall be the segment connected to the SELT-PMD block, subsequent loop segments in the list shall describe the loop in the direction toward the far-end loop termination.

This Loop Topology parameter is defined in ITU-T Recommendation [Clause B.1.1.3/G.996.2].

- 2.13
⇐ AttenuationCharacteristics string­(61430) -

Comma-separated list (maximum list length 61430) of strings. List items represent paired frequency spacing index i and transfer function log value, i.e. [i,TFlog(i * Df)], where the reference frequency spacing Df = 4.3125 kHz, the index i valid range is 0 to 8191, and TFlog(i * Df) spans a range from +6.0 dB down to -96.2 dB with units of 0.1 dB.

The Attenuation characteristics TFlog(f) parameter is defined in ITU-T Recommendation [Clause B.1.1.6/G.996.2].

- 2.13
⇐ MissingFilter boolean -

Missing micro-filter or splitter: This parameter is a binary indication of a missing or incorrectly installed splitter or micro-filter at the U-R reference point. A value of true represents a missing splitter.

The missing micro-filter or splitter parameter is defined in [Clause B.1.1.4/G.996.2].

- 2.13
⇐ CapacityEstimate unsignedInt -

Capacity Estimate: This parameter is an unsigned integer representing the capacity estimate in kbit/s, with units of kbit/s.

The capacity estimate parameter is defined in [Clause B.1.1.7/G.996.2].

- 2.13
Device.ATM. object - Asynchronous Transfer Mode (ATM) object that contains the Link interface and Diagnostics.F5Loopback() diagnostics. - 2.0
Device.ATM.Diagnostics. object - The ATM Diagnostics object. - 2.0
F5Loopback() command - [ASYNC] This command provides access to an ATM-layer F5 OAM loopback test. - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string -

Indicates the availability of diagnostics data. Enumeration of:

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

- 2.13
Device.Ethernet. object - Ethernet object. This object models several Ethernet interface objects, each representing a different stack layer, including: Interface, Link, and VLANTermination. Interface is media-specific and models a port, the PHY layer, and the MAC layer. Link is media-independent and models the Logical Link Control (LLC) layer. An "outer" VLANTermination, when present, is expected to be stacked on top of Link objects to receive and send frames with a configured VLANID. - 2.0
WoLSupported boolean - Indicates that WoL (Wake on LAN) over Ethernet is supported. - 2.13
Device.Ethernet.WoL. object - This object provides access to the WoL (Wake on LAN) funtionality. - 2.13
SendMagicPacket() command - [ASYNC] This command sends a magic packet over the CPE active Ethernet interfaces. - 2.13
⇒ Input. arguments - Input arguments. -
⇒ MACAddress string­(17) W [MACAddress] MAC address target of the magic packet. - 2.13
⇒ Password string W The SecureOn password. The parameter value can be empty or, if present, can contain either 4 bytes or 6 bytes. - 2.13
Device.HPNA. object - HPNA object that contains the Interface and Diagnostics objects. The HPNA (also known as HomePNA) industry standard [G.9954] defines peer to peer communication for home networking over existing coax cables and telephone wiring within the home. - 2.0
Device.HPNA.Diagnostics. object - The HPNA Diagnostics object. - 2.0
PHYThroughput() command -

[ASYNC] HPNA PHY throughput diagnostics configuration and results.

When diagnostics are requested, all HPNA nodes for which the Interface.{i}.AssociatedDevice.{i}.PHYDiagnosticsEnable parameter is set enter PHY diagnostics mode.

- 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string -

Indicates the availability of diagnostics data. Enumeration of:

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

- 2.13
PerformanceMonitoring() command -

[ASYNC] HPNA performance monitoring configuration and results.

Performance monitoring results are sampled from all nodes in the HPNA network. All packet related counters are sampled synchronized at all nodes in the HPNA network in order to derive packet loss calculations in the HPNA network.

- 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string -

Indicates the availability of diagnostics data. Enumeration of:

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

- 2.13
Device.Ghn. object - G.hn object that contains an Interface table for G.hn supported CPE. The ITU-T G.hn specifications [G.9960] and [G.9961] define Physical and MAC Layers for communication between two or more G.hn nodes in the home network over multiple wired media such as power line, phone line and coaxial cable. - 2.4
Device.Ghn.Diagnostics. object - The G.hn Diagnostics object. - 2.8
PHYThroughput() command -

[ASYNC] G.hn PHY throughput diagnostics configuration and results.

When diagnostics are requested, all G.hn nodes for which the Interface.{i}.PHYThroughputDiagnosticsEnable parameter is set enter PHY diagnostics mode.

- 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string -

Indicates the availability of diagnostics data. Enumeration of:

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

- 2.13
PerformanceMonitoring() command -

[ASYNC] G.hn Performance Monitoring diagnostics configuration and results.

When diagnostics are requested, all G.hn nodes for which the Interface.{i}.PerformanceMonitoringDiagnosticsEnable parameter is set enter PHY diagnostics mode.

- 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string -

Indicates the availability of diagnostics data. Enumeration of:

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

- 2.13
Device.UPA. object - Universal Powerline Association [UPA-PLC]. This object contains the Interface and Diagnostics objects. - 2.0
Device.UPA.Diagnostics. object - The UPA Diagnostics object. - 2.0
InterfaceMeasurement() command -

[ASYNC] This command provides access to either a Signal-to-Noise-Ratio (SNR) Port Measurement test or a Channel Frequency Response (CFR) Port Measurement test. The Type parameter is used to select which type of test to perform.

CFR and SNR measurements are done between a two UPA devices (a local interface and a remote device belonging to the same network).

- 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string -

Indicates the availability of diagnostics data. Enumeration of:

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

- 2.13
Device.WiFi. object - The WiFi object is based on the WiFi Alliance 802.11 specifications ([802.11-2007]). It defines interface objects (Radio and SSID), and application objects (AccessPoint and EndPoint). - 2.0
NeighboringWiFiDiagnostic() command - [ASYNC] This command defines access to other WiFi SSIDs that this device is able to receive. - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string -

Indicates the availability of diagnostics data. Enumeration of:

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

- 2.13
Device.WiFi.MultiAP. object -

This object describes a Wi-Fi network containing 1 or more Access Point devices.

This object is related to a Wi-Fi network that contains multiple Access Points (Multi-AP) and utilizes software logic to optimize that Wi-Fi network (typically via steering STAs, also known as Associated Devices, to the best Access Point). This object exposes the view of the Wi-Fi netwtork from the perspective of the Multi-AP Controller. The Wi-Fi Alliance EasyMesh solution is one example of managing a Multi-AP network.

- 2.13
APDeviceNumberOfEntries unsignedInt - The number of entries in the APDevice table. - 2.13
Device.WiFi.MultiAP.SteeringSummaryStats. object -

The summary of statistics related to Multi-AP Steering for the Wi-Fi network.

The counters contained in SteeringSummaryStats are all reset on reboot.

- 2.13
NoCandidateAPFailures unsignedLong - [StatsCounter64] Number of times Associated Devices should have been steered but weren't because a better candidate AP couldn't be found. - 2.13
BlacklistAttempts unsignedLong - [StatsCounter64] Number of times a Blacklist steer was attempted. - 2.13
BlacklistSuccesses unsignedLong - [StatsCounter64] Number of times an attempted Blacklist steer succeeded. - 2.13
BlacklistFailures unsignedLong - [StatsCounter64] Number of times an attempted Blacklist steer failed. - 2.13
BTMAttempts unsignedLong - [StatsCounter64] Number of times a BTM (BSS Transition Management; 802.11k) steer was attempted. - 2.13
BTMSuccesses unsignedLong - [StatsCounter64] Number of times an attempted BTM (BSS Transition Management; 802.11k) steer succeeded. - 2.13
BTMFailures unsignedLong - [StatsCounter64] Number of times an attempted BTM (BSS Transition Management; 802.11k) steer failed. - 2.13
BTMQueryResponses unsignedLong - [StatsCounter64] Number of asynchronous BTM (BSS Transition Management; 802.11k) Queries for which a BTM Request was issued. - 2.13
Device.WiFi.MultiAP.APDevice.{i}. object -

Each instance of this object represents an individual Access Point device in the Wi-Fi network.

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

- 2.13
MACAddress string­(17) - [MACAddress] A unique identifier for this particular device within the Wi-Fi network. - 2.13
Manufacturer string - The manufacturer of the Access Point device (human readable string). - 2.13
ManufacturerOUI string­(6:6) -

Organizationally unique identifier of the Access Point 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.

- 2.13
ProductClass 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.13
SerialNumber string­(64) -

Identifier of the particular Access Point 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.13
SoftwareVersion string­(64) -

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

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

- 2.13
LastContactTime dateTime - The last time that the Access Point device was contacted via the Multi-AP control protocol. - 2.13
AssocIEEE1905DeviceRef string - The value MUST be the Path Name of a row in the IEEE1905.AL.NetworkTopology.IEEE1905Device table. If the referenced object is deleted, the parameter value MUST be set to an empty string. AssocIEEE1905DeviceRef is a reference to the IEEE 1905.1 Network Topology Device. Since IEEE 1905.1 is a common protocol used by Multi-AP Controllers for communications, this parameter allows the MultiAP portion of the data model to reference the associated IEEE 1905.1 portion of the data model. - 2.13
BackhaulLinkType string -

The medium being used to backhaul this Access Point Device to the Multi-AP Controller. The None value is reserved for the APDevice instance that represents the Multi-AP Controller. Enumeration of:

- 2.13
BackhaulMACAddress string­(17) -

[MACAddress] The MAC Address of the Device on the network that is providing a Backhaul Link for this Access Point Device.

The an empty string value is reserved for the APDevice instance that represents the Multi-AP Controller.

- 2.13
BackhaulBytesSent unsignedLong - [StatsCounter64] The total number of bytes transmitted across the backhaul medium (as identified by the value of the BackhaulLinkType parameter), including framing characters. - 2.13
BackhaulBytesReceived unsignedLong - [StatsCounter64] The total number of bytes received across the backhaul medium (as identified by the value of the BackhaulLinkType parameter), including framing characters. - 2.13
BackhaulLinkUtilization unsignedInt­[:100] - Current utilization (expressed in %) of the medium (as identified by the value of the BackhaulLinkType parameter) being used to backhaul this Access Point device to the Multi-AP Controller. A value of 0 is used for the APDevice instance that represents the Access Point on the Multi-AP Controller. - 2.13
BackhaulSignalStrength unsignedInt­[:255] - An indicator of radio signal strength of the backhaul link of the Access Point (AP) to the Multi-AP Controller, measured in dBm. RCPI threshold is encoded per Table 9-154 of [802.11-2016]. The value of this parameter is indeterminate if the value of the BackhaulLinkType parameter is anything other than Wi-Fi. - 2.13
RadioNumberOfEntries unsignedInt - The number of entries in the Radio table. - 2.13
Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}. object -

This object represents all of the individual Radios contained within the identified Access Point device known to the controller.

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

- 2.13
MACAddress string­(17) - [MACAddress] A unique identifier for this particular Radio within the identified Access Point. - 2.13
OperatingFrequencyBand string -

Indicates the frequency band at which the radio is operating. Enumeration of:

- 2.13
OperatingStandards string -

Comma-separated list of strings. List items indicate which IEEE 802.11 standard this Radio instance is configured for. Each list item is an enumeration of:

Each value indicates support for the indicated standard.

If OperatingFrequencyBand is set to 2.4GHz, only values b, g, n, ax are applicable.

If OperatingFrequencyBand is set to 5GHz, only values a, n, ac, ax are applicable.

For example, a value of "g,b" (or "b,g" - order is not important) means that the 802.11g standard [802.11g-2003] is used with a backwards-compatible mode for 802.11b [802.11b-1999]. A value of "g" means that only the 802.11g standard is in use.

- 2.13
Channel unsignedInt­[1:255] - The current radio channel used by the connection. - 2.13
ExtensionChannel string -

The secondary extension channel position, applicable when operating in wide channel mode (i.e. when CurrentOperatingChannelBandwidth is 40MHz

If not operating in wide channel mode (i.e. when CurrentOperatingChannelBandwidth is something other than 40MHz, then the value of ExtensionChannel is None. Enumeration of:

- 2.13
CurrentOperatingChannelBandwidth string -

The channel bandwidth currently in use. Enumeration of:

- 2.13
MCS int­[0:15, 16:31] - The Modulation Coding Scheme index (applicable to 802.11n and 802.11ac specifications only). Values from 0 to 15 MUST be supported ([802.11n-2009]). Values from 0 to 9 MUST be supported for [802.11ac-2013]. - 2.13
TransmitPower int­[-1:100] - Indicates the current transmit power level as a percentage of full power. - 2.13
APNumberOfEntries unsignedInt - The number of entries in the AP table. - 2.13
Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.AP.{i}. object -

A single logical Access Point operating on this radio.

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

- 2.13
BSSID string­(17) - [MACAddress] The MAC Address of the logical BSS (BSSID). - 2.13
SSID string - The SSID in use for this BSS. - 2.13
BlacklistAttempts unsignedLong - [StatsCounter64] Number of times a Blacklist steer was attempted for this Access Point. - 2.13
BTMAttempts unsignedLong - [StatsCounter64] Number of times a BTM (BSS Transition Management; 802.11k) steer was attempted for this Access Point. - 2.13
BTMQueryResponses unsignedLong - [StatsCounter64] Number of asynchronous BTM (BSS Transition Management; 802.11k) Queries for which a BTM Request was issued by this Access Point. - 2.13
AssociatedDeviceNumberOfEntries unsignedInt - The number of entries in the AssociatedDevice table. - 2.13
Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.AP.{i}.AssociatedDevice.{i}. object -

Object describing a single Associated Device (STA).

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

- 2.13
MACAddress string­(17) - [MACAddress] The MAC address of an associated device. - 2.13
OperatingStandard string -

The operating standard that this associated device is connected with. Enumeration of:

- 2.13
Active boolean -

Whether or not this associated device is currently present on the Wi-Fi Access Point device.

The ability to list inactive nodes is OPTIONAL. If the Access Point devices includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE.

- 2.13
AssociationTime dateTime - Date and time in UTC when the device was associated. - 2.13
LastDataDownlinkRate unsignedInt - The data transmit rate in kbps that was most recently used for transmission of data from the access point to the associated device. - 2.13
LastDataUplinkRate unsignedInt - The data transmit rate in kbps that was most recently used for transmission of data from the associated device to the access point. - 2.13
SignalStrength unsignedInt­[:255] - An indicator of radio signal strength of the uplink from the Associated Device (STA) to the Access Point (AP) measured in dBm. RCPI threshold is encoded per Table 9-154 of [802.11-2016]. - 2.13
Noise unsignedInt­[:255] -

An indicator of the average radio noise plus interference power measured on the uplink from the Associated Device (STA) to the Access Point (AP).

Encoded as defined for ANPI in [Section 10.11.9.4/802.11-2016].

- 2.13
SteeringHistoryNumberOfEntries unsignedInt - The number of entries in the SteeringHistory table. - 2.13
Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.AP.{i}.AssociatedDevice.{i}.Stats. object - Object describing the Statistics for a single Associated Device (STA). - 2.13
BytesSent unsignedLong - [StatsCounter64] The total number of bytes transmitted to the Associated Device. - 2.13
BytesReceived unsignedLong - [StatsCounter64] The total number of bytes received from the Associated Device. - 2.13
PacketsSent unsignedLong - [StatsCounter64] The total number of packets transmitted to the Associated Device. - 2.13
PacketsReceived unsignedLong - [StatsCounter64] The total number of packets received from the Associated Device. - 2.13
ErrorsSent unsignedLong - [StatsCounter64] The total number of outbound packets that could not be transmitted because of errors. These might be due to the number of retransmissions exceeding the retry limit, or from other causes. - 2.13
ErrorsReceived unsignedLong - [StatsCounter64] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.13
RetransCount unsignedLong - [StatsCounter64] The total number of transmitted packets which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two. - 2.13
Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.AP.{i}.AssociatedDevice.{i}.SteeringSummaryStats. object -

The summary of statistics related to Multi-AP Steering for an individual STA on the Wi-Fi network.

The counters contained in SteeringSummaryStats are all reset on reboot.

- 2.13
NoCandidateAPFailures unsignedLong - [StatsCounter64] Number of times this Associated Device should have been steered but wasn't because a better candidate AP couldn't be found. - 2.13
BlacklistAttempts unsignedLong - [StatsCounter64] Number of times a Blacklist steer was attempted on this Associated Device. - 2.13
BlacklistSuccesses unsignedLong - [StatsCounter64] Number of times an attempted Blacklist steer succeeded for this Associated Device. - 2.13
BlacklistFailures unsignedLong - [StatsCounter64] Number of times an attempted Blacklist steer failed for this Associated Device. - 2.13
BTMAttempts unsignedLong - [StatsCounter64] Number of times a BTM (BSS Transition Management; 802.11k) steer was attempted on this Associated Device. - 2.13
BTMSuccesses unsignedLong - [StatsCounter64] Number of times an attempted BTM (BSS Transition Management; 802.11k) steer succeeded for this Associated Device. - 2.13
BTMFailures unsignedLong - [StatsCounter64] Number of times an attempted BTM (BSS Transition Management; 802.11k) steer failed for this Associated Device. - 2.13
BTMQueryResponses unsignedLong - [StatsCounter64] Number of asynchronous BTM (BSS Transition Management; 802.11k) Queries for which a BTM Request was issued to this Associated Device. - 2.13
LastSteerTime unsignedInt - The number of seconds since this Associated Device was last attempted to be steered. - 2.13
Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.AP.{i}.AssociatedDevice.{i}.SteeringHistory.{i}. object -

The history of Multi-AP Steering for an individual STA on the Wi-Fi network.

The contents of this multi-instance object are reset on reboot.

At most one entry in this table can exist with all the same values for Time, APOrigin and APDestination.

- 2.13
Time dateTime - The date/time when steering was initiated for the Associated Device. - 2.13
APOrigin string - The BSSID of the Access Point that initiated the steering. - 2.13
TriggerEvent string -

The type of event that caused the steering to be initiaited. Enumeration of:

NOTE: This might be Unknown for BTM Query Response steers.

- 2.13
SteeringApproach string -

The type of steering that was attempted. Enumeration of:

- 2.13
APDestination string -

The BSSID of the destination Access Point of a successful steer.

A failed steering attempt will leave this parameter an empty string.

- 2.13
SteeringDuration unsignedInt -

The amount of time in seconds required for the steer to complete successfully.

A failed steering attempt will leave this parameter 0.

- 2.13
Device.WiFi.DataElements. object - This object represents the Wi-Fi Alliance Data Elements as defined in [DataElements-v1.0]. - 2.13
Device.WiFi.DataElements.Network. object - This object describes a Wi-Fi network containing 1 or more Access Point devices. - 2.13
ID string W A unique identifier for this particular Wi-Fi network. - 2.13
TimeStamp string - The time this group was collected. - 2.13
ControllerID string W A unique identifier for a Multi-AP controller. - 2.13
DeviceNumberOfEntries unsignedInt - The number of entries in the Device table. - 2.13
Device.WiFi.DataElements.Network.Device.{i}. object -

Each instance of this object represents an individual Access Point device in the Wi-Fi network.

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

- 2.13
ID string­(17) - [MACAddress] A unique identifier for this particular device within the Wi-Fi network as defined in [Section 3.1/DataElements-v1.0]. - 2.13
MultiAPCapabilities base64­(1:1) - The Multi-AP capabilities supported by this device as defined by the APCapability TLV in [Section 17.2.6/MAPv1.0]. - 2.13
CollectionInterval unsignedInt - The interval between the collection of consecutive measurements of the most frequently updated Data Element from this device in milliseconds. - 2.13
RadioNumberOfEntries unsignedInt - The number of entries in the Radio table. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}. object -

This object represents all of the individual Radios contained within the identified Access Point device known to the controller.

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

- 2.13
ID base64­(6:6) - A unique identifier for this particular Radio within the identified Access Point as defined in [Section 3.1/DataElements-v1.0]. - 2.13
Enabled boolean - Indicates whether this radio is enabled or disabled. - 2.13
Noise unsignedInt­[:255] -

An indicator of the average radio noise plus interference power measured for the primary operating channel.

Encoded as defined for ANPI in [Section 11.11.9.4/802.11-2016].

- 2.13
Utilization unsignedInt­[0:255] -

(Total Channel Utililzation) The percentage of time (linearly scaled with 255 representing 100%) that the Access Point device sensed the medium was busy, as indicated by either the physical or virtual carier sense (CS) mechanism. This is essentially the amount of time spent transmiting (both successful and failed transmissions), receiving (both local and non-local transmissions), and processing noise.

When more than one channel is in use for the BSS operating on the radio, the Utilization value is calculated only for the primary channel.

- 2.13
Transmit unsignedInt­[0:255] -

(Transmit Channel Utilization) The percentage of time (linearly scaled with 255 representing 100%) that the radio has spent on sending individually or group addressed transmissions (successful and failed).

When more than one channel is in use for the BSS operating on the radio, the Transmit value is calculated only for the primary channel.

- 2.13
ReceiveSelf unsignedInt­[:255] -

(Receive Local Channel Utilization) The percentage of time (linearly scaled with 255 representing 100%) that the radio has spent on receiving individually or group addressed local transmissions (i.e. transmissions from any STA associated with any BSS operating on this radio).

When more than one channel is in use for the BSS operating on the radio, the ReceiveSelf value is calculated only for the primary channel.

- 2.13
ReceiveOther unsignedInt­[0:255] -

(Receive Non-Local Channel Utilization) The percentage of time (linearly scaled with 255 representing 100%) that the radio has spent on receiving individually or group addressed non-local transmissions (i.e. valid IEEE 802.11 PPDUs that are not associated with any BSS operatin gon this radio).

When more than one channel is in use for the BSS operating on the radio, the ReceiveOther value is calculated only for the primary channel.

- 2.13
CurrentOperatingClassProfileNumberOfEntries unsignedInt - The number of entries in the CurrentOperatingClassProfile table. - 2.13
UnassociatedSTANumberOfEntries unsignedInt - The number of entries in the UnassociatedSTA table. - 2.13
BSSNumberOfEntries unsignedInt - The number of entries in the BSS table. - 2.13
ScanResultNumberOfEntries unsignedInt - The number of entries in the ScanResult table. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BackhaulSta. object - Contains the MACAddress of the STA on this radio providing Wi-Fi backhaul to this device. - 2.13
MACAddress string­(17) - [MACAddress] The MAC address of the logical STA sharing the radio for Wi-Fi backhaul. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities. object - This object represents the capabilities of the radio which may be different from the current operational configuration. - 2.13
HTCapabilities base64­(1:1) - Describes the HT capabilities of the radio as defined by the HTCapabilities TLV [Section 17.2.8/MAPv1.0]. - 2.13
VHTCapabilities base64­(2:6) - Describes the VHT capabilities of the radio as defined by the VHTCapabilities TLV [Section 17.2.9/MAPv1.0]. - 2.13
HECapabilities base64­(4:14) - Describes the HE capabilities of the radio as defined by the HECapabilities TLV [Section 17.2.10/MAPv1.0]. - 2.13
CapableOperatingClassProfileNumberOfEntries unsignedInt - The number of entries in the CapableOperatingClassProfile table. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.CapableOperatingClassProfile.{i}. object -

Describes one of the possible Operating Classes supported by this Radio.

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

- 2.13
Class unsignedInt­[:255] - The Operating Class per Table E-4 in [802.11-2016] that this radio is capable of operating on. - 2.13
MaxTxPower int­[-127:127] -

Maximum Transmit Power EIRP that this radio is capable of transmitting in the current regulatory domain for the Operating Class.

Represented as 2's complement signed integer in units of decibels relative to 1 mW (dBm).

- 2.13
NonOperable string -

Comma-separated list of unsigned integers (value 0 to 255). The channel numbers which are statically non-operable in the Operating Class (i.e. the Radio is never able to operate on these channels).

Other channels from this Operating Class which are not listed here are supported for the Radio.

- 2.13
NumberOfNonOperChan unsignedInt - The number of non-operable channels contained in NonOperable. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.CurrentOperatingClassProfile.{i}. object -

Describes one of the current Operating Classes in use by this Radio. One Opeating Class is indicated for each current Operating Channel Bandwidth.

The Channel indicated for the 20 MHz Operating Class is equal to the current primary channel.

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

- 2.13
Class unsignedInt­[:255] - The Operating Class per Table E-4 in [802.11-2016] that this radio is currently operating on. - 2.13
Channel unsignedInt­[:255] - This Channel number in the Operating Class that this Radio is currently operating on. - 2.13
TxPower int­[-127:127] -

Nominal Transmit Power EIRP that this radio is currently using for the current Channel in the Opeating Class.

Represented as 2's complement signed integer in units of decibels relative to 1 mW (dBm).

- 2.13
TimeStamp string - The time this group was collected. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}. object -

A single logical BSS operating on this radio.

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

- 2.13
BSSID string­(17) - [MACAddress] The MAC Address of the logical BSS (BSSID). - 2.13
SSID string - The SSID in use for this BSS. - 2.13
Enabled boolean - Whether the BSSID is currently enabled (beaconing frames are being sent) or disabled. - 2.13
LastChange unsignedInt - Time in seconds since the last change to the Enabled value. - 2.13
TimeStamp string - The time this group was collected. - 2.13
UnicastBytesSent unsignedLong - [StatsCounter64] Access Point (BSS) wide statistics for total unicast bytes transmitted. - 2.13
UnicastBytesReceived unsignedLong - [StatsCounter64] Access Point (BSS) wide statistics for total unicast bytes received. - 2.13
MulticastBytesSent unsignedLong - [StatsCounter64] Access Point (BSS) wide statistics for total multicast bytes transmitted. - 2.13
MulticastBytesReceived unsignedLong - [StatsCounter64] Access Point (BSS) wide statistics for total multicast bytes received. - 2.13
BroadcastBytesSent unsignedLong - [StatsCounter64] Access Point (BSS) wide statistics for total broadcast bytes transmitted. - 2.13
BroadcastBytesReceived unsignedLong - [StatsCounter64] Access Point (BSS) wide statistics for total broadcast bytes received. - 2.13
EstServiceParametersBE base64­(3) - Estimated Service Parameters information field for AC=BE, defined per Figure 9-588 in [802.11-2016] and referenced in [Section 17.2.22/MAPv1.0]. - 2.13
EstServiceParametersBK base64­(3) - Estimated Service Parameters information field for AC=BK, defined per Figure 9-588 in [802.11-2016] and referenced in [Section 17.2.22/MAPv1.0]. - 2.13
EstServiceParametersVI base64­(3) - Estimated Service Parameters information field for AC=VI, defined per Figure 9-588 in [802.11-2016] and referenced in [Section 17.2.22/MAPv1.0]. - 2.13
EstServiceParametersVO base64­(3) - Estimated Service Parameters information field for AC=VO, defined per Figure 9-588 in [802.11-2016] and referenced in [Section 17.2.22/MAPv1.0]. - 2.13
STANumberOfEntries unsignedInt - The number of entries in the STA table. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}. object -

Object describing a single Associated Device (STA).

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

- 2.13
MACAddress string­(17) - [MACAddress] The MAC address of an associated device. - 2.13
TimeStamp string - The time this group was collected. - 2.13
HTCapabilities base64­(1:1) - Describes the HT capabilities of the Associated Device (STA). - 2.13
VHTCapabilities base64­(2:6) - Describes the VHT capabilities of the Associated Device (STA). - 2.13
HECapabilities base64­(4:14) - Describes the HE capabilities of the Associated Device (STA). - 2.13
LastDataDownlinkRate unsignedInt - The data transmit rate in kbps that was most recently used for transmission of data from the access point to the associated device. - 2.13
LastDataUplinkRate unsignedInt - The data transmit rate in kbps that was most recently used for transmission of data from the associated device to the access point. - 2.13
UtilizationReceive unsignedLong - The amount of time in milliseconds that the Radio has spent on the Channel receiving data from this Associated Device (STA). - 2.13
UtilizationTransmit unsignedLong - The amount of time in milliseconds that the Radio has spent on the Channel transmitting data to this Associated Device (STA). - 2.13
EstMACDataRateDownlink unsignedInt - Estimate of the MAC layer throughput in Mbps achievable in the downlink direction if 100% of channel airtime and BSS operating bandwidth were available, as defined in [Section 10.3.1/MAPv1.0]. - 2.13
EstMACDataRateUplink unsignedInt - Estimate of the MAC layer throughput in Mbps achievable in the uplink direction if 100% of channel airtime and BSS operating bandwidth were available, as defined in [Section 10.3.1/MAPv1.0]. - 2.13
SignalStrength unsignedInt­[:255] -

An indicator of radio signal strength of the uplink from the associated STA to the access point - measured in dBm. RCPI threshold (encoded per Table 9-154 of [802.11-2016], and described in 10.3.1 of [MAPv1.0]). Reserved: 221 - 255.

NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details.

- 2.13
LastConnectTime unsignedInt - The time in seconds since this Assocated Device (STA) was associated. - 2.13
BytesSent unsignedLong - [StatsCounter64] The total number of bytes transmitted to the Associated Device. - 2.13
BytesReceived unsignedLong - [StatsCounter64] The total number of bytes received from the Associated Device. - 2.13
PacketsSent unsignedLong - [StatsCounter64] The total number of packets transmitted to the Associated Device. - 2.13
PacketsReceived unsignedLong - [StatsCounter64] The total number of packets received from the Associated Device. - 2.13
ErrorsSent unsignedLong - [StatsCounter64] The total number of outbound packets that could not be transmitted because of errors. These might be due to the number of retransmissions exceeding the retry limit, or from other causes. - 2.13
ErrorsReceived unsignedLong - [StatsCounter64] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.13
RetransCount unsignedLong - [StatsCounter64] The total number of transmitted packets which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two. - 2.13
MeasurementReport string - Comma-separated list of BASE64 strings. Measurement Report element(s) received from the Associated Device (STA) that constitute the latest Beacon report as defined in Figure 9-199 of [802.11-2016]. - 2.13
NumberOfMeasureReports unsignedInt - The number of measurement report elements contained in MeasurementReport. - 2.13
IPV4Address string­(15) - [IPv4Address] IPV4 Address assigned to the client. - 2.13
IPV6Address string­(45) - [IPv6Address] IPV6Address assigned to the client. - 2.13
Hostname string - Hostname assigned to the client. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}. object - The list of neighboring Access Points discovered by a Radio organized per Operating Class and Channel tuple. - 2.13
TimeStamp string - The timestamp of the last scan. - 2.13
OpClassScanNumberOfEntries unsignedInt - The number of entries in the OpClassScan table. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}. object -

The Operating Class of neighboring Access Points discovered by a Radio during a channel scan.

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

- 2.13
OperatingClass unsignedInt­[:255] -

The Operating Class per Table E-4 in [802.11-2016] of the OpClass and Channel tuple scanned by the Radio. For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid.

Note that the Operating Class identifies the band and channel width.

- 2.13
ChannelScanNumberOfEntries unsignedInt - The number of entries in the ChannelScan table. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}. object -

The Channel associated with an Operating Class of neighboring Access Points discovered by a Radio during a channel scan.

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

- 2.13
Channel unsignedInt­[:255] - The channel number of the Channel scanned by the Radio given the Operating Class. - 2.13
TimeStamp string - The timestamp of the last scan of the channel. - 2.13
Utilization unsignedInt­[:255] - The current Channel Utilization measured by the Radio on the scanned 20MHz channel, as defined by [Section 9.4.2.28/802.11-2016]. - 2.13
Noise unsignedInt­[:255] -

An indicator of the average radio noise plus interference power measured for the primary operating channel.

Encoded as defined for ANPI in [Section 11.11.9.4/802.11-2016].

- 2.13
NeighborBSSNumberOfEntries unsignedInt - The number of entries in the NeighborBSS table. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.NeighborBSS.{i}. object -

The neighboring BSS discovered by a Radio during a channel scan.

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

- 2.13
BSSID string­(17) - [MACAddress] The BSSID indicated by the neighboring BSS. - 2.13
SSID string - The SSID indicated by the neighboring BSS. - 2.13
SignalStrength unsignedInt­[:255] -

An indicator of radio signal strength (RSSI) of the Beacon or Probe Response frames of the neighboring BSS as received by the radio measured in dBm. (RSSI is encoded per Table 9-154 of [802.11-2016]). Reserved: 221 - 255.

NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details.

- 2.13
ChannelBandwidth string - Indicates the maximum bandwidth at which the neighboring BSS is operating. e.g. "20" or "40" or "80" or "80+80" or "160" MHz. - 2.13
ChannelUtilization unsignedInt­[:255] - The channel utilization reported by the neighboring BSS per the BSS Load element if present in Beacon or Probe Response frames, as defined by Section 9.4.2.28 in [802.11-2016]. - 2.13
StationCount unsignedInt - The number of Associated Devices (STA) reported by this neighboring BSS per the BSS Load element if present in Beacon or Probe Response frames as defined by [Section 9.4.2.28/802.11-2016]. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.UnassociatedSTA.{i}. object -

Each instance represents a Non-AP STA that has been discovered by the Radio but is not associated to any of the BSS operating on the Radio.

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

- 2.13
MACAddress string­(17) - [MACAddress] The MAC address of the Non-AP STA. - 2.13
SignalStrength unsignedInt­[:255] -

An indicator of radio signal strength (RCPI) of the uplink from the Non-AP STA - measured in dBm. (RCPI threshold is encoded per Table 9-154 of [802.11-2016], and described in 103.2 of [MAPv1.0]). Reserved: 221 - 255.

NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details.

- 2.13
Device.WiFi.DataElements.AssociationEvent. object - This object contains the events generated when a STA associates to a BSS. - 2.13
AssociationEventDataNumberOfEntries unsignedInt - The number of entries in the AssociationEventData table. - 2.13
Device.WiFi.DataElements.AssociationEvent.AssociationEventData.{i}. object - The events generated when an Associated Device (STA) associates to a BSS. - 2.13
BSSID string­(17) - [MACAddress] The MAC Address of the logical BSS ( BSSID) which is reporting the Association Event. - 2.13
MACAddress string­(17) - [MACAddress] The MAC Address of the Associated Device (STA). - 2.13
StatusCode unsignedInt - The status code sent to the Associated Device (STA) in the Association Response frame as defined by Table 9-46 in [802.11-2016]. - 2.13
HTCapabilities base64­(1:1) - Describes the HT capabilities of the Associated Device (STA). - 2.13
VHTCapabilities base64­(2:6) - Describes the VHT capabilities of the Associated Device (STA). - 2.13
HECapabilities base64­(4:14) - Describes the HE capabilities of the Associated Device (STA). - 2.13
TimeStamp string - The time this event was collected. - 2.13
Device.WiFi.DataElements.DisassociationEvent. object - This object contains the events generated when an Associated Device (STA) disassociates from a BSS. - 2.13
DisassociationEventDataNumberOfEntries unsignedInt - The number of entries in the DisassociationEventData table. - 2.13
Device.WiFi.DataElements.DisassociationEvent.DisassociationEventData.{i}. object - The events generated when an Associated Device (STA) disassociates from a BSS. - 2.13
BSSID string­(17) - [MACAddress] The MAC Address of the logical BSS ( BSSID) which is reporting the Disassociation Event. - 2.13
MACAddress string­(17) - [MACAddress] The MAC address of the Associated Device (STA). - 2.13
ReasonCode unsignedInt - The Reason Code received by the AP from the Associated Device (STA) in the most recent Disassociation or Deauthentication frame or sent by the AP to the Associated Device (STA) in the most recent Disassociation or Deauthenticaiton frame as defined in Table 9-45 in [802.11-2016]. - 2.13
BytesSent unsignedLong - [StatsCounter64] The total number of bytes transmitted to the Associated Device (STA). - 2.13
BytesReceived unsignedLong - [StatsCounter64] The total number of bytes received from the Associated Device (STA). - 2.13
PacketsSent unsignedLong - [StatsCounter64] The total number of packets transmitted to the Associated Device (STA). - 2.13
PacketsReceived unsignedLong - [StatsCounter64] The total number of packets received from the Associated Device (STA). - 2.13
ErrorsSent unsignedInt - [StatsCounter32] The total number of outbound packets that could not be transmitted to the Associated Device (STA) because of errors. These might be due to the number of retransmissions exceeding the retry limit or from other causes. - 2.13
ErrorsReceived unsignedInt - [StatsCounter32] The total number of inbound packets from the Associated Device (STA) that contained errors preventing them from being delivered to a higher-layer protocol. - 2.13
RetransCount unsignedInt -

[StatsCounter32] The total number of transmitted packets to the Associated Device (STA) which were retransmissions.

N retransmissions of the same packet results in this counter incrementing by N.

- 2.13
TimeStamp string - The time this event was collected. - 2.13
Device.WiFi.Radio.{i}. object -

This object models an 802.11 wireless radio on a device (a stackable interface object as described in [Section 4.2/TR-181i2]).

If the device can establish more than one connection simultaneously (e.g. a dual radio device), a separate Radio instance MUST be used for each physical radio of the device. See [Appendix III.1/TR-181i2] for additional information.

Note: A dual-band single-radio device (e.g. an 802.11a/b/g radio) can be configured to operate at 2.4 or 5 GHz frequency bands, but only a single frequency band is used to transmit/receive at a given time. Therefore, a single Radio instance is used even for a dual-band radio.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. The non-functional key parameters Alias and Name are immutable and therefore MUST NOT change once they've been assigned.

- 2.0
CenterFrequencySegement0 unsignedInt W When operating in 80+80MHz, this parameter determines the Center Frequency Segment 0 for the first 80 MHz channel. See [Section 9.4.2.161/802.11-2016] and Table 9-252. - 2.13
CenterFrequencySegement1 unsignedInt W When operating in 80+80MHz, this parameter determines the Center Frequency Segment 1 for the second 80 MHz channel. See [Section 9.4.2.161/802.11-2016] and Table 9-252. - 2.13
Device.WiFi.AccessPoint.{i}. object W

This object models an 802.11 connection from the perspective of a wireless access point. Each AccessPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter.

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

Note: The AccessPoint table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated AccessPoint row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending AccessPoint row.

At most one entry in this table can exist with a given value for Alias, or with a given value for SSIDReference. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.0
Device.WiFi.AccessPoint.{i}.Security. object - This object contains security related parameters that apply to a CPE acting as an Access Point [802.11-2007]. - 2.0
SAEPassphrase string W

A passphrase for WPA3-Personal or WPA3-Personal-Transition security modes.

NOTE: this parameter is for WPA3. WPA2 PreSharedKey is generated from KeyPassphrase.

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

- 2.13
Device.WiFi.EndPoint.{i}. object W

This object models an 802.11 connection from the perspective of a wireless end point. Each EndPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter, and an associated active Profile instance via the ProfileReference parameter. The active profile is responsible for specifying the actual SSID and security settings used by the end point.

For enabled table entries, if SSIDReference or ProfileReference is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

Note: The EndPoint table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated EndPoint row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending EndPoint row.

At most one entry in this table can exist with a given value for Alias, or with a given value for SSIDReference. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.0
Device.WiFi.EndPoint.{i}.Profile.{i}. object W

EndPoint Profile table.

At most one entry in this table can exist with a given value for Alias, or with all the same values for SSID, Location and Priority. On creation of a new table entry, the Agent MUST choose initial values for Alias, SSID and Location such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.0
Device.WiFi.EndPoint.{i}.Profile.{i}.Security. object - This object contains security related parameters that apply to a WiFi End Point profile [802.11-2007]. - 2.0
SAEPassphrase string W

A passphrase for WPA3-Personal or WPA3-Personal-Transition security modes.

NOTE: this parameter is for WPA3. WPA2 PreSharedKey is generated from KeyPassphrase.

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

- 2.13
Device.IP. object - IP object that contains the Interface, ActivePort, and Diagnostics objects. - 2.0
Device.IP.Diagnostics. object - The IP Diagnostics object. - 2.0
IPPing() command - [ASYNC] This command provides access to an IP-layer ping test. - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string -

Indicates the availability of diagnostics data. Enumeration of:

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

- 2.13
TraceRoute() command - [ASYNC] This command defines access to an IP-layer trace-route test for the specified IP interface. - 2.13
⇒ Input. arguments - Input arguments. -
⇐ Output. arguments - Output arguments. -
⇐ Status string -

Indicates the availability of diagnostics data. Enumeration of:

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

- 2.13
DownloadDiagnostics() command -

[ASYNC] This command defines the diagnostics configuration for a HTTP and FTP DownloadDiagnostics Test.

Files received in the DownloadDiagnostics do not require file storage on the CPE device.

- 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string -

Indicates the availability of diagnostics data. Enumeration of:

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

- 2.13
UploadDiagnostics() command -

[ASYNC] This command defines the diagnostics configuration for a HTTP or FTP UploadDiagnostics test.

Files sent by the UploadDiagnostics do not require file storage on the CPE device, and MAY be an arbitrary stream of bytes.

- 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string -

Indicates the availability of diagnostics data. Enumeration of:

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

- 2.13
UDPEchoDiagnostics() command - [ASYNC] This command defines the diagnostics configuration for a UDP Echo test [Appendix A.1/TR-143] defined in [RFC862] or a UDP Echo Plus test defined in [Appendix A.1/TR-143]. - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string -

Indicates the availability of diagnostics data. Enumeration of:

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

- 2.13
ServerSelectionDiagnostics() command - [ASYNC] This command provides access to a diagnostics test that performs either an ICMP Ping or UDP Echo ping against multiple hosts determining which one has the smallest average response time. There MUST be a ping response to the transmitted ping, or timeout, before the next ping is sent out. - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string -

Indicates the availability of diagnostics data. Enumeration of:

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

- 2.13
Device.NeighborDiscovery. object - The Neighbor Discovery Protocol (NDP) object [RFC4861]. This object applies only to IPv6. It contains an InterfaceSetting table that defines the NDP configuration for individual IP interfaces. - 2.2
Device.NeighborDiscovery.InterfaceSetting.{i}. object W

Per-interface Neighbor Discovery Protocol (NDP) configuration [RFC4861].

For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

Note: The InterfaceSetting table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated InterfaceSetting row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending InterfaceSetting row.

At most one entry in this table can exist with a given value for Alias, or with a given value for Interface. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.2
DADTransmits unsignedInt W

The number of consecutive Neighbor Solicitation messages sent while performing Duplicate Address Detection on a tentative address (see[Section 5.1/RFC4862]).

A value of zero indicates that Duplicate Address Detection is not performed on tentative addresses.

A value of one indicates a single transmission with no follow-up retransmissions.

If the value is greater than 1, RetransTimer defines the delay between consecutive messages.

1 2.13
Device.Hosts. object - This object provides information about each of the hosts on the LAN, including those whose IP address was allocated by the CPE using DHCP as well as hosts with statically allocated IP addresses. It can also include non-IP hosts. - 2.0
Device.Hosts.Host.{i}. object -

Host table.

At most one entry in this table can exist with a given value for Alias, or with a given value for PhysAddress. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.0
InterfaceType string -

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

- 2.13
Device.DNS. object - Properties for Domain Name Service (DNS). - 2.0
Device.DNS.Diagnostics. object - The DNS Diagnostics object containing the NSLookupDiagnostics() test. - 2.0
NSLookupDiagnostics() command -

[ASYNC] This command defines access to an IP-layer NS Lookup test for the specified IP interface.

When initiated, the NS Lookup test will contact DNSServer and look up HostName NumberOfRepetitions times.

There will be a Result instance for each time the device performs a DNS lookup, which is determined by the value of NumberOfRepetitions.

Any previous Result instances are removed when a new test is initiated.

- 2.12
⇐ Output. arguments - Output arguments. -
⇐ Status string -

Indicates the availability of diagnostics data. Enumeration of:

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

- 2.13
Device.NAT. object -

Properties for Network Address Translation (NAT).

The entire NAT object only applies to IPv4.

- 2.0
Device.NAT.InterfaceSetting.{i}. object W

NAT settings for an associated IP Interface on which NAT is enabled.

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

Note: The InterfaceSetting table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated InterfaceSetting row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending InterfaceSetting row.

At most one entry in this table can exist with a given value for Alias, or with a given value for Interface. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.0
TCPTranslationTimeout int­[-1:] W Determines the timeout, in seconds, of NAT translations for TCP sessions. It is the time after which a NAT entry is removed from the NAT table if there is no activity. A value of -1 represents an infinite duration. 300 2.13
UDPTranslationTimeout int­[-1:] W Determines the timeout, in seconds, of NAT translations for UDP bindings. It is the time after which a NAT entry is removed from the NAT table if there is no activity. A value of -1 represents an infinite duration. 30 2.13
Device.DHCPv4. object - The Dynamic Host Configuration Protocol (DHCP) IPv4 object [RFC2131]. This entire object applies to IPv4 only. It contains the Client, Server, and Relay objects. - 2.0
Device.DHCPv4.Server. object - DHCP server configuration. - 2.0
Device.DHCPv4.Server.Pool.{i}. object W

DHCP conditional serving pool table.

Each instance of this object defines a DHCP conditional serving pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCP options, and MAC address.

Overlapping pool ranges MUST be supported.

For enabled table entries, if Interface is not a valid reference, or MinAddress, MaxAddress, or SubnetMask is not a valid value, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.0
AllowedDevices string W

Pool association criterion. Determines which devices are allowed, Enumeration of:

  • All (All clients are served)
  • Known (Only clients, whose MAC address is listed in the Client.{i}. table (parameter Client.{i}.Chaddr) or in the StaticAddress.{i}. table (parameter StaticAddress.{i}.Chaddr) are served. The parameter Chaddr is not used, if this value is set)
  • Unknown (Only clients, whose MAC address is not listed in the Client.{i}. table (parameter Client.{i}.Chaddr) or in the StaticAddress.{i}. table (parameter StaticAddress.{i}.Chaddr) are served)
- 2.13
Device.BulkData. object -

This object provides bulk data collection capabilities and global collection settings that affect the entire device.

Bulk Data utilizes various solutions (e.g., IPDR, HTTP) to collect data from devices and transfer the data to a collection server.

The IPDR solution is based on a service specification described in [TR-232].

The HTTP solution is based on transfer mechanisms described in [Annex A/TR-369].

The USPEventNotif solution is based on sending a Device.BulkData.Profile.{i}.Push! Event Notification via USP [TR-369].

The Bulk Data Collection Profiles are measured over a reporting interval (which can be aligned with absolute time) and are made available to the collection server.

- 2.5
Device.BulkData.Profile.{i}. object W

A set of Bulk Data Collection profiles.

Each profile represents a bulk data report, including its own timing configuration, communications configuration, and set of parameters. This allows the Controller to configure multiple reports to be generated at different times for different sets of data.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.5
Push! event - Bulk Data Push event for delivering a bulk data report within a USP Notification message. - 2.13
⇒ Data string - The contents of the bulk data report in the configured CSV or JSON Encoding Type. - 2.13
Device.LocalAgent. object -

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
SupportedThresholdOperator string -

Comma-separated list of strings, each entry is a threshold operation for Threshold.{i}.ThresholdOperator supported by the Agent.

Each list item is an enumeration of:

- 2.13
ThresholdNumberOfEntries unsignedInt - The number of entries in the Threshold table. - 2.13
Device.LocalAgent.MTP.{i}. object 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. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Device.LocalAgent.MTP.{i}.MQTT. object - If the USP Endpoint uses the MQTT Message Transport Protocol (MTP), then this object contains MQTT Client specific configuration parameters related to how the Agent communicates with the MQTT broker. - 2.13
Reference string W The value MUST be the Path Name of a row in the MQTT.Client table. A reference to the MQTT Client used by this Agent when communicating via the MQTT MTP. <Empty> 2.13
ResponseTopicConfigured string­(65535) W The Agent's configured "reply to" topic. When MQTT 5.0 is being used, this value is put in the PUBLISH Response Topic property for all PUBLISH packets with a USP Record, if no Response Information (value recorded in ResponseTopicDiscovered) is included in the CONNACK. When MQTT 3.1.1 is being used, this value is put at the end of the PUBLISH Topic Name property (as specified in [Section "MQTT Binding"/TR-369]. If the value of ResponseTopicConfigured is not a subset (wildcarded or precise match) of any of the Reference MQTT.Client.{i}.Subscription.{i}.Topic values the Agent MUST subscribe to this Topic. The value MUST NOT contain any wild card characters (“+”, “#”). - 2.13
ResponseTopicDiscovered string­(65535) - Duplicate of Reference MQTT.Client.{i}.ResponseInformation. This is the value of the CONNACK Response Information property supplied by a MQTT 5.0 server and is used by a MQTT 5.0 client as the basis for the PUBLISH Response Topic property for all PUBLISH packets that expect a response. If a value is received from the MQTT 5.0 server, it will be used instead of any value configured in ResponseTopicConfigured. - 2.13
PublishQoS unsignedInt­[0:2] W

The Agent MUST use this QoS value when sending a USP Record on this MTP.

If the referenced MQTT Client uses MQTT 5.0 and the MQTT server only indicates support for a QoS value in the CONNACK Maximum QoS property lower than this QoS value, the Agent MUST use the highest QoS value that is supported by the server.

- 2.13
Device.LocalAgent.Threshold.{i}. object W

Each instance of this table represents a Threshold Event that is triggered by a threshold test.

For example:

ReferencePath: Device.Ethernet.[Enable==1].Stats.

ThresholdParam: BytesSent

ThresholdOperator: Rise

ThresholdValue: 100000

Would trigger a Triggered! Event whenever a value of a parameter matching Device.Ethernet.[Enable==1].Stats.BytesSent rises from below to above 100000.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.13
Alias string­(64) W

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.

- 2.13
Enable boolean W

Enable/Disable this Threshold instance.

If the Threshold instance is disabled, the Triggered! Event will not be invoked, even if there is a LocalAgent.Subscription.{i}. instance that references it

false 2.13
OperatingMode string W

Determines whether to disable this Threshold instance after the Triggered! Event has been invoked. Enumeration of:

"Normal" 2.13
ReferencePath string W

The combination of ReferencePath and ThresholdParam create the reference to the parameter being checked for the threshold test.

ReferencePath can be either an Object Path or a Search Path.

- 2.13
ThresholdParam string W

The combination of ReferencePath and ThresholdParam create the reference to the parameter being checked for the threshold test.

ThresholdParam is the name of the Parameter in the context of ReferencePath.

- 2.13
ThresholdOperator string W The value MUST be a member of the list reported by the Device.LocalAgent.SupportedThresholdOperator parameter. The operator used for the threshold test. "Rise" 2.13
ThresholdValue string W The Value used for the threshold test. - 2.13
Triggered! event -

Triggered event requested via a Threshold object.

When any of the Threshold.{i}.ThresholdParams that are in the Threshold.{i}.ReferencePath change and the threshold test conditation changes from false to true, the Triggered Event will be invoked. The Triggered Event will only be eligible for retriggering if the test condition is fulfilled again.

- 2.13
⇒ ParamPath string - The parameter (LocalAgent.Threshold.{i}.ReferencePath and LocalAgent.Threshold.{i}.ThresholdParam) for which the threshold has been triggered. - 2.13
⇒ ParamValue string - The new (LocalAgent.Threshold.{i}.ReferencePath and LocalAgent.Threshold.{i}.ThresholdParam) Value. - 2.13
Device.LocalAgent.Controller.{i}. object 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. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Device.LocalAgent.Controller.{i}.MTP.{i}. object 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. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Device.LocalAgent.Controller.{i}.MTP.{i}.MQTT. object - If the USP Endpoint uses the MQTT Message Transport Protocol (MTP), then this object contains MQTT Client specific configuration parameters related to how this Controller communicates with the MQTT broker. - 2.13
Reference string W The value MUST be the Path Name of a row in the MQTT.Client table. A reference to the MQTT Client used by this Controller when communicating via the MQTT MTP. <Empty> 2.13
Topic string­(65535) W The topic name the USP Controller has subscribed to, to be used for Notify messages send by the USP Agent. - 2.13
Device.LocalAgent.Subscription.{i}. object 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 Recipient and ID. On creation of a new table entry, the Agent MUST choose initial values for Alias and Recipient such that the new entry does not conflict with any existing entries. The non-functional key parameters Alias, Recipient and ID are immutable and therefore MUST NOT change once they've been assigned.

- 2.12
ReferenceList string W

Comma-separated list of strings (maximum item length 256). Each entry in the list is a Path Name, Search Path, Command reference, or Event reference that determines the element(s) 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.

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.

The following bullet points describe what is allowed as a value of ReferenceList based on the different values of the NotifType parameter:

  • ValueChange: may be either a Path Name or Search Path; if an Object Path (one type of Path Name) then it is treated like a filter match such that all supported parameters in all objects below this point will be relevant for the subscription.
  • ObjectCreation: may be either a Path Name or Search Path as long as it only refers to a Multi-Instance Object; only the referenced Multi-Instance Objects will be relevant for the subscription.
  • ObjectDeletion: may be either a Path Name or Search Path as long as it only refers to instances of a Multi-Instance Object; only the referenced instances (wildcard references all instances over time) of the Multi-Instance Objects will be relevant for the subscription.
  • OperationComplete: may be either a Path Name, Search Path, or Command reference; if an Object Path (one type of Path Name) then it is treated like a filter match such that all supported data model commands in all objects below this point will be relevant for the subscription.
  • Event: may be either a Path Name, Search Path, or Event reference; if an Object Path (one type of Path Name) then it is treated like a filter match such that all supported Events in all objects below this point will be relevant for the subscription.
- 2.13
Device.IEEE1905. object - This object represents the management functions for the 1905 capabilities as defined in [IEEE1905.1a]. - 2.9
Device.IEEE1905.AL. object - This object represents the management functions for the 1905 Abstraction Layer as defined in [Section 4.4 Abstraction Layer/IEEE1905.1a]. - 2.9
Device.IEEE1905.AL.NetworkTopology. object - This object represents the 1905 Network Topology capabilities of this device. - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}. object -

This object represents an instance of discovered 1905 Devices in the network (received Topology discovery message as defined in [Clause 6.3.1/IEEE1905.1a]).

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

- 2.9
AssocWiFiNetworkDeviceRef string - The value MUST be the Path Name of a row in the WiFi.MultiAP.APDevice table. If the referenced object is deleted, the parameter value MUST be set to an empty string. AssocWiFiNetworkDeviceRef is a reference to the Wi-Fi Network "APDevice". Since IEEE 1905.1 is the protocol used by the Wi-Fi Alliance's EasyMesh specification for communications, this parameter allows the IEEE 1905.1 portion of the data model to reference the associated EasyMesh portion of the data model. - 2.13
Device.MQTT. object - MQTT Base object describing all MQTT related parameters and objects. - 2.10
Device.MQTT.Client.{i}. object W

MQTT client table. Contains a list of configured MQTT clients.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. The non-functional key parameters Alias and Name are immutable and therefore MUST NOT change once they've been assigned.

- 2.10
CleanStart boolean W

The value of the MQTT Clean Start flag in the MQTT CONNECT packet (see [Section 3.1.2.4/MQTT50]. If this flag is set to true (default), the MQTT broker will delete all subscription information after a Disconnect.

A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed..

This parameter only applies if ProtocolVersion is set to 5.0.

true 2.13
SessionExpiryInterval unsignedInt W

Session expiry interval in seconds defines the wait time before a session expires after the connection has been closed by the MQTT client [Section 3.1.2.11.2/MQTT50]).

This parameter only applies if ProtocolVersion is set to 5.0.

- 2.13
ReceiveMaximum unsignedInt W

The MQTT client uses this value to limit the number of QoS 1 and QoS 2 publications that it is willing to process concurrently (see [Section 3.1.2.11.3/MQTT50]).

A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed.

This parameter only applies if ProtocolVersion is set to 5.0.

- 2.13
MaximumPacketSize unsignedInt W

The maximum packet size in byte the MQTT client can and will accept from the MQTT broker. A value of 0 means no limit. If the value is set to another value, the MQTT client will inform the broker in the next CONNECT packet [Section 3.1.2.11.4/MQTT50]).

A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed.

This parameter only applies if ProtocolVersion is set to 5.0.

- 2.13
TopicAliasMaximum unsignedInt­[:65535] W

This value indicates the highest value that the MQTT client will accept as a Topic Alias sent by the Server (see [Section 3.1.2.11.5/MQTT50]). The MQTT client uses this value to limit the number of Topic Aliases that it is willing to hold on this connection.

A value of 0 indicates that Topic Alias is not supported.

A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed.

This parameter only applies if ProtocolVersion is set to 5.0.

- 2.13
RequestResponseInfo boolean W

The MQTT client uses this value in a MQTT CONNECT packet to request the Server to return Response Information in the MQTT CONNACK (see [Section 3.1.2.11.6/MQTT50]).

A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed.

This parameter only applies if ProtocolVersion is set to 5.0.

- 2.13
RequestProblemInfo boolean W

This value indicates whether the Reason String or User Properties are sent in the case of failures.(see [Section 3.1.2.11.7/MQTT50]).

A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed.

This parameter only applies if ProtocolVersion is set to 5.0.

- 2.13
AuthenticationMethod string­(256) W

This value defines the extended authentication method to be used (see [Section 3.1.2.11.9/MQTT50]).

If the parameter is empty, no extended authentication is performed.

A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed.

This parameter only applies if ProtocolVersion is set to 5.0.

- 2.13
WillDelayInterval unsignedInt W

The delay in seconds after the session is disconnected, before sending the Will message [Section 3.1.3.2.2/MQTT50]). A value of 0 indicates that there is no delay.

A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet.

If will handling is enabled (Parameter WillEnable is set to true) and the change needs to be applied immediately, the command ForceReconnect() has to be executed.

This parameter only applies if ProtocolVersion is set to 5.0.

5 2.13
WillMessageExpiryInterval unsignedInt W

The lifetime in seconds of a Will Message (see [Section 3.1.3.2.4/MQTT50]). A value of 0 indicates that no message expiry interval value is specified for in the will message properties of a CONNECT packet.

This parameter only applies if ProtocolVersion is set to 5.0.

- 2.13
WillContentType string­(256) W

Describes the type of the WillValue [Section 3.1.3.2.5/MQTT50]).

A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet.

If will handling is enabled (Parameter WillEnable is set to true) and the change needs to be applied immediately, the command ForceReconnect() has to be executed.

This parameter only applies if ProtocolVersion is set to 5.0.

- 2.13
WillResponseTopic string­(65535) W

Topic Name for a will response message. The presence of a Response Topic identifies the Will Message as a Request [Section 3.1.3.2.6/MQTT50]).

If the WillResponseTopic is an empty string the will response topic will not be sent in a MQTT CONNECT packet.

A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet.

If will handling is enabled (Parameter WillEnable is set to true) and the change needs to be applied immediately, the command ForceReconnect() has to be executed.

This parameter only applies if ProtocolVersion is set to 5.0.

- 2.13
PublishMessageExpiryInterval unsignedInt W

The lifetime in seconds of a PUBLISH Message (see [Section 3.3.2.3.3/MQTT50]). A value of 0 indicates that no message expiry interval value is included in the PUBLISH packet.

This parameter only applies if ProtocolVersion is set to 5.0.

- 2.13
ConnectRetryIntervalMultiplier unsignedInt­[1000:65535] W

Configures the retry interval multiplier.

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

2000 2.13
ConnectRetryMaxInterval unsignedInt­[1:] W The maximum reconnection wait interval, in seconds. 30720 2.13
ResponseInformation string­(65535) - The value of the CONNACK Response Information property supplied by a MQTT 5.0 server. This value is used by a MQTT 5.0 client as the basis for the PUBLISH Response Topic property for all PUBLISH packets that expect a response. If the value of ResponseInformation is not a subset (wildcarded or precise match) of any of the Subscription.{i}.Topic values the MQTT client MUST subscribe to this Topic. - 2.13
UserPropertyNumberOfEntries unsignedInt - The number of entries in the UserProperty table. - 2.13
Device.MQTT.Client.{i}.UserProperty.{i}. object W

List of user properties used by the MQTT client.

This table only applies if #.ProtocolVersion is set to 5.0.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.13
Alias string­(64) W

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.

- 2.13
Enable boolean W Setting Enable to true means the user property is used in the indicated control packet(s). The user property will be applied to all control packets of the same control packet type (e.g PUBLISH). - 2.13
Name string­(65535) W Name of the user property - 2.13
Value string­(65535) W Value of the user property - 2.13
PacketType string W

Comma-separated list of strings. Each entry defines the control packet type(s) in which the user property is included. Each list item is an enumeration of:

  • AUTH (User property will be added in the AUTH control packet (see [Section 3.15.2.2.5/MQTT50]))
  • CONNECT (User property will be added in the CONNECT packet (see [Section 3.1.3.2.8/MQTT50]))
  • DISCONNECT (User property will be added in the DISCONNECT packet (see [Section 3.14.2.2.4/MQTT50]))
  • PUBLISH (User property will be added in the PUBLISH packet (see [Section 3.3.2.3.7/MQTT50]))
  • PUBACK (User property will be added in the PUBACK packet (see [Section 3.4.2.2.3/MQTT50]))
  • PUBREC (User property will be added in the PUBREC packet (see [Section 3.5.2.2.3/MQTT50]))
  • PUBREL (User property will be added in the PUBREL packet (see [Section 3.6.2.2.3/MQTT50]))
  • PUBCOMP (User property will be added in the PUBCOMP packet (see [Section 3.7.2.2.3/MQTT50]))
  • SUBSCRIBE (User property will be added in the SUBSCRIBE packet (see [Section 3.8.2.1.3/MQTT50]))
  • UNSUBSCRIBE (User property will be added in the UNSUBSCRIBE packet (see [Section 3.10.2.1.2/MQTT50]))
  • WILL (User property will be added in the WILL properties (see [Section 3.1.3.2/MQTT50]))
- 2.13
Device.MQTT.Broker.{i}. object W

MQTT broker table. Contains a list of configured MQTT brokers.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. The non-functional key parameters Alias and Name are immutable and therefore MUST NOT change once they've been assigned.

- 2.10
Device.MQTT.Broker.{i}.Bridge.{i}. object W

Configures MQTT bridges, which are used to communicate with other MQTT brokers.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. The non-functional key parameters Alias and Name are immutable and therefore MUST NOT change once they've been assigned.

- 2.10
CleanStart boolean W

The value of the MQTT Clean Start flag in the MQTT CONNECT packet (see [Section 3.1.2.4/MQTT50] to establish a MQTT bridge connection. If this flag is set to true (default), the remote MQTT broker will delete all subscription information after a Disconnect.

A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the command ForceReconnect() has to be executed..

This parameter only applies if ProtocolVersion is set to 5.0.

true 2.13
Device.LMAP. object - This object represents the objects necessary to manage and control the functionality for Large-Scale Measurement of Broadband Performance[RFC7594] as defined in by [LMAPIFM]. - 2.12
Device.LMAP.MeasurementAgent.{i}. object W

This object represents the measurement agent that performs measurement tasks and reporting functions defined in [RFC7594].

At most one entry in this table can exist with a given value for Alias, or with a given value for Identifier. On creation of a new table entry, the Agent MUST choose initial values for Alias and Identifier such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Device.LMAP.MeasurementAgent.{i}.Controller. object - This objects represents the measurement controller that is assigned to a measurement agent. - 2.12
ControllerTimeout int­[0:] W

The timer, in seconds, that is started after each successful contact with a measurement controller.

When the timer reaches the timeout en event is raised indicating that connectivity to the controller has been lost.

- 2.13
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}. object W

This object represents a schedule that is associated with a set of scheduled actions to be performed by a measurement agent.

Note: Actions of an occurrence of this Schedule are gracefully terminated by the defining either the End or Duration parameters. Only one of these parameters may be defined at a time.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Stats. object - This object represents the statistics associated with this object. - 2.12
Invocations unsignedLong - Number of invocations of this schedule. This counter does not include suppressed invocations or invocations that were prevented due to an overlap with a previous invocation of this schedule. - 2.13
Device.LMAP.Event.{i}. object W

This object defines the information associated with an event used within the measurement agent. Event instances may be referenced by various objects within the LMAP model.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Device.LMAP.Event.{i}.PeriodicTimer. object - This object defines a periodic timer instance. The periodic timer instance has attributes for when the timer is to begin (StartTime) and end (EndTime) as well as the interval to use. - 2.12
StartTime dateTime W Date and time, based on [RFC3339], that the PeriodicTimer instance is to begin operation. - 2.13
Device.ProxiedDevice.{i}. object -

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. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.12
Type string -

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

- 2.13
Description string­(256) - Human-readable description of the ProxiedDevice. e.g. a more detailed description of Type. - 2.13
Name string­(64) W A textual name of the instance, which can be assigned by the user. ProxiedDevice. - 2.13
Online boolean - This parameter provides the state of the ProxiedDevice on the underlying (proxied) connected network. - 2.13
LastTimeContacted dateTime - The date time of the last successful contact. - 2.13
InterfaceReference string - The value MUST be the Path Name of a protocol object that uses the ProxyProtocol. If the referenced object is deleted, the parameter value MUST be set to an empty string. . - 2.13
ProxyProtocol string -

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

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

- 2.13
NodeNumberOfEntries unsignedInt - The number of entries in the Node table. - 2.13
Device.ProxiedDevice.{i}.Node.{i}. object -

Each Node instance represents distinct functional devices, which are virtual and abstracted representation of functionality.

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. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.13
Alias string­(64) W

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.

- 2.13
Type string -

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

- 2.13
Description string­(256) - Human-readable description of the Node. e.g. a more detailed description of Type. - 2.13
Device.IoTCapability.{i}. object -

This list of IoT capability objects.

This object is mountable as a child of mount points.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. The non-functional key parameters Alias and Name are immutable and therefore MUST NOT change once they've been assigned.

- 2.13
Alias string­(64) W

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.

- 2.13
Name string­(64) W A textual name of the instance, which can be assigned by the user. - 2.13
Class string -

Describes the type of functionality that IoTCapability is representing. Depending on the functionality the corresponding sub-object is instantiated.

Note: Only one of the defined sub-objects can exist in an IoTCapability instance. Enumeration of:

- 2.13
Device.IoTCapability.{i}.BinaryControl. object -

This capability provides a boolean function that is mapped to the type of function it represents.

E.g. If the instance represents a door lock (Type is Locked), a Value of true says the door lock is locked.

- 2.13
Type string -

Describes the type of functionality that BinaryControl is representing. Enumeration of:

- 2.13
Description string­(256) - Human-readable description of the BinaryControl. e.g. a more detailed description of Type. - 2.13
Value boolean W Value of true or false that reflects the functionality. - 2.13
Toggle() command - [ASYNC] Toggle the Value. - 2.13
Device.IoTCapability.{i}.LevelControl. object -

LevelController is used to model a control with a range of continuous states.

These values are configurable via Value and measured in Unit and are restricted between a Min and Max values.

Intensity profile - Value of intensity and ability to update that level through StepUp and StepDown commands with a configurable StepValue.

- 2.13
Type string -

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

- 2.13
Description string­(256) - Human-readable description of the LevelControl. e.g. a more detailed description of Type. - 2.13
Value decimal W The desired run value that this LevelControl will be between MinValue and MaxValue. - 2.13
Unit string -

Units in which Value, Value, MinValue, MaxValue and StepValue are expressed. Possible Unit types used for decimal values. Enumeration of:

  • - (Dimensionless quantity)
  • % (Percent)
  • deg (Decimal degrees)
  • degC (Celsius)
  • degF (Fahrenheit)
  • K (Kelvin [SI])
  • km (Kilometer [SI])
  • m (Meter [SI])
  • cm (Centimeter [SI])
  • mm (Millimeter [SI])
  • h (Hour)
  • min (Minute)
  • s (Second [SI])
  • ms (Millisecond)
  • sq-km (Square kilometer)
  • sq-m (Square meter)
  • sq-cm (Square cm)
  • cu-m (Cubic meter)
  • l (Liter [SI])
  • cl (Centiliter [SI])
  • ml (Milliliter [SI])
  • kg (Kilogram [SI])
  • g (Gram [SI])
  • mg (Milligram [SI])
  • Wh (Watt hour)
  • kWh (Kilowatt hour)
  • W (Watt [SI])
  • A (Ampere [SI])
  • Hz (Hertz [SI])
  • V (Volt [SI])
  • N (Newton [SI])
  • Pa (Pascal [SI])
  • C (Coulomb [SI])
  • F (Farad [SI])
  • ohm (Ohm [SI])
  • S (Siemens [SI])
  • Wb (Weber [SI])
  • T (Tesla [SI])
  • H (Henry [SI])
  • lm (Lumen [SI])
  • lx (Lux [SI])
  • mps (Meter per second)
  • cd (Candela [SI])
  • mol (Mole [SI])
  • UV (Ultraviolet index)
  • RGB (RGB color, encoded as integer value between 0 (usually represented as 0x000000) and 16777215 (usually represented as 0xFFFFFF), e.g. Blue would be 255 (usually represented as 0x0000FF))
  • ppm (Parts per million (Alternative use percent: 1ppm = 0.0001%))
  • Sv (Sievert (J/kg) [SI])
  • J (Joule [SI]).
- 2.13
MinValue decimal - Minimum allowed value for Value. - 2.13
MaxValue decimal - Maximum allowed value for Value. - 2.13
StepValue decimal W Number of Unit changes of each StepUp() and StepDown() command. - 2.13
StepUp() command - [ASYNC] Step Up the Value. - 2.13
StepDown() command - [ASYNC] Step Down the Value. - 2.13
Device.IoTCapability.{i}.EnumControl. object -

The EnumControl reflects the Enumerated level Control functionality.

The enumeration is defined by the ValidValues parameter. This will provide a comma-separated list of values that are available for configuring via the Value parameter.

- 2.13
Type string -

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

- 2.13
Description string­(256) - Human-readable description of the EnumControl. e.g. a more detailed description of Type. - 2.13
Value string W Current value representing the EnumControl; MUST be an element of ValidValues. - 2.13
ValidValues string - Comma-separated list of strings (maximum item length 64). List of valid values from the control represented by the EnumControl. - 2.13
StepUp() command - [ASYNC] Step up the Value to the next allowed value in the enum. - 2.13
StepDown() command - [ASYNC] Step down the Value to the previous allowed value in the enum. - 2.13
Device.IoTCapability.{i}.BinarySensor. object -

BinarySensor is used to reflect the functionality of a sensor that reports a Value. The Sensitivity configures the degree of sensitivity that the sensor uses for detection.

Timed BinarySensor profile - To provide the ability to add time based control over the Value attribute. How long the Value remains true is controlled by the HoldTime. RestTime controls how soon, after being activated, the sensor will respond to continuous events.

- 2.13
Type string -

Describes the type of functionality that BinarySensor is representing. Enumeration of:

- 2.13
Description string­(256) - Human-readable description of the BinarySensor. e.g. a more detailed description of Type. - 2.13
Value boolean - If the BinarySensor has been recently activated, the value would be true. For how long the state attribute remain true after being activated depends on the underlying sensor reports. - 2.13
LastChange dateTime - The date and time in UTC when Value has been changed to the current value. - 2.13
Sensitivity unsignedInt­[:100] W A 0 to 100 value indicating how reactive to changes the BinarySensor should be, 0 being not sensible / disabled and 100 max sensitivity. - 2.13
HoldTime unsignedInt W After activation has been detected and the sensing attribute set to true, how soon, in milliseconds should the Value be reset to false. - 2.13
RestTime unsignedInt W After activation has been detected and the Value set to true, how soon, in milliseconds should affected again per subsequent event. - 2.13
Device.IoTCapability.{i}.LevelSensor. object - LevelSensor is used to reflect the functionality of a sensor that reports a Value in Unit. - 2.13
Type string -

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

- 2.13
Description string­(256) - Human-readable description of the LevelSensor. e.g. a more detailed description of Type. - 2.13
Value decimal - The current value reading of this LevelSensor in units defined in Unit. - 2.13
LastChange dateTime - The date and time in UTC when Value has been changed to the current value. - 2.13
Unit string -

Possible Unit types used for decimal values. Enumeration of:

  • - (Dimensionless quantity)
  • % (Percent)
  • deg (Decimal degrees)
  • degC (Celsius)
  • degF (Fahrenheit)
  • K (Kelvin [SI])
  • km (Kilometer [SI])
  • m (Meter [SI])
  • cm (Centimeter [SI])
  • mm (Millimeter [SI])
  • h (Hour)
  • min (Minute)
  • s (Second [SI])
  • ms (Millisecond)
  • sq-km (Square kilometer)
  • sq-m (Square meter)
  • sq-cm (Square cm)
  • cu-m (Cubic meter)
  • l (Liter [SI])
  • cl (Centiliter [SI])
  • ml (Milliliter [SI])
  • kg (Kilogram [SI])
  • g (Gram [SI])
  • mg (Milligram [SI])
  • Wh (Watt hour)
  • kWh (Kilowatt hour)
  • W (Watt [SI])
  • A (Ampere [SI])
  • Hz (Hertz [SI])
  • V (Volt [SI])
  • N (Newton [SI])
  • Pa (Pascal [SI])
  • C (Coulomb [SI])
  • F (Farad [SI])
  • ohm (Ohm [SI])
  • S (Siemens [SI])
  • Wb (Weber [SI])
  • T (Tesla [SI])
  • H (Henry [SI])
  • lm (Lumen [SI])
  • lx (Lux [SI])
  • mps (Meter per second)
  • cd (Candela [SI])
  • mol (Mole [SI])
  • UV (Ultraviolet index)
  • RGB (RGB color, encoded as integer value between 0 (usually represented as 0x000000) and 16777215 (usually represented as 0xFFFFFF), e.g. Blue would be 255 (usually represented as 0x0000FF))
  • ppm (Parts per million (Alternative use percent: 1ppm = 0.0001%))
  • Sv (Sievert (J/kg) [SI])
  • J (Joule [SI])

Unit in which Value is expressed.

- 2.13
LowLevel boolean - Low level indicator. Is set to true if Value is equal or less than the value defined in LowLevelThreshold. - 2.13
LowLevelThreshold decimal W The threshold value in for LowLevel expressed in the same units like Value. - 2.13
HighLevel boolean - High level indicator. Is set to true if Value is equal or higher than the value defined in HighLevelThreshold. - 2.13
HighLevelThreshold decimal W The threshold value in for HighLevel expressed in the same units like Value. - 2.13
Device.IoTCapability.{i}.MultiLevelSensor. object - MultiLevelSensor is used to reflect the functionality of a sensor that reports multiple Values with the same Unit. - 2.13
Type string -

Describes the type of functionality that MultiLevelSensor is representing. Enumeration of:

  • RGB (RGB color, encoded as integer value between 0 (usually represented as 0x000000) and 16777215 (usually represented as 0xFFFFFF), e.g. Blue would be 255 (usually represented as 0x0000FF))
  • Location (The sensor reports a location with the values of Longitude, Latitude, Altitude as decimal values in km)
- 2.13
Description string­(256) - Human-readable description of the MultiLevelSensor. e.g. a more detailed description of Type. - 2.13
Values string - Comma-separated list (at least 2 items) of decimals. The current value reading of this MultiLevelSensor in units defined in Unit. - 2.13
ValueNames string - Comma-separated list (at least 2 items) of strings. The names of the values expressed in Values. - 2.13
LastChange dateTime - The date and time when Values has been changed to the current values. - 2.13
Unit string -

Possible Unit types used for decimal values. Enumeration of:

  • - (Dimensionless quantity)
  • % (Percent)
  • deg (Decimal degrees)
  • degC (Celsius)
  • degF (Fahrenheit)
  • K (Kelvin [SI])
  • km (Kilometer [SI])
  • m (Meter [SI])
  • cm (Centimeter [SI])
  • mm (Millimeter [SI])
  • h (Hour)
  • min (Minute)
  • s (Second [SI])
  • ms (Millisecond)
  • sq-km (Square kilometer)
  • sq-m (Square meter)
  • sq-cm (Square cm)
  • cu-m (Cubic meter)
  • l (Liter [SI])
  • cl (Centiliter [SI])
  • ml (Milliliter [SI])
  • kg (Kilogram [SI])
  • g (Gram [SI])
  • mg (Milligram [SI])
  • Wh (Watt hour)
  • kWh (Kilowatt hour)
  • W (Watt [SI])
  • A (Ampere [SI])
  • Hz (Hertz [SI])
  • V (Volt [SI])
  • N (Newton [SI])
  • Pa (Pascal [SI])
  • C (Coulomb [SI])
  • F (Farad [SI])
  • ohm (Ohm [SI])
  • S (Siemens [SI])
  • Wb (Weber [SI])
  • T (Tesla [SI])
  • H (Henry [SI])
  • lm (Lumen [SI])
  • lx (Lux [SI])
  • mps (Meter per second)
  • cd (Candela [SI])
  • mol (Mole [SI])
  • UV (Ultraviolet index)
  • RGB (RGB color, encoded as integer value between 0 (usually represented as 0x000000) and 16777215 (usually represented as 0xFFFFFF), e.g. Blue would be 255 (usually represented as 0x0000FF))
  • ppm (Parts per million (Alternative use percent: 1ppm = 0.0001%))
  • Sv (Sievert (J/kg) [SI])
  • J (Joule [SI])

Unit in which Values are expressed.

- 2.13
Device.IoTCapability.{i}.EnumSensor. object - EnumSensor is used to reflect the functionality of a sensor that reports explicit non-continuous values. - 2.13
Type string -

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

- 2.13
Description string­(256) - Human-readable description of the EnumSensor. e.g. a more detailed description of Type. - 2.13
Value string - The actual reading value; MUST be a member of the enumeration defined in ValidValues. - 2.13
LastChange dateTime - The date and time when Value has been changed to the current value. - 2.13
ValidValues string - Comma-separated list of strings (maximum item length 64). List of valid values reported from the sensor represented by this EnumSensor. - 2.13
Device.Node.{i}. object -

Each Node instance represents distinct functional devices, which are virtual and abstracted representation of functionality.

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. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 2.13
Alias string­(64) W

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.

- 2.13
Type string -

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

- 2.13
Description string­(256) - Human-readable description of the Node. e.g. a more detailed description of Type. - 2.13

Notification Requirements

Parameters for which Value Change Notification MAY be Denied

Parameter
Device.MQTT.Client.{i}.UserProperty.{i}.
Alias
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Stats.
Invocations

Profile Definitions

Notation

The following abbreviations are used to specify profile requirements:

Abbreviation Description
R Read support is REQUIRED.
W Both Read and Write support is REQUIRED. This MUST NOT be specified for a parameter that is defined as read-only.
P The object is REQUIRED to be present.
C Creation and deletion of instances of the object is REQUIRED.
A Creation of instances of the object is REQUIRED, but deletion is not REQUIRED.
D Deletion of instances of the object is REQUIRED, but creation is not REQUIRED.

MQTTClientCon:1 Profile

This table defines the MQTTClientCon:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.13. Provides MQTT client control

Name Requirement
Device.­MQTT. P
ClientNumberOfEntries R
Device.­MQTT.­Client.­{i}. P
Enable W
Status R
ProtocolVersion W
BrokerAddress W
BrokerPort W
CleanSession W
KeepAliveTime W
Name W
ClientID W
Username W
Password W
TransportProtocol W
MessageRetryTime W
ConnectRetryTime W
ConnectRetryIntervalMultiplier W
ConnectRetryMaxInterval W
ResponseInformation R

BinaryControl:1 Profile

This table defines the BinaryControl:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.13.

Name Requirement
Device. P
IoTCapabilityNumberOfEntries R
Device.­IoTCapability.­{i}. P
Class R
Device.­IoTCapability.­{i}.­BinaryControl. P
Type R
Value W

LevelControl:1 Profile

This table defines the LevelControl:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.13.

Name Requirement
Device. P
IoTCapabilityNumberOfEntries R
Device.­IoTCapability.­{i}. P
Class R
Device.­IoTCapability.­{i}.­LevelControl. P
Type R
Value W
Unit R
MinValue R
MaxValue R

LevelControlIntensity:1 Profile

The LevelControlIntensity:1 profile for the Device:2 data model is defined as the union of the LevelControl:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.13.

Name Requirement
Device.­IoTCapability.­{i}.­LevelControl. P
StepUp() P
StepDown() P
StepValue W

EnumControl:1 Profile

This table defines the EnumControl:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.13.

Name Requirement
Device. P
IoTCapabilityNumberOfEntries R
Device.­IoTCapability.­{i}. P
Class R
Device.­IoTCapability.­{i}.­EnumControl. P
Type R
Value W
ValidValues R

BinarySensor:1 Profile

This table defines the BinarySensor:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.13.

Name Requirement
Device. P
IoTCapabilityNumberOfEntries R
Device.­IoTCapability.­{i}. P
Class R
Device.­IoTCapability.­{i}.­BinarySensor. P
Type R
Value R

LevelSensor:1 Profile

This table defines the LevelSensor:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.13.

Name Requirement
Device. P
IoTCapabilityNumberOfEntries R
Device.­IoTCapability.­{i}. P
Class R
Device.­IoTCapability.­{i}.­LevelSensor. P
Type R
Value R
Unit R

LevelSensorLowThreshold:1 Profile

The LevelSensorLowThreshold:1 profile for the Device:2 data model is defined as the union of the LevelSensor:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.13.

Name Requirement
Device.­IoTCapability.­{i}.­LevelSensor. P
LowLevel R
LowLevelThreshold W

LevelSensorHighThreshold:1 Profile

The LevelSensorHighThreshold:1 profile for the Device:2 data model is defined as the union of the LevelSensor:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.13.

Name Requirement
Device.­IoTCapability.­{i}.­LevelSensor. P
HighLevel R
HighLevelThreshold W

MultiLevelSensor:1 Profile

This table defines the MultiLevelSensor:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.13.

Name Requirement
Device. P
IoTCapabilityNumberOfEntries R
Device.­IoTCapability.­{i}. P
Class R
Device.­IoTCapability.­{i}.­MultiLevelSensor. P
Type R
Values R
ValueNames R
Unit R

EnumSensor:1 Profile

This table defines the EnumSensor:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.13.

Name Requirement
Device. P
IoTCapabilityNumberOfEntries R
Device.­IoTCapability.­{i}. P
Class R
Device.­IoTCapability.­{i}.­EnumSensor. P
Type R
Value R
ValidValues R

SELTDiagnostics:1 Profile

This table defines the SELTDiagnostics:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.13.

Name Requirement
Device.­DSL.­Diagnostics. P
SELTUER() P
Input. -
UERMaxMeasurementDuration W
Output. -
Status R
UER R
UERScaleFactor R
UERGroupSize R
UERVar R
SELTQLN() P
Input. -
QLNMaxMeasurementDuration W
Output. -
Status R
QLN R
QLNGroupSize R

PacketCaptureDiagnostics:1 Profile

This table defines the PacketCaptureDiagnostics:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.13.

Name Requirement
Device. P
PacketCaptureDiagnostics() P
Input. -
Interface W
Duration W
FileTarget W
Output. -
PacketCaptureResult.{i}. R
FileLocation R

CoAPAgent:1 Profile

The CoAPAgent:1 profile for the Device:2 data model is defined as the union of the LocalAgent:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.13.

Name Requirement
Device.­LocalAgent.­MTP.­{i}.­CoAP. P
Port R
Path R

WebSocketAgent:1 Profile

The WebSocketAgent:1 profile for the Device:2 data model is defined as the union of the LocalAgent:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.13.

Name Requirement
Device.­LocalAgent.­MTP.­{i}.­WebSocket. P
Port R
Path R

MQTTAgent:1 Profile

The MQTTAgent:1 profile for the Device:2 data model is defined as the union of the LocalAgent:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.13. This profile adds USP agent extensions for MQTT transport.

Name Requirement
Device.­LocalAgent.­MTP.­{i}.­MQTT. P
Reference R
ResponseTopicConfigured W
ResponseTopicDiscovered R

CoAPController:1 Profile

The CoAPController:1 profile for the Device:2 data model is defined as the union of the Controllers:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.13.

Name Requirement
Device.­LocalAgent.­Controller.­{i}.­MTP.­{i}.­CoAP. P
Host R
Port R
Path R

WebSocketController:1 Profile

The WebSocketController:1 profile for the Device:2 data model is defined as the union of the Controllers:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.13.

Name Requirement
Device.­LocalAgent.­Controller.­{i}.­MTP.­{i}.­WebSocket. P
Host R
Port R
Path R

MQTTController:1 Profile

The MQTTController:1 profile for the Device:2 data model is defined as the union of the Controllers:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.13. This profile adds USP controller extensions for MQTT transport.

Name Requirement
Device.­LocalAgent.­Controller.­{i}.­MTP.­{i}.­MQTT. P
Reference R
Topic W

Subscriptions:1 Profile

This table defines the Subscriptions:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.13.

Name Requirement
Device.­LocalAgent. P
SubscriptionNumberOfEntries R
Device.­LocalAgent.­Subscription.­{i}. C
Enable W
Alias W
ID W
Recipient R
CreationDate R
NotifType W
ReferenceList W
Persistent W

ControllerTrust:1 Profile

This table defines the ControllerTrust:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.13.

Name Requirement
Device.­LocalAgent.­ControllerTrust. P
UntrustedRole R
Device.­LocalAgent.­ControllerTrust.­Role.­{i}. P
Alias W
Enable W
Name W
PermissionNumberOfEntries R
Device.­LocalAgent.­ControllerTrust.­Role.­{i}.­Permission.­{i}. P
Alias W
Enable W
Targets R
Param R
Obj R
InstantiatedObj R
CommandEvent R


Generated by Broadband Forum report.pl#424 (2019-07-26 version) on 2019/09/04 at 16:23:07.
report.pl --exitcode=fatals --altnotifreqstyle --ignoreenableparameter --immutablenonfunctionalkeys --markmounttype --cwmpindex=.. --nofontstyles --nowarnreport --quiet --lastonly --report=html --outfile=tr-181-2-13-0-usp-diffs.html tr-181-2-13-0-usp.xml