 | Device:2 Root Data Model definition [CWMP] (changes)tr-181-2-22-0-cwmp.xml | ||
DATA MODEL DEFINITION | |||
License
Copyright (c) 2010-2025, Broadband Forum
The undersigned members have elected to grant the copyright to
their contributed material used in this software:
Copyright (c) 2017-2019, 2021 ARRIS Enterprises, LLC.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
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.
-
Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The above license is used as a license under copyright only. Please reference the Forum IPR Policy for patent licensing terms https://www.broadband-forum.org/ipr-policy.
Any moral rights which are necessary to exercise under the above license grant are also deemed granted under this license.
Data Types
The Parameters defined in this specification make use of a limited subset of the default SOAP data types [SOAP1.1]. These data types and the named data types used by this specification are described below.
Note: A Parameter that is defined to be one of the named data types is reported as such at the beginning of the Parameter's description via a reference back to the associated data type definition (e.g. [MACAddress]). However, such parameters still indicate their SOAP data types.
| Data Type | Base Type | Description |
|---|---|---|
|
base64 |
- |
Base64 encoded binary (no line-length limitation). A minimum and maximum allowed length can be indicated using the form base64(Min:Max), where Min and Max are the minimum and maximum length in characters before Base64 encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in base64(Max). Multiple comma-separate ranges can be specified, in which case the length MUST be in one of the ranges. |
|
boolean |
- |
Boolean, where the allowed values are 0 or 1 (or equivalently, true or false). |
|
dateTime |
- |
The subset of the ISO 8601 date-time format defined by the SOAP dateTime type [SOAP1.1]. |
|
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. |
|
string |
- |
For strings, a minimum and maximum allowed length can be indicated using the form string(Min:Max), where Min and Max are the minimum and maximum string length in characters. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in string(Max). Multiple comma-separated ranges can be specified, in which case the string length will be in one of the ranges. |
|
unsignedInt |
- |
Unsigned integer in the range 0 to 4294967295, inclusive. For some unsignedInt types, a value range is given using the form unsignedInt(Min:Max) or unsigned(Min:Max step Step), where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges. |
|
unsignedLong |
- |
Unsigned long integer in the range 0 to 18446744073709551615, inclusive. For some unsignedLong types, a value range is given using the form unsignedLong(Min:Max) or unsignedLong(Min:Max step Step), where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges. |
|
Alias |
string(:64) |
A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
|
FileURI |
URI(:2048) |
A Uniform Resource Identifier (URI) using the file URI scheme as defined in [RFC8089]. This is used to specify file system paths. The path component represents an absolute file system path. |
|
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:
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:
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.
This notation can also represent individual addresses by specifying all bits.
If the IP address part is unspecified or inapplicable, it MUST be an empty string unless otherwise specified by the parameter definition. In this case the IP prefix will be of the form "/n". If the entire IP prefix is unspecified or inapplicable, it MUST be an empty string unless otherwise specified by the parameter definition. |
|
IPv4Address |
IPAddress(:45) |
IPv4 address (or subnet mask). Can be any IPv4 address that is permitted by the IPAddress data type. Possible patterns:
|
|
IPv4Prefix |
IPPrefix(:49) |
IPv4 address prefix. Can be any IPv4 prefix that is permitted by the IPPrefix data type. Possible patterns:
|
|
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:
|
|
Order |
unsignedInt(1:) |
Position of the object entry in the order of precedence. A value of 1 indicates the first entry to be considered (highest precedence). When a object instance is created, or when an existing parameter value is modified, if the value matches that of an existing entry, the parameter values for the existing entry and all lower parameter entries are incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes parameter values to be compacted. When a value is changed, incrementing occurs before compaction. If no parameter value is supplied on creation of a object instance, it MUST be assigned a value that is one more than the largest current value (lowest precedence). |
|
SST |
Service Slice Type (SST). Enumeration of:
|
|
|
SensingDataType |
hexBinary(8) |
A 4-byte hexadecimal value representing a sensing data type. A sensing data type identifies the format of the sensing measurement data, e.g. [Section 9.4.1.81/802.11bf] or vendor-specific. The first three bytes represent either the CID (Company Identifier) or OUI (Organizationally Unique Identifier) assigned and registered by the IEEE Registration Authority. The last byte identifies the format belonging to the CID, or OUI. The value of 000FAC00 represents the format defined in [Section 9.4.1.81/802.11bf]. See [Section 21.2, Sensing Capabilities/EasyMesh]. |
|
SensingExchangeType |
Indicates the sensing exchange types: Enumeration of:
See [Section 17.2.116, Sensing Exchange Request TLV/EasyMesh]. |
|
|
StatsCounter32 |
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 |
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. |
|
|
ThreadLinkQuality |
unsignedInt(0:3) |
Encoded intervals representation of the Thread link quality:
|
|
UERComplex |
int[2:2] |
Pair of 32-bit signed integers a(i),b(i) with each pair representing a complex component of the uncalibrated echo response (UER);
for values of i starting at i=0. Both values are represented as signed integers. The interpretation of the UER value is as defined in [Clause A.2.2.1/G.996.2]. |
|
URI |
string(:2048) |
Uniform Resource Identifier. See [RFC3986]. |
|
URL |
URI(:2048) |
Uniform Resource Locator. See [RFC3986] (URI), [IANA-uri-schemes], and individual URI scheme RFCs such as [RFC7252] (coap, coaps) and [RFC7230] (http, https). |
References
|
3GPP TS 23.003, Numbering, addressing and identification, 3GPP CT WG4. |
|
|
3GPP TS 23.501, System architecture for the 5G System (5GS); Stage 2, 3GPP SA WG2. |
|
|
3GPP TS 24.008, Mobile radio interface Layer 3 specification; Core network protocols; Stage 3, 3GPP CT WG1. |
|
|
3GPP TS 24.301, Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3, 3GPP CT WG1. |
|
|
3GPP TS 24.501, Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3, 3GPP CT WG1. |
|
|
3GPP TS 36.101, Evolved Universal Terrestrial Radio Access (E-UTRA); User Equipment (UE) radio transmission and reception, 3GPP RAN WG4. |
|
|
3GPP TS 38.104, NR; Base Station (BS) radio transmission and reception, 3GPP RAN WG3. |
|
|
IEEE Std 802.11-2007, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, 2007. |
|
|
IEEE Std 802.11-2012, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, March 2012. |
|
|
IEEE Std 802.11-2020, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, December 2020. |
|
|
IEEE Std 802.11-2024, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, April 2025. |
|
|
[802.11ax] |
IEEE Std 802.11ax, Enhancements for High Efficiency WLAN, IEEE, May 2021. |
|
[802.11be] |
IEEE Std 802.11be, Enhancements for Exteremely High Throughput (EHT) WLAN, IEEE, July 2025. |
|
[802.11bf] |
IEEE Std 802.11bf, Enhancements for Wireless LAN Sensing, IEEE, September 2025. |
|
Thread Specification, IEEE Standard for Low-Rate Wireless Networks, IEEE, July 2020. |
|
|
IEEE Std 802.1AB-2009, Station and Media Access Control Connectivity Discovery, IEEE, 2009. |
|
|
IEEE Std 802.1ad-2005, Virtual Bridged Local Area Networks Amendment 4: Provider Bridges, IEEE, May 2005. |
|
|
IEEE Std 802.1AX-2014, IEEE Standard for Local and metropolitan area networks - Link Aggregation, IEEE, 2014. |
|
|
IEEE Std 802.1D-2004, Media Access Control (MAC) Bridges, IEEE, 2004. |
|
|
IEEE Std 802.1Q-2005, Virtual Bridged Local Area Networks, IEEE, 2006. |
|
|
IEEE Std 802.1Q-2011, MAC Bridges and Virtual Bridge Local Area Networks, IEEE, 2011. |
|
|
IEEE Std 802.1x-2004, Standards for Local and Metropolitan Area Networks: Port based Network Access Control, IEEE, 2004. |
|
|
IEEE Std 802.3-2015, IEEE Standard for Ethernet, IEEE, 2015. |
|
|
[AFCSDI] |
AFC System to AFC Device Interface (SDI) Specification, Wi-Fi AFC System to AFC Device Interface (SDI) Specification, Wi-Fi Alliance, May 2024. |
|
CM-SP-MULPIv3.0, DOCSIS 3.0 MAC and Upper Layer Protocols Interface Specification, CableLabs, December 2017. |
|
|
CM-SP-RFIv2.0, Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification, CableLabs, April 2009. |
|
|
Data Elements Specification, Wi-Fi Data Elements Specification, Wi-Fi Alliance, 2024. |
|
|
[DNS-SD] |
RFC 6763, DNS-Based Service Discovery, IETF, 2013. |
|
[DSLite] |
RFC 6333, Dual-Stack Lite Broadband Deployments Following IPv4 Exhaustion, IETF, 2011. |
|
Wi-Fi Easy Connect Specification, Wi-Fi Easy Connect Specification, Wi-Fi Alliance, November 2022. |
|
|
[EasyMesh] |
EasyMesh Specification, Wi-Fi EasyMesh Specification, Wi-Fi Alliance, August 2024. |
|
ETSI TS 102 690 v1.1.6, Machine-to-Machine Communications (M2M Functional Architecture), ETSI, June 2012. |
|
|
[G.9701] |
G.9701, Fast access to subscriber terminals (G.fast)- Physical layer specification, ITU-T, 2014. |
|
[G.988] |
G.988, ONU management and control interface (OMCI) specification, ITU-T, 2010. |
|
[G.993.1] |
G.993.1, Very high speed digital subscriber line transceivers, ITU-T. |
|
[G.9954] |
G.9954, Phoneline networking transceivers - Enhanced physical, media access, and link layer specifications (HPNA 3.0 and 3.1), ITU-T, 2007. |
|
[G.996.2] |
G.996.2, Single-ended line testing for digital subscriber lines (DSL), ITU-T. |
|
[G.9960] |
G.9960, Unified high-speed wire-line based home networking transceivers - System architecture and physical layer specification, ITU-T. |
|
[G.9961] |
G.9961, Unified high-speed wire-line based home networking transceivers - Data link layer specification, ITU-T. |
|
[G.9964] |
G.9964, Unified high-speed wire-line based home networking transceivers - Power spectral density specification, 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. |
|
[G.Sup45] |
G.Sup45, Power conservation in optical access systems, ITU-T, September 2022. |
|
[HPAV1.1] |
HomePlug™ AV Specification, Version 1.1, HomePlug Alliance, 2007. |
|
IANA IP Version Numbers, IP Version Numbers, IANA. |
|
|
IANA Protocol Numbers, Protocol Numbers, IANA. |
|
|
IANA Uniform Resource Identifier (URI) Schemes Registry, Uniform Resource Identifier (URI) Schemes, IANA. |
|
|
ICSA Baseline Modular Firewall Certification Criteria, Baseline module - version 4.1, ICSA Labs, 2008. |
|
|
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. |
|
|
Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, IEEE, March 1997. |
|
|
IKEv2 Parameters, Internet Key Exchange Version 2 (IKEv2) Parameters, IANA. |
|
|
[LMAPIFM] |
RFC 8193, Information Model for Large-Scale Measurement Platforms (LMAPs), IETF, August 2017. |
|
MOCA20-MIB, Remote Management of MoCA Interfaces using SNMP MIB v2.0, MoCA Alliance, 2020. |
|
|
[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. |
|
[MoCAv2.0] |
MoCA v2.0, MoCA MAC/PHY Specification v2.0, MoCA Alliance, 2017. |
|
[MQTT311] |
MQTT Version 3.1.1, MQTT v3.1.1, OASIS Message Queuing Telemetry Transport (MQTT) TC, October 2014. |
|
[MQTT50] |
MQTT Version 5.0, MQTT Version 5.0, Candidate OASIS Standard 02., OASIS Message Queuing Telemetry Transport (MQTT) TC, February 2019. |
|
[PCPProxy] |
RFC 7648, Port Control Protocol (PCP) Proxy Function, IETF, September 2015. |
|
[RFC1035] |
RFC 1035, Domain Names - Implementation and Specification, IETF, 1987. |
|
[RFC1661] |
RFC 1661, The Point-to-Point Protocol (PPP), IETF, 1994. |
|
[RFC2131] |
RFC 2131, Dynamic Host Configuration Protocol, IETF. |
|
[RFC2132] |
RFC 2132, DHCP Options and BOOTP Vendor Extensions, IETF. |
|
[RFC2616] |
RFC 2616, Hypertext Transfer Protocol - HTTP/1.1, IETF, 1999. |
|
[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. |
|
[RFC2819] |
RFC 2819, Remote Network Monitoring Management Information Base, IETF, 2000. |
|
[RFC2863] |
RFC 2863, The Interfaces Group MIB, IETF, 2000. |
|
[RFC2890] |
RFC 2890, Key and Sequence Number Extensions to GRE, IETF, November 2000. |
|
[RFC3004] |
RFC 3004, The User Class Option for DHCP, IETF. |
|
[RFC3339] |
RFC 3339, Date and Time on the Internet: Timestamps, IETF, July, 2002. |
|
[RFC3646] |
RFC 3646, DNS Configuration options for Dynamic Host Configuration Protocol for IPv6 (DHCPv6), IETF, 2003. |
|
[RFC3647] |
RFC 3647, Internet X.509 Public Key Infrastructure Certificate Policy and Certification Practices Framework, IETF, November 2003. |
|
[RFC3925] |
RFC 3925, Vendor-Identifying Vendor Options for Dynamic Host Configuration Protocol version 4 (DHCPv4), IETF. |
|
[RFC3931] |
RFC 3931, Layer Two Tunneling Protocol - Version 3 (L2TPv3), IETF, March 2005. |
|
[RFC3986] |
RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF. |
|
[RFC4007] |
RFC 4007, IPv6 Scoped Address Architecture, IETF. |
|
[RFC4122] |
RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005. |
|
[RFC4191] |
RFC 4191, Default Router Preferences and More-Specific Routes, IETF, 2005. |
|
[RFC4193] |
RFC 4193, Unique Local IPv6 Unicast Addresses, 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. |
|
[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. |
|
[RFC4861] |
RFC 4861, Neighbor Discovery for IP version 6 (IPv6), IETF, 2007. |
|
[RFC4862] |
RFC 4862, IPv6 Stateless Address Autoconfiguration, IETF, 2007. |
|
[RFC5280] |
RFC 5280, Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile, IETF, May 2008. |
|
[RFC5424] |
RFC 5424, The Syslog Protocol, IETF, May 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. |
|
[RFC6120] |
RFC 6120, Extensible Messaging and Presence Protocol (XMPP) : Core, IETF, 2011. |
|
[RFC6296] |
RFC 6296, IPv6-to-IPv6 Network Prefix Translation, IETF, June 2011. |
|
[RFC6614] |
RFC 6614, Transport Layer Security (TLS) Encryption for RADIUS, IETF, May 2012. |
|
[RFC6887] |
RFC 6887, Port Control Protocol (PCP), IETF, 2013. |
|
[RFC6970] |
RFC 6970, Universal Plug and Play (UPnP) Internet Gateway Device (IGD) - Port Control Protocol (PCP) Interworking Function, IETF, 2013. |
|
[RFC7159] |
RFC7159, The JavaScript Object Notation (JSON) Data Interchange Format, IETF, March 2014. |
|
[RFC7230] |
RFC 7230, Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing, IETF, June 2014. |
|
[RFC7252] |
RFC 7252, The Constrained Application Protocol (CoAP), IETF, June 2014. |
|
[RFC7291] |
RFC 7291, DHCP Options for the Port Control Protocol (PCP), IETF, July 2014. |
|
[RFC7348] |
RFC 7348, Virtual eXtensible Local Area Network (VXLAN), IETF, August 2014. |
|
[RFC7559] |
RFC 7559, Packet-Loss Resiliency for Router Solicitations, IETF, May 2015. |
|
[RFC7594] |
RFC 7594, A Framework for Large-Scale Measurement of Broadband Performance (LMAP), IETF, September 2015. |
|
[RFC7597] |
RFC 7597, Mapping of Address and Port with Encapsulation (MAP), IETF, July 2015. |
|
[RFC7598] |
RFC 7598, DHCPv6 Options for configuration of Softwire Address and Port Mapped Clients, IETF, July 2015. |
|
[RFC7599] |
RFC 7599, Mapping of Address and Port using Translation (MAP-T), IETF, July 2015. |
|
[RFC7616] |
RFC 7616, HTTP Digest Access Authentication, IETF, September 2015. |
|
[RFC7617] |
RFC 7617, The 'Basic' HTTP Authentication Scheme, IETF, September 2015. |
|
[RFC8089] |
RFC 8089, The "file" URI Scheme, IETF, February 2017. |
|
[RFC8141] |
RFC 8141, Uniform Resource Names (URNs), IETF, April 2017. |
|
[RFC862] |
RFC 862, Echo Protocol, IETF, 1983. |
|
[RFC8822] |
RFC 8822, 5G Wireless Wireline Convergence User Plane Encapsulation (5WE), IETF, April 2021. |
|
[RFC959] |
RFC 959, File Transfer Protocol, IETF, 1985. |
|
[RFC9915] |
RFC 9915, Dynamic Host Configuration Protocol for IPv6 (DHCPv6), IETF, January 2026. |
|
[SFF-8024] |
SFF-8024, SFF Module Management Reference Code Tables, SNIA, May 2021. |
|
[SFF-8472] |
SFF-8472, Management Interface for SFP+, SNIA, March 2021. |
|
[SOAP1.1] |
Simple Object Access Protocol (SOAP) 1.1, W3C. |
|
Thread Specification, Thread Specification, Version 1.3, Thread Group. |
|
|
[TR-069] |
TR-069 Amendment 6, CPE WAN Management Protocol, Broadband Forum, April 2018. |
|
[TR-106] |
TR-106 Amendment 8, Data Model Template for CWMP Endpoints and USP Agents, Broadband Forum, May 2018. |
|
[TR-143] |
TR-143 Amendment 1 Corrigendum 1, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, August 2015. |
|
[TR-159] |
TR-159, Management Framework for xDSL Bonding, Broadband Forum, December 2008. |
|
[TR-181i2] |
TR-181 Issue 2 Amendment 15, Device Data Model, Broadband Forum, January 2022. |
|
[TR-232] |
TR-232, Bulk Data Collection, Broadband Forum, May 2012. |
|
[TR-304] |
TR-304, Broadband Access Service Attributes and Performance Metrics, Broadband Forum, February 2015. |
|
[TR-369] |
TR-369 Issue 1 Amendment 2, User Services Platform, Broadband Forum, January 2022. |
|
[UPA-PLC] |
Universal Powerline Association, UPA. |
|
UPnP Device Architecture, UPnP Device Architecture 1.0, UPnP Forum, April 2008. |
|
|
[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. |
|
Wi-Fi Alliance Capabilities, Wi-Fi Alliance Capabilities Specification, Wi-Fi Alliance. |
|
|
draft-ietf-netmod-syslog-model, A YANG Data Model for Syslog Configuration, IETF, April 2023. |
|
|
ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007. |
Legend
|
Object definition. |
|
Parameter definition. |
Device:2.22 Data Model
For a given implementation of this data model, the Agent MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the Agent supports only a single parameter that was introduced in version 1.4, then it will indicate support for version 1.4. The version number associated with each object and parameter is shown in the Version column.
Changes since 2.21:
- Changed name = Device:2.21 ⇒ Device:2.22
| Name | Type | Write | Description | Object Default | Version |
|---|---|---|---|---|---|
|
Device. |
object |
R |
The top-level object for a Device. |
- |
2.0 |
|
Device.DeviceInfo. |
object |
R |
This object contains general device information. |
- |
2.0 |
|
Manufacturer |
string(:64) |
R |
The manufacturer of the CPEdevice (human readable string). |
- |
2.0 |
|
ModelName |
string(:64) |
R |
Model name of the CPEdevice (human readable string). |
- |
2.0 |
|
Description |
string(:256) |
R |
A full description of the CPE device (human readable string). |
- |
2.0 |
|
HardwareVersion |
string(:64) |
R |
A string identifying the particular CPEdevice model and version. This parameter MUST always be included in Inform messages. |
- |
2.0 |
|
SoftwareVersion |
string(:64) |
R |
A string identifying the software version currently installed in the CPEdevice (i.e. version of the overall CPEdevice firmware). To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 3.0.21 where the components mean: Major.Minor.Build. This parameter MUST always be included in Inform messages. Active Notification MUST always be enabled for this parameter. |
- |
2.0 |
|
BootFirmwareImage |
string |
W |
A full path reference to the row in the FirmwareImage table of the firmware image that is to be loaded the next time the device boots. This parameter value cannot be empty and must point to a valid and enabled FirmwareImage object where the (FirmwareImage.{i}.Available parameter is set to 'true'). Out of the factory, this parameter should be set to point to the firmware image the CPEdevice will attempt to boot when first powered on. The firmware image instance referenced by this parameter must also have an Available parameter value of 'true'. Attempting to set this parameter to point to a non-enabled firmware image MUST result in the CPEdevice responding with a CWMP fault (9007). In situations where the CPEdevice cannot boot the firmware image specified by this parameter and manages to boot a different firmware image, the CPEdevice MUST NOT modify this value to point to the alternate firmware image that is currently active. |
- |
2.12 |
|
UpTime |
unsignedInt |
R |
Time in seconds since the CPEdevice was last restarted. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
|
FirstUseDate |
dateTime |
R |
Date and time in UTC that the CPEdevice first both successfully established an IP-layer network connection and acquired an absolute time reference using NTP or equivalent over that network connection. The CPEdevice MAY reset this date after a factory reset. If NTP or equivalent is not available, this parameter, if present, SHOULD be set to the Unknown Time value. |
- |
2.0 |
|
Device.DeviceInfo.VendorConfigFile.{i}. |
object(0:) |
R |
Every instance of this object is a Vendor Configuration File, and contains parameters associated with the Vendor Configuration File. This table of Vendor Configuration Files is for information only and does not allow the Controller to operate on these files in any way. Whenever the CPE successfully downloads a configuration file as a result of the Download RPC with the FileType argument of ''3 Vendor Configuration File'', the CPE MUST update this table. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.0 |
|
Name |
string(:64) |
R |
Name of the vendor configuration file. If the CPEdevice is able to obtain the name of the configuration file from the file itself, then the value of this parameter MUST be set to that name. Otherwise, if the CPEdevice can extract the file name from the URL used to download the configuration file, then the value of this parameter MUST be set to that name. Otherwise, the value of this parameter MUST be set to the value of the TargetFileName argument of the Download RPC used to download this configuration file. |
- |
2.0 |
|
Version |
string(:16) |
R |
A string identifying the configuration file version currently used in the CPE.device. If the CPEdevice is able to obtain the version of the configuration file from the file itself, then the value of this parameter MUST be set to the obtained value. Otherwise, the value of this parameter MUST be an empty string. |
- |
2.0 |
|
Date |
dateTime |
R |
Date and time when the content of the current version of this vendor configuration file was first applied by the CPE.}}device. |
- |
2.0 |
|
Device.DeviceInfo.ProcessStatus. |
object |
R |
Status of the processes on the device. |
- |
2.0 |
|
Device.DeviceInfo.ProcessStatus.CPU.{i}. |
object(0:) |
R |
This object describes the utilization metrics for each CPU on the device. It also defines the monitoring actions that are automatically triggered when specific utilization thresholds are crossed. At most one entry in this table can exist with a given value for Name, or with a given value for Alias. |
- |
2.18 |
|
NumSamples |
unsignedInt(1:300) |
W |
This parameter indicates the number of CPU usage samples that is neededrequired to calculate the average CPU utilization and populate the CPUUtilization The default value SHOULD be 30. |
- |
2.18 |
|
Device.DeviceInfo.LogRotate.{i}. |
object(0:) |
W |
This Objectobject details the available rotation settings for vendor log file rotation. Based on [A YANG Data Model for Syslog Configuration/YANGSYSLOG]. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name. |
- |
2.17 |
|
Name |
string(:2048) |
W |
[FileURI] Specifies the full path and filename of the log file that must be rotated.rotated, Which MUST useusing the urifile URI scheme file [The file URI Scheme/RFC8089]. |
- |
2.17 |
|
Device.DeviceInfo.LogRotate.{i}.LogFile.{i}. |
object(0:) |
R |
Each table entry represents a Log File. This table of log files is informational only and does not allow the Controller to operate on these files in any way. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.17 |
|
Name |
string(:2048) |
R |
[FileURI] Name of the rotated log file stored within the same directory thatas Name, is specified. Which MUST useusing the urifile URI scheme file [The file URI Scheme/RFC8089]. |
- |
2.17 |
|
Device.ManagementServer. |
object |
R |
This object contains parameters relating to the CPE's association with an ACS. |
- |
2.0 |
|
EnableCWMP |
boolean |
W |
Enables and disables the CPE'sdevice's support for CWMP. false means that CWMP support in the CPEdevice is disabled, in which case the device MUST NOT send any Inform messages to the ACS or accept any Connection Request notifications from the ACS. true means that CWMP support on the CPEdevice is enabled. The subscriber can re-enable the CPE'sdevice's CWMP support either by performing a factory reset or by using a LAN-side protocol to change the value of this parameter back to true. The factory default value MUST be true. |
- |
2.0 |
|
Device.Time. |
object |
R |
This object contains global parameters relating to the NTP time clients and or servers that are active in the device. This object can be used to model SNTP and NTP clients and servers. Both NTP and SNTP have identical packet formats and use the same mathematical operations to calculate client time, clock offset, and roundtrip delay. From the perspective of an NTP or SNTP server, there is no difference between NTP and SNTP clients, and from the perspective of an NTP or SNTP client, there is no difference between NTP and SNTP servers. SNTP servers are stateless like NTP servers in non-symmetric modes and can handle numerous clients, but SNTP clients usually operate with only one server at a time, unlike most NTP clients. |
- |
2.0 |
|
Status |
string |
R |
Reflects the global time synchronisation status of the CPE.device. Enumeration of:
|
- |
2.0 |
|
CurrentLocalTime |
dateTime |
R |
The current date and time in the CPE'sdevice's local time zone. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
|
Device.Time.Client.{i}. |
object(0:) |
W |
This object contains parameters relating to ana time client instance. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.16 |
|
Device.Time.Server.{i}. |
object(0:) |
W |
This object contains parameters relating to ana time server instance. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.16 |
|
Mode |
string |
W |
Specifies in which mode the NTP server must be ran.run. Enumeration of:
|
- |
2.16 |
|
BindType |
string |
W |
Specifies how the client sockets must be bounded.bound. Enumeration of:
|
- |
2.16 |
|
Device.UserInterface. |
object |
R |
This object contains parameters relating to the user interface of the CPE.}}device. |
- |
2.0 |
|
Enable |
boolean |
W |
Enables and disables the CPE'sdevice's user interface. The factory default value MUST be true. |
- |
2.11 |
|
PasswordRequired |
boolean |
W |
Present only if the CPEdevice provides a password-protected LAN-side user interface. Indicates whether or not the local user interface MUST require a password to be chosen by the user. If false, the choice of whether or not a password is used is left to the user. |
- |
2.0 |
|
PasswordUserSelectable |
boolean |
W |
Present only if the CPEdevice provides a password-protected LAN-side user interface and supports LAN-side Auto-Configuration. Indicates whether or not a password to protect the local user interface of the CPEdevice MAY be selected by the user directly (i.e. Users.User.{i}.Password), or MUST be equal to the password used by the LAN-side Auto-Configuration protocol (i.e. LANConfigSecurity.ConfigPassword). |
- |
2.0 |
|
UpgradeAvailable |
boolean |
W |
Indicates that a CPEdevice upgrade is available, allowing the CPEdevice to display this information to the user. |
- |
2.0 |
|
WarrantyDate |
dateTime |
W |
Indicates the date and time in UTC that the warranty associated with the CPEdevice is to expire. |
- |
2.0 |
|
AutoUpdateServer |
string(:256) |
W |
The server the CPEdevice can check to see if an update is available for direct download to it. This MUST NOT be used by the CPE if the ManagementServer.UpgradesManaged parameter is true. |
- |
2.0 |
|
HTTPAccessSupportedProtocols |
string[] |
R |
Comma-separated list of strings. Indicates the protocols that are supported by the CPEdevice for the purpose of remotely accessing the user interface. Each list item is an enumeration of: |
- |
2.16 |
|
Device.UserInterface.HTTPAccess.{i}. |
object(0:) |
W |
HTTPAccess is used for modeling the different web interfaces that may be either locally or remotely available in the device. For example with Software Modules it is possible to install multiple services that embed a web interface like a Video service or Photo service. An instance of the HTTPAccess can model a web interface that is embedded in the device firmware or installed through a Software Modules management system. Access to the web interface MAY require user authentication. To have access authentication the device MUST support a Users.User. object with at least one instance and an assigned relevant role in Users.User.{i}.RoleParticipation. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. Changes since 2.21:
|
- |
2.16 |
|
CACertificate |
string |
W |
The value MUST be the Path Name of a row in the Security.Certificate. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Points to the CA certificate that must be used by the web interface. The CACertificate is used to validate the web client certificate. Protocol MUST be set to HTTPS This parameter was DEPRECATED in 2.19 Replaced by CABundle which can now contain one or more reference. This parameter was OBSOLETED in 2.21. This parameter was DELETED in 2.22. Changes since 2.21:
|
<Empty> |
2.16 |
|
MaxSessionEntries |
int(-1:) |
W |
The maximum number of concurrent entries in the Session table. When the maximum is reached, new sessions are rejected until an existing session ends. When MaxSessionEntries is 0, the Session table is disabled. When MaxSessionEntries is -1, the number of entries is left to the implementation. |
-1 |
2.22 |
|
MaxAccessLogEntries |
int(-1:) |
W |
The maximum number of entries in the AccessLog table. When the maximum is reached, the oldest entry (determined by AccessLog.{i}.TimeStamp) is deleted to make room for the new entry. When MaxAccessLogEntries is 0, the AccessLog table is disabled. When MaxAccessLogEntries is -1, the number of entries is left to the implementation. |
-1 |
2.22 |
|
AccessLogNumberOfEntries |
unsignedInt |
R |
The number of entries in the AccessLog table. |
- |
2.22 |
|
Device.UserInterface.HTTPAccess.{i}.Session.{i}. |
object(0:) |
R |
WebList serverof currently active web interface sessions. An entry is created when a session list.is established and removed when the session ends, regardless of the reason. Login attempts and session termination details are recorded in AccessLog. Note: This parameterobject was demoted to readOnly in the Device:2.17 version. At most one entry in this table can exist with a given value for SessionID. |
- |
2.16 |
|
Device.UserInterface.HTTPAccess.{i}.AccessLog.{i}. |
object(0:) |
R |
Log of web interface access events. Each entry records a login attempt, an authorization failure, or the reason a session ended. When the number of entries reaches the maximum specified by MaxAccessLogEntries, the oldest entry (determined by TimeStamp) is deleted and a new entry is created. At most one entry in this table can exist with the same values for all of User, IPAddress, Port, Protocol and TimeStamp. |
- |
2.22 |
|
User |
string(:256) |
R |
The user to whom the session belongs. When the user is unknown, an empty string is used. |
- |
2.22 |
|
IPAddress |
string(:45) |
R |
[IPAddress] The IP address of the remote web client, connected to the web interface. |
- |
2.22 |
|
Port |
unsignedInt(1:65535) |
R |
The port number of the remote web client connected to the web interface. |
- |
2.22 |
|
Protocol |
string |
R |
The value MUST be a member of the list reported by the HTTPAccessSupportedProtocols parameter. The protocol used for the web interface session. |
- |
2.22 |
|
TimeStamp |
dateTime |
R |
Indicates when the event occurred. |
- |
2.22 |
|
Status |
string |
R |
The outcome of the access attempt or the reason the session ended. Enumeration of:
|
- |
2.22 |
|
Device.UserInterface.RemoteAccess. |
object |
R |
This object contains parameters relating to remotely accessing the CPE'sdevice's user interface. Remote access is defined as any entity not of a local subnet attempting to connect to the CPE.device. Remote access requires user authentication. To provide remote access authentication the CPEdevice MUST support a "User" table with at least one instance that has "RemoteAccessCapable" set to true. This object was DEPRECATED in 2.16 due to the introduction of HTTPAccess. This object was OBSOLETED in 2.18. This object was DELETED in 2.19. |
- |
2.0 |
|
Device.UserInterface.LocalDisplay. |
object |
R |
This object describes how to remotely manage the initial positioning of a user interface on a device's local display. This object was DEPRECATED in 2.22 Replaced by Device.Hardware.Display to support multiple screens and apps. Changes since 2.21:
|
- |
2.0 |
|
Device.SFPs. |
object |
R |
This object describes the Small Form-Factor Pluggable (SFP) cages and the transceivers hosted in them. The object definition is based on parts of [SFF-8024] and [SFF-8472]. This data model is extensible to support new SFP management protocol standards in the future. |
- |
2.19 |
|
SupportedSFPTypes |
string[] |
R |
Comma-separated list of strings. Indicates the SFP types supported by the CPE.}}device. Each list item is an enumeration of:
|
- |
2.21 |
|
Device.SFPs.SFPCage.{i}. |
object(0:) |
R |
This object describes a cage into which an SFP is inserted. This object can also describe an instance of Small Form Factor (SFF) units soldered on to the platform. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.19 |
|
IsAllowed |
boolean |
R |
true if the CPEdevice allows the SFP, false if the CPEdevice blocks the SFP. See AllowedSFPs for what it means for an SFP to be blocked or allowed. The CPEdevice sets this parameter to true or false based on the configuration in: - AllowedSFPs.AllowAllSFPs - AllowedSFPs.AllowedSFP This parameter is only applicable for pluggable SFPs; it's not applicable for built-in modules/SFPs (the CPEdevice should always allow built-in modules/SFPs). This parameter is also only applicable if SFPPresent is true. |
- |
2.21 |
|
Device.SFPs.Mgmt. |
object |
R |
This object describes the elements of an SFP that are exposed through the given management interface. |
- |
2.19 |
|
Device.SFPs.Mgmt.SFF8472.{i}. |
object(0:) |
R |
This object describes an SFP in a cage or the SFF present that can be managed as per SFF-8472 standard. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.19 |
|
Device.SFPs.Mgmt.SFF8472.{i}.Transceiver. |
object |
R |
This object describes the Transceiver present in the SFP. The Transceiver object here models the electrical interface to the SFP from the host and the function that enables transmission and reception of electrical or optical signals over the link connected. The Transceiver object is agnostic of the underlying protocol used in the transmission. |
- |
2.19 |
|
Device.SFPs.Mgmt.SFF8472.{i}.Transceiver.Status. |
object |
R |
This object contains real time diagnostic and control values and status fields. See [Table 9-16/SFF-8472]. The CPEdevice 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.19 |
|
Device.SFPs.AllowedSFPs. |
object |
R |
Object specifying which pluggable SFPs the CPEdevice should block or allow. The object is not applicable for built-in modules/SFPs (the CPEdevice should always allow built-in modules/SFPs). When blocking a PON SFP, i.e. an SFP of type "G-PON", "XG-PON", "NG-PON2" or "XGS-PON", it's expected that the ANI using the SFP does not reach O5, i.e. that XPON.ONU.{i}.ANI.{i}.TC.ONUActivation.ONUState will not become O5. When blocking a MoCA SFP, it's expected that the MoCA interface using the SFP does not become up, i.e. that MoCA.Interface.{i}.Status does not become Up. When blocking an Ethernet SFP, i.e. an SFP of type "Optical Ethernet" or "Electrical Ethernet", it's expected that the Ethernet interface using the SFP does not become up, i.e. that Ethernet.Interface.{i}.Status does not become Up. |
- |
2.21 |
|
AllowAllSFPs |
boolean |
W |
When set to true, the CPEdevice allows all SFPs and the configuration in AllowedSFP is ignored. When set to false, the CPEdevice only allows SFPs which match with the classification criteria of at least one entry in AllowedSFP. The CPEdevice blocks each SFP for which there is no match. The default value SHOULD be true. |
- |
2.21 |
|
Device.SFPs.AllowedSFPs.AllowedSFP.{i}. |
object(0:) |
W |
Table of entries to classify pluggable SFPs. The CPEdevice should allow any pluggable SFP which matches at least one of the entries; the CPEdevice should block any SFP which does not match any entries. Example 1: allow all optical Ethernet SFPs Add entry with SFPType set to "Optical Ethernet" and with all other classification criteria set to the empty string. Example 2: allow XGS-PON SFP with "VendorA" as vendor name and "PartA" as part number Add entry with following values: - SFPType = "XGS-PON" - VendorName = "VendorA" - VendorOUI = "" - VendorPN = "PartA" - Fingerprint = "" At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.21 |
|
Enable |
boolean |
W |
Enables or disables this entry. If true, the CPEdevice should allow the SFPs which match this entry. If false, the CPEdevice should not use this entry to determine if an SFP is allowed or not. |
- |
2.21 |
|
Fingerprint |
string(:512) |
W |
Classification criterion. Fingerprint over certain properties of the SFP. If non-empty, the CPEdevice must take this fingerprint into account when classifying the SFP. Sometimes the other classification criteria in this AllowedSFP do not suffice to classify an SFP (to determine whether the SFP should be blocked or allowed). Then a CPEdevice can use a fingerprint/CRC/hash calculated over other properties of the SFP as extra discriminator. E.g. it could calculate a hash over the calibration data. Example: Assume AllowedSFP has only 1 entry with: - SFPType = "XGS-PON" - VendorName = "NameA" - VendorOUI = "" - VendorPN = "PartA" - Fingerprint = "FP1" If a user inserts an XGS-PON SFP with "NameA" as vendor name and "PartA" as part number, it depends on the fingerprint whether the CPEdevice blocks or allows the SFP. If the fingerprint of the SFP is "FP1", the CPEdevice must allow the SFP, else it must block it. |
- |
2.21 |
|
Device.InterfaceStack.{i}. |
object(0:) |
R |
This table contains information about the relationships between the multiple layers of interface objects ([Section 4.3/TR-181i2]). In particular, it contains information on which interfaces run on top of which other interfaces. This table is auto-generated by the CPEdevice based on the LowerLayers parameters on individual interface objects. Each table row represents a "link" between two interface objects, a higher-layer interface object (referenced by HigherLayer) and a lower-layer interface object (referenced by LowerLayer). Consequently, if a referenced interface object is deleted, the CPEdevice MUST delete the corresponding InterfaceStack row(s) that had referenced it. At most one entry in this table can exist with the same values for both HigherLayer and LowerLayer, or with a given value for Alias. |
- |
2.0 |
|
HigherLayer |
string(:256) |
R |
A reference to the interface object corresponding to the higher layer of the relationship, i.e. the interface which runs on top of the interface identified by the corresponding instance of LowerLayer. When the referenced higher layer interface is deleted, the CPEdevice MUST delete the table row. |
- |
2.0 |
|
LowerLayer |
string(:256) |
R |
A reference to the interface object corresponding to the lower layer of the relationship, i.e. the interface which runs below the interface identified by the corresponding instance of HigherLayer. When the referenced lower layer interface is deleted, the CPEdevice MUST delete the table row. |
- |
2.0 |
|
Device.DSL. |
object |
R |
This object models DSL lines, DSL channels, DSL bonding, and DSL diagnostics. The specific interface objects defined here are Line, Channel, and BondingGroup. Each Line models a layer 1 DSL Line interface, and each Channel models a layer 1 DSL Channel interface where multiple channels can run over a DSL line. In the case where bonding is configured, it is expected that BondingGroup is stacked above the Channel instances within its group. |
- |
2.0 |
|
Device.DSL.Line.{i}. |
object(0:) |
R |
DSL Line table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models physical DSL lines. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.0 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.0 |
|
FirmwareVersion |
string(:64) |
R |
A string identifying the version of the modem firmware currently installed for this interface. This is applicable only when the modem firmware is separable from the overall CPEdevice software. |
- |
2.0 |
|
LinkStatus |
string |
R |
Status of the DSL physical link. Enumeration of:
When LinkStatus is Up, Status is expected to be Up. When LinkStatus is Initializing or EstablishingLink or NoSignal or Disabled, Status is expected to be Down. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.0 |
|
LineEncoding |
string |
R |
The line encoding method used in establishing the Layer 1 DSL connection between the CPEdevice and the DSLAM. Enumeration of:
Note: Generally speaking, this variable does not change after provisioning. |
- |
2.0 |
|
UpstreamPower |
int |
R |
The current output power at the CPE'sdevice's DSL line (expressed in 0.1dBmV). Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
|
DownstreamPower |
int |
R |
The current received power at the CPE'sdevice's DSL line (expressed in 0.1dBmV). Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
|
Device.DSL.Line.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.0 |
|
TotalStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of Total statistics. Statistics SHOULD continue to be accumulated across CPEdevice reboots, though this might not always be possible. Note: TotalStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
|
LastShowtimeStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the second most recent DSL Showtime-the beginning of the period used for collection of LastShowtime statistics. If the CPEdevice has not retained information about the second most recent Showtime (e.g., on reboot), the start of LastShowtime statistics MAY temporarily coincide with the start of Showtime statistics. Note: LastShowtimeStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
|
CurrentDayStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of CurrentDay statistics. The CPEdevice MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so. Statistics SHOULD continue to be accumulated across CPEdevice reboots, though this might not always be possible. Note: CurrentDayStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
|
QuarterHourStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of QuarterHour statistics. The CPEdevice MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so. Statistics SHOULD continue to be accumulated across CPEdevice reboots, though this might not always be possible. Note: QuarterHourStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
|
Device.DSL.Channel.{i}. |
object(0:) |
R |
DSL Channel table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models DSL channel(s) on top of physical DSL lines. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.0 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.0 |
|
Device.DSL.Channel.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.0 |
|
TotalStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of Total statistics. Statistics SHOULD continue to be accumulated across CPEdevice reboots, though this might not always be possible. Note: TotalStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
|
LastShowtimeStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the second most recent DSL Showtime-the beginning of the period used for collection of LastShowtime statistics. If the CPEdevice has not retained information about the second most recent Showtime (e.g., on reboot), the start of LastShowtime statistics MAY temporarily coincide with the start of Showtime statistics. Note: LastShowtimeStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
|
CurrentDayStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of CurrentDay statistics. The CPEdevice MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so. Statistics SHOULD continue to be accumulated across CPEdevice reboots, though this might not always be possible. Note: CurrentDayStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
|
QuarterHourStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of QuarterHour statistics. The CPEdevice MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so. Statistics SHOULD continue to be accumulated across CPEdevice reboots, though this might not always be possible. Note: QuarterHourStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
|
Device.DSL.BondingGroup.{i}. |
object(0:) |
R |
DSL bonding group table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each instance is a bonding group, and is expected to be stacked above a Channel instance or a FAST.Line instance for each bonded channel in the group. Many of the parameters within this object, including LowerLayers, are read-only because bonding is not expected to be configured by a Controller. The DSL bonding data model is closely aligned with [TR-159]. Corresponds to [TR-159] oBondingGroup. At most one entry in this table can exist with a given value for Alias, or with a given value for Name, or with a given value for GroupID. |
- |
2.0 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.0 |
|
LowerLayers |
string[](:1024) |
R |
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, or an empty string. See [Section 4.2.1/TR-181i2]. LowerLayers is read-only for this object because bonding is expected to be configured by the CPE,device, not by the Controller. |
- |
2.0 |
|
BondSchemesSupported |
string[] |
R |
Comma-separated list of strings. Supported DSL bonding schemes. Each list item is an enumeration of:
Corresponds to [TR-159] oBondingGroup.aGroupBondSchemesSupported. |
- |
2.0 |
|
Device.DSL.BondingGroup.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.0 |
|
TotalStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of Total statistics. Statistics SHOULD continue to be accumulated across CPEdevice reboots, though this might not always be possible. Note: TotalStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
|
CurrentDayStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of CurrentDay statistics. The CPEdevice MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so. Statistics SHOULD continue to be accumulated across CPEdevice reboots, though this might not always be possible. Note: CurrentDayStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
|
QuarterHourStart |
unsignedInt |
R |
DSL-specific statistic. The Number of seconds since the beginning of the period used for collection of QuarterHour statistics. The CPEdevice MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so. Statistics SHOULD continue to be accumulated across CPEdevice reboots, though this might not always be possible. Note: QuarterHourStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
|
Device.DSL.BondingGroup.{i}.BondedChannel.{i}. |
object(0:) |
R |
DSL bonded channel table. Each table entry represents a bonded channel within the bonding group, and is associated with exactly one Channel instance or one FAST.Line instance. There MUST be an instance of BondedChannel for each DSL channel or FAST line that is bonded. When a Channel or FAST.Line is no longer bonded, then the CPEdevice MUST delete the corresponding BondedChannel instance. However, when a bonded Channel or FAST.Line becomes disabled, the channel remains bonded and so the corresponding BondedChannel instance MUST NOT be deleted. At most one entry in this table can exist with a given value for Alias, or with a given value for Channel. |
- |
2.0 |
|
Channel |
string(:256) |
R |
The value MUST be the Path Name of a row in the Channel. or FAST.Line. tables.This is the channel that is being bonded. This is read-only because bonding is expected to be configured by the CPE,device, not by the Controller. |
- |
2.0 |
|
Device.DSL.BondingGroup.{i}.BondedChannel.{i}.Ethernet. |
object |
R |
Per-channel [G.998.2] Ethernet-based bonding parameters. |
- |
2.0 |
|
Device.DSL.BondingGroup.{i}.BondedChannel.{i}.Ethernet.Stats. |
object |
R |
Per-channel [G.998.2] Ethernet-based bonding statistics. These relate to the [G.998.2] PME (Physical Medium Entity) Aggregation Function (PAF) lower layer (per-channel) interfaces. The CPEdevice MUST reset the Stats parameters either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.0 |
|
Device.DSL.BondingGroup.{i}.Ethernet. |
object(0:1) |
R |
Ethernet-based bonding parameters [G.998.2]. This object MUST be present if, and only if, BondScheme is Ethernet. This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time. |
- |
2.0 |
|
Device.DSL.BondingGroup.{i}.Ethernet.Stats. |
object |
R |
[G.998.2] Ethernet-based bonding statistics. These relate to the [G.998.2] PME (Physical Medium Entity) Aggregation Function (PAF) and to its upper layer interface. PAF lower layer interface statistics are in the BondedChannel.{i}.Ethernet.Stats objects. The CPEdevice MUST reset the Stats parameters either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.0 |
|
Device.DSL.Diagnostics. |
object |
R |
The DSL Diagnostics object. |
- |
2.0 |
|
Device.DSL.Diagnostics.SELTUER. |
object |
R |
This object contains DSL Single Ended Line Test - Physical Medium Dependent (SELT-PMD) Uncalibrated Echo Response (UER) diagnostics parameters. This object is for the CPE, aka the Transmission Unit - Remote end (TU-R). Reference: ITU-T Recommendation [Clause A.2, SELT-PMD management entity/G.996.2]. |
- |
2.13 |
|
UER |
int[2:2][1:4096] |
R |
The Uncalibrated Echo Response (UER) [a(0),b(0)], [a(1),b(1)], ... Comma-separated list (1 to 4096 items) of UERComplexs, with each list item consisting of the following. [UERComplex] Pair of 32-bit signed integers a(i),b(i) with each pair representing a complex component of the uncalibrated echo response (UER);
for values of i starting at i=0. Both values are represented as signed integers. The interpretation of the UER value is as defined in [Clause A.2.2.1/G.996.2]. The value of UER at frequency i*UERGroupSizeDf = (UERScaleFactor/(231))(a(i)+j*b(i))/(231) where Df = 4.3125 kHz. This parameter is defined as CPEdevice SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation [Clause A.2.2.1/G.996.2]. |
- |
2.13 |
|
UERScaleFactor |
unsignedInt |
R |
The Uncalibrated Echo Response (UER) scale factor. This parameter is defined as part of the CPEdevice SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation [Clause A.2.2.1/G.996.2]. Note that the scale factor is chosen such that max(abs(a(i)), abs(b(i))) over all i is equal to 231 - 1, which doesn't allow UERScaleFactor to be zero. |
- |
2.13 |
|
UERGroupSize |
unsignedInt(1:2,12) |
R |
The Uncalibrated Echo Response (UER) group size, UER_G. In units of subcarriers. This parameter is defined as part of the CPEdevice SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation [Clause A.2.2.2/G.996.2]. |
- |
2.13 |
|
Device.FAST. |
object |
R |
This object models FAST (defined in ITU Recommendation [G.9701]) lines. Each Line models a layer 1 FAST Line interface. |
- |
2.11 |
|
Device.FAST.Line.{i}. |
object(0:) |
R |
FAST Line table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models physical FAST lines. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.11 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.11 |
|
FirmwareVersion |
string(:64) |
R |
A string identifying the version of the modem firmware currently installed for this interface. This is applicable only when the modem firmware is separable from the overall CPEdevice software. |
- |
2.11 |
|
LinkStatus |
string |
R |
Status of the FAST physical link. Enumeration of:
When LinkStatus is Up, Status is expected to be Up. When LinkStatus is Initializing or EstablishingLink or NoSignal or Disabled, Status is expected to be Down. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.11 |
|
DownstreamNoiseMargin |
int |
R |
This parameter reports the signal-to-noise ratio margin (as defined in clause 9.8.3.2/[G.9701] and 11.4.1.3/[G.9701]) in the upstreamdownstream direction. A special value indicates that the signal-to-noise ratio margin is out of the range to be represented. The parameter is expressed in 0.1dB. Note: In G.997.2, this parameter is called SNRMds. See ITU-T Recommendation [G.997.2]. Active Notification requests for this parameter MAY be denied. |
- |
2.11 |
|
UpstreamPower |
int |
R |
The current output power at the CPE'sdevice's FAST line (expressed in 0.1dBmV). Active Notification requests for this parameter MAY be denied. |
- |
2.11 |
|
DownstreamPower |
int |
R |
The current received power at the CPE'sdevice's FAST line (expressed in 0.1dBmV). Active Notification requests for this parameter MAY be denied. |
- |
2.11 |
|
Device.FAST.Line.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.11 |
|
TotalStart |
unsignedInt |
R |
FAST-specific statistic. The Number of seconds since the beginning of the period used for collection of Total statistics. Statistics SHOULD continue to be accumulated across CPEdevice reboots, though this might not always be possible. Note: TotalStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Active Notification requests for this parameter MAY be denied. |
- |
2.11 |
|
LastShowtimeStart |
unsignedInt |
R |
FAST-specific statistic. The Number of seconds since the second most recent DSL Showtime, i.e. the beginning of the period used for collection of LastShowtime statistics. If the CPEdevice has not retained information about the second most recent Showtime (e.g., on reboot), the start of LastShowtime statistics MAY temporarily coincide with the start of Showtime statistics. Note: LastShowtimeStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Active Notification requests for this parameter MAY be denied. |
- |
2.11 |
|
CurrentDayStart |
unsignedInt |
R |
FAST-specific statistic. The Number of seconds since the beginning of the period used for collection of CurrentDay statistics. The CPEdevice MAY align the beginning of each CurrentDay interval with days in the UTC time zone, but is not required to do so. Statistics SHOULD continue to be accumulated across CPEdevice reboots, though this might not always be possible. Note: CurrentDayStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Active Notification requests for this parameter MAY be denied. |
- |
2.11 |
|
QuarterHourStart |
unsignedInt |
R |
FAST-specific statistic. The Number of seconds since the beginning of the period used for collection of QuarterHour statistics. The CPEdevice MAY align the beginning of each QuarterHour interval with real-time quarter-hour intervals, but is not required to do so. Statistics SHOULD continue to be accumulated across CPEdevice reboots, though this might not always be possible. Note: QuarterHourStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. Active Notification requests for this parameter MAY be denied. |
- |
2.11 |
|
Device.Optical. |
object |
R |
This object models a generic optical interface. It defines an Interface object that models a layer 1 optical interface that is capable of transporting Ethernet packets. For historical reasons, the data model definition is based on parts of [G.988]. However, it is not intended to model anything specific to IEEE PON or ITU-T PON technologies. Note that this object is not intended to model the optical transceiver either. |
- |
2.4 |
|
Device.Optical.Interface.{i}. |
object(0:) |
R |
Optical interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models physical optical interfaces. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.4 |
|
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863]. Because the interface includes layer 1, the LowerLayerDown value SHOULD never be used. Independent from the value of Enable, Status SHOULD change to NotAllowed if the interface is not allowed to transmit network traffic, e.g. because of a certain policy. If Status is NotAllowed, the CPEdevice should block the interface from sending network traffic. An example use case for NotAllowed is the following: if SFPReferenceList has one item referring to an SFPs.SFPCage instance whose SFPs.SFPCage.{i}.SFPPresent is true, whose SFPs.SFPCage.{i}.SFPType does not warrant NotPresent as value for Status, but whose SFPs.SFPCage.{i}.IsAllowed is false, then Status should change to NotAllowed. |
- |
2.4 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.4 |
|
Device.Optical.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.4 |
|
Device.Cellular. |
object |
R |
This object models cellular interfaces and access points. |
- |
2.8 |
|
Device.Cellular.Interface.{i}. |
object(0:) |
R |
Cellular interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each instance of this object models a cellular modem with a single radio and can reference multiple TrustedElements.SIM.. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. Changes since 2.21:
|
- |
2.8 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.8 |
|
Device.Cellular.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.8 |
|
Device.Cellular.Interface.{i}.USIM. |
object |
R |
USIM (Universal Subscriber Identity Module or SIM card) parameters for the interface. This object was DEPRECATED in 2.19 because moved to TrustedElements.SIM. This object was OBSOLETED in 2.21. This object was DELETED in 2.22. Changes since 2.21:
|
- |
2.8 |
|
Device.Cellular.Interface.{i}.CarrierAggregation. |
object |
R |
This object models the Carrier Aggregation configuration of the cellular interface. The current configuration is represented in MasterCellGroup and SecondaryCellGroup. Historical configurations are retained in MasterCellGroup.History and SecondaryCellGroup.History instances respectively. When 5G dual connectivity is not active, SecondaryCellGroup.CurrentAccessTechnology reports NotApplicable and the SCG cell counts are 0. |
- |
2.22 |
|
MaxHistoryEntries |
unsignedInt |
W |
Defines the maximum number of History instances that can be stored per CellGroup on the device. History retention is entry-based, not time-based. To determine the time span covered, inspect the MasterCellGroup.History.{i}.StartTime and MasterCellGroup.History.{i}.Duration of the oldest retained entry. When the maximum is reached, the next History entry will replace the instance with the oldest MasterCellGroup.History.{i}.StartTime. Reducing this parameter will cause the implementation to delete the oldest History instances. |
- |
2.22 |
|
Device.Cellular.Interface.{i}.CarrierAggregation.MasterCellGroup. |
object |
R |
The Master Cell Group (MCG) represents the primary radio connection for the cellular interface. The MCG is always present and contains exactly one Primary Cell (PCell) and zero or more Secondary Cells (SCells). In LTE-only and 5G SA configurations the MCG is the sole cell group. In dual connectivity configurations such as EN-DC or NR-DC a Secondary Cell Group is also present. |
- |
2.22 |
|
CurrentAccessTechnology |
string |
R |
The radio access technology currently in use by this Master Cell Group. Allows a controller to determine which radio technology is carrying traffic on this cell group and to correctly interpret the band and channel values in the associated cell objects. Enumeration of:
|
- |
2.22 |
|
SecondaryCellNumberOfEntries |
unsignedInt |
R |
The number of entries in the SecondaryCell table. |
- |
2.22 |
|
HistoryNumberOfEntries |
unsignedInt |
R |
The number of entries in the History table. |
- |
2.22 |
|
Device.Cellular.Interface.{i}.CarrierAggregation.MasterCellGroup.PrimaryCell. |
object |
R |
The Primary Cell (PCell) of the Master Cell Group. The PCell is always present and handles both control signaling and data traffic. |
- |
2.22 |
|
Band |
string |
R |
The frequency band used by the cell as a 3GPP band identifier (e.g. B20, n78). See [Section 5.2/3GPP-TS.38.104] for 5G NR bands and [Section 5.5/3GPP-TS.36.101] for LTE bands. |
- |
2.22 |
|
UplinkBandwidth |
unsignedInt |
R |
The channel bandwidth for uplink on this cell, measured in MHz. For FDD bands this may differ from DownlinkBandwidth. |
- |
2.22 |
|
DownlinkBandwidth |
unsignedInt |
R |
The channel bandwidth for downlink on this cell, measured in MHz. For FDD bands this may differ from UplinkBandwidth. |
- |
2.22 |
|
UplinkChannel |
unsignedInt |
R |
The uplink channel number (ARFCN) for this cell, as defined in [Section 5.4.2.1/3GPP-TS.38.104] for 5G NR and [Section 5.7.3/3GPP-TS.36.101] for LTE. For TDD bands the uplink and downlink share the same channel number. |
- |
2.22 |
|
DownlinkChannel |
unsignedInt |
R |
The downlink channel number (ARFCN) for this cell, as defined in [Section 5.4.2.1/3GPP-TS.38.104] for 5G NR and [Section 5.7.3/3GPP-TS.36.101] for LTE. For TDD bands the uplink and downlink share the same channel number. |
- |
2.22 |
|
PCI |
int |
R |
The Physical Cell Identifier (PCI) of this cell. Set to 2147483647 (the maximum valid value) if the PCI is not known or not discoverable. |
- |
2.22 |
|
UplinkPRBCount |
unsignedInt |
R |
The number of Physical Resource Blocks currently allocated for uplink on this cell, as reported by the modem at the time of read. This is an instantaneous value reflecting the current scheduling grant, not a time-averaged figure. |
- |
2.22 |
|
DownlinkPRBCount |
unsignedInt |
R |
The number of Physical Resource Blocks currently allocated for downlink on this cell, as reported by the modem at the time of read. This is an instantaneous value reflecting the current scheduling grant, not a time-averaged figure. |
- |
2.22 |
|
UplinkMIMOLayers |
unsignedInt |
R |
The actual number of MIMO (Multiple-Input Multiple-Output) spatial layers currently scheduled for uplink on this cell, i.e. the effective Rank Indicator (RI) as negotiated with the network at the time of read. This does not represent the maximum number of layers supported by the device hardware. |
- |
2.22 |
|
DownlinkMIMOLayers |
unsignedInt |
R |
The actual number of MIMO (Multiple-Input Multiple-Output) spatial layers currently scheduled for downlink on this cell, i.e. the effective Rank Indicator (RI) as negotiated with the network at the time of read. This does not represent the maximum number of layers supported by the device hardware. |
- |
2.22 |
|
RSRP |
int |
R |
The Reference Signal Received Power measured in dBm. |
- |
2.22 |
|
SINR |
int |
R |
The Signal-to-Interference-plus-Noise Ratio measured in dB. |
- |
2.22 |
|
RSSI |
int |
R |
The Received Signal Strength Indicator measured in dBm. |
- |
2.22 |
|
RSRQ |
int |
R |
The Reference Signal Received Quality measured in dB. |
- |
2.22 |
|
TxPower |
int |
R |
The transmit power of the device on this cell measured in dBm. |
- |
2.22 |
|
Device.Cellular.Interface.{i}.CarrierAggregation.MasterCellGroup.SecondaryCell.{i}. |
object(0:) |
R |
A Secondary Cell (SCell) of the Master Cell Group. SCells carry additional data traffic on top of the PCell. Zero or more SCells may be active at any time. At most one entry in this table can exist with a given value for Alias. |
- |
2.22 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.22 |
|
DownlinkOnly |
boolean |
R |
When true, this Secondary Cell carries downlink traffic only and has no uplink component. When false, the cell carries both uplink and downlink traffic. |
- |
2.22 |
|
Band |
string |
R |
The frequency band used by the cell as a 3GPP band identifier (e.g. B20, n78). See [Section 5.2/3GPP-TS.38.104] for 5G NR bands and [Section 5.5/3GPP-TS.36.101] for LTE bands. |
- |
2.22 |
|
UplinkBandwidth |
unsignedInt |
R |
The channel bandwidth for uplink on this cell, measured in MHz. For FDD bands this may differ from DownlinkBandwidth. |
- |
2.22 |
|
DownlinkBandwidth |
unsignedInt |
R |
The channel bandwidth for downlink on this cell, measured in MHz. For FDD bands this may differ from UplinkBandwidth. |
- |
2.22 |
|
UplinkChannel |
unsignedInt |
R |
The uplink channel number (ARFCN) for this cell, as defined in [Section 5.4.2.1/3GPP-TS.38.104] for 5G NR and [Section 5.7.3/3GPP-TS.36.101] for LTE. For TDD bands the uplink and downlink share the same channel number. |
- |
2.22 |
|
DownlinkChannel |
unsignedInt |
R |
The downlink channel number (ARFCN) for this cell, as defined in [Section 5.4.2.1/3GPP-TS.38.104] for 5G NR and [Section 5.7.3/3GPP-TS.36.101] for LTE. For TDD bands the uplink and downlink share the same channel number. |
- |
2.22 |
|
PCI |
int |
R |
The Physical Cell Identifier (PCI) of this cell. Set to 2147483647 (the maximum valid value) if the PCI is not known or not discoverable. |
- |
2.22 |
|
UplinkPRBCount |
unsignedInt |
R |
The number of Physical Resource Blocks currently allocated for uplink on this cell, as reported by the modem at the time of read. This is an instantaneous value reflecting the current scheduling grant, not a time-averaged figure. |
- |
2.22 |
|
DownlinkPRBCount |
unsignedInt |
R |
The number of Physical Resource Blocks currently allocated for downlink on this cell, as reported by the modem at the time of read. This is an instantaneous value reflecting the current scheduling grant, not a time-averaged figure. |
- |
2.22 |
|
UplinkMIMOLayers |
unsignedInt |
R |
The actual number of MIMO (Multiple-Input Multiple-Output) spatial layers currently scheduled for uplink on this cell, i.e. the effective Rank Indicator (RI) as negotiated with the network at the time of read. This does not represent the maximum number of layers supported by the device hardware. |
- |
2.22 |
|
DownlinkMIMOLayers |
unsignedInt |
R |
The actual number of MIMO (Multiple-Input Multiple-Output) spatial layers currently scheduled for downlink on this cell, i.e. the effective Rank Indicator (RI) as negotiated with the network at the time of read. This does not represent the maximum number of layers supported by the device hardware. |
- |
2.22 |
|
RSRP |
int |
R |
The Reference Signal Received Power measured in dBm. |
- |
2.22 |
|
SINR |
int |
R |
The Signal-to-Interference-plus-Noise Ratio measured in dB. |
- |
2.22 |
|
RSSI |
int |
R |
The Received Signal Strength Indicator measured in dBm. |
- |
2.22 |
|
RSRQ |
int |
R |
The Reference Signal Received Quality measured in dB. |
- |
2.22 |
|
TxPower |
int |
R |
The transmit power of the device on this cell measured in dBm. |
- |
2.22 |
|
Device.Cellular.Interface.{i}.CarrierAggregation.MasterCellGroup.History.{i}. |
object(0:) |
R |
A historical record of a past MCG Carrier Aggregation configuration. Each instance represents a period during which the MCG configuration remained unchanged, defined by StartTime and Duration. A new History entry is created only when the set of Component Carriers changes in the UE's RRC Connected state, for example when the network issues an RRC Reconfiguration that adds or removes a cell from the configured set. Transient MAC-layer SCell activations and deactivations do not create new History entries. At most one entry in this table can exist with a given value for Alias. |
- |
2.22 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.22 |
|
StartTime |
dateTime |
R |
The time at which this MCG configuration became active. |
- |
2.22 |
|
Duration |
unsignedInt |
R |
The length of time in seconds for which this MCG configuration was active and unchanged. |
- |
2.22 |
|
CurrentAccessTechnology |
string |
R |
The radio access technology that was in use by this Master Cell Group during this historical record. Allows a controller to correctly interpret the band and channel values in the associated historical cell objects. Enumeration of:
|
- |
2.22 |
|
SecondaryCellNumberOfEntries |
unsignedInt |
R |
The number of entries in the SecondaryCell table. |
- |
2.22 |
|
Device.Cellular.Interface.{i}.CarrierAggregation.MasterCellGroup.History.{i}.PrimaryCell. |
object |
R |
The Primary Cell (PCell) configuration snapshot for this MCG history record. |
- |
2.22 |
|
Band |
string |
R |
The frequency band used by the cell as a 3GPP band identifier (e.g. B20, n78). See [Section 5.2/3GPP-TS.38.104] for 5G NR bands and [Section 5.5/3GPP-TS.36.101] for LTE bands. |
- |
2.22 |
|
UplinkBandwidth |
unsignedInt |
R |
The channel bandwidth for uplink on this cell, measured in MHz. For FDD bands this may differ from DownlinkBandwidth. |
- |
2.22 |
|
DownlinkBandwidth |
unsignedInt |
R |
The channel bandwidth for downlink on this cell, measured in MHz. For FDD bands this may differ from UplinkBandwidth. |
- |
2.22 |
|
UplinkChannel |
unsignedInt |
R |
The uplink channel number (ARFCN) for this cell, as defined in [Section 5.4.2.1/3GPP-TS.38.104] for 5G NR and [Section 5.7.3/3GPP-TS.36.101] for LTE. For TDD bands the uplink and downlink share the same channel number. |
- |
2.22 |
|
DownlinkChannel |
unsignedInt |
R |
The downlink channel number (ARFCN) for this cell, as defined in [Section 5.4.2.1/3GPP-TS.38.104] for 5G NR and [Section 5.7.3/3GPP-TS.36.101] for LTE. For TDD bands the uplink and downlink share the same channel number. |
- |
2.22 |
|
PCI |
int |
R |
The Physical Cell Identifier (PCI) of this cell. Set to 2147483647 (the maximum valid value) if the PCI is not known or not discoverable. |
- |
2.22 |
|
UplinkPRBCount |
unsignedInt |
R |
The number of Physical Resource Blocks currently allocated for uplink on this cell, as reported by the modem at the time of read. This is an instantaneous value reflecting the current scheduling grant, not a time-averaged figure. |
- |
2.22 |
|
DownlinkPRBCount |
unsignedInt |
R |
The number of Physical Resource Blocks currently allocated for downlink on this cell, as reported by the modem at the time of read. This is an instantaneous value reflecting the current scheduling grant, not a time-averaged figure. |
- |
2.22 |
|
UplinkMIMOLayers |
unsignedInt |
R |
The actual number of MIMO (Multiple-Input Multiple-Output) spatial layers currently scheduled for uplink on this cell, i.e. the effective Rank Indicator (RI) as negotiated with the network at the time of read. This does not represent the maximum number of layers supported by the device hardware. |
- |
2.22 |
|
DownlinkMIMOLayers |
unsignedInt |
R |
The actual number of MIMO (Multiple-Input Multiple-Output) spatial layers currently scheduled for downlink on this cell, i.e. the effective Rank Indicator (RI) as negotiated with the network at the time of read. This does not represent the maximum number of layers supported by the device hardware. |
- |
2.22 |
|
RSRP |
int |
R |
The Reference Signal Received Power measured in dBm. |
- |
2.22 |
|
SINR |
int |
R |
The Signal-to-Interference-plus-Noise Ratio measured in dB. |
- |
2.22 |
|
RSSI |
int |
R |
The Received Signal Strength Indicator measured in dBm. |
- |
2.22 |
|
RSRQ |
int |
R |
The Reference Signal Received Quality measured in dB. |
- |
2.22 |
|
TxPower |
int |
R |
The transmit power of the device on this cell measured in dBm. |
- |
2.22 |
|
Device.Cellular.Interface.{i}.CarrierAggregation.MasterCellGroup.History.{i}.SecondaryCell.{i}. |
object(0:) |
R |
A Secondary Cell (SCell) configuration snapshot for this MCG history record. At most one entry in this table can exist with a given value for Alias. |
- |
2.22 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.22 |
|
DownlinkOnly |
boolean |
R |
When true, this Secondary Cell carried downlink traffic only during this historical period. |
- |
2.22 |
|
Band |
string |
R |
The frequency band used by the cell as a 3GPP band identifier (e.g. B20, n78). See [Section 5.2/3GPP-TS.38.104] for 5G NR bands and [Section 5.5/3GPP-TS.36.101] for LTE bands. |
- |
2.22 |
|
UplinkBandwidth |
unsignedInt |
R |
The channel bandwidth for uplink on this cell, measured in MHz. For FDD bands this may differ from DownlinkBandwidth. |
- |
2.22 |
|
DownlinkBandwidth |
unsignedInt |
R |
The channel bandwidth for downlink on this cell, measured in MHz. For FDD bands this may differ from UplinkBandwidth. |
- |
2.22 |
|
UplinkChannel |
unsignedInt |
R |
The uplink channel number (ARFCN) for this cell, as defined in [Section 5.4.2.1/3GPP-TS.38.104] for 5G NR and [Section 5.7.3/3GPP-TS.36.101] for LTE. For TDD bands the uplink and downlink share the same channel number. |
- |
2.22 |
|
DownlinkChannel |
unsignedInt |
R |
The downlink channel number (ARFCN) for this cell, as defined in [Section 5.4.2.1/3GPP-TS.38.104] for 5G NR and [Section 5.7.3/3GPP-TS.36.101] for LTE. For TDD bands the uplink and downlink share the same channel number. |
- |
2.22 |
|
PCI |
int |
R |
The Physical Cell Identifier (PCI) of this cell. Set to 2147483647 (the maximum valid value) if the PCI is not known or not discoverable. |
- |
2.22 |
|
UplinkPRBCount |
unsignedInt |
R |
The number of Physical Resource Blocks currently allocated for uplink on this cell, as reported by the modem at the time of read. This is an instantaneous value reflecting the current scheduling grant, not a time-averaged figure. |
- |
2.22 |
|
DownlinkPRBCount |
unsignedInt |
R |
The number of Physical Resource Blocks currently allocated for downlink on this cell, as reported by the modem at the time of read. This is an instantaneous value reflecting the current scheduling grant, not a time-averaged figure. |
- |
2.22 |
|
UplinkMIMOLayers |
unsignedInt |
R |
The actual number of MIMO (Multiple-Input Multiple-Output) spatial layers currently scheduled for uplink on this cell, i.e. the effective Rank Indicator (RI) as negotiated with the network at the time of read. This does not represent the maximum number of layers supported by the device hardware. |
- |
2.22 |
|
DownlinkMIMOLayers |
unsignedInt |
R |
The actual number of MIMO (Multiple-Input Multiple-Output) spatial layers currently scheduled for downlink on this cell, i.e. the effective Rank Indicator (RI) as negotiated with the network at the time of read. This does not represent the maximum number of layers supported by the device hardware. |
- |
2.22 |
|
RSRP |
int |
R |
The Reference Signal Received Power measured in dBm. |
- |
2.22 |
|
SINR |
int |
R |
The Signal-to-Interference-plus-Noise Ratio measured in dB. |
- |
2.22 |
|
RSSI |
int |
R |
The Received Signal Strength Indicator measured in dBm. |
- |
2.22 |
|
RSRQ |
int |
R |
The Reference Signal Received Quality measured in dB. |
- |
2.22 |
|
TxPower |
int |
R |
The transmit power of the device on this cell measured in dBm. |
- |
2.22 |
|
Device.Cellular.Interface.{i}.CarrierAggregation.SecondaryCellGroup. |
object |
R |
The Secondary Cell Group (SCG) represents the secondary radio connection in 5G dual connectivity configurations such as EN-DC (E-UTRA NR Dual Connectivity) or NR-DC (NR Dual Connectivity). When dual connectivity is active, the SCG contains exactly one Primary Secondary Cell (PSCell) and zero or more Secondary Cells. When dual connectivity is not active, CurrentAccessTechnology reports NotApplicable and SecondaryCellNumberOfEntries is 0. |
- |
2.22 |
|
CurrentAccessTechnology |
string |
R |
The radio access technology currently in use by this Secondary Cell Group. Allows a controller to determine which radio technology is carrying traffic on this cell group and to correctly interpret the band and channel values in the associated cell objects. Reports NotApplicable when 5G dual connectivity is not active. Enumeration of:
|
- |
2.22 |
|
SecondaryCellNumberOfEntries |
unsignedInt |
R |
The number of entries in the SecondaryCell table. |
- |
2.22 |
|
HistoryNumberOfEntries |
unsignedInt |
R |
The number of entries in the History table. |
- |
2.22 |
|
Device.Cellular.Interface.{i}.CarrierAggregation.SecondaryCellGroup.PrimaryCell. |
object |
R |
The Primary Secondary Cell (PSCell) of the Secondary Cell Group. The PSCell handles data traffic for the SCG. |
- |
2.22 |
|
Band |
string |
R |
The frequency band used by the cell as a 3GPP band identifier (e.g. B20, n78). See [Section 5.2/3GPP-TS.38.104] for 5G NR bands and [Section 5.5/3GPP-TS.36.101] for LTE bands. |
- |
2.22 |
|
UplinkBandwidth |
unsignedInt |
R |
The channel bandwidth for uplink on this cell, measured in MHz. For FDD bands this may differ from DownlinkBandwidth. |
- |
2.22 |
|
DownlinkBandwidth |
unsignedInt |
R |
The channel bandwidth for downlink on this cell, measured in MHz. For FDD bands this may differ from UplinkBandwidth. |
- |
2.22 |
|
UplinkChannel |
unsignedInt |
R |
The uplink channel number (ARFCN) for this cell, as defined in [Section 5.4.2.1/3GPP-TS.38.104] for 5G NR and [Section 5.7.3/3GPP-TS.36.101] for LTE. For TDD bands the uplink and downlink share the same channel number. |
- |
2.22 |
|
DownlinkChannel |
unsignedInt |
R |
The downlink channel number (ARFCN) for this cell, as defined in [Section 5.4.2.1/3GPP-TS.38.104] for 5G NR and [Section 5.7.3/3GPP-TS.36.101] for LTE. For TDD bands the uplink and downlink share the same channel number. |
- |
2.22 |
|
PCI |
int |
R |
The Physical Cell Identifier (PCI) of this cell. Set to 2147483647 (the maximum valid value) if the PCI is not known or not discoverable. |
- |
2.22 |
|
UplinkPRBCount |
unsignedInt |
R |
The number of Physical Resource Blocks currently allocated for uplink on this cell, as reported by the modem at the time of read. This is an instantaneous value reflecting the current scheduling grant, not a time-averaged figure. |
- |
2.22 |
|
DownlinkPRBCount |
unsignedInt |
R |
The number of Physical Resource Blocks currently allocated for downlink on this cell, as reported by the modem at the time of read. This is an instantaneous value reflecting the current scheduling grant, not a time-averaged figure. |
- |
2.22 |
|
UplinkMIMOLayers |
unsignedInt |
R |
The actual number of MIMO (Multiple-Input Multiple-Output) spatial layers currently scheduled for uplink on this cell, i.e. the effective Rank Indicator (RI) as negotiated with the network at the time of read. This does not represent the maximum number of layers supported by the device hardware. |
- |
2.22 |
|
DownlinkMIMOLayers |
unsignedInt |
R |
The actual number of MIMO (Multiple-Input Multiple-Output) spatial layers currently scheduled for downlink on this cell, i.e. the effective Rank Indicator (RI) as negotiated with the network at the time of read. This does not represent the maximum number of layers supported by the device hardware. |
- |
2.22 |
|
RSRP |
int |
R |
The Reference Signal Received Power measured in dBm. |
- |
2.22 |
|
SINR |
int |
R |
The Signal-to-Interference-plus-Noise Ratio measured in dB. |
- |
2.22 |
|
RSSI |
int |
R |
The Received Signal Strength Indicator measured in dBm. |
- |
2.22 |
|
RSRQ |
int |
R |
The Reference Signal Received Quality measured in dB. |
- |
2.22 |
|
TxPower |
int |
R |
The transmit power of the device on this cell measured in dBm. |
- |
2.22 |
|
Device.Cellular.Interface.{i}.CarrierAggregation.SecondaryCellGroup.SecondaryCell.{i}. |
object(0:) |
R |
A Secondary Cell (SCell) of the Secondary Cell Group. Zero or more SCells may be active at any time. At most one entry in this table can exist with a given value for Alias. |
- |
2.22 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.22 |
|
DownlinkOnly |
boolean |
R |
When true, this Secondary Cell carries downlink traffic only and has no uplink component. When false, the cell carries both uplink and downlink traffic. |
- |
2.22 |
|
Band |
string |
R |
The frequency band used by the cell as a 3GPP band identifier (e.g. B20, n78). See [Section 5.2/3GPP-TS.38.104] for 5G NR bands and [Section 5.5/3GPP-TS.36.101] for LTE bands. |
- |
2.22 |
|
UplinkBandwidth |
unsignedInt |
R |
The channel bandwidth for uplink on this cell, measured in MHz. For FDD bands this may differ from DownlinkBandwidth. |
- |
2.22 |
|
DownlinkBandwidth |
unsignedInt |
R |
The channel bandwidth for downlink on this cell, measured in MHz. For FDD bands this may differ from UplinkBandwidth. |
- |
2.22 |
|
UplinkChannel |
unsignedInt |
R |
The uplink channel number (ARFCN) for this cell, as defined in [Section 5.4.2.1/3GPP-TS.38.104] for 5G NR and [Section 5.7.3/3GPP-TS.36.101] for LTE. For TDD bands the uplink and downlink share the same channel number. |
- |
2.22 |
|
DownlinkChannel |
unsignedInt |
R |
The downlink channel number (ARFCN) for this cell, as defined in [Section 5.4.2.1/3GPP-TS.38.104] for 5G NR and [Section 5.7.3/3GPP-TS.36.101] for LTE. For TDD bands the uplink and downlink share the same channel number. |
- |
2.22 |
|
PCI |
int |
R |
The Physical Cell Identifier (PCI) of this cell. Set to 2147483647 (the maximum valid value) if the PCI is not known or not discoverable. |
- |
2.22 |
|
UplinkPRBCount |
unsignedInt |
R |
The number of Physical Resource Blocks currently allocated for uplink on this cell, as reported by the modem at the time of read. This is an instantaneous value reflecting the current scheduling grant, not a time-averaged figure. |
- |
2.22 |
|
DownlinkPRBCount |
unsignedInt |
R |
The number of Physical Resource Blocks currently allocated for downlink on this cell, as reported by the modem at the time of read. This is an instantaneous value reflecting the current scheduling grant, not a time-averaged figure. |
- |
2.22 |
|
UplinkMIMOLayers |
unsignedInt |
R |
The actual number of MIMO (Multiple-Input Multiple-Output) spatial layers currently scheduled for uplink on this cell, i.e. the effective Rank Indicator (RI) as negotiated with the network at the time of read. This does not represent the maximum number of layers supported by the device hardware. |
- |
2.22 |
|
DownlinkMIMOLayers |
unsignedInt |
R |
The actual number of MIMO (Multiple-Input Multiple-Output) spatial layers currently scheduled for downlink on this cell, i.e. the effective Rank Indicator (RI) as negotiated with the network at the time of read. This does not represent the maximum number of layers supported by the device hardware. |
- |
2.22 |
|
RSRP |
int |
R |
The Reference Signal Received Power measured in dBm. |
- |
2.22 |
|
SINR |
int |
R |
The Signal-to-Interference-plus-Noise Ratio measured in dB. |
- |
2.22 |
|
RSSI |
int |
R |
The Received Signal Strength Indicator measured in dBm. |
- |
2.22 |
|
RSRQ |
int |
R |
The Reference Signal Received Quality measured in dB. |
- |
2.22 |
|
TxPower |
int |
R |
The transmit power of the device on this cell measured in dBm. |
- |
2.22 |
|
Device.Cellular.Interface.{i}.CarrierAggregation.SecondaryCellGroup.History.{i}. |
object(0:) |
R |
A historical record of a past SCG Carrier Aggregation configuration. Each instance represents a period during which the SCG configuration remained unchanged, defined by StartTime and Duration. A new History entry is created only when the set of Component Carriers changes in the UE's RRC Connected state, for example when the network issues an RRC Reconfiguration that adds or removes a cell from the configured set. Transient MAC-layer SCell activations and deactivations do not create new History entries. At most one entry in this table can exist with a given value for Alias. |
- |
2.22 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.22 |
|
StartTime |
dateTime |
R |
The time at which this SCG configuration became active. |
- |
2.22 |
|
Duration |
unsignedInt |
R |
The length of time in seconds for which this SCG configuration was active and unchanged. |
- |
2.22 |
|
CurrentAccessTechnology |
string |
R |
The radio access technology that was in use by this Secondary Cell Group during this historical record. Allows a controller to correctly interpret the band and channel values in the associated historical cell objects. Enumeration of:
|
- |
2.22 |
|
SecondaryCellNumberOfEntries |
unsignedInt |
R |
The number of entries in the SecondaryCell table. |
- |
2.22 |
|
Device.Cellular.Interface.{i}.CarrierAggregation.SecondaryCellGroup.History.{i}.PrimaryCell. |
object |
R |
The Primary Secondary Cell (PSCell) configuration snapshot for this SCG history record. |
- |
2.22 |
|
Band |
string |
R |
The frequency band used by the cell as a 3GPP band identifier (e.g. B20, n78). See [Section 5.2/3GPP-TS.38.104] for 5G NR bands and [Section 5.5/3GPP-TS.36.101] for LTE bands. |
- |
2.22 |
|
UplinkBandwidth |
unsignedInt |
R |
The channel bandwidth for uplink on this cell, measured in MHz. For FDD bands this may differ from DownlinkBandwidth. |
- |
2.22 |
|
DownlinkBandwidth |
unsignedInt |
R |
The channel bandwidth for downlink on this cell, measured in MHz. For FDD bands this may differ from UplinkBandwidth. |
- |
2.22 |
|
UplinkChannel |
unsignedInt |
R |
The uplink channel number (ARFCN) for this cell, as defined in [Section 5.4.2.1/3GPP-TS.38.104] for 5G NR and [Section 5.7.3/3GPP-TS.36.101] for LTE. For TDD bands the uplink and downlink share the same channel number. |
- |
2.22 |
|
DownlinkChannel |
unsignedInt |
R |
The downlink channel number (ARFCN) for this cell, as defined in [Section 5.4.2.1/3GPP-TS.38.104] for 5G NR and [Section 5.7.3/3GPP-TS.36.101] for LTE. For TDD bands the uplink and downlink share the same channel number. |
- |
2.22 |
|
PCI |
int |
R |
The Physical Cell Identifier (PCI) of this cell. Set to 2147483647 (the maximum valid value) if the PCI is not known or not discoverable. |
- |
2.22 |
|
UplinkPRBCount |
unsignedInt |
R |
The number of Physical Resource Blocks currently allocated for uplink on this cell, as reported by the modem at the time of read. This is an instantaneous value reflecting the current scheduling grant, not a time-averaged figure. |
- |
2.22 |
|
DownlinkPRBCount |
unsignedInt |
R |
The number of Physical Resource Blocks currently allocated for downlink on this cell, as reported by the modem at the time of read. This is an instantaneous value reflecting the current scheduling grant, not a time-averaged figure. |
- |
2.22 |
|
UplinkMIMOLayers |
unsignedInt |
R |
The actual number of MIMO (Multiple-Input Multiple-Output) spatial layers currently scheduled for uplink on this cell, i.e. the effective Rank Indicator (RI) as negotiated with the network at the time of read. This does not represent the maximum number of layers supported by the device hardware. |
- |
2.22 |
|
DownlinkMIMOLayers |
unsignedInt |
R |
The actual number of MIMO (Multiple-Input Multiple-Output) spatial layers currently scheduled for downlink on this cell, i.e. the effective Rank Indicator (RI) as negotiated with the network at the time of read. This does not represent the maximum number of layers supported by the device hardware. |
- |
2.22 |
|
RSRP |
int |
R |
The Reference Signal Received Power measured in dBm. |
- |
2.22 |
|
SINR |
int |
R |
The Signal-to-Interference-plus-Noise Ratio measured in dB. |
- |
2.22 |
|
RSSI |
int |
R |
The Received Signal Strength Indicator measured in dBm. |
- |
2.22 |
|
RSRQ |
int |
R |
The Reference Signal Received Quality measured in dB. |
- |
2.22 |
|
TxPower |
int |
R |
The transmit power of the device on this cell measured in dBm. |
- |
2.22 |
|
Device.Cellular.Interface.{i}.CarrierAggregation.SecondaryCellGroup.History.{i}.SecondaryCell.{i}. |
object(0:) |
R |
A Secondary Cell (SCell) configuration snapshot for this SCG history record. At most one entry in this table can exist with a given value for Alias. |
- |
2.22 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.22 |
|
DownlinkOnly |
boolean |
R |
When true, this Secondary Cell carried downlink traffic only during this historical period. |
- |
2.22 |
|
Band |
string |
R |
The frequency band used by the cell as a 3GPP band identifier (e.g. B20, n78). See [Section 5.2/3GPP-TS.38.104] for 5G NR bands and [Section 5.5/3GPP-TS.36.101] for LTE bands. |
- |
2.22 |
|
UplinkBandwidth |
unsignedInt |
R |
The channel bandwidth for uplink on this cell, measured in MHz. For FDD bands this may differ from DownlinkBandwidth. |
- |
2.22 |
|
DownlinkBandwidth |
unsignedInt |
R |
The channel bandwidth for downlink on this cell, measured in MHz. For FDD bands this may differ from UplinkBandwidth. |
- |
2.22 |
|
UplinkChannel |
unsignedInt |
R |
The uplink channel number (ARFCN) for this cell, as defined in [Section 5.4.2.1/3GPP-TS.38.104] for 5G NR and [Section 5.7.3/3GPP-TS.36.101] for LTE. For TDD bands the uplink and downlink share the same channel number. |
- |
2.22 |
|
DownlinkChannel |
unsignedInt |
R |
The downlink channel number (ARFCN) for this cell, as defined in [Section 5.4.2.1/3GPP-TS.38.104] for 5G NR and [Section 5.7.3/3GPP-TS.36.101] for LTE. For TDD bands the uplink and downlink share the same channel number. |
- |
2.22 |
|
PCI |
int |
R |
The Physical Cell Identifier (PCI) of this cell. Set to 2147483647 (the maximum valid value) if the PCI is not known or not discoverable. |
- |
2.22 |
|
UplinkPRBCount |
unsignedInt |
R |
The number of Physical Resource Blocks currently allocated for uplink on this cell, as reported by the modem at the time of read. This is an instantaneous value reflecting the current scheduling grant, not a time-averaged figure. |
- |
2.22 |
|
DownlinkPRBCount |
unsignedInt |
R |
The number of Physical Resource Blocks currently allocated for downlink on this cell, as reported by the modem at the time of read. This is an instantaneous value reflecting the current scheduling grant, not a time-averaged figure. |
- |
2.22 |
|
UplinkMIMOLayers |
unsignedInt |
R |
The actual number of MIMO (Multiple-Input Multiple-Output) spatial layers currently scheduled for uplink on this cell, i.e. the effective Rank Indicator (RI) as negotiated with the network at the time of read. This does not represent the maximum number of layers supported by the device hardware. |
- |
2.22 |
|
DownlinkMIMOLayers |
unsignedInt |
R |
The actual number of MIMO (Multiple-Input Multiple-Output) spatial layers currently scheduled for downlink on this cell, i.e. the effective Rank Indicator (RI) as negotiated with the network at the time of read. This does not represent the maximum number of layers supported by the device hardware. |
- |
2.22 |
|
RSRP |
int |
R |
The Reference Signal Received Power measured in dBm. |
- |
2.22 |
|
SINR |
int |
R |
The Signal-to-Interference-plus-Noise Ratio measured in dB. |
- |
2.22 |
|
RSSI |
int |
R |
The Received Signal Strength Indicator measured in dBm. |
- |
2.22 |
|
RSRQ |
int |
R |
The Reference Signal Received Quality measured in dB. |
- |
2.22 |
|
TxPower |
int |
R |
The transmit power of the device on this cell measured in dBm. |
- |
2.22 |
|
Device.Cellular.AccessPoint.{i}. |
object(0:) |
W |
Cellular Access Point table. Each entry is identified by an APN (Access Point Name) that identifies a gateway between the mobile network and another computer network. Note: Device 2.19 grouped the APN and Interface keys into one combined key. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both APN and Interface. |
- |
2.8 |
|
Username |
string(:256) |
W |
Username used to authenticate the CPEdevice when making a connection to the Access Point. |
- |
2.8 |
|
Password |
string(:256) |
W |
Password used to authenticate the CPEdevice when making a connection to the Access Point. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.8 |
|
Device.ATM. |
object |
R |
Asynchronous Transfer Mode (ATM) object that contains the Link interface and Diagnostics.F5Loopback diagnostics. |
- |
2.0 |
|
Device.ATM.Link.{i}. |
object(0:) |
W |
ATM link-layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Models an ATM PVC virtual circuit and the ATM Adaption Layer (AAL). An ATM Link entry is typically stacked on top of either a DSL.Channel or a DSL.BondingGroup object. When an ATM Link interface is used, a lower-layer DSL.Channel interface MUST be configured with ATM encapsulation (see DSL.Channel.{i}.LinkEncapsulationUsed). At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.0 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.0 |
|
AutoConfig |
boolean |
R |
Indicates if the CPEdevice is currently using some auto configuration mechanisms for this connection. If this variable is true, all writable variables in this connection instance become read-only. Any attempt to change one of these variables SHOULD fail and an error SHOULD be returned. |
- |
2.0 |
|
Device.ATM.Link.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.0 |
|
Device.DOCSIS. |
object |
R |
DOCSIS object. This object models the DOCSIS 3.x cable interface objects. |
- |
2.15 |
|
Device.DOCSIS.Downstream.{i}. |
object(0:) |
R |
DOCSIS Downstream interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the PHY DOCSIS Downstream interface. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.15 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.15 |
|
Device.DOCSIS.Downstream.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.15 |
|
Device.DOCSIS.Upstream.{i}. |
object(0:) |
R |
DOCSIS Upstream interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the PHY DOCSIS Upstream interface. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.15 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.15 |
|
Device.DOCSIS.Upstream.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.15 |
|
Device.DOCSIS.Interface.{i}. |
object(0:) |
R |
DOCSIS Layer 2 (MAC) interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the MAC level DOCSIS interface. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.15 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.15 |
|
FirmwareVersion |
string(:64) |
R |
A string identifying the version of the modem firmware currently installed for this interface. This is applicable only when the modem firmware is separable from the overall CPEdevice software. |
- |
2.15 |
|
Device.DOCSIS.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.15 |
|
Device.PTM. |
object |
R |
Packet Transfer Mode ([Annex H/G.993.1]). This object contains the Link interface. |
- |
2.0 |
|
Device.PTM.Link.{i}. |
object(0:) |
W |
PTM link-layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Models a layer 2 variable-sized packet interface. A PTM Link entry is typically stacked on top of either a FAST.Line, DSL.Channel, or a DSL.BondingGroup object. When a PTM Link interface is used, a lower-layer DSL.Channel interface MUST be configured with PTM encapsulation (see DSL.Channel.{i}.LinkEncapsulationUsed). At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.0 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.0 |
|
Device.PTM.Link.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.0 |
|
Device.Ethernet. |
object |
R |
Ethernet object, which is any interface implementing the [802.3-2015] family of specifications. This object models several Ethernet interface objects, each representing a different stack layer, including: Interface, Link, and VLANTermination. Interface is media-specific and models a port, the PHY layer, and the Channel Access Method (CAM) part of the MAC layer. Link is media-independent and models the Logical Link Control (LLC) layer. An "outer" VLANTermination, when present, is expected to be stacked on top of Link objects to receive and send frames with a configured VLANID. |
- |
2.0 |
|
Device.Ethernet.Interface.{i}. |
object(0:) |
R |
Ethernet interface table (a stackable interface object as described in [Section 4.2/TR-181i2]) for any interface implementing the IEEE 802.3 family of specifications. This table models physical Ethernet ports, but in terms of the interface stack it only models the PHY and Connection Access Method of the Ethernet interface MAC. A Link is also required to model a full Ethernet device. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.0 |
|
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863]. Because the interface includes layer 1, the LowerLayerDown value SHOULD never be used. Independent from the value of Enable, Status SHOULD change to NotAllowed if the interface is not allowed to transmit network traffic, e.g. because of a certain policy. If Status is NotAllowed, the CPEdevice should block the interface from sending network traffic. An example use case for NotAllowed is the following: if SFPReferenceList has one item referring to an SFPs.SFPCage instance whose SFPs.SFPCage.{i}.SFPPresent is true, whose SFPs.SFPCage.{i}.SFPType does not warrant NotPresent as value for Status, but whose SFPs.SFPCage.{i}.IsAllowed is false, then Status should change to NotAllowed. |
- |
2.0 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.0 |
|
Device.Ethernet.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.0 |
|
Device.Ethernet.Link.{i}. |
object(0:) |
W |
Ethernet link layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Table entries model the Logical Link Control (LLC) layer. It is expected that an Ethernet Link interface can be stacked above any lower-layer interface object capable of carrying Ethernet frames. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for MACAddress. |
- |
2.0 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.0 |
|
Device.Ethernet.Link.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.0 |
|
Device.Ethernet.VLANTermination.{i}. |
object(0:) |
W |
VLAN Termination table (a stackable interface object as described in [Section 4.2/TR-181i2]). A VLAN Termination entry is typically stacked on top of a Link object to receive and send frames with the configured VLANID. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.0 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.0 |
|
Device.Ethernet.VLANTermination.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.0 |
|
Device.Ethernet.LAG.{i}. |
object(0:) |
W |
Ethernet Link Aggregation Group (LAG) table (a stackable interface object as described in [Section 4.2/TR-181i2]). Table entries model the Link Aggregation Sub-Layer as defined in [802.3-2015] and [802.1AX-2014]. It is expected that a LAG interface can only be stacked above Interface interfaces. The CPEdevice can reject creation of additional LAG instances if this would exceed its capabilities. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for MACAddress. |
- |
2.12 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.12 |
|
LowerLayers |
string[](:1024) |
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, or an empty string. See [Section 4.2.1/TR-181i2]. LowerLayers must reference to Device.Ethernet.Interface instances where Link Aggregation Group is configured by the CPE.device. For example, "Device.Ethernet.Interface.1, Device.Ethernet.Interface.2" |
<Empty> |
2.12 |
|
Device.Ethernet.LAG.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice 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 |
|
Device.Ethernet.RMONStats.{i}. |
object(0:) |
W |
Ethernet statistics based on the [RFC2819] RMON-MIB etherStatsTable, with some extensions inspired by [Section 9.3.32/G.988]. Each instance is associated with an interface capable of transporting Ethernet-encapsulated packets, and contains a set of unidirectional Ethernet statistics. The statistics are sampled either on ingress or on egress. This is determined as follows:
When sampling on egress, the term received means received by the queuing sub-system. Multiple instances can be associated with a single interface: individual instances can be configured to collect data associated with the entire interface, or with a particular VLAN and/or queue. The CPEdevice MUST reset each instances's Stats parameters whenever the instance is disabled and re-enabled. Whether this reset occurs when the instance becomes operationally disabled (Status = Disabled) or administratively enabled (Enable = true) is a local matter to the CPE.device. This is similar to the behavior of interface statistics, e.g. as specified for Interface.{i}.Stats. Furthermore, this instance's Stats parameters MUST be reset whenever the referenced interface's Stats parameters are reset, or when the referenced queue or VLAN is disabled and re-enabled. For enabled table entries, if Interface references an interface that is not capable of transporting Ethernet-encapsulated packets, or if Queue references a queue that is not instantiated on Interface, or if Queue is not a valid reference and AllQueues is false, the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. Note: The RMONStats table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPEdevice will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated RMONStats row to then violate the table's unique key constraint; if this occurs, the CPEdevice MUST set Status to Error_Misconfigured and disable the offending RMONStats row. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of Interface, VLANID and Queue. |
- |
2.4 |
|
Status |
string |
R |
The status of this instance. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.4 |
|
Name |
string(:64) |
R |
The textual name of the RMONStats entry as assigned by the CPE.}}device. |
- |
2.4 |
|
Device.USB. |
object |
R |
Universal Serial Bus ([USB1.0], [USB2.0], [USB3.0]). This object contains the Interface, Port, and USBHosts objects. |
- |
2.0 |
|
Device.USB.Interface.{i}. |
object(0:) |
R |
USB interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models master and slave USB physical interfaces that support carrying Ethernet frames, e.g. via the USB Communication Device Class. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.0 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.0 |
|
Device.USB.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.0 |
|
Device.USB.USBHosts. |
object |
R |
This object models the CPE'sdevice's USB Host controllers. See [Appendix XVII/TR-181i2] for Theory of Operation. |
- |
2.0 |
|
Device.USB.USBHosts.Host.{i}. |
object(0:) |
R |
Table of CPEdevice USB Host controllers. At most one entry in this table can exist with a given value for Name, or with a given value for Alias. |
- |
2.0 |
|
Device.HPNA. |
object |
R |
HPNA object that contains the Interface and Diagnostics objects. The HPNA (also known as HomePNA) industry standard [G.9954] defines peer to peer communication for home networking over existing coax cables and telephone wiring within the home. |
- |
2.0 |
|
Device.HPNA.Interface.{i}. |
object(0:) |
R |
HPNA interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of an HPNA interface [G.9954]. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.0 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.0 |
|
Device.HPNA.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.0 |
|
Device.HPNA.Interface.{i}.QoS. |
object |
R |
QoS configuration object. |
- |
2.0 |
|
Device.HPNA.Interface.{i}.QoS.FlowSpec.{i}. |
object(0:) |
W |
Flow specification table. The QoS.Classification table is used to classify ingress traffic, where QoS.Classification.{i}.TrafficClass is one of the classification result outputs. This TrafficClass value can be used to look up the appropriate FlowSpec entry (i.e. the FlowSpec entry whose TrafficClasses list contains a matching traffic class). For enabled table entries, if TrafficClasses is an empty string then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.0 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.0 |
|
Device.HPNA.Interface.{i}.AssociatedDevice.{i}. |
object(0:) |
R |
This table provides information about other HPNA devices that are directly accessible via this HPNA interface. At most one entry in this table can exist with a given value for MACAddress. |
- |
2.0 |
|
Active |
boolean |
R |
Whether or not this node is currently present in the HPNA network. The ability to list inactive nodes is OPTIONAL. If the CPEdevice includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE.}}device. |
- |
2.0 |
|
Device.HPNA.Diagnostics. |
object |
R |
The HPNA Diagnostics object. |
- |
2.0 |
|
Device.HPNA.Diagnostics.PerformanceMonitoring. |
object |
R |
HPNA performance monitoring configuration and results. Performance monitoring results are sampled from all nodes in the HPNA network. All packet related counters are sampled synchronized at all nodes in the HPNA network in order to derive packet loss calculations in the HPNA network. |
- |
2.0 |
|
SampleInterval |
unsignedInt |
W |
Time in seconds between automatic collection of performance monitoring data. A value of zero disables automatic collection of data. The CPEdevice MAY impose a minimum sample interval, in which case an attempt to set a (non-zero) interval that is less than this minimum MUST set the interval to the minimum and MUST NOT be regarded as an error. If SampleInterval is a simple fraction of a day, e.g. 900 (a quarter of an hour) or 3600 (an hour), the CPEdevice MAY choose to align sample intervals with time of day, but is not required to do so. |
- |
2.0 |
|
Device.MoCA. |
object |
R |
MoCA object that contains the Interface table [MoCAv1.0] [MoCAv1.1]. |
- |
2.0 |
|
Device.MoCA.Interface.{i}. |
object(0:) |
R |
MoCA interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of a MoCA interface [MoCAv1.0] [MoCAv1.1]. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.0 |
|
Name |
string(:64) |
R |
[mocaIfName/1.3.6.1.4.1.31621.1.2.1.7.1.8] The textual name of the interface as assigned by the CPE.}}device. |
- |
2.0 |
|
MpsPairFailTrap |
unsignedInt |
R |
[moca25TrapMpsPairFail/1.3.6.1.4.1.31621.1.3.0.4] This trap is sent when MpsTrapEn is true, and indicates a MPS pairing failure. This parameter is a counter that is incremented whenever the event occurs. |
- |
2.17 |
|
MpsPrivacyChangedTrap |
unsignedInt |
R |
[moca25TrapMpsPrivacyChanged/1.3.6.1.4.1.31621.1.3.0.5] This trap is sent when MpsTrapEn is true, and indicates that the Node's privacy settings (PRIVACYEN and/or PSWD) have been changed by MPS. This parameter is a counter that is incremented whenever the event occurs. |
- |
2.17 |
|
Device.MoCA.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.0 |
|
Device.MoCA.Interface.{i}.AssociatedDevice.{i}. |
object(0:) |
R |
[mocaNodeTable/1.3.6.1.4.1.31621.1.2.1.11 mocaLinkStatsTable/1.3.6.1.4.1.31621.1.2.1.10] This table contains information about other MoCA devices currently associated with this MoCA interface. Entries in this table cannot be created or deleted by the network management system. All entries are created or deleted by the device software. At most one entry in this table can exist with a given value for MACAddress. |
- |
2.0 |
|
Active |
boolean |
R |
Whether or not this remote device is currently present in the MoCA network. The ability to list inactive nodes is OPTIONAL. If the CPEdevice includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE.}}device. |
- |
2.0 |
|
Device.Ghn. |
object |
R |
G.hn object that contains an Interface table for G.hn supported CPE.device. The ITU-T G.hn specifications [G.9960] and [G.9961] define Physical and MAC Layers for communication between two or more G.hn nodes in the home network over multiple wired media such as power line, phone line and coaxial cable. |
- |
2.4 |
|
Device.Ghn.Interface.{i}. |
object(0:) |
R |
G.hn interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY [G.9960] and MAC [G.9961] layers of a G.hn interface. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.4 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.4 |
|
Device.Ghn.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface at the different G.hn reference points described in [Clause 8.1/G.9961]. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.4 |
|
Device.Ghn.Interface.{i}.AssociatedDevice.{i}. |
object(0:) |
R |
This table contains information about other G.hn devices connected to this G.hn interface. At most one entry in this table can exist with a given value for MACAddress. |
- |
2.4 |
|
Active |
boolean |
R |
Whether or not this device is currently present in the G.hn domain. The ability to list inactive nodes is OPTIONAL. If the CPEdevice includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE.device. If Active is true, it indicates that the Status of the remote device is 0, 1, or 2 (see [Table 7-3/G.9961]). |
- |
2.4 |
|
Device.HomePlug. |
object |
R |
HomePlug object that contains the Interface table. The HomePlug industry standard [HPAV1.1] defines peer to peer communication over powerline medium. |
- |
2.0 |
|
Device.HomePlug.Interface.{i}. |
object(0:) |
R |
HomePlug interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of a HomePlug interface [HPAV1.1]. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.0 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.0 |
|
Device.HomePlug.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.0 |
|
Device.HomePlug.Interface.{i}.AssociatedDevice.{i}. |
object(0:) |
R |
This table contains information about other HomePlug devices connected to this HomePlug interface. At most one entry in this table can exist with a given value for MACAddress. |
- |
2.0 |
|
Active |
boolean |
R |
Whether or not this device is currently present in the HomePlug network. The ability to list inactive nodes is OPTIONAL. If the CPEdevice includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE.}}device. |
- |
2.0 |
|
Device.UPA. |
object |
R |
Universal Powerline Association [UPA-PLC]. This object contains the Interface and Diagnostics objects. |
- |
2.0 |
|
Device.UPA.Interface.{i}. |
object(0:) |
R |
UPA interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of a UPA interface [UPA-PLC]. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.0 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.0 |
|
Device.UPA.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.0 |
|
Device.UPA.Interface.{i}.AssociatedDevice.{i}. |
object(0:) |
R |
This table contains information about PLC connections running between this UPA interface and other UPA devices. At most one entry in this table can exist with a given value for MACAddress. |
- |
2.0 |
|
Active |
boolean |
R |
Whether or not this node is currently present in the UPA network. The ability to list inactive nodes is OPTIONAL. If the CPEdevice includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE.}}device. |
- |
2.0 |
|
Device.WiFi. |
object |
R |
The WiFi object is based on the IEEE 802.11 specifications ([802.11-2024]). It defines interface objects (Radio and SSID), and application objects (AccessPoint and EndPoint). Changes since 2.21:
|
- |
2.0 |
|
MaxNumMLDs |
unsignedInt |
R |
The maximum number of MLDs that the EasyMesh Agent can support. [EasyMesh] source: Wi-Fi 7 Agent Capabilities TLV. |
- |
2.22 |
|
APMLDMaxLinks |
unsignedInt(0:15) |
R |
The maximum number of affiliated APs supported by any AP MLD on this EasyMesh Agent. Set to a value between 0 and 14, which is the number of affiliated APs minus 1. The value of 15 is reserved. [EasyMesh] source: Wi-Fi 7 Agent Capabilities TLV. |
- |
2.22 |
|
bSTAMLDMaxLinks |
unsignedInt(0:15) |
R |
The maximum number of affiliated bSTAs supported by the bSTA MLD on this EasyMesh Agent. Set to a value between 0 and 14, which is the number of affiliated bSTAs minus 1. The value of 15 is reserved. [EasyMesh] source: Wi-Fi 7 Agent Capabilities TLV. |
- |
2.22 |
|
APMLDNumberOfEntries |
unsignedInt |
R |
The number of entries in the APMLD table. |
- |
2.22 |
|
bSTAMLDNumberOfEntries |
unsignedInt |
R |
The number of entries in the bSTAMLD table. |
- |
2.22 |
|
Device.WiFi.MultiAP. |
object |
R |
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 network from the perspective of the Multi-AP Controller. The Wi-Fi Alliance EasyMesh solution is one example of managing a Multi-AP network. This object and all sub-objects have been moved to new objects. This object was DEPRECATED in 2.15 because it has moved to WiFi.DataElements.Network MultiAP objects. This object was OBSOLETED in 2.17. This object was DELETED in 2.18. |
- |
2.13 |
|
Device.WiFi.DataElements. |
object |
R |
This object represents the Wi-Fi Alliance Data Elements as defined in [DataElements] with extended capabilities in additional objects whose names begin with MultiAP. |
- |
2.13 |
|
Device.WiFi.DataElements.Network. |
object |
R |
This object describes a Wi-Fi network containing 1 or more Access Point (AP) devices. |
- |
2.13 |
|
Device.WiFi.DataElements.Network.ProvisionedDPP.{i}. |
object(0:) |
W |
This table contains provisioned Device Provisioning Protocol (DPP) BoostrapBootstrap URIs [Section 5.2.1/EasyConnect] which contain bootstrapping keys available to the Multi-AP controller for trusted third party onboarding of new Multi-AP agents. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.19 |
|
DPPURI |
string(:2048) |
W |
[URI] The boostrappingbootstrapping DPP URI information which contains the enrollee public key to use for DPP onboarding a Multi-AP agent as specified by [Section 5.2.1/EasyConnect]. |
- |
2.19 |
|
Device.WiFi.DataElements.Network.Device.{i}. |
object(0:) |
R |
Each instance of this object represents an individual EasyMesh Agent or single-AP device in the Wi-Fi network. At most one entry in this table can exist with a given value for ID. Changes since 2.21:
|
- |
2.13 |
|
MaxReportingRate |
unsignedInt |
R |
Maximum rate for reporting unsuccessful association attempts in attempts per minute. This parameter was DEPRECATED in 2.19 because it was the same as MaxUnsuccessfulAssociationReportingRate. This parameter was OBSOLETED in 2.21. This parameter was DELETED in 2.22. Changes since 2.21:
|
- |
2.15 |
|
BackhaulDownMACAddress |
string(:17)[] |
R |
[MACAddress] Comma-separated list of MAC Addresses. Each MAC address is that of a downstream EasyMesh agent's backhaul link. This parameter was DEPRECATED in 2.19 because it was replaced by BackhaulDown.{i}.BackhaulDownMACAddress. This parameter was OBSOLETED in 2.21. This parameter was DELETED in 2.22. Changes since 2.21:
|
- |
2.17 |
|
Layer3PathCapabilities |
string[] |
R |
Comma-separated list of strings. Each entry represents the supported Layer3Path transport protocols as indicated in the Layer3 Transport Capabilities TLV [Layer3 Transport Capabilities TLV/EasyMesh]. If this device does not support any Layer3Path transport protocols, then this value is an empty string. Each list item is an enumeration of:
|
- |
2.22 |
|
Layer3PathNumberOfEntries |
unsignedInt |
R |
The number of entries in the Layer3Path table. |
- |
2.22 |
|
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}. |
object(0:) |
R |
Table of Multi-Link Operation (MLO) capable Access Points (APs) on this EasyMesh Agent or Single AP device. [EasyMesh] source: Agent AP MLD Configuration TLV. At most one entry in this table can exist with a given value for MLDMACAddress. |
- |
2.17 |
|
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.AffiliatedAP.{i}. |
object(0:) |
R |
The Access Points (APs) affiliated to the AP MLD. [EasyMesh] Source: Agent AP MLD Configuration TLV. Counters in this object only include MLD traffic. At most one entry in this table can exist with a given value for BSSID. |
- |
2.17 |
|
PacketsSent |
unsignedInt |
R |
[StatsCounter32] The number of packets transmitted by the Affiliatedaffiliated AP. Note: this counter counts only MLD traffic through this BSSID, not legacy (non-MLD) traffic. [EasyMesh] source: Associated STA Traffic Stats TLV. |
- |
2.17 |
|
PacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packets received from the affiliated STAs by this Affiliatedaffiliated AP. [EasyMesh] source: Associated STA Traffic Stats TLV. |
- |
2.17 |
|
UnicastBytesSent |
unsignedInt |
R |
[StatsCounter32] Total number of unicast bytes transmitted to affiliatedMLD STAs associated with thisthe affiliated AP. [EasyMesh] source: AffiliatedAssociated APSTA MetricsTraffic Stats TLV. |
- |
2.17 |
|
UnicastBytesReceived |
unsignedInt |
R |
[StatsCounter32] Total number of unicast bytes received from affiliatedMLD STAs associated with thisthe affiliated AP. [EasyMesh] source: AffiliatedAssociated APSTA MetricsTraffic Stats TLV. |
- |
2.17 |
|
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The number of packets which could not be transmitted by the Affiliatedaffiliated AP due to errors. This counter counts only MLD traffic through this BSSID, not legacy (non-MLD) traffic. [EasyMesh] source: AffiliatedAssociated APSTA MetricsTraffic Stats TLV. |
- |
2.17 |
|
MulticastBytesSent |
unsignedInt |
R |
[StatsCounter32] Total multicast bytes transmitted to affiliatedMLD STAs associated with thisthe affiliated AP. [EasyMesh] source: AffiliatedAssociated APSTA MetricsTraffic Stats TLV. |
- |
2.17 |
|
MulticastBytesReceived |
unsignedInt |
R |
[StatsCounter32] Total multicast bytes received from affiliatedMLD STAs associated with thisthe affiliated AP. [EasyMesh] source: AffiliatedAssociated APSTA MetricsTraffic Stats TLV. |
- |
2.17 |
|
BroadcastBytesSent |
unsignedInt |
R |
[StatsCounter32] Total broadcast bytes transmitted to affiliatedMLD STAs associated with thisthe affiliated AP. [EasyMesh] source: AffiliatedAssociated APSTA MetricsTraffic Stats TLV. |
- |
2.17 |
|
BroadcastBytesReceived |
unsignedInt |
R |
[StatsCounter32] Total broadcast bytes received from affiliatedMLD STAs associated with thisthe affiliated AP. [EasyMesh] source: AffiliatedAssociated APSTA MetricsTraffic Stats TLV. |
- |
2.17 |
|
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.STAMLD.{i}. |
object(0:) |
R |
This object describes Multi-Link Operation (MLO) capable stations (STAs), also known as client Multilink Devices (MLDs), associated to this MLO capable Access Point. [EasyMesh] source: Associated Clients TLV. At most one entry in this table can exist with a given value for MLDMACAddress. Changes since 2.21:
|
- |
2.17 |
|
SupportedWiFiGenerations |
hexBinary(2:) |
R |
A bit map indicating each Wi-Fi generation supported by this STAMLD
Notes:
If the STA includes a Generational Capabilities Indication attribute, as defined in [Table 6/WFA Capabilities] in its (Re)Association Request frames or in its Wi-Fi Alliance Capabilities frames, the information about support for Wi-Fi 4 and above may be retrieved from this attribute. In addition, or alternatively when the STA doesn't include a Generational Capabilities Indication attribute in its (Re)Association Request frames and Wi-Fi Alliance Capabilities frames, the DataElements Agent may use the following guidance to infer STA support of a Wi-Fi generation:
Notes:
|
- |
2.22 |
|
WFACapabilities |
hexBinary(1:) |
R |
A bit map indicating each WFA Capability supported by this STAMLD, as defined in [Table 3/WFA Capabilities]
A value of 0 indicates that either the information has not been provided by the STA or that the STA doesn't support any of the capabilities listed in [Table 3/WFA Capabilities]. Notes:
|
- |
2.22 |
|
Device.WiFi.DataElements.Network.Device.{i}.bSTAMLD. |
object |
R |
This object represents the Multi-Link Operation (MLO) capable backhaul station (bSTA) operating on this EasyMesh Agent. Only one MLO capable bSTA per EasyMesh Agent is allowed. [EasyMesh] source: Backhaul STA MLD Configuration TLV. |
- |
2.17 |
|
AffiliatedbSTAList |
string(:17)[] |
R |
[MACAddress] Comma-separated list of MAC Addresses. backhaul STA MAC addresses affiliated to this bSTA MLD. [EasyMesh] source: Backhaul STA MLD Configuration TLV. Changes since 2.21:
|
- |
2.17 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}. |
object(0:) |
R |
This object represents all of the individual Radios contained within the identified Access Point device known to the controller. At most one entry in this table can exist with a given value for ID. Changes since 2.21:
|
- |
2.13 |
|
SupportedSensingDataTypes |
hexBinary(8)[] |
R |
[SensingDataType] Comma-separated list of Sensing Data Types. Each entry represents a sensing data type, identified by a 4-byte hexadecimal number. If this radio does not support generating sensing measurement data, then this value is an empty string. |
- |
2.22 |
|
SupportedBSSSensingExchangeTypes |
string[] |
R |
[SensingExchangeType] Comma-separated list of Sensing Exchange Types. Each entry represents the supported sensing exchange types on a BSS operating on this radio. If this radio does not support any sensing exchange types, then this value is an empty string. |
- |
2.22 |
|
SupportedSTASensingExchangeTypes |
string[] |
R |
[SensingExchangeType] Comma-separated list of Sensing Exchange Types. Each entry represents the supported sensing exchange types on a STA operating on this radio. If this radio does not support any sensing exchange types, then this value is an empty string. |
- |
2.22 |
|
AgentSTANumberOfEntries |
unsignedInt |
R |
The number of entries in the AgentSTA table. |
- |
2.22 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}. |
object(0:) |
R |
The list of neighboring Access Points discovered by a Radio organized per Operating Class and Channel tuple. |
- |
2.14 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}. |
object(0:) |
R |
The Operating Class of neighboring Access Points discovered by a Radio during a channel scan. At most one entry in this table can exist with a given value for OperatingClass. |
- |
2.14 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}. |
object(0:) |
R |
The Channel associated with an Operating Class of neighboring Access Points discovered by a Radio during a channel scan. At most one entry in this table can exist with a given value for Channel. |
- |
2.14 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.NeighborBSS.{i}. |
object(0:) |
R |
The neighboring BSS discovered by a Radio during a channel scan. For MLDs, MLDMACAddress identifies the AP MLD for which this NeighborBSS.{i}. is an affilatedaffiliated AP, other affiliated APs in this NeighborBSS have the same value of MLDMACAddress. At most one entry in this table can exist with a given value for BSSID. |
- |
2.14 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.AgentSTA.{i}. |
object(0:) |
R |
Each instance represents an Agent STA (aSTA) on this radio. The aSTA interface may be used for sensing. See [Section 7.5, Agent STA configuration/EasyMesh]. At most one entry in this table can exist with a given value for MACAddress. |
- |
2.22 |
|
MACAddress |
string(:17) |
R |
[MACAddress] The MAC address of the Agent STA. |
- |
2.22 |
|
MaxSupportedBandwidth |
string |
R |
Specifies the maximum supported bandwidth of the STA. Enumeration of:
|
- |
2.22 |
|
ProbeResponseNumberOfEntries |
unsignedInt |
R |
The number of entries in the ProbeResponse table. |
- |
2.22 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.AgentSTA.{i}.ProbeResponse.{i}. |
object(0:) |
R |
Each instance represents a Tunneled message containing a Probe Response frame received from an EasyMesh agent. See [Section 21.3, Trigger Probe Request/EasyMesh]. At most one entry in this table can exist with a given value for BSSID. |
- |
2.22 |
|
TimeStamp |
dateTime |
R |
The timestamp of when the Tunneled message was received by the EasyMesh controller. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. |
- |
2.22 |
|
BSSID |
string(:17) |
R |
[MACAddress] The MAC Address of the logical BSS (BSSID) corresponding to this object. |
- |
2.22 |
|
SignalStrength |
unsignedInt(:255) |
R |
An indicator of radio signal strength (RSSI) of the Probe Response frame as received by the radio measured in dBm. (RSSI is encoded per [Table 9-176/802.11-2020]). Reserved: 221 - 255. |
- |
2.22 |
|
MLDMACAddress |
string(:17) |
R |
[MACAddress] The Multi-Link Device (MLD) MAC address of the Multi-Link Operation (MLO) capable BSS that sent the Probe Response frame. Empty if the BSS that sent the Probe Response frame is not MLO capable. |
- |
2.22 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.AgentSTA.{i}.ProbeResponse.{i}.SensingCapabilities. |
object |
R |
This object is a copy of the sensing capabilities received in the Probe Response frame represented by this object. |
- |
2.22 |
|
MaxTxBandwidth |
unsignedInt |
R |
Indicates the maximum bandwidth in MHz supported for any sensing NDP (null data physical layer protocol data unit) transmission. |
- |
2.22 |
|
MaxTxSTSLE80MHz |
unsignedInt |
R |
Indicates the maximum number of STS (space-time streams) supported for any sensing NDP transmission using bandwidths less than or equal to 80 MHz. |
- |
2.22 |
|
MaxTxSTS160MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP transmission using a bandwidth equal to 160 MHz. |
- |
2.22 |
|
MaxTxSTS320MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP transmission using a bandwidth equal to 320 MHz. |
- |
2.22 |
|
MaxRxSTSLE80MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using bandwidths less than or equal to 80 MHz. |
- |
2.22 |
|
MaxRxSTS160MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using a bandwidth equal to 160 MHz. |
- |
2.22 |
|
MaxRxSTS320MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using a bandwidth equal to 320 MHz. |
- |
2.22 |
|
MaxTxLTFRepetition |
unsignedInt |
R |
Indicates the maximum number of LTF (long training field) repetitions minus 1 supported for any sensing NDP transmission. |
- |
2.22 |
|
MaxRxLTFRepetition |
unsignedInt |
R |
Indicates the maximum number of LTF repetitions minus 1 supported for any sensing NDP reception. |
- |
2.22 |
|
MaxTxLTFTotal |
unsignedInt(4,8,16,64) |
R |
Indicates the maximum total number of LTF repetitions supported for any sensing NDP transmission, which includes all STS. |
- |
2.22 |
|
MaxRxLTFTotal |
unsignedInt(4,8,16,64) |
R |
Indicates the maximum total number of LTF repetitions supported for any sensing NDP reception, which includes all STS. |
- |
2.22 |
|
MaxSupportedSessions |
unsignedInt |
R |
Indicates maximum number of concurrent sessions supported as a Sensing Responder. |
- |
2.22 |
|
MinMeasurementInterval |
unsignedInt |
R |
Indicates the minimum time between two consecutive non-TB (non-trigger-based) measurement exchanges, in 100 usec. |
- |
2.22 |
|
Sensing20MHzOnlyTx |
boolean |
R |
Indicates support for a Sensing Transmitter role only in a bandwidth of 20 MHz. |
- |
2.22 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.AgentSTA.{i}.SensingCapabilities. |
object |
R |
This object is a copy of the sensing capabilities of the Agent STA as transmitted in the Sensing Capabilities IE [Section 9.4.2.332/802.11bf]. |
- |
2.22 |
|
MaxTxBandwidth |
unsignedInt |
R |
Indicates the maximum bandwidth in MHz supported for any sensing NDP (null data physical layer protocol data unit) transmission. |
- |
2.22 |
|
MaxTxSTSLE80MHz |
unsignedInt |
R |
Indicates the maximum number of STS (space-time streams) supported for any sensing NDP transmission using bandwidths less than or equal to 80 MHz. |
- |
2.22 |
|
MaxTxSTS160MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP transmission using a bandwidth equal to 160 MHz. |
- |
2.22 |
|
MaxTxSTS320MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP transmission using a bandwidth equal to 320 MHz. |
- |
2.22 |
|
MaxRxSTSLE80MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using bandwidths less than or equal to 80 MHz. |
- |
2.22 |
|
MaxRxSTS160MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using a bandwidth equal to 160 MHz. |
- |
2.22 |
|
MaxRxSTS320MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using a bandwidth equal to 320 MHz. |
- |
2.22 |
|
MaxTxLTFRepetition |
unsignedInt |
R |
Indicates the maximum number of LTF (long training field) repetitions minus 1 supported for any sensing NDP transmission. |
- |
2.22 |
|
MaxRxLTFRepetition |
unsignedInt |
R |
Indicates the maximum number of LTF repetitions minus 1 supported for any sensing NDP reception. |
- |
2.22 |
|
MaxTxLTFTotal |
unsignedInt(4,8,16,64) |
R |
Indicates the maximum total number of LTF repetitions supported for any sensing NDP transmission, which includes all STS. |
- |
2.22 |
|
MaxRxLTFTotal |
unsignedInt(4,8,16,64) |
R |
Indicates the maximum total number of LTF repetitions supported for any sensing NDP reception, which includes all STS. |
- |
2.22 |
|
MaxSupportedSessions |
unsignedInt |
R |
Indicates maximum number of concurrent sessions supported as a Sensing Responder. |
- |
2.22 |
|
MinMeasurementInterval |
unsignedInt |
R |
Indicates the minimum time between two consecutive non-TB (non-trigger-based) measurement exchanges, in 100 usec. |
- |
2.22 |
|
Sensing20MHzOnlyTx |
boolean |
R |
Indicates support for a Sensing Transmitter role only in a bandwidth of 20 MHz. |
- |
2.22 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BackhaulSta. |
object |
R |
Contains the Medium Access Control (MAC) address of the STA on this radio providing Wi-Fi backhaul to this device. Changes since 2.21:
|
- |
2.13 |
|
MaxSupportedBandwidth |
string |
R |
Specifies the maximum supported bandwidth of the STA. Enumeration of:
|
- |
2.22 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BackhaulSta.SensingCapabilities. |
object |
R |
This object describes the sensing capabilities of a single bSTA (backhaul STA) interface, extracted from the Sensing Capabilities Information Element in [Section 9.4.2.332/802.11bf]. |
- |
2.22 |
|
MaxTxBandwidth |
unsignedInt |
R |
Indicates the maximum bandwidth in MHz supported for any sensing NDP (null data physical layer protocol data unit) transmission. |
- |
2.22 |
|
MaxTxSTSLE80MHz |
unsignedInt |
R |
Indicates the maximum number of STS (space-time streams) supported for any sensing NDP transmission using bandwidths less than or equal to 80 MHz. |
- |
2.22 |
|
MaxTxSTS160MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP transmission using a bandwidth equal to 160 MHz. |
- |
2.22 |
|
MaxTxSTS320MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP transmission using a bandwidth equal to 320 MHz. |
- |
2.22 |
|
MaxRxSTSLE80MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using bandwidths less than or equal to 80 MHz. |
- |
2.22 |
|
MaxRxSTS160MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using a bandwidth equal to 160 MHz. |
- |
2.22 |
|
MaxRxSTS320MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using a bandwidth equal to 320 MHz. |
- |
2.22 |
|
MaxTxLTFRepetition |
unsignedInt |
R |
Indicates the maximum number of LTF (long training field) repetitions minus 1 supported for any sensing NDP transmission. |
- |
2.22 |
|
MaxRxLTFRepetition |
unsignedInt |
R |
Indicates the maximum number of LTF repetitions minus 1 supported for any sensing NDP reception. |
- |
2.22 |
|
MaxTxLTFTotal |
unsignedInt(4,8,16,64) |
R |
Indicates the maximum total number of LTF repetitions supported for any sensing NDP transmission, which includes all STS. |
- |
2.22 |
|
MaxRxLTFTotal |
unsignedInt(4,8,16,64) |
R |
Indicates the maximum total number of LTF repetitions supported for any sensing NDP reception, which includes all STS. |
- |
2.22 |
|
MaxSupportedSessions |
unsignedInt |
R |
Indicates maximum number of concurrent sessions supported as a Sensing Responder. |
- |
2.22 |
|
MinMeasurementInterval |
unsignedInt |
R |
Indicates the minimum time between two consecutive non-TB (non-trigger-based) measurement exchanges, in 100 usec. |
- |
2.22 |
|
Sensing20MHzOnlyTx |
boolean |
R |
Indicates support for a Sensing Transmitter role only in a bandwidth of 20 MHz. |
- |
2.22 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}. |
object(0:) |
R |
A single logical BSS operating on this radio. At most one entry in this table can exist with a given value for BSSID. Changes since 2.21:
|
- |
2.13 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.SensingCapabilities. |
object |
R |
This object is a copy of the sensing capabilities for the BSS as transmitted in the Sensing Capabilities IE defined in [Section 9.4.2.332/802.11bf]. |
- |
2.22 |
|
MaxTxBandwidth |
unsignedInt |
R |
Indicates the maximum bandwidth in MHz supported for any sensing NDP (null data physical layer protocol data unit) transmission. |
- |
2.22 |
|
MaxTxSTSLE80MHz |
unsignedInt |
R |
Indicates the maximum number of STS (space-time streams) supported for any sensing NDP transmission using bandwidths less than or equal to 80 MHz. |
- |
2.22 |
|
MaxTxSTS160MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP transmission using a bandwidth equal to 160 MHz. |
- |
2.22 |
|
MaxTxSTS320MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP transmission using a bandwidth equal to 320 MHz. |
- |
2.22 |
|
MaxRxSTSLE80MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using bandwidths less than or equal to 80 MHz. |
- |
2.22 |
|
MaxRxSTS160MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using a bandwidth equal to 160 MHz. |
- |
2.22 |
|
MaxRxSTS320MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using a bandwidth equal to 320 MHz. |
- |
2.22 |
|
MaxTxLTFRepetition |
unsignedInt |
R |
Indicates the maximum number of LTF (long training field) repetitions minus 1 supported for any sensing NDP transmission. |
- |
2.22 |
|
MaxRxLTFRepetition |
unsignedInt |
R |
Indicates the maximum number of LTF repetitions minus 1 supported for any sensing NDP reception. |
- |
2.22 |
|
MaxTxLTFTotal |
unsignedInt(4,8,16,64) |
R |
Indicates the maximum total number of LTF repetitions supported for any sensing NDP transmission, which includes all STS. |
- |
2.22 |
|
MaxRxLTFTotal |
unsignedInt(4,8,16,64) |
R |
Indicates the maximum total number of LTF repetitions supported for any sensing NDP reception, which includes all STS. |
- |
2.22 |
|
MaxSupportedSessions |
unsignedInt |
R |
Indicates maximum number of concurrent sessions supported as a Sensing Responder. |
- |
2.22 |
|
MinMeasurementInterval |
unsignedInt |
R |
Indicates the minimum time between two consecutive non-TB (non-trigger-based) measurement exchanges, in 100 usec. |
- |
2.22 |
|
Sensing20MHzOnlyTx |
boolean |
R |
Indicates support for a Sensing Transmitter role only in a bandwidth of 20 MHz. |
- |
2.22 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}. |
object(0:) |
R |
Object describing a single Associated Device (STA). The Backhaul STAs (bSTAs) with which other Device.WiFi.DataElements.Network.Device.{i}. connect to this BSS are included in this table. STA MLD and bSTA MLD are not included, and are instead part of Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.STAMLD.{i}.. AffiliatedSTAs and AffiliatedbSTAs are not included, and are instead part of Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.STAMLD.{i}.AffiliatedSTA.{i}.. At most one entry in this table can exist with a given value for MACAddress. Changes since 2.21:
|
- |
2.13 |
|
SupportedWiFiGenerations |
hexBinary(2:) |
R |
A bit map indicating each Wi-Fi generation supported by this STA
Notes:
If the STA includes a Generational Capabilities Indication attribute, as defined in [Table 6/WFA Capabilities] in its (Re)Association Request frames or in its Wi-Fi Alliance Capabilities frames, the information about support for Wi-Fi 4 and above may be retrieved from this attribute. In addition, or alternatively when the STA doesn't include a Generational Capabilities Indication attribute in its (Re)Association Request frames and Wi-Fi Alliance Capabilities frames, the DataElements Agent may use the following guidance to infer STA support of a Wi-Fi generation:
Notes:
|
- |
2.22 |
|
MaxSupportedBandwidth |
string |
R |
Specifies the maximum supported bandwidth of the STA. Enumeration of:
|
- |
2.22 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.SensingCapabilities. |
object |
R |
This object is a copy of the sensing capabilities of the STA as received by the BSS in the Sensing Capabilities IE [Section 9.4.2.332/802.11bf]. |
- |
2.22 |
|
MaxTxBandwidth |
unsignedInt |
R |
Indicates the maximum bandwidth in MHz supported for any sensing NDP (null data physical layer protocol data unit) transmission. |
- |
2.22 |
|
MaxTxSTSLE80MHz |
unsignedInt |
R |
Indicates the maximum number of STS (space-time streams) supported for any sensing NDP transmission using bandwidths less than or equal to 80 MHz. |
- |
2.22 |
|
MaxTxSTS160MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP transmission using a bandwidth equal to 160 MHz. |
- |
2.22 |
|
MaxTxSTS320MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP transmission using a bandwidth equal to 320 MHz. |
- |
2.22 |
|
MaxRxSTSLE80MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using bandwidths less than or equal to 80 MHz. |
- |
2.22 |
|
MaxRxSTS160MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using a bandwidth equal to 160 MHz. |
- |
2.22 |
|
MaxRxSTS320MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using a bandwidth equal to 320 MHz. |
- |
2.22 |
|
MaxTxLTFRepetition |
unsignedInt |
R |
Indicates the maximum number of LTF (long training field) repetitions minus 1 supported for any sensing NDP transmission. |
- |
2.22 |
|
MaxRxLTFRepetition |
unsignedInt |
R |
Indicates the maximum number of LTF repetitions minus 1 supported for any sensing NDP reception. |
- |
2.22 |
|
MaxTxLTFTotal |
unsignedInt(4,8,16,64) |
R |
Indicates the maximum total number of LTF repetitions supported for any sensing NDP transmission, which includes all STS. |
- |
2.22 |
|
MaxRxLTFTotal |
unsignedInt(4,8,16,64) |
R |
Indicates the maximum total number of LTF repetitions supported for any sensing NDP reception, which includes all STS. |
- |
2.22 |
|
MaxSupportedSessions |
unsignedInt |
R |
Indicates maximum number of concurrent sessions supported as a Sensing Responder. |
- |
2.22 |
|
MinMeasurementInterval |
unsignedInt |
R |
Indicates the minimum time between two consecutive non-TB (non-trigger-based) measurement exchanges, in 100 usec. |
- |
2.22 |
|
Sensing20MHzOnlyTx |
boolean |
R |
Indicates support for a Sensing Transmitter role only in a bandwidth of 20 MHz. |
- |
2.22 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.UnassociatedSTA.{i}. |
object(0:) |
R |
Each instance represents a station (STA) that has been discovered by the Radio but is not associated to any of the BSS operating on the Radio. At most one entry in this table can exist with a given value for MACAddress. Changes since 2.21:
|
- |
2.13 |
|
MaxSupportedBandwidth |
string |
R |
Specifies the maximum supported bandwidth of the STA. Enumeration of:
|
- |
2.22 |
|
Device.WiFi.DataElements.Network.Device.{i}.Layer3Path.{i}. |
object(0:) |
R |
Each instance of this object represents a successfully established Layer3Path on this EasyMesh Agent. See [Section 16.2, Layer3Path/EasyMesh]. At most one entry in this table can exist with a given value for Alias. |
- |
2.22 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.22 |
|
Layer3ServiceType |
string |
R |
Service type for which the Layer3Path will transport data. Enumeration of:
|
- |
2.22 |
|
TransportProtocol |
string |
R |
The transport protocol used for transmission and reception of Layer3Path data, provided in the Layer3PathSetup Request TLV. Enumeration of:
|
- |
2.22 |
|
DestinationAddress |
string(:45) |
R |
[IPAddress] The destination IPv4 or IPV6 address of the device used for reception of Layer3Path data, provided in the Layer3PathSetup Request TLV. |
- |
2.22 |
|
DestinationPort |
unsignedInt(:65535) |
R |
The destination UDP or TCP port number used for reception of Layer3Path data, provided in the Layer3PathSetup Request TLV. |
- |
2.22 |
|
SourceAddress |
string(:45) |
R |
[IPAddress] The source IP address of the device used for transmission of Layer3Path data, provided in the Layer3PathSetup Response TLV. |
- |
2.22 |
|
SourcePort |
unsignedInt(:65535) |
R |
The source UDP or TCP port number used for transmission of Layer3Path data, provided in the Layer3PathSetup Response TLV. |
- |
2.22 |
|
Device.WiFi.Sensing. |
object |
R |
This object represents the Wi-Fi Alliance Sensing functionality on local Wi-Fi radios for Basic and Advanced functionality as defined in [Section 21, Sensing/EasyMesh]. |
- |
2.22 |
|
SessionNumberOfEntries |
unsignedInt |
R |
The number of entries in the Session table. |
- |
2.22 |
|
Device.WiFi.Sensing.Session.{i}. |
object(0:) |
R |
This object represents a sensing session, which is a connection from a client sensing application. At most one entry in this table can exist with a given value for SessionID, or with a given value for Alias. |
- |
2.22 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.22 |
|
ApplicationName |
string(:64) |
R |
Name or identifier of the sensing application which has created the Session instance. |
- |
2.22 |
|
SessionID |
unsignedInt |
R |
Unique session identifier, as communicated by the lower-layer implementation. |
- |
2.22 |
|
ExchangeNumberOfEntries |
unsignedInt |
R |
The number of entries in the Exchange table. |
- |
2.22 |
|
DataSocketPath |
string(:2048) |
R |
[URI] The destination path and filename for a UNIX domain socket of type SOCK_SEQPACKET, which an application can use to obtain sensing measurement data for all exchanges belonging to this session. The format is the URI scheme file [The file URI Scheme/RFC8089]. Note: Any sensing measurement data obtained while no application is connected to the socket may be discarded. |
- |
2.22 |
|
Device.WiFi.Sensing.Session.{i}.Exchange.{i}. |
object(0:) |
R |
This object represents a specific measurement exchange created by a sensing application. At most one entry in this table can exist with a given value for SensingExchangeID, or with a given value for Alias. |
- |
2.22 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.22 |
|
SensingExchangeID |
unsignedInt |
R |
Indicates the unique Sensing Exchange ID corresponding to this exchange [Section 17.2.116, Sensing Exchange Request TLV/EasyMesh]. |
- |
2.22 |
|
DeviceRef |
string |
R |
The value MUST be the Path Name of a row in the WiFi.DataElements.Network.Device. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. DeviceRef specifies the Multi-AP Agent which initiates the sensing exchange. |
- |
2.22 |
|
SensingPeriod |
unsignedInt |
R |
The requested period to perform the sensing measurement exchange in 10 TU intervals, where 1 TU = 1024 microseconds. Note: A value of 0 identifies a one-shot measurement. |
- |
2.22 |
|
SensingBandwidth |
unsignedInt |
R |
Requested bandwidth in MHz, on which to perform the sensing measurement. If not present, the maximum available bandwidth will be used. Notes:
|
- |
2.22 |
|
SensingNTx |
unsignedInt(:255) |
R |
Requested number of transmit chains to use. This only applies to Advanced sensing exchange types [Section 21.6, Sensing Operation Advanced/EasyMesh]. When not applicable then set to a value of 0. |
- |
2.22 |
|
SensingNRx |
unsignedInt(:255) |
R |
Requested number of receive chains to use. This only applies to Advanced sensing exchange types [Section 21.6, Sensing Operation Advanced/EasyMesh]. When not applicable then set to a value of 0. |
- |
2.22 |
|
SensingLTFRep |
unsignedInt(:255) |
R |
Requested number of LTF (long training field) repetitions per STS (space-time stream). This only applies to Advanced sensing TB (trigger-based) and non-TB (non-trigger-based) exchange types [Section 21.6, Sensing Operation Advanced/EasyMesh]. When not applicable then set to a value of 0. |
- |
2.22 |
|
SensingExchangeType |
string |
R |
[SensingExchangeType] The type of measurement exchange to create. |
- |
2.22 |
|
SensingDataType |
hexBinary(8) |
R |
[SensingDataType] The data type format of the sensing measurement results. |
- |
2.22 |
|
TransmitterMACAddress |
string(:17) |
R |
[MACAddress] MAC address of the sensing transmitter. |
- |
2.22 |
|
ReceiverMACAddress |
string(:17) |
R |
[MACAddress] MAC address of the sensing receiver. |
- |
2.22 |
|
MeasurementsRequested |
boolean |
R |
Indicates if sensing measurement results are sent to the established Layer3Path, or not.
|
- |
2.22 |
|
Device.WiFi.AFC. |
object |
R |
Object that contains all the information regarding Automated Frequency Coordination (AFC) configuration and status for 6 GHz operation. The object definition is based on specification [AFCSDI], which defines the AFC system for communicating to the AFC server. |
- |
2.21 |
|
ServerURL |
string(:2048) |
W |
[URI] The URL for the CPEdevice to connect to the AFC server. This parameter MUST be in the form of a valid HTTP or HTTPS URL. The host portion of this URL is used by the CPEdevice for validating the AFC certificate when using TLS. |
- |
2.21 |
|
Device.WiFi.Radio.{i}. |
object(0:) |
R |
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. Changes since 2.21:
|
- |
2.0 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.0 |
|
OperatingFrequencyBand |
string |
W |
The value MUST be a member of the list reported by the SupportedFrequencyBands parameter. Indicates the frequency band at which the radio is operating. If the radio supports multiple bands, and OperatingFrequencyBand is changed, then all parameters whose value is not valid for the new frequency band (e.g. Channel) MUST be set to a valid value (according to some CPEdevice vendor-specific behavior). |
- |
2.0 |
|
TransmitPowerSupported |
int(-1:100)[](:64) |
R |
Comma-separated list (maximum number of characters 64) of integers (-1 to 100). List items represent supported transmit power levels as percentage of full power. For example, "0,25,50,75,100". A -1 item indicates auto mode (automatic decision by CPE).device). Auto mode allows the Radio to adjust transmit power accordingly. For example, this can be useful for power-save modes such as EU-CoC, where the Radio can adjust power according to activity in the CPE.}}device. |
- |
2.0 |
|
TransmitPower |
int(-1:100) |
W |
Indicates the current transmit power level as a percentage of full power. The value MUST be one of the values reported by the TransmitPowerSupported parameter. A value of -1 indicates auto mode (automatic decision by CPE).device). If the instance of this Radio is the same as Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}., then this parameter is the same as Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.CurrentOperatingClassProfile.{i}.TxPower. |
- |
2.0 |
|
CCAReport |
hexBinary(12) |
R |
The clear channel assessment (CCA) report in the format specified in [Clause 8.4.2.24.3/802.11-2012]. When read, the value of this parameter MUST correspond to CCARequest. How this is achieved is a local matter to the CPE.device. If this parameter is read before a CCARequest has been issued, then its value is an empty string. |
- |
2.8 |
|
DTIMPeriod |
unsignedInt |
W |
This specifies the number of beacon intervals (measured in ms) that elapse between transmission of Beacon frames containing a TIM element whose DTIM Count field is 0. This parameter is based on dot11DTIMPeriod from [802.11-2024]. |
- |
2.8 |
|
SupportedSensingDataTypes |
hexBinary(4)[] |
R |
Comma-separated list of Hex binarys (length 4). Each item is a 4-byte hexadecimal number that identifies a sensing data type. A sensing data type identifies the formatting of the sensing data, e.g. reporting frame CSI [802.11bf], CFO [802.11-2024], or vendor-specific. The first three bytes are either zeros, representing standard types, or the CID (Company identifier) or OUI (Organizationally Unique Identifier). The last byte identifies the format. An empty string value indicates that the radio does not support sensing of any type. |
- |
2.22 |
|
SupportedAccessPointSensingExchangeTypes |
string[] |
R |
Comma-separated list of strings. Each item is a BSS supported sensing exchange type, includes legacy exchange types such as qosnull, opportunistic, probe and [802.11bf] types like trigger-based, non-trigger-based and sensing by proxy. |
- |
2.22 |
|
SupportedEndPointSensingExchangeTypes |
string[] |
R |
Comma-separated list of strings. Each item is a STA supported sensing exchange type,includes legacy exchange types such as qosnull, opportunistic, probe and [802.11bf] types like non-trigger-based and sensing by proxy. Endpoints (station) cannot initiate trigger-based sensing exchanges. |
- |
2.22 |
|
Device.WiFi.Radio.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice 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]. Packet counters here count 802.11 WiFi frames. See [Appendix III/TR-181i2] for further details. |
- |
2.0 |
|
Device.WiFi.CCAMeasurementDiagnostic. |
object |
R |
This object is to provide diagnostic information on a Clear Channel Assessment (CCA) measurement scan on this radio on the given channel using a specific DwellTime. |
- |
2.15 |
|
CCAReport |
hexBinary(12) |
R |
The clear channel assessment (CCA) report in the format specified in [Section 9.4.2.21.3/802.11-2020]. When read, the value of this parameter MUST correspond to Channel. How this is achieved is a local matter to the CPE.}}device. |
- |
2.15 |
|
Device.WiFi.NeighboringWiFiDiagnostic. |
object |
R |
This object defines access to other WiFi SSIDs that this device is able to receive. |
- |
2.7 |
|
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}. |
object(0:) |
R |
Neighboring SSID table. This table models other WiFi SSIDs that this device is able to receive. At most one entry in this table can exist with a given value for BSSID. |
- |
2.7 |
|
EncryptionMode |
string[] |
R |
Comma-separated list of strings. The type of encryption the neighboring WiFi SSID advertises. The reported values depend on SecurityModeEnabled:
Each list item is an enumeration of:
Changes since 2.21:
|
- |
2.7 |
|
DTIMPeriod |
unsignedInt |
R |
The number of beacon intervals (measured in ms) that elapse between transmission of Beacon frames containing a TIM element whose DTIM count field is 0. This value is transmitted in the DTIM Period field of beacon frames. [802.11-2024] |
- |
2.7 |
|
Device.WiFi.Radio.{i}.Capabilities. |
object |
R |
This object represents the capabilities of the radio which may be different from the current operational configuration. Changes since 2.21:
|
- |
2.20 |
|
TIDLinkMapCapability |
string |
R |
Indicates the EasyMesh Agent support for TID to Link mapping. [EasyMesh] source: Wi-Fi 7 Agent Capabilities TLV. Enumeration of:
|
- |
2.22 |
|
Device.WiFi.Radio.{i}.StaticPuncturing. |
object |
R |
Static puncturing configuration for this radio. Static puncturing allows specific sub-channels to be permanently disabled for EHT (IEEE 802.11be) operation. |
- |
2.22 |
|
DisabledSubChannels |
unsignedInt(0:65535) |
W |
Disabled Subchannel Bitmap specifying which 20 MHz sub-channels within the operating channel are statically punctured. The bitmap follows the Punctured Channel Information field as defined in [802.11be]. The disabled channels list can be rejected when it does not match any reference puncturing bitmap or when it includes a channel not supported by the radio. |
- |
2.22 |
|
Device.WiFi.SSID.{i}. |
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 (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for BSSID. Changes since 2.21:
|
- |
2.0 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.0 |
|
MLDLinkID |
int(-1:15) |
R |
The link ID of this SSID in active MLO connections. When MLDLinkID is -1, this SSID is not actively part of an MLD. For endpoints where MLDRole is not None, and the endpoint is actively connected to an upstream AP, it may still occur that MLDLinkID is -1. In that case the SSID is associated as a single link even though configured as MLO capable, and is thus not part of an active bSTAMLD. |
-1 |
2.22 |
|
MLDLinkLocalMACAddress |
string(:17) |
R |
[MACAddress] The remote link MAC address of this SSID in active MLO connections. When this SSID is not actively part of an MLD, MLDLinkLocalMACAddress is set to the null MAC address. |
- |
2.22 |
|
MLDRole |
string |
R |
The role this SSID is fulfilling in the MLO operation. Enumeration of:
|
None |
2.22 |
|
MLDStatus |
string |
R |
The MLD status of this SSID. Enumeration of:
|
- |
2.22 |
|
Device.WiFi.SSID.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice 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]. Packet counters here count 802.11 WiFi frames. See [Appendix III/TR-181i2] for further details. |
- |
2.0 |
|
Device.WiFi.APMLD.{i}. |
object(0:) |
W |
Table of Multi-Link Operation (MLO) capable Access Points (APs) on this EasyMesh Agent or Single AP device. [EasyMesh] source: Agent AP MLD Configuration TLV. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for MLDMACAddress. |
- |
2.22 |
|
MLDMACAddress |
string(:17) |
R |
[MACAddress] The Multi-Link Device (MLD) MAC Address of the MLO Capable access point (AP). [EasyMesh] Source: Agent AP MLD Configuration TLV. |
- |
2.22 |
|
APMLDTemplateRef |
string |
R |
The value MUST be the Path Name of a row in the WiFi.Templates.APMLDTemplate. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. APMLDTemplateRef is a reference to the APMLDTemplate selected for this APMLD. |
- |
2.22 |
|
TIDLinkMapNumberOfEntries |
unsignedInt |
R |
The number of entries in the TIDLinkMap table. |
- |
2.22 |
|
AffiliatedAPNumberOfEntries |
unsignedInt |
R |
The number of entries in the AffiliatedAP table. |
- |
2.22 |
|
LinkToOpClassMapNumberOfEntries |
unsignedInt |
R |
The number of entries in the LinkToOpClassMap table. |
- |
2.22 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.22 |
|
Enable |
boolean |
W |
Enables or disables this AP MLD instance. |
false |
2.22 |
|
MLDID |
int |
WO |
MLD unit identifier. Matches the MLDUnit value configured on the affiliated AP SSIDs. Set only during instance creation and cannot be modified thereafter. Once it's been set, this parameter is immutable. |
- |
2.22 |
|
Device.WiFi.APMLD.{i}.APMLDConfig. |
object |
R |
This object describes the Wi-Fi 7 Multi-Link Operation (MLO) configuration of the Multi-Link Device (MLD) Access Point (AP), [EasyMesh] source: Agent AP MLD Configuration TLV. |
- |
2.22 |
|
EMLMREnabled |
boolean |
W |
Indicates if the Enhanced Multi-Link Multi-Radio (EMLMR) operation is enabled. |
- |
2.22 |
|
EMLSREnabled |
boolean |
W |
Indicates if Enhanced Multi-Link Single-Radio (EMLSR) operation is enabled. |
- |
2.22 |
|
STREnabled |
boolean |
W |
Indicates if Simultaneous Transmit and Receive (STR) operation is enabled. |
- |
2.22 |
|
NSTREnabled |
boolean |
W |
Indicates if Non-Simultaneous Transmit and Receive (NSTR) operation is enabled. |
- |
2.22 |
|
TIDLinkMapNegotiation |
boolean |
W |
Indicates if Traffic Identifier (TID) to Link Mapping Negotiation is enabled. [EasyMesh] source: TID-to-Link Mapping Policy TLV. |
- |
2.22 |
|
TIDToOpClassPolicyNumberOfEntries |
unsignedInt |
R |
The number of entries in the TIDToOpClassPolicy table. |
- |
2.22 |
|
Device.WiFi.APMLD.{i}.APMLDConfig.TIDToOpClassPolicy.{i}. |
object(0:) |
W |
Table of Traffic Identifier (TID) to Operating Class to be used as a policy when configuring TID-to-Link Mapping in the Multi-Link Operation (MLO) capable access point (AP). Each table entry describes the mapping between a particular TID and direction and the required current Operating Class for any link to be used for this TID when constructing a TID-to-Link Map [Section 20.2.8/EasyMesh]. At most one enabled entry in this table can exist with the same values for both TID and Direction. |
- |
2.22 |
|
Enable |
boolean |
W |
This parameter indicates whether the TID-to-Link mapping entry is enabled for Multi-Link Operation (MLO) on the access point (AP). When set to "true", the mapping between the specified Traffic Identifier (TID), direction, and required Operating Class will be active, and the TID-to-Link mapping policy will be applied during Multi-Link operations. When set to "false", the entry will be ignored. |
false |
2.22 |
|
TID |
unsignedInt(0:255) |
W |
The traffic identifier (TID) for this mapping. This TID is a unique key for this table. |
- |
2.22 |
|
OpClass |
unsignedInt(:255)[] |
W |
Comma-separated list of unsigned integers (up to 255). The Operating class of an available channel, from [Table E-4/802.11ax]. The TID can be mapped to any link using a radio with a current operating class within this list. |
- |
2.22 |
|
Direction |
string |
W |
The direction of the traffic flow from the perspective the AP MLD. Enumeration of:
|
- |
2.22 |
|
Device.WiFi.APMLD.{i}.TIDLinkMap.{i}. |
object(0:) |
W |
Table of Traffic Identifier (TID) to Link Mappings of the Multi-Link Operation (MLO) capable access point (AP). Each table entry describes the mapping between a particular TID and direction and preferred link. [EasyMesh] source: TID-to-Link Mapping Policy TLV. At most one entry in this table can exist with a given value for TID. On creation of a new table entry, the Agent MUST choose an initial value for TID such that the new entry does not conflict with any existing entries. |
- |
2.22 |
|
Direction |
string |
R |
The direction of the traffic flow from the perspective of the AP MLD. Enumeration of:
|
- |
2.22 |
|
TID |
unsignedInt(0:255) |
R |
The traffic identifier (TID) for this mapping. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.22 |
|
BSSID |
string(:17) |
R |
[MACAddress] The BSSID of the preferred link (affiliated AP) to use for traffic with matching direction and TID values. |
- |
2.22 |
|
LinkID |
unsignedInt(0:15)[] |
R |
Comma-separated list of unsigned integers (0 to 15). The Link ID of the preferred link (affiliated AP) to use for traffic with matching direction and TID values. |
- |
2.22 |
|
LinkMapFrequencyBands |
string[] |
W |
Comma-separated list of strings. Each item represent a frequency band whose link is part of the specific link mapping for this TID. An empty string indicates that all available links are usable. Each list item is an enumeration of:
|
- |
2.22 |
|
Device.WiFi.APMLD.{i}.LinkToOpClassMap.{i}. |
object(0:) |
R |
This object describes the relationship between an Affiliated AP and the Operating Class (OpClass) of the Radio that the Affiliated AP is operating on [Section 20.2.8/EasyMesh]. At most one entry in this table can exist with a given value for LinkID. |
- |
2.22 |
|
LinkID |
unsignedInt(0:15) |
R |
The Link ID assigned to one of the affiliated APs of this AP MLD. [Section 17.2.96, Agent AP MLD Configuration TLV/EasyMesh] |
- |
2.22 |
|
OpClass |
unsignedInt(:255) |
R |
One of the current Operating Class per [Table E-4/802.11ax] that the Radio on which the Affiliated AP with the given LinkID is operating on. |
- |
2.22 |
|
Device.WiFi.APMLD.{i}.AffiliatedAP.{i}. |
object(0:) |
R |
The Access Points (APs) affiliated to the AP MLD. [EasyMesh] Source: Agent AP MLD Configuration TLV. Counters in this object only include MLD traffic. At most one entry in this table can exist with a given value for BSSID, or with a given value for Alias. |
- |
2.22 |
|
BSSID |
string(:17) |
R |
[MACAddress] The BSSID of the affiliated AP. |
- |
2.22 |
|
LinkID |
unsignedInt(0:15) |
R |
The Link ID assigned to this affiliated AP. [EasyMesh] source: Agent AP MLD Configuration TLV. |
- |
2.22 |
|
RUID |
base64 |
R |
The Radio unique identifier (RUID) of the Radio that this affiliated AP is operating on. [EasyMesh] source: Agent AP MLD Configuration TLV. |
- |
2.22 |
|
DisabledSubChannels |
unsignedInt(0:65535) |
R |
Disabled Subchannel Bitmap subfield from the EHT Operation element in transmitted Management frames. Null value or not present for stations. [EasyMesh] source: Static Puncturing Configuration TLV. |
- |
2.22 |
|
PacketsSent |
unsignedInt |
R |
[StatsCounter32] The number of packets transmitted by the affiliated AP. Note: this counter counts only MLD traffic through this BSSID, not legacy (non-MLD) traffic. [EasyMesh] source: Associated STA Traffic Stats TLV. |
- |
2.22 |
|
PacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packets received from the affiliated STAs by this affiliated AP. [EasyMesh] source: Associated STA Traffic Stats TLV. |
- |
2.22 |
|
UnicastBytesSent |
unsignedInt |
R |
[StatsCounter32] Total number of unicast bytes transmitted to MLD STAs associated with the affiliated AP. [EasyMesh] source: Associated STA Traffic Stats TLV. |
- |
2.22 |
|
UnicastBytesReceived |
unsignedInt |
R |
[StatsCounter32] Total number of unicast bytes received from MLD STAs associated with the affiliated AP. [EasyMesh] source: Associated STA Traffic Stats TLV. |
- |
2.22 |
|
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The number of packets which could not be transmitted by the affiliated AP due to errors. This counter counts only MLD traffic through this BSSID, not legacy (non-MLD) traffic. [EasyMesh] source: Associated STA Traffic Stats TLV. |
- |
2.22 |
|
MulticastBytesSent |
unsignedInt |
R |
[StatsCounter32] Total multicast bytes transmitted to MLD STAs associated with the affiliated AP. [EasyMesh] source: Associated STA Traffic Stats TLV. |
- |
2.22 |
|
MulticastBytesReceived |
unsignedInt |
R |
[StatsCounter32] Total multicast bytes received from MLD STAs associated with the affiliated AP. [EasyMesh] source: Associated STA Traffic Stats TLV. |
- |
2.22 |
|
BroadcastBytesSent |
unsignedInt |
R |
[StatsCounter32] Total broadcast bytes transmitted to MLD STAs associated with the affiliated AP. [EasyMesh] source: Associated STA Traffic Stats TLV. |
- |
2.22 |
|
BroadcastBytesReceived |
unsignedInt |
R |
[StatsCounter32] Total broadcast bytes received from MLD STAs associated with the affiliated AP. [EasyMesh] source: Associated STA Traffic Stats TLV. |
- |
2.22 |
|
EstServiceParametersBE |
base64(0:3) |
R |
Estimated Service Parameters information field for AC=BE, defined per [Figure 9-637/802.11-2020] and referenced in [Section 17.2.22/EasyMesh]. |
- |
2.22 |
|
EstServiceParametersBK |
base64(0:3) |
R |
Estimated Service Parameters information field for AC=BK, defined per [Figure 9-637/802.11-2020] and referenced in [Section 17.2.22/EasyMesh]. |
- |
2.22 |
|
EstServiceParametersVI |
base64(0:3) |
R |
Estimated Service Parameters information field for AC=VI, defined per [Figure 9-637/802.11-2020] and referenced in [Section 17.2.22/EasyMesh]. |
- |
2.22 |
|
EstServiceParametersVO |
base64(0:3) |
R |
Estimated Service Parameters information field for AC=VO, defined per [Figure 9-637/802.11-2020] and referenced in [Section 17.2.22/EasyMesh]. |
- |
2.22 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.22 |
|
AccessPointReference |
string |
R |
The value MUST be the Path Name of a row in the Device.WiFi.AccessPoint. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the physical Wi-Fi access point entry representing the same physical network interface as this affiliated AP. |
- |
2.22 |
|
Device.WiFi.APMLD.{i}.TIDLinkMapConfig. |
object |
R |
TID-to-Link Mapping configuration for this AP MLD. This object configures how Traffic Identifiers (TIDs) are mapped to specific links within the MLD. |
- |
2.22 |
|
Mode |
string |
W |
TID-to-Link Mapping operational mode. Enumeration of:
|
Disabled |
2.22 |
|
AdvertisedMapSwitchTime |
unsignedInt |
W |
Expected duration for switching to the advertised TID-to-Link Mapping, in TU, where 1 TU = 1024 microseconds. Advertised to STAs when Mode is Advertised. |
- |
2.22 |
|
AdvertisedExpectedDuration |
unsignedInt |
W |
Expected duration for which the advertised TID-to-Link Mapping will remain valid, in TU, where 1 TU = 1024 microseconds. Advertised to STAs when Mode is Advertised. |
- |
2.22 |
|
AdvertisedLinkMapFrequencyBands |
string[] |
W |
Comma-separated list of strings. Each item represents a frequency band whose link is included in the TID-to-Link Mapping advertised by this AP MLD. An empty string indicates that all available links are usable. Each list item is an enumeration of:
|
- |
2.22 |
|
Device.WiFi.bSTAMLD.{i}. |
object(0:) |
W |
Table of Multi-Link Operation (MLO) capable backhaul stations (bSTAs). Each instance groups one or more endpoint SSIDs across different radio bands into a single MLD for IEEE 802.11be Multi-Link Operation (MLO). An instance is created when one or more endpoint SSIDs are configured with the same MLDUnit value. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for MLDMACAddress. |
- |
2.22 |
|
MLDMACAddress |
string(:17) |
R |
[MACAddress] The Multi-Link Device (MLD) MAC Address of the MLO Capable bSTA. [EasyMesh] Source: Backhaul STA MLD Configuration TLV. |
- |
2.22 |
|
BSSID |
string(:17) |
R |
[MACAddress] The MLD MAC address of the upstream AP MLD that this bSTA MLD is associated to. [EasyMesh] source: Associated Clients TLV. |
- |
2.22 |
|
AffiliatedbSTAList |
string(:17)[] |
R |
[MACAddress] Comma-separated list of MAC Addresses. backhaul STA MAC addresses affiliated to this bSTA MLD. [EasyMesh] source: Backhaul STA MLD Configuration TLV. |
- |
2.22 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.22 |
|
Enable |
boolean |
W |
Enables or disables this bSTA MLD instance. |
false |
2.22 |
|
MLDID |
int |
WO |
MLD unit identifier. Matches the MLDUnit value configured on the affiliated endpoint SSIDs. Set only during instance creation and cannot be modified thereafter. Once it's been set, this parameter is immutable. |
- |
2.22 |
|
Device.WiFi.bSTAMLD.{i}.bSTAMLDConfig. |
object |
R |
This object describes the Multi-Link Operation (MLO) configuration of a Multi-Link Device (MLD) backhaul STA (bSTA). |
- |
2.22 |
|
EMLMREnabled |
boolean |
W |
Indicates if the Enhanced Multi-Link Multi-Radio (EMLMR) operation is enabled. |
- |
2.22 |
|
EMLSREnabled |
boolean |
W |
Indicates if Enhanced Multi-Link Single-Radio (EMLSR) operation is enabled. |
- |
2.22 |
|
STREnabled |
boolean |
W |
Indicates if Simultaneous Transmit and Receive (STR) operation is enabled. |
- |
2.22 |
|
NSTREnabled |
boolean |
W |
Indicates if Non-Simultaneous Transmit and Receive (NSTR) operation is enabled. |
- |
2.22 |
|
TIDLinkMapNegotiation |
boolean |
W |
Indicates if Traffic Identifier (TID) to Link Mapping Negotiation is enabled. [EasyMesh] source: TID-to-Link Mapping Policy TLV. |
- |
2.22 |
|
UseNeighborProfile |
boolean |
W |
When true, use the neighbor MLO profile if the own endpoint profile is disabled. When false, all bSTAMLD link endpoints must have provisioned and matching profiles in order to connect. |
true |
2.22 |
|
Device.WiFi.AccessPoint.{i}. |
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 CPEdevice 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 CPEdevice 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 CPEdevice MUST set Status to Error_Misconfigured and disable the offending AccessPoint row. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for SSIDReference. Changes since 2.21:
|
- |
2.0 |
|
Status |
string |
R |
Indicates the status of this access point. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.0 |
|
CpeOperationMode |
string |
W |
Reports information about the CPEdevice operation mode (router or bridge/range extender). Enumeration of:
|
Router |
2.14 |
|
Device.WiFi.AccessPoint.{i}.Security. |
object |
R |
This object contains security related parameters that apply to a CPEdevice acting as an Access Point [802.11-2007]. |
- |
2.0 |
|
EncryptionMode |
string[] |
W |
Comma-separated list of strings. The type of encryption in use. The valid values depend on ModeEnabled:
Each list item is an enumeration of:
Changes since 2.21:
|
- |
2.14 |
|
Device.WiFi.AccessPoint.{i}.Sensing. |
object |
R |
This object contains parameters related to Wi-Fi Sensing configuration. |
- |
2.22 |
|
UnassociatedSTAComebackEnabled |
boolean |
W |
Enables Unassociated STA Comeback behavior as per [802.11bf]. When UnassociatedSTAComebackEnabled is true:
When UnassociatedSTAComebackEnabled is false, Unassociated STA Comeback handling is disabled. |
- |
2.22 |
|
UnassociatedSTAComebackAfterExponent |
unsignedInt(0:7) |
W |
Specifies the Comeback After Exponent as specified in [802.11bf]. UnassociatedSTAComebackAfterExponent is the exponent n (0 to 7) used to calculate the minimum Unassociated STA Comeback After interval. The interval is measured in milliseconds and computed as 2^n+4^. |
6 |
2.22 |
|
UnassociatedSTAComebackBeforeExponent |
unsignedInt(0:3) |
W |
Specifies the Comeback Before Exponent as specified in [802.11bf]. UnassociatedSTAComebackBeforeExponent is the exponent n (0 to 3) used to calculate the maximum Unassociated STA Comeback Before interval. The interval is measured in milliseconds and computed as 2^n+12^. |
0 |
2.22 |
|
ExternalRequestPolicy |
string |
W |
Willingness to participate in externally requested sensing as a Responder. Enumeration of:
|
- |
2.22 |
|
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}. |
object(0:) |
R |
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. Changes since 2.21:
|
- |
2.0 |
|
MACAddress |
string(:17) |
R |
[MACAddress] The MAC address of an associated device. If the instance of this AssociatedDevice is the same as Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}., then this parameter is the same as Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.MACAddress. For a STA MLD, MACAddress is the MLD MAC Address, not an Affiliated STA MAC Address. The Affiliated STA MAC Addresses are reported in AffiliatedSTA. |
- |
2.0 |
|
Active |
boolean |
R |
Whether or not this node is currently present in the WiFi AccessPoint network. The ability to list inactive nodes is OPTIONAL. If the CPEdevice includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE.}}device. |
- |
2.0 |
|
APMLDMACAddress |
string(:17) |
R |
[MACAddress] The AP MLD MAC address to which the MLO station is connected. When APMLDMACAddress is set to the null MAC address, the station is not connected via MLO. |
- |
2.22 |
|
AffiliatedSTANumberOfEntries |
unsignedInt |
R |
The number of entries in the AffiliatedSTA table. |
- |
2.22 |
|
MLOMode |
string |
R |
The current Multi-Link Operation (MLO) mode of the associated device. Enumeration of:
|
- |
2.22 |
|
ActiveNumberOfAffiliatedSTA |
unsignedInt |
R |
The number of affiliated STA links, as reported in AffiliatedSTA, that are currently active. |
- |
2.22 |
|
FrequencyCapabilities |
string[] |
R |
Comma-separated list of strings. The frequency bands on which the associated device is capable of operating. Each list item is an enumeration of:
|
- |
2.22 |
|
UNIIBandsCapabilities |
string[] |
R |
Comma-separated list of strings. The U-NII bands on which the associated device is capable of operating. Each list item is an enumeration of:
|
- |
2.22 |
|
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.Stats. |
object |
R |
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 CPEdevice 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.8 |
|
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.AffiliatedSTA.{i}. |
object(1:) |
R |
This object describes stations (STAs, also called associated devices) that are affiliated to this Multi-Link Device (MLD) STA. This table MUST contain at least 1 entry. At most one entry in this table can exist with a given value for MACAddress. |
- |
2.22 |
|
MACAddress |
string(:17) |
R |
[MACAddress] The MAC address of the affiliated STA. |
- |
2.22 |
|
AccessPointReference |
string |
R |
The value MUST be the Path Name of a row in the Device.WiFi.AccessPoint. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The Device.WiFi.AccessPoint entry representing the access point via which the Multi-Link Device (MLD) access point provides the link represented by this AffiliatedSTA instance. |
- |
2.22 |
|
LinkID |
unsignedInt(0:15) |
R |
The Link ID of the affiliated AP that provides the connection for this AffiliatedSTA instance. |
- |
2.22 |
|
BSSID |
string(:17) |
R |
[MACAddress] The BSSID of the access point interface via which the Multi-Link Device (MLD) access point provides the link represented by this AffiliatedSTA instance. |
- |
2.22 |
|
FrequencyBand |
string |
R |
The frequency band on which this affiliated STA is connected. This is the same as the operating frequency band of the Radio of the access point to which this AffiliatedSTA instance is connected. Enumeration of:
|
- |
2.22 |
|
Active |
boolean |
R |
Whether this affiliated STA link is currently active. If false, the Stats. parameters show the state at the time of disconnection. |
- |
2.22 |
|
MaxSupportedBandwidth |
string |
R |
Specifies the maximum supported bandwidth for the Affiliated STA. Enumeration of:
|
- |
2.22 |
|
SignalStrength |
int(-200:0) |
R |
An indicator of radio signal strength of the uplink from the affiliated STA to the access point on this link, measured in dBm, as an average of the last 100 packets received from the affiliated STA. |
- |
2.22 |
|
LastDataDownlinkRate |
unsignedInt(1000:) |
R |
The data transmit rate in kbps that was most recently used for transmission of data from the access point to the affiliated STA on this link. |
- |
2.22 |
|
LastDataUplinkRate |
unsignedInt(1000:) |
R |
The data transmit rate in kbps that was most recently used for transmission of data from the affiliated STA to the access point on this link. |
- |
2.22 |
|
DownlinkRateSpec |
string |
R |
A string representation of the full rate specification that was most recently used for transmission of data from the access point to the affiliated STA on this link, e.g. the channel bandwidth, Modulation and Coding Scheme (MCS) index, and number of spatial streams. |
- |
2.22 |
|
UplinkRateSpec |
string |
R |
A string representation of the full rate specification that was most recently used for transmission of data from the affiliated STA to the access point on this link, e.g. the channel bandwidth, Modulation and Coding Scheme (MCS) index, and number of spatial streams. |
- |
2.22 |
|
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.AffiliatedSTA.{i}.Stats. |
object |
R |
These count bytes or packets sent to, or received from, this affiliated STA, which is one of the Multi-Link Operation (MLO) links of the associated device. |
- |
2.22 |
|
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytes transmitted to the affiliated STA on this link. |
- |
2.22 |
|
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytes received from the affiliated STA on this link. |
- |
2.22 |
|
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets transmitted to the affiliated STA on this link. |
- |
2.22 |
|
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packets received from the affiliated STA on this link. |
- |
2.22 |
|
ErrorsSent |
unsignedLong |
R |
[StatsCounter64] The number of packets that could not be transmitted to the affiliated STA on this link due to errors. |
- |
2.22 |
|
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.AffiliatedSTA.{i}.SensingCapabilities. |
object |
R |
This object is a copy of the sensing capabilities of the Affiliated STA as transmitted in the Sensing Capabilities IE defined in [Section 9.4.2.332/802.11bf]. |
- |
2.22 |
|
MaxTxBandwidth |
unsignedInt |
R |
Indicates the maximum bandwidth in MHz supported for any sensing NDP (null data physical layer protocol data unit) transmission. |
- |
2.22 |
|
MaxTxSTSLE80MHz |
unsignedInt |
R |
Indicates the maximum number of STS (space-time streams) supported for any sensing NDP transmission using bandwidths less than or equal to 80 MHz. |
- |
2.22 |
|
MaxTxSTS160MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP transmission using a bandwidth equal to 160 MHz. |
- |
2.22 |
|
MaxTxSTS320MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP transmission using a bandwidth equal to 320 MHz. |
- |
2.22 |
|
MaxRxSTSLE80MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using bandwidths less than or equal to 80 MHz. |
- |
2.22 |
|
MaxRxSTS160MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using a bandwidth equal to 160 MHz. |
- |
2.22 |
|
MaxRxSTS320MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using a bandwidth equal to 320 MHz. |
- |
2.22 |
|
MaxTxLTFRepetition |
unsignedInt |
R |
Indicates the maximum number of LTF (long training field) repetitions minus 1 supported for any sensing NDP transmission. |
- |
2.22 |
|
MaxRxLTFRepetition |
unsignedInt |
R |
Indicates the maximum number of LTF repetitions minus 1 supported for any sensing NDP reception. |
- |
2.22 |
|
MaxTxLTFTotal |
unsignedInt(4,8,16,64) |
R |
Indicates the maximum total number of LTF repetitions supported for any sensing NDP transmission, which includes all STS. |
- |
2.22 |
|
MaxRxLTFTotal |
unsignedInt(4,8,16,64) |
R |
Indicates the maximum total number of LTF repetitions supported for any sensing NDP reception, which includes all STS. |
- |
2.22 |
|
MaxSupportedSessions |
unsignedInt |
R |
Indicates maximum number of concurrent sessions supported as a Sensing Responder. |
- |
2.22 |
|
MinMeasurementInterval |
unsignedInt |
R |
Indicates the minimum time between two consecutive non-TB (non-trigger-based) measurement exchanges, in 100 usec. |
- |
2.22 |
|
Sensing20MHzOnlyTx |
boolean |
R |
Indicates support for a Sensing Transmitter role only in a bandwidth of 20 MHz. |
- |
2.22 |
|
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.SensingCapabilities. |
object |
R |
This object is a copy of the sensing capabilities of the Associated Devices as transmitted in the Sensing Capabilities IE defined in [Section 9.4.2.332/802.11bf]. |
- |
2.22 |
|
MaxTxBandwidth |
unsignedInt |
R |
Indicates the maximum bandwidth in MHz supported for any sensing NDP (null data physical layer protocol data unit) transmission. |
- |
2.22 |
|
MaxTxSTSLE80MHz |
unsignedInt |
R |
Indicates the maximum number of STS (space-time streams) supported for any sensing NDP transmission using bandwidths less than or equal to 80 MHz. |
- |
2.22 |
|
MaxTxSTS160MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP transmission using a bandwidth equal to 160 MHz. |
- |
2.22 |
|
MaxTxSTS320MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP transmission using a bandwidth equal to 320 MHz. |
- |
2.22 |
|
MaxRxSTSLE80MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using bandwidths less than or equal to 80 MHz. |
- |
2.22 |
|
MaxRxSTS160MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using a bandwidth equal to 160 MHz. |
- |
2.22 |
|
MaxRxSTS320MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using a bandwidth equal to 320 MHz. |
- |
2.22 |
|
MaxTxLTFRepetition |
unsignedInt |
R |
Indicates the maximum number of LTF (long training field) repetitions minus 1 supported for any sensing NDP transmission. |
- |
2.22 |
|
MaxRxLTFRepetition |
unsignedInt |
R |
Indicates the maximum number of LTF repetitions minus 1 supported for any sensing NDP reception. |
- |
2.22 |
|
MaxTxLTFTotal |
unsignedInt(4,8,16,64) |
R |
Indicates the maximum total number of LTF repetitions supported for any sensing NDP transmission, which includes all STS. |
- |
2.22 |
|
MaxRxLTFTotal |
unsignedInt(4,8,16,64) |
R |
Indicates the maximum total number of LTF repetitions supported for any sensing NDP reception, which includes all STS. |
- |
2.22 |
|
MaxSupportedSessions |
unsignedInt |
R |
Indicates maximum number of concurrent sessions supported as a Sensing Responder. |
- |
2.22 |
|
MinMeasurementInterval |
unsignedInt |
R |
Indicates the minimum time between two consecutive non-TB (non-trigger-based) measurement exchanges, in 100 usec. |
- |
2.22 |
|
Sensing20MHzOnlyTx |
boolean |
R |
Indicates support for a Sensing Transmitter role only in a bandwidth of 20 MHz. |
- |
2.22 |
|
Device.WiFi.AccessPoint.{i}.AC.{i}. |
object(4:4) |
R |
This object contains parameters related to WiFi QoS for different 802.11e access categories (priorities). Access categories are: BE, BK, VI, and VO. These parameters can help control and monitor 802.11e Enhanced distributed channel access (EDCA). The size of this table is fixed, with four entries which are identified by the AccessCategory parameter as follows:
This table MUST contain exactly 4 entries. At most one entry in this table can exist with a given value for AccessCategory, or with a given value for Alias. |
- |
2.8 |
|
Device.WiFi.AccessPoint.{i}.AC.{i}.Stats. |
object |
R |
This object contains statistics for different 802.11e access categories (priorities). Packet counters here count 802.11 WiFi frames. If there are not separate stats for each access category, (e.g., 802.11e is not used and there is only one queue), then only access category 0 = BE applies (e.g., the statistics for the single queue are in access category 0 = BE). The CPEdevice MUST reset the Access Point's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the Access Point becomes operationally down due to a previous administrative down (i.e. the Access Point's Status parameter transitions to a Disabled state) or when the Access Point becomes administratively up (i.e. the Access Point's Enable parameter transitions from false to true). Administrative and operational status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.8 |
|
Device.WiFi.EndPoint.{i}. |
object(0:) |
W |
This object models an 802.11 connection from the perspective of a wireless end point. Each EndPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter, and an associated active Profile instance via the ProfileReference parameter. The active profile is responsible for specifying the actual SSID and security settings used by the end point. For enabled table entries, if SSIDReference or ProfileReference is not a valid reference then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. Note: The EndPoint table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPEdevice will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated EndPoint row to then violate the table's unique key constraint; if this occurs, the CPEdevice MUST set Status to Error_Misconfigured and disable the offending EndPoint row. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for SSIDReference. Changes since 2.21:
|
- |
2.0 |
|
Status |
string |
R |
Indicates the status of this end point. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.0 |
|
PeerAffiliatedMACAddress |
string(:17) |
R |
[MACAddress] The peer link MAC address (i.e. AP side) of the established bSTAMLD link. Only relevant when this endpoint is part of a connected Wi-Fi 7 bSTA MLO connection. Set to the null MAC address otherwise. |
- |
2.22 |
|
ConnectionStatus |
string |
R |
The current connection status of this endpoint. Enumeration of:
|
Disabled |
2.22 |
|
PASNNumberOfEntries |
unsignedInt |
R |
The number of entries in the PASN table. |
- |
2.22 |
|
Device.WiFi.EndPoint.{i}.Profile.{i}. |
object(0:) |
W |
EndPoint Profile table. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of SSID, Location and Priority. |
- |
2.0 |
|
Status |
string |
R |
Indicates the status of this Profile. Enumeration of:
The Active value is reserved for the instance that is actively connected. The Available value represents an instance that is not currently active, but is also not disabled or in error. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.0 |
|
Device.WiFi.EndPoint.{i}.Sensing. |
object |
R |
This object contains parameters related to Wi-Fi Sensing configuration. |
- |
2.22 |
|
ExternalRequestPolicy |
string |
W |
Willingness to participate in externally requested sensing as a Responder. Enumeration of:
|
- |
2.22 |
|
Device.WiFi.EndPoint.{i}.PASN.{i}. |
object(1:) |
R |
Each table entry represents a Wi-Fi Sensing PASN (Pre-Association Security Negotiation) Associations. This table MUST contain at least 1 entry. At most one entry in this table can exist with a given value for BSSID. |
- |
2.22 |
|
BSSID |
string(:17) |
R |
[MACAddress] This parameter indicates the BSSID to which the EndPoint has a PASN (Pre-Association Security Negotiation) association. |
- |
2.22 |
|
Device.WiFi.EndPoint.{i}.PASN.{i}.SensingCapabilities. |
object |
R |
This object contains the Wi-Fi Sensing capabilities of the BSS, as defined in Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.SensingCapabilities.. |
- |
2.22 |
|
MaxTxBandwidth |
unsignedInt |
R |
Indicates the maximum bandwidth in MHz supported for any sensing NDP (null data physical layer protocol data unit) transmission. |
- |
2.22 |
|
MaxTxSTSLE80MHz |
unsignedInt |
R |
Indicates the maximum number of STS (space-time streams) supported for any sensing NDP transmission using bandwidths less than or equal to 80 MHz. |
- |
2.22 |
|
MaxTxSTS160MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP transmission using a bandwidth equal to 160 MHz. |
- |
2.22 |
|
MaxTxSTS320MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP transmission using a bandwidth equal to 320 MHz. |
- |
2.22 |
|
MaxRxSTSLE80MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using bandwidths less than or equal to 80 MHz. |
- |
2.22 |
|
MaxRxSTS160MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using a bandwidth equal to 160 MHz. |
- |
2.22 |
|
MaxRxSTS320MHz |
unsignedInt |
R |
Indicates the maximum number of STS supported for any sensing NDP reception using a bandwidth equal to 320 MHz. |
- |
2.22 |
|
MaxTxLTFRepetition |
unsignedInt |
R |
Indicates the maximum number of LTF (long training field) repetitions minus 1 supported for any sensing NDP transmission. |
- |
2.22 |
|
MaxRxLTFRepetition |
unsignedInt |
R |
Indicates the maximum number of LTF repetitions minus 1 supported for any sensing NDP reception. |
- |
2.22 |
|
MaxTxLTFTotal |
unsignedInt(4,8,16,64) |
R |
Indicates the maximum total number of LTF repetitions supported for any sensing NDP transmission, which includes all STS. |
- |
2.22 |
|
MaxRxLTFTotal |
unsignedInt(4,8,16,64) |
R |
Indicates the maximum total number of LTF repetitions supported for any sensing NDP reception, which includes all STS. |
- |
2.22 |
|
MaxSupportedSessions |
unsignedInt |
R |
Indicates maximum number of concurrent sessions supported as a Sensing Responder. |
- |
2.22 |
|
MinMeasurementInterval |
unsignedInt |
R |
Indicates the minimum time between two consecutive non-TB (non-trigger-based) measurement exchanges, in 100 usec. |
- |
2.22 |
|
Sensing20MHzOnlyTx |
boolean |
R |
Indicates support for a Sensing Transmitter role only in a bandwidth of 20 MHz. |
- |
2.22 |
|
Device.WiFi.EndPoint.{i}.AC.{i}. |
object(4:4) |
R |
This object contains parameters related to WiFi QoS for different 802.11e access categories (priorities). Access categories are: BE, BK, VI, and VO. These parameters can help control and monitor 802.11e Enhanced distributed channel access (EDCA). The size of this table is fixed, with four entries which are identified by the AccessCategory parameter as follows:
This table MUST contain exactly 4 entries. At most one entry in this table can exist with a given value for AccessCategory, or with a given value for Alias. |
- |
2.8 |
|
Device.WiFi.EndPoint.{i}.AC.{i}.Stats. |
object |
R |
This object contains statistics for different 802.11e access categories (priorities). Packet counters here count 802.11 WiFi frames. If there are not separate stats for each access category, (e.g., 802.11e is not used and there is only one queue), then only access category 0 = BE applies (e.g., the statistics for the single queue are in access category 0 = BE). The CPEdevice MUST reset the EndPoint's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the EndPoint becomes operationally down due to a previous administrative down (i.e. the EndPoint's Status parameter transitions to a Disabled state) or when the EndPoint becomes administratively up (i.e. the EndPoint's Enable parameter transitions from false to true). Administrative and operational status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.8 |
|
Device.Thread. |
object |
R |
The Thread object is based on the Thread Group specifications: Thread 1.3.0 Specification [ThreadSpec]. It defines interface object (Radio and MLE), and application object (BorderRouter). Changes since 2.21:
|
- |
2.19 |
|
BorderRouterNumberOfEntries |
unsignedInt |
R |
The number of entries in the BorderRouter table. Changes since 2.21:
|
- |
2.19 |
|
BorderAgentNumberOfEntries |
unsignedInt |
R |
The number of entries in the BorderAgent table. |
- |
2.22 |
|
RadioNumberOfEntries |
unsignedInt |
R |
The number of entries in the Radio table. Changes since 2.21:
|
- |
2.19 |
|
MLENumberOfEntries |
unsignedInt |
R |
The number of entries in the MLE table. Changes since 2.21:
|
- |
2.19 |
|
NodeNumberOfEntries |
unsignedInt |
R |
The number of entries in the Node table. Changes since 2.21:
|
- |
2.19 |
|
Device.Thread.BorderRouter.{i}. |
object(0:) |
R |
The BorderRouter is capable of forwarding between a Thread Network and a non-Thread Network. Each BorderRouter entry is associated with a particular Thread Network (or MLE) instance via the MLEReference parameter. Note: the BorderAgentID unique key was deprecated in favor of BorderAgentReference since 2.22 with the introduction of BorderAgent representing the Border Agent capabilities. At most one entry in this table can exist with a given value for Alias, or with a given value for BorderAgentReference. Changes since 2.21:
|
- |
2.19 |
|
Status |
string |
R |
Indicates the status of this border router. Enumeration of:
Changes since 2.21:
|
- |
2.19 |
|
BorderAgentID |
hexBinary(16) |
R |
Globally unique ID generated by the Thread Border Router. This parameter was DEPRECATED in 2.22 because it was moved to BorderAgent.{i}. Changes since 2.21:
|
- |
2.19 |
|
BorderAgentReference |
string |
W |
The value MUST be the Path Name of a row in the BorderAgent. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Reference to the BorderAgent entry representing the Border Agent function associated with this Border Router. |
- |
2.22 |
|
Device.Thread.BorderAgent.{i}. |
object(0:) |
R |
A Border Agent is a Thread device relaying Mesh Commissioning Protocol (MeshCoP) messages between a Thread Network and a Commissioner. The Commissioner may be reachable via either a non-Thread Network (External Commissioner) or a Thread Network (Native Commissioner). The Border Agent requires a Thread Interface to operate and may coexist with any other Thread role except the Joiner. Each entry in this table represents a Thread Border Agent service and its Thread Administration Sharing (TAS) capability. At most one entry in this table can exist with a given value for Alias, or with a given value for ID. |
- |
2.22 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.22 |
|
Enable |
boolean |
W |
Enables or disables the Border Agent service on the device. |
- |
2.22 |
|
ID |
hexBinary(16) |
R |
The globally unique ID generated by the Thread Border Agent that uniquely identifies the device. |
- |
2.22 |
|
State |
string |
R |
Current state of the BorderAgent, Mesh Commissioning Protocol (MeshCoP) over Pre-Shared Key for commissioning (PSKc). Enumeration of:
|
- |
2.22 |
|
SessionNumberOfEntries |
unsignedInt |
R |
The number of entries in the Session table. |
- |
2.22 |
|
Device.Thread.BorderAgent.{i}.Session.{i}. |
object(0:) |
R |
Represents current Border Agent sessions used to commission a Thread Device onto the Thread Network using MeshCoP (Mesh Commissioning Protocol). Each entry in the table represents a session as reported by the Border Agent service. The session advertised through the _meshcop-e._udp service for the Thread Administration Sharing (TAS) is not considered here. At most one entry in this table can exist with the same values for both Address and Port, or with a given value for Alias. |
- |
2.22 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.22 |
|
Address |
string(:45) |
R |
[IPv6Address] Peer IPv6 address for the session. |
- |
2.22 |
|
Port |
unsignedInt(1:65535) |
R |
UDP port of the _meshcop._udp service. |
- |
2.22 |
|
Connected |
boolean |
R |
Connected is true if the Border Agent session is currently connected. |
- |
2.22 |
|
IsCommissioner |
boolean |
R |
IsCommissioner is true if the Border Agent session is accepted as the full Commissioner. |
- |
2.22 |
|
Lifetime |
unsignedLong |
R |
Session lifetime in milliseconds since the session was established. |
- |
2.22 |
|
Device.Thread.BorderAgent.{i}.TAS. |
object |
R |
Controls and monitors Thread Administration Sharing (TAS) session using ephemeral PSKc (ePSKc): start/stop window, state/port reporting, and PasscodeURI for user interactions. |
- |
2.22 |
|
State |
string |
R |
The TAS state of the Border Agent's Ephemeral Key Manager. Enumeration of:
|
- |
2.22 |
|
DefaultPort |
unsignedInt(1:65535) |
W |
Default UDP port of the _meshcop-e._udp service when TAS is active (distinct from _meshcop._udp port). |
- |
2.22 |
|
DefaultTimeout |
unsignedLong |
W |
Default TAS window duration in milliseconds. |
- |
2.22 |
|
DefaultMaxFailedAttempts |
unsignedInt(0:255) |
W |
Maximum allowed failed DTLS connection attempts in a TAS window before automatic deactivation. |
- |
2.22 |
|
PasscodeLength |
unsignedInt(:255) |
W |
Length of the Thread Administrator Passcode (ePSKc). The default value SHOULD be 9. |
- |
2.22 |
|
PasscodeURI |
string |
R |
URN [RFC8141] carrying the passcode digits: "urn:thread:pc:<digits>". Non-empty only while State is Started. PasscodeURI is cleared when State transitions to Connected or Stopped or Disabled. |
- |
2.22 |
|
Device.Thread.Radio.{i}. |
object(0:) |
R |
This object models an 802.15.4 wireless radio ([802.15.4-2020]) on the device (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. Changes since 2.21:
|
- |
2.19 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.19 |
|
TransmitPowerSupported |
int(-1:100)[] |
R |
Comma-separated list of integers (-1 to 100). List items represent supported transmit power levels as percentage of full power. For example, "0,25,50,75,100". A -1 item indicates auto mode (automatic decision by CPE).device). Auto mode allows the Radio to adjust transmit power accordingly. For example, this can be useful for power-save modes such as EU-CoC, where the Radio can adjust power according to activity in the CPE.}}device. Changes since 2.21:
|
- |
2.19 |
|
HardwareVersion |
string |
R |
This radio's Thread hardware version. Changes since 2.21:
|
- |
2.19 |
|
FirmwareVersion |
string |
R |
This radio's Thread firmware version. Changes since 2.21:
|
- |
2.19 |
|
Device.Thread.Radio.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice 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.19 |
|
Device.Thread.MLE.{i}. |
object(0:) |
W |
This object models the Mesh Link Establishment (MLE) (a stackable interface object as described in [Section 4.2/TR-181i2]) used to establish and configure secure radio link of Thread network. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.19 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.19 |
|
SupportedStandards |
string[] |
R |
Comma-separated list of strings. The items in the list indicate the supported Thread version. The associated border router can only support one standard at a time. Each list item is an enumeration of:
Changes since 2.21:
|
- |
2.19 |
|
OperatingStandard |
string |
R |
The value MUST be a member of the list reported by the SupportedStandards parameter. The operating standard this MLE instance is configured for. Changes since 2.21:
|
- |
2.19 |
|
DatasetNumberOfEntries |
unsignedInt |
R |
The number of entries in the Dataset table. Changes since 2.21:
|
- |
2.19 |
|
AssociatedNodeNumberOfEntries |
unsignedInt |
R |
The number of entries in the AssociatedNode table. Changes since 2.21:
|
- |
2.19 |
|
Device.Thread.MLE.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice 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.19 |
|
Device.Thread.MLE.{i}.LeaderData. |
object |
R |
Indicates the leader data. Changes since 2.21:
|
- |
2.19 |
|
DataVersion |
unsignedInt(0:65535) |
R |
The full Network Data Version the Node currently uses. Changes since 2.21:
|
- |
2.19 |
|
LeaderRouterID |
unsignedInt(0:65535) |
R |
The 8-bit LeaderRouterID the Node attempts to utilize upon becoming a router or leader on the Thread network. Changes since 2.21:
|
- |
2.19 |
|
PartitionID |
unsignedInt |
R |
The Thread Leader Partition ID for the Thread network to which the Node is joined. Changes since 2.21:
|
- |
2.19 |
|
StableDataVersion |
unsignedInt(0:65535) |
R |
The Network Data Version for the stable subset of data the Node currently uses. Changes since 2.21:
|
- |
2.19 |
|
Weighting |
unsignedInt(0:65535) |
R |
The Thread Leader weight used when operating in the Leader role. Changes since 2.21:
|
- |
2.19 |
|
Device.Thread.MLE.{i}.Dataset.{i}. |
object(0:2) |
R |
Thread network configuration parameters are managed using an active and one optional pending Operational Dataset objects. The active Operational Dataset includes parameters (defined in the Thread specification, see [ThreadSpec]) that are currently in use across an entire Thread network. The active Operational Dataset contains:
The pending Operational Dataset is used to communicate changes to the active Operational Dataset before they take effect. The pending Operational Dataset contains all the parameters from the Active Operational Dataset, with the addition of: Delay Timer. This table MUST contain at least 0 and at most 2 entries. At most one entry in this table can exist with a given value for Status, or with a given value for Alias. Changes since 2.21:
|
- |
2.19 |
|
Status |
string |
R |
Indicates the status of this dataset. Enumeration of:
Changes since 2.21:
|
- |
2.19 |
|
TimeStamp |
dateTime |
R |
TimeStamp of the dataset, depending status, it represent :
Changes since 2.21:
|
- |
2.19 |
|
DelayTimer |
unsignedInt |
R |
An unsigned 32-bit number in milliseconds indicate the Time Remaining when pending Dataset will be activated. This value MUST be 0 for active dataset. Changes since 2.21:
|
- |
2.19 |
|
Channel |
unsignedInt(0:255) |
R |
The IEEE 802.15.4 channel value of the interface defined in [ThreadSpec] (Thread specification only supports the 2450 MHz channels). Changes since 2.21:
|
- |
2.19 |
|
NetworkName |
string |
R |
The name of the network link to the interface. Changes since 2.21:
|
- |
2.19 |
|
PanID |
hexBinary(2) |
R |
The IEEE 802.15.4 PAN ID value link to the interface. Changes since 2.21:
|
- |
2.19 |
|
ExtendedPanID |
hexBinary(8) |
R |
The IEEE 802.15.4 ExtPAN ID value link to the interface. Changes since 2.21:
|
- |
2.19 |
|
MeshLocalPrefix |
string(:49) |
R |
[IPv6Prefix] Indicate the mesh-local IPv6 prefix for the Thread network. Changes since 2.21:
|
- |
2.19 |
|
ChannelMask |
hexBinary(4) |
R |
Indicates the channels within channel page 0, in the 2.4GHz ISM band. The channels are represented in most significant bit order, with bit value 1 meaning selected, bit value 0 meaning unselected. Changes since 2.21:
|
- |
2.19 |
|
PSKc |
hexBinary(16) |
R |
Pre-Shared Key Credential for inband commissioning. Changes since 2.21:
|
- |
2.19 |
|
NetworkKey |
hexBinary(16) |
R |
Key of the network. Changes since 2.21:
|
- |
2.19 |
|
Device.Thread.MLE.{i}.Dataset.{i}.SecurityPolicy. |
object |
R |
The SecurityPolicy provide an administrator a way to enable or disable certain security related behaviors. Changes since 2.21:
|
- |
2.19 |
|
RotationTime |
unsignedInt(0:65535) |
R |
The rotation time of the security policy. Changes since 2.21:
|
- |
2.19 |
|
Flags |
string[] |
R |
Comma-separated list of strings. The flags indicates the current security policies for the Thread partition of the current dataset. The Flags is an ordered concatenation of case sensitive characters containing list elements (may be empty). Each list item is an enumeration of:
Changes since 2.21:
|
- |
2.19 |
|
Device.Thread.MLE.{i}.AssociatedNode.{i}. |
object(0:) |
R |
A table of the nodes currently associated to the Thread network defined by this MLE. instance. This includes the host nodes. At most one entry in this table can exist with a given value for Alias, or with a given value for ExtendedMAC. Changes since 2.21:
|
- |
2.19 |
|
LastContactTime |
dateTime |
R |
The date and time in UTC when associated Thread node on the device has received data from remote node. Changes since 2.21:
|
- |
2.19 |
|
ExtendedMAC |
hexBinary(16) |
R |
Unique MacID of the node. Changes since 2.21:
|
- |
2.19 |
|
Rloc16 |
unsignedInt(0:65535) |
R |
Rloc of the node. Changes since 2.21:
|
- |
2.19 |
|
RoutingRole |
string |
R |
The current state of the Thread node. Enumeration of:
Changes since 2.21:
|
- |
2.19 |
|
Mode |
string |
R |
Thread Device mode value. Enumeration of:
Changes since 2.21:
|
- |
2.19 |
|
RouteNumberOfEntries |
unsignedInt |
R |
The number of entries in the Route table. Changes since 2.21:
|
- |
2.19 |
|
NeighborNumberOfEntries |
unsignedInt |
R |
The number of entries in the Neighbor table. Changes since 2.21:
|
- |
2.19 |
|
IPv6AddressNumberOfEntries |
unsignedInt |
R |
The number of entries in the IPv6Address table. Changes since 2.21:
|
- |
2.19 |
|
Device.Thread.MLE.{i}.AssociatedNode.{i}.Neighbor.{i}. |
object(0:) |
R |
Entries in this table reference nodes that are immediate neighbors of the associated node instance. This table is empty if the RoutingRole is not a Router or Leader. At most one entry in this table can exist with a given value for NodeReference. Changes since 2.21:
|
- |
2.19 |
|
NodeReference |
string |
R |
The value MUST be the Path Name of a row in the AssociatedNode. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. References the Thread node that is an immediate neighbor of the AssociatedNode. By construction the RoutingRole of AssociatedNode MUST be Router or Leader. Changes since 2.21:
|
- |
2.19 |
|
AvgRSSI |
unsignedInt |
R |
The average Received Signal Strength Indicator (RSSI) is the average measurement of the signal strength received by the parent router node from the neighbor node. Changes since 2.21:
|
- |
2.19 |
|
Device.Thread.MLE.{i}.AssociatedNode.{i}.Route.{i}. |
object(0:) |
R |
Entries in this table depend on the associated node routing capabilities defined by the RoutingRole and Mode according to the Thread Specification (i.e. a child node has an empty Route table). It maintains information for each link to Router neighbor as follows:
At most one entry in this table can exist with a given value for ID. Changes since 2.21:
|
- |
2.19 |
|
ID |
unsignedInt(0:65535) |
R |
Router ID of the route table entry. Changes since 2.21:
|
- |
2.19 |
|
PathCost |
unsignedInt(0:65535) |
R |
The routing cost advertised by the Next Hop to reach ID. Changes since 2.21:
|
- |
2.19 |
|
LQIn |
unsignedInt(0:3) |
R |
[ThreadLinkQuality] Link Quality for messages received from ID, depending on the Link Margin value average of the received relative signal strength. Changes since 2.21:
|
- |
2.19 |
|
LQOut |
unsignedInt(0:3) |
R |
[ThreadLinkQuality] Link Quality for messages sent to ID, depending on the Link Margin value average of the sent relative signal strength. Changes since 2.21:
|
- |
2.19 |
|
Device.Thread.MLE.{i}.AssociatedNode.{i}.IPv6Address.{i}. |
object(0:) |
R |
This object represents the list of IPv6 addresses associated with the Thread node. At most one entry in this table can exist with the same values for both Alias and IPAddress. Changes since 2.21:
|
- |
2.19 |
|
Type |
string |
R |
The IPv6 address may be of one the following types. Enumeration of:
Changes since 2.21:
|
- |
2.19 |
|
IPAddress |
string(:45) |
R |
[IPv6Address] Router ID of the route table entry. Changes since 2.21:
|
- |
2.19 |
|
Device.Thread.Node.{i}. |
object(0:) |
R |
The table of nodes hosted on the device. At most one entry in this table can exist with a given value for ExtendedMAC. Changes since 2.21:
|
- |
2.19 |
|
ExtendedMAC |
hexBinary(16) |
R |
Unique MacID of the node. Changes since 2.21:
|
- |
2.19 |
|
MLEReference |
string |
R |
The value MUST be the Path Name of a row in the MLE. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Connect the node to the Thread network managed by the Mesh Link Established. Changes since 2.21:
|
- |
2.19 |
|
Device.ZigBee. |
object |
R |
Top level object for ZigBee capabilities based on the [ZigBee2007] specification. |
- |
2.7 |
|
Device.ZigBee.Interface.{i}. |
object(0:) |
R |
ZigBee interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the ZigBee interface of a ZigBee end device, ZigBee router or ZigBee coordinator. 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 ZDOReference. |
- |
2.7 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.7 |
|
Device.ZigBee.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice 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.7 |
|
UnknownPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of ZigBee packets received which were discarded because of an unknown or unsupported protocol. This parameter was DEPRECATED in 2.19 because its name is a typo of UnknownProtoPacketsReceived. This parameter was OBSOLETED in 2.21. This parameter was DELETED in 2.22. Active Notification requests for this parameter MAY be denied. Changes since 2.21:
|
- |
2.7 |
|
Device.ZigBee.Interface.{i}.AssociatedDevice.{i}. |
object(0:) |
R |
This table provides information about other ZigBee devices that are directly accessible via this interface. At most one entry in this table can exist with the same values for both IEEEAddress and NetworkAddress. It is possible that instances of this object have the same key value when the value of IEEEAddress parameter is "FF:FF:FF:FF:FF:FF:FF:FF" and the ZigBee Coordinators on two or more separate area networks assign the same value for the NetworkAddress. This is because the ZigBee specification describes only intra-area network topologies [Section 1.1.4 Network Topology/ZigBee2007]. As such if two or more AssociatedDevice instances have the same key value the implementation is undefined. |
- |
2.7 |
|
Active |
boolean |
R |
Whether or not this device is currently present in the ZigBee network as defined in [Section 2.4.4.1/ZigBee2007]. The ability to list inactive devices is OPTIONAL. If the CPEdevice includes inactive devices in this table, Active MUST be set to false for each inactive device. The length of time an inactive device remains listed in this table is a local matter to the CPE.}}device. |
- |
2.7 |
|
Device.ZigBee.Discovery. |
object |
R |
This object is used for managing the discovery of ZigBee devices within a ZigBee Area Network. ZigBee Devices are discovered via the ZDO instance associated with the ZigBee Coordinator of an Area Network. |
- |
2.7 |
|
Device.ZigBee.Discovery.AreaNetwork.{i}. |
object(0:) |
W |
This object specifies the ZigBee devices that are discovered by the Coordinator. As the ZigBee specification does not provide a discovery protocol between the CWMP proxy and the ZigBee coordinator, the AreaNetwork object is provisioned and not discovered. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Coordinator. |
- |
2.7 |
|
Coordinator |
string(:256) |
W |
The Fully Qualified Domain Name (FQDN) or IP address of the ZigBee Coordinator. The coordinator MAY be located within the CPE.device. In this scenario the Controller or CPEdevice MAY use the value of "localhost". |
- |
2.7 |
|
Device.Bridging. |
object |
R |
Layer 2 bridging configuration. Specifies bridges between different layer 2 interfaces. Bridges can be defined to include layer 2 filter criteria to selectively bridge traffic between interfaces. This object can be used to configure both 802.1D [802.1D-2004] and 802.1Q [802.1Q-2011] bridges. Not all 802.1D and 802.1Q features are modeled, and some additional features not present in either 802.1D or 802.1Q are modeled. 802.1Q [802.1Q-2011] bridges incorporate 802.1Q [802.1Q-2005] customer and 802.1ad [802.1ad-2005] provider bridges. |
- |
2.0 |
|
MaxBridgeEntries |
unsignedInt |
R |
The maximum number of entries available in the Bridge table.}} When this limit is reached, creating a new entry fails. A value of 0 means no limit. |
- |
2.0 |
|
MaxDBridgeEntries |
unsignedInt |
R |
The maximum number of 802.1D [802.1D-2004] entries available in the Bridge table. A positive value for this parameter implies support for 802.1D. There is no guarantee that this many 802.1D Bridges can be configured. For example, the CPEdevice might not be able simultaneously to support both 802.1D and 802.1Q Bridges. |
- |
2.0 |
|
MaxQBridgeEntries |
unsignedInt |
R |
The maximum number of 802.1Q [802.1Q-2011] entries available in the Bridge table. A non-zero value for this parameter implies support for 802.1Q. There is no guarantee that this many 802.1Q Bridges can be configured. For example, the CPEdevice might not be able simultaneously to support both 802.1D and 802.1Q Bridges. |
- |
2.0 |
|
MaxProviderBridgeEntries |
unsignedInt |
R |
The maximum number of entries available in the ProviderBridge table. A non-zero value for this parameter implies support for 802.1Q Provider Bridges.}} When this limit is reached, creating a new entry fails. A value of 0 means no limit. |
- |
2.7 |
|
MaxFilterEntries |
unsignedInt |
R |
The maximum number of entries available in the Filter table.}} When this limit is reached, creating a new entry fails. A value of 0 means no limit. |
- |
2.0 |
|
Device.Bridging.Bridge.{i}. |
object(0:) |
W |
Bridge table. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.0 |
|
Status |
string |
R |
The status of this Bridge. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.0 |
|
Device.Bridging.Bridge.{i}.Port.{i}. |
object(0:) |
W |
Bridge port table, which MUST contain an entry for each bridge port (a stackable interface object as described in [Section 4.2/TR-181i2]). There are two types of bridge ports: management (upward facing) and non-management (downward facing). This is determined by configuring the Boolean ManagementPort parameter. The CPEdevice will automatically configure each management bridge port to appear in the interface stack above all non-management bridge ports that share the same Bridge instance. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.0 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.0 |
|
LowerLayers |
string[](:1024) |
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, or an empty string. See [Section 4.2.1/TR-181i2]. When ManagementPort is set to true the CPEdevice MUST set LowerLayers to reference all non-management bridge ports that are within the same Bridge instance (and update LowerLayers when subsequent non-management bridge ports are added or deleted on that Bridge). The Controller SHOULD NOT set LowerLayers in this case. |
<Empty> |
2.0 |
|
Device.Bridging.Bridge.{i}.Port.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.0 |
|
Device.Bridging.Bridge.{i}.Port.{i}.PriorityCodePoint. |
object |
R |
PriorityCodePoint provides the management control for the processing of the Priority Code Point (PCP) field for the 802.1Q header as defined in [Section 6.9.3 Priority Code Point Encoding/802.1Q-2011]. The object is applicable to deployments of Bridging.ProviderBridge where the Bridge instance is referenced by Bridging.ProviderBridge.{i}.SVLANcomponent or Bridging.ProviderBridge.{i}.CVLANcomponents parameters. |
- |
2.7 |
|
PCPEncoding |
string(31)[4:4]() |
W |
Comma-separated list (4 items) (length ) of strings (length 31). This parameter provides the management control for the processing of the encoding of the Priority Code Point (PCP) field for the 802.1Q header as defined in [Section 6.9.3 Priority Code Point Encoding/802.1Q-2011] and [Table 6-3/802.1Q-2011]. The list is an ordered list that contains entries for the following 4 PCP Values: "8P0D","7P1D", "6P2D" "5P3D". Each list entry matches the following pattern:}}{{div|{{classes}}| Each list item matches one of:
The value of this parameter MUST use square brackets to protect comma separators within nested lists. For example, this corresponds to Table 6-3 (mentioned above):
|
- |
2.7 |
|
PCPDecoding |
string(31)[4:4]() |
W |
Comma-separated list (4 items) (length ) of strings (length 31). This parameter provides the management control for the processing of the decoding of the Priority Code Point (PCP) field for the 802.1Q header as defined in [Section 6.9.3 Priority Code Point Encoding/802.1Q-2011] and [Table 6-4/802.1Q-2011]. The list is an ordered list that contains entries for the following 4 PCP Values: "8P0D","7P1D", "6P2D" "5P3D". Each list entry matches the following pattern: Each list item matches one of:
The value of this parameter MUST use square brackets to protect comma separators within nested lists. For example, this corresponds to Table 6-4 (mentioned above):
Changes since 2.21:
|
- |
2.7 |
|
Device.Bridging.Bridge.{i}.STP. |
object |
R |
STP (Spanning Tree Algorithm and Protocol) / RSTP (Rapid Spanning Tree Algorithm and Protocol) bridge configuration as defined in [802.1D-2004] and [802.1Q-2011]. |
- |
2.16 |
|
Status |
string |
R |
The status of the STP for this Bridge. The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. Enumeration of:
|
Disabled |
2.16 |
|
Device.Bridging.Bridge.{i}.VLAN.{i}. |
object(0:) |
W |
Bridge VLAN table. If this table is supported, ifit MUST contain an entry for each VLAN known to the Bridge. This table only applies to an 802.1Q [802.1Q-2011] Bridge. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for VLANID. |
- |
2.0 |
|
Device.Bridging.Bridge.{i}.VLANPort.{i}. |
object(0:) |
W |
Bridge VLAN egress port and untagged port membership table. This table only applies to an 802.1Q [802.1Q-2011] Bridge. Note: The VLANPort table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPEdevice will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated VLANPort row to then violate the table's unique key constraint; if this occurs, the CPEdevice MUST disable the offending VLANPort row. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both VLAN and Port. |
- |
2.0 |
|
Device.Bridging.Filter.{i}. |
object(0:) |
W |
Filter table containing classification filter entries, each of which expresses a set of classification criterion to classify ingress frames as member of a Bridge instance or a Bridge.{i}.VLAN instance. Bridge VLAN classification only applies for 802.1Q [802.1Q-2011] Bridges. For enabled table entries, if Bridge or Interface is an empty string then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. Several of this object's parameters specify DHCP option values. Some cases are version neutral (the parameter can apply to both DHCPv4 and DHCPv6), but in other cases the representation of the option is different for DHCPv4 and DHCPv6, so it is necessary to define separate DHCPv4-specific and DHCPv6-specific parameters. Therefore, an instance of this object that uses DHCP option values as filter criteria will be associated with either DHCPv4 or DHCPv6, as indicated by the DHCPType parameter. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.0 |
|
Status |
string |
R |
The status of this Filter table entry. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. If the bridge port table is supported, but none of its entries correspond to Interface, or if such an entry exists but is disabled, Status MUST NOT indicate Enabled. If the Bridge VLAN table is supported, but none of its entries correspond to VLANIDFilter, or if such an entry exists but is disabled, Status MUST NOT indicate Enabled. |
Disabled |
2.0 |
|
SourceMACFromVendorClassIDFilterv6 |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCPv6 Vendor Class Identifier (Option 16 as defined in [RFC9915]) was equal to the specified value. The option value is binary, so an exact match is REQUIRED. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address. Note: This parameter is DHCPv6-specific. It only applies when DHCPType is DHCPv6. |
<Empty> |
2.2 |
|
DestMACFromVendorClassIDFilterv6 |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCPv6 Vendor Class Identifier (Option 16 as defined in [RFC9915]) was equal to the specified value. The option value is binary, so an exact match is REQUIRED. Note: This parameter is DHCPv6-specific. It only applies when DHCPType is DHCPv6. |
<Empty> |
2.2 |
|
SourceMACFromClientIDFilter |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCP Client Identifier (via DHCP lease acquisition or renewal for DHCPv4) was equal to the specified value. The DHCP Client Identifier is Option 61 (as defined in [RFC2132]) for DHCPv4, or is Option 1 (as defined in [RFC9915]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. Note: DHCPv6 Option 1 (Client Identifier) is sometimes referred to as DUID. |
<Empty> |
2.0 |
|
DestMACFromClientIDFilter |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCP Client Identifier (via DHCP lease acquisition or renewal for DHCPv4) was equal to the specified value. The DHCP Client Identifier is Option 61 (as defined in [RFC2132]) for DHCPv4, or is Option 1 (as defined in [RFC9915]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. Note: DHCPv6 Option 1 (Client Identifier) is sometimes referred to as DUID. |
<Empty> |
2.0 |
|
SourceMACFromUserClassIDFilter |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCP User Class Identifier (via DHCP lease acquisition or renewal for DHCPv4) was equal to the specified value. The DHCP User Class Identifier is Option 77 (as defined in [RFC3004]) for DHCPv4, or is Option 15 (as defined in [RFC9915]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. |
<Empty> |
2.0 |
|
DestMACFromUserClassIDFilter |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCP User Class Identifier (via DHCP lease acquisition or renewal for DHCPv4) was equal to the specified value. The DHCP User Class Identifier is Option 77 (as defined in [RFC3004]) for DHCPv4, or is Option 15 (as defined in [RFC9915]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. |
<Empty> |
2.0 |
|
Device.Bridging.ProviderBridge.{i}. |
object(0:) |
W |
Provider Bridge table. A Provider Bridge is described in [Section 5.10 Provider Bridge conformance/802.1Q-2011] as an entity that is comprised of one S-VLAN component and zero or more C-VLAN components. S-VLAN and C-VLAN components are modelled as instances of Bridge objects. When Type is configured with value of PE VLAN tags from the S-VLAN component (outer of 2 VLAN tags) are stacked on top of the VLAN tag from the C-VLAN component (inner of 2 VLAN tags). When Type is configured with value of S-VLAN only VLAN tags from the S-VLAN component are utilized. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.7 |
|
Status |
string |
R |
The status of this ProviderBridge. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. For example when the Type is configured with value of PE but CVLANcomponents is an empty string. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.7 |
|
Device.PPP. |
object |
R |
Point-to-Point Protocol [RFC1661]. This object contains the Interface table. |
- |
2.0 |
|
Device.PPP.Interface.{i}. |
object(0:) |
W |
PPP interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.0 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.0 |
|
AutoDisconnectTime |
unsignedInt |
W |
The time in seconds since the establishment of the connection after which connection termination is automatically initiated by the CPE.device. This occurs irrespective of whether the connection is being used or not. A value of 0 (zero) indicates that the connection is not to be shut down automatically. |
- |
2.0 |
|
IdleDisconnectTime |
unsignedInt |
W |
The time in seconds that if the connection remains idle, the CPEdevice automatically terminates the connection. A value of 0 (zero) indicates that the connection is not to be shut down automatically. |
- |
2.0 |
|
ConnectionTrigger |
string |
W |
Trigger used to establish the PPP connection. Enumeration of:
Note that the reason for a PPP connection becoming disconnected to begin with might be either external to the CPE,device, such as termination by the BRAS or momentary disconnection of the physical interface, or internal to the CPE,device, such as use of the IdleDisconnectTime and/or AutoDisconnectTime parameters in this object. |
- |
2.0 |
|
Device.PPP.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.0 |
|
Device.PPP.Interface.{i}.PPPoE. |
object(0:1) |
R |
PPPoE object that functionally groups PPPoE related parameters. PPPoE is only applicable when the lower layer provides Ethernet frames, e.g. ATM with EoA, PTM, or anything else that supports an Ethernet MAC. This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time. Changes since 2.21:
|
- |
2.0 |
|
EthernetPriorityMark |
int(-1:7) |
W |
Ethernet priority code (as defined in [802.1Q-2011]) to mark egress PPPoE packets with. A value of -1 indicates no specific (re)marking; the Ethernet priority derived from the underlying VLAN termination interface (if any) is preserved. Any other value supersedes the priority set by the VLAN termination interface. The default value SHOULD be -1. |
- |
2.22 |
|
Device.IP. |
object |
R |
IP object that contains the Interface, ActivePort, and Diagnostics objects. |
- |
2.0 |
|
IPv4Status |
string |
R |
Indicates the status of the IPv4 stack. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.2 |
|
IPv6Status |
string |
R |
Indicates the status of the IPv6 stack. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.2 |
|
Device.IP.Interface.{i}. |
object(0:) |
W |
IP interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the layer 3 IP interface. Each IP interface can be attached to the IPv4 and/or IPv6 stack. The interface's IP addresses and prefixes are listed in the IPv4Address, IPv6Address and IPv6Prefix tables. Note that support for manipulating Loopback interfaces is OPTIONAL, so the implementation MAY choose not to create (or allow the Controller to create) Interface instances of type Loopback. When the Controller administratively disables the interface, i.e. sets Enable to false, the interface's automatically-assigned IP addresses and prefixes MAY be retained. When the Controller administratively enables the interface, i.e. sets Enable to true, these IP addresses and prefixes MUST be refreshed. It's up to the implementation to decide exactly what this means: it SHOULD take all reasonable steps to refresh everything but if it is unable, for example, to refresh a prefix that still has a significant lifetime, it might well choose to retain rather than discard it. Any Tunneled IP interface instances instantiated by the CPEdevice MUST NOT have any statistics, writable parameters, IP addresses or IPv6 prefixes. Any read-only parameters, e.g. Status, MUST return the same information as for the corresponding Tunnel interface. The reason for these rules is that Tunneled IP interfaces exist only in order to be the targets of references (within the data model) and do not model any concepts over and above those already modeled by the Tunnel IP interfaces. Note that Tunnel and Tunneled IP interfaces are part of a legacy mechanism that is only used for IPv6rd, DSLite and IPsec tunnels and MUST NOT be used in any other context. For all other tunneling mechanisms Normal IP interfaces are stacked above technology-specific Tunnel Interfaces, e.g. above GRE.Tunnel.{i}.Interface or MAP.Domain.{i}.Interface objects. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.0 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.0 |
|
Loopback |
boolean |
W |
When set to true, the IP interface becomes a loopback interface and the CPEdevice MUST set Type to Loopback. In this case, the CPEdevice MUST also set LowerLayers to an empty string and fail subsequent attempts at setting LowerLayers until the interface is no longer a loopback. Support for manipulating loopback interfaces is OPTIONAL. |
false |
2.0 |
|
Device.IP.Interface.{i}.IPv4Address.{i}. |
object(0:) |
W |
IPv4 address table. Entries are auto-created and auto-deleted as IP addresses are added and deleted via DHCP, auto-IP, 3GPP-NAS (3GPP Non Access Stratum), or IPCP. Static entries are created and configured by the Controller. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both IPAddress and SubnetMask. Changes since 2.21:
|
- |
2.0 |
|
Status |
string |
R |
The status of this IPv4Address table entry. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.2 |
|
LastChange |
unsignedInt |
R |
The accumulated time in seconds since this IPv4Address entry last changed its Status or IPAddress value. Active Notification requests for this parameter MAY be denied. |
- |
2.22 |
|
StatusChangeCount |
unsignedInt |
R |
The number of times this IPv4Address entry has changed its Status or IPAddress value since the last reboot. This includes recovery state changes. Active Notification requests for this parameter MAY be denied. |
- |
2.22 |
|
Device.IP.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.0 |
|
Device.IP.Interface.{i}.IPv6Address.{i}. |
object(0:) |
W |
This table contains the IP interface's IPv6 unicast addresses. There MUST be an entry for each such address, including anycast addresses. There are several ways in which entries can be added to and deleted from this table, including:
This table MUST NOT include entries for the Subnet-Router anycast address [Section 2.6.1/RFC4291]. Such entries would be identical to others but with a zero interface identifier, and would add no value. A loopback interface will always have address ::1 [Section 2.5.3/RFC4291] and MAY also have link-local address fe80::1. This object is based on ipAddressTable from [RFC4293]. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for IPAddress. Changes since 2.21:
|
- |
2.2 |
|
Status |
string |
R |
The status of this IPv6Address table entry. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.2 |
|
Origin |
string |
R |
Mechanism via which the IP address was assigned. Enumeration of:
This parameter is based on ipOrigin from [RFC4293]. |
Static |
2.2 |
|
LastChange |
unsignedInt |
R |
The accumulated time in seconds since this IPv6Address entry last changed its Status, IPAddressStatus, or IPAddress value. Active Notification requests for this parameter MAY be denied. |
- |
2.22 |
|
StatusChangeCount |
unsignedInt |
R |
The number of times this IPv6Address entry has changed its Status, IPAddressStatus, or IPAddress value since the last reboot. This includes recovery state changes. Active Notification requests for this parameter MAY be denied. |
- |
2.22 |
|
Device.IP.Interface.{i}.IPv6Prefix.{i}. |
object(0:) |
W |
This table contains the interface's IPv6 prefixes. There MUST be an entry for each such prefix, not only for prefixes learned from router advertisements. There are several ways in which entries can be added to and deleted from this table, including:
The CPEdevice MAY choose not to create IPv6Prefix entries for WellKnown prefixes or for the ULA /48 prefix [RFC4193]. If an IPv6Prefix entry exists for the ULA /48 prefix, it MUST be on a downstream interface (i.e. an interface for which the physical layer interface object has Upstream = false). This object is based on ipAddressPrefixTable from [RFC4293]. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Prefix. |
- |
2.2 |
|
Status |
string |
R |
The status of this IPv6Prefix table entry. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.2 |
|
Origin |
string |
R |
Mechanism via which the prefix was assigned or most recently updated. Enumeration of:
Note that:
Also note that a Child prefix's ParentPrefix will always be an AutoConfigured, PrefixDelegation, or RouterAdvertisement prefix. This parameter is based on ipAddressOrigin from [RFC4293]. |
Static |
2.2 |
|
StaticType |
string |
W |
Static prefix sub-type. For a Static prefix, this can be set to PrefixDelegation or Child, thereby creating an unconfigured prefix of the specified type that will be populated in preference to creating a new instance. This allows the Controller to pre-create "prefix slots" with known path names that can be referenced from elsewhere in the data model before they have been populated. Enumeration of:
This mechanism works as follows:
The prefix StaticType can only be modified if Origin is Static. |
Static |
2.2 |
|
Device.IP.Diagnostics. |
object |
R |
The IP Diagnostics object. |
- |
2.0 |
|
Device.IP.Diagnostics.IPPing. |
object |
R |
This object provides access to an IP-layer ping test. |
- |
2.0 |
|
DSCP |
unsignedInt(0:63) |
W |
DiffServ codepoint to be used for the test packets. By default the CPEdevice SHOULD set this value to zero. |
- |
2.0 |
|
Device.IP.Diagnostics.TraceRoute. |
object |
R |
This object defines access to an IP-layer trace-route test for the specified IP interface. |
- |
2.0 |
|
NumberOfTries |
unsignedInt(1:3) |
W |
Number of tries per hop. Set prior to running Diagnostic. By default, the CPEdevice SHOULD set this value to 3. |
- |
2.0 |
|
Timeout |
unsignedInt(1:) |
W |
Timeout in milliseconds for each hop of the trace route test. By default the CPEdevice SHOULD set this value to 5000. |
- |
2.0 |
|
DataBlockSize |
unsignedInt(1:65535) |
W |
Size of the data block in bytes to be sent for each trace route. By default, the CPEdevice SHOULD set this value to 38. |
- |
2.0 |
|
DSCP |
unsignedInt(0:63) |
W |
DiffServ codepoint to be used for the test packets. By default the CPEdevice SHOULD set this value to 0. |
- |
2.0 |
|
MaxHopCount |
unsignedInt(1:64) |
W |
The maximum number of hop used in outgoing probe packets (max TTL). By default the CPEdevice SHOULD set this value to 30. |
- |
2.0 |
|
Device.IP.Diagnostics.DownloadDiagnostics. |
object |
R |
This object defines the diagnostics configuration for a HTTP and FTP DownloadDiagnostics Test. Files received in the DownloadDiagnostics do not require file storage on the CPE device. Changes since 2.21:
|
- |
2.0 |
|
DownloadURL |
string(:2048) |
W |
The [URL] for the CPEdevice to perform the download on. This parameter MUST be in the form of a valid HTTP [RFC2616] or FTP [RFC959] URL.
Note: For time based tests (TimeBasedTestDuration > 0) the Controller MAY add a hint to duration of the test to the URL. See [Section 4.3/TR-143] for more details. |
- |
2.0 |
|
DownloadTransports |
string[] |
R |
Comma-separated list of strings. Supported DownloadDiagnostics transport protocols for a CPE device. Each list item is an enumeration of:
|
- |
2.0 |
|
NumberOfConnections |
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 DownloadDiagnosticsMaxConnections. |
- |
2.9 |
|
DownloadDiagnosticsMaxConnections |
unsignedInt(1:) |
R |
Indicates the maximum number of connections that are supported by Download Diagnostics. |
- |
2.22 |
|
DownloadDiagnosticMaxConnections |
unsignedInt(1:) |
R |
Indicates the maximum number of connections that are supported by Download Diagnostics. This parameter was DEPRECATED in 2.22 in favor of DownloadDiagnosticsMaxConnections. Changes since 2.21:
|
- |
2.9 |
|
DownloadDiagnosticsMaxIncrementalResult |
unsignedInt(1:) |
R |
The maximum number of rows in IncrementalResult that the CPEdevice will store. |
- |
2.9 |
|
Device.IP.Diagnostics.UDPEchoConfig. |
object |
R |
This object allows the CPEdevice to be configured to perform the UDP Echo Service defined in [RFC862] and UDP Echo Plus Service defined in [Appendix A.1/TR-143]. |
- |
2.0 |
|
Interface |
string(:256) |
W |
The value MUST be the Path Name of IP-layer interface over which the CPEdevice MUST listen and receive UDP echo requests on. The value of this parameter MUST be either a valid interface or an empty string. An attempt to set this parameter to a different value MUST be rejected as an invalid parameter value. If an empty string is specified, the CPEdevice MUST listen and receive UDP echo requests on all interfaces. Note: Interfaces behind a NAT MAY require port forwarding rules configured in the Gateway to enable receiving the UDP packets. |
- |
2.0 |
|
SourceIPAddress |
string(:45) |
W |
[IPAddress] The Source IP address of the UDP echo packet. The CPEdevice MUST only respond to a UDP echo from this source IP address. |
- |
2.0 |
|
EchoPlusEnabled |
boolean |
W |
If true the CPEdevice will perform necessary packet processing for UDP Echo Plus packets. |
- |
2.0 |
|
Device.IP.Diagnostics.UploadDiagnostics. |
object |
R |
This object defines the diagnostics configuration for a HTTP or FTP UploadDiagnostics test. Files sent by the UploadDiagnostics do not require file storage on the CPE device, and MAY be an arbitrary stream of bytes. |
- |
2.0 |
|
UploadURL |
string(:2048) |
W |
The [URL] for the CPEdevice to Upload to. This parameter MUST be in the form of a valid HTTP [RFC2616] or FTP [RFC959] URL.
|
- |
2.0 |
|
UploadTransports |
string[] |
R |
Comma-separated list of strings. Supported UploadDiagnostics transport protocols for a CPE device. Each list item is an enumeration of:
|
- |
2.0 |
|
TestFileLength |
unsignedLong |
W |
The size of the file bytes to be uploaded to the server. The CPEdevice MUST insure the appropriate number of bytes are sent. |
- |
2.0 |
|
UploadDiagnosticsMaxIncrementalResult |
unsignedInt(1:) |
R |
The maximum number of rows in IncrementalResult that the CPEdevice will store. |
- |
2.9 |
|
Device.IP.Diagnostics.UDPEchoDiagnostics. |
object |
R |
This object defines the diagnostics configuration for a UDP Echo test [Appendix A.1/TR-143] defined in [RFC862] or a UDP Echo Plus test defined in [Appendix A.1/TR-143]. |
- |
2.9 |
|
UDPEchoDiagnosticsMaxResults |
unsignedInt(1:) |
R |
The maximum number of rows in IndividualPacketResult that the CPEdevice will store. If a test would create more rows than UDPEchoDiagnosticsMaxResults only the first UDPEchoDiagnosticsMaxResults rows are present in IndividualPacketResult. |
- |
2.9 |
|
Device.IP.Diagnostics.UDPEchoDiagnostics.IndividualPacketResult.{i}. |
object(0:) |
R |
This object provides the results from individual UDPEchoPlus test packets collected during a test if EnableIndividualPacketResults is set to true. When DiagnosticsState is set to Complete it should contain NumberOfRepetitions objects. Instance numbers MUST start at 1 and sequentially increment as new instances are created. The instance number should match the TestIterationNumber field of the request and response packet. All instances are removed when DiagnosticsState is set to Requested or None. |
- |
2.9 |
|
PacketSuccess |
boolean |
R |
Indicates that the response to this UDP Echo Plus packet sent was received by the client. When this value is true, then all the remaining parameters in this instance are valid. Otherwise only the values originally set by the CPEdevice client (e.g. PacketSendTime and TestGenSN) MAY be set to valid values. |
- |
2.9 |
|
TestGenSN |
unsignedInt |
R |
The TestGenSN field in the UDPEcho Plus packet [Section A.1.4/TR-143] sent by the CPEdevice client. |
- |
2.9 |
|
TestRespSN |
unsignedInt |
R |
The TestRespSN field in the response packet [Section A.1.4/TR-143] from the UDP Echo Plus server (i.e. Host) for this Echo Plus packet sent by the CPEdevice client. If PacketSuccess is false, TestRespSN SHOULD be 0. |
- |
2.9 |
|
TestRespRcvTimeStamp |
unsignedInt |
R |
The TestRespRcvTimeStamp field in the response packet [Section A.1.4/TR-143] from the UDP Echo Plus server (i.e. Host) to record the reception time in microseconds of this UDP Echo Plus packet sent from the CPEdevice client. If PacketSuccess is false, TestRespRcvTimeStamp SHOULD be 0. |
- |
2.9 |
|
TestRespReplyTimeStamp |
unsignedInt |
R |
The TestRespReplyTimeStamp field in the response packet [Section A.1.4/TR-143] from the UDP Echo Plus server (i.e. Host) to record the server reply time in microseconds of this UDP Echo Plus packet sent from the CPEdevice client. That is, the time that the server returned the UDP Echo Plus packet. If PacketSuccess is false, TestRespReplyTimeStamp SHOULD be 0. |
- |
2.9 |
|
Device.LLDP. |
object |
R |
This object contains Link Layer Discovery Protocol (LLDP) [802.1AB-2009] related objects and parameters. |
- |
2.8 |
|
Device.LLDP.Discovery. |
object |
R |
This object is used for managing the discovery of LLDP devices. The CPEdevice MAY, but need not, retain some or all of the information in this object across reboot. |
- |
2.8 |
|
Device.IPsec. |
object |
R |
IPsec [RFC4301] object that supports the configuration of Encapsulating Security Payload (ESP) [RFC4303] and Authentication Header (AH) [RFC4302] in tunnel mode [Section 3.2/RFC4301]. Use of IKEv2 [RFC5996] is assumed. The IPsec object does not currently support static configuration of tunnels and child Security Associations (SAs). See the IPsec Theory of Operation [Appendix IX/TR-181i2] for a description of the working of this IPsec data model. |
- |
2.5 |
|
Status |
string |
R |
IPsec status. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.5 |
|
SupportedIntegrityAlgorithms |
string[] |
R |
Comma-separated list of strings. Supported integrity algorithms [Transform Type 3/IKEv2-params]. Each list item is an enumeration of:
Note that these are the names from the above reference, transformed as follows:
As additional algorithms are added to the above reference, this data model will be extended according to the above conventions. |
- |
2.5 |
|
MaxFilterEntries |
unsignedInt |
R |
The maximum number of entries in the Filter table. When this limit is reached, creating a new entry fails. A value of 0 means no specific limit. |
- |
2.5 |
|
MaxProfileEntries |
unsignedInt |
R |
The maximum number of entries in the Profile table. When this limit is reached, creating a new entry fails. A value of 0 means no specific limit. |
- |
2.5 |
|
Device.IPsec.Stats. |
object |
R |
Global IPsec statistics. These statistics include all IPsec traffic, i.e. all IKEv2 negotiation, IKEv2 SAs and child SAs. The CPEdevice MUST reset global IPsec Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when IPsec is disabled (Enable is set to false) or when IPsec is enabled (Enable is set to true). |
- |
2.5 |
|
Device.IPsec.Filter.{i}. |
object(0:) |
W |
Filter table that represents the IPsec Security Policy Database (SPD) [Section 4.4.1/RFC4301] selection criteria. Each (ordered) entry defines a set of selection criteria and references a Profile table entry that specifies how matching packets will be processed. SPD filtering is performed for all packets that might need to cross the IPsec boundary [Section 3.1/RFC4301]. Given that IPsec operates at the IP level, this means that SPD filtering conceptually occurs after bridging and before routing. For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.5 |
|
Status |
string |
R |
The status of this IPsec Filter table entry. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.5 |
|
Interface |
string(:256) |
W |
SPD selection criterion. The value MUST be the Path Name of a table row. This specifies the ingress interface associated with the entry. It MAY be a layer 1, 2 or 3 interface. However, the types of interfaces for which filters can be instantiated is a local matter to the CPE.}}device. |
<Empty> |
2.5 |
|
Device.IPsec.Profile.{i}. |
object(0:) |
W |
Profile table that represents the IPsec Security Policy Database (SPD) [Section 4.4.1/RFC4301] processing info. Each entry defines the IPsec treatment for packets that match the Filter entries that reference the entry. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. Changes since 2.21:
|
- |
2.5 |
|
IKEv2AuthenticationMethod |
string |
W |
IKEv2 CPEdevice authentication method [Section 2.15/RFC5996]. The value MUST be the Path Name of an enabled row in the Security.Certificate table or in another table that contains appropriate CPEdevice credentials. If an empty string, or the referenced row is disabled or deleted, the CPEdevice chooses the authentication method based on local policy. |
<Empty> |
2.5 |
|
AllowedEncryptionKeyLengths |
unsignedInt[] |
W |
Comma-separated list of unsigned integers. These limits apply to ciphers with support for multiple key lengths, such as AES, Camellia, and Blowfish. For example, if ESPAllowedEncryptionAlgorithms includes AES-CBC and AllowedEncryptionKeyLengths is [256,192], then the device neither proposes nor accepts AES-CBC with a 128-bit key length. If multiple key sizes are permitted, the implementation uses the largest supported key size. An empty string means that no restriction is imposed on key lengths. |
<Empty> |
2.22 |
|
DSCPMarkPolicy |
int(-2:63) |
W |
DSCP with which to mark the outer IP header for traffic that is associated with this IPsec channel. A value of -1 indicates copy from the incoming packet. A value of -2 indicates automatic marking of DSCP. De-tunneled packets are never re-marked. Automatic DSCP marking behavior is a local matter to the CPE,device, possibly influenced by other Broadband Forum standards that it supports. |
- |
2.5 |
|
Device.IPsec.Tunnel.{i}. |
object(0:) |
R |
Represents an IPsec tunnel, i.e. a virtual IP interface that models an IPsec tunnel entry point and exit point. A Tunnel instance always references (and has the same lifetime as) a (Tunnel,Tunneled) IP.Interface pair. The Tunnel instance models the IPsec-specific concepts, the Tunnel IP.Interface instance models the generic concepts, and the Tunneled IP.Interface instance exists only so it can be referenced by forwarding or filter rules. Tunnel instances are automatically created (as needed) when Filter instances are enabled and disabled. Each instance's Filters parameter references the Filter instances that require the Tunnel instance to exist. If this list ever becomes an empty string, e.g. because all the referenced Filter instances have been disabled or deleted, the CPEdevice MAY choose not to delete the Tunnel instance (and its associated (Tunnel,Tunneled) IP.Interface pair). This can be desirable, because QoS.Classification, Routing.Router.{i}.IPv4Forwarding, Routing.Router.{i}.IPv6Forwarding etc instances might be referencing the IP.Interface instances. At most one entry in this table can exist with a given value for Alias, or with the same values for both TunnelInterface and TunneledInterface. |
- |
2.5 |
|
Device.IPsec.Tunnel.{i}.Stats. |
object |
R |
Statistics for this IPsec tunnel, i.e. all traffic that has passed through the tunnel, including IKEv2 negotiation, IKEv2 SA and ChildSA traffic. The CPEdevice MUST reset the tunnel's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the tunnel becomes operationally down due to a previous administrative down (i.e. its associated IP.Interface.{i}.Status parameter transitions to a down state after the tunnel has been disabled) or when the tunnel becomes administratively up (i.e. its associated IP.Interface.{i}.Enable parameter transition from false to true). Note that this object does not include generic statistics that are available in the associated IP.Interface.{i}.Stats object. |
- |
2.5 |
|
Device.IPsec.IKEv2SA.{i}. |
object(0:) |
R |
Represents an IKEv2 Security Association (SA), corresponding to an IKEv2 session. Instances are automatically created and deleted as IKEv2 SAs are created and deleted. At most one entry in this table can exist with a given value for Tunnel, or with a given value for Alias. |
- |
2.5 |
|
Device.IPsec.IKEv2SA.{i}.Stats. |
object |
R |
Statistics for this IKEv2 Security Association (SA). The CPEdevice MUST reset the IKEv2 SA's Stats parameters (unless otherwise stated in individual object or parameter descriptions) whenever the associated Tunnel instance's Stats parameters are reset. |
- |
2.5 |
|
Device.IPsec.IKEv2SA.{i}.ReceivedCPAttr.{i}. |
object(0:) |
W |
This is a transitory table that lists all the IKEv2 Configuration Payload (CP) [Section 3.15/RFC5996] Attributes that have been received via CFG_REPLY messages. Table entries are automatically created to correspond with received Attributes. However, it is a local matter to the CPEdevice when to delete old table entries. If the same Attribute is received multiple times, it is up to the CPEdevice to decide which entries to include (i.e. whether the same Attribute will be present multiple times). In order to allow for the same Attribute to be present multiple times within the table, this table has no unique key defined. |
- |
2.5 |
|
Device.IPsec.IKEv2SA.{i}.ChildSA.{i}. |
object(0:) |
R |
Represents a child Security Association (SA) pair, i.e. an inbound child SA and an outbound child SA. At most one entry in this table can exist with a given value for InboundSPI, or with a given value for OutboundSPI, or with a given value for Alias. |
- |
2.5 |
|
Device.IPsec.IKEv2SA.{i}.ChildSA.{i}.Stats. |
object |
R |
Statistics for this child Security Association (SA). The CPEdevice MUST reset the child SA's Stats parameters (unless otherwise stated in individual object or parameter descriptions) whenever the parent ChildSA instance's Stats parameters are reset. |
- |
2.5 |
|
Device.GRE. |
object |
R |
This object contains parameters associated with the Generic Routing Encapsulation (GRE) Tunnel ([RFC2784]) with Key and Sequence Number extensions ([RFC2890]). This object also provides a means to treat packets that are encapsulated within a GRE Tunnel by using a set of Filter objects to determine the treatment of the packet. |
- |
2.8 |
|
Device.GRE.Tunnel.{i}. |
object(0:) |
W |
GRE Tunnel table, models the GRE Tunnel instance and represents the entry point and exit point of the tunnel in relation to the WAN interface. A Tunnel object has one or more Interface objects that further define the sessions or flows within the tunnel. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.8 |
|
Device.GRE.Tunnel.{i}.Interface.{i}. |
object(0:) |
W |
GRE Interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). The Interface object models the GRE Header as defined in [RFC2784] and extensions to the GRE Header as defined in [RFC2890]. The Interface object provides a way to discriminate how sessions or flows are encapsulated within the GRE Tunnel. In addition the Interface object represents the entry point and exit point of the tunnel in relation to the LAN interface. Unless the Key Identifier of [RFC2890] is supported there is only one instance of this Interface object per tunnel. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.8 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.8 |
|
ProtocolIdOverride |
unsignedInt |
W |
The Protocol ID assigned to this Interface. The Protocol Id is the EtherType value used to identify the encapsulated payload. When set to 0 the CPEdevice determines the Protocol Id. |
0 |
2.8 |
|
KeyIdentifierGenerationPolicy |
string |
W |
The method used to generate the Key Identifier extension as defined in.[RFC2890]. Enumeration of:
|
Disabled |
2.8 |
|
Device.GRE.Tunnel.{i}.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.8 |
|
Device.GRE.Filter.{i}. |
object(0:) |
W |
GRE Filter table. Entries in this table are applied against the packets that are to be encapsulated within the GRE Tunnel based on the following conditions:
For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.8 |
|
Status |
string |
R |
The status of this filter. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.8 |
|
Device.L2TPv3. |
object |
R |
This object contains parameters associated with the configuration and monitoring of stateless tunnels using the Layer Two Tunneling Protocol version 3 (L2TPv3) ([RFC3931]). This object also provides a means to treat packets that are encapsulated within a L2TPv3 Tunnel by using a set of Filter objects to determine the treatment of the packet. |
- |
2.12 |
|
Device.L2TPv3.Tunnel.{i}. |
object(0:) |
W |
L2TPv3 Tunnel table, models the L2TPv3 Tunnel instance and represents the entry point and exit point of the tunnel in relation to the WAN interface. A Tunnel object has one or more Interface objects that further define the sessions or flows within the tunnel. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Device.L2TPv3.Tunnel.{i}.Interface.{i}. |
object(0:) |
W |
L2TPv3 Interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). The Interface object models the L2TPv3 Header as defined in [RFC3931] and the transport of L2 frames across over L2TPv3 as defined in [RFC4719]. The Interface object provides a way to discriminate how sessions or flows are encapsulated within the L2TPv3 Tunnel. In addition the Interface object represents the entry point and exit point of the tunnel in relation to the LAN interface. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.12 |
|
SessionID |
int(-1,1:65535) |
W |
The unique Session ID to be used in the L2TPv3 header of the tunnel. A Session ID with a value of -1 indicates that the CPEdevice is to generate the session ids for this Interface instance. |
1 |
2.12 |
|
Device.L2TPv3.Tunnel.{i}.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice 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 |
|
Device.L2TPv3.Filter.{i}. |
object(0:) |
W |
L2TPv3 Filter table. Entries in this table are applied against the packets that are to be encapsulated within the L2TPv3 Tunnel based on the following conditions:
For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this filter. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.12 |
|
Device.VXLAN. |
object |
R |
This object contains parameters associated with the configuration and monitoring of stateless tunnels using the Virtual eXtensible Local Area Network (VXLAN) ([RFC7348]). This object also provides a means to treat packets that are encapsulated within a VXLAN Tunnel by using a set of Filter objects to determine the treatment of the packet. |
- |
2.12 |
|
Device.VXLAN.Tunnel.{i}. |
object(0:) |
W |
VXLAN Tunnel table, models the VXLAN Tunnel instance and represents the entry point and exit point of the tunnel in relation to the WAN interface. A Tunnel object has one or more Interface objects that further define the sessions or flows within the tunnel. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Device.VXLAN.Tunnel.{i}.Interface.{i}. |
object(0:) |
W |
VXLAN Interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). The Interface object models the VXLAN Header as defined in [RFC7348] for the transport of L2 frames across over VXLAN. The Interface object provides a way to discriminate how multiple LAN segments are encapsulated within the VXLAN Tunnel. In addition the Interface object represents the entry point and exit point of the tunnel in relation to the LAN interface. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.12 |
|
VNI |
int(-1,0:16777215) |
W |
The unique Virtual Network Identifier (VNI) to be used in the VXLAN header of the tunnel. A VNI with a value of -1 indicates that the CPEdevice is to generate the VNI for this Interface instance. |
1 |
2.12 |
|
Device.VXLAN.Tunnel.{i}.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice 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 |
|
Device.VXLAN.Filter.{i}. |
object(0:) |
W |
VXLAN Filter table. Entries in this table are applied against the packets that are to be encapsulated within the VXLAN Tunnel based on the following conditions:
For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Status |
string |
R |
The status of this filter. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.12 |
|
Device.MAP. |
object |
R |
The Mapping of Address and Port (MAP) object [RFC7597] [RFC7599] [RFC7598]. This object applies only to gateway devices that support IPv4 on the LAN side, include a NAT, and typically have only IPv6 connectivity on the WAN side. See the MAP Theory of Operation [Appendix XV/TR-181i2] for a description of the working of this MAP data model. |
- |
2.8 |
|
Device.MAP.Domain.{i}. |
object(0:) |
W |
MAP domain settings [RFC7597] [RFC7599]. Each instance models a MAP domain. MAP supports two transport modes, both of which use NAPT44 (modified to use a restricted port range):
Note: There is an n:1 relationship between a MAP domain and the associated WANInterface, i.e. in theory multiple MAP domains can be associated with a single WAN IP interface (each domain would have its own End-user IPv6 prefix and MAP IPv6 address). Note: The Domain table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPEdevice will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Domain row to then violate the table's unique key constraint; if this occurs, the CPEdevice MUST set Status to Error_Misconfigured and disable the offending Domain row. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both WANInterface and IPv6Prefix. |
- |
2.8 |
|
IPv6Prefix |
string |
W |
The value MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The MAP domain's End-user IPv6 prefix. This MUST reference one of WANInterface's prefixes. If the Controller configures this prefix directly, the CPEdevice MUST use the Controller-configured prefix. Otherwise, the CPEdevice MUST select one of WANInterface's prefixes; the selected prefix will typically have IP.Interface.{i}.IPv6Prefix.{i}.Origin = PrefixDelegation. |
- |
2.8 |
|
Device.MAP.Domain.{i}.Interface. |
object |
R |
MAP interface (a stackable interface object as described in [Section 4.2/TR-181i2]). This models the LAN side MAP domain interface. |
- |
2.8 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.8 |
|
Device.MAP.Domain.{i}.Interface.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.8 |
|
Device.MAP.Domain.{i}.Rule.{i}. |
object(0:) |
W |
The MAP domain's Mapping Rules [RFC7597]. The rule with the longest match between its IPv6Prefix and the end-user IPv6Prefix is the Basic Mapping Rule (BMR). Any of the rules (including the BMR) can be a Forwarding Mapping Rule. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for IPv6Prefix, or with a given value for IPv4Prefix. |
- |
2.8 |
|
Status |
string |
R |
The status of this Rule instance. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.8 |
|
Origin |
string |
R |
The mechanism via which the Rule was created. If the CPEdevice supports MAP configuration via both DHCPv6 and CWMP, it is up to the implementation to determine how the two mechanisms will interact. Enumeration of:
|
Static |
2.8 |
|
Device.CaptivePortal. |
object |
R |
This object contains parameters relating to the captive portal configuration on the CPE.device. The captive portal configuration defines the CPE'sdevice's upstream HTTP (port 80) traffic redirect behavior. When the captive portal is disabled, upstream HTTP (port 80) traffic MUST be permitted to all destinations. When the captive portal is enabled, upstream HTTP (port 80) traffic MUST be permitted only to destinations listed in the AllowedList; traffic to all other destinations MUST be redirected to the URL. |
- |
2.0 |
|
Status |
string |
R |
Indicates the status of the captive portal. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.0 |
|
URL |
string(:2048) |
W |
Captive portal [URL] to which upstream HTTP (port 80) traffic to destinations not listed in the AllowedList will be redirected. The captive portal URL MUST be an HTTP (not HTTPS) URL. The CPEdevice MUST permit the captive portal URL to be set to an empty string, which has the effect of disabling the captive portal (if Enable is true and the captive portal URL is an empty string, Status MUST be Error_URLEmpty). |
- |
2.0 |
|
Device.Routing. |
object |
R |
Routing object that contains the Router table, the received router advertisement information RouteInformation, Babel, and RIP protocol objects. |
- |
2.0 |
|
Device.Routing.Router.{i}. |
object(0:) |
W |
This object allows the handling of the routing and forwarding configuration of the device. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for ID, or with a given value for Name. |
- |
2.0 |
|
Status |
string |
R |
The status of this Router entry. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.0 |
|
Device.Routing.Router.{i}.IPv4Forwarding.{i}. |
object(0:) |
W |
Layer 3 IPv4 forwarding table. In addition to statically configured routes, this table MUST include dynamic routes learned through layer 3 routing protocols, including RIP (i.e. RIP version 2), OSPF, DHCPv4, 3GPP-NAS (3GPP Non Access Stratum) and IPCP. The CPEdevice MAY reject attempts to delete or modify a dynamic route entry. For each incoming packet, the layer 3 forwarding decision is conceptually made as follows:
For enabled table entries, if Interface is not a valid reference to an IPv4-capable interface (that is attached to the IPv4 stack), then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. Note: The IPv4Forwarding table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPEdevice will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated IPv4Forwarding row to then violate the table's unique key constraint; if this occurs, the CPEdevice MUST disable the offending IPv4Forwarding row. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of DestIPAddress, DestSubnetMask, SourceIPAddress, SourceSubnetMask, ForwardingPolicy, GatewayIPAddress, Interface and ForwardingMetric. |
- |
2.0 |
|
Status |
string |
R |
Indicates the status of the forwarding entry. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. |
Disabled |
2.0 |
|
Device.Routing.Router.{i}.IPv6Forwarding.{i}. |
object(0:) |
W |
Layer 3 IPv6 forwarding table. In addition to statically configured routes, this table MUST include dynamic routes learned through layer 3 routing protocols, including RIPng, OSPF, DHCPv6, 3GPP-NAS, and RA. The CPEdevice MAY reject attempts to delete or modify a dynamic route entry. For each incoming packet, the layer 3 forwarding decision is conceptually made as follows:
For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. This object is based on inetCidrRouteTable from [RFC4292]. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of DestIPPrefix, ForwardingPolicy, NextHop, Interface and ForwardingMetric. |
- |
2.2 |
|
Status |
string |
R |
Indicates the status of the forwarding entry. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.2 |
|
Device.Routing.Policy.{i}. |
object(0:) |
W |
Routing policy table. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.20 |
|
SourceIPPrefix |
string(:49) |
W |
Source IP address prefix, represented as an IP routing prefix using CIDR notation (defined in [RFC4632]). The IP version of IPVersion determines whether SourceIPPrefix is interpreted as an IPv4 or IPv6 prefix. An an empty string indicates this criterion is not used for matching. |
<Empty> |
2.20 |
|
DestIPPrefix |
string(:49) |
W |
Destination IP address prefix, represented as an IP routing prefix using CIDR notation (defined in [RFC4632]). The IP version of IPVersion determines whether DestIPPrefix is interpreted as an IPv4 or IPv6 prefix. An an empty string indicates this criterion is not used for matching. |
<Empty> |
2.20 |
|
Device.Routing.RIP. |
object |
R |
Routing Information Protocol (RIP) object. |
- |
2.0 |
|
Device.Routing.RIP.InterfaceSetting.{i}. |
object(0:) |
W |
IP Interface RIP configuration table. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. Note: The InterfaceSetting table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPEdevice will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated InterfaceSetting row to then violate the table's unique key constraint; if this occurs, the CPEdevice MUST set Status to Error_Misconfigured and disable the offending InterfaceSetting row. Note: This object only applies to RIP2; i.e. version 2 of the RIP protocol is used to accept or send over the specified Interface. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface. |
- |
2.0 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.0 |
|
Device.Routing.RouteInformation. |
object |
R |
Received Router Advertisement (RA) route information [RFC4191]. |
- |
2.2 |
|
Device.Routing.RouteInformation.InterfaceSetting.{i}. |
object(0:) |
R |
IP Interface RA route information table. Contains received RA route information [RFC4191]. As such, the data in this table cannot be modified. At most one entry in this table can exist with a given value for Interface. |
- |
2.2 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.2 |
|
Device.NeighborDiscovery. |
object |
R |
This object describes a unified approach for Layer 3 to Layer 2 address resolution protocols, managing both the Neighbor Discovery Protocol (NDP) for IPv6 [RFC4861] and the Address Resolution Protocol (ARP) for IPv4. It contains an InterfaceSetting table that defines the configuration for individual IP interfaces. |
- |
2.2 |
|
Device.NeighborDiscovery.InterfaceSetting.{i}. |
object(0:) |
W |
A per-interface configuration entry for address resolution protocols. This entry is associated with a specific IP interface (via Interface) and contains sub-objects for configuring ARP (ARP) for IPv4 and NDP (NDP) for IPv6. For this entry to be operational, the Interface parameter MUST be a valid reference to an existing IP interface. If the reference is invalid, this entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface. |
- |
2.2 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.2 |
|
Device.NeighborDiscovery.InterfaceSetting.{i}.NDP. |
object |
R |
Contains all parameters related to the Neighbor Discovery Protocol (NDP) for this interface, as defined in [RFC4861]. |
- |
2.21 |
|
MaxRtrSolicitations |
unsignedInt |
W |
Maximum Number of Router Solicitation Transmission messages, as defined in [RFC4861]. For auto-configuration purposes MaxRtrSolicitations specifies the Maximum Number of Router Solicitation Transmission messages to help the host to conclude that there are no routers on the link. If MaxRtrSolicitationInterval is configured, Thisthis parameter corresponds to the Max Retransmit Count (MRC), where MRC is set to MAX_RTR_SOLICITATIONS as defined in [RFC7559]. This parameter is ignored if UnlimitedMaxRtrSolicitations is true. |
3 |
2.21 |
|
Device.RouterAdvertisement. |
object |
R |
The Router Advertisement (RA) object [RFC4861]. This object applies only to IPv6. It contains an InterfaceSetting table that defines the RA configuration for individual IP interfaces. Information received via router advertisement messages is automatically propagated to the relevant IP.Interface sub-objects, e.g. to the IP.Interface.{i}.IPv6Address and IP.Interface.{i}.IPv6Prefix tables. |
- |
2.2 |
|
Device.RouterAdvertisement.InterfaceSetting.{i}. |
object(0:) |
W |
Per-interface Router Advertisement (RA) configuration [RFC4861]. Table entries are created for use in sending Router Advertisements. For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. Note: The InterfaceSetting table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPEdevice will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated InterfaceSetting row to then violate the table's unique key constraint; if this occurs, the CPEdevice MUST set Status to Error_Misconfigured and disable the offending InterfaceSetting row. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface. |
- |
2.2 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.2 |
|
Device.IPv6rd. |
object |
R |
Settings allowing a CPEdevice to derive and route IPv6 Rapid Deployment (6rd) delegated prefixes as specified in [RFC5969]. The 6rd mechanism is intended to be implemented only on what [RFC5969] refers to as Customer Edge Routers, i.e. on gateway devices, that support IPv6 on the LAN side and only have IPv4 connectivity on the WAN side. See the 6rd Theory of Operation [Appendix VI/TR-181i2] for a description of the working of this 6rd data model. |
- |
2.2 |
|
Device.IPv6rd.InterfaceSetting.{i}. |
object(0:) |
R |
6rd [RFC5969] settings. A 6rd delegated prefix is expected to be of maximum length 64 bits, and is the concatenation of the following two items:
This object definition is derived from [RFC5969] with some minor nomenclature changes. At most one entry in this table can exist with a given value for Alias. |
- |
2.2 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.2 |
|
Device.DSLite. |
object |
R |
Settings allowing a CPEdevice to configure and route IPv6 Dual-Stack Lite (DSLite) as specified in [DSLite]. The DS-Lite mechanism is intended to be implemented only on gateway devices that support IPv4 on the LAN side and only have IPv6 connectivity on the WAN side. See the Dual-Stack Lite Theory of Operation [Appendix VII/TR-181i2] for a description of the working of this DS-Lite data model. |
- |
2.2 |
|
Device.DSLite.InterfaceSetting.{i}. |
object(0:) |
R |
DSLite [DSLite] settings. At most one entry in this table can exist with a given value for Alias. |
- |
2.2 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.2 |
|
Origin |
string |
R |
Method used to assign EndpointAddressInUse. Enumeration of:
|
- |
2.2 |
|
Device.QoS. |
object |
R |
Queue management configuration object. Changes since 2.21:
|
- |
2.0 |
|
MaxClassificationEntries |
unsignedInt |
R |
The maximum number of entries available in the Classification table.}} When this limit is reached, creating a new entry fails. A value of 0 means no limit. |
- |
2.0 |
|
MaxChainEntries |
unsignedInt |
R |
The maximum number of entries available in the Chain table. A value of 0 means no limit. |
- |
2.22 |
|
ChainNumberOfEntries |
unsignedInt |
R |
The number of entries in the Chain table. |
- |
2.22 |
|
MaxAppEntries |
unsignedInt |
R |
The maximum number of entries available in the App table.}} When this limit is reached, creating a new entry fails. A value of 0 means no limit. |
- |
2.0 |
|
MaxFlowEntries |
unsignedInt |
R |
The maximum number of entries available in the Flow table.}} When this limit is reached, creating a new entry fails. A value of 0 means no limit. |
- |
2.0 |
|
MaxPolicerEntries |
unsignedInt |
R |
The maximum number of entries available in the Policer table.}} When this limit is reached, creating a new entry fails. A value of 0 means no limit. |
- |
2.0 |
|
MaxQueueEntries |
unsignedInt |
R |
The maximum number of entries available in the Queue table.}} When this limit is reached, creating a new entry fails. A value of 0 means no limit. |
- |
2.0 |
|
MaxShaperEntries |
unsignedInt |
R |
The maximum number of entries available in the Shaper table.}} When this limit is reached, creating a new entry fails. A value of 0 means no limit. |
- |
2.0 |
|
MaxSchedulerEntries |
unsignedInt |
R |
The maximum number of entries available in the Scheduler table.}} When this limit is reached, creating a new entry fails. A value of 0 means no limit. |
- |
2.16 |
|
Device.QoS.Classification.{i}. |
object(0:) |
W |
Classification table. For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. Several of this object's parameters specify DHCP option values. Some cases are version neutral (the parameter can apply to both DHCPv4 and DHCPv6), but in other cases the representation of the option is different for DHCPv4 and DHCPv6, so it is necessary to define separate DHCPv4-specific and DHCPv6-specific parameters. Therefore, an instance of this object that uses DHCP option values as classification criteria will be associated with either DHCPv4 or DHCPv6, as indicated by the DHCPType parameter. Note: As of Device:2.22, if the device has an instantiated data model of Chain, then objects of Classification are only used when referenced by Chain.{i}.Classification.{i}.ClassificationRef. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. Changes since 2.21:
|
- |
2.0 |
|
Status |
string |
R |
The status of this classifier. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.0 |
|
Order |
unsignedInt(1:) |
W |
[Order] Position of the Classification entry in the order of precedence. A value of 1 indicates the first entry to be considered (highest precedence). When a Classification instance is created, or when an existing Order value is modified, if the value matches that of an existing entry, the Order values for the existing entry and all lower Order entries are incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. If no Order value is supplied on creation of a Classification instance, it MUST be assigned a value that is one more than the largest current value (lowest precedence). For each packet, the classification entries are processed in descending order of this parameter (higher values mean higher precedence).parameter. The matching process can stop either on the first match or continue, as determined by the value of the StopProcessing parameter. Note: The requirement for highest-ordered entry precedence in packet classification is removed in Device:2.21. |
- |
2.0 |
|
Interface |
string(:256) |
W |
Classification criterion. The value MUST be the Path Name of a table row. This specifies the ingress interface associated with the entry. It MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which Classifications can be instantiated is a local matter to the CPE.device. Note that this parameter is permitted to reference Tunnel instances in order to classify upstream packets that have just been encapsulated (such packets are conceptually similar to locally-generated traffic). For example, this parameter might reference a GRE.Tunnel or a MAP.Domain instance. |
<Empty> |
2.0 |
|
SourceVendorClassIDv6 |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCPv6 Vendor Class Identifier (Option 16) as defined in [RFC9915]. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used for classification. Note: This parameter is DHCPv6-specific. It only applies when DHCPType is DHCPv6. |
<Empty> |
2.2 |
|
DestVendorClassIDv6 |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCPv6 Vendor Class Identifier (Option 16) as defined in [RFC9915]. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used for classification. Note: This parameter is DHCPv6-specific. It only applies when DHCPType is DHCPv6. |
<Empty> |
2.2 |
|
SourceClientID |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Client Identifier. The DHCP Client Identifier is Option 61 (as defined in [RFC2132]) for DHCPv4, or is Option 1 (as defined in [RFC9915]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. Note: DHCPv6 Option 1 (Client Identifier) is sometimes referred to as DUID. |
<Empty> |
2.0 |
|
DestClientID |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Client Identifier. The DHCP Client Identifier is Option 61 (as defined in [RFC2132]) for DHCPv4, or is Option 1 (as defined in [RFC9915]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. Note: DHCPv6 Option 1 (Client Identifier) is sometimes referred to as DUID. |
<Empty> |
2.0 |
|
SourceUserClassID |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP User Class Identifier. The DHCP User Class Identifier is Option 77 (as defined in [RFC3004]) for DHCPv4, or is Option 15 (as defined in [RFC9915]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. |
<Empty> |
2.0 |
|
DestUserClassID |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP User Class Identifier. The DHCP User Class Identifier is Option 77 (as defined in [RFC3004]) for DHCPv4, or is Option 15 (as defined in [RFC9915]) for DHCPv6. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. |
<Empty> |
2.0 |
|
SourceVendorSpecificInfo |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Vendor-specific Information, matched according to the criteria in SourceVendorSpecificInfoEnterprise and SourceVendorSpecificInfoSubOption. The DHCP Vendor-specific Information is Option 125 (as defined in [RFC3925]) for DHCPv4, or is Option 17 (as defined in [RFC9915]) for DHCPv6. An empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. |
<Empty> |
2.0 |
|
DestVendorSpecificInfo |
hexBinary(:65535) |
W |
Classification criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCP Vendor-specific Information, matched according to the criteria in DestVendorSpecificInfoEnterprise and DestVendorSpecificInfoSubOption. The DHCP Vendor-specific Information is Option 125 (as defined in [RFC3925]) for DHCPv4, or is Option 17 (as defined in [RFC9915]) for DHCPv6. An empty string indicates this criterion is not used for classification. Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535. Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType. |
<Empty> |
2.0 |
|
HardwareOffloadEnabled |
boolean |
W |
Classification result. If true, the Device MAY use hardware acceleration for traffic associated with this entry. If false, the Device MUST use the software slow path, bypassing any hardware acceleration for this entry. |
true |
2.21 |
|
TargetChain |
string |
W |
The value MUST be the Path Name of a row in the Chain. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the Chain to process. If there are no matching rules in the referenced chain, processing continues with the next row in the current chain (if any). In other words, TargetChain behaves like a subroutine call. An empty string indicates no TargetChain is specified. |
<Empty> |
2.22 |
|
Device.QoS.Chain.{i}. |
object(0:) |
W |
A table of QoS chains used to group classification entries that belong together. If the device has an instantiated data model of Chain, then objects of Classification are only used when referenced by Classification.{i}.ClassificationRef. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.22 |
|
Enable |
boolean |
W |
Enables or disables this Chain table entry. |
false |
2.22 |
|
Status |
string |
R |
The status of this Chain table entry. The Error value MAY be used by the device to indicate a locally defined error condition. The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid (for example, the chain contains no resolvable Classification.{i}. entries). Enumeration of:
|
Disabled |
2.22 |
|
Name |
string(:64) |
W |
Human-readable name associated with this entry in the Chain table. |
<Empty> |
2.22 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.22 |
|
Direction |
string |
W |
Direction in which the classification needs to be applied. Enumeration of:
|
Inherited |
2.22 |
|
IPVersion |
int(-1,4,6) |
W |
Specifies the IP protocol version, following the definitions in [IANA-ipversionnumbers]. Valid values are: -1 (No specific IP version is required), 4 (IPv4), or 6 (IPv6). |
-1 |
2.22 |
|
ClassificationNumberOfEntries |
unsignedInt |
R |
The number of entries in the Classification table. |
- |
2.22 |
|
Device.QoS.Chain.{i}.Classification.{i}. |
object(0:) |
W |
Classification table. Each entry references a Classification table entry that specifies how matching packets will be classified. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.22 |
|
Enable |
boolean |
W |
Enables or disables this Classification table entry. The Classification.{i}.Enable of the referenced classification is ignored. |
false |
2.22 |
|
Status |
string |
R |
The status of this Classification table entry. Enumeration of:
The Error value MAY be used by the device to indicate a locally defined error condition. The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid (for example, ClassificationRef is empty or dangling, or the referenced classification's Classification.{i}.IPVersion is incompatible with the parent chain's IPVersion). The Classification.{i}.Status of the referenced classification is ignored. |
Disabled |
2.22 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.22 |
|
ClassificationRef |
string |
W |
The value MUST be the Path Name of a row in the Classification. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. A reference to a Classification row used by this chain classification entry. |
<Empty> |
2.22 |
|
Order |
unsignedInt(1:) |
W |
[Order] Position of the Classification entry in the order of precedence. A value of 1 indicates the first entry to be considered (highest precedence). When a Classification instance is created, or when an existing Order value is modified, if the value matches that of an existing entry, the Order values for the existing entry and all lower Order entries are incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. If no Order value is supplied on creation of a Classification instance, it MUST be assigned a value that is one more than the largest current value (lowest precedence). For each packet, the entries in the Classification table are processed in descending order of this parameter. The matching process can stop either on the first match or continue, as determined by the value of the Classification.{i}.StopProcessing parameter. The Classification.{i}.Order of the referenced classification is ignored. |
- |
2.22 |
|
Device.QoS.App.{i}. |
object(0:) |
W |
Application table. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.0 |
|
Status |
string |
R |
The status of this App table entry. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.0 |
|
Device.QoS.Flow.{i}. |
object(0:) |
W |
Flow table. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.0 |
|
Status |
string |
R |
The status of this Flow table entry. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.0 |
|
Device.QoS.Policer.{i}. |
object(0:) |
W |
Policer table. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.0 |
|
Status |
string |
R |
The status of this policer. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.0 |
|
Device.QoS.Queue.{i}. |
object(0:) |
W |
Queue table. Each entry is associated with a set of traffic classes, which are specified via the TrafficClasses parameter, and is configured with weight, precedence, drop algorithm, scheduler algorithm etc as appropriate for the traffic classes. An entry can be associated either with all egress interfaces (in which case an actual queue will be instantiated on each egress interface on which traffic of that traffic class can be generated) or else with a single specified egress interface. For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.0 |
|
Status |
string |
R |
The status of this queue. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.0 |
|
Interface |
string(:256) |
W |
The value MUST be the Path Name of a table row. Specifies the egress interface for which the specified queue MUST exist. This MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which Queues can be instantiated is a local matter to the CPE.}}device. |
<Empty> |
2.0 |
|
REDThreshold |
unsignedInt(:100) |
W |
Random Early Detection threshold, used only when DropAlgorithm is RED. This is the minimum threshold (min_th) and is measured as a percentage of the queue size. If the value is set to zero, the CPEdevice MUST choose a sensible value, e.g. 5 (but the value MUST still read back as zero). In this version of the data model, there is no way to set the maximum threshold (max_th). The CPEdevice MUST choose a sensible value, e.g. three times the minimum threshold. In this version of the data model, there is no way to set the RED weight (w_q). The CPEdevice MUST choose a sensible value, e.g. 0.002. |
0 |
2.0 |
|
REDPercentage |
unsignedInt(:100) |
W |
Random Early Detection percentage, used only when DropAlgorithm is RED. This is the maximum value of the packet marking probability (max_p). If the value is set to zero, the CPEdevice MUST choose a sensible value, e.g. 10 (but the value MUST still read back as zero). In this version of the data model, there is no way to set the RED weight (w_q). The CPEdevice MUST choose a sensible value, e.g. 0.002. |
0 |
2.0 |
|
Device.QoS.QueueStats.{i}. |
object(0:) |
W |
Queue statistics table. This table is managed by the Controller, which will create entries only for those {Queue, Interface} combinations for which statistics are to be collected. Note: The QueueStats table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPEdevice will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated QueueStats row to then violate the table's unique key constraint; if this occurs, the CPEdevice MUST disable the offending QueueStats row. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both Queue and Interface. |
- |
2.0 |
|
Interface |
string(:256) |
W |
The value MUST be the Path Name of a table row. Specifies the egress interface for which this object contains statistics. This MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which QueueStats can be instantiated is a local matter to the CPE.}}device. |
<Empty> |
2.0 |
|
Device.QoS.Shaper.{i}. |
object(0:) |
W |
Shaper table. Used to shape the queue(s) associated with Interface. In case of a single queue for that interface, determines the egress rate of the queue. In case of multiple queues for that interface (possibly with per queue shaping rates), determines the aggregate egress rate on that interface. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. Note: The Shaper table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPEdevice will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Shaper row to then violate the table's unique key constraint; if this occurs, the CPEdevice MUST set Status to Error_Misconfigured and disable the offending Shaper row. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface. |
- |
2.0 |
|
Status |
string |
R |
The status of this shaper. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.0 |
|
Interface |
string(:256) |
W |
The value MUST be the Path Name of a table row.The interface object associated with this Shaper entry. It MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which Shapers can be instantiated is a local matter to the CPE.}}device. |
<Empty> |
2.0 |
|
Device.QoS.Scheduler.{i}. |
object(0:) |
W |
Scheduler table. Each entry is used to model a scheduler object. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.16 |
|
Status |
string |
R |
The status of this scheduler. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.16 |
|
Interface |
string(:256) |
W |
The value MUST be the Path Name of a table row. Specifies the egress interface for which the specified queue MUST exist. This MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which Queues can be instantiated is a local matter to the CPE.}}device. |
<Empty> |
2.16 |
|
Device.LANConfigSecurity. |
object |
R |
This object contains generic device configuration information. |
- |
2.0 |
|
ConfigPassword |
string(:64) |
W |
A password to allow LAN access to protected auto-configuration services. If the CPEdevice supports TR-064 (LAN-side DSL CPE Configuration Protocol), this parameter is to be used as the dslf-config password (as defined in TR-064). If the CPEdevice has a user interface with password protection enabled, this parameter is also to be used as the user password for password-protected operations. However, this parameter MUST NOT be used to set the user password if the parameter UserInterface.PasswordUserSelectable is true. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.0 |
|
Device.Hosts. |
object |
R |
This object provides information about each of the hosts on the LAN, including those whose IP address was allocated by the CPEdevice using DHCP as well as hosts with statically allocated IP addresses. It can also include non-IP hosts. |
- |
2.0 |
|
Device.Hosts.Host.{i}. |
object(0:) |
R |
Host table. At most one entry in this table can exist with a given value for PhysAddress. |
- |
2.0 |
|
IPAddress |
string(:45) |
R |
[IPAddress] Current IP Address of the host. An empty string if no address is available. If more than one IP address for this host is known, the CPEdevice will choose a primary address. All known IP addresses can be listed in the IPv4Address and IPv6Address tables. |
- |
2.0 |
|
AddressSource |
string |
R |
Indicates whether the IP address of the host was allocated by the CPEdevice using DHCP, was assigned to the host statically, or was assigned using automatic IP address allocation. Enumeration of:
This parameter was DEPRECATED in 2.11 because only None and DHCP made sense (the device doesn't know whether the address is Static or AutoIP). The DHCP case is now handled via the DHCPClient reference. This parameter was OBSOLETED in 2.14. This parameter was DELETED in 2.15. |
- |
2.0 |
|
Active |
boolean |
R |
Whether or not the host is currently present on the LAN. The method of presence detection is a local matter to the CPE.device. The ability to list inactive hosts is OPTIONAL. If the CPEdevice includes inactive hosts in this table, Active MUST be set to false for each inactive host. The length of time an inactive host remains listed in this table is a local matter to the CPE.device. Entries in Device.Hosts.Host SHOULD NOT be removed when they become inactive if there are WANStats statistics collected for the entry in the past seven days, unless requested by a Controller or if the CleanupHostsThreshold parameter value is reached. |
- |
2.0 |
|
ActiveLastChange |
dateTime |
R |
The datetime when Active last changed from true to false or from false to true. The initial detection of a host SHOULD be treated as a transition from false to true, showing the datetime when the host was first detected. The ability to list inactive hosts is OPTIONAL. The length of time an inactive host remains listed in this table is a local matter to the CPE.device. Entries in Device.Hosts.Host SHOULD NOT be removed when they become inactive if there are WANStats statistics collected for the entry in the past seven days, unless requested by a Controller or if the CleanupHostsThreshold parameter value is reached. |
- |
2.10 |
|
Device.Hosts.AccessControl.{i}. |
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. If access is not allowed, then the LAN device cannot access the broadband network. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for PhysAddress. |
- |
2.14 |
|
Origin |
string |
R |
Indicates the owner of the AccessControl instance. Note: This parameter was changed to writeOnceReadOnly in the Device:2.18 version. Note: This parameter was reverted back to readOnly in the Device 2.19 version. Enumeration of:
|
Controller |
2.17 |
|
Device.DNS. |
object |
R |
Properties for Domain Name Service (DNS). |
- |
2.0 |
|
Device.DNS.Zone.{i}. |
object(0:) |
W |
This object specifies Zone file configuration of the DNS server. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.17 |
|
Origin |
string |
R |
The mechanism via which the Zone was created. Note: This parameter was changed to writeOnceReadOnly in the Device:2.18 version. Note: This parameter was reverted back to readOnly in the Device 2.19 version. Enumeration of:
Changes since 2.21:
|
Controller |
2.17 |
|
Device.DNS.Zone.{i}.Host.{i}. |
object(0:) |
W |
This object specifies the resource records (RR) of the DNS zone. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.17 |
|
Origin |
string |
R |
Indicates the owner of the Host instance. Note: This parameter was changed to writeOnceReadOnly in the Device:2.18 version. Note: This parameter was reverted back to readOnly in the Device 2.19 version. Enumeration of:
Changes since 2.21:
|
Controller |
2.17 |
|
Device.DNS.Client. |
object |
R |
Client properties for Domain Name Service (DNS). The DNS client resolves FQDN on behalf of device internal (client) applications. |
- |
2.0 |
|
Status |
string |
R |
The status of the DNS client. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.0 |
|
Device.DNS.Client.Server.{i}. |
object(0:) |
W |
This table contains the DNS Server IP address to be used by the DNS Client (it does not model a DNS Server). Entries are either automatically created as result of DHCP (v4 or v6), IPCP, 3GPP-NAS (3GPP Non Access Stratum), or RA received DNS server information, or are statically configured by the Controller. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for DNSServer. |
- |
2.0 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.0 |
|
Device.DNS.Relay. |
object |
R |
DNS Relay object. The DNS proxy (or relay) function allows the forwarding of local network DNS queries to local or external DNS server(s) [RFC5625]. |
- |
2.0 |
|
Status |
string |
R |
The status of the DNS relay. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.0 |
|
Device.DNS.Relay.Config.{i}. |
object(0:) |
W |
This object is used to specify the forwarding strategy (ForwardingMode) among Forwarders, and cache configuration for each Forwarding relay. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.17 |
|
FailbackMaxTimer |
unsignedInt |
W |
This parameter applies only when ForwardingMode is set to StrictOrder. In this case the entry in the Forwarders list is identifyidentified as the primary DNS server. The parameter FailbackMaxTimer is the maximum value for the timer, in milliseconds, to automatically revert to the primary DNS server. If both FailbackMinTimer and FailbackMaxTimer are set to 0 then no failback is performed. |
0 |
2.21 |
|
CacheMinTTL |
unsignedInt |
R |
Specifies the minimum TTL amount of time,TTL, in seconds, that an entry MUST be kept in the cache regardless of what has been specified by the domain owner. When '0' is specified, then the TTL chosen by the domain owner will be applied. |
0 |
2.17 |
|
CacheMaxTTL |
unsignedInt |
R |
Specifies the maximum TTL amount of time,TTL, in seconds, than an entry MUST be kept in the cache regardless of what has been specified by the domain owner. When '0' is specified, then the TTL chosen by the domain owner will be applied. |
86400 |
2.17 |
|
Device.DNS.Relay.Forwarding.{i}. |
object(0:) |
W |
DNS Server forwarding policy to be used by the DNS Relay. Entries are either automatically created as result of DHCP (v4 or v6), IPCP, 3GPP-NAS (3GPP Non Access Stratum) or RA received DNS server information, or are statically configured by the Controller. Note: Management of re-directing queries to the device embedded DNS server is not defined in this version of the specification. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for DNSServer. |
- |
2.0 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.0 |
|
Device.DNS.Diagnostics. |
object |
R |
The DNS Diagnostics object containing the NSLookupDiagnostics test. |
- |
2.0 |
|
Device.DNS.Diagnostics.NSLookupDiagnostics. |
object |
R |
This object defines access to an IP-layer NS Lookup test for the specified IP interface. When initiated, the NS Lookup test will contact DNSServer and look up HostName NumberOfRepetitions times. There will be a Result instance for each time the device performs a DNS lookup, which is determined by the value of NumberOfRepetitions. Any previous Result instances are removed when a new test is initiated. |
- |
2.0 |
|
NumberOfRepetitions |
unsignedInt |
W |
The number of times the device SHOULD repeat the execution of the NSLookup using the same input parameters. If the diagnostics test fails the CPEdevice MAY terminate the test without completing the full number of repetitions. Each repetition will use a Result instance to hold the NSLookup result data. |
- |
2.0 |
|
Device.DNS.SD. |
object |
R |
This object contains the DNS Service Discovery [DNS-SD] object and parameters necessary to discover services and their associated devices. Upon reboot the contents of the service table are repopulated. When the DNS-SD service is disabled, the contents of the service table is implementation specific. |
- |
2.6 |
|
Device.DNS.SD.Advertise.{i}. |
object(0:) |
W |
The Advertise table contains DNS-SD services that MUST be advertised. DNS.SD service information is provided in DNS RR SRV records [RFC2782]. The Service Instance Name [Section 4.1 Structured Instance Names/DNS-SD] further specifies information about the service name (RFC2782 Service field) and domain name (RFC2782 Name field) in the form: Service Instance Name = [InstanceName] . [Service] . [Domain] [Service] = _[ApplicationProtocol] . _[TransportProtocol] RFC2782 Service field will always be equal to [InstanceName]. [Service] RFC2782 Name field will always be equal to [Domain] For example, an SSH service might have: *InstanceName = "Secure Shell (SSH))" *ApplicationProtocol = "ssh" *TransportProtocol = "TCP" *Port = 22 At most one enabled entry in this table can exist with a given value for Alias. |
- |
2.17 |
|
Device.DNS.SD.Advertise.{i}.TextRecord.{i}. |
object(0:) |
W |
This object maintains an instance of a (key/value pairs) of the service. The information is to be provided in the DNS TXT records [RFC1035] of the advertised service. When multiple instances of the TextRecord table have the same value for the Key parameter, the implementation is CPEdevice specific. Note: This object was promoted to readWrite in the Device:2.18 version. |
- |
2.17 |
|
Device.DNS.SD.Service.{i}. |
object(0:) |
R |
The Service table contains discovered DNS-SD services. DNS.SD service information is provided in DNS RR SRV records [RFC2782]. The Service Instance Name [Section 4.1 Structured Instance Names/DNS-SD] further specifies information about the service name (RFC2782 Service field) and domain name (RFC2782 Name field) in the form: Service Instance Name = [InstanceName] . [Service] . [Domain] [Service] = _[ApplicationProtocol] . _[TransportProtocol] RFC2782 Service field will always be equal to [InstanceName]. [Service] RFC2782 Name field will always be equal to [Domain] For example, an SSH service might have: *InstanceName = "Secure Shell (SSH))" *ApplicationProtocol = "ssh" *TransportProtocol = "TCP" *Domain = "example.com" *Port = 22 *Target = "ssh.example.com." At most one entry in this table can exist with the same values for all of InstanceName, ApplicationProtocol, TransportProtocol and Domain. |
- |
2.6 |
|
Device.DNS.SD.Service.{i}.TextRecord.{i}. |
object(0:) |
R |
This object maintains an instance of a (key/value pairs) of the service. The information is extracted from DNS TXT records [RFC1035] of the discovered service. When multiple instances of the TextRecord table have the same value for the Key parameter, the implementation is CPEdevice specific. |
- |
2.6 |
|
Device.NAT. |
object |
R |
Properties for Network Address Translation (NAT). This includes settings for IPv4 NAT within this object, and for IPv6-to-IPv6 Network Prefix Translation (NPTv6). Changes since 2.21:
|
- |
2.0 |
|
MaxNumberOfPortMappings |
unsignedInt |
R |
The maximum number of port mappings that can exist at any given time. When this limit is reached, creating a new port mapping fails. If the value of this parameter is 0, then it means that the device doesn't have a limit to the number of port mappings that can exist. |
- |
2.17 |
|
ProtocolMappingNumberOfEntries |
unsignedInt |
R |
The number of entries in the ProtocolMapping table. |
- |
2.22 |
|
MaxNumberOfProtocolMappings |
unsignedInt |
R |
The maximum number of protocol mappings that can exist at any given time. When this limit is reached, creating a new entry fails. If the value of this parameter is 0, then it means that the device doesn't have a limit to the number of protocol mappings that can exist. |
- |
2.22 |
|
MaxNumberOfPortTriggers |
unsignedInt |
R |
The maximum number of port triggers that can exist at any given time. When this limit is reached, creating a new port trigger fails. If the value of this parameter is 0, then it means that the device doesn't have a limit to the number of port mappingstriggers that can exist. |
- |
2.17 |
|
Device.NAT.InterfaceSetting.{i}. |
object(0:) |
W |
NAT settings for an associated IP Interface on which NAT is enabled. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. Note: The InterfaceSetting table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPEdevice will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated InterfaceSetting row to then violate the table's unique key constraint; if this occurs, the CPEdevice MUST set Status to Error_Misconfigured and disable the offending InterfaceSetting row. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface. |
- |
2.0 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.0 |
|
Device.NAT.PortMapping.{i}. |
object(0:) |
W |
Port mapping table. This table MUST contain all NAT port mappings associated with this connection, including static and dynamic port mappings programmatically created via local control protocol, such as UPnP. This table MUST NOT contain dynamic NAT binding entries associated with the normal operation of NAT. If the CPEdevice hosts a firewall, it is assumed that it will appropriately configure the firewall for the port mapping. For enabled table entries, if InternalClient is an empty string, or if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of RemoteHost, ExternalPort and Protocol. |
- |
2.0 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.0 |
|
Origin |
string |
R |
Indicates the Originowner of the PortMapping instance.}}{{div|{{classes}}|Note: This parameter was changed to writeOnceReadOnly in the Device:2.18 version. Note: This parameter was reverted back to readOnly in the Device 2.19 version. Enumeration of:
|
Controller |
2.17 |
|
RemoteHost |
string |
W |
This parameter is the IP address of the source of inbound packets. An empty string indicates a "wildcard", i.e. any IP address (this will be an empty string in most cases). CPEDevices are REQUIRED only to support an empty string. When RemoteHost is an empty string, all traffic sent to the ExternalPort on the WAN interface of the gateway is forwarded to the IP.Interface associated with the InternalClient on the InternalPort. When RemoteHost is specified as one external IP address, the NAT will only forward inbound packets from this RemoteHost to the InternalClient, all other packets will be dropped. If a CPEdevice supports non-empty values for RemoteHost, it MAY additionally support the ability to have more than one port mapping with the same ExternalPort and Protocol, but with differing values of RemoteHost. When wildcard values are used for RemoteHost and/or ExternalPort, the following precedence order applies (with the highest precedence listed first):
If an incoming packet matches the criteria associated with more than one entry in this table, the CPEdevice MUST apply the port mapping associated with the highest precedence entry. |
<Empty> |
2.0 |
|
ExternalPort |
unsignedInt(0:65535) |
W |
The external port (or the first port of a range of external ports) that the NAT gateway would listen on for traffic to a corresponding InternalPort. Inbound packets to this external port on the WAN interface SHOULD be forwarded to the IP.Interface associated with the InternalClient on the InternalPort. A value of zero (0) represents a "wildcard", i.e. any port number. If this value is 0, traffic on all external ports (that are not otherwise mapped) will be forwarded to InternalClient, and the value(s) of InternalPort on InternalClient are ignored. When wildcard values are used for RemoteHost and/or ExternalPort, the following precedence order applies (with the highest precedence listed first):
If an incoming packet matches the criteria associated with more than one entry in this table, the CPEdevice MUST apply the port mapping associated with the highest precedence entry. |
- |
2.0 |
|
InternalClient |
string(:256) |
W |
The IP address or DNS host name of an internal client (on the LAN). Support for an IP address is mandatory. If InternalClient is specified as an IP address and the LAN device's IP address subsequently changes, the port mapping MUST remain associated with the original IP address. Support for DNS host names is OPTIONAL. If InternalClient is specified as a DNS host name and the LAN device's IP address subsequently changes, the port mapping MUST remain associated with this LAN device. In this case, it is the responsibility of the CPEdevice to maintain the name-to-address mapping in the event of IP address changes. This can be accomplished, for example, by assigning the DNS host name via use of DHCP option 12 (Host Name) or option 81 (FQDN). Note that the Controller can learn the host name associated with a given LAN device via the Hosts.Host table. Read access to this parameter MUST always return the exact value that was last set by the Controller. For example, if the internal client is set to a DNS host name, it MUST read back as a DNS host name and not as an IP address. It MUST be possible to set the InternalClient to the broadcast IP address 255.255.255.255 for UDP mappings. This is to enable multiple NAT clients to use the same well-known port simultaneously. |
<Empty> |
2.0 |
|
Device.NAT.ProtocolMapping.{i}. |
object(0:) |
W |
Protocol mapping table. This table MUST contain all NAT protocol mappings associated with this connection, including static and dynamic protocol mappings programmatically created via local control protocol. This table MUST NOT contain dynamic NAT binding entries associated with the normal operation of NAT. If the device hosts a firewall, it is assumed that it will appropriately configure the firewall for the protocol mapping. For enabled table entries, if InternalClient is an empty string, or if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the device MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.22 |
|
Enable |
boolean |
W |
Enables or disables the protocol mapping instance. On creation, an entry is disabled by default. |
false |
2.22 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the device to indicate a locally defined error condition. |
Disabled |
2.22 |
|
Origin |
string |
R |
Indicates the owner of the ProtocolMapping instance. Enumeration of:
|
Controller |
2.22 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.22 |
|
Interface |
string(:256) |
W |
The value MUST be the Path Name of a row in the IP.Interface. or Logical.Interface. tables, or the Path Name of an interface layered above such a row, e.g., a row in the Logical.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the IP interface to which this protocol mapping applies. |
<Empty> |
2.22 |
|
AllInterfaces |
boolean |
W |
Indicates whether this protocol mapping applies to all interfaces that support protocol mappings. If true, the value of Interface is ignored since all supported IP interfaces are indicated. |
false |
2.22 |
|
RemoteHost |
string |
W |
This parameter is the IP address of the source of inbound packets. An empty string indicates a "wildcard", i.e. any IP address (this will be an empty string in most cases). Devices are REQUIRED only to support an empty string. When RemoteHost is an empty string, all traffic sent to the WAN interface of the gateway is forwarded to the IP.Interface associated with the InternalClient. When RemoteHost is specified as one external IP address, the NAT will only forward inbound packets from this RemoteHost to the InternalClient. If a device supports non-empty values for RemoteHost, it MAY additionally support the ability to have more than one protocol mapping with the same ProtocolNumber, but with differing values of RemoteHost. When wildcard values are used for RemoteHost, the following precedence order applies (with the highest precedence listed first):
If an incoming packet matches the criteria associated with more than one entry in this table, the device MUST apply the protocol mapping associated with the highest precedence entry. |
<Empty> |
2.22 |
|
ProtocolNumber |
unsignedInt(0:255)[] |
W |
Comma-separated list of unsigned integers (0 to 255). The protocol number of the ProtocolMapping. Values are taken from [IANA-protocolnumbers]. |
- |
2.22 |
|
InternalClient |
string(:256) |
W |
The IP address or DNS host name of an internal client (on the LAN). Support for an IP address is mandatory. If InternalClient is specified as an IP address and the LAN device's IP address subsequently changes, the protocol mapping MUST remain associated with the original IP address. Support for DNS host names is OPTIONAL. If InternalClient is specified as a DNS host name and the LAN device's IP address subsequently changes, the protocol mapping MUST remain associated with this LAN device. In this case, it is the responsibility of the device to maintain the name-to-address mapping in the event of IP address changes. This can be accomplished, for example, by assigning the DNS host name via use of DHCP option 12 (Host Name) or option 81 (FQDN). Note that the Controller can learn the host name associated with a given LAN device via the Hosts.Host table. Read access to this parameter MUST always return the exact value that was last set by the Controller. For example, if the internal client is set to a DNS host name, it MUST read back as a DNS host name and not as an IP address. |
<Empty> |
2.22 |
|
Description |
string(:256) |
W |
User-readable description of this protocol mapping. |
<Empty> |
2.22 |
|
ScheduleRef |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Schedules.Schedule. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Each reference provides a time schedule that controls when the associated feature or resource is active or inactive. When ScheduleRef is an empty string the ProtocolMapping is not scheduled, and the Enable defines the operational state. |
<Empty> |
2.22 |
|
Log |
boolean |
W |
Enable or disable logging, in a DeviceInfo.VendorLogFile, of packets matching this ProtocolMapping. |
false |
2.22 |
|
LogRef |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Firewall.Log. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Specifies the logging rules for this ProtocolMapping entry. The Log parameter MUST be set to true for this setting to take effect. When Log is true and LogRef is an empty string or contains an invalid reference, the system MUST treat the configuration as an error and set Status to Error_Misconfigured. |
<Empty> |
2.22 |
|
Device.NAT.PortTrigger.{i}. |
object(0:) |
W |
Firewall PortTrigger table. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.16 |
|
Origin |
string |
R |
Indicates the owner of the PortTrigger instance.}}{{div|{{classes}}|Note: This parameter was changed to writeOnceReadOnly in the Device:2.18 version. Note: This parameter was reverted back to readOnly in the Device 2.19 version. Enumeration of:
|
Controller |
2.16 |
|
ActivationDate |
dateTime |
R |
Indicates when the port trigger was enabled. WhenThis parameter is cleared when the port trigger is no longer active. Note: This parameter was demoted to readOnly in the Device:2.18 version. |
0001-01-01T00:00:00Z |
2.16 |
|
Device.NAT.NPTv6. |
object |
R |
Properties for IPv6-to-IPv6 Network Prefix Translation (NPTv6). NPTv6 is defined in [RFC6296]. The entire NPTv6 object only applies to IPv6. |
- |
2.21 |
|
Device.NAT.NPTv6.InterfaceSetting.{i}. |
object(0:) |
W |
NPTv6 settings for an associated IP Interface on which NPTv6 is enabled. For enabled table entries, if Interface is not a valid reference, or if ExternalPrefix or InternalPrefix are not configured, then the table entry is inoperable and the device MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both Interface and ExternalPrefix, or with the same values for both Interface and InternalPrefix. |
- |
2.21 |
|
Status |
string |
R |
The status of this InterfaceSetting instance. The status of this entry. Enumeration of:
|
- |
2.21 |
|
Device.PCP. |
object |
R |
Properties for Port Control Protocol (PCP) [RFC6887]. See the PCP Theory of Operation [Appendix XIV/TR-181i2] for a description of the working of this PCP data model. |
- |
2.8 |
|
Device.PCP.Client.{i}. |
object(0:) |
W |
Client properties for Port Control Protocol (PCP). The PCP Client interacts with a PCP Server as defined in [RFC6887] for internal device applications or LAN device applications via Interworking functions. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for WANInterface. |
- |
2.8 |
|
Status |
string |
R |
The status of the PCP Client. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.8 |
|
THIRDPARTYStatus |
string |
R |
Indicates whether THIRD_PARTY Option is enabled or not. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.8 |
|
Device.PCP.Client.{i}.PCPProxy. |
object |
R |
Properties for the Port Control Protocol (PCP) Proxy, as specified in [PCPProxy]. |
- |
2.8 |
|
HighestVersion |
unsignedInt(0:255) |
R |
A string identifying theThe highest version number of PCP that the proxy supports. This parameter is based on Version from [RFC6887]. Changes since 2.21:
|
- |
2.8 |
|
Status |
string |
R |
The status of the PCP Proxy for this PCP Client. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.8 |
|
Device.PCP.Client.{i}.UPnPIWF. |
object |
R |
Properties for the interworking function between UPnP IGD (Internet Gateway Device) and PCP, as specified in [RFC6970]. |
- |
2.8 |
|
Status |
string |
R |
The status of the UPnP IGD-PCP Interworking Function for this PCP Client. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.8 |
|
Device.PCP.Client.{i}.Server.{i}. |
object(0:) |
W |
This table contains the PCP Servers to be used by the PCP Client. Entries are either statically configured or automatically created via DHCP options OPTION_V4_PCP_SERVER and OPTION_V6_PCP_SERVER, as per [RFC7291]. Each OPTION_V4_PCP_SERVER or OPTION_V6_PCP_SERVER option corresponds to a Server instance. If an option returns multiple addresses then that Server instance has multiple addresses. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for ServerNameOrAddress. |
- |
2.8 |
|
Status |
string |
R |
The status of the PCP Server. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.8 |
|
Device.PCP.Client.{i}.Server.{i}.InboundMapping.{i}. |
object(0:) |
W |
Inbound Mapping table. This table contains all Inbound Mappings requested by this PCP Client on this PCP Server. Such a mapping is created by a PCP request with OpCode MAP, as described in [Section 11/RFC6887]. These requests can be issued from internal device applications, from static configuration or from other LAN device applications via interworking functions such as UPnP IGD or PCP proxies. The Origin parameter indicates which mechanism requested the mapping. For non-Static mappings (here Static refers to the mechanism that created the mapping, not to the Lifetime), the Controller MAY modify the Enable parameter but MUST NOT modify any other parameters in the mapping or its sub-objects. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of InternalPort, ProtocolNumber and ThirdPartyAddress. |
- |
2.8 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
The Error_PCPErrorCodeReceived value indicates that the PCP Client received an error code from the PCP Server. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.8 |
|
Lifetime |
unsignedInt |
W |
Determines the time to live, in seconds, of this Inbound Mapping lease, i.e. the remaining time before this port mapping expires. A value of 0 means that the port mapping is permanent (referred to as a static mapping in [RFC6887]). When a dynamic Inbound Mapping lease expires, the CPEdevice MUST automatically delete the corresponding InboundMapping table entry. Active Notification requests for this parameter MAY be denied. |
- |
2.8 |
|
Device.PCP.Client.{i}.Server.{i}.OutboundMapping.{i}. |
object(0:) |
W |
Outbound Mapping table. This table contains all Outbound Mappings requested by this PCP Client on this PCP Server. Such a mapping is created by a PCP request with OpCode PEER, as described in [Section 12/RFC6887]. These requests can be issued from internal device applications, from static configuration or from other LAN device applications via interworking functions such as UPnP IGD or PCP proxies. The Origin parameter indicates which mechanism requested the mapping. For non-Static mappings (here Static refers to the mechanism that created the mapping, not to the Lifetime), the Controller MAY modify the Enable parameter but MUST NOT modify any other parameters in the mapping or its sub-objects. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of InternalPort, ProtocolNumber, ThirdPartyAddress, RemoteHostIPAddress and RemotePort. |
- |
2.8 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
The Error_PCPErrorCodeReceived value indicates that the PCP Client received an error code from the PCP Server. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.8 |
|
Lifetime |
unsignedInt |
W |
Determines the time to live, in seconds, of this Outbound Mapping lease, i.e. the remaining time before this port mapping expires. A value of 0 means that the port mapping is permanent (referred to as a static mapping in [RFC6887]). When a dynamic Outbound Mapping lease expires, the CPEdevice MUST automatically delete the corresponding OutboundMapping table entry. |
- |
2.8 |
|
Device.DHCPv4. |
object |
R |
The Dynamic Host Configuration Protocol (DHCP) IPv4 object [RFC2131]. This entire object applies to IPv4 only. It contains the Client, Server, and Relay objects. |
- |
2.0 |
|
Device.DHCPv4.Client.{i}. |
object(1:) |
W |
This object contains DHCP client settings for an associated IP Interface indicated by Interface. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. Note: The Client table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPEdevice will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Client row to then violate the table's unique key constraint; if this occurs, the CPEdevice MUST set Status to Error_Misconfigured and disable the offending Client row. This table MUST contain at least 1 entry. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface. |
- |
2.0 |
|
Status |
string |
R |
The status of this table entry. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.0 |
|
Device.DHCPv4.Client.{i}.ReqOption.{i}. |
object(0:) |
W |
Each instance of this object represents a DHCP option that MUST, if enabled, be requested in DHCP client requests. All requested DHCP options MUST be listed. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Tag. |
- |
2.0 |
|
Value |
hexBinary(0:255) |
R |
A hexbinary encoded, most recently received DHCP option value. If no option value has been received, then the value MUST represent an empty string. Received DHCP option values MAY, but need not, persist across CPEdevice reboots. |
<Empty> |
2.0 |
|
Device.DHCPv4.Server. |
object |
R |
DHCP server configuration. |
- |
2.0 |
|
Device.DHCPv4.Server.Pool.{i}. |
object(0:) |
W |
DHCP conditional serving pool table. Each instance of this object defines a DHCP conditional serving pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCP options, and MAC address. Overlapping pool ranges MUST be supported. For enabled table entries, if Interface is not a valid reference, or MinAddress, MaxAddress, or SubnetMask is not a valid value, then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Order. |
- |
2.0 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.0 |
|
Device.DHCPv4.Server.Pool.{i}.Client.{i}. |
object(0:) |
R |
DHCPv4 client table. This table lists details of DHCPv4 clients that matched the filter criteria of this Pool entry. At most one entry in this table can exist with a given value for Alias, or with a given value for Chaddr. |
- |
2.2 |
|
Active |
boolean |
R |
Whether or not the DHCPv4 client is currently present on the LAN. The method of presence detection is a local matter to the CPE.device. The ability to list inactive DHCPv4 clients is OPTIONAL. If the CPEdevice includes inactive DHCPv4 clients in this table, Active MUST be set to false for each inactive DHCPv4 client. The length of time an inactive DHCPv4 client remains listed in this table is a local matter to the CPE.}}device. |
- |
2.2 |
|
Device.DHCPv4.Server.Pool.{i}.Client.{i}.IPv4Address.{i}. |
object(0:) |
R |
IPv4 addresses assigned to this client. At most one entry in this table can exist with a given value for IPAddress. Changes since 2.21:
|
- |
2.2 |
|
IsStatic |
boolean |
R |
IsStatic is true if and only if IPAddress was assigned from a static reservation (StaticAddress). |
- |
2.22 |
|
Device.DHCPv4.Relay. |
object |
R |
DHCP Relay Agent (conditional relaying). |
- |
2.0 |
|
Status |
string |
R |
The status of the DHCP relay. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.0 |
|
Device.DHCPv4.Relay.Forwarding.{i}. |
object(0:) |
W |
DHCP Relay Agent Forwarding table. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.0 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.0 |
|
LocallyServed |
boolean |
W |
If true, incoming DHCP requests will be forwarded to the CPEdevice DHCP Server. If false, incoming DHCP requests will be forwarded to the DHCPServerIPAddress configured for this forwarding entry. |
false |
2.0 |
|
Device.DHCPv6. |
object |
R |
The Dynamic Host Configuration Protocol (DHCP) IPv6 object [RFC9915]. This entire object applies to IPv6 only. It contains the Client and Server objects. |
- |
2.2 |
|
Device.DHCPv6.Client.{i}. |
object(1:) |
W |
This object contains DHCPv6 client settings for an associated IP Interface indicated by Interface. For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. Note: The Client table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPEdevice will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Client row to then violate the table's unique key constraint; if this occurs, the CPEdevice MUST set Status to Error_Misconfigured and disable the offending Client row. This table MUST contain at least 1 entry. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface. Changes since 2.21:
|
- |
2.2 |
|
Status |
string |
R |
The status of this table entry. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.2 |
|
DHCPStatus |
string |
R |
The DHCPv6 client protocol state as defined in [Section 18/RFC9915]. This parameter is only relevant when the DHCPv6 client is operationally enabled (i.e. when Status is Enabled). When both RequestAddresses and RequestPrefixes are false, the client operates in stateless mode, DHCPStatus remains Init, and StatelessStatus applies instead. Enumeration of:
|
Init |
2.22 |
|
StatelessStatus |
string |
R |
The status of the most recent stateless DHCPv6 Information-request exchange, as defined in [Section 18.2.6/RFC9915]. This parameter is only relevant when the client is operating in stateless mode, i.e. when both RequestAddresses and RequestPrefixes are false. When the client is not operating in stateless mode, StatelessStatus remains None and DHCPStatus applies instead. Enumeration of:
|
None |
2.22 |
|
DUID |
hexBinary(:130) |
R |
The client's DHCP Unique Identifier (DUID) [Section 11/RFC9915]. DUID is set by the CPE.}}device. |
- |
2.2 |
|
RequestAddresses |
boolean |
W |
Enables or disables inclusion of the Identity Association (IA) for Non-Temporary Address option OPTION_IA_NA(3) [Section 21.4/RFC9915] in Solicit messages. |
true |
2.2 |
|
RequestPrefixes |
boolean |
W |
Enables or disables inclusion of the Identity Association (IA) for Prefix Delegation option OPTION_IA_PD(25) [Section 21.21/RFC9915] in Solicit messages. Note that this is only appropriate for an upstream interface on a requesting router, e.g. for an RG WAN interface. |
false |
2.2 |
|
RapidCommit |
boolean |
W |
Enables or disables inclusion of the Rapid Commit option OPTION_RAPID_COMMIT(14) [Section 21.14/RFC9915] in Solicit messages. |
false |
2.2 |
|
Renew |
boolean |
W |
When set to true, the Client will renew its DHCPv6-supplied information (i.e. the CPEdevice will do a renew or information request as needed, updating both stateful and stateless parameter values discovered by this Client instance). |
false |
2.2 |
|
ForceSolicitPolicy |
boolean |
W |
Determines whether the DHCPv6 client waits for a Router Advertisement (RA) message [RFC4861] before initiating DHCPv6 negotiation. When false, the DHCPv6 client first waits for a Router Advertisement message to determine if DHCPv6 services are available (via 'M' and 'O' flags). This is the recommended behavior according to [Section 18.2.1/RFC9915]. When true, the client bypasses the wait for Router Advertisements and sends a Solicit message directly based on configured parameters such as RequestAddresses and RequestPrefixes. |
false |
2.21 |
|
SuggestedT1 |
int(-1:) |
W |
T1 value, in seconds, that the client SHOULD use when sending IA options, e.g. OPTION_IA_NA [Section 21.4/RFC9915] and OPTION_IA_PD [Section 21.21/RFC9915]. A value of -1 indicates that no T1 value is specified. |
- |
2.2 |
|
SuggestedT2 |
int(-1:) |
W |
T2 value, in seconds, that the client SHOULD use when sending IA options, e.g. OPTION_IA_NA [Section 21.4/RFC9915] and OPTION_IA_PD [Section 21.21/RFC9915]. A value of -1 indicates that no T2 value is specified. |
- |
2.2 |
|
RequestedOptions |
unsignedInt[] |
W |
Comma-separated list of unsigned integers. An ordered list of the top-level options (i.e. not encapsulated options) that the client will explicitly request from the server. This parameter is intended only for options that are not necessary for the basic operation of the protocol, and are not modeled elsewhere. For example, it is appropriate for OPTION_DNS_SERVERS [RFC3646] but is not appropriate for OPTION_SERVERID (which is part of the protocol), OPTION_IA_NA (which is modeled via RequestAddresses) or OPTION_IA_PD (which is modeled via RequestPrefixes). However, the CPEdevice MUST NOT reject an attempt to set this parameter to a value that includes options that it regards as inappropriate; instead, it MUST accept the requested options and handle them as best it can. Loosely speaking, these are the options that the client will include in OPTION_ORO [RFC9915] but the client is free to decide (in accordance with [RFC9915]) in which messages to request which option, whether also to request additional options, whether not to request inappropriate options, and in which order to request any options that are also in SupportedOptions. |
- |
2.2 |
|
AuthenticationProtocol |
string |
W |
Specifies the authentication protocol to be used, as explained in [Chapter 20.2 Summary of DHCP Authentication/RFC9915]. Enumeration of:
|
None |
2.19 |
|
LastRenewSentTime |
dateTime |
R |
The date and time when the last RENEW message was sent to the DHCPv6 server [Section 18.2.4/RFC9915]. LastRenewSentTime is 0001-01-01T00:00:00Z when its value is unknown. |
- |
2.22 |
|
LastRebindSentTime |
dateTime |
R |
The date and time when the last REBIND message was sent to the DHCPv6 server [Section 18.2.5/RFC9915]. LastRebindSentTime is 0001-01-01T00:00:00Z when its value is unknown. |
- |
2.22 |
|
LastRenewSuccessful |
boolean |
R |
Indicates whether the last RENEW exchange was successful, i.e., a Reply was received in response to the Renew message [Section 18.2.4/RFC9915]. false if no successful RENEW exchange has occurred since the client last started. |
- |
2.22 |
|
LastRebindSuccessful |
boolean |
R |
Indicates whether the last REBIND exchange was successful, i.e., a Reply was received in response to the Rebind message [Section 18.2.5/RFC9915]. false if no successful REBIND exchange has occurred since the client last started. |
- |
2.22 |
|
LastBoundTime |
dateTime |
R |
The date and time when the DHCPv6 client last successfully obtained or extended a lease, whether via initial binding [Section 18.2.2/RFC9915], RENEW [Section 18.2.4/RFC9915], or REBIND [Section 18.2.5/RFC9915]. LastBoundTime is 0001-01-01T00:00:00Z when its value is unknown. |
- |
2.22 |
|
Device.DHCPv6.Client.{i}.Server.{i}. |
object(0:) |
R |
This is a transitory table that lists the discovered DHCPv6 servers (it does not model a local DHCP server). Table entries are automatically created to correspond with these servers. However, it is a local matter to the CPEdevice when to delete old table entries. At most one entry in this table can exist with a given value for SourceAddress. |
- |
2.2 |
|
DUID |
hexBinary(:130) |
R |
The server's DHCP Unique Identifier (DUID) [Section 11/RFC9915] as received via OPTION_SERVERID. |
- |
2.2 |
|
Device.DHCPv6.Client.{i}.SentOption.{i}. |
object(0:) |
W |
The top-level options and option values (including any encapsulated options) that the client will send to the server. This table is intended only for options that are not part of the basic operation of the protocol, and whose values are simple, do not often change and are not modeled elsewhere. For example, it is appropriate for OPTION_USER_CLASS (whose value is a list of user classes) but is not appropriate for OPTION_RECONF_MSG (which is part of the protocol), OPTION_IA_NA (which is modeled via RequestAddresses) or OPTION_RAPID_COMMIT (which is modeled via RapidCommit). At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Tag. |
- |
2.2 |
|
Tag |
unsignedInt(0:65535) |
W |
Option tag (code) [Section 21.1/RFC9915]. |
- |
2.2 |
|
Value |
hexBinary(0:65535) |
W |
A hexbinary encoded option data [Section 21.1/RFC9915]. Note: The length of the option data is option-len octets, as specified in [Section 21.1/RFC9915]. |
<Empty> |
2.2 |
|
Device.DHCPv6.Client.{i}.ReceivedOption.{i}. |
object(0:) |
R |
This is a transitory table that lists all the options received from all servers. Table entries are automatically created to correspond with received options. However, it is a local matter to the CPEdevice when to delete old table entries. If the same option is received multiple times, whether from one or more servers, it is up to the CPEdevice to decide which entries to include (i.e. whether the same option will be present multiple times). In order to allow for the same option to be present multiple times within the table, this table has no unique key defined. |
- |
2.2 |
|
Tag |
unsignedInt(0:65535) |
R |
Option tag (code) [Section 21.1/RFC9915]. |
- |
2.2 |
|
Value |
hexBinary(0:65535) |
R |
A hexbinary encoded option data [Section 21.1/RFC9915]. |
- |
2.2 |
|
Device.DHCPv6.Client.{i}.Retransmission. |
object |
R |
This object enables the configuration of the DHCPv6 retransmission behavior according to the guidelines described in [Section 7.6/RFC9915]. |
- |
2.18 |
|
TimeoutRandomize |
int |
W |
The Randomization factor for the retransmission timeout, in ms, as defined in [Section 15 Reliability of Client-Initiated Message Exchanges/RFC9915]. E.g. a timeout of 1000ms with a randomization of 100 will end up between 900 and 1100 ms. |
100 |
2.18 |
|
Device.DHCPv6.Client.{i}.Stats. |
object |
R |
Provide statistics for the embedded DHCPv6 Client. |
- |
2.19 |
|
Solicit |
unsignedLong |
R |
[StatsCounter64] The total number of SOLICIT messages sent by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
Advertise |
unsignedLong |
R |
[StatsCounter64] The total number of ADVERTISE messages received by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
Request |
unsignedLong |
R |
[StatsCounter64] The total number of REQUEST messages sent by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
Confirm |
unsignedLong |
R |
[StatsCounter64] The total number of CONFIRM messages sent by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
Renew |
unsignedLong |
R |
[StatsCounter64] The total number of RENEW messages sent by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
Rebind |
unsignedLong |
R |
[StatsCounter64] The total number of REBIND messages sent by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
Reply |
unsignedLong |
R |
[StatsCounter64] The total number of REPLY messages received by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
Release |
unsignedLong |
R |
[StatsCounter64] The total number of RELEASE packets sent by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
Decline |
unsignedLong |
R |
[StatsCounter64] The total number of DECLINE messages sent by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
Reconfigure |
unsignedLong |
R |
[StatsCounter64] The total number of RECONFIGURE messages received by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
InformationRequest |
unsignedLong |
R |
[StatsCounter64] The total number of INFORMATION-REQUEST messages sent by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
Device.DHCPv6.Server. |
object |
R |
DHCPv6 server configuration. |
- |
2.2 |
|
Device.DHCPv6.Server.Pool.{i}. |
object(0:) |
W |
DHCPv6 server pool table. Each instance of this object defines a DHCPv6 server pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCPv6 options, and source address. Overlapping pool ranges MUST be supported. For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack) then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Order. |
- |
2.2 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.2 |
|
DUID |
hexBinary(:130) |
W |
Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCPv6 Client Identifier (Option 1) [Section 21.2/RFC9915]. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used. Note: DHCPv6 Option 1 (DUID) is sometimes referred to as Client Identifier. |
<Empty> |
2.2 |
|
VendorClassID |
hexBinary(:65535) |
W |
Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCPv6 Vendor Class Identifier (Option 16) [Section 21.16/RFC9915]. The option value is binary, so an exact match is REQUIRED. An empty string indicates this criterion is not used. |
<Empty> |
2.2 |
|
UserClassID |
hexBinary(:65535) |
W |
Pool association criterion. A hexbinary string used to identify one or more LAN devices, value of the DHCPv6 User Class Identifier (Option 15) [Section 21.15/RFC9915]. An empty string indicates this criterion is not used. |
<Empty> |
2.2 |
|
IAPDPrefixes |
string[:8]() |
R |
Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. All prefixes for which IA_PD prefixes will be assigned. This list can include:
|
- |
2.2 |
|
Device.DHCPv6.Server.Pool.{i}.Client.{i}. |
object(0:) |
R |
DHCPv6 client table. This table lists details of DHCPv6 clients that matched the filter criteria of this Pool entry. At most one entry in this table can exist with a given value for Alias, or with a given value for SourceAddress. |
- |
2.2 |
|
Active |
boolean |
R |
Whether or not the DHCPv6 client is currently present on the LAN. The method of presence detection is a local matter to the CPE.device. The ability to list inactive DHCPv6 clients is OPTIONAL. If the CPEdevice includes inactive DHCPv6 clients in this table, Active MUST be set to false for each inactive DHCPv6 client. The length of time an inactive DHCPv6 client remains listed in this table is a local matter to the CPE.}}device. |
- |
2.2 |
|
Device.DHCPv6.Server.Pool.{i}.Client.{i}.Option.{i}. |
object(0:) |
R |
DHCPv6 options supplied by this client, e.g. DUID (Option 1), UserClassID (Option 15) or VendorClassID (option 16). |
- |
2.2 |
|
Tag |
unsignedInt(0:65535) |
R |
Option tag (code) [Section 21.1/RFC9915]. |
- |
2.2 |
|
Device.DHCPv6.Server.Pool.{i}.Option.{i}. |
object(0:) |
W |
This object specifies the DHCPv6 options that, if enabled, can be offered to clients whose DHCPv6 requests are associated with this pool. If PassthroughClient is specified, and the referenced client has a value for a given option then the PassthroughClient option value will be sent instead of Value. Otherwise, Value will be sent. If Force is specified, it determines that the option is always sent or only when requested by the client. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Tag. |
- |
2.2 |
|
Tag |
unsignedInt(0:65535) |
W |
Option tag (code) [Section 21.1/RFC9915]. |
- |
2.2 |
|
Device.DHCPv6.Server.Stats. |
object |
R |
Provide statistics for the embedded DHCPv6 Server. |
- |
2.19 |
|
Solicit |
unsignedLong |
R |
[StatsCounter64] The total number of SOLICIT messages received by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
Advertise |
unsignedLong |
R |
[StatsCounter64] The total number of ADVERTISE messages sent by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
Request |
unsignedLong |
R |
[StatsCounter64] The total number of REQUEST messages received by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
Confirm |
unsignedLong |
R |
[StatsCounter64] The total number of CONFIRM messages received by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
Renew |
unsignedLong |
R |
[StatsCounter64] The total number of RENEW messages received by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
Rebind |
unsignedLong |
R |
[StatsCounter64] The total number of REBIND messages received by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
Reply |
unsignedLong |
R |
[StatsCounter64] The total number of REPLY messages sent by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
Release |
unsignedLong |
R |
[StatsCounter64] The total number of RELEASE packets received by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
Decline |
unsignedLong |
R |
[StatsCounter64] The total number of INFORM messages received by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
Reconfigure |
unsignedLong |
R |
[StatsCounter64] The total number of RECONFIGURE messages sent by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
InformationRequest |
unsignedLong |
R |
[StatsCounter64] The total number of INFORMATION-REQUEST messages received by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
RelayForward |
unsignedLong |
R |
[StatsCounter64] The total number of RELAY-FORW messages received by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
RelayReply |
unsignedLong |
R |
[StatsCounter64] The total number of RELAY-REPL messages sent by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC9915]. |
- |
2.19 |
|
Device.IEEE8021x. |
object |
R |
IEEE 802.1x object [802.1x-2004], where Supplicant models authentication supplicants. |
- |
2.0 |
|
Device.IEEE8021x.Supplicant.{i}. |
object(1:) |
W |
802.1x supplicant authentication provisioning and status information associated with an interface to be authenticated (e.g. an Ethernet.Link instance). For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. Note: The Supplicant table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPEdevice will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Supplicant row to then violate the table's unique key constraint; if this occurs, the CPEdevice MUST set Status to Error_Misconfigured and disable the offending Supplicant row. This table MUST contain at least 1 entry. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface. |
- |
2.0 |
|
Status |
string |
R |
The current operational status of this 802.1x supplicant. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.0 |
|
Device.UPnP. |
object |
R |
This object contains all UPnP related objects and parameters including Device and Discovery related objects and parameters. |
- |
2.0 |
|
Device.UPnP.Device. |
object |
R |
This object defines the UPnP devices and UPnP services that are implemented by the CPE.}}device. |
- |
2.0 |
|
Device.UPnP.Discovery. |
object |
R |
UPnP [UPnP-DAv1] SSDP discovered root devices, embedded devices and embedded services. The CPEdevice MAY, but need not, retain some or all of the information in this object across reboots. |
- |
2.0 |
|
Device.UPnP.Discovery.RootDevice.{i}. |
object(0:) |
R |
UPnP root device table. This table contains an entry for each UPnP root device that has been discovered via SSDP. At most one entry in this table can exist with a given value for UUID. |
- |
2.0 |
|
Status |
string |
R |
The status of the UPnP root device. Enumeration of:
The ability to list inactive UPnP root devices is OPTIONAL. The length of time an inactive device remains listed in this table is a local matter to the CPE.}}device. |
- |
2.0 |
|
Device.UPnP.Discovery.Device.{i}. |
object(0:) |
R |
UPnP embedded device table. This table contains an entry for each UPnP embedded device that has been discovered via SSDP. At most one entry in this table can exist with a given value for UUID. |
- |
2.0 |
|
Status |
string |
R |
The status of the UPnP embedded device. Enumeration of:
The ability to list inactive UPnP embedded devices is OPTIONAL. The length of time an inactive device remains listed in this table is a local matter to the CPE.}}device. |
- |
2.0 |
|
Device.UPnP.Discovery.Service.{i}. |
object(0:) |
R |
UPnP embedded service table. This table contains an entry for each UPnP embedded service that has been discovered via SSDP. At most one entry in this table can exist with a given value for USN. |
- |
2.0 |
|
Status |
string |
R |
The status of the UPnP embedded service. Enumeration of:
The ability to list inactive UPnP embedded services is OPTIONAL. The length of time an inactive service remains listed in this table is a local matter to the CPE.}}device. |
- |
2.0 |
|
Device.UPnP.Description. |
object |
R |
This object contains information from the Description Document discovered from the UPnP Devices and Services. |
- |
2.6 |
|
Device.UPnP.Description.DeviceDescription.{i}. |
object(0:) |
R |
This table contains information read from the Device Description Document of discovered root devices. The CPEdevice MAY, but need not, retain some or all of the information in this table after the associated SSDP advertisement (objects in the UPnP.Discovery. object tables) expires. In case the SSDP advertisement expires and the CPEdevice deletes the related instances from the tables in UPnP.Discovery., the reference to such instances MUST be set to the empty string. At most one entry in this table can exist with a given value for URLBase. |
- |
2.6 |
|
Device.UPnP.Description.DeviceInstance.{i}. |
object(0:) |
R |
This table contains the information from Device Description Document retrieved for a discovered UPnP root or embedded device. At most one entry in this table can exist with a given value for UDN. |
- |
2.6 |
|
DiscoveryDevice |
string(:256) |
R |
The value MUST be the Path Name of a Discovery.RootDevice table entry (if this is a root device) or a Discovery.Device table entry (if this is an embedded device). If the referenced object is deleted, the parameter value MUST be set to an empty string. This DiscoveryDevice value can be an empty string because the referenced object has been deleted or the CPEdevice was unable to retrieve the Description Document due to some out-of-band error. The determination to delete this DeviceInstance or use an empty string is implementation specific. |
- |
2.6 |
|
Device.UPnP.Description.ServiceInstance.{i}. |
object(0:) |
R |
This table contains the information from Device Description Document retrieved for a discovered UPnP service. At most one entry in this table can exist with the same values for both ParentDevice and ServiceId. |
- |
2.6 |
|
ServiceDiscovery |
string(:256) |
R |
The value MUST be the Path Name of a Discovery.Service table entry. If the referenced object is deleted, the parameter value MUST be set to an empty string. This ServiceDiscovery value can be an empty string because the referenced object has been deleted or the CPEdevice was unable to retrieve the Description Document due to some out-of-band error. The determination to delete this ServiceInstance or use an empty string is implementation specific. |
- |
2.6 |
|
Device.Firewall. |
object |
R |
Firewall configuration object. The Config parameter enables and disables the Firewall, and can select either a predefined configuration (High or Low) or an explicitly-defined Advanced configuration. For an Advanced configuration, AdvancedLevel controls the currently active Firewall Level, and the Firewall Levels are defined in the Level, Chain and Chain.{i}.Rule tables. For an Policy configuration, PolicyLevel controls the currently active Firewall Level, and the Firewall Levels are defined in the Policy, Level, Chain and Chain.{i}.Rule tables. The Firewall rules modeled by Chain, DMZ and Pinhole operate only on the forwarding path. This means that they affect only routed traffic, and do not affect traffic that is destined for or generated by the device itself. Traffic destined for or generated by the device itself can use the Service object to model the appropriate Firewall rules. Note that any NAT processing on the ingress packet occurs before Firewall rules are applied so, for example, the Firewall rules will see the translated destination IP address and port in a downstream packet that has passed through the NAT. See [Appendix VIII/TR-181i2] for an example Advanced configuration. Changes since 2.21:
|
- |
2.0 |
|
Config |
string |
W |
How this firewall is configured. Enumeration of:
Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106] MUST be adhered to. |
- |
2.0 |
|
Version |
string(:16) |
R |
A string identifying the firewall settings version currently used in the CPE,device, or an empty string if the firewall settings are not associated with a version. |
- |
2.0 |
|
MaxNumberOfPinholes |
unsignedInt |
R |
The maximum number of pinholes that can exist at any given time. When this limit is reached, creating a new pinhole fails. If the value of this parameter is 0, then it means that the device doesn't have a limit to the number of pinholes that can exist. |
- |
2.22 |
|
Device.Firewall.Policy.{i}. |
object(0:) |
W |
Firewall Policy table. When a Policy configuration is selected, PolicyLevel selects the currently active entry in this table. Each Policy table entry references the Chain that contains the rules for this policy. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. Changes since 2.21:
|
- |
2.16 |
|
Status |
string |
R |
The status of this Policy entry. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.16 |
|
Origin |
string |
R |
Indicates the owner of the Policy instance. Enumeration of: |
Controller |
2.22 |
|
Device.Firewall.Chain.{i}. |
object(0:) |
W |
Firewall Chain table. Each entry contains an ordered list of Rule objects which can themselves reference other Chain instances. A hierarchy of rules can therefore be created. A given Firewall Chain's rules are all created by the same entity, as indicated by the Creator parameter. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.2 |
|
Device.Firewall.Chain.{i}.Rule.{i}. |
object(0:) |
W |
Firewall Rule table. Each entry defines a Firewall packet selection rule. The Target parameter defines the action to perform for traffic matching this rule: the packet can be dropped, accepted, rejected or passed to another Chain. This table MUST NOT contain dynamic Firewall rules associated with Stateful Firewall sessions. All entries are created by the creator of the parent Chain, as indicated by its Creator parameter. Rule entries in a Chain with a Creator of Defaults, ACS, UserInterface or (maybe) Other are referred to as Static Rules. Whether or not a Rule in a Chain with Creator Other is regarded as Static is a local matter to the CPE.device. Some of this object's parameter descriptions refer to whether a Rule is Static when specifying whether or not the parameter value can be modified. For enabled table entries, if SourceInterface is not a valid reference and SourceAllInterfaces is false, or if DestInterface is not a valid reference and DestAllInterfaces is false, then the table entry is inoperable and the CPEdevice MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.2 |
|
Status |
string |
R |
The status of this Rule entry. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
Disabled |
2.2 |
|
Log |
boolean |
W |
Enable or disable logging, in a DeviceInfo.VendorLogFile, of packets matching this Rule. If the Rule is not Static (as explained in the object description), whether changes to this parameter persist across re-boot is a local matter to the CPE.}}device. |
false |
2.2 |
|
ExpiryDate |
dateTime |
W |
The time at which this Rule entry will expire, or 0001-01-01T00:00:00Z if not known. For an infinite lifetime, the parameter value MUST be 9999-12-31T23:59:59Z. The only value that MUST be supported is 9999-12-31T23:59:59Z (i.e. support for rules that expire is OPTIONAL). When a rule expires, the CPEdevice MUST automatically terminate that rule and MUST automatically delete the corresponding Rule table entry. This parameter can only be modified if the Rule is Static (as explained in the object description). |
9999-12-31T23:59:59Z |
2.2 |
|
SourceInterface |
string(:256) |
W |
Rule criterion. The value MUST be the Path Name of a table row. This specifies the ingress interface associated with the entry. It MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which Rules can be instantiated is a local matter to the CPE.device. This parameter can only be modified if the Rule is Static (as explained in the object description). |
<Empty> |
2.2 |
|
DestInterface |
string(:256) |
W |
Rule criterion. The value MUST be the Path Name of a table row. This specifies the egress interface associated with the entry. It MAY be a layer 1, 2 or 3 interface, however, the types of interfaces for which Rules can be instantiated is a local matter to the CPE.device. This parameter can only be modified if the Rule is Static (as explained in the object description). |
<Empty> |
2.2 |
|
Device.Firewall.Pinhole.{i}. |
object(0:) |
W |
Firewall Pinhole object that is used for configuring pinholes. Pinholes are similar to port mapping entries but without the NAT support. The Pinhole table is used for allowing certain incoming traffic, on the Interface, to be routed to the internal network. For enabled table entries, if DestMACAddress and DestIP are an empty string, or if Interface is not a valid reference, then the table entry is inoperable and the device MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.16 |
|
Origin |
string |
R |
Indicates the Originowner of the Pinhole instance.}}{{div|{{classes}}|Note: This parameter was changed to writeOnceReadOnly in the Device:2.18 version. Note: This parameter was reverted back to readOnly in the Device 2.19 version. Enumeration of:
|
Controller |
2.16 |
|
Device.Firewall.DMZ.{i}. |
object(0:) |
W |
Firewall DMZ object that is be used for configuring a demilitarized zone. A DMZ network is a separate network perimeter that protects the internal network from untrusted traffic. Typically the DMZ is located between two firewalls, the firewall of the internal network and the firewall responsible for handling untrusted traffic. The device MUST forward all received packets that matches the SourcePrefix criteria to the IP address that is specified in DestIP. For enabled table entries, if DestIP is an empty string, or if Interface is not a valid reference, then the table entry is inoperable and the device MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both DestIP and SourcePrefix. |
- |
2.16 |
|
Origin |
string |
R |
Indicates whothe configuredowner of the DMZ instance.}}{{div|{{classes}}|Note: This parameter was changed to writeOnceReadOnly in the Device:2.18 version. Note: This parameter was reverted back to readOnly in the Device 2.19 version. Enumeration of: |
Controller |
2.16 |
|
Device.Firewall.Service.{i}. |
object(0:) |
W |
Firewall Service object that is used for configuring the firewall for opening a port/protocol for a local network service. For example:
For enabled table entries, if Interface, DestPort and Protocol are an empty string, or if Interface is not a valid reference, then the table entry is inoperable and the device MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. Changes since 2.21:
|
- |
2.16 |
|
Origin |
string |
R |
Indicates the owner of the Service instance. Enumeration of: |
Controller |
2.22 |
|
Device.Firewall.InterfaceSetting.{i}. |
object(0:) |
W |
Firewall settings for an associated IP Interface. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the device MUST set Status to Error_Misconfigured. Note: The InterfaceSetting includes a unique key that is a strong reference. If a strongly referenced object is deleted, the device will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated InterfaceSetting row to then violate the table's unique key constraint; if this occurs, the device MUST set Status to Error_Misconfigured and disable the offending InterfaceSetting row. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface. Changes since 2.21:
|
- |
2.17 |
|
IPv4SpoofingExceptions |
string(:49)[] |
W |
[IPv4Prefix] Comma-separated list of IPv4Prefixs. Each item in the list is an IPv4 address or CIDR prefix that is exempt from spoofing protection checks. Packets originating from these addresses are accepted even when IPv4SpoofingProtection is enabled. An empty string means no exceptions are configured. |
<Empty> |
2.22 |
|
IPv6SpoofingExceptions |
string(:49)[] |
W |
[IPv6Prefix] Comma-separated list of IPv6Prefixs. Each item in the list is an IPv6 address or CIDR prefix that is exempt from spoofing protection checks. Packets originating from these addresses are accepted even when IPv6SpoofingProtection is enabled. An empty string means no exceptions are configured. |
<Empty> |
2.22 |
|
IPv4AcceptUDPTraceroute |
boolean |
W |
Enables or disables the acceptance of UDP-based traceroute packets for IPv4. E.g., port numbers in the range 33434 to 33534. When true, UDP packets with destination ports in this range are accepted. When false, such packets are dropped. |
- |
2.22 |
|
IPv6AcceptUDPTraceroute |
boolean |
W |
Enables or disables the acceptance of UDP-based traceroute packets for IPv6. E.g., port numbers in the range 33434 to 33534. When true, UDP packets with destination ports in this range are accepted. When false, such packets are dropped. |
- |
2.22 |
|
IsolateInterfaces |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the IP.Interface. table, or the Path Name of an interface layered above such a row, e.g., a row in the Logical.Interface. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Each item is a reference to an IP or Logical interface from which the interface referenced by Interface is isolated. When one or more interfaces are listed, the firewall blocks traffic between Interface and each listed interface, preventing direct communication between them. An empty string means no interface isolation is configured. |
<Empty> |
2.22 |
|
Device.Firewall.Set.{i}. |
object(0:) |
W |
This object is used for configuring sets of IP, MAC addresses and/or port numbers which can then be used in conjunction with the firewall. It provides a more efficient way to manage large collections of addresses and ports compared to traditional methods of listing them individually within firewall rules. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name. |
- |
2.18 |
|
Origin |
string |
R |
Indicates the Originowner of the Set instance. Note: This parameter was changed to readOnly in the Device 2.19 version. Enumeration of: |
Controller |
2.18 |
|
Device.Firewall.Log.{i}. |
object(0:) |
W |
Firewalls monitor network traffic and enforce security policies. To aid in debugging and troubleshooting potential issues, it's possible to capture specific information when certain rules are triggered. These captured details, known as traces, are then logged by the implementation for further analysis. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. Changes since 2.21:
|
- |
2.19 |
|
Origin |
string |
R |
Indicates the owner of the Log instance. Enumeration of: |
Controller |
2.22 |
|
Device.PeriodicStatistics. |
object |
R |
This object configures collection of periodic statistics for the device. Periodic statistics are measured over a sample interval (which can be
aligned with absolute time) and are made available to the Controller as
a comma-separated list of the most recent This object provides a single set of global settings that affect the entire device unless overridden locally. |
- |
2.0 |
|
MinSampleInterval |
unsignedInt |
R |
Minimum sample interval in seconds that the CPEdevice is able to support. A value of 0 indicates no specific minimum sample interval. |
- |
2.0 |
|
MaxReportSamples |
unsignedInt |
R |
Maximum number of samples of each statistic that the CPEdevice is able to store and report. A value of 0 indicates no specific maximum number of samples. |
- |
2.0 |
|
Device.PeriodicStatistics.SampleSet.{i}. |
object(0:) |
W |
Periodic statistics sample set table. Each sample set has its own sample interval etc. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name. |
- |
2.0 |
|
SampleInterval |
unsignedInt(1:) |
W |
The sample interval in seconds. Each statistic is measured over this sample interval. The CPEdevice MAY also support an internal sampling rate (implementation dependent) that is faster than the SampleInterval and allows the CPEdevice to support the various options available in Parameter.{i}.CalculationMode. The CPEdevice MAY reject a request to set SampleInterval to less than MinSampleInterval. Sample intervals MUST begin every SampleInterval seconds, with no delay between samples. If SampleInterval is changed while collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately. For example, if ReportSamples is 24 and SampleInterval is 3600 (an hour), the CPEdevice can store up to a day's worth of samples for each statistic. |
3600 |
2.0 |
|
ReportSamples |
unsignedInt(1:) |
W |
The number of samples that the CPEdevice will store and report for each statistic. The CPEdevice MUST permit ReportSamples to be set to at least MaxReportSamples. If ReportSamples is changed while collection of periodic statistics is enabled, the CPEdevice will truncate or extend its statistics buffers as appropriate, but statistics collection MUST NOT otherwise be affected. For example, if ReportSamples is 24 and SampleInterval is 3600 (an hour), the CPEdevice can store up to a day's worth of samples for each statistic. |
24 |
2.0 |
|
Device.PeriodicStatistics.SampleSet.{i}.Parameter.{i}. |
object(0:) |
W |
Periodic statistics parameter table for this sample set. This table contains entries for parameters whose values are to be sampled. Note that the comma-separated lists in this object (SampleSeconds, SuspectData and Values) only ever change (a) when first enabled, (b) when Device.PeriodicStatistics.SampleSet.{i}.ForceSample has been used to force statistics for the current sample to be calculated (a "sneak preview" of the current sample), or (c) at the end of the sample interval. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Reference. |
- |
2.0 |
|
Failures |
unsignedInt |
R |
Counts the number of times (since this object instance was last enabled) that a newly-calculated sample value (accounting for SampleMode) transitioned from the "in range" state to the "out of range" state, or between the "out of range (low)" and "out of range (high)" states. The states are defined as follows:
Note that, if LowThreshold and HighThreshold are both the same, the threshold/failure mechanism is disabled, so the value of this parameter will not increment. This parameter can be incremented at any time during a sample interval, and might be incremented more than once during a single sample interval. For this reason, the CPEdevice SHOULD place a locally specified limit on the frequency at which it will notify the Controller of such changes. Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters. |
0 |
2.0 |
|
Device.PeriodicFileTransfer. |
object |
R |
This object serves as the central control for managing file uploads to a remote server. It allows for periodic transfers of various file types, such as logs, crash dumps, and kernel oopses. Individual upload configurations are defined within instances of the Profile object. |
- |
2.20 |
|
Device.PeriodicFileTransfer.Profile.{i}. |
object(0:) |
W |
This object defines a reusable profile for configuring file uploads. Each profile specifies the common parameters for transferring files to a remote server, such as the protocol to be used. Multiple transfer tasks (Transfer) can reference the same profile. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.20 |
|
Device.PeriodicFileTransfer.Profile.{i}.HTTP. |
object |
R |
This object defines the HTTP/HTTPS transport properties for a transfer file upload profile. This object is used when the Protocol parameter has a value of HTTP. For authentication purposes the Device MUST support HTTP Basic and Digest Access Authentication as defined in [RFC7617] and [RFC7616]. |
- |
2.20 |
|
Device.PeriodicFileTransfer.Profile.{i}.HTTP.RequestURIParameter.{i}. |
object(0:) |
W |
This object represents an instance of a parameter to be used in the report header used as part of the HTTP Request-URI transmitted by the CPEdevice to the collection server using the Request-URI in addition to the parameters required by [Annex N.2.1/TR-069]. |
- |
2.20 |
|
Device.PeriodicFileTransfer.Transfer.{i}. |
object(0:) |
W |
This object specifies the parameters for an individual file transfer task. Each instance specifies a file to be transferred, the method of transfer (periodic or on-demand), and a reference to a Profile.{i}. object containing the server connection details. The Status parameter reflects the current state of the transfer process, which can transition through the following sequences:
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.20 |
|
Origin |
string |
R |
Indicates the Origin of the Transfer instance. Enumeration of: |
Controller |
2.20 |
|
Device.FaultMgmt. |
object |
R |
This object contains parameters relating to Fault/Alarm Management. |
- |
2.4 |
|
Device.FaultMgmt.HistoryEvent.{i}. |
object(0:) |
R |
Alarm events added or updated in CurrentAlarm are simultaneously entered into the this table. This table also contains alarm clearing events. Active alarms at the time of a power failure or reboot might not get an alarm clearing event. This object has a fixed number of entries with instance numbers from 1 to HistoryEventNumberOfEntries. If maximum instance number HistoryEventNumberOfEntries is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic "rolling" of records. At most one entry in this table can exist with the same values for both EventTime and AlarmIdentifier. |
- |
2.4 |
|
Device.FaultMgmt.ExpeditedEvent.{i}. |
object(0:) |
R |
Alarm events added or updated in CurrentAlarm are simultaneously entered into the this table if their corresponding entry in SupportedAlarm has SupportedAlarm.{i}.ReportingMechanism set to 0 Expedited. This table also contains alarm clearing events. This object has a fixed number of entries with instance numbers from 1 to ExpeditedEventNumberOfEntries. Initially the table starts with all instances having EventTime set to the Unknown Time value, as defined in [TR-106]. If maximum instance number ExpeditedEventNumberOfEntries is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic "rolling" of records. When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the Controller (even if their new values are identical to those of the prior alarm). At most one entry in this table can exist with a given value for AlarmIdentifier. |
- |
2.4 |
|
Device.FaultMgmt.QueuedEvent.{i}. |
object(0:) |
R |
Alarm events added or updated in CurrentAlarm are simultaneously entered into the this table if their corresponding entry in SupportedAlarm has SupportedAlarm.{i}.ReportingMechanism set to 1 Queued. This table also contains alarm clearing events. This object has a fixed number of entries with instance numbers from 1 to QueuedEventNumberOfEntries. Initially the table starts with all instances having EventTime set to the Unknown Time value, as defined in [TR-106]. If maximum instance number QueuedEventNumberOfEntries is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic "rolling" of records. When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the Controller (even if their new values are identical to those of the prior alarm). At most one entry in this table can exist with a given value for AlarmIdentifier. |
- |
2.4 |
|
Device.Security. |
object |
R |
This object contains general information related to managing security features on the device. Changes since 2.21:
|
- |
2.4 |
|
ClientCertificateDefaultNumberOfEntries |
unsignedInt |
R |
The number of entries in the ClientCertificateDefault table. |
- |
2.22 |
|
Device.Security.Certificate.{i}. |
object(0:) |
R |
This table provides information about all types of public key-based credentials, such as X.509 certificates, see [RFC5280]. At most one entry in this table can exist with a given value for Alias, or with the same values for both SerialNumber and Issuer, or with a given value for Name. Changes since 2.21:
|
- |
2.4 |
|
RenewalMode |
string |
W |
Specifies the automatic certificate update mode. When auto-update is triggered, certificate information is copied from Certificate to populate the new CSR. Enumeration of:
|
- |
2.22 |
|
RenewalInterval |
unsignedInt |
W |
Number of days before NotAfter at which the device automatically initiates a new CSR, as determined by RenewalMode. A value of 0, or None for RenewalMode, disables auto-update. If RenewalInterval is greater than or equal to the certificate validity period (the interval between NotBefore and NotAfter), or if the computed trigger date (NotAfter minus RenewalInterval days) already lies in the past, the device SHOULD initiate auto-update immediately. See [Section 4.1.2.5/RFC5280] for the certificate validity period definition. |
- |
2.22 |
|
HasPrivateKey |
boolean |
R |
true when the device has the private key for this certificate. false when the device does not have the private key (e.g., imported CA certificate for trust chain validation). |
- |
2.22 |
|
Device.Security.CABundle.{i}. |
object(0:) |
R |
This table stores information about a group of Certificate Authorities (CAs). A CA is a trusted entity that issues digital certificates used to verify the identity of servers, clients, or other entities in secure communication protocols like TLS. This group defines a collection of trusted CA certificates that can be used to validate server certificates during TLS connections. At most one entry in this table can exist with a given value for Name, or with a given value for Alias. Changes since 2.21:
|
- |
2.19 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.22 |
|
Device.Security.ClientCertificateDefault.{i}. |
object(0:) |
R |
This table provides a default Certificate and CABundle for commands that are invoked without explicitly specifying them as a parameter. At most one entry in this table can exist with a given value for Alias, or with a given value for Type. |
- |
2.22 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.22 |
|
Certificate |
string |
W |
The value MUST be the Path Name of a row in the Security.Certificate. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the client certificate that must be presented to the remote server for mutual authentication. This certificate is used to authenticate the client by the remote server, ensuring that the remote server is communicating with a trusted client. The client certificate must be issued by a trusted Certificate Authority (CA) and should match the client's private key. This parameter is applicable only when a TLS session is being used. |
- |
2.22 |
|
CABundle |
string |
W |
The value MUST be the Path Name of a row in the Security.CABundle. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the group of CA certificate(s) that the client must use to validate the certificate presented by the remote server. These CA certificates form a trust chain that the server certificate must match, ensuring that only servers with trusted certificates can establish a connection. This parameter supports multiple CA certificates to accommodate different server certificate issuers. This parameter is applicable only when a TLS session is being used. |
- |
2.22 |
|
Type |
string[] |
W |
Comma-separated list of strings. Specifies the command this entry applies to. Each list item is an enumeration of:
|
- |
2.22 |
|
Device.FAP. |
object |
R |
This object is the container for all Femto related component objects, to prevent pollution of the so-called global namespace of the BBF with FAP specific objects. |
- |
2.4 |
|
Device.FAP.GPS. |
object |
R |
This object contains the parameters relating to the GPS scan. |
- |
2.4 |
|
PeriodicTime |
dateTime |
W |
An absolute time reference in UTC to determine when the CPEdevice will initiate the periodic GPS scan. Each GPS scan MUST occur at (or as soon as possible after) this reference time plus or minus an integer multiple of the PeriodicInterval. PeriodicTime is used only to set the "phase" of the GPS scan. The actual value of PeriodicTime can be arbitrarily far into the past or future. For example, if PeriodicInterval is 86400 (a day) and if PeriodicTime is set to UTC midnight on some day (in the past, present, or future) then periodic GPS scans will occur every day at UTC midnight. These MUST begin on the very next midnight, even if PeriodicTime refers to a day in the future. The Unknown Time value defined in [Section 3.2/TR-106] indicates that no particular time reference is specified. That is, the CPEdevice MAY locally choose the time reference, and needs only to adhere to the specified PeriodicInformInterval. If absolute time is not available to the CPE,device, its periodic GPS scan behavior MUST be the same as if PeriodicTime parameter was set to the Unknown Time value. |
- |
2.4 |
|
Device.BulkData. |
object |
R |
This object provides bulk data collection capabilities and global collection settings that affect the entire device. Bulk Data utilizes various solutions (e.g., IPDR, HTTP) to collect data from devices and transfer the data to a collection server. The IPDR solution is based on a service specification described in [TR-232]. The HTTP solution is based on transfer mechanisms described in [Annex N/TR-069]. The Bulk Data Collection Profiles are measured over a reporting interval (which can be aligned with absolute time) and are made available to the collection server. |
- |
2.5 |
|
MinReportingInterval |
unsignedInt |
R |
Minimum reporting interval in seconds that the CPEdevice is capable of supporting. A value of 0 indicates no minimum reporting interval. |
- |
2.5 |
|
MaxNumberOfProfiles |
int(-1:) |
R |
The maximum number of profiles that can exist at any given time. Specifically, the maximum number of Profile.{i}. instances that the Controller can create. When this limit is reached, creating a new profile fails. If the value of this parameter is -1, then it means that the CPEdevice doesn't have a limit to the number of profiles that can exist. |
- |
2.5 |
|
MaxNumberOfParameterReferences |
int(-1:) |
R |
The maximum number of parameters that can be referenced via the bulk data collection mechanism. Specifically, the maximum number of parameters that can be referenced via Profile.{i}.Parameter.{i}.Reference across all Profile and Parameter instances (including the expansion of partial paths within the Reference parameter). When this limit is reached, creating a new parameter reference fails. If the value of this parameter is -1, then it means that the CPEdevice doesn't have a limit to the number of parameterparameters that can be referenced via the bulk data collection mechanism. |
- |
2.5 |
|
Device.BulkData.Profile.{i}. |
object(0:) |
W |
A set of Bulk Data Collection profiles. Each profile represents a bulk data report, including its own timing configuration, communications configuration, and set of parameters. This allows the Controller to configure multiple reports to be generated at different times for different sets of data. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.5 |
|
NumberOfRetainedFailedReports |
int(-1:) |
W |
The number of failed reports to be retained and transmitted (in addition to the current report) at the end of the current reporting interval. If the value of the EncodingType parameter is modified any outstanding failed reports are deleted. If the CPEdevice cannot retain the number of failed reports from previous reporting intervals while transmitting the report of the current reporting interval, then the oldest failed reports are deleted until the CPEdevice is able to transmit the report from the current reporting interval. A value of 0 indicates that failed reports are not to be retained for transmission in the next reporting interval. A value of -1 indicates that the CPEdevice will retain as many failed reports as possible. |
0 |
2.10 |
|
ReportingInterval |
unsignedInt(1:) |
W |
The reporting interval in seconds. Each report is generated based on this interval and TimeReference. The CPEdevice MAY reject a request to set ReportingInterval to less than MinReportingInterval. Reporting intervals MUST begin every ReportingInterval seconds. If ReportingInterval is changed while collection is enabled, the first reporting interval begins immediately. For example, if ReportingInterval is 86400 (a day) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then the CPEdevice will generate (and transmit) its report at midnight every 24 hours. |
86400 |
2.5 |
|
TimeReference |
dateTime |
W |
An absolute time reference in UTC to determine when will be transmitted. Each reporting interval MUST complete at this reference time plus or minus an integer multiple of ReportingInterval, unless unable to due to higher prioritized operations. TimeReference is used only to set the "phase" of the reporting intervals. The actual value of TimeReference can be arbitrarily far into the past or future. If TimeReference is changed while collection of bulk data is enabled, the first reporting interval begins immediately. The Unknown Time value as defined in [TR-106] indicates that no particular time reference is specified. That is, the CPEdevice MAY locally choose the time reference, and is required only to adhere to the specified reporting intervals. If absolute time is not available to the CPE,device, its reporting interval behavior MUST be the same as if the TimeReference parameter was set to the Unknown Time value. For example, if ReportingInterval is 86400 (a day) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then the CPEdevice will generate (and transmit, if in a "ITPush" mode) its report at midnight every 24 hours. Note that, if TimeReference is set to a time other than the Unknown Time, the first reporting interval (which has to begin immediately) will almost certainly be shorter than ReportingInterval). This is why TimeReference is defined in terms of when reporting intervals complete rather than start. |
0001-01-01T00:00:00Z |
2.5 |
|
Device.BulkData.Profile.{i}.Parameter.{i}. |
object(0:) |
W |
Bulk data parameter table. Each entry in this table represents a parameter (or set of parameters if a partial path is provided) to be either collected and reported, or omitted if Exclude is true. |
- |
2.5 |
|
Reference |
string(:256) |
W |
Represents the parameter(s) that are part of this Bulk Data collection profile. The value MUST be a path name of a parameter or an object. When the ParameterWildCardSupported parameter has a value of true, patterns for instance identifiers are permitted with wildcards (an "*" character) in place of instance identifiers; any attempt to set the value otherwise MUST be rejected by the CPE.device. In the case where an Object Path is specified, the sub-objects of the resolved pattern and contained parameters will be part of the bulk data collected and reported. If the path name refers to an object then it MUST end with a '.'. |
<Empty> |
2.5 |
|
Device.BulkData.Profile.{i}.CSVEncoding. |
object |
R |
This object defines the properties to be used when the Profile object's EncodingType parameter value is CSV. |
- |
2.10 |
|
RowTimestamp |
string |
W |
The format of the timestamp to use for data inserted into the row. Enumeration of:
|
Unix-Epoch |
2.10 |
|
Device.BulkData.Profile.{i}.JSONEncoding. |
object |
R |
This object defines the properties to be used when the Profile object's EncodingType parameter value is JSON. |
- |
2.10 |
|
ReportTimestamp |
string |
W |
The format of timestamp to use for the JSON Object named "CollectionTime" as described in [Annex N.3.5/TR-069]. Enumeration of:
|
Unix-Epoch |
2.10 |
|
Device.BulkData.Profile.{i}.HTTP. |
object |
R |
This object defines the properties to be used when transporting bulk data using the HTTP/HTTPS protocol. This object is used when the Protocol parameter has a value of HTTP. For authentication purposes the CPEdevice MUST support HTTP Basic and Digest Access Authentication as defined in [RFC7617] and [RFC7616]. |
- |
2.10 |
|
URL |
string(:2048) |
W |
The [URL] for the collection server to receive the Bulk Data transmitted by the CPE.}}device. |
- |
2.10 |
|
Username |
string(:256) |
W |
Username used to authenticate the CPEdevice when making a connection to the collection server. |
- |
2.10 |
|
Password |
string(:256) |
W |
Password used to authenticate the CPEdevice when making a connection to the collection server. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.10 |
|
CompressionsSupported |
string[] |
R |
Comma-separated list of strings. Indicates the HTTP Compression mechanism(s) supported by this CPEdevice for the purposes of transferring bulk data. Each list item is an enumeration of:
|
- |
2.10 |
|
Compression |
string |
W |
The value MUST be a member of the list reported by the CompressionsSupported parameter, or else be None. The value of this parameter represents the HTTP Compression mechanism to be used by the CPEdevice when transferring data to the collection server. |
None |
2.10 |
|
MethodsSupported |
string[] |
R |
Comma-separated list of strings. Indicates the HTTP method(s) supported by this CPEdevice for the purposes of transferring bulk data. Each list item is an enumeration of:
|
- |
2.10 |
|
Method |
string |
W |
The value MUST be a member of the list reported by the MethodsSupported parameter. The value of this parameter represents the HTTP method to be used by the CPEdevice when transferring data to the collection server. |
POST |
2.10 |
|
UseDateHeader |
boolean |
W |
When true, the CPEdevice encodes the HTTP Date Header [Section 14.18/RFC2616] in the HTTP client request. |
true |
2.10 |
|
RetryEnable |
boolean |
W |
When true, the CPEdevice retries unsuccessful attempts to transfer data. |
false |
2.10 |
|
Device.BulkData.Profile.{i}.HTTP.RequestURIParameter.{i}. |
object(0:) |
W |
This object represents an instance of a parameter to be used in the report header used as part of the HTTP Request-URI transmitted by the CPEdevice to the collection server using the Request-URI in addition to the parameters required by [Annex N.2.1/TR-069]. |
- |
2.10 |
|
Device.SoftwareModules. |
object |
R |
Top level object for dynamically managed applications. Since Device:2.15, the Software Module data model has undergone significant enhancements, particularly in expanding support for new concepts, e.g. ExecEnvClass.{i}., ExecEnv.{i}.ApplicationData.{i}., ExecutionUnit.{i}.AutoRestart., ExecutionUnit.{i}.NetworkConfig., ExecutionUnit.{i}.HostObject.{i}, and ExecutionUnit.{i}.EnvVariable.{i}.. However, the CWMP protocol lacks native capabilities to dynamically manage these new concepts. At best, CWMP can be used to view the available configurations. For more dynamic and interactive management of these concepts, the USP protocol should be utilized. |
- |
2.1 |
|
Device.SoftwareModules.ExecutionUnit.{i}. |
object(0:) |
R |
This table serves as the Execution Unit inventory and contains both status information about each Execution Unit as well as configurable parameters for each Execution Unit. Each DeploymentUnit that is installed can have zero or more Execution Units. Once a Deployment Unit is installed it populates this table with its contained Execution Units. When the Deployment Unit (that caused this ExecutionUnit to come into existence) is updated, this instance MAY be removed and new instances MAY come into existence. While the Deployment Unit (that caused this ExecutionUnit to come into existence) is being updated, all ExecutionUnit instances associated with the Deployment Unit will be stopped until the update is complete at which time they will be restored to the state that they were in before the update started. When the Deployment Unit (that caused this ExecutionUnit to come into existence) is uninstalled, this instance is removed. Each ExecutionUnit MAY also contain a set of vendor specific parameters displaying status and maintaining configuration that reside under the Extensions object. At most one entry in this table can exist with a given value for EUID, or with a given value for Alias. Changes since 2.21:
|
- |
2.1 |
|
EnableHostNSCapabilities |
boolean |
R |
Indicates whether this ExecutionUnit has been granted additional capabilities that apply to the host namespaces. This parameter is only applicable when Privileged is false.
|
- |
2.22 |
|
Device.XMPP. |
object |
R |
The XMPP represents the XMPP capabilities of the device, as described in [Appendix III/TR-069]. |
- |
2.7 |
|
SupportedServerConnectAlgorithms |
string[] |
R |
Comma-separated list of strings. The algorithms supported by the CPEdevice for resolving XMPP server addresses and ports. Each list item is an enumeration of:
|
- |
2.11 |
|
Device.XMPP.Connection.{i}. |
object(0:) |
W |
The Connection represents a XMPP connection between the device and a server. The Username, Domain and Resource comprise the full identity (JabberID) of this Connection for this device. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of Username, Domain and Resource. |
- |
2.7 |
|
Password |
string(:256) |
W |
Password used to authenticate this Connection when making a connection to the Server using the procedure outlined in [Section 6/RFC6120]. Note that on a factory reset of the CPE,device, the value of this parameter might be reset to its factory value. If a Controller modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.7 |
|
UseTLS |
boolean |
W |
This parameter allows a Controller to configure whether or not this XMPP Connection is required to use TLS independent of whether or not the XMPP Server that is being connected to is configured for TLS "mandatory-to-negotiate". If the value of UseTLS is true then the CPEdevice will initiate TLS negotiation if not required to by the XMPP Server. If the value of UseTLS is false then the CPEdevice will not initiate TLS negotiation if not required to by the XMPP Server. |
false |
2.7 |
|
Device.IEEE1905. |
object |
R |
This object represents the management functions for the 1905 capabilities as defined in [IEEE1905.1a]. |
- |
2.9 |
|
Device.IEEE1905.AL. |
object |
R |
This object represents the management functions for the 1905 Abstraction Layer as defined in [Section 4.4 Abstraction Layer/IEEE1905.1a]. |
- |
2.9 |
|
Status |
string |
R |
The current operational state of the 1905 Abstraction Layer. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.9 |
|
Device.MQTT. |
object |
R |
MQTT Base object describing all MQTT related parameters and objects. |
- |
2.10 |
|
Device.MQTT.Capabilities. |
object |
R |
Indicates the MQTT capabilities of the device. |
- |
2.10 |
|
MaxNumberOfClientSubscriptions |
unsignedInt |
R |
Indicates the maximum number of subscriptions per MQTT client, which can be stored in the Client.{i}.Subscription table. When this limit is reached, creating a new subscription fails. A value of 0 means no limit. |
- |
2.10 |
|
MaxNumberOfBrokerBridges |
unsignedInt |
R |
Indicates the maximum number of bridges, which can be configured in the Broker.{i}.Bridge table. When this limit is reached, creating a new bridge fails. A value of 0 means no limit. |
- |
2.10 |
|
MaxNumberOfBrokerBridgeSubscriptions |
unsignedInt |
R |
Indicates the maximum number of subscriptions, which can be stored per bridge instance in the Broker.{i}.Bridge.{i}.Subscription table. When this limit is reached, creating a new subscription fails. A value of 0 means no limit. |
- |
2.10 |
|
Device.MQTT.Client.{i}. |
object(0:) |
W |
MQTT client table. Contains a list of configured MQTT clients. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.10 |
|
Status |
string |
R |
Indicates the status of this MQTT client. Enumeration of:
The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid (e.g. The MQTT client can not use the defined port, because it is blocked) The Error_BrokerUnreachable value indicates that the connection to the MQTT broker could not be established. The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.10 |
|
WillEnable |
boolean |
W |
Enables or disables the will handling (see [Section 3.1/MQTT311], [Section 3.1.2.5/MQTT311]) or [Section 3.1.2.5/MQTT50]). If the connection gets enabled and this parameter is set to true and either the parameter WillTopic or WillValue are an empty string, the CPEdevice MUST set the Status to Error_Misconfigured. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the parameter ForceReconnect has to be set as well.. |
- |
2.10 |
|
Device.MQTT.Client.{i}.Subscription.{i}. |
object(0:) |
W |
List of MQTT subscriptions handled by the MQTT client. The MQTT client MUST subscribe with the MQTT broker for all subscription instances, whose parameter Enable is set to true, when it establishes a new connection to the MQTT broker. Disabled subscription instances with Enable set to false will be ignored during connection establishment. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Topic. |
- |
2.10 |
|
Status |
string |
R |
Indicates the status of this subscription. Enumeration of:
The Subscribed value indicates that the topic was successfully subscribed with the MQTT broker, the MQTT client received the SUBACK message for this topic from the server. The Subscribing value MAY be used by the CPEdevice to indicate that the a SUBSCRIBE message for this topic was sent, and the CPEdevice is waiting for a SUBACK message. The Unsubscribed value indicates that the topic is not registered with the MQTT broker. The Unsubscribing value MAY be used by the CPEdevice to indicate that an UNSUBSCRIBE message for this topic was sent, and the CPEdevice is waiting for an UNSUBACK message. If the Enable is set to false the status MUST be either Unsubscribed or if the unsubscription failed Error. |
- |
2.10 |
|
Device.MQTT.Client.{i}.Stats. |
object |
R |
Contains the MQTT client statistics and usage information. The CPEdevice MUST reset the Stats parameters after the MQTT client gets (re-)enabled or if the MQTT client connects with a new MQTT broker (e.g. BrokerAddress has changed). The CPEdevice MAY retain the values across a reboot if it reconnects with the same MQTT broker. |
- |
2.10 |
|
Device.MQTT.Broker.{i}. |
object(0:) |
W |
Each entry in this table configures a single listener for the local MQTT broker. This allows the device to accept incoming MQTT client connections on different ports or with different security protocols (e.g., separate listeners for encrypted (e.g., TLS) and unencrypted connections). At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.10 |
|
Status |
string |
R |
Indicates the status of the MQTT broker. Enumeration of:
The "Error_Misconfigured" value indicates that a necessary configuration value is undefined or invalid. The "Error" value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.10 |
|
Interface |
string(:256) |
W |
The value MUST be the Path Name of a row in the IP.Interface. table, or the Path Name of an interface layered above such a row, e.g., a row in the Logical.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. If an empty string is specified, the CPEdevice MUST bind the MQTT broker to all available interfaces, which depends on the value of the IPVersion parameter. Meaning that the broker will bind to an IPv4 address, an IPv6 address, or both. |
- |
2.10 |
|
Device.DynamicDNS. |
object |
R |
Properties for Dynamic DNS. |
- |
2.10 |
|
SupportedServices |
string[](:1024) |
R |
Comma-separated list (maximum number of characters 1024) of strings. List of Dynamic DNS service names that are supported by the CPE.}}device. |
- |
2.10 |
|
Device.DynamicDNS.Client.{i}. |
object(0:) |
W |
Client properties for Dynamic DNS. A dynamic DNS client is responsible for verifying IP address changes and updating information from a subscribed account on a Dynamic DNS Server. For enabled table entries, if Server is not a valid reference then the table entry is inoperable and the CPEdevice MUST set the Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both Server and Username. |
- |
2.10 |
|
Device.DynamicDNS.Server.{i}. |
object(0:) |
W |
Table of Dynamic DNS servers available for this CPE.}}device. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name. |
- |
2.10 |
|
SupportedProtocols |
string[] |
R |
Indicates the protocols that are supported by the CPEdevice for sending requests to the Dynamic DNS server. Comma-separated list of strings. This list depends on the Dynamic DNS service defined by the ServiceName parameter. Each list item is an enumeration of: |
- |
2.10 |
|
CheckInterval |
unsignedInt |
W |
Interval (in seconds) between two checks for IP change. A value of zero indicates that the CPEdevice knows when IP changes and doesn’t need to check it periodically. |
- |
2.10 |
|
Device.LEDs. |
object |
R |
This object describes the LEDs on the device. |
- |
2.11 |
|
BrightnessLimiter |
unsignedInt(0:100) |
W |
The maximum allowed brightness level for all LEDs, expressed as a percentage. This value is relative to the maximum allowed brightness value of each LED, which is specified in LED.{i}.MaxBrightness. Valid values are: 0 percentage to 100 percentage (The value 0 indicates that all LEDs are turned off, while the value 100 indicates the maximum brightness). This value serves as the default brightness limit for all LEDs and is overridden on a per-LED basis by LED.{i}.BrightnessLimiter. |
- |
2.20 |
|
Device.LEDs.LED.{i}. |
object(0:) |
R |
Each instance of this object describes an LED on the device. The default illumination characteristics (e.g., Color, Brightness) of an in use LED is vendor specific. When a cycle completes (i.e., CyclePeriodRepetitions = 0), the LED reverts back to its default illumination characteristics. When the value of the Status parameter is Controlled, then the value of CyclePeriodRepetitions and CycleElementNumberOfEntries parameters SHOULD be 0. When the value of the RelativeXPosition and RelativeYPosition parameters are 0, this indicates that the position of the LED is unknown. When the value of the ControllingPeripheral parameter is specified, the CyclePeriodRepetitions, CycleElement.{i}., and CurrentCycleElement. objects are not applicable. At most one entry in this table can exist with a given value for Name, or with a given value for Alias. Changes since 2.21:
|
- |
2.11 |
|
Status |
string |
R |
The status of the LED. Enumeration of:
|
- |
2.11 |
|
BrightnessLimiter |
int(-1,0:100) |
W |
The maximum allowed brightness level for this LED, expressed as a percentage. This value is relative to the maximum allowed brightness value of this LED, which is specified in MaxBrightness. When BrightnessLimiter is different from -1, it takes precedence for this LED instance over the general LEDs default BrightnessLimiter. Valid values are: -1 percentage (The value -1 indicates that the brightness limit for this LED is the same as the default brightness limit specified in BrightnessLimiter), or 0 percentage to 100 percentage (The value 0 indicates that this LED is turned off, while the value 100 indicates the maximum brightness). |
- |
2.22 |
|
Device.LEDs.LED.{i}.CycleElement.{i}. |
object(0:) |
W |
Each instance of this object describes the LED characteristics for a portion of the LED cycle period. The pattern of lighting for the LED corresponding to this table (i.e., the LED cycle period) is defined by the illumination of the LED according to the entries in this table, taken sequentially in the order specified by the Order parameter, with the duration for the portion of the LED illumination corresponding to a given instance specified by the Duration parameter. The other parameters of the instance of this object (e.g., Color, Brightness) describes the illumination characteristics applied to the LED for this CycleElement instance. The length of the complete LED cycle is the sum of the Duration parameters for all of the entries in this table. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Order. |
- |
2.11 |
|
Color |
hexBinary(3) |
W |
The color being displayed by the LED RGB hexadecimal notation (e.g., FF0088). Note: If the parameter is set to an unsupported color the CPEdevice MUST NOT infer a different color. |
- |
2.11 |
|
Brightness |
unsignedInt(0:100) |
W |
The desired brightness level for this element of the cycle period, expressed as a percentage, relative to the maximum allowed brightness value specified in MaxBrightness. The value should not exceedrespect the maximum brightness levellimits that are specified in {{param: non-existent .LEDs.BrightnessLimiter and LEDs.LED.{i}.BrightnessLimiter}}. |
- |
2.19 |
|
Device.BASAPM. |
object |
R |
This object represents the objects necessary to manage and control the functionality for tests that utilize the Broadband Access Service Attributes and Performance Metrics measurement test framework as defined in by [TR-304]. |
- |
2.12 |
|
Device.LMAP. |
object |
R |
This object represents the objects necessary to manage and control the functionality for Large-Scale Measurement of Broadband Performance[RFC7594] as defined in by [LMAPIFM]. |
- |
2.12 |
|
Device.LMAP.MeasurementAgent.{i}. |
object(0:) |
W |
This object represents the measurement agent that performs measurement tasks and reporting functions defined in [RFC7594]. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Identifier. |
- |
2.12 |
|
Device.LMAP.MeasurementAgent.{i}.Controller. |
object |
R |
This objectsobject represents the measurement controller that is assigned to a measurement agent. |
- |
2.12 |
|
ControlChannels |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a CommunicationChannel object. If the referenced object is deleted, the corresponding item MUST be removed from the list. The measurement agent to measurement controller channel is used for conveying results of communication sessions with the configuration, instruction status and logging information elements defined in defined in [LMAPIFM]. |
- |
2.12 |
|
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}. |
object(0:) |
W |
This object represents a schedule that is associated with a set of scheduled actions to be performed by a measurement agent. Note: Actions of an occurrence of this Schedule are gracefully terminated by the defining either the End or Duration parameters. Only one of these parameters may be defined at a time. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name. |
- |
2.12 |
|
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}. |
object(0:) |
W |
This object represents an action that is associated with the this Schedule object. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}.Option.{i}. |
object(0:) |
W |
This object represents an option associated with the Scheduled Action. When an option with the same Name exists between the SeheduledScheduled Action's Option and The Task's option, the option of the Scheduled Action takes precedence over the option associated with the Task. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name. |
- |
2.12 |
|
Device.LMAP.MeasurementAgent.{i}.Instruction.{i}. |
object(0:) |
W |
The Instruction object defines the instruction to the measurement agent by the measurement controller. At most one Instruction object for the MeasurementAgent instance is enabled at a time. .}} At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
|
Device.LMAP.Report.{i}. |
object(0:) |
R |
This Report object instance represents a report that is generated by a reporting task where the reporting task is defined as a MeasurementAgent.{i}.Task.{i} and executed as a scheduled action (MeasurementAgent.{i}.Schedule.{i}.Action.{i}). The Report replicates the MeasurementAgent.{i} object instance's data at the time of the action execution. When a BulkData.Profile.{i} object instance is used to communicate a Report instance, the CPEdevice adds a BulkData.Profile.{i}.Parameter.{i} object instance referring to this Report object instance. |
- |
2.12 |
|
Device.LMAP.Report.{i}.Result.{i}. |
object(0:) |
R |
The Result object provides the meta-data of the result report of a single executed action that produced the result. At most one entry in this table can exist with the same values for all of ScheduleName, ActionName and StartTime. |
- |
2.12 |
|
Device.LMAP.Report.{i}.Result.{i}.ReportTable.{i}. |
object(0:) |
R |
ThisInstances of this ReportTable object instances representsrepresent a row of results. |
- |
2.12 |
|
Device.LMAP.Report.{i}.Result.{i}.ReportTable.{i}.ResultRow.{i}. |
object(0:) |
R |
ThisInstances of this ResultRow object instances representsrepresent a row of results for the report. |
- |
2.12 |
|
Device.LMAP.Event.{i}. |
object(0:) |
W |
This object defines the information associated with an event used within the measurement agent. Event instances may be referenced by various objects within the LMAP model. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name. |
- |
2.12 |
|
CycleInterval |
int |
W |
The duration of the time interval, in seconds, that is used to calculate cycle numbers. |
- |
2.12 |
|
Device.WWC. |
object |
R |
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 |
|
HwCapabilities |
string[] |
R |
Comma-separated list of strings. Wireline Wireless Convergence hardware capabilities supported by the CPE.device. Each list item is an enumeration of:
|
- |
2.14 |
|
SwCapabilities |
string[] |
R |
Comma-separated list of strings. Wireline Wireless Convergence software capabilities supported by the CPE.device. Each list item is an enumeration of: |
- |
2.14 |
|
Mode |
string |
W |
Sets the mode the CPEdevice is operating in. Whilst the CPEdevice is expected to auto-negotiate, a service provider may need to lock the CPEdevice in FN-RG or 5G-RG mode for stability. Enumeration of:
The factory default value MUST be Auto. |
- |
2.14 |
|
Status |
string |
R |
The mode the CPEdevice is operating in. A CPEdevice in Negotiating is deemed to be auto-negotiating its operational mode. Enumeration of:
|
- |
2.14 |
|
Device.WWC.AccessNetwork.{i}. |
object(0:) |
R |
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 |
|
Name |
string(:64) |
R |
The textual name of the Access Network entry as assigned by the CPE.}}device. |
- |
2.14 |
|
RegistrationStatus |
string |
R |
The registration status of this entry. See [Clause 5.3.2/3GPP-TS.23.501]. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.14 |
|
ConnectionStatus |
string |
R |
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:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.14 |
|
Device.WWC.AccessNetwork.{i}.GUTI. |
object |
R |
A 5G Globally Unique Temporary Identity (GUTI) securely identifies an CPEdevice 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 |
|
TMSI |
unsignedInt |
R |
The Temporary Mobile Subscriber Identity (TMSI) is allocated by the AMF at the time of registration and uniquely identifies the CPE.device. See [Clause 2.4/3GPP-TS.23.003]. |
- |
2.14 |
|
Device.PDU. |
object |
R |
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. This object was DEPRECATED in 2.19 because it is no longer a top level object. This object was OBSOLETED in 2.21. This object was DELETED in 2.22. Changes since 2.21:
|
- |
2.14 |
|
Device.FWE. |
object |
R |
5G Wireline wireless Encapsulation transport for data plane. See [RFC8822]. |
- |
2.14 |
|
Device.FWE.Link.{i}. |
object(0:) |
R |
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 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.14 |
|
Device.FWE.Link.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice 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.14 |
|
Device.Logical. |
object |
R |
Logical object. This object models several Logical interface objects, each representing a different stack layer, including: Interface. Interface is a logical interface which can point to other stackable interface layers. The intention of the logical interface is to simplify the configuration management of individual [TR-181i2] services. Instead of configuring the individual network services with a physical interface and deal with reconfiguration problems that may arise from switching between WAN interfaces. The intention is that the network services are configured with a logical interface and that this configuration stays unchanged during the switching between WAN interfaces. The software service (For example a WAN mode manager.) responsible for handling the WAN interface changes must then only care about rewriting the LowerLayers parameter of the Logical Interface Objects. |
- |
2.16 |
|
Device.Logical.Interface.{i}. |
object(0:) |
W |
Logical interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models only logical interfaces. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.16 |
|
Device.Logical.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice 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]. This information SHOULD be mirrored or aggregated from the active underlying interfaces. |
- |
2.16 |
|
Device.Logical.TUN. |
object |
R |
TUN (network TUNnel) virtual interface container object. TUN interfaces are Layer 3 virtual network devices that operate at the IP packet level. They are commonly used for VPN implementations, IP tunneling, and network virtualization scenarios where applications need to handle IP packets directly without dealing with Layer 2 Ethernet framing. |
- |
2.21 |
|
Device.Logical.TUN.Interface.{i}. |
object(0:) |
R |
TUN virtual interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each entry represents a Layer 3 virtual network interface that handles IP packets. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.21 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.21 |
|
Device.Logical.TUN.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice 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.21 |
|
Device.Logical.TAP. |
object |
R |
TAP (network tap) virtual interface container object. TAP interfaces are Layer 2 virtual network devices that operate at the Ethernet frame level. They simulate a complete Ethernet adapter and are commonly used for network bridging, virtual machine networking, and scenarios where applications need full access to Ethernet frames including Layer 2 protocols. |
- |
2.21 |
|
Device.Logical.TAP.Interface.{i}. |
object(0:) |
R |
TAP virtual interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each entry represents a Layer 2 virtual network interface that handles Ethernet frames. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.21 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.21 |
|
Device.Logical.TAP.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice 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.21 |
|
Device.XPON. |
object |
R |
This object models one or more xPON interfaces or ONUs as specified by the ITU based PON standards. It does not address IEEE based PON standards (like EPON). An ONU performs tasks such as traffic classification, VLAN manipulation, GEM port mapping, aggregation and/or forwarding between one or more UNIs and one or more ANIs. |
- |
2.16 |
|
Device.XPON.ONU.{i}. |
object(0:) |
R |
This object models one xPON interface or ONU as specified by the ITU based PON standards. At most one entry in this table can exist with a given value for Name. |
- |
2.16 |
|
Name |
string(:64) |
R |
The textual name of the ONU as assigned by the CPE.}}device. |
- |
2.16 |
|
Device.XPON.ONU.{i}.EthernetUNI.{i}. |
object(0:) |
R |
Ethernet UNI table (a stackable interface object as described in [Section 4.2/TR-181i2]). This object models User Network Interfaces carrying Ethernet frames. An EthernetUNI can be a virtual or a physical UNI. If the ONU is managed via OMCI, an EthernetUNI has an associated service, which is either a VEIP (see [Section 9.5.5/G.988]) or a PPTP Ethernet UNI (see [Section 9.5.1/G.988]). If the associated service is a VEIP, the ONU shows a VEIP ME in the OMCI MIB. If it's a PPTP Ethernet UNI, the ONU shows a PPTP Ethernet UNI ME in the OMCI MIB. It is expected the associated service is a VEIP for a virtual UNI, and that it is a PPTP Ethernet UNI for a physical UNI. However, some network operators require that the ONU shows a PPTP Ethernet UNI ME instead of a VEIP ME in its OMCI MIB even if the EthernetUNI models a virtual UNI. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.16 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.16 |
|
LowerLayers |
string[](:1024) |
R |
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, or an empty string. See [Section 4.2.1/TR-181i2]. Note: Since EthernetUNI is a layer 1 interface, it is expected that LowerLayers will not be used. If EthernetUNI models a physical UNI, it represents a layer 1 interface; if EthernetUNI models a virtual UNI, it virtualizes a layer 1 interface. Note: access type was made Changes since 2.21:
|
- |
2.16 |
|
Device.XPON.ONU.{i}.EthernetUNI.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice 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]. Transmit direction has PON as destination. Receive direction has PON as source. |
- |
2.16 |
|
Device.XPON.ONU.{i}.SoftwareImage.{i}. |
object(0:2) |
R |
This table models the software images stored in the ONU. It is expected this table has two entries: the ONU normally creates two instances of the Software Image ME to model the 2 software images in the ONU. This object is based on [Section 9.1.4/G.988]. This table MUST contain at least 0 and at most 2 entries. At most one entry in this table can exist with a given value for ID. |
- |
2.16 |
|
ID |
unsignedInt(0:1) |
R |
The ID as assigned by the CPEdevice to this SoftwareImage entry. |
- |
2.16 |
|
Device.XPON.ONU.{i}.ANI.{i}. |
object(0:) |
R |
Access Node Interface (ANI) table. An ANI models the xPON MAC/PHY as defined in the ITU-T PON standards. This object is not an interface object as described in [Section 4.2/TR-181i2], but it has many of the same core parameters as an interface object, and they follow largely the same conventions. The most important deviations are:
Because it's not an interface object, it does not occur in the InterfaceStack table. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.16 |
|
Status |
string |
R |
The current operational state of the interface. Although this object is not an interface object, it follows largely the conventions of [Section 4.2.2/TR-181i2]. The most important deviation is that LowerLayerDown is not a valid value. Enumeration of:
When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable becomes true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; more specifically, Status should change to Up if TC.ONUActivation.ONUState becomes O5; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. Independent from the value of Enable, Status SHOULD change to NotAllowed if the interface is not allowed to transmit network traffic, e.g. because of a certain policy. If Status is NotAllowed, the CPEdevice should force the ONU state to O1 (Initial state). An example use case for NotAllowed is the following: if SFPReferenceList has one item referring to an SFPs.SFPCage instance whose SFPs.SFPCage.{i}.SFPPresent is true, whose SFPs.SFPCage.{i}.SFPType does not warrant NotPresent as value for Status, but whose SFPs.SFPCage.{i}.IsAllowed is false, then Status should change to NotAllowed. This parameter is based on ifOperStatus from [RFC2863]. |
- |
2.16 |
|
Name |
string(:64) |
R |
The textual name of the ANI entry as assigned by the CPE.}}device. |
- |
2.16 |
|
Device.XPON.ONU.{i}.ANI.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice 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]. Transmit direction has PON as destination. Receive direction has PON as source. |
- |
2.16 |
|
Device.XPON.ONU.{i}.ANI.{i}.Transceiver.{i}. |
object(0:2) |
R |
Transceiver table. Each entry models a PON transceiver. This table MUST contain at least 0 and at most 2 entries. At most one entry in this table can exist with a given value for ID. |
- |
2.16 |
|
ID |
unsignedInt(0:1) |
R |
The ID as assigned by the CPEdevice to this Transceiver entry. |
- |
2.16 |
|
Device.XPON.ONU.{i}.PowerManagement. |
object |
R |
This object models the power reduction management capabilities of the ONU. It is based on [Section 9.1.14 ONU dynamic power management control/G.988]. When OLTSleepAllow is true then the ONU is allowed to enter a low power state. [Clause 7.5.2 Main power-saving methods/G.Sup45]. [Section 9.1.14 ONU dynamic power management control/G.988]. Changes since 2.21:
|
- |
2.20 |
|
PowerReductionManagementCapability |
string[] |
R |
Comma-separated list of strings. This parameter indicates the sleep mode capability of the PowerManagement. This parameter is based on [Section 9.1.14 ONU dynamic power management control/G.988]. An an empty string string indicates that no capabilities are supported. Each list item is an enumeration of:
|
- |
2.20 |
|
Device.XPON.ONU.{i}.PowerManagement.PM. |
object |
R |
Performance monitoring (PM) data associated with the ONU's energy consumption. All time-based counters are expressed in microseconds to provide high granularity for rapid power-state transitions. The device MUST reset all parameters in this object to 0 (unless otherwise stated in individual object or parameter descriptions) either when the ONU instance is powered off (i.e. PowerStatus indicates a powered-off state), or when the ONU instance's Enable parameter changes value. |
- |
2.22 |
|
TotalMeasurementTime |
unsignedLong |
R |
The total elapsed time in microseconds since the ONU instance was last initialized or restarted. This parameter provides the precise baseline context for DozeTime, CyclicSleepTime, and WatchfulSleepTime. Note: For a dedicated PON device, where ONU instance is always enabled, this value will typically align with the overall device uptime (presented in microseconds). For a multi-WAN device, this value specifically tracks the uptime of the ONU instance. Active Notification requests for this parameter MAY be denied. |
- |
2.22 |
|
DozeTime |
unsignedLong |
R |
The time in microseconds during which the ONU was in doze energy conservation mode. If watchful sleep is enabled in the ONU dynamic power management control ME, the ONU returns 0 for this parameter. Reference [Section 9.2.14 Energy consumption performance monitoring history data/G.988]. |
- |
2.22 |
|
CyclicSleepTime |
unsignedLong |
R |
The time in microseconds during which the ONU was in cyclic sleep energy conservation mode. If watchful sleep is enabled in the ONU dynamic power management control ME, the ONU returns 0 for this parameter. Reference [Section 9.2.14 Energy consumption performance monitoring history data/G.988]. |
- |
2.22 |
|
WatchfulSleepTime |
unsignedLong |
R |
The time in microseconds during which the ONU was in watchful sleep energy conservation mode. Reference [Section 9.2.14 Energy consumption performance monitoring history data/G.988]. |
- |
2.22 |
|
Device.SSH. |
object |
R |
This object contains global parameters relating to the Secure Shell clients and or servers implementations that are active in the CPE.}}device. |
- |
2.16 |
|
Device.SSH.Server.{i}. |
object(0:) |
W |
This object contains parameters relating to a SSH server instance. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.16 |
|
AutoDisableDuration |
unsignedInt |
W |
The SSH server instance will be disabled when the the AutoDisableDuration elapses, and configuration must be done in minutes. At the end, the corresponding Enable parameter of the SSH server instance is automatically changed to false false. Any active sessions must be forcibly terminated. 0 means the the SSH server instance is always active. |
0 |
2.16 |
|
Device.Syslog. |
object |
R |
This object contains global parameters relating to the syslog implementations that isare active in the Device. Based on [A YANG Data Model for Syslog Configuration/YANGSYSLOG]. |
- |
2.17 |
|
Device.Syslog.Filter.{i}. |
object(0:) |
W |
This table defines the processing used to select log messages by comparing syslog message with the provided rules. A rule can consist eitherof any combination of FacilityLevel -, Severity, and or PatternMatch. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.17 |
|
SeverityCompare |
string |
W |
Describes the comparison method that must be applied when a syslog message is received. Not applicable when severity All and None is configured. Enumeration of:
|
EqualOrHigher |
2.17 |
|
SeverityCompareAction |
string |
W |
Specifies the process of handling a syslog message based on specified conditions. It defines the action that will be taken when the criteria of both Severity and SeverityCompare are met, determining the response to the syslog message. Enumeration of:
|
Log |
2.17 |
|
Device.Syslog.Source.{i}. |
object(0:) |
W |
This table describes where and how the syslog service receives log messages. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.17 |
|
Device.Syslog.Source.{i}.Network. |
object |
R |
This object describes the configuration parameters for receiving syslog information on a network socket. Changes since 2.21:
|
- |
2.17 |
|
StructuredData |
boolean |
W |
When true, the syslog source expects to receive log messages in the structured-data format as defined in [Section 6.3 STRUCTURED-DATA/RFC5424]. When false, log messages are expected in the traditional (non-structured) syslog format. |
false |
2.22 |
|
Device.Syslog.Action.{i}. |
object(0:) |
W |
This object describes the log action parameters for syslog. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.17 |
|
StructuredData |
boolean |
W |
ThisWhen feature represents the ability totrue, log messages are written in the structured-data format.format Referenceas defined in [Section 6.3 STRUCTURED-DATA/RFC5424]. When false, log messages are written in the traditional (non-structured) syslog format. |
false |
2.17 |
|
Device.RadSecProxy. |
object |
R |
This object contains configurations pertaining to the RadSecProxy service which implements the RadSec protocol for transporting RADIUS datagrams over TCP and TLS as detailed in [Appendix B/RFC6614]. |
- |
2.19 |
|
Status |
string |
R |
Status of the RadSecProxy service. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.19 |
|
Device.RadSecProxy.Realm.{i}. |
object(1:) |
W |
Realm block configuration of the RadSecProxy service as defined in [Appendix B/RFC6614]. This table MUST contain at least 1 entry. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Pattern. |
- |
2.19 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.19 |
|
Device.RadSecProxy.Server.{i}. |
object(0:) |
W |
Server block configuration of the RadSecProxy service. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Address. |
- |
2.19 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.19 |
|
Device.RadSecProxy.Client.{i}. |
object(1:) |
W |
Client block configuration of the RadSecProxy service. This table MUST contain at least 1 entry. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Address. |
- |
2.19 |
|
Status |
string |
R |
The status of this entry. Enumeration of:
The Error value MAY be used by the CPEdevice to indicate a locally defined error condition. |
- |
2.19 |
|
Device.SessionManagement. |
object |
R |
The logical connection between an RG and a data network using 3GPP technologies (FN-RG cellular and 5G-RG ALL) are considered data sessions. The Device.SessionManagement subtree describes each sessions properties together with the QoS rules specific to that access technology. |
- |
2.19 |
|
Device.SessionManagement.Session.{i}. |
object(0:) |
R |
Contains all the properties of a 3GPP session instance common to all generations. 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.19 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. |
- |
2.20 |
|
Device.Hardware. |
object |
R |
Represents the hardware configuration of the device, including details about the CPU, memory, and other hardware components. Changes since 2.21:
|
- |
2.20 |
|
Device.Hardware.Display. |
object |
R |
This object describes the displays attached to the device and the sessions that can render on the displays. |
- |
2.22 |
|
SessionNumberOfEntries |
unsignedInt |
R |
The number of entries in the Session table. |
- |
2.22 |
|
ScreenNumberOfEntries |
unsignedInt |
R |
The number of entries in the Screen table. |
- |
2.22 |
|
Device.Hardware.Display.Screen.{i}. |
object(0:) |
R |
This object describes a screen attached to the display device. In the case of multiple screens, each screen will be given a unique position within the coordinate space of all screens via PosX and PosY. This means that a session can be on zero, one or many screens at once depending on the position and dimensions of the session in the coordinate space. At most one entry in this table can exist with a given value for Alias. |
- |
2.22 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.22 |
|
Enable |
boolean |
W |
Enables/disables the screen. |
- |
2.22 |
|
Width |
unsignedInt |
R |
The width of this display, expressed in pixels. |
- |
2.22 |
|
Height |
unsignedInt |
R |
The height of this display, expressed in pixels. |
- |
2.22 |
|
PhysicalWidth |
unsignedInt |
R |
The physical width of this display, expressed in millimeters. |
- |
2.22 |
|
PhysicalHeight |
unsignedInt |
R |
The physical height of this display, expressed in millimeters. |
- |
2.22 |
|
RefreshDuration |
unsignedInt |
R |
The current refresh duration (1/refresh rate) of this display, expressed in nanoseconds. |
- |
2.22 |
|
PixelFormat |
unsignedInt |
R |
The FourCC pixel format of this display. |
- |
2.22 |
|
Type |
string |
R |
The display technology type. Enumeration of:
|
- |
2.22 |
|
PosX |
unsignedInt |
R |
The horizontal position of this screen's top left corner expressed in pixels within the coordinate space of all the screens. This acts to position the screen relative to other screens. In the case of a single screen, the position will always be 0. |
- |
2.22 |
|
PosY |
unsignedInt |
R |
The vertical position of this screen's top left corner expressed in pixels within the coordinate space of all the screens. This acts to position the screen relative to other screens. In the case of a single screen, the position will always be 0. |
- |
2.22 |
|
Device.Hardware.Display.Session.{i}. |
object(0:) |
W |
Represents sessions that can render and be composited together on screen. Each session has a position, z-order and visibility that can be controlled when the sessions are composited together on the display. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.22 |
|
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.22 |
|
Enable |
boolean |
W |
Enables/disables the session. If disabled, the session will not be shown on the display, and new processes will not be allowed to connect to the session. |
- |
2.22 |
|
Status |
string |
R |
Status of the session. Enumeration of:
|
- |
2.22 |
|
Movable |
boolean |
W |
Controls whether the user is allowed to change the positions of GUI windows associated with this session. |
- |
2.22 |
|
Resizable |
boolean |
W |
Controls whether the user is allowed to resize the GUI windows associated with this session. |
- |
2.22 |
|
Hidden |
boolean |
W |
Controls whether a session is hidden. If hidden, any graphics from the session will not be shown on the display. |
false |
2.22 |
|
ExclusiveAccess |
boolean |
W |
Controls whether this session has exclusive access. When the session is not hidden and ExclusiveAccess is true, all sessions for which ExclusiveAccess is not true will be hidden. |
false |
2.22 |
|
Path |
string(:2048) |
W |
[FileURI] Path to allow clients to connect to the session to display their UI (for example a Wayland Unix domain socket). The path MUST use the file URI scheme [The file URI Scheme/RFC8089]. |
- |
2.22 |
|
ZIndex |
unsignedInt |
W |
Z-order (draw order) of sessions. Lower numbers will be drawn first, and may be occluded by higher numbers. If two sessions have the same z-order, the session with the earlier index will be drawn first. |
- |
2.22 |
|
PosX |
unsignedInt |
W |
The horizontal position of this session's top left corner within the coordinate space, expressed in pixels. This acts to position the session within one or more screens. |
- |
2.22 |
|
PosY |
unsignedInt |
W |
The vertical position of this session's top left corner within the coordinate space, expressed in pixels. This acts to position the session within one or more screens. |
- |
2.22 |
|
Width |
unsignedInt |
W |
The maximum width of the session within the coordinate space, expressed in pixels. This clips the available area that a session can render to. |
- |
2.22 |
|
Height |
unsignedInt |
W |
The maximum height of the session within the coordinate space, expressed in pixels. This clips the available area that a session can render to. |
- |
2.22 |
|
Device.ConnectionMonitoring. |
object |
R |
This object contains parameters for monitoring the connection status of interfaces. It allows the Device to monitor interfaces using ARP (Address Resolution Protocol) or ND (Neighbor Discovery) packets, depending on the IP version used by the interface. The CPEdevice can enable or disable the connection monitor and configure individual entries for each interface. Each entry can be enabled or disabled independently, allowing for flexible monitoring configurations. |
- |
2.20 |
|
Device.ConnectionMonitoring.Connection.{i}. |
object(0:) |
W |
This object contains parameters for monitoring the connection. The device can enable or disable the connection monitor and configure individual entries for different interfaces. Depending on Method, the device can use different methods to test connectivity, such as ARP, ND, Ping, BFDEcho or DNS. During normal operation, a connectivity check is performed every MonitorInterval. If a check fails, due to no response within MaxResponseTimeout, then the device enters a failure state. In this failure state, it performs subsequent checks more frequently, every FailInterval. The NumberOfAttempts counter is incremented for each failed check and the value of the parameter MonitoringStatus status is set to Unresponsive. If this counter equals the Action.{i}.AttemptCount threshold, the configured Action.{i}.Action is triggered. If a check succeeds at any point, the NumberOfAttempts counter is reset, the monitor interval reverts to the normal MonitorInterval and the MonitoringStatus status is set to Up. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.20 |
|
DestAddress |
string |
W |
The destination address (IP address or FQDN) to which connectivity test packets are sent. When IPVersion is set to '-1',the'-1', the implementation will chosechoose and use only one IP version for testing the connectivity. It will try to use IPv6 first, and if that fails, it will fall back to IPv4. When Method is set to ARP or ND this parameter specifies the IP address of the network device under test. The Device will send ARP requests (for IPv4) or Neighbor Solicitation messages (for IPv6) to this address to check connectivity. When an empty string the Device will use the default gateway IP address from the Interface specified in the Interface parameter. When Method is set to Ping this parameter specifies the IP address to which ICMP Echo Request packets are sent. The Device will send ICMP Echo Requests to this address to check connectivity. When an empty string the Device will use the default gateway IP address from the Interface specified in the Interface parameter. When Method is set to BFDEcho this parameter specifies the IP address to which BFD echo packets are sent. The Device will send BFD Echo packets to this address to check connectivity. When an empty string the Device will use the default gateway IP address from the Interface specified in the Interface parameter. When Method is set to DNS this parameter specifies the DNS server (IP address or FQDN) to which DNS queries are sent. When an empty string the Device will use the default DNS server configured on the Interface specified in the Interface parameter. |
- |
2.20 |
|
Device.WireGuard. |
object |
R |
This object contains configuration and status for the WireGuard subsystem. The WireGuard subsystem is used to create secure tunnels between devices using the WireGuard protocol. |
- |
2.20 |
|
Device.WireGuard.Tunnel.{i}. |
object(0:) |
W |
WireGuard Tunnel table, models the WireGuard Tunnel instance and represents the entry point and exit point of the tunnel in relation to the WAN interface. A Tunnel object has one or more Interface objects that further define the sessions or flows within the tunnel. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for PrivateKey. |
- |
2.20 |
|
Device.WireGuard.Tunnel.{i}.Interface.{i}. |
object(0:) |
W |
WireGuard Interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). The Interface object provides a way to discriminate how sessions or flows are encapsulated within the WireGuard Tunnel. In addition the Interface object represents the entry point and exit point of the tunnel in relation to the LAN interface. Compared to other tunnel protocols, WireGuard does not have a concept of multiple interfaces within a tunnel. Therefore, a WireGuard Tunnel will only have one Interface instance. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.20 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE.}}device. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.20 |
|
Device.WireGuard.Tunnel.{i}.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPEdevice 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.20 |
|
Device.USPAgent. |
object |
R |
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. Changes since 2.21:
|
- |
2.15 |
|
AllowToSendRequestorIDList |
string[] |
W |
Comma-separated list of strings, each entry is the EndpointID of a USP Controller that is authorized to use the requestor_id field in a USP request record. Controllers included in this list are permitted to act using the roles and permissions associated with another EndpointID, as specified by the requestor_id field. If a Controller is not included in this list, any attempt to use the requestor_id field in a USP record MUST result in the Agent returning an Error response.. |
- |
2.22 |
|
Device.USPAgent.MTP.{i}. |
object(0:) |
W |
Each instance of this table represents a MTP used by the local Agent. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.15 |
|
Status |
string |
R |
The current operational state of the MTP instance. Enumeration of:
|
- |
2.15 |
|
Device.USPAgent.ControllerTrust. |
object |
R |
This object contains information that an Agent applies when establishing a trust relationship with a Controller. |
- |
2.15 |
|
SecuredRoles |
string[] |
W |
Each list item MUST be the Path Name of a row in the Role. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Comma-separated list of strings, each entry is a Role that is associated with Controllers to indicate their access to the content of secured parameters (e.g. WiFi.AccessPoint.{i}.Security.WEPKey). The value of the {{param}} parameter is appended to the {{param|#.Controller.{i}.AssignedRole}} parameter of the Controller instance that requires access to the content of secured parameters.). A Controller that requires access to the content of secured parameters must possess at least one Role from this list via Controller.{i}.AssignedRole or Controller.{i}.InheritedRole. The secured role on a Controller only affects the visibility of the parameter content; that is, if a Controller attempts to access a secured parameter for which it has the appropriate access rights, the content will only be visible if the Controller also possesses one of the Roles from the value of this parameter. If a Controller attempts to read a secured parameter without being assigned a Role from the value of this parameter, the Agent MUST return an empty string. |
- |
2.16 |
|
Device.ETSIM2M. |
object |
R |
The ETSIM2M object represents the management object for the Remote Entity Functions (REM) functions defined in the M2M Functional Architecture [ETSIM2MFA]. |
- |
2.6 |
|
Device.ETSIM2M.SCL.{i}. |
object(0:) |
W |
This object represents an instance of a Service Capability Layer (SCL) for a M2M device or gateway. The SCL MAY be maintained by the ACS or by the CPE.device. When the SCL provides the administration of an SCL that is represented as a SoftwareModules.ExecutionUnit the SCL is maintained in the SoftwareModules.ExecutionUnit.{i}.References parameter. Section 5.1.2 of the M2M Functional Architecture [ETSIM2MFA] describes the high level event flows for SCL registration. Section 9.3.2.6.2 of the M2M Functional Architecture [ETSIM2MFA] describes the creation/registration of SCLs. Section 9.3.2.6.4 of the M2M Functional Architecture [ETSIM2MFA] describes the update/re-registration of SCLs. Section 9.3.2.6.5 of the M2M Functional Architecture [ETSIM2MFA] describes the deletion/deregistration of SCLs. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.6 |
|
Device.ETSIM2M.SCL.{i}.AreaNwkInstance.{i}. |
object(0:) |
R |
The M2M Area Network information provides administration capabilities for remote management (REM) of M2M Devices (D', d) that are attached to this SCL instance. This object provides the administration of the properties needed by the SCL to remotely manage M2M Devices within a specific type of M2M Area network as defined by AreaNwkType. Multiple instances of AreaNwkInstance with the same AreaNwkType is permitted. Section 5.3.5 of the M2M Functional Architecture [ETSIM2MFA] describes the REM functionality expected of a SCL for an M2M Device. At most one entry in this table can exist with a given value for ID. |
- |
2.6 |
|
ListOfDevices |
string[] |
R |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the AreaNwkDeviceInfoInstance. table, or an empty string. The list represents the M2M Devices (D', d) that are attached to this SCL instance that are within this AreaNwkInstance instance. The list does not contain an instance for this CPE.}}device. |
- |
2.6 |
|
Device.ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance.{i}. |
object(0:) |
R |
The M2M Area Network Device Information provides the administration capability to the SCL for maintenance of M2M Devices (D', d) that are attached to this SCL instance. While discovery and identification of devices by the M2M Gateway or Device (CPE)(device) is implementation specific, each device is represented by an instance of the Hosts.Host table. When the M2M Device is managed by the CWMP endpoint of the CPE,device, the AreaNwkDeviceInfoInstance is expected to be referenced by an instance of one of the following tables: *ManagementServer.EmbeddedDevice *ManagementServer.VirtualDevice Section 5.3.5 of the M2M Functional Architecture [ETSIM2MFA] describes the REM functionality expected of a SCL to a M2M Device. This object instance provides the administration properties required by a SCL to remotely manage an instance of a M2M Device within a M2M area network. A M2M Device is associated with an instance of a AreaNwkInstance. This table contains parameters and information of the M2M Device related to each AreaNwkInstance instance. Instances of this table are created and deleted by the CPE.device. The ACS MAY modify the writeable parameters of this object instance but it is possible that the value set by the ACS is not retained between reboots of the M2M Device. |
- |
2.6 |
|
SleepInterval |
unsignedInt |
W |
The interval, in seconds, between sleep periods for the device. A value of 0 represents a device that does not sleep. Note: When this value is modified, the CPEdevice could modify the SleepInterval for this M2M Device in other Area Networks. |
- |
2.6 |
|
SleepDuration |
unsignedInt |
W |
The duration, in seconds, of a sleep period. The value 0 represents an unknown value. Note: When this value is modified, the CPEdevice could modify the SleepDuration for this M2M Device in other Area Networks. |
- |
2.6 |
|
Active |
boolean |
R |
Whether or not this M2M Device is currently attached to this SCL instance. The ability to list inactive M2M Devices is OPTIONAL. If the CPEdevice includes inactive M2MDevices in this table, Active is set to false for each inactive M2M Device. The length of time an inactive M2M Device remains listed in this table is a local matter to the CPE.}}device. |
- |
2.6 |
|
Device.STOMP. |
object |
R |
The STOMP represents the STOMP capabilities of the device as described in [TR-369]. |
- |
2.15 |
|
Device.STOMP.Connection.{i}. |
object(0:) |
W |
The Connection represents a STOMP connection between the Agent and a STOMP server. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of Host, Username and VirtualHost. |
- |
2.15 |
|
Status |
string |
R |
The current operational state of this Connection (see [Section 4.2.2/TR-181i2]). Enumeration of:
When Enable is false then Status SHOULD normally be Disabled or Error if there is a fault condition on the interface).interface. When Enable is changed to true then Status SHOULD change to Enabled if and only if the interface is able to transmit and receive PDUs; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. |
- |
2.15 |
Generated by Broadband Forum bbfreport v2.4.0 (2025-11-11 version) on 2026-11-10 at 11:24:33 UTC.
report.py --include ../../install/cwmp --output tr-181-2-22-0-cwmp-diffs.html --show --transform diff --format html tr-181-2-21-0-cwmp.xml tr-181-2-22-0-cwmp.xml