Broadband Forum

USP Device:2.14 Root Object definition
tr-181-2-14-1-usp.xml (changes)

DATA MODEL DEFINITION

License

Copyright (c) 2010-2020, 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

November 2020: Original

November 2020: Corrigendum 1

Data Types

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

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

Data Type Base Type Description
base64 -

Base64 encoded binary (no line-length limitation).

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

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

Decimal value.

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

hexBinary -

Hex encoded binary.

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

int -

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

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

long -

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

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

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

Unsigned integer in the range 0 to 4294967295, inclusive.

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

unsignedLong -

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

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

Alias string(64)

A non-volatile 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.
Dbm1000 int The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.
IEEE_EUI64 string(23)

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

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

Possible patterns:

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

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

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

  • 216.52.29.100
  • 192.168.1.254

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

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

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

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

IPPrefix string(49)

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

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

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

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

IPv4Address IPAddress(15)

IPv4 address (or subnet mask).

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

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

IPv4 address prefix.

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

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

IPv6 address.

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

IPv6Prefix IPPrefix(49)

IPv6 address prefix.

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

MACAddress string(17)

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

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

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

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

Both values are represented as unsignedInt.

PSMBreakPointIndexAndLevel unsignedInt[2]

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

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

Both values are represented as unsignedInt.

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

SELTPAttenuationCharacteristicsIndexAndTFlog unsignedInt[2]

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

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

Both values are represented as unsignedInt.

SST string

Service Slice Type (SST). Enumeration of:

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

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

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[2]

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

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

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

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

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

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

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

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

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

References

[3GPP-HSPA] High Speed Packet data Access (HSPA), 3GPP.
[3GPP-TS.23.003] 3GPP TS 23.003, Numbering, addressing and identification, 3GPP CT WG4.
[3GPP-TS.23.501] 3GPP TS 23.501, System architecture for the 5G System (5GS); Stage 2, 3GPP SA WG2.
[3GPP-TS.24.008] 3GPP TS 24.008, Mobile radio interface Layer 3 specification; Core network protocols; Stage 3, 3GPP CT WG1.
[3GPP-TS.24.301] 3GPP TS 24.301, Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3, 3GPP CT WG1.
[3GPP-TS.24.501] 3GPP TS 24.501, Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3, 3GPP CT WG1.
[3GPP-TS.24.526] 3GPP TS 24.526, User Equipment (UE) policies for 5G System (5GS); Stage 3, 3GPP CT WG1.
[3GPP-TS.25.171] 3GPP TS 25.171, Requirements for support of Assisted Global Positioning System (A-GPS), 3GPP RAN WG4.
[802.11-2007] IEEE Std 802.11-2007, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, 2007.
[802.11-2012] IEEE Std 802.11-2012, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, March 2012.
[802.11-2016] IEEE Std 802.11-2016, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, December 2016.
[802.11a-1999] IEEE Std 802.11a-1999, High-speed Physical Layer in the 5 GHz band, IEEE, 1999.
[802.11ac-2013] IEEE Std 802.11ac-2013, Enhancements for Very High Throughput for Operation in Bands below 6 GHz, IEEE, December 2013.
[802.11ax] IEEE Std 802.11ax, Enhancements for High Efficiency WLAN, IEEE, May 2021.
[802.11b-1999] IEEE Std 802.11b-1999, Higher Speed Physical Layer Extension in the 2.4 GHz band, IEEE, 1999.
[802.11g-2003] IEEE Std 802.11g-2003, Further Higher Data Rate Extension in the 2.4 GHz Band, IEEE, 2003.
[802.11h-2003] IEEE Std 802.11h-2003, Spectrum and Transmit Power Management Extensions, IEEE, 2003.
[802.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.
[FWEREG] draft-allan-5g-fmc-encapsulation, 5G Wireless Wireline Convergence User Plane Encapsulation (5WE), IETF, March 2020.
[G.988] G.988, ONU management and control interface (OMCI) specification, ITU-T, 2010.
[G.9701] G.9701, Fast access to subscriber terminals (G.fast)- Physical layer specification, ITU-T, 2014.
[G.9954] G.9954, Phoneline networking transceivers - Enhanced physical, media access, and link layer specifications (HPNA 3.0 and 3.1), ITU-T, 2007.
[G.9960] G.9960, Unified high-speed wire-line based home networking transceivers - System architecture and physical layer specification, ITU-T.
[G.9961] G.9961, Unified high-speed wire-line based home networking transceivers - Data link layer specification, ITU-T.
[G.9962] G.9962, Unified high-speed wire-line based home networking transceivers - Management specification, ITU-T.
[G.9964] G.9964, Unified high-speed wire-line based home networking transceivers - Power spectral density specification, ITU-T.
[G.9973] G.9973, Protocol for identifying home network topology, ITU-T, 2011.
[G.993.1] G.993.1, Very high speed digital subscriber line transceivers, ITU-T.
[G.993.2] G.993.2, Very high speed digital subscriber line transceivers 2 (VDSL2), ITU-T.
[G.996.2] G.996.2, Single-ended line testing for digital subscriber lines (DSL), ITU-T.
[G.997.1] G.997.1, Physical layer management for digital subscriber line (DSL) transceivers, ITU-T.
[G.997.2] G.997.2, Physical layer management for FAST transceivers, ITU-T, 2015.
[G.998.1] G.998.1, ATM-based Multi-Pair Bonding, ITU-T, 2005.
[G.998.2] G.998.2, Ethernet-based Multi-Pair Bonding, ITU-T, 2005.
[G.998.3] G.998.3, Multi-Pair Bonding Using Time-Division Inverse Multiplexing, ITU-T, 2005.
[HPAV1.1] HomePlug AV Specification, Version 1.1, HomePlug, 2007.
[HTML4.01] HTML 4.01 Specification, W3C.
[IANA-protocolnumbers] IANA Protocol Numbers, Protocol Numbers, IANA.
[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-106] TR-106 Amendment 8, Data Model Template for CWMP Endpoints and USP Agents, Broadband Forum, May 2018.
[TR-124i5] TR-124 Issue 5, Functional Requirements for Broadband Residential Gateway Devices, Broadband Forum, July 2016.
[TR-124i6] TR-124 Issue 6, Functional Requirements for Broadband Residential Gateway Devices, Broadband Forum, July 2020.
[TR-143] TR-143 Amendment 3, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, May 2017.
[TR-159] TR-159, Management Framework for xDSL Bonding, Broadband Forum, December 2008.
[TR-181i2] TR-181 Issue 2 Amendment 13, Device Data Model, Broadband Forum, September 2019.
[TR-232] TR-232, Bulk Data Collection, Broadband Forum, May 2012.
[TR-262] TR-262, Femto Component Objects, Broadband Forum, November 2011.
[TR-304] TR-304, Broadband Access Service Attributes and Performance Metrics, Broadband Forum, February 2015.
[TR-390] TR-390, Performance Measurement from Customer Equipment to IP Edge, Broadband Forum, May 2017.
[TR-471] TR-471, Maximum IP-Layer Capacity Metric, Related Metrics, and Measurements, Broadband Forum, December 2021.
[UPA-PLC] Universal Powerline Association, UPA.
[UPnP-DAv1] UPnP Device Architecture, UPnP Device Architecture 1.0, UPnP Forum, April 2008.
[UPnP-DAv11] UPnP Device Architecture 1.1, UPnP Device Architecture 1.1, UPnP Forum, October, 2008.
[UPnP-IGD:1] UPnP InternetGatewayDevice:1, InternetGatewayDevice:1 Device Template Version 1.01, UPnP, 2001.
[UPnP-IGD:2] UPnP InternetGatewayDevice:2, InternetGatewayDevice:2 Device Template Version 1.01, UPnP, 2010.
[USB1.0] USB 1.0, USB 1.0 Specification, USB-IF, January 1996.
[USB2.0] USB 2.0, USB 2.0 Specification, USB-IF, April 2000.
[USB3.0] USB 3.0, USB 3.0 Specification, USB-IF, November 2008.
[WPS 2.0] WSC 2.0, Wi-Fi Simple Configuration Technical Specification Version 2.0.x, Wi-Fi Alliance.
[WPSv1.0] Wi-Fi Protected Setup Specification Version 1.0h, Wi-Fi Alliance, 2006.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

Legend

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

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

Name Type Syntax Write Description Object Default Version Spec
Device. object object​[1:1] - The top-level object for a Device. - 2.12 TR-181i2a14c1
Device.​DeviceInfo. object object​[1:1] - This object contains general device information. - 2.12 TR-181i2a14c1
Device.​DeviceInfo.​FirmwareImage.​{i}. object​[0:] object​[0:∞] -

Top-level object for mapping firmware images.

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

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

- 2.12 TR-181i2a14c1
Status string string -

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

  • NoImage (This Firmware Image instance is empty. This value could happen on an Agent that supports multiple firmware images, but only has a single image installed)
  • Active (This Firmware Image instance is the currently active image, added in v2.14)
  • Downloading (This Firmware Image instance is being downloaded)
  • Validating (This Firmware Image instance has been downloaded, and is in the process of being validated)
  • Available (This Firmware Image instance has been downloaded, validated, and installed, and is ready to be activated)
  • DownloadFailed (The Agent has attempted to download this Firmware Image instance, but ultimately failed while retrieving it from the source URL)
  • ValidationFailed (The Agent has attempted to validate a Firmware Image downloaded to this instance, but ultimately failed while validating it)
  • InstallationFailed (The Agent has attempted to install a Firmware Image downloaded and validated to this instance, but ultimately failed while installing it)
  • ActivationFailed (The Agent has attempted to active this Firmware Image instance, but ultimately failed while being activated)
- 2.12 TR-181i2a14c1
Device.​DSL. object object​[1:1] - This object models DSL lines, DSL channels, DSL bonding, and DSL diagnostics. The specific interface objects defined here are Line, Channel, and BondingGroup. Each Line models a layer 1 DSL Line interface, and each Channel models a layer 1 DSL Channel interface where multiple channels can run over a DSL line. In the case where bonding is configured, it is expected that BondingGroup is stacked above the Channel instances within its group. - 2.12 TR-181i2a14c1
Device.​DSL.​Diagnostics. object object​[1:1] - The DSL Diagnostics object. - 2.12 TR-181i2a14c1
SELTP​() command object -

[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 TR-181i2a14c1
⇐ Output. arguments object - Output arguments. -
⇐ TFlogGroupSize unsignedInt​(1:2,12) unsignedInt​(1:2,12) -

This parameter represents the Transfer Function Log (TFlog) group size. In units of subcarriers.

This parameter is defined as part of the SELT attenuation characteristics, AttenuationCharacteristics, defined in ITU-T Recommendation [Clause B.1.1.6/G.996.2].

- 2.14 TR-181i2a14c1
Device.​Cellular. object object​[1:1] - This object models cellular interfaces and access points. - 2.12 TR-181i2a14c1
Device.​Cellular.​Interface.​{i}. object​[0:] object​[0:∞] -

Cellular interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each instance of this object models a cellular modem with a single radio and a single USIM.

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

- 2.12 TR-181i2a14c1
SupportedAccessTechnologies string​[] list of string -

Comma-separated list of strings. Access technologies supported by the interface. Each list item is an enumeration of:

- 2.12 TR-181i2a14c1
RSRP int int -

The Reference Signal Received Power in dBm for LTE, NR values of CurrentAccessTechnology:

  • The valid range of RSRP values from worst to best is -140 dBm to -44 dBm
- 2.14 TR-181i2a14c1
RSRQ int int -

The Reference Signal Received Quality in dBm for LTE, NR values of CurrentAccessTechnology:

  • RSRQ is calculated using RSSI and RSRP values using RSRQ = (N*RSRP)/RSSI where N is the number of resource blocks (bandwidth).
  • The valid range of RSRP values from worst to best is -20 dBm to -3 dBm
- 2.14 TR-181i2a14c1
Device.​Ethernet. object object​[1:1] - 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.12 TR-181i2a14c1
FlowControlSupported boolean boolean - Indicates that Flow Control over Ethernet is supported, as per [802.3-2015]. - 2.14 TR-181i2a14c1
Device.​Ethernet.​Link.​{i}. object​[0:] object​[0:∞] W

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

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

- 2.12 TR-181i2a14c1
FlowControl boolean boolean W Configures Flow Control on given Ethernet port. When set to true, it activates the exchange of pause-resume flow control frames. false 2.14 TR-181i2a14c1
Device.​WiFi. object object​[1:1] - 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.12 TR-181i2a14c1
ResetCause string string -

Reports the cause for the previous Wi-Fi driver reset. Enumeration of:

  • HostReinit (Indicates that the host processor intentionally performed the reset. This can be due to an external instruction)
  • SpontaneousInterrupt (Indicates that the reset was spontaneous. This can be due to an error condition)
  • LossOfPower (Indicates that the reset was due to a loss of mains power on the device)
- 2.14 TR-181i2a14c1
Device.​WiFi.​MultiAP. object object​[1:1] -

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 TR-181i2a14c1
Device.​WiFi.​MultiAP.​APDevice.​{i}. object​[0:] object​[0:∞] -

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 TR-181i2a14c1
RadarDetections unsignedInt​(1024)​[] list​(1024) of unsignedInt - Comma-separated list (maximum number of characters 1024) of unsigned integers. List items represent channels in the non-occupancy list due to radars detected by Dynamic Frequency Selection (DFS) Channel Availability Check (CAC). - 2.14 TR-181i2a14c1
DFSEnable boolean boolean W Enables or disables Dynamic Frequency Selection (DFS). - 2.14 TR-181i2a14c1
Device.​WiFi.​MultiAP.​APDevice.​{i}.​Radio.​{i}. object​[0:] object​[0:∞] -

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 TR-181i2a14c1
PossibleChannels string​(1024)​[] list​(1024) of string -

Comma-separated list (maximum number of characters 1024) of strings. List items represent possible radio channels for the wireless standard (a, b, g, n, ac, ax) and the regulatory domain.

Ranges in the form "n-m" are permitted.

For example, for 802.11b and North America, would be "1-11".

- 2.14 TR-181i2a14c1
TransmitPowerLimit int​(-90:36) int​(-90:36) W Indicates the maximum Effective Isotropic Radiated Power (EIRP) per 20 MHz bandwidth representing the nominal transmit power limit for this radio. The field is coded in units of dBm relative to 1 mW. [Clause 17.2.15/MAPv1.0] - 2.14 TR-181i2a14c1
Device.​WiFi.​Radio.​{i}. object​[0:] object​[0:∞] -

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.

- 2.12 TR-181i2a14c1
GuardInterval string string W

The guard interval value between OFDM symbols. Enumeration of:

  • 400nsec (applicable to 802.11n and 802.11ac specifications only)
  • 800nsec (applicable to 802.11n and 802.11ac specifications only)
  • 1xLTF_0.8us (applicable to 802.11ax specification only, added in v2.14)
  • 1xLTF_1.6us (applicable to 802.11ax specification only, added in v2.14)
  • 2xLTF_0.8us (applicable to 802.11ax specification only, added in v2.14)
  • 2xLTF_1.6us (applicable to 802.11ax specification only, added in v2.14)
  • 4xLTF_0.8us (applicable to 802.11ax specification only, added in v2.14)
  • 4xLTF_3.2us (applicable to 802.11ax specification only, added in v2.14)
  • Auto
- 2.12 TR-181i2a14c1
CenterFrequencySegment0 unsignedInt 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.14 TR-181i2a14c1
CenterFrequencySegment1 unsignedInt 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.14 TR-181i2a14c1
EnableRRM boolean boolean W Enables or disables 802.11k Radio Resource Management (RRM). - 2.14 TR-181i2a14c1
Device.​WiFi.​Radio.​{i}.​Stats. object object​[1:1] - Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See [Appendix III/TR-181i2] for further details. The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.12 TR-181i2a14c1
CtsReceived unsignedLong StatsCounter64 - [StatsCounter64] The total number of Request To Send (RTS) control frames that received a Clear To Send (CTS) response. - 2.14 TR-181i2a14c1
NoCtsReceived unsignedLong StatsCounter64 - [StatsCounter64] The total number of Request To Send (RTS) control frames that did not receive a Clear To Send (CTS) response. - 2.14 TR-181i2a14c1
FrameHeaderError unsignedLong StatsCounter64 - [StatsCounter64] The total number of received packets for which the PHY was able to correlate the preamble but not the header. - 2.14 TR-181i2a14c1
GoodPLCPReceived unsignedLong StatsCounter64 - [StatsCounter64] The total number of received frames with a good Physical Layer Convergence Protocol (PLCP) header. - 2.14 TR-181i2a14c1
DPacketOtherMACReceived unsignedLong StatsCounter64 - [StatsCounter64] The total number of Wi-Fi data packets received from other Basic Service Sets (BSSs), with a good Frame Check Sequence (FCS) and not matching the receiver address, meaning that that the frame is received at the MAC layer but is addressed to a different MAC. - 2.14 TR-181i2a14c1
MPacketOtherMACReceived unsignedLong StatsCounter64 - [StatsCounter64] The total number of Wi-Fi management packets received from other Basic Service Sets (BSSs), with a good Frame Check Sequence (FCS) and not matching the receiver address, meaning that that the frame is received at the MAC layer but is addressed to a different MAC. - 2.14 TR-181i2a14c1
CPacketOtherMACReceived unsignedLong StatsCounter64 - [StatsCounter64] The total number of Wi-Fi control packets received from other Basic Service Sets (BSSs), with a good Frame Check Sequence (FCS) and not matching the receiver address, meaning that that the frame is received at the MAC layer but is addressed to a different MAC. - 2.14 TR-181i2a14c1
CtsOtherMACReceived unsignedLong StatsCounter64 - [StatsCounter64] The total number of received Clear to Send (CTS) packets not addressed to the MAC address of this receiver. - 2.14 TR-181i2a14c1
RtsOtherMACReceived unsignedLong StatsCounter64 - [StatsCounter64] The total number of received Request to Send (RTS) frames not addressed to the MAC address of this receiver. - 2.14 TR-181i2a14c1
Device.​WiFi.​SSID.​{i}. object​[0:] object​[0:∞] W

WiFi SSID table (a stackable interface object as described in [Section 4.2/TR-181i2]), where table entries model the MAC layer. A WiFi SSID entry is typically stacked on top of a Radio object.

WiFi SSID is also a multiplexing layer, i.e. more than one SSID can be stacked above a single Radio.

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

- 2.12 TR-181i2a14c1
ATFEnable boolean boolean W Enables or disables Air Time Fairness (ATF). - 2.14 TR-181i2a14c1
FlushATFTable boolean boolean W After this parameter is set to true, the ATF configuration of the interface will be reset. - 2.14 TR-181i2a14c1
SetATF unsignedInt​(0:100) unsignedInt​(0:100) W Configures the ATF setting for all associated devices on an individual SSID. Expressed as percentage of airtime, such that no station should exceed this percentage. - 2.14 TR-181i2a14c1
Device.​WiFi.​SSID.​{i}.​Stats. object object​[1:1] - Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See [Appendix III/TR-181i2] for further details. The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.12 TR-181i2a14c1
DiscardPacketsSentBufOverflow unsignedLong StatsCounter64 - [StatsCounter64] The total number of discarded packets during transmission caused by transmit buffer overflow. - 2.14 TR-181i2a14c1
DiscardPacketsSentNoAssoc unsignedLong StatsCounter64 - [StatsCounter64] The total number of discarded packets due to the station not being associated. - 2.14 TR-181i2a14c1
FragSent unsignedLong StatsCounter64 - [StatsCounter64] The total number of frame-fragments transmitted out of the interface. - 2.14 TR-181i2a14c1
SentNoAck unsignedLong StatsCounter64 - [StatsCounter64] The total number of transmitted data packets that did not receive an ACK when expected. - 2.14 TR-181i2a14c1
DupReceived unsignedLong StatsCounter64 - [StatsCounter64] The total number of received packets whose Sequence Control field indicates it is a duplicate. - 2.14 TR-181i2a14c1
TooLongReceived unsignedLong StatsCounter64 - [StatsCounter64] The total number of received packets longer than the maximum allowed packet length. - 2.14 TR-181i2a14c1
TooShortReceived unsignedLong StatsCounter64 - [StatsCounter64] The total number of received packets that did not contain enough bytes for the packet type. - 2.14 TR-181i2a14c1
AckUcastReceived unsignedLong StatsCounter64 - [StatsCounter64] The total number of unicast ACKs received, with good Frame Check Sequence (FCS). - 2.14 TR-181i2a14c1
Device.​WiFi.​AccessPoint.​{i}. object​[0:] object​[0:∞] 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.

- 2.12 TR-181i2a14c1
CpeOperationMode string string W

Reports information about the CPE operation mode (router or bridge/range extender). Enumeration of:

  • Router (Indicates indicates operation as a router)
  • Bridge/Extender (Indicates operation as a range extender or acess point in bridge mode)
"Router" 2.14 TR-181i2a14c1
Device.​WiFi.​AccessPoint.​{i}.​Security. object object​[1:1] - This object contains security related parameters that apply to a CPE acting as an Access Point [802.11-2007]. - 2.12 TR-181i2a14c1
EncryptionMode string​[] list of string W

Comma-separated list of strings. The type of encryption in use.

When ModeEnabled is one of WPA3-Personal, WPA3-Personal-Transition, or WPA3-Enterprise, TKIP is not valid, and should not be in the list. Each list item is an enumeration of:

- 2.14 TR-181i2a14c1
Device.​WiFi.​AccessPoint.​{i}.​AssociatedDevice.​{i}. object​[0:] object​[0:∞] -

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

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

- 2.12 TR-181i2a14c1
Type string string - Associated device type (Laptop, iPhone, Android, etc.). - 2.14 TR-181i2a14c1
SetStaATF unsignedInt​(0:100) unsignedInt​(0:100) W Configures the Air Time Fairness (ATF) setting of this individual associated device. Expressed as percentage of airtime, such that this associated device should not exceed this percentage. Setting this value overrides Device.WiFi.SSID.{i}.SetATF for this associated device. - 2.14 TR-181i2a14c1
Device.​WiFi.​AccessPoint.​{i}.​AssociatedDevice.​{i}.​Stats. object object​[1:1] -

These count bytes or packets sent to, or received from, this Associated Device, which is a WiFi station associated to this access point. Packet counters here count 802.11 WiFi frames.

The CPE MUST reset these Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the Status of the parent AccessPoint object transitions from Disabled to Enabled, or when it transitions from Enabled to Disabled.

- 2.12 TR-181i2a14c1
ErrorsReceived unsignedInt StatsCounter32 - [StatsCounter32] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.14 TR-181i2a14c1
Device.​IP. object object​[1:1] - IP object that contains the Interface, ActivePort, and Diagnostics objects. - 2.12 TR-181i2a14c1
Device.​IP.​Diagnostics. object object​[1:1] - The IP Diagnostics object. - 2.12 TR-181i2a14c1
IPLayerCapacitySupported boolean boolean - Indicates that IP Layer Capacity measurement is supported. - 2.14 TR-181i2a14c1
IPLayerMaxConnections unsignedInt​(1:) unsignedInt​(1:) - Indicates the maximum number of connections that are supported for an IP-Layer Capacity test. - 2.14 TR-181i2a14c1
IPLayerMaxIncrementalResult unsignedInt​(1:) unsignedInt​(1:) - The maximum number of rows in IPLayerCapacity().IncrementalResult that the device will store. - 2.14 TR-181i2a14c1
IPLayerCapSupportedMetrics string​[] list of string -

Comma-separated list of strings. Indicates the test metrics from [Section 5.2/TR-471] that are supported by the device. Each list item is an enumeration of:

  • IPLR (IP packet Loss Ratio)
  • Sampled_RTT (Sampled Round Trip Time)
  • IPDV (IP packet Delay Variation, OPTIONAL)
  • IPRR (IP packet Reordering Ratio, OPTIONAL)
- 2.14 TR-181i2a14c1
IPLayerCapacity​() command object -

[ASYNC] This command defines the IP Layer Capacity measurement configuration. IP Layer Capacity measurement is specified in [TR-471].

Data received in the IP Layer Capacity measurement do not require storage on the device.

- 2.14 TR-181i2a14c1
⇒ Input. arguments object - Input arguments. -
⇒ Interface string​(256) string​(256) W

Note that [TR-471] mandates support for and use of IPLR and Sampled RTT.

The value MUST be the Path Name of a table row. The IP-layer interface over which the test is to be performed. Example: Device.IP.Interface.1

If an empty string is specified, the device MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface.

- 2.14 TR-181i2a14c1
⇒ Role string string W

[MANDATORY] Indicates whether the device will act as Sender or Receiver of test packets. Enumeration of:

  • Receiver (The device will act as the Receiver)
  • Sender (The device will act as the Sender)
- 2.14 TR-181i2a14c1
⇒ Host string​(256) string​(256) W [MANDATORY] The Fully Qualified Domain Name (FQDN) or IP address of the Test Endpoint to perform the UDP Capacity tests with. - 2.14 TR-181i2a14c1
⇒ Port unsignedInt​(1:65535) unsignedInt​(1:65535) W [MANDATORY] Port on the Test Endpoint host. - 2.14 TR-181i2a14c1
⇒ JumboFramesPermitted boolean boolean W If true, jumbo frames are allowed. Default SHOULD be false. - 2.14 TR-181i2a14c1
⇒ NumberOfConnections unsignedInt​(1:) unsignedInt​(1:) W The number of connections to be used in the test. The default value SHOULD be 1. NumberOfConnections MUST NOT be set to a value greater than IPLayerMaxConnections. - 2.14 TR-181i2a14c1
⇒ EthernetPriority unsignedInt​(0:7) unsignedInt​(0:7) W Ethernet priority code for marking packets transmitted in the test (if applicable). The default value SHOULD be zero. - 2.14 TR-181i2a14c1
⇒ DSCP unsignedInt​(0:63) unsignedInt​(0:63) W The DiffServ code point for marking packets transmitted in the test. The default value SHOULD be zero. - 2.14 TR-181i2a14c1
⇒ ProtocolVersion string string W

Indicates the IP protocol version to be used. The default value SHOULD be Any. Enumeration of:

  • Any (Use either IPv4 or IPv6 depending on the system preference)
  • IPv4 (Use IPv4 for the requests)
  • IPv6 (Use IPv6 for the requests)
- 2.14 TR-181i2a14c1
⇒ UDPPayloadMin unsignedInt​(35:9000) unsignedInt​(35:9000) W Minimum reference size of UDP payload in octets. No default. The implementation will algorithmically determine a value if none is configured. The value SHOULD be set to a value that avoids fragmentation (i.e., using path MTU discovery). - 2.14 TR-181i2a14c1
⇒ UDPPayloadMax unsignedInt​(35:9000) unsignedInt​(35:9000) W Maximum reference size of UDP payload in octets. No default. The implementation will algorithmically determine a value if none is configured. The value SHOULD be set to the largest value that avoids fragmentation (i.e., using path MTU discovery). If JumboFramesPermitted is false, the maximum value MUST be 1472 octets. If JumboFramesPermitted is true, this value can be as large as 9000 octets. UDPPayloadMax MUST be greater than or equal to UDPPayloadMin. - 2.14 TR-181i2a14c1
⇒ PortMin unsignedInt​(49152:65535) unsignedInt​(49152:65535) W [MANDATORY] Starting value for range of Dynamic Ports supported for test traffic and status feedback messages. - 2.14 TR-181i2a14c1
⇒ PortMax unsignedInt​(49152:65535) unsignedInt​(49152:65535) W [MANDATORY] Indicates the upper bound of the supported Dynamic Port range, where PortMin indicates the starting port number. PortMax MUST be greater than or equal to PortMin. - 2.14 TR-181i2a14c1
⇒ PortOptionalMin unsignedInt​(0,1024:49151) unsignedInt​(0,1024:49151) W Starting value for range of User Ports supported for test traffic and status feedback messages. A value of zero (0) indicates no User Ports are used for test traffic or status feedback messages. - 2.14 TR-181i2a14c1
⇒ PortOptionalMax unsignedInt​(0,1024:49151) unsignedInt​(0,1024:49151) W Indicates the upper bound of the supported User Port range, where PortOptionalMin indicates the starting port number. PortOptionalMax MUST be greater than or equal to PortOptionalMin. A value of zero (0) indicates no User Ports are used for test traffic or status feedback messages. - 2.14 TR-181i2a14c1
⇒ TestType string string W

Indicates the type of IP-Layer Capacity test being run. The default value SHOULD be Search. Enumeration of:

  • Search (Search algorithm will be used to determine sending rate)
  • Fixed (Fixed sending rate will be used)
- 2.14 TR-181i2a14c1
⇒ IPDVEnable boolean boolean W Enables IPDV (IP packet Delay Variation) metric. Default SHOULD be false. - 2.14 TR-181i2a14c1
⇒ IPRREnable boolean boolean W Enables IPRR (IP packet Reordering Ratio) metric. Default SHOULD be false. - 2.14 TR-181i2a14c1
⇒ PreambleDuration unsignedInt​(0:5) unsignedInt​(0:5) W Duration of the preamble testing, when traffic is being sent and/or received but the test clock has not been started. This is done to ensure all network elements in the path are "awake". The default value SHOULD be 2 seconds. Value specified in seconds. - 2.14 TR-181i2a14c1
⇒ StartSendingRate unsignedInt​(500:10000000) unsignedInt​(500:10000000) W [MANDATORY] The Sending Rate for a Fixed test or the initial Sending Rate value for a Search test. Value specified in kbps. The default SHOULD be 500 kbps. - 2.14 TR-181i2a14c1
⇒ NumberTestSubIntervals unsignedInt​(1:100) unsignedInt​(1:100) W Number of intermediate measurement reporting intervals. The value MUST NOT be greater than IPLayerMaxIncrementalResult. The default value SHOULD be 10. - 2.14 TR-181i2a14c1
⇒ TestSubInterval unsignedInt​(100:6000) unsignedInt​(100:6000) W Duration of intermediate measurement reporting intervals. TestSubInterval * NumberTestSubIntervals MUST result in an integer value in seconds, in the range 5 seconds <= TestSubInterval * NumberTestSubIntervals <= 60 seconds. The default value SHOULD be 1000 milliseconds. Value specified in milliseconds. - 2.14 TR-181i2a14c1
⇒ StatusFeedbackInterval unsignedInt​(5:250) unsignedInt​(5:250) W Period of status feedback message (receiver of offered load returns messages to the sender with results of measured metrics). Value specified in milliseconds. The default SHOULD be 50 milliseconds. - 2.14 TR-181i2a14c1
⇒ TimeoutNoTraffic unsignedInt​(5:30) unsignedInt​(5:30) W Timeout value. Value specified in seconds. The default value SHOULD be 5 seconds. - 2.14 TR-181i2a14c1
⇒ Tmax unsignedInt​(50:3000) unsignedInt​(50:3000) W Maximum waiting time for packets to arrive. Value specified in milliseconds. The default SHOULD be 1000 milliseconds. - 2.14 TR-181i2a14c1
⇒ TmaxRTT unsignedInt​(50:3000) unsignedInt​(50:3000) W Maximum Round Trip Time waiting time for packets to arrive. Value specified in milliseconds. The default SHOULD be 3000 milliseconds. - 2.14 TR-181i2a14c1
⇒ TimestampResolution unsignedInt​(1:1000) unsignedInt​(1:1000) W Indicates the requested precision of timestamp values. The test implementation will determine the actual precision to use based on the implemented resolution capabilities of the protocols used and this requested value. If the implemented resolution capabilities of the IPLayerCapSupportedMetrics protocols being used are able to provide the requested resolution, this resolution SHOULD be provided. Value specified in microseconds. The default SHOULD be 1 microseconds. - 2.14 TR-181i2a14c1
⇒ LowerThresh unsignedInt​(5:250) unsignedInt​(5:250) W This parameter is only meaningful if TestType is Search. The lower threshold on the range of Round Trip Time (RTT) variation. Value specified in milliseconds. The default SHOULD be 30 milliseconds. - 2.14 TR-181i2a14c1
⇒ UpperThresh unsignedInt​(5:250) unsignedInt​(5:250) W This parameter is only meaningful if TestType is Search. The upper threshold on the range of Round Trip Time (RTT) variation. Value specified in milliseconds. The default SHOULD be 90 milliseconds. - 2.14 TR-181i2a14c1
⇒ HighSpeedDelta unsignedInt​(2:) unsignedInt​(2:) W This parameter is only meaningful if TestType is Search. The number of rows to move in a single adjustment when initially increasing offered load (to ramp up quickly). The default SHOULD be 10. - 2.14 TR-181i2a14c1
⇒ SlowAdjThresh unsignedInt​(2:) unsignedInt​(2:) W This parameter is only meaningful if TestType is Search. Threshold on the measured number of consecutive status reports indicating loss and/or delay variation above UpperThresh (SlowAdjCount). The default SHOULD be 2. - 2.14 TR-181i2a14c1
⇒ HSpeedThresh unsignedInt​(1:) unsignedInt​(1:) W This parameter is only meaningful if TestType is Search. Threshold for transition between low and high sending rate step sizes (such as 1Mbps and 100 Mbps). If JumboFramesPermitted is true this may result in use of jumbo frames. The default SHOULD be 1 Gbps. - 2.14 TR-181i2a14c1
⇐ Output. arguments object - Output arguments. -
⇐ Status string 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.14 TR-181i2a14c1
⇐ BOMTime dateTime dateTime - Beginning of transmission send/receive time in UTC, which MUST be specified to TimestampResolution precision. If multiple connections are used, then BOMTime is set to the earliest value across all connections. For example: 2008-04-09T15:01:05.123456Z - 2.14 TR-181i2a14c1
⇐ EOMTime dateTime dateTime - End of transmission in UTC, which MUST be specified to TimestampResolution precision. If multiple connections are used, then EOMTime is set to the latest value across all connections. For example: 2008-04-09T15:01:05.123456Z - 2.14 TR-181i2a14c1
⇐ TmaxUsed unsignedInt unsignedInt - Configured value of Tmax used in the test. This value is expressed in milliseconds. - 2.14 TR-181i2a14c1
⇐ TestInterval unsignedInt unsignedInt - Duration of the test (either downlink or uplink). This value is expected to equal TestSubInterval * NumberTestSubIntervals. This value is expressed in seconds. - 2.14 TR-181i2a14c1
⇐ MaxIPLayerCapacity decimal decimal - The maximum IP-Layer Capacity metric from among all IncrementalResult.{i}.IPLayerCapacity values measured between BOMTime and EOMTime across all connections for this test. This is calculated according to [TR-471] Equation 1. Result is expressed in Mbps with 3 digits beyond the decimal. 10^6 bits/second = 1 Mbps. - 2.14 TR-181i2a14c1
⇐ TimeOfMax dateTime dateTime - Time in UTC of end of the sub-interval when MaxIPLayerCapacity was measured. If the value of MaxIPLayerCapacity occurred in multiple sub-intervals, this MUST be the earliest of these sub-intervals. Value MUST be specified to TimestampResolution precision. For example: 2008-04-09T15:01:05.123456Z - 2.14 TR-181i2a14c1
⇐ LossRatioAtMax decimal decimal - Ratio of lost packets to total packets during sub-interval of MaxIPLayerCapacity. This value is expressed as a decimal to 9 decimal digits. - 2.14 TR-181i2a14c1
⇐ RTTRangeAtMax decimal decimal - The range of Round Trip Time (RTT) during sub-interval of MaxIPLayerCapacity. This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. - 2.14 TR-181i2a14c1
⇐ PDVRangeAtMax decimal decimal - The range of Packet Delay Variation (PDV) during sub-interval of MaxIPLayerCapacity. This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. - 2.14 TR-181i2a14c1
⇐ MinOnewayDelayAtMax decimal decimal - The minimum one-way delay during the sub-interval of MaxIPLayerCapacity. The minimum one-way delay is calculated at the conclusion of the test and SHALL be calculated using the conditional distribution of all packets with a finite one-way delay value (undefined delays are excluded). This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. - 2.14 TR-181i2a14c1
⇐ ReorderedRatioAtMax decimal decimal - Ratio of reordered packets to total packets during the sub-interval of MaxIPLayerCapacity. This value is expressed as a decimal to 9 decimal digits. - 2.14 TR-181i2a14c1
⇐ TmaxRTTUsed unsignedInt unsignedInt - Configured value of TmaxRTT used in the test. This value is expressed in milliseconds. - 2.14 TR-181i2a14c1
⇐ TimestampResolutionUsed unsignedInt unsignedInt - Indicates the timestamp resolution of reported results. Value specified in microseconds. - 2.14 TR-181i2a14c1
⇐ IncrementalResult.​{i}. object​[0:] object​[0:∞] -

Results for time segmented tests (tests where NumberTestSubIntervals > 1). This data is calculated across all connections in the test. A new object is created every TestSubInterval after that interval has completed. Instance numbers MUST start at 1 and sequentially increment as new instances are created. All instances are removed when new test is started or results are otherwise cleared.

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

- 2.14 TR-181i2a14c1
⇐ IPLayerCapacity decimal decimal - Results of measurements using the maximum IP-Layer Capacity metric calculation for a single interval from [TR-471] Equation 1, for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. Result is expressed in Mbps with 3 digits beyond the decimal. 10^6 bits/second = 1 Mbps. - 2.14 TR-181i2a14c1
⇐ TimeOfSubInterval dateTime dateTime - Time in UTC of end of sub-interval when IPLayerCapacity was measured. Value MUST be specified to TimestampResolution precision. For example: 2008-04-09T15:01:05.123456Z - 2.14 TR-181i2a14c1
⇐ LossRatio decimal decimal - Ratio of lost packets to total packets, for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. This value is expressed as a decimal to 9 decimal digits. - 2.14 TR-181i2a14c1
⇐ RTTRange decimal decimal - The range of Round Trip Time (RTT), for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. See [TR-471] for description of how value is calculated. This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. - 2.14 TR-181i2a14c1
⇐ PDVRange decimal decimal - The range of Packet Delay Variation (PDV), for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. See [TR-471] for description of how value is calculated. This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. - 2.14 TR-181i2a14c1
⇐ MinOnewayDelay decimal decimal - The minimum one-way delay, for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. The minimum one-way delay is calculated at the conclusion of the test and SHALL be calculated using the conditional distribution of all packets with a finite one-way delay value (undefined delays are excluded). This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. - 2.14 TR-181i2a14c1
⇐ ReorderedRatio decimal decimal - Ratio of reordered packets to total packets, for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. This value is expressed as a decimal to 9 decimal digits. - 2.14 TR-181i2a14c1
Device.​Hosts. object object​[1:1] - 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.12 TR-181i2a14c1
AccessControlNumberOfEntries unsignedInt unsignedInt - The number of entries in the AccessControl table. - 2.14 TR-181i2a14c1
Device.​Hosts.​AccessControl.​{i}. object​[0:] object​[0:∞] W

Every instance of this object provides access control for a LAN device.

Access is allowed if no instance of AccessControl is defined for a device.

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

- 2.14 TR-181i2a14c1
Alias string​(64) Alias W

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

The following mandatory constraints MUST be enforced:

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

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

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

- 2.14 TR-181i2a14c1
PhysAddress string​(64) string​(64) W

Unique physical identifier of the device. For many layer 2 technologies this is typically a MAC address.

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

- 2.14 TR-181i2a14c1
HostName string​(256) string​(256) W Any user defined name for the device. - 2.14 TR-181i2a14c1
Enable boolean boolean W Enables or disables this AccessControl entry. false 2.14 TR-181i2a14c1
AccessPolicy string string W

Allows or denies access for a device.

If AccessPolicy is set to "Allow", device access is allowed based on the Schedule objects. Access is enabled if there is no Schedule object defined.

If AccessPolicy is set to "Deny", defined Schedule objects are ignored and no access is allowed for the device. Enumeration of:

"Allow" 2.14 TR-181i2a14c1
ScheduleNumberOfEntries unsignedInt unsignedInt - The number of entries in the Schedule table. - 2.14 TR-181i2a14c1
Device.​Hosts.​AccessControl.​{i}.​Schedule.​{i}. object​[0:] object​[0:∞] W

Each instance of this object provides a schedule where access is enabled.

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

- 2.14 TR-181i2a14c1
Alias string​(64) Alias W

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

The following mandatory constraints MUST be enforced:

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

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

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

- 2.14 TR-181i2a14c1
Enable boolean boolean W Enables or disables this Schedule entry. false 2.14 TR-181i2a14c1
Day string​[] list of string W

Comma-separated list of strings. Comma-separated list of days which access is enabled. Each list item is an enumeration of:

- 2.14 TR-181i2a14c1
StartTime string​(5) string​(5) W

Start time of the enable schedule in hh:mm format. [hh] refers to a zero-padded hour between 00 and 23. [mm] refers to a zero-padded minute between 00 and 59.

Start time is in local time zone. Possible patterns:

- 2.14 TR-181i2a14c1
Duration unsignedInt​(1:) unsignedInt​(1:) W

The duration, in seconds, which the access is enabled.

If the StartTime is not defined, duration is the total time access is allowed during a calendar day.

If a StartTime is defined, access is allowed for the Duration period starting from StartTime.

- 2.14 TR-181i2a14c1
Device.​LocalAgent. object object​[1:1] -

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

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

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

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

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

- 2.12 TR-181i2a14c1
Device.​LocalAgent.​MTP.​{i}.​WebSocket. object object​[1:1] - If the USP Endpoint uses the WebSocket Message Transport Protocol (MTP) as a WebSocket server, then this object contains WebSocket specific configuration parameters. - 2.12 TR-181i2a14c1
EnableEncryption boolean boolean W When true, encryption MUST be used for all connections to this MTP instance. true 2.14 TR-181i2a14c1
Device.​LocalAgent.​Controller.​{i}. object​[0:] object​[0:∞] W

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

On the deletion of an entry from this table, the Agent MUST send the ObjectDeletion notification to all subscribed recipients, even if the recipient is the deleted Controller itself. This notification is the last notification sent to this Controller.

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

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

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

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

- 2.12 TR-181i2a14c1
Device.​LocalAgent.​Controller.​{i}.​MTP.​{i}.​WebSocket. object object​[1:1] - If the USP Endpoint uses the WebSocket Message Transport Protocol (MTP) as a WebSocket client, then this object contains WebSocket specific configuration parameters. - 2.12 TR-181i2a14c1
EnableEncryption boolean boolean W When true, encryption MUST be used for this MTP instance. true 2.14 TR-181i2a14c1
Device.​LocalAgent.​Controller.​{i}.​MTP.​{i}.​MQTT. object object​[1:1] - 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 TR-181i2a14c1
PublishRetainResponse boolean boolean W If set to true the Agent MUST set the RETAIN flag in MQTT PUBLISH messages carrying a USP Response Message to 1, unless the MQTT server sent Retain Available = 0 (MQTT 5.0) in its CONNACK (in which case, the Agent MUST set the RETAIN flag to 0). false 2.14 TR-181i2a14c1
PublishRetainNotify boolean boolean W If set to true the Agent MUST set the RETAIN flag in MQTT PUBLISH messages carrying a USP Notify Message to 1, unless the MQTT server sent Retain Available = 0 (MQTT 5.0) in its CONNACK (in which case, the Agent MUST set the RETAIN flag to 0). false 2.14 TR-181i2a14c1
Device.​STOMP. object object​[1:1] - The STOMP represents the STOMP capabilities of the device as described in [TR-369]. - 2.12 TR-181i2a14c1
Device.​STOMP.​Connection.​{i}. object​[0:] object​[0:∞] W

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

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

- 2.12 TR-181i2a14c1
EnableEncryption boolean boolean W When true, encryption MUST be used for this STOMP Connection Connection. true 2.14 TR-181i2a14c1
Device.​MQTT. object object​[1:1] - MQTT Base object describing all MQTT related parameters and objects. - 2.12 TR-181i2a14c1
Device.​MQTT.​Client.​{i}. object​[0:] object​[0:∞] 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.

- 2.12 TR-181i2a14c1
EnableEncryption boolean boolean W When true, encryption MUST be used for this MQTT Client instance. true 2.14 TR-181i2a14c1
Device.​WWC. object object​[1:1] - Base object for Wireline Wireless Convergence. The controller can use this object to learn the supported 5G features and whether the 5G-RG is operating in 5G mode. - 2.14 TR-181i2a14c1
HwCapabilities string​[] list of string -

Comma-separated list of strings. Wireline Wireless Convergence hardware capabilities supported by the CPE. Each list item is an enumeration of:

  • NG-RAN (Able to use the 5G Radio Access Network)
  • E-UTRAN (Able to use the 4G (LTE) Radio Access Network)
  • W-5GAN (Able to use fixed access networks)
- 2.14 TR-181i2a14c1
SwCapabilities string​[] list of string -

Comma-separated list of strings. Wireline Wireless Convergence software capabilities supported by the CPE. Each list item is an enumeration of:

  • FN-RG (Able to use PPPoE or IPoE as specified in [TR-124i5] or earlier)
  • 5G-RG (Able to use 5G capabilities such as specified in [TR-124i6])
  • ATSSS (Able to support multi access PDUs using Access Traffic Steering Switching Splitting (ATSSS))
- 2.14 TR-181i2a14c1
Mode string string W

Sets the mode the CPE is operating in. Whilst the CPE is expected to auto-negotiate, a service provider may need to lock the CPE in FN-RG or 5G-RG mode for stability. Enumeration of:

  • FN-RG (The CPE only attempts to authenticate using PPPoE or IPoE)
  • 5G-RG (The CPE only attempts to register using 5G NAS)
  • Auto (The CPE may operate in either mode)

The factory default value MUST be Auto.

- 2.14 TR-181i2a14c1
Status string string -

The mode the CPE is operating in. A CPE in Negotiating is deemed to be auto-negotiating its operational mode. Enumeration of:

- 2.14 TR-181i2a14c1
AccessNetworkNumberOfEntries unsignedInt unsignedInt - The number of entries in the AccessNetwork table. - 2.14 TR-181i2a14c1
URSPNumberOfEntries unsignedInt unsignedInt - The number of entries in the URSP table. - 2.14 TR-181i2a14c1
Device.​WWC.​AccessNetwork.​{i}. object​[0:] object​[0:∞] -

Each table entry describes a single access network. The entire table is built by the 5G-RG upon startup. The primary purpose is to show the registration and connectivity status of each access network. Typically a 5G-RG would register on each available access network. A minimum of one access network must be in the CM-CONNECTED state in order to support N1 messaging.

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

- 2.14 TR-181i2a14c1
Alias string​(64) Alias W

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

The following mandatory constraints MUST be enforced:

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

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

- 2.14 TR-181i2a14c1
Name string​(64) string​(64) -

The textual name of the Access Network entry as assigned by the CPE.

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

- 2.14 TR-181i2a14c1
Interface string​(256) string​(256) W The value MUST be the Path Name of a table row. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the egress interface associated with this "AccessNetwork" entry. This MUST be a layer 1 interface. - 2.14 TR-181i2a14c1
RegistrationStatus string string -

The registration status of this entry. See [Clause 5.3.2/3GPP-TS.23.501]. Enumeration of:

  • RM_REGISTERED (The 5G-RG has sucessfully authenticated and has been assigned an AMF to manage it)
  • RM_DEREGISTERED (The 5G-RG is no longer managed by an AMF)
  • RM_UNDEFINED (The access network will always start in this state and indicates that the 5G-RG has never registered to the access network. This state is only used by the 5G-RG and is never present in the AMF)
  • Error (The LastError parameter is updated with the detail of this error)

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

- 2.14 TR-181i2a14c1
ConnectionStatus string string -

The connection status of this entry. A 5G-RG is deemed in the CM_CONNECTED state if there is a NAS signalling connection established between the 5G-RG and AMF. If RegistrationStatus transitions from RM_REGISTERED to RM_DEREGISTERED, the status of ConnectionStatus must change to CM_UNDEFINED. See [Clause 5.3.3/3GPP-TS.23.501]. Enumeration of:

  • CM_IDLE (The 5G-RG does not have a NAS connection over N1 to the AMF)
  • CM_CONNECTED (The 5G-RG does have a NAS connection over N1 to the AMF)
  • CM_UNDEFINED (The access network will always start in this state and indicates that the 5G-RG is not registered to the access network. This state is only used by the 5G-RG and is never present in the AMF)
  • Error (The LastError parameter is updated with the detail of this error)

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

- 2.14 TR-181i2a14c1
AccessNetworkType string string -

The access network type of this entry. Enumeration of:

- 2.14 TR-181i2a14c1
LastError unsignedInt unsignedInt - Error code. See [Clause 9.11.4.2/3GPP-TS.24.501] - 2.14 TR-181i2a14c1
Device.​WWC.​AccessNetwork.​{i}.​GUTI. object object​[1:1] -

A 5G Globally Unique Temparary Identity (GUTI) securely identifes an CPE by keeping the permanent User Equipment (UE identifier (IMSI) hidden. This identity is globally unique and assigned by the AMF at the time of registration.

See [.Clause 2.10/3GPP-TS.23.003].

- 2.14 TR-181i2a14c1
PLMN unsignedInt unsignedInt -

The Public Land Mobile Network (PLMN) globally identifies the service provider. A PLMN consists of a country code (MCC) and a network code (MNC).

See [Clause 12.1/3GPP-TS.23.003].

For example, a PLMN of 50101 refers to MCC 501 (Australia) and MNC 01 (Telstra).

- 2.14 TR-181i2a14c1
AMFId unsignedInt unsignedInt -

The AMFId identifies an AMF instance within a service provider's network. In conjunction with the PLMN, it forms a Globally Unique AMF Id (GUAMI) which globally uniquely identifes an AMF.

See [Clause 2.10/3GPP-TS.23.003].

- 2.14 TR-181i2a14c1
TMSI unsignedInt unsignedInt -

The Temporary Mobile Subscriber Identity (TMSI) is allocatred by the AMF at the time of registration and uniquely identifies the CPE.

See [Clause 2.4/3GPP-TS.23.003].

- 2.14 TR-181i2a14c1
Device.​WWC.​URSP.​{i}. object​[0:] object​[0:∞] -

User equipment Router Selection Policy (URSP) is a table of rules used to determine which network slice and data network to route a PDU over. Typically a 5G-RG would search the URSP table in precedence order matching the traffic descriptor types against the service it was setting up. For example a 5G-RG would search for 'connection capabilities' matching 'ims' in order to establish a dedicated PDU session for telephony.

See [Clause 5.2/3GPP-TS.24.526] for a full descrption of the URSP data elements.

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

- 2.14 TR-181i2a14c1
Alias string​(64) Alias W

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

The following mandatory constraints MUST be enforced:

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

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

- 2.14 TR-181i2a14c1
Precedence unsignedInt​(0:255) unsignedInt​(0:255) - The precedence value of URSP rule field is used to specify the precedence of the URSP rule among all URSP rules in the URSP. The precedence value in the range from 0 to 255 (decimal). The higher the value of the precedence value field, the lower the precedence of the URP rule is. Multiple URSP rules in the URSP shall not have the same precedence value. - 2.14 TR-181i2a14c1
TrafficDescriptorNumberOfEntries unsignedInt unsignedInt - The number of entries in the TrafficDescriptor table. - 2.14 TR-181i2a14c1
Device.​WWC.​URSP.​{i}.​TrafficDescriptor.​{i}. object​[0:] object​[0:∞] -

A set of rules for a given precedence that must be matched in order to select a router in the form of data network and slice. Selection criteria range from destination IP addresses to connection capabilities.

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

- 2.14 TR-181i2a14c1
Alias string​(64) Alias W

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

The following mandatory constraints MUST be enforced:

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

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

- 2.14 TR-181i2a14c1
Type unsignedInt unsignedInt - Traffic Descriptor Type. See [Clause 5.2/3GPP-TS.24.526]. - 2.14 TR-181i2a14c1
Value string​(1024) string​(1024) - Traffic descriptor value. See [Clause 5.2/3GPP-TS.24.526]. - 2.14 TR-181i2a14c1
RouteSelectionDescriptorNumberOfEntries unsignedInt unsignedInt - The number of entries in the RouteSelectionDescriptor table. - 2.14 TR-181i2a14c1
Device.​WWC.​URSP.​{i}.​TrafficDescriptor.​{i}.​RouteSelectionDescriptor.​{i}. object​[0:] object​[0:∞] -

This object describes the URSP Route Selection Descriptor table which provides a table of data networks and network slices used in PDU establishment. Table entries are used in precedence order until a successful PDU session is established.

See ((bibref|3GPP-TS.23.503|Annex A}} for an example URSP rule traversal.

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

- 2.14 TR-181i2a14c1
Alias string​(64) Alias W

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

The following mandatory constraints MUST be enforced:

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

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

- 2.14 TR-181i2a14c1
Precedence unsignedInt​(0:255) unsignedInt​(0:255) - The precedence value of route selection descriptor field is used to specify the precedence of the route selection descriptor among all route selection descriptors in the URSP rule. The precedence value in the range from 0 to 255 (decimal). The higher the value of the precedence value field, the lower the precedence of the route selection descriptor is. - 2.14 TR-181i2a14c1
SSC unsignedInt​(1:3) unsignedInt​(1:3) - Session and Service Continuity (SSC) Mode: Indicates that the traffic of the matching application shall be routed via a PDU Session supporting the included SSC Mode. See [Clause 9.11.4.16/3GPP-TS.24.501]. - 2.14 TR-181i2a14c1
DNN string​(100) string​(100) - The DNN value contains an APN as defined in [Clause 9.1.1/3GPP-TS.23.003]. - 2.14 TR-181i2a14c1
PDUSessionType string string -

PDU session type. See [Clause 9.11.4.11/3GPP-TS.24.501]. Enumeration of:

- 2.14 TR-181i2a14c1
AccessType string string -

The preferred access type for the PDU session. For a 5G-RG non-3GPP refers to any fixed access technology.

See [Clause 9.11.3.11/3GPP-TS.24.501]. Enumeration of:

- 2.14 TR-181i2a14c1
Device.​WWC.​URSP.​{i}.​TrafficDescriptor.​{i}.​RouteSelectionDescriptor.​{i}.​NetworkSlice. object object​[1:1] -

Describes a S-NSSAI Information element providing network slice specification.

See [Clause 9.11.2.8/3GPP-TS.24.501]

- 2.14 TR-181i2a14c1
SliceServiceType string SST -

[SST] The Slice Service Type (SST). Enumeration of:

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

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

- 2.14 TR-181i2a14c1
SliceDifferentiator unsignedInt unsignedInt -

The Slice differentiator is an optional number used to differentiate network slices with the same SST.

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

- 2.14 TR-181i2a14c1
Device.​PDU. object object​[1:1] - The logical connection between the 5G-RG and data network is the Protocol Data Unit (PDU). The Device.PDU subtree describes each PDU sessions properties together with the QoS rules specific to that PDU session. - 2.14 TR-181i2a14c1
SessionNumberOfEntries unsignedInt unsignedInt - The number of entries in the Session table. - 2.14 TR-181i2a14c1
Device.​PDU.​Session.​{i}. object​[0:] object​[0:∞] -

Contains all the properties of a PDU session instance, ranging from maximum bitrate through to assigned network slice. This object contains the Session table.

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

- 2.14 TR-181i2a14c1
Alias string​(64) Alias W

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

The following mandatory constraints MUST be enforced:

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

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

- 2.14 TR-181i2a14c1
Interface string​(256) string​(256) - The value MUST be the Path Name of a row in the IP.Interface table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The IP Interface associated with the PDU entry. - 2.14 TR-181i2a14c1
SessionID unsignedInt​(1:15) unsignedInt​(1:15) - PDU session identity. See [Clause 9.4/3GPP-TS.24.501]. - 2.14 TR-181i2a14c1
PTI unsignedInt​(1:254) unsignedInt​(1:254) - Procedure transaction identity. See [Clause 9.6/3GPP-TS.24.501]. - 2.14 TR-181i2a14c1
SessionType string string -

The PDU session type indicating the protocol the PDU is capable of carrying. See [Clause 9.11.4.11/3GPP-TS.24.501]. Enumeration of:

- 2.14 TR-181i2a14c1
SSC unsignedInt​(1:3) unsignedInt​(1:3) - Session and Service Continuity (SSC) Mode: Indicates that the traffic of the matching application shall be routed via a PDU Session supporting the included SSC Mode. See [Clause 9.11.4.16/3GPP-TS.24.501] - 2.14 TR-181i2a14c1
SessionAMBRDownlink unsignedLong unsignedLong - Downlink Aggregate Maximum Bit Rate in bits per second. See [Clause 9.11.4.14/3GPP-TS.24.501]. - 2.14 TR-181i2a14c1
SessionAMBRUplink unsignedLong unsignedLong - Uplink Aggregate Maximum Bit Rate in bits per second. See [Clause 9.11.4.14/3GPP-TS.24.501]. - 2.14 TR-181i2a14c1
LastError unsignedInt unsignedInt - Error code. See [Clause 9.11.4.2/3GPP-TS.24.501] - 2.14 TR-181i2a14c1
PDUIPv4Address string​(15) IPv4Address - [IPv4Address] The IPv4 address allocated to the PDU session by the SMF. This parameter is only valid if SessionType has a value of IPv4 or IPv4v6. See [Clause 9.11.4.10/3GPP-TS.24.501]. - 2.14 TR-181i2a14c1
PDUIPv6InterfaceIdentifier string string - The interface identifier for the IPv6 link local address allocated to the PDU session by the SMF. This parameter is only valid if SessionType has a value of IPv6 or IPv4v6. See [Clause 9.11.4.10/3GPP-TS.24.501]. - 2.14 TR-181i2a14c1
RQTimerValue unsignedInt unsignedInt - Reflective QoS timeout in seconds. See [Clause 9.11.2.3/3GPP-TS.24.501]. - 2.14 TR-181i2a14c1
AlwaysOn boolean boolean -

Always on PDU session indication. The purpose of the Always-on PDU session indication information element is to indicate whether a PDU session is established as an always-on PDU session.

See [Clause 9.11.4.3/3GPP-TS.24.501].

- 2.14 TR-181i2a14c1
DNN string​(100) string​(100) - The Data Network Name used by the PDU. The DNN value may be from the optional S-NSSAI specified at the time of PDU establishment or a default determined by the 5G core. A DNN is analagous to an LTE APN used the same format defined in [Clause 9.11.2.1A/3GPP-TS.24.501]. - 2.14 TR-181i2a14c1
QoSRuleNumberOfEntries unsignedInt unsignedInt - The number of entries in the QoSRule table. - 2.14 TR-181i2a14c1
QoSFlowNumberOfEntries unsignedInt unsignedInt - The number of entries in the QoSFlow table. - 2.14 TR-181i2a14c1
Device.​PDU.​Session.​{i}.​PCO. object object​[1:1] - Policy Configuration Options (PCO) is an optional set of configuration parameters supplied by the network at the request of the 5G-RG as defined in [Clause 10.5.6.3/3GPP-TS.24.008]. - 2.14 TR-181i2a14c1
IPv6PCSCF string​(45) IPv6Address - [IPv6Address] The IPv6 address of the P-CSCF used for VoLTE telephony. - 2.14 TR-181i2a14c1
IPv6DNS string​(256) string​(256) - A comma separated list of IPv6 DNS servers. - 2.14 TR-181i2a14c1
IPv4PCSCF string​(15) IPv4Address - [IPv4Address] The IPv4 address of the P-CSCF used for VoLTE telephony. - 2.14 TR-181i2a14c1
IPv4DNS string​(256) string​(256) - A comma separated list of IPv4 DNS servers. - 2.14 TR-181i2a14c1
Device.​PDU.​Session.​{i}.​NetworkSlice. object object​[1:1] -

Describes a S-NSSAI Information element providing network slice specification.

See [Clause 9.11.2.8/3GPP-TS.24.501]

- 2.14 TR-181i2a14c1
SliceServiceType string SST -

[SST] The Slice Service Type (SST). Enumeration of:

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

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

- 2.14 TR-181i2a14c1
SliceDifferentiator unsignedInt unsignedInt -

The Slice differentiator is an optional number used to differentiate network slices with the same SST.

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

- 2.14 TR-181i2a14c1
Device.​PDU.​Session.​{i}.​QoSRule.​{i}. object​[0:] object​[0:∞] -

This object describes the PDU QoS Rule table. The purpose of the QoS Rule table is to assign a QFI to mark traffic based on a set of classification rules. The rules are set by the netowrk operator and are specific for each PDU.

For example:

  • A QoS Rule with a default used for general traffic has the following parameters.
  • QFI=1
  • DQR=1 - Default rule
  • Filter 1 for rule
  • Direction=bidirectional
  • Type=1 - Match all
  • A QoS Rule matchihg a voice service.
  • QFI=32
  • DQR=0
  • Filter 1 for rule
  • Direction=bidirectional
  • Type=33 - Destination IPv6 range
  • Value=2001:8000/48 - Destination IPv6 range
  • Filter 2 for rule
  • Direction=bidirectional
  • Type=16 - Destination IPv4 address with netmask
  • Value=203.1.0.0 255.255.255.0 - Destination IPv4 address with netmask

A full description can be found at [Clause 9.11.4.13/3GPP-TS.24.501] QoS Rules

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

- 2.14 TR-181i2a14c1
Alias string​(64) Alias W

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

The following mandatory constraints MUST be enforced:

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

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

- 2.14 TR-181i2a14c1
Identifier unsignedInt​(1:255) unsignedInt​(1:255) - The QoS rule identifier field is used to identify the QoS rule. - 2.14 TR-181i2a14c1
Precedence unsignedInt​(0:255) unsignedInt​(0:255) - The QoS rule precedence field is used to specify the precedence of the QoS rule among all QoS rules. The higher the value of the QoS rule precedence field, the lower the precedence of that QoS rule is. - 2.14 TR-181i2a14c1
Segregation boolean boolean - In the UE to network direction the segregation bit indicates whether the UE is requesting the network to bind service data flows described by the QoS rule to a dedicated QoS Flow. When true segregation is requested. - 2.14 TR-181i2a14c1
QFI unsignedInt​(1:63) unsignedInt​(1:63) - QoS Flow identifier. - 2.14 TR-181i2a14c1
DQR boolean boolean - Default QoS rule flag. When true this QoS rule is the default QoS rule. - 2.14 TR-181i2a14c1
FilterNumberOfEntries unsignedInt unsignedInt - The number of entries in the Filter table. - 2.14 TR-181i2a14c1
Device.​PDU.​Session.​{i}.​QoSRule.​{i}.​Filter.​{i}. object​[0:] object​[0:∞] -

This object describes the PDU QoS Rule Filter table. As each packet filter is logically anded with the others, there shall not be more than one occurrence of each packet filter component type.

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

- 2.14 TR-181i2a14c1
Alias string​(64) Alias W

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

The following mandatory constraints MUST be enforced:

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

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

- 2.14 TR-181i2a14c1
Direction string string -

The packet filter direction field is used to indicate for what traffic direction the filter applies. See [Clause 9.11.4.13/3GPP-TS.24.501] Enumeration of:

- 2.14 TR-181i2a14c1
Type unsignedInt unsignedInt - Packet filter component type identifier. See [Clause 9.11.4.13/3GPP-TS.24.501]. - 2.14 TR-181i2a14c1
Value string​(1024) string​(1024) - Matching value for the component type. See [Clause 9.11.4.13/3GPP-TS.24.501]. - 2.14 TR-181i2a14c1
Device.​PDU.​Session.​{i}.​QoSFlow.​{i}. object​[0:] object​[0:∞] -

Table of all QoS Flow Indicators (QFI) and their properties supported by the access network for this particular PDU.

For example:

  • A QoS Flow with a QFI of 1 used for general traffic has the following parameters.
  • FiveQI=8
  • A QoS Flow with a QFI of 32 used for voice traffic with a guaranteed bitrate of 150k has the following parameters.
  • FiveQI=1
  • GFBRUplink=150
  • GFBRDownlink=150

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

- 2.14 TR-181i2a14c1
Alias string​(64) Alias W

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

The following mandatory constraints MUST be enforced:

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

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

- 2.14 TR-181i2a14c1
QFI unsignedInt​(1:63) unsignedInt​(1:63) - QoS Flow Identifier. - 2.14 TR-181i2a14c1
FiveQI unsignedInt​(1:255) unsignedInt​(1:255) - 5G QoS Identifier. See [Clause 5.7.4/3GPP-TS.23.501] for a table of standardised 5QI QoS characteristics. - 2.14 TR-181i2a14c1
GFBRUplink unsignedLong unsignedLong - Guaranteed Flow Bitrate - Upstream (expressed in bits per second). - 2.14 TR-181i2a14c1
GFBRDownlink unsignedLong unsignedLong - Guaranteed Flow Bitrate - Downstream (expressed in bits per second). - 2.14 TR-181i2a14c1
MFBRUplink unsignedLong unsignedLong - Maximum Flow Bitrate - Upstream (expressed in bits per second). - 2.14 TR-181i2a14c1
MFBRDownlink unsignedLong unsignedLong - Maximum Flow Bitrate - Downstream (expressed in bits per second). - 2.14 TR-181i2a14c1
AveragingWindow unsignedInt unsignedInt - Averaging window for both uplink and downlink in milliseconds. - 2.14 TR-181i2a14c1
EPSBearer unsignedInt unsignedInt - EPS Bearer Identity. See [Clause 9.3.2/3GPP-TS.24.301]. - 2.14 TR-181i2a14c1
Device.​FWE. object object​[1:1] - 5G Wireline wireless Encapsulation transport for data plane. See [FWEREG]. - 2.14 TR-181i2a14c1
LinkNumberOfEntries unsignedInt unsignedInt - The number of entries in the Link table. - 2.14 TR-181i2a14c1
Device.​FWE.​Link.​{i}. object​[0:] object​[0:∞] -

5G Wireline wireless Encapsulation link layer table (a stackable interface object as described in [Section 4.2/TR-181i2]).

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

- 2.14 TR-181i2a14c1
Status string string -

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

This parameter is based on ifOperStatus from [RFC2863].

- 2.14 TR-181i2a14c1
Alias string​(64) Alias W

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

The following mandatory constraints MUST be enforced:

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

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

- 2.14 TR-181i2a14c1
Name string​(64) string​(64) -

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

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

- 2.14 TR-181i2a14c1
LastChange unsignedInt unsignedInt - The accumulated time in seconds since the link entered its current operational state. - 2.14 TR-181i2a14c1
LowerLayers string​(1024)​[] list​(1024) of string W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2]. - 2.14 TR-181i2a14c1
Device.​FWE.​Link.​{i}.​Stats. object object​[1:1] -

Throughput statistics for this interface.

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

- 2.14 TR-181i2a14c1
BytesSent unsignedLong unsignedLong - The total number of bytes transmitted out of the interface, including framing characters. - 2.14 TR-181i2a14c1
BytesReceived unsignedLong unsignedLong - The total number of bytes received on the interface, including framing characters. - 2.14 TR-181i2a14c1
PacketsSent unsignedLong unsignedLong - The total number of packets transmitted out of the interface. - 2.14 TR-181i2a14c1
PacketsReceived unsignedLong unsignedLong - The total number of packets received on the interface. - 2.14 TR-181i2a14c1
ErrorsSent unsignedInt unsignedInt - The total number of outbound packets that could not be transmitted because of errors. - 2.14 TR-181i2a14c1
ErrorsReceived unsignedInt unsignedInt - The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. - 2.14 TR-181i2a14c1
UnicastPacketsSent unsignedLong unsignedLong - The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. - 2.14 TR-181i2a14c1
UnicastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. - 2.14 TR-181i2a14c1
DiscardPacketsSent unsignedInt unsignedInt - The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. - 2.14 TR-181i2a14c1
DiscardPacketsReceived unsignedInt unsignedInt - The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. - 2.14 TR-181i2a14c1
MulticastPacketsSent unsignedLong unsignedLong - The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.14 TR-181i2a14c1
MulticastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. - 2.14 TR-181i2a14c1
BroadcastPacketsSent unsignedLong unsignedLong - The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.14 TR-181i2a14c1
BroadcastPacketsReceived unsignedLong unsignedLong - The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. - 2.14 TR-181i2a14c1
UnknownProtoPacketsReceived unsignedInt unsignedInt - The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. - 2.14 TR-181i2a14c1

Notification Requirements

Parameters for which Value Change Notification MAY be Denied

Parameter
Device.Cellular.Interface.{i}.
RSRP
Device.Cellular.Interface.{i}.
RSRQ
Device.Hosts.AccessControl.{i}.
Alias
Device.Hosts.AccessControl.{i}.Schedule.{i}.
Alias
Device.WWC.AccessNetwork.{i}.
Alias
Device.WWC.URSP.{i}.
Alias
Device.WWC.URSP.{i}.TrafficDescriptor.{i}.
Alias
Device.WWC.URSP.{i}.TrafficDescriptor.{i}.RouteSelectionDescriptor.{i}.
Alias
Device.PDU.Session.{i}.QoSRule.{i}.
Alias
Device.PDU.Session.{i}.QoSRule.{i}.Filter.{i}.
Alias
Device.PDU.Session.{i}.QoSFlow.{i}.
Alias
Device.FWE.Link.{i}.
Alias
Device.FWE.Link.{i}.
LastChange
Device.FWE.Link.{i}.Stats.
BytesSent
Device.FWE.Link.{i}.Stats.
BytesReceived
Device.FWE.Link.{i}.Stats.
PacketsSent
Device.FWE.Link.{i}.Stats.
PacketsReceived
Device.FWE.Link.{i}.Stats.
ErrorsSent
Device.FWE.Link.{i}.Stats.
ErrorsReceived
Device.FWE.Link.{i}.Stats.
UnicastPacketsSent
Device.FWE.Link.{i}.Stats.
UnicastPacketsReceived
Device.FWE.Link.{i}.Stats.
DiscardPacketsSent
Device.FWE.Link.{i}.Stats.
DiscardPacketsReceived
Device.FWE.Link.{i}.Stats.
MulticastPacketsSent
Device.FWE.Link.{i}.Stats.
MulticastPacketsReceived
Device.FWE.Link.{i}.Stats.
BroadcastPacketsSent
Device.FWE.Link.{i}.Stats.
BroadcastPacketsReceived
Device.FWE.Link.{i}.Stats.
UnknownProtoPacketsReceived

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.

AccessControl:1 Profile

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

Name Requirement
Device.​Hosts. P
AccessControlNumberOfEntries R
Device.​Hosts.​AccessControl.​{i}. P
PhysAddress W
AccessPolicy W
Enable W
ScheduleNumberOfEntries R
Device.​Hosts.​AccessControl.​{i}.​Schedule.​{i}. P
Alias W
Enable W
Day W
StartTime W
Duration W

IPLayerCapacity:1 Profile

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

Name Requirement
Device.​IP.​Diagnostics. P
IPLayerCapacitySupported R
IPLayerMaxConnections R
IPLayerMaxIncrementalResult R
IPLayerCapSupportedMetrics R
IPLayerCapacity() P
Input. -
Interface W
Role W
Host W
Port W
JumboFramesPermitted W
NumberOfConnections W
EthernetPriority W
DSCP W
ProtocolVersion W
UDPPayloadMin W
UDPPayloadMax W
PortMin W
PortMax W
TestType W
PreambleDuration W
StartSendingRate W
NumberTestSubIntervals W
TestSubInterval W
StatusFeedbackInterval W
TimeoutNoTraffic W
Tmax W
TmaxRTT W
TimestampResolution W
LowerThresh W
UpperThresh W
HighSpeedDelta W
SlowAdjThresh W
HSpeedThresh W
Output. -
BOMTime R
EOMTime R
Tmax R
TestInterval R
MaxIPLayerCapacity R
TimeOfMax R
LossRatioAtMax R
RTTRangeAtMax R
PDVRangeAtMax R
MinOnewayDelayAtMax R
ReorderedRatioAtMax R
IncrementalResult.{i}. R
IPLayerCapacity R
TimeOfSubInterval R
LossRatio R
RTTRange R
PDVRange R
MinOnewayDelay R
ReorderedRatio R


Generated by Broadband Forum report.pl#428+ (2022-01-07 version) on 2022/07/19 at 16:57:12 (INTERIM VERSION).
report.pl --exitcode=fatals --usp --cwmpindex=.. --nofontstyles --nowarnreport --quiet --lastonly --report=html --outfile=tr-181-2-14-1-usp-diffs.html tr-181-2-14-1-usp.xml --altnotifreqstyle --clampversion=2.12 --ignoreenableparameter --immutablenonfunctionalkeys --markmounttype --valuessuppliedoncreate