 | Device:2 Root Data Model definition [CWMP] (changes)tr-181-2-21-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 |
|---|---|---|
|
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:
|
|
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. |
|
JSONObject |
A JSON Object as defined in [Section 4/RFC7159]. |
|
|
MACAddress |
string(:17) |
All MAC addresses are represented as strings of 12 hexadecimal digits (digits 0-9, letters A-F or a-f) displayed as six pairs of digits separated by colons. Unspecified or inapplicable MAC addresses MUST be represented as empty strings unless otherwise specified by the parameter definition. Possible patterns:
|
|
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:
|
|
|
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. |
|
|
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. |
|
|
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. |
|
|
Thread Specification, IEEE Standard for Low-Rate Wireless Networks, IEEE, July 2020. |
|
|
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.3-2015, IEEE Standard for Ethernet, IEEE, 2015. |
|
|
[AFCCTP] |
AFC Device (AFC DUT) Compliance Test Plan, AFC Device (AFC DUT) Compliance Test Plan, Wi-Fi Alliance, June 2024. |
|
[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. |
|
[EasyMesh] |
EasyMesh Specification, Wi-Fi EasyMesh Specification, Wi-Fi Alliance, August 2024. |
|
[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.993.2] |
G.993.2, Very high speed digital subscriber line transceivers 2 (VDSL2), ITU-T. |
|
[G.9954] |
G.9954, Phoneline networking transceivers - Enhanced physical, media access, and link layer specifications (HPNA 3.0 and 3.1), ITU-T, 2007. |
|
[G.996.2] |
G.996.2, Single-ended line testing for digital subscriber lines (DSL), ITU-T. |
|
[G.9960] |
G.9960, Unified high-speed wire-line based home networking transceivers - System architecture and physical layer specification, ITU-T. |
|
[G.9961] |
G.9961, Unified high-speed wire-line based home networking transceivers - Data link layer specification, ITU-T. |
|
[G.9964] |
G.9964, Unified high-speed wire-line based home networking transceivers - Power spectral density specification, ITU-T. |
|
[G.997.1] |
G.997.1, Physical layer management for digital subscriber line (DSL) transceivers, ITU-T. |
|
[HPAV1.1] |
HomePlug™ AV Specification, Version 1.1, HomePlug Alliance, 2007. |
|
IANA IP Version Numbers, IP Version Numbers, IANA. |
|
|
IANA Uniform Resource Identifier (URI) Schemes Registry, Uniform Resource Identifier (URI) Schemes, IANA. |
|
|
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. |
|
|
ISO 3166-1, Codes for the representation of names of countries and their subdivisions - Part 1: Country codes, ISO, 2006. |
|
|
[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. |
|
[MQTT50] |
MQTT Version 5.0, MQTT Version 5.0, Candidate OASIS Standard 02., OASIS Message Queuing Telemetry Transport (MQTT) TC, February 2019. |
|
[OUI] |
Organizationally Unique Identifiers (OUIs). |
|
[RFC1027] |
RFC 1027, Using ARP to Implement Transparent Subnet Gateways, IETF, October 1987. |
|
[RFC1122] |
RFC 1122, Requirements for Internet Hosts - Communication Layers, IETF, October 1989. |
|
[RFC1661] |
RFC 1661, The Point-to-Point Protocol (PPP), IETF, 1994. |
|
[RFC2131] |
RFC 2131, Dynamic Host Configuration Protocol, IETF. |
|
[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. |
|
[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. |
|
[RFC4291] |
RFC 4291, IP Version 6 Addressing Architecture, 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. |
|
[RFC5139] |
RFC 5139, Revised Civic Location Format For Presence Information Data Format Location Object (PIDF-LO), IETF, February 2008. |
|
[RFC5280] |
RFC 5280, Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile, IETF, May 2008. |
|
[RFC5491] |
RFC 5491, GEOPRIV Presence Information Data Format Location Object (PIDF-LO) Usage Clarification, Considerations, and Recommendations, IETF, March 2009. |
|
[RFC5625] |
RFC 5625, DNS Proxy Implementation Guidelines, IETF, 2009. |
|
[RFC5996] |
RFC 5996, Internet Key Exchange Protocol Version 2 (IKEv2), IETF, September 2010. |
|
[RFC6296] |
RFC 6296, IPv6-to-IPv6 Network Prefix Translation, IETF, June 2011. |
|
[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. |
|
[RFC7296] |
RFC 7296, Internet Key Exchange Protocol Version 2 (IKEv2), IETF, October 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. |
|
[RFC826] |
RFC 826, An Ethernet Address Resolution Protocol, IETF, November 1982. |
|
[RFC8415] |
RFC 8415, Dynamic Host Configuration Protocol for IPv6 (DHCPv6), IETF, November 2018. |
|
[RFC8428] |
RFC 8428, Sensor Measurement Lists (SenML), IETF, August 2018. |
|
[RFC8822] |
RFC 8822, 5G Wireless Wireline Convergence User Plane Encapsulation (5WE), IETF, April 2021. |
|
[RFC8966] |
RFC 8966, The Babel Routing Protocol, IETF, January 2021. |
|
[RFC9046] |
RFC 9046, Babel Information Model, IETF, June 2021. |
|
[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-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-471] |
TR-471, Maximum IP-Layer Capacity Metric, Related Metrics, and Measurements, Broadband Forum, December 2023. |
|
[UPA-PLC] |
Universal Powerline Association, UPA. |
|
UPnP Device Architecture, UPnP Device Architecture 1.0, UPnP Forum, April 2008. |
|
|
UPnP Device Architecture 1.1, UPnP Device Architecture 1.1, UPnP Forum, October, 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. |
|
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.21 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.20:
- Changed name = Device:2.20 ⇒ Device:2.21
| 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. Changes since 2.20:
|
- |
2.0 |
|
BootStage |
string |
R |
The operational state of the device middleware during its boot sequence. Represents the possible milestones during the boot process, providing clear indicators of the device's current state and readiness for communication. These stages are used both for real-time operational state tracking and for historical boot performance analysis. The transitions between stages provide clear triggers for internal management agents to know exactly when the device is ready for specific operations. E.g., the CWMP/USP agents can use these stages to determine communication readiness. Enumeration of:
|
- |
2.21 |
|
LastFirmwareUpdate |
dateTime |
R |
Date and time of when the SoftwareVersion last changed. |
- |
2.21 |
|
CountryCode |
string(2) |
W |
The two-letter country code in accordance with [ISO3166-1] alpha-2. For example, 'US' for the United States. Possible patterns:
|
- |
2.21 |
|
ProcessorNumberOfEntries |
unsignedInt |
R |
The number of entries in the Processor table. This parameter was DEPRECATED in 2.18 because the only contained parameter, Processor.{i}.Architecture, is no longer relevant for modern devices. {{obsoleted|2.20}}}}This parameter was DELETED in 2.21. Changes since 2.20:
|
- |
2.1 |
|
Device.DeviceInfo.MemoryStatus. |
object |
R |
Status of the device's physical memory. Changes since 2.20:
|
- |
2.0 |
|
Available |
unsignedInt |
R |
The estimated total physical volatile RAM, in KiB, that can be allocated without triggering out-of-memory conditions. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
Free |
unsignedInt |
R |
The free physical volatile RAM, in KiB, currently availableunallocated onand theunused. device.}}This excludes memory that can be reclaimed (e.g. caches, buffers). Note: This definition was changed in Device:2.21. Please refer to Available for a guaranteed indication of memory availability, rather than memory that is completely unused. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
|
Device.DeviceInfo.MemoryStatus.MemoryMonitor. |
object |
R |
This object specifies information that the device has obtained via sampling the memory utilization (RAM) on the device. |
- |
2.18 |
|
FilePath |
string(:2048) |
W |
[FileURI] Destination path and filename of where to create and keep the log files which MUST use the file URI scheme [The file URI Scheme/RFC8089]. This file is related to EnableCriticalLog. Changes since 2.20:
|
- |
2.18 |
|
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. Changes since 2.20:
|
- |
2.18 |
|
FilePath |
string(:2048) |
W |
[FileURI] Destination path and filename of where to create and keep the log files which MUST use the uri scheme file [The file URI Scheme/RFC8089]. This file is related to EnableCriticalLog. Changes since 2.20:
|
- |
2.18 |
|
InterruptRate |
unsignedInt |
R |
The aggregate rate of hardware interrupts (IRQs) handled by this CPU across all interrupt sources, in interrupts per second. |
- |
2.21 |
|
Device.DeviceInfo.Processor.{i}. |
object(0:) |
R |
Each table entry represents a hardware or virtual processor that resides on this device. This object was DEPRECATED in 2.18 because the only contained parameter, Architecture, is no longer relevant for modern devices. {{obsoleted|2.20}}}}This object was DELETED in 2.21. At most one entry in this table can exist with a given value for Alias. Changes since 2.20:
|
- |
2.1 |
|
Device.DeviceInfo.LogRotate.{i}. |
object(0:) |
W |
This Object 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. Which MUST use the uri scheme file [The file URI Scheme/RFC8089]. Changes since 2.20:
|
- |
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 that Name is specified. Which MUST use the uri scheme file [The file URI Scheme/RFC8089]. Changes since 2.20:
|
- |
2.17 |
|
Device.DeviceInfo.Location.{i}. |
object(0:) |
W |
This object contains Location information. At most one entry in this table can exist with the same values for both Source and ExternalSource. On creation of a new table entry, the Agent MUST choose an initial value for ExternalSource such that the new entry does not conflict with any existing entries. |
- |
2.4 |
|
Source |
string |
R |
Identifies the source of the location data. Enumeration of:
Changes since 2.20:
|
External |
2.4 |
|
ExternalSource |
string |
R |
URL, MAC address, or other identifier that identifies an "External" source of this location. Meaningful only if Source has a value of External, otherwise it MUST be an empty string. If ExternalProtocol has a value of CWMP, this is the URL or IP address of the Controller.}} If ExternalProtocol has a value of USP, this is the USP Endpoint of the Controller. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.4 |
|
DataObject |
string(:2048) |
W |
The currently valid location information. Writable only when ExternalProtocol has a value of CWMP or USP. If obtained through the local GPS/AGPS then the location information is formatted according to [RFC5491]. If obtained through the local Barometer then the location information is formatted according to [RFC8428]. If manually configured then location information will be XML-formatted according to [RFC5491] (geographical information) and [RFC5139] (civic addresses). If manually configured then location information will be XML-formatted according to [RFC8428] (barometric data). If obtained by an external source this is the location information as received. If it's an XML document (e.g. CWMP, OMA-DM, UPnP, HELD, MLP) the location information will be represented as-is, otherwise it will be converted to base64. CWMP or USP configured location information will be XML-formatted according to [RFC5491] (geographical information) and [RFC5139] (civic addresses). CWMP or USP configured location information will be XML-formatted according to [RFC8428] (barometric information) for Barometer. Only zero or one Location object instance with value CWMP or {{enum|USP|ExternalProtocol}} MUST exist at any given time. Changes since 2.20:
|
- |
2.4 |
|
Device.DeviceInfo.FirmwareImage.{i}. |
object(0:) |
R |
Top-level object for mapping firmware images. This is a static table – the number of object instances in this table is defined by the firmware that is currently running. At most one entry in this table can exist with a given value for Alias. Changes since 2.20:
|
- |
2.12 |
|
LastUpdate |
dateTime |
R |
Date and time of when Status last changed. |
- |
2.21 |
|
Device.DeviceInfo.KernelFaults. |
object |
R |
A fault in the context of the Kernel refers to a situation where the kernel encounters a critical error or a bug that it cannot recover from. When this happens, the kernel generates a "fault message" or "kernel panic", which provides information about the error, the state of the system at the time of the error, and a stack trace of function calls leading up to the error. Changes since 2.20:
|
- |
2.17 |
|
CurrentBootCount |
unsignedInt |
R |
The number of Kernel faults which have occurred during the current boot cycle. |
- |
2.21 |
|
StatsNumberOfEntries |
unsignedInt |
R |
The number of entries in the Stats table. |
- |
2.21 |
|
Device.DeviceInfo.KernelFaults.Stats.{i}. |
object(0:) |
R |
Each table entry represents statistics for a particular recorded Kernel Fault Type. At most one entry in this table can exist with a given value for Alias, or with a given value for Type. |
- |
2.21 |
|
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.21 |
|
Type |
string |
R |
The type of the Kernel fault for which this table entry contains the statistics. Enumeration of:
|
- |
2.21 |
|
LastUpgradeCount |
unsignedInt |
R |
Total number of Kernel faults, of this type, which occurred since last firmware upgrade. |
- |
2.21 |
|
PreviousBootCount |
unsignedInt |
R |
The number of Kernel faults, of this type, which occurred during the previous boot cycle. |
- |
2.21 |
|
CurrentBootCount |
unsignedInt |
R |
The number of Kernel faults, of this type, which have occurred during the current boot cycle. |
- |
2.21 |
|
Device.DeviceInfo.ProcessFaults. |
object |
R |
Monitoring process faults and configuring the operating system to generate crash dumps and core files is essential for diagnosing and troubleshooting issues with applications and processes. Changes since 2.20:
|
- |
2.17 |
|
CurrentBootCount |
unsignedInt |
R |
The number of process faults that have occurred during the current boot cycle. |
- |
2.21 |
|
StatsNumberOfEntries |
unsignedInt |
R |
The number of entries in the Stats table. |
- |
2.21 |
|
Device.DeviceInfo.ProcessFaults.Stats.{i}. |
object(0:) |
R |
Each table entry represents statistics for a particular recorded Process Fault Type. At most one entry in this table can exist with a given value for Alias, or with a given value for Type. |
- |
2.21 |
|
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.21 |
|
Type |
string |
R |
The type of the process fault for which this table entry contains the statistics. Enumeration of:
|
- |
2.21 |
|
LastUpgradeCount |
unsignedInt |
R |
Total number of process faults, of this type, which occurred since last firmware upgrade. |
- |
2.21 |
|
PreviousBootCount |
unsignedInt |
R |
The number of process faults, of this type, which occurred during the previous boot cycle. |
- |
2.21 |
|
CurrentBootCount |
unsignedInt |
R |
The number of process faults, of this type, which have occurred during the current boot cycle. |
- |
2.21 |
|
Device.ManagementServer. |
object |
R |
This object contains parameters relating to the CPE's association with an ACS. |
- |
2.0 |
|
Device.ManagementServer.StandbyPolicy. |
object |
R |
Parameters related to CPE behavior when waking up from standby. If this object is supported then the CPE MUST support the requirements of [Annex L/TR-069]. NOTE: "CR", as used in the names and descriptions of the parameters defined in this object, refers to the Connection Request concept defined in TR-069. |
- |
2.7 |
|
ScheduledAwarenessRequested |
boolean |
W |
If this parameter is true, the CPE MUST NOT go into a standby state that prevents it from honoring Scheduled Contacts. This means that, whenever the ACS has requested a Scheduled Contact: *if* if SelfTimerCapable is true and the CPE chooses to go into Standby before the Scheduled Contact has been honored, it MUST use a Timer-Aware Standby; *if* if SelfTimerCapable is false, the CPE MUST NOT go into Standby before the Scheduled Contact has been honored. |
- |
2.7 |
|
Device.UserInterface. |
object |
R |
This object contains parameters relating to the user interface of the CPE. |
- |
2.0 |
|
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. |
- |
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. Changes since 2.20:
|
<Empty> |
2.16 |
|
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. Changes since 2.20:
|
- |
2.19 |
|
SupportedSFPTypes |
string[] |
R |
Comma-separated list of strings. Indicates the SFP types supported by the CPE. 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. Changes since 2.20:
|
- |
2.19 |
|
SFPPresent |
boolean |
R |
The value true indicates the presence of aan SFP in the SFP Cage instance. The value is always true for a SFF. Note: A value of 0x02 in SFF8024Identifier will also indicate the presence of an SFF. |
- |
2.19 |
|
SFF8024Identifier |
unsignedInt(0:255) |
R |
ThsThis identifier describes the type of SFP and the management protocol as per "Identifier Value" listed in [Table 4-1/SFF-8024]. |
- |
2.19 |
|
SFPType |
string |
R |
The value MUST be a member of the list reported by the SupportedSFPTypes parameter, or else be Unsupported. This value is applicable only when SFPPresent is true. The SFP Type is classified as one of: GPON, XGS-PON, Optical Ethernet, Copper Ethernet. If the SFP Type cannot be classified, the value is reported as "Unsupported". Changes since 2.20:
|
- |
2.19 |
|
IsAllowed |
boolean |
R |
true if the CPE allows the SFP, false if the CPE blocks the SFP. See AllowedSFPs for what it means for an SFP to be blocked or allowed. The CPE sets this parameter to true or false based on the configuration in: This parameter is only applicable for pluggable SFPs; it's not applicable for built-in modules/SFPs (the CPE 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 aan SFP that are exposed through the given Managmentmanagement 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 |
|
VendorName |
string(:16) |
R |
The vendor name is a string containsof ASCII characterscharacters. thatIt containis the full name of the corporation, a commonly accepted abbreviation of the name of the corporation, the SCSI company code for the corporation, or the stock exchange code for the corporation. At least one of VendorName or VendorOUTVendorOUI shall contain valid data. |
- |
2.19 |
|
Device.SFPs.Mgmt.SFF8472.{i}.Transceiver.Warnings. |
object |
R |
This object contains the state of the SFP internal Diagnostic Warning Flags [Table 9-17/SFF-8472]. Warning flags indicate conditions outside the normally guaranteed bounds but not necessarily causes of immediate link failures. Certain warning flags may also be defined by the manufacturer as end-of-life indicators (such as for higher than expected bias currents in a constant power control loop). A flag is set for each warning that is active. Implementation is vendor specific. AAn SFP module has the ability to monitor and warn on a high or low readings for a number of situations. This ability is internal to the SFP and is part of the digital diagnostic interface common to many SFPs. The associated field changes from false to true to signal a warning and changes from true to false to indicate that the warning has cleared. It is recommended that detection of an asserted flag bit will be verified by a second read of the flag at least 100ms later. |
- |
2.19 |
|
Device.SFPs.SFPProperties. |
object |
R |
Object to help implementations to determine the SFP type. See SFP for more info. In the future the object can be expanded to show other properties of SFPs, e.g., the polarity of certain pins. |
- |
2.21 |
|
SFPNumberOfEntries |
unsignedInt |
R |
The number of entries in the SFP table. |
- |
2.21 |
|
Device.SFPs.SFPProperties.SFP.{i}. |
object(0:) |
W |
List of SFPs to help implementations to determine the SFP type. SFPCage.{i}.SFPType reports the SFP type. SFPs themselves do not report their type. Implementations typically try to determine a value for that parameter based on the values for parameters such as:
This approach is not foolproof: many SFPs do not report correct values. They e.g. might report 0 as value for all transceiver codes. What all SFPs normally report correctly is their vendor name, vendor OUI and part number, cfr:
Therefore this table specifies the SFP type based on vendor name, vendor OUI and/or part number. After reading those 3 properties, implementations can look up the value to assign to SFPCage.{i}.SFPType in this table. This list is allowed to include a built-in module/SFP to help an implementation to determine the type of such a module/SFP. At most one enabled entry in this table can exist with the same values for all of VendorName, VendorOUI and VendorPN. |
- |
2.21 |
|
Enable |
boolean |
W |
Enables or disables this entry. |
true |
2.21 |
|
VendorName |
string(:16) |
W |
The vendor name of the SFP. When empty, the vendor name is not used in determining the SFP type. |
- |
2.21 |
|
VendorOUI |
hexBinary(3) |
W |
The vendor organizationally unique identifier (OUI) field of the SFP. When empty, the vendor OUI is not used in determining the SFP type. |
- |
2.21 |
|
VendorPN |
string(:16) |
W |
The vendor part number (PN) of the SFP. When empty, the vendor PN is not used in determining the SFP type. The ASCII character Note: the string "*" as value for this parameter is equivalent to the empty string as value for this parameter. |
- |
2.21 |
|
SFPType |
string |
W |
The value MUST be a member of the list reported by the SupportedSFPTypes parameter. It has the same allowed values as SFPCage.{i}.SFPType, except for "Unsupported". |
- |
2.21 |
|
Device.SFPs.AllowedSFPs. |
object |
R |
Object specifying which pluggable SFPs the CPE should block or allow. The object is not applicable for built-in modules/SFPs (the CPE 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 |
|
AllowedSFPNumberOfEntries |
unsignedInt |
R |
The number of entries in the AllowedSFP table. |
- |
2.21 |
|
AllowAllSFPs |
boolean |
W |
When set to true, the CPE allows all SFPs and the configuration in AllowedSFP is ignored. When set to false, the CPE only allows SFPs which match with the classification criteria of at least one entry in AllowedSFP. The CPE 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 CPE should allow any pluggable SFP which matches at least one of the entries; the CPE 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:
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 |
|
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.21 |
|
Enable |
boolean |
W |
Enables or disables this entry. If true, the CPE should allow the SFPs which match this entry. If false, the CPE should not use this entry to determine if an SFP is allowed or not. |
- |
2.21 |
|
SFPType |
string |
W |
The value MUST be a member of the list reported by the SupportedSFPTypes parameter, or else be an empty string. Classification criterion. When empty, the SFP is not classified by SFP type. |
- |
2.21 |
|
VendorName |
string(:16) |
W |
Classification criterion. When empty, the SFP is not classified by vendor name. |
- |
2.21 |
|
VendorOUI |
hexBinary(3) |
W |
Classification criterion. The vendor organizationally unique identifier (OUI) field of the SFP. When empty, the SFP is not classified by vendor OUI. |
- |
2.21 |
|
VendorPN |
string(:16) |
W |
Classification criterion. The vendor part number (PN) of the SFP. The ASCII character When empty or equal to "*", the SFP is not classified by vendor PN. Note: the string "*" as value for this parameter is equivalent to the empty string as value for this parameter. |
- |
2.21 |
|
Fingerprint |
string(:512) |
W |
Classification criterion. Fingerprint over certain properties of the SFP. If non-empty, the CPE 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 CPE 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:
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 CPE blocks or allows the SFP. If the fingerprint of the SFP is "FP1", the CPE must allow the SFP, else it must block it. |
- |
2.21 |
|
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. Changes since 2.20:
|
- |
2.0 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). The upstream interface is the one that provides connectivity to the Internet or the next hop router. For example:
|
- |
2.0 |
|
VirtualNoisePSDus |
base64(0:49) |
R |
Reports the virtual noise PSD for the upstream direction. Base64 encoded of the binary representation defined in G.997.1byG.997.1 by the parameter called TXREFVNus (maximum length is 49 octets, which requires 68 bytes for Base64 encoding). See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to an empty string. |
- |
2.0 |
|
Device.DSL.Line.{i}.DataGathering. |
object |
R |
This object models the DSL data gathering function at the VTU-R. This only applies to VDSL2. Note: see ITU-T Recommendation [G.993.2]. |
- |
2.8 |
|
EventTraceBufferR |
string(:256) |
R |
The value MUST be the Path Name of a row in the DeviceInfo.VendorLogFile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This parameter identifies the log file of the the data gathering event trace buffer containing the event records that originated at the VTU-R. This indicates the table entry that represents a Vendor Log File that contains the data gathering buffer at the VTU-R in the DeviceInfo.VendorLogFile table. This data gathering buffer MAY be retrieved wiavia an upload RPC of the identified Vendor Log File. Note: This parameter is defined as EVENT_TRACE_BUFFER_R in Clause 7.5.3.6 of ITU-T Recommendation [G.997.1] and Clause 11.5 of ITU-T Recommendation [G.993.2]. |
- |
2.8 |
|
Device.DSL.Channel.{i}. |
object(0:) |
R |
DSL Channel table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models DSL channel(s) on top of physical DSL lines. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. Changes since 2.20:
|
- |
2.0 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
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. Changes since 2.20:
|
- |
2.0 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
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. Changes since 2.20:
|
- |
2.11 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). The upstream interface is the one that provides connectivity to the Internet or the next hop router. For example:
|
- |
2.11 |
|
LineNumber |
int(1:) |
R |
Signifies the line pair that the modem is using to connection.connect. LineNumber = 1 is the innermost pair. |
- |
2.11 |
|
Device.FAST.Line.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.11 |
|
LastShowtimeStart |
unsignedInt |
R |
FAST-specific statistic. The Number of seconds since the second most recent DSL Showtime-theShowtime, i.e. the beginning of the period used for collection of LastShowtime statistics. If the CPE has not retained information about the second most recent Showtime (e.g., on reboot), the start of LastShowtime statistics MAY temporarily coincide with the start of Showtime statistics. Note: LastShowtimeStart SHOULD NOT be reset when the interface statistics are reset via an interface disable / enable cycle. 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. Changes since 2.20:
|
- |
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 CPE 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. Changes since 2.20:
|
- |
2.4 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). The upstream interface is the one that provides connectivity to the Internet or the next hop router. For example:
|
- |
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.20:
|
- |
2.8 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). The upstream interface is the one that provides connectivity to the Internet or the next hop router. For example:
|
- |
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. Changes since 2.20:
|
- |
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. Changes since 2.20:
|
- |
2.0 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
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. Changes since 2.20:
|
- |
2.15 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). The upstream interface is the one that provides connectivity to the Internet or the next hop router. For example:
|
- |
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. Changes since 2.20:
|
- |
2.15 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). The upstream interface is the one that provides connectivity to the Internet or the next hop router. For example:
|
- |
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. Changes since 2.20:
|
- |
2.15 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
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. Changes since 2.20:
|
- |
2.0 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Device.Ethernet. |
object |
R |
Ethernet object.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. Changes since 2.20:
|
- |
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 CPE 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. Changes since 2.20:
|
- |
2.0 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). The upstream interface is the one that provides connectivity to the Internet or the next hop router. For example:
|
- |
2.0 |
|
EDPDStatus |
string |
R |
Indicates the active state of Energy Detect Power Down (EDPD). Implementations of this feature are vendor specific, Energy Detect Power Down is not part of the 802.3-2015 standard. Enumeration of:
|
- |
2.19 |
|
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. Changes since 2.20:
|
- |
2.0 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
NoARP |
boolean |
W |
Disables or enables sending of ARP messages on the Ethernet link. If true, the kernel will not send ARP requests and won't send ARP replies. This parameter was DEPRECATED in 2.21 in favor of NeighborDiscovery.InterfaceSetting.{i}.ARP.Enable. Changes since 2.20:
|
false |
2.18 |
|
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. Changes since 2.20:
|
- |
2.0 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
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 CPE 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. Changes since 2.20:
|
- |
2.12 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
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 CPE MUST reset each instances's Stats parameters whenever the instance is disabled and re-enabled. Whether this reset occurs when the instance becomes operationally disabled (Status = Disabled) or administratively enabled (Enable = true) is a local matter to the CPE. This is similar to the behavior of interface statistics, e.g. as specified for Interface.{i}.Stats. Furthermore, this instance's Stats parameters MUST be reset whenever the referenced interface's Stats parameters are reset, or when the referenced queue or VLAN is disabled and re-enabled. For enabled table entries, if Interface references an interface that is not capable of transporting Ethernet-encapsulated packets, or if Queue references a queue that is not instantiated on Interface, or if Queue is not a valid reference and AllQueues is false, the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The RMONStats table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated RMONStats row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending 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 |
|
Packets128to255Bytes |
unsignedLong |
R |
The total number of packets (including bad packets) received that were between 128 and 255 bytes in length inclusive (excluding framing bits but including FCS bytes). This parameter is based on etherStatsPkts6128to255OctetsetherStatsPkts128to255Octets from [RFC2819]. Active Notification requests for this parameter MAY be denied. |
0 |
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. Changes since 2.20:
|
- |
2.0 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). The upstream interface is the one that provides connectivity to the Internet or the next hop router. For example:
|
- |
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. Changes since 2.20:
|
- |
2.0 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). The upstream interface is the one that provides connectivity to the Internet or the next hop router. For example:
|
- |
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. Changes since 2.20:
|
- |
2.0 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). The upstream interface is the one that provides connectivity to the Internet or the next hop router. For example:
|
- |
2.0 |
|
Device.Ghn. |
object |
R |
G.hn object that contains an Interface table for G.hn supported CPE. The ITU-T G.hn specifications [G.9960] and [G.9961] define Physical and MAC Layers for communication between two or more G.hn nodes in the home network over multiple wired media such as power line, phone line and coaxial cable. |
- |
2.4 |
|
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. Changes since 2.20:
|
- |
2.4 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). The upstream interface is the one that provides connectivity to the Internet or the next hop router. For example:
|
- |
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 CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.4 |
|
BlocksErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of received LPDUs that contained errors. Note the following relationships hold:
Active Notification requests for this parameter MAY be denied. |
- |
2.8 |
|
Device.Ghn.Diagnostics. |
object |
R |
The G.hn Diagnostics object. |
- |
2.8 |
|
Device.Ghn.Diagnostics.PerformanceMonitoring. |
object |
R |
G.hn Performance Monitoring diagnostics configuration and results. When diagnostics are requested, all G.hn nodes for which the Interface.{i}.PerformanceMonitoringDiagnosticsEnable parameter is set enter PHY diagnostics mode. |
- |
2.8 |
|
Device.Ghn.Diagnostics.PerformanceMonitoring.Nodes. |
object |
R |
Per-node G.hn performance monitoring results. When automatic collection is enabled, i.e. SampleInterval is non-zero, the "current" interval is defined by the most recent automatic sample and the most recent subsequent manual sample, if any. When automatic collection is disabled, i.e. SampleInterval is zero, the "current" interval is defined by the three most recent manual samples. Note: Packets in statistics counters are Ethernet packets. |
- |
2.8 |
|
Device.Ghn.Diagnostics.PerformanceMonitoring.Nodes.Node.{i}. |
object(1:) |
R |
Per-node G.hn performance monitoring results during the current sample interval. Each table entry contains the results collected between the G.hn nodes with MAC addresses DiagnoseMACAddress) and DestinationMACAddress). Note: Packet counters indicate the number of packets received between CurrentStart and CurrentEnd. This table MUST contain at least 1 entry. At most one entry in this table can exist with a given value for DestinationMACAddress. |
- |
2.8 |
|
BlocksErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of received LPDUs that contained errors. Note the following relationships hold:
Active Notification requests for this parameter MAY be denied. |
- |
2.8 |
|
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. Changes since 2.20:
|
- |
2.0 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). The upstream interface is the one that provides connectivity to the Internet or the next hop router. For example:
|
- |
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. Changes since 2.20:
|
- |
2.0 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). The upstream interface is the one that provides connectivity to the Internet or the next hop router. For example:
|
- |
2.0 |
|
Device.UPA.Diagnostics. |
object |
R |
The UPA Diagnostics object. |
- |
2.0 |
|
Device.UPA.Diagnostics.InterfaceMeasurement. |
object |
R |
This object provides access to either a Signal-to-Noise-Ratio (SNR) Port Measurement test or a Channel Frequency Response (CFR) Port Measurement test. The Type parameter is used to select which type of test to perform. CFR and SNR measurements are done between a two UPA devices (a local interface and a remote device belonging to the same network). |
- |
2.0 |
|
RxGain |
int |
R |
Reception gain of the adapter (expresssed(expressed in dB). |
- |
2.0 |
|
Device.WiFi. |
object |
R |
The WiFi object is based on the IEEE 802.11 specifications ([802.11-2020]). It defines interface objects (Radio and SSID), and application objects (AccessPoint and EndPoint). Changes since 2.20:
|
- |
2.0 |
|
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 netwtorknetwork 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.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. |
- |
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. Changes since 2.20:
|
- |
2.15 |
|
CountryCode |
string(2) |
R |
Two-character country code in which the Multi-AP Agent is operating according to [ISO3166-1]. The characters are encoded as UTF-8. If the instance of this DataElements is the same as Device.WiFi.Radio.{i}., then this parameter is the same as the first two octets of Device.WiFi.Radio.{i}.RegulatoryDomain. Possible patterns:
Changes since 2.20:
|
- |
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. Changes since 2.20:
|
- |
2.17 |
|
BackhaulPHYRate |
unsignedInt |
R |
The Physical Layer (PHY) rate in Mbps on the backhaul link of this EasyMesh agent. Changes since 2.20:
|
- |
2.17 |
|
APMLDMaxLinks |
unsignedInt(0:15) |
R |
The maximum number of affiliated APs supported by any APMLDAP 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.17 |
|
bSTAMLDMaxLinks |
unsignedInt(0:15) |
R |
The maximum number of affiliated bSTAs supported by the bSTAMLDbSTA 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.17 |
|
Device.WiFi.DataElements.Network.Device.{i}.AFCAvailableSpectrum. |
object |
R |
This object contains the Available Spectrum Inquiry request and response message defined by [Section 8.2.5/EasyMesh]. This provides information of 6 GHz spectrum availability as determined by an Automated Frequency Coordination (AFC) system [AFCSDI]. |
- |
2.19 |
|
AFCAvailableSpectrumInquiryRequest |
string |
R |
[JSONObject] One JSON encoded AvailableSpectrumInquiryRequestMessage object as defined in [Section 8.2.5 and Section 17.2.104 Available Spectrum Inquiry Request TLV/EasyMesh]. Changes since 2.20:
|
- |
2.19 |
|
AFCAvailableSpectrumInquiryResponse |
string |
R |
[JSONObject] One JSON encoded AvailableSpectrumInquiryResponseMessage object as defined in [Section 8.2.5 and Section 17.2.105 Available Spectrum Inquiry Response TLV/EasyMesh]. Changes since 2.20:
|
- |
2.19 |
|
Device.WiFi.DataElements.Network.Device.{i}.MultiAPDevice. |
object |
R |
This object represents an individual Access Point device. |
- |
2.15 |
|
ManufacturerOUI |
string(6) |
R |
Organizationally unique identifier of the Access Point device manufacturer. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. Possible patterns:
The value MUST be a valid OUI as defined in [OUI]. This value MUST remain fixed over the lifetime of the device, including across firmware updates. If the instance of this MultiAPDevice is the same as Device., then this parameter is the same as Device.DeviceInfo.ManufacturerOUI. This parameter was DEPRECATED in 2.18 because it was essentially the same as Manufacturer. This parameter was OBSOLETED in 2.20. This parameter was DELETED in 2.21. Changes since 2.20:
|
- |
2.15 |
|
EasyMeshControllerOperationMode |
string |
R |
This parameter represents the status of Wi-Fi CERTIFIED EasyMeshTM controller functionality. Enumeration of:
This parameter was DEPRECATED in 2.18 because it was the same as ControllerOperationMode. This parameter was OBSOLETED in 2.20. This parameter was DELETED in 2.21. Changes since 2.20:
|
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.MultiAPDevice.Backhaul. |
object |
R |
This object represents an individual Access Point device's Backhaul and unique aspects in the Wi-Fi network. The endpoints of the backhaul interface are represented by the (Device's ID and interface MAC Address). This object represents the upward view of the backhaul interface. The two endpoints of the backhaul interface are - (BackhaulDeviceID, BackhaulMACAddress) of the uplinked Backhaul Device - MACAddress of this Access Point Device. An empty string is reserved for the Backhaul instance that represents the Multi-AP Controller. |
- |
2.15 |
|
LinkType |
string |
R |
The medium being used to backhaul this Access Point Device to the Backhaul Access Point Device. The None value is reserved for the Backhaul instance that represents the Multi-AP Controller. Enumeration of:
This parameter was DEPRECATED in 2.18 because it was essentially the same as BackhaulMediaType. This parameter was OBSOLETED in 2.20. This parameter was DELETED in 2.21. Changes since 2.20:
|
- |
2.15 |
|
BackhaulMACAddress |
string(:17) |
R |
[MACAddress] The MAC Address at the far end of the backhaul link of the interface on the network that is providing a backhaul for this Access Point Device. This along with BackhaulDeviceID, helps to identify the backhaul interface endpoint. an empty string is reserved for the Backhaul instance that represents the Multi-AP Controller. This parameter was DEPRECATED in 2.18 because it was the same as BackhaulMACAddress. This parameter was OBSOLETED in 2.20. This parameter was DELETED in 2.21. Changes since 2.20:
|
- |
2.15 |
|
BackhaulDeviceID |
string(:17) |
R |
[MACAddress] The Device's ID of the Device on the network that is providing a Backhaul Link for this Access Point Device. This parameter was DEPRECATED in 2.18 because it was essentially the same as BackhaulALID. This parameter was OBSOLETED in 2.20. This parameter was DELETED in 2.21. Changes since 2.20:
|
- |
2.15 |
|
MACAddress |
string(:17) |
R |
[MACAddress] The MAC Address at the near end of the backhaul link of this Access Point Device's backhaul interface that is connecting via BackhaulMediaType to BackhaulMACAddress of the Backhaul Device identified by BackhaulDeviceID. This parameter was DEPRECATED in 2.18 because it was the same as Radio.{i}.BackhaulSta.MACAddress. This parameter was OBSOLETED in 2.20. This parameter was DELETED in 2.21. Changes since 2.20:
|
- |
2.15 |
|
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. |
- |
2.13 |
|
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 |
|
AggregateScanDuration |
unsignedInt |
R |
Total time spent performing the scan of this channel in milliseconds. This parameter was DEPRECATED in 2.21 because it is was moved to OpClassScan.{i}.ChannelScan.{i}. Changes since 2.20:
|
- |
2.17 |
|
ScanType |
boolean |
R |
Indicates whether the scan was performed passively (false) or with active probing (true). This parameter was DEPRECATED in 2.21 because it is was moved to OpClassScan.{i}.ChannelScan.{i}. Changes since 2.20:
|
- |
2.17 |
|
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. Changes since 2.20:
|
- |
2.14 |
|
AggregateScanDuration |
unsignedInt |
R |
Total time spent performing the scan of this channel in milliseconds. |
- |
2.21 |
|
ScanType |
boolean |
R |
Indicates the scan method used: true if active probing was employed, or false if the scan was performed passively. |
- |
2.21 |
|
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 APMLDAP MLD for which this NeighborBSS.{i}. is an affilated 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}.Capabilities. |
object |
R |
This object represents the capabilities of the radio which may be different from the current operational configuration. |
- |
2.13 |
|
HTCapabilities |
base64(1) |
R |
Describes the HT capabilities of the radio as defined by the AP HTCapabilities TLV [Section 17.2.8/EasyMesh].}} Includes all fields in the AP HTCapabilities TLV except tlvType, tlvLength, tlvValue and RUID. |
- |
2.13 |
|
VHTCapabilities |
base64(2:6) |
R |
Describes the VHT capabilities of the radio as defined by the AP VHTCapabilities TLV [Section 17.2.9/EasyMesh].}} Includes all fields in the AP VHTCapabilities TLV except tlvType, tlvLength, tlvValue and RUID. |
- |
2.13 |
|
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. |
- |
2.13 |
|
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. |
- |
2.13 |
|
HTCapabilities |
base64(1) |
R |
Describes the HT capabilities of the Associated Device (STA).}} Uses the format defined by the AP HTCapabilities TLV [Section 17.2.8/EasyMesh]. Includes all fields in the AP HTCapabilities TLV except tlvType, tlvLength, tlvValue and RUID. |
- |
2.13 |
|
VHTCapabilities |
base64(2:6) |
R |
Describes the VHT capabilities of the Associated Device (STA).}} Uses the format defined by the AP VHTCapabilities TLV [Section 17.2.9/EasyMesh]. Includes all fields in the AP VHTCapabilities TLV except tlvType, tlvLength, tlvValue and RUID. |
- |
2.13 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.MultiAPSTA. |
object |
R |
The summary of statistics and operations for an individual STA on the Wi-Fi network. The counters contained in MultiAPSTA are all reset on reboot. |
- |
2.15 |
|
AssociationTime |
dateTime |
R |
Date and time in UTC when the device was associated. If the instance of this MultiAPSTA is the same as Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}., then this parameter is the same as Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.AssociationTime. This parameter was DEPRECATED in 2.18 because it was essentially the same as LastConnectTime. This parameter was OBSOLETED in 2.20. This parameter was DELETED in 2.21. Changes since 2.20:
|
- |
2.15 |
|
Noise |
unsignedInt(:255) |
R |
An indicator of the average radio noise plus interference power measured on the uplink from the Associated Device (STA) to the Access Point (AP). Encoded as defined for ANPI in [Section 11.10.9.4/802.11-2020]. If the instance of this MultiAPSTA is the same as Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}., then this parameter is the same as Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.Noise. This parameter was DEPRECATED in 2.18 because it should be the same as Noise. This parameter was OBSOLETED in 2.20. This parameter was DELETED in 2.21. Changes since 2.20:
|
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.MultiAPRadio. |
object |
R |
This object represents an individual Access Point Radio in the Wi-Fi network. |
- |
2.15 |
|
RadarDetections |
unsignedInt[](:1024) |
R |
Comma-separated list (maximum number of characters 1024) of unsigned integers. List items represent channels in the non-occupancy list due to radars detected by Dynamic Frequency Selection (DFS) Channel Availability Check (CAC). This parameter was DEPRECATED in 2.18 because it was superseded by CACStatus.{i}.. This parameter was OBSOLETED in 2.20. This parameter was DELETED in 2.21. Changes since 2.20:
|
- |
2.15 |
|
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}.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.17 |
|
Device.WiFi.DataElements.Network.Device.{i}.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.19 |
|
Direction |
string |
W |
The direction of the traffic flow from the perspective the APMLD.AP MLD. Enumeration of:
|
- |
2.19 |
|
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.TIDLinkMap.{i}. |
object(0:) |
R |
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. |
- |
2.17 |
|
Direction |
string |
R |
The direction of the traffic flow from the perspective of the APMLD.AP MLD. Enumeration of:
|
- |
2.17 |
|
Device.WiFi.DataElements.Network.Device.{i}.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.19 |
|
LinkID |
unsignedInt(0:15) |
R |
The Link ID assigned to one of the affiliated APs of this APMLD.AP MLD. [Section 17.2.96, Agent AP MLD Configuration TLV/EasyMesh] |
- |
2.19 |
|
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 |
|
UnicastBytesSent |
unsignedInt |
R |
[StatsCounter32] Total number of unicast bytes transmitted to MLDaffiliated STAs associated with thethis affiliated AP. [EasyMesh] source: Affiliated AP Metrics TLV. |
- |
2.17 |
|
UnicastBytesReceived |
unsignedInt |
R |
[StatsCounter32] Total number of unicast bytes received from MLDaffiliated STAs associated with thethis affiliated AP. [EasyMesh] source: Affiliated AP Metrics TLV. |
- |
2.17 |
|
MulticastBytesSent |
unsignedInt |
R |
[StatsCounter32] Total multicast bytes transmitted to MLDaffiliated STAs associated with thethis affiliated AP. [EasyMesh] source: Affiliated AP Metrics TLV. |
- |
2.17 |
|
MulticastBytesReceived |
unsignedInt |
R |
[StatsCounter32] Total multicast bytes received from MLDaffiliated STAs associated with thethis affiliated AP. [EasyMesh] source: Affiliated AP Metrics TLV. |
- |
2.17 |
|
BroadcastBytesSent |
unsignedInt |
R |
[StatsCounter32] Total broadcast bytes transmitted to MLDaffiliated STAs associated with thethis affiliated AP. [EasyMesh] source: Affiliated AP Metrics TLV. |
- |
2.17 |
|
BroadcastBytesReceived |
unsignedInt |
R |
[StatsCounter32] Total broadcast bytes received from MLDaffiliated STAs associated with thethis affiliated AP. [EasyMesh] source: Affiliated AP Metrics 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. |
- |
2.17 |
|
MLDMACAddress |
string(:17) |
R |
[MACAddress] The Multi-Link Device (MLD) MAC Address of the clientSTA MLD STA.MLD. [EasyMesh] source: Associated STA MLD Configuration Report TLV. |
- |
2.17 |
|
Hostname |
string |
R |
The Hostname for the clientSTA MLD STA.}}MLD. |
- |
2.17 |
|
IsbSTA |
boolean |
R |
Indicates if the clientSTA MLD STA is a backhaul STA MLD STA(bSTA (bSTAMLD).MLD). This is useful to identify the type of STA MLD when the same AP MLD hasis used for both client MLDFronthaul and bSTAMLDsBackhaul associated.operation. [EasyMesh] source: Backhaul STA MLD Configuration TLV. |
- |
2.17 |
|
LastConnectTime |
unsignedInt |
R |
The time in seconds since this clientSTA MLD STA was associated. |
- |
2.17 |
|
BytesSent |
unsignedInt |
R |
[StatsCounter32] The total number of bytes transmitted to the clientSTA MLD STA.MLD. [EasyMesh] source: Associated STA Traffic Stats TLV. |
- |
2.17 |
|
BytesReceived |
unsignedInt |
R |
[StatsCounter32] The total number of bytes received from the clientSTA MLD STA.MLD. [EasyMesh] source: Associated STA Traffic Stats TLV. |
- |
2.17 |
|
PacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of packets transmitted to the clientSTA MLD STA.MLD. [EasyMesh] source: Associated STA Traffic Stats TLV. |
- |
2.17 |
|
PacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packets received from the clientSTA MLD STA.MLD. [EasyMesh] source: Associated STA Traffic Stats TLV. |
- |
2.17 |
|
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The number of packets which could not be transmitted to the clientSTA MLD STA due to errors. [EasyMesh] source: Associated STA Traffic Stats TLV. |
- |
2.17 |
|
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The number of packets which were received with error from the clientSTA MLD STA.MLD. [EasyMesh] source: Associated STA Traffic Stats TLV. |
- |
2.17 |
|
RetransCount |
unsignedInt |
R |
[StatsCounter32] The number of packets transmitted with the retry flag sent to the clientSTA MLD STA.MLD. [EasyMesh] source: Associated STA Traffic Stats TLV. |
- |
2.17 |
|
PairwiseAKM |
hexBinary(4) |
R |
Pairwise AKM suite selector selected by the STAMLD.STA MLD. The Pairwise AKM suite selector (OUI and type) is encoded as a 4-octet hex-encoded value without internal delimiters, e.g. 506F9A02 [Table 9-151/802.11-2020]. |
- |
2.19 |
|
PairwiseCipher |
hexBinary(4) |
R |
Pairwise AKM cipher selector selected by the STAMLD.STA MLD. The Pairwise AKM cipher selector (OUI and type) is encoded as a 4-octet hex-encoded value without internal delimiters, e.g. 506F9A02 [Table 9-149/802.11-2020]. |
- |
2.19 |
|
RSNCapabilities |
unsignedInt(:65535) |
R |
The RSN Capabilities selected by the STAMLDSTA MLD during association [Section 9.4.2.24.4/802.11-2020]. |
- |
2.19 |
|
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.STAMLD.{i}.WiFi7Capabilities. |
object |
R |
This object describes the Wi-Fi 7 capabilities for this STAMLDSTA MLD including Multi-Link Operation (MLO) capabilities. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV. |
- |
2.17 |
|
EMLMRSupport |
boolean |
R |
Indicates if the Enhanced Multi-Link Multi-Radio (EMLMR) operation is supported by this STAMLD.}}STA MLD. |
- |
2.17 |
|
EMLSRSupport |
boolean |
R |
Indicates if Enhanced Multi-Link Single-Radio (EMLSR) operation is supported by this STAMLD.}}STA MLD. |
- |
2.17 |
|
STRSupport |
boolean |
R |
Indicates if Simultaneous Transmit and Receive (STR) operation is supported by this STAMLD.}}STA MLD. |
- |
2.17 |
|
NSTRSupport |
boolean |
R |
Indicates if Non-Simultaneous Transmit and Receive (NSTR) operation is supported by this STAMLD.}}STA MLD. |
- |
2.17 |
|
TIDLinkMapNegotiation |
boolean |
R |
Indicates if Traffic Identifier (TID) to Link Mapping Negotiation is supported by this STAMLD.}}STA MLD. |
- |
2.17 |
|
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.STAMLD.{i}.STATIDLinkMap.{i}. |
object(0:) |
R |
Table of Traffic Identifier (TID) to Link Mappings of the Multi-Link Operation (MLO) capable station (STA). 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. |
- |
2.17 |
|
Direction |
string |
R |
The direction of the traffic flow from the perspective of the APMLD.AP MLD. Enumeration of:
|
- |
2.17 |
|
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.STAMLD.{i}.AffiliatedSTA.{i}. |
object(0:) |
R |
This object describes stations (STAs, also called associated devices) that are affiliated to this Multi-Link Device (MLD) STA. [EasyMesh] source: Associated STA MLD Configuration TLV. At most one entry in this table can exist with a given value for MACAddress. |
- |
2.17 |
|
UtilizationReceive |
unsignedLong |
R |
The amount of time in milliseconds that the APMLDAP MLD Radio has spent on the channel receiving data from the affiliated STA. |
- |
2.17 |
|
UtilizationTransmit |
unsignedLong |
R |
The amount of time in milliseconds that the APMLDAP MLD Radio has spent on the channel transmitting data to the affiliated STA. |
- |
2.17 |
|
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 |
|
BSSID |
string(:17) |
R |
[MACAddress] The MLD MAC address of the upstream APMLDAP MLD that this bSTAMLDbSTA MLD is associated to. [EasyMesh] source: Associated Clients TLV. |
- |
2.17 |
|
AffiliatedbSTAList |
string(:17)[] |
R |
[MACAddress] Comma-separated list of MAC Addresses. backhaul STA MAC addresses affiliated to this bSTAMLD.bSTA MLD. [EasyMesh] source: Backhaul STA MLD Configuration TLV. |
- |
2.17 |
|
Device.WiFi.DataElements.AssociationEvent. |
object |
R |
This object contains the events generated when a STA associates to a BSS. |
- |
2.13 |
|
Device.WiFi.DataElements.AssociationEvent.AssociationEventData.{i}. |
object(0:) |
R |
The events generated when an Associated Device (STA) associates to a BSS. This object was DEPRECATED in 2.17 because a corresponding USP event is defined instead. This object was OBSOLETED in 2.19. This object was DELETED in 2.20. |
- |
2.13 |
|
Device.WiFi.DataElements.DisassociationEvent. |
object |
R |
This object contains the events generated when an Associated Device (STA) disassociates from a BSS. |
- |
2.13 |
|
Device.WiFi.DataElements.DisassociationEvent.DisassociationEventData.{i}. |
object(0:) |
R |
The events generated when an Associated Device (STA) disassociates from a BSS. This object was DEPRECATED in 2.17 because a corresponding USP event is defined instead. This object was OBSOLETED in 2.19. This object was DELETED in 2.20. |
- |
2.13 |
|
Device.WiFi.Templates. |
object |
R |
Wi-Fi Configuration Templates provide a comprehensive way to configure Wi-Fi. Configuration Templates can be applied across multiple deployments in an operator's network, and across multiple APs, radios and BSSs. A set of Configuration Templates can be pre-defined, which can then handle many different services and scenarios by matching flags to select a particular template depending on AP or radio capabilities and topology. Different BSSs can be configured across different radios to provision different types of services. A detailed description of how to use Wi-Fi Configuration Templates is in [Section 3.4/DataElements]. The Configuration Template Manager (CTM) interprets and implements Configuration Templates for each deployment. |
- |
2.20 |
|
Device.WiFi.Templates.Network. |
object |
R |
This Network either has the Configuration Template Manager (CTM) deploy BSS(s) according to the templates, or has all BSS(s) be disabled. |
- |
2.20 |
|
PrimarySSCTemplateReference |
string |
W |
The value MUST be the Path Name of a row in the SSCTemplate. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. IncicatesIndicates the Primary SSCTemplate. The PrimaryVLANID in the EasyMesh network is the VLANID of the SSCTemplate referenced by PrimarySSCTemplateReference. If this value is empty, then Traffic Separation is not used. [Section 19/EasyMesh]. |
- |
2.20 |
|
Device.WiFi.Templates.SecurityTemplate.{i}. |
object(0:) |
W |
Table of SecurityTemplates for Wi-Fi configuration [WPA3]. 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 SecurityTemplateID. |
- |
2.20 |
|
Device.WiFi.Templates.SecurityTemplate.{i}.RSNE. |
object |
R |
This object describes the Robust Security Network Element (RSNE). This object is only used by the Configuration Template Manager if the SecurityIEs is empty. |
- |
2.20 |
|
MFP |
string |
W |
Indicates the expected support for Management Frame Protection (MFP), aka Protected Management Frame (PMF). [WPA3] and see also the WPA3 and Wi-Fi Enhanced Open Deployment Guide v1.1.pdf, Table 3, row PMF. Enumeration of:
|
- |
2.20 |
|
Device.WiFi.Templates.SecurityTemplate.{i}.RSNOE. |
object |
R |
This object describes the RSNOE element. This object is only used by the Configuration Template Manager if the SecurityIEs is empty. |
- |
2.20 |
|
MFP |
string |
W |
Indicates the expected support for Management Frame Protection (MFP), aka Protected Management Frame (PMF). [WPA3] and see also the WPA3 and Wi-Fi Enhanced Open Deployment Guide v1.1.pdf, Table 3, row PMF. Enumeration of:
|
- |
2.20 |
|
Device.WiFi.Templates.SecurityTemplate.{i}.RSNO2E. |
object |
R |
This object describes the RSNO2E element. This object is only used by the Configuration Template Manager if the SecurityIEs is empty. |
- |
2.20 |
|
MFP |
string |
W |
Indicates the expected support for Management Frame Protection (MFP), aka Protected Management Frame (PMF). [WPA3] and see also the WPA3 and Wi-Fi Enhanced Open Deployment Guide v1.1.pdf, Table 3, row PMF. Enumeration of:
|
- |
2.20 |
|
Device.WiFi.Templates.SecurityGroup.{i}. |
object(0:) |
W |
Table of SecurityGroups for Wi-Fi configuration [WPA3]. At most one entry in this table can exist with a given value for SecurityGroupID. On creation of a new table entry, the Agent MUST choose an initial value for SecurityGroupID such that the new entry does not conflict with any existing entries. |
- |
2.20 |
|
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 |
|
Enable |
boolean |
W |
Enable or disable the AFC client function. This parameter should be true if 6GHz AP Type is Standard Power. If the Device.WiFi.Radio.{i}.PowerType for 6GHz is not StandardPower , this should be set to false. To enable this parameter, the AFC server URL, ServerURL must be specified. |
- |
2.21 |
|
ServerURL |
string(:2048) |
W |
[URI] The URL for the CPE 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 CPE for validating the AFC certificate when using TLS. |
- |
2.21 |
|
Port |
unsignedInt(0:65535) |
W |
Specifies the TCP port on which the AFC server is listening for incoming requests from the AFC client. The default value SHOULD be 443. |
- |
2.21 |
|
RequestVersion |
string(:16) |
W |
AFC protocol version as defined in [Section 4.1/AFCSDI]. This value MUST match the version used by the AFC server and specification. For example, "1.4". |
- |
2.21 |
|
UseFrequencyRange |
boolean |
W |
Indicates whether FrequencyRange should be included in the Available Spectrum Inquiry Request. If true, it indicates that the AFC System is to provide Available Spectrum information on the basis of frequency and "inquiredFrequencyRange" field would be included in the Available Spectrum Inquiry Request message. If true, FrequencyRange should not be empty. |
- |
2.21 |
|
FrequencyRange |
string[] |
W |
Comma-separated list of strings. Each entry in the list is a range of frequency for which the AFC request is made, in the form "low:high", for example "5925:6425,6525:6875". This parameter is conditionally required when UseFrequencyRange is true. This parameter contains one or more frequency ranges for which the AP or Fixed Client Device is requesting spectrum availability. If present, it indicates that the AFC System is to provide Available Spectrum information on the basis of frequency. This field would be included in the Available Spectrum Inquiry Request message. |
- |
2.21 |
|
UseInquiredChannels |
boolean |
W |
Indicates whether OperatingClassList should be included in the Available Spectrum Inquiry Request. If true, it indicates that the AFC System is to provide Available Spectrum information on the basis of channels, and "inquiredChannels" field would be included in the Available Spectrum Inquiry Request message. If true, OperatingClassList should not be empty. |
- |
2.21 |
|
OperatingClassList |
unsignedInt[] |
W |
Comma-separated list of unsigned integers. Each entry in the list is the global operating classes used to define the channel center frequency indices and operating bandwidth. For example, "131,132,133,134,136". This parameter is conditionally required when UseInquiredChannels is true. This parameter contains one or more lists of channels for which the AP or Fixed Client Device is requesting spectrum availability. If present, it indicates that the AFC System is to provide Available Spectrum information on the basis of channels. |
- |
2.21 |
|
IndoorDeployment |
string |
R |
Indicates whether the deployment of the AP or Fixed Client Device is located indoors, outdoors, or is unknown. Enumeration of:
|
- |
2.21 |
|
MinDesiredPower |
int |
W |
Indicates the minimum desired EIRP in dBm. This field is optionally present in a AFC query by inquiredChannels; otherwise, it is absent. If present, the AFC System shall provide all the inquired channels available for use at or above the defined minDesiredPower. If absent, the AFC System shall provide a response for all inquiredChannels which are available for use at any power. |
- |
2.21 |
|
TLSVersion |
string |
W |
Specifies the version of Transport Layer Security (TLS) to be used by AFC client for secure communication with the AFC server. The device must use TLS version 1.2, or a newer version as per [Section 3.4.2/AFCSDI]. The selected version must be supported by both the AFC client and server. If the CA certificate path is not located in the standard Path of the device, the CABundle parameter must be specified to provide the correct certificate path. Enumeration of:
|
- |
2.21 |
|
OCSPEnable |
boolean |
W |
Enables or disables Online Certificate Status Protocol (OCSP) checking for certificate validation during TLS handshake. When enabled, the AFC client will verify the revocation status of the server certificate using OCSP before establishing a secure connection. As per [Section 2.3.1 AFC DUT Test Harness/AFCCTP], AFC DUT should have OCSP enabled. If set to false, the client will skip OCSP validation, which may reduce security. The default value SHOULD be true. |
- |
2.21 |
|
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.21 |
|
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.21 |
|
MTLSEnable |
boolean |
W |
Enable or disable mutual TLS (mTLS). MTLSEnable is an optional parameter that enables mTLS when required by the AFC server. If true, Certificate should be specified. |
- |
2.21 |
|
Device.WiFi.AFC.DeviceDescriptor. |
object |
R |
This object contains the information of an AP or Fixed Client Device used by the AFC system. |
- |
2.21 |
|
SerialNumber |
string(:64) |
R |
Device serial number for this AP or Fixed Client Device. |
- |
2.21 |
|
CertificationID |
string(:128) |
W |
Specifies the certification ID of the AP or Fixed Client Device, as defined in [Table 8. CertificationId object/AFCSDI]. |
- |
2.21 |
|
RulesetID |
string(:128) |
W |
Identifier for the regulatory ruleset applicable to this device. For example, US_47_CFR_PART_15_SUBPART_E for US, CA_RES_DBS-06 for CA as per [Table 8. CertificationId object/AFCSDI]. |
- |
2.21 |
|
Device.WiFi.AFC.Location. |
object |
R |
Object that contains references to the location of the AP or Fixed Client Device obtained from GPS, Barometer, External or Manual sources. |
- |
2.21 |
|
GPS |
string(:256) |
W |
The value MUST be the Path Name of a row in the DeviceInfo.Location. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The value MUST be the path name of a row in Device.DeviceInfo.Location Object, which has the GPS location details, either via GPS, External source or Manual. For example: Device.DeviceInfo.Location.1. |
- |
2.21 |
|
Barometer |
string(:256) |
W |
The value MUST be the Path Name of a row in the DeviceInfo.Location. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The value MUST be the path name of a row in Device.DeviceInfo.Location Object, which has the Barometer data details, either via Barometer, External source or Manual. For example: Device.DeviceInfo.Location.2. |
- |
2.21 |
|
Device.WiFi.AFC.Stats. |
object |
R |
Object that contains information about AFC requests and responses. |
- |
2.21 |
|
AvailableSpectrumRequest |
string |
R |
[JSONObject] Represents the full JSON Available Spectrum Inquiry request payload sent by the AFC client to the AFC server. |
- |
2.21 |
|
AvailableSpectrumResponse |
string |
R |
[JSONObject] Contains the JSON response payload received from the AFC server corresponding to the AvailableSpectrumRequest parameter. |
- |
2.21 |
|
GrantExpiryTime |
dateTime |
R |
This parameter contains the time when the spectrum availability specified in the response expires. This field SHALL be included if and only if the response code indicates SUCCESS as per [Table 19. AvailableSpectrumInquiryResponse object/AFCSDI]. The string value SHALL be represented in UTC and conform to the following format: "YYYY-MM-DDThh:mm:ssZ". |
- |
2.21 |
|
GrantStatus |
string |
R |
Indicates the status of the AFC grant request. It indicates the Response Name associated with the Response Code received in the latest Available Inquiry Spectrum Response as defined in [Table 25. Response Code definitions/AFCSDI]. Enumeration of:
|
- |
2.21 |
|
GrantResponse |
string(:1024) |
R |
Human-readable interpretation of the grant status as defined in [Table 25. Response Code definitions/AFCSDI]. For example, "Incompatible interface version number" for response code 100. |
- |
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.20:
|
- |
2.0 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). The upstream interface is the one that provides connectivity to the Internet or the next hop router. For example:
An interface might have some SSIDs pointing towards the Internet and other SSIDs pointing towards End Devices. This is indicated by the associated SSID.{i}.Upstream parameters. This interface's Upstream parameter is set to true if any of the associated SSID.{i}.Upstream parameters are true, and is set to false otherwise. This parameter was DEPRECATED in 2.12 (and then OBSOLETED in 2.14) because it couldn't describe all multi-SSID use cases. It has now been restored, and its multi-SSID behavior has been clarified. |
- |
2.0 |
|
AllowedChannels |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. List items represent user-defined allowed radio channels for use by Automatic Channel Selection or manual channel selection. An empty list means that all channels in PossibleChannels are allowed. A non-empty list means that only the channels in the list are allowed. Ranges in the form "n-m" are permitted. This list is a subset of PossibleChannels. |
- |
2.21 |
|
PowerType |
string |
W |
Indicates the AP type of 6GHz Radio. This has no impact for operation on other bands. This value will be mapped to he_6ghz_reg_pwr_type in hostapd.conf. [Table E-12/802.11-2024] [Table E-13/802.11-2024] Enumeration of:
|
- |
2.21 |
|
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.20:
|
- |
2.0 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
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 CPE MUST set Status to Error_Misconfigured. Note: The AccessPoint table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated AccessPoint row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending AccessPoint row. At most one entry in this table (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. |
- |
2.0 |
|
Device.WiFi.AccessPoint.{i}.Security. |
object |
R |
This object contains security related parameters that apply to a CPE acting as an Access Point [802.11-2007]. |
- |
2.0 |
|
TransitionDisableIndication |
boolean |
W |
Sets the transition disable indication. When this parameter is enabled with ModeEnabled set to a transition mode, such as WPA3-Personal-Transition, stations connected to the AP are not allowed to transition between the security modes allowed by the transition mode. Stations capable of the more secure security mode allowed by the transition, as defined in [WPA3], will always communicate to the AP using it. |
true |
2.16 |
|
Device.WiFi.AccessPoint.{i}.Interworking. |
object |
R |
This object contains the settings to the interworking element as described in [Section 9.4.2.91/802.11-2020]. |
- |
2.19 |
|
VenueGroup |
string |
W |
Specifies the venue group as descripeddescribed in [Table 9-65-Venue group codes and descriptions/802.11-2020]. Enumeration of:
|
- |
2.19 |
|
Device.WiFi.AccessPoint.{i}.ANQP. |
object |
R |
This object contains the settings required for configuring the Access Network Query Protocol Information Elements as described in [Section 9.4.5/802.11-2020]. |
- |
2.19 |
|
Enable |
boolean |
W |
SpecfiesSpecifies whether ANQP Element is sent as part of the wireless frames. |
false |
2.19 |
|
IPv4AddressAvailability |
string |
W |
Specifies the IPv4 address availabiltyavailability field as described in [Table 9-334-IPv4 Address field values/802.11-2020]. Enumeration of:
|
- |
2.19 |
|
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. |
- |
2.0 |
|
Noise |
int(-200:0) |
R |
An indicator of radio noise on the uplink from the associated device to the access point, measured in dBm, as an average of the last 100 packets received from the device (see ANPI definition in [Clause 10.11.9.4/802.11-2012]) 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}.MultiAPSTA.Noise. |
- |
2.12 |
|
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). |
- |
2.19 |
|
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.20:
|
- |
2.19 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). The upstream interface is the one that provides connectivity to the Internet or the next hop router. For example:
|
- |
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. Changes since 2.20:
|
- |
2.19 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
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. |
- |
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. |
- |
2.19 |
|
Type |
string |
R |
The IPv6 address may bybe of one the following types. Enumeration of: * LinkLocal (Address reachable by a single radio transmission with the prefixes fe80::/16). * MeshLocal (Address reachable within the same Thread network with the prefix defined by the Thread network). * Global (Address reachable from outside a Thread network with the prefix provided by the Border Router). |
- |
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. Changes since 2.20:
|
- |
2.7 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). The upstream interface is the one that provides connectivity to the Internet or the next hop router. For example:
|
- |
2.19 |
|
Device.ZigBee.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.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. Active Notification requests for this parameter MAY be denied. Changes since 2.20:
|
- |
2.7 |
|
Device.ZigBee.ZDO.{i}. |
object(0:) |
R |
ZigBee Device Object (ZDO) provides management capabilities of the ZigBee Application Support (APS) and Network (NWK) layers of a ZigBee Device as defined in [Section 2.5/ZigBee2007]. At most one entry in this table can exist with the same values for both IEEEAddress and NetworkAddress, or with a given value for Alias. 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 ZDO instances have the same key value the implementation is undefined |
- |
2.7 |
|
Device.ZigBee.ZDO.{i}.ApplicationEndpoint.{i}. |
object(0:) |
W |
The ApplicationEndpoint object describes the application endpoint as defined in [Section 2.1.2 Application Framework/ZigBee2007]. 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 EndpointId. |
- |
2.7 |
|
Device.ZigBee.ZDO.{i}.ApplicationEndpoint.{i}.SimpleDescriptor. |
object |
R |
The SimpleDescriptor object contains the attributes of the Simple Descriptor of an application endpoint, as defined in [Section 2.3.2.5 Simple Descriptor/ZigBee2007]. |
- |
2.7 |
|
ProfileId |
unsignedInt(:65535) |
W |
Specifies the application profile that is supported on this endpoint. Application profiles are agreements for messages, message formats, andprocessingand processing actions that enable developers to create an interoperable, distributed application employing application entities that reside on separate ZigBee devices. These application profiles enable applications to send commands, request data, and process commands and requests as defined in [Section 2.1.2.1 Application Profiles/ZigBee2007]. |
- |
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 |
|
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 |
|
Device.Bridging.Bridge.{i}.Port.{i}. |
object(0:) |
W |
Bridge Portport 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 CPE 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. Changes since 2.20:
|
- |
2.0 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
DefaultUserPriority |
unsignedInt(0:7) |
W |
BridgeThe Portdefault Defaultuser Userpriority Priority.}}for the bridge port. |
- |
2.0 |
|
PriorityRegeneration |
unsignedInt(0:7)[8:8]() |
W |
Comma-separated list (8 items) (length ) of unsigned integers (0 to 7). List items represent user priority regeneration values for each ingress user priority on this Bridgebridge Port.}}port. |
0,1,2,3,4,5,6,7 |
2.0 |
|
PortState |
string |
R |
Bridge Portport state as defined in 802.1D [802.1D-2004] and 802.1Q [802.1Q-2011]. Enumeration of:
|
Disabled |
2.0 |
|
AcceptableFrameTypes |
string |
W |
Indicates which types of frame arriving on this port will be admitted to the bridge (i.e. Bridgebridge Portport acceptable frame types as defined in 802.1Q [802.1Q-2011]). Enumeration of:
For an 802.1D [802.1D-2004] Bridge, the value of this parameter MUST be AdmitAll. |
AdmitAll |
2.0 |
|
PriorityTagging |
boolean |
W |
Enables or disables priority tagging on this Bridgebridge Port.port. When true, egress frames leaving this interface will be priority tagged with the frame's associated priority value, which will either be derived directly from the ingress frame or else set via QoS.Classification.{i}.EthernetPriorityMark. When false, egress frames leaving this interface will be untagged. The parameter does not affect reception of ingress frames. Only applies on bridge ports that are untagged member of one or more VLAN's. |
false |
2.0 |
|
STPPointToPointMode |
string |
W |
Configures the point-to-point link status for RSTP. Enumeration of:
If STP is used instead of RSTP, this feature has no effect since rapid transition for P2P links does not exist in regular STP. |
Auto |
2.21 |
|
STPAdminEdgePort |
boolean |
W |
Configures the administrative edge port status for STP. Edge ports do not participate in the STP algorithm, since they are by definition located at the edge of the network and therefore cannot cause any loops. |
false |
2.21 |
|
IGMP |
boolean |
W |
Enables or disables Internet Group Management Protocol (IGMP) snooping on this bridge port. When enabled, the bridge monitors IGMP messages to determine which hosts are interested in receiving multicast traffic, and forwards multicast traffic only to the appropriate ports. This helps to reduce multicast traffic on the network. |
false |
2.21 |
|
MLD |
boolean |
W |
Enables or disables Multicast Listener Discovery (MLD) snooping on this bridge port. When enabled, the bridge monitors MLD messages to determine which hosts are interested in receiving multicast traffic, and forwards multicast traffic only to the appropriate ports. This helps to reduce multicast traffic on the network. |
false |
2.21 |
|
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 CPE 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 CPE to indicate a locally defined error condition. If the Bridgebridge Portport 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 |
|
Interface |
string(:256) |
W |
The value MUST be the Path Name of a row in the Bridge.{i}.Port. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This MUST relate to the same bridge as does Bridge. Defines the Bridgebridge Portport on which ingress frame classification will occur. |
<Empty> |
2.0 |
|
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. Changes since 2.20:
|
- |
2.0 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Device.IP. |
object |
R |
IP object that contains the Interface, ActivePort, and Diagnostics objects. |
- |
2.0 |
|
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 CPE 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. Changes since 2.20:
|
- |
2.0 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Device.IP.Diagnostics. |
object |
R |
The IP Diagnostics object. |
- |
2.0 |
|
Device.IP.Diagnostics.IPLayerCapacityMetrics. |
object |
R |
This object defines the diagnostics configuration for a IP Layer Capacity test. IP Layer Capacity measurement is specified in [TR-471]. FilesData received in the IP Layer Capacity testmeasurement do not require file storage on the CPE device. If AuthenticationEnabled is set to true, one of the following combinations of AuthenticationCode, AuthenticationKeyID and AuthenticationKeyFileLocation MUST be met. Otherwise, the client returns an error. If only AuthenticationCode is provided, the client uses the value directly as the key. If both AuthenticationCode and AuthenticationKeyID are provided but AuthenticationKeyFileLocation is not provided, the client uses the AuthenticationCode as the key and the AuthenticationKeyID as key ID. The IPLayerCapacityAuthCode table is ignored. If only AuthenticationKeyID is provided, AuthenticationKeyID is used to select the instance to use from the IPLayerCapacityAuthCode table. The client uses theIPLayerCapacityAuthCode.{i}.AuthenticationKey {{object|IPLayerCapacityAuthCode}} table to deriveas the key and AuthenticationKeyID as key ID,ID. andIf the IPLayerCapacityAuthCode table does not contain the AuthenticationKeyID as, the key.client returns an error. If both AuthenticationKeyID and AuthenticationKeyFileLocation are provided, but AuthenticationCode is not provided, the client uses the AuthenticationKeyID as key ID along with AuthenticationKeyFileLocation as file location. The IPLayerCapacityAuthCode table is ignored. If only AuthenticationKeyFileLocation is provided, andif the {{object|IPLayerCapacityAuthCode}}file doesspecified notcontains containonly a single entry, then it uses that as the {{param|AuthenticationAlias}},key. If the file contains multiple entries, then it uses the key from the entry with Key ID equal to 0. If no entry exists with Key ID equal to 0, the client returns an error.{{div|{{classes}}|If only {{param|AuthenticationKeyFileLocation}} is provided, the file specified MUST contain a single entry. Otherwise, the client returns an error.}} Changes since 2.20:
|
- |
2.14 |
|
AuthenticationKeyID |
unsignedInt(0:255) |
W |
The authentication key ID to use when the client connects to the server. Refer to Device.IP.Diagnostics.IPLayerCapacityMetrics for description on how the input arguments are provided to enable authentication for the test. |
- |
2.21 |
|
AuthenticationAlias |
string |
W |
The reference to IPLayerCapacityAuthCode table by Alias. Refer to Device.IP.Diagnostics.IPLayerCapacityMetrics for description on how the input arguments are provided to enable authentication for the test. This parameter was DEPRECATED in 2.21 because it is superseded by AuthenticationKeyID . Changes since 2.20:
|
- |
2.19 |
|
AuthenticationKeyFileLocation |
string |
W |
The key file location the client uses to derive the {{param|AuthenticationCode}}key and {{param|AuthenticationAlias}}key ID to be used for authentication. Refer to Device.IP.Diagnostics.IPLayerCapacityMetrics for description on how the input arguments are provided to enable authentication for the test. |
- |
2.19 |
|
Device.IP.Diagnostics.IPLayerCapacityMetrics.IPLayerCapacityAuthCode.{i}. |
object(1:256) |
W |
Authentication Code table containing list of keys to be used by the client when connecting to the server. This table MUST contain at least 1 and at most 256 entries. At most one entry in this table can exist with a given value for AuthenticationKeyID, or with a given value for Alias. On creation of a new table entry, the Agent MUST choose initial values for AuthenticationKeyID and Alias such that the new entry does not conflict with any existing entries. Changes since 2.20:
|
- |
2.19 |
|
AuthenticationKeyID |
unsignedInt(0:255) |
W |
The authentication key ID to use when the client connects to the server using AuthenticationKey as key. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.21 |
|
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. Changes since 2.20:
|
- |
2.5 |
|
IKEv2SupportedIDTypes |
string[] |
R |
Comma-separated list of strings. Supported IKE Identity Payload types as defined in [Section 3.5/RFC7296]. Each list item is an enumeration of:
|
- |
2.21 |
|
SecretNumberOfEntries |
unsignedInt |
R |
The number of entries in the Secret table. |
- |
2.21 |
|
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.20:
|
- |
2.5 |
|
IKEv2RemoteAuthenticationMethod |
string |
W |
The value MUST be the Path Name of a row in the Security.CABundle. or IPsec.Secret. tables. If the referenced object is deleted, the parameter value MUST be set to an empty string. IKEv2 authentication method for the remote peer [Section 2.15/RFC7296]. If an empty string, the device uses the value of IKEv2AuthenticationMethod, and symmetric authentication is expected. |
<Empty> |
2.21 |
|
IKEv2LocalID |
string |
W |
The identity sent in the IKEv2 Identification payload (IDi or IDr) during the IKE_AUTH exchange. Together with the ID type, this identity is used by the device to select the IKEv2/IPsec policy and enforce access control, as defined in [RFC7296]. If IKEv2LocalID is an empty string, the device MAY select a default identity and identity type. When certificate-based authentication is used, this default MAY be derived from certificate attributes e.g. subject DN or subjectAltName. Depending on local policy, the device MAY require the selected identity to match certificate fields, as permitted by [RFC7296]. |
- |
2.21 |
|
IKEv2LocalIDType |
string |
W |
The value MUST be a member of the list reported by the IPsec.IKEv2SupportedIDTypes parameter. This parameter specifies the IKEv2 Identification Payload type used for the local endpoint (IDi or IDr). It is used together with IKEv2LocalID to construct the identity sent during IKE_AUTH. |
- |
2.21 |
|
IKEv2RemoteID |
string |
W |
The expected peer identity as carried in the IKEv2 Identification payload (IDi or IDr) during the IKE_AUTH exchange. Together with the ID type, this identity is used by the device to select the IKEv2/IPsec policy and enforce access control, as defined in [RFC7296]. If an empty string, the device MAY accept any identity that is successfully authenticated. Depending on local policy, the device MAY require the peer’s asserted identity to match certificate fields, as permitted by [RFC7296]. |
- |
2.21 |
|
IKEv2RemoteIDType |
string |
W |
The value MUST be a member of the list reported by the IPsec.IKEv2SupportedIDTypes parameter. This parameter specifies the expected IKEv2 Identification Payload type for the remote endpoint (IDi or IDr). It is used together with IKEv2RemoteID to verify the peer’s asserted identity during IKE_AUTH. |
- |
2.21 |
|
HardwareOffload |
string |
W |
Configures how IPSec is off-loaded to the hardware. Enumeration of:
|
Auto |
2.21 |
|
Device.IPsec.Secret.{i}. |
object(0:) |
W |
Each instance of this object represents a pre-shared secret used for IKEv2 authentication. Either PreSharedKey or KeyPassphrase MUST be configured. 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 Secret. |
false |
2.21 |
|
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.21 |
|
|
hexBinary |
W |
A literal PreSharedKey (PSK) expressed as a hexadecimal string. If KeyPassphrase is written, then PreSharedKey is immediately generated. The Controller SHOULD NOT set both the KeyPassphrase and the PreSharedKey directly (the result of doing this is undefined). When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.21 |
|
KeyPassphrase |
string |
W |
A passphrase from which the PreSharedKey is to be generated. If KeyPassphrase is written, then PreSharedKey is immediately generated. The Controller SHOULD NOT set both the KeyPassphrase and the PreSharedKey directly (the result of doing this is undefined). The key is generated as specified by IKEv2, which uses ASCII-to-hex algorithm [Section 2.15/RFC7296]. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.21 |
|
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. Changes since 2.20:
|
- |
2.8 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
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. Changes since 2.20:
|
- |
2.12 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
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 hethe CPE is to generate the session ids for this Interface instance. |
1 |
2.12 |
|
CookiePolicy |
string |
W |
The policy that defines how the Cookie is handled in this Interface instance. Enumeration of:
|
Configured |
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. Changes since 2.20:
|
- |
2.12 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
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 CPE 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 CPE 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 |
|
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. Changes since 2.20:
|
- |
2.8 |
|
Alias |
string(:64) |
W |
[Alias] ::::::: hide 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:
This parameter was DEPRECATED in 2.18 because Domain already has an Alias parameter. This parameter was OBSOLETED in 2.20. This parameter was DELETED in 2.21. Changes since 2.20:
|
- |
2.8 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
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.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. Changes since 2.20:
|
- |
2.2 |
|
LastChange |
unsignedInt |
R |
The accumulated time in seconds since the last router advertisement message was received. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
Device.Routing.Babel. |
object |
R |
This object provides parameters for configuration, troubleshooting, and monitoring of the Babel routing protocol [RFC8966]. This data model is based on the Babel information model defined in [RFC9046]. |
- |
2.15 |
|
Device.Routing.Babel.InterfaceSetting.{i}. |
object(0:) |
W |
This object provides parameters related to the interfaces the Babel protocol is operating over and can act as a routing protocol for. 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 |
|
Device.Routing.Babel.InterfaceSetting.{i}.Neighbor.{i}. |
object(0:) |
R |
This object provides parameters related to neighbor devices that Babel packets are received from and sent to. At most one entry in this table can exist with a given value for NeighborAddress. |
- |
2.15 |
|
HelloUCastHistory |
hexBinary |
R |
The unicast Hello history of whether or not the unicast Hello packets prior to ExpectedUCastHelloSeqno were received. This is a binary sequence where the most recently received Hello is expressed as a "1" placed in the left-most bit, with prior bits shifted right (and "0" bits placed between prior Hello bitssbits and the most recent Hello bit for any not-received Hellos). This value is displayed using hex digits. See [Section A.1/RFC8966]. |
- |
2.15 |
|
Cost |
unsignedInt(:65535) |
R |
Link cost is computed from the values maintained by a Babel implementation in its neighbor table as defined in [Section 3.2.4/RFC8966]: the statistics kept about the reception of Hellos and the transmission cost computed from received IHU packets. See [Section 3.4.3/RFC8966]. |
- |
2.15 |
|
Device.NeighborDiscovery. |
object |
R |
TheThis object describes a unified approach for Layer 3 to Layer 2 address resolution protocols, managing both the Neighbor Discovery Protocol (NDP) objectfor IPv6 [RFC4861]. Thisand objectthe appliesAddress onlyResolution toProtocol IPv6.(ARP) for IPv4. It contains an InterfaceSetting table that defines the NDP configuration for individual IP interfaces. |
- |
2.2 |
|
Device.NeighborDiscovery.InterfaceSetting.{i}. |
object(0:) |
W |
Per-interfaceA Neighbor Discovery Protocol (NDP)per-interface configuration {{bibref|RFC4861}}.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 enabledthis tableentry entries,to ifbe operational, the Interface isparameter notMUST be a valid reference to an IPv6-capableexisting interfaceIP (thatinterface. If the reference is attachedinvalid, to the IPv6 stack), then the tablethis entry is inoperable and the CPE MUST set Status to Error_Misconfigured.{{div|{{classes}}|Note: The {{object}} table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to {{empty}}. However, doing so under these circumstances might cause the updated {{object}} row to then violate the table's unique key constraint; if this occurs, the CPE MUST set {{param|Status}} to {{enum|Error_Misconfigured|Status}} and disable the offending {{object}} 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 |
|
Enable |
boolean |
W |
Enables or disables this {{object}}entire interface setting entry.}} If false, both ARP and NDP are considered disabled for this interface through this object, regardless of their individual ARP.Enable or NDP.Enable settings. |
false |
2.2 |
|
DADTransmits |
unsignedInt |
W |
The number of consecutive Neighbor Solicitation messages sent while performing Duplicate Address Detection on a tentative address (see[Section 5.1/RFC4862]). A value of zero indicates that Duplicate Address Detection is not performed on tentative addresses. A value of one indicates a single transmission with no follow-up retransmissions. If the value is greater than 1, RetransTimer defines the delay between consecutive messages. This parameter was DEPRECATED in 2.21 in favor of NDP.DADTransmits. Changes since 2.20:
|
1 |
2.13 |
|
RetransTimer |
unsignedInt(1:) |
W |
Retransmission interval in milliseconds, as defined in [RFC4861]. For auto-configuration purposes, RetransTimer specifies the delay between consecutive Neighbor Solicitation transmissions performed during Duplicate Address Detection (DAD) [Section 5.4/RFC4862], as well as the time a node waits after sending the last Neighbor Solicitation before ending the DAD process. This parameter was DEPRECATED in 2.21 in favor of NDP.RetransTimer. Changes since 2.20:
|
1000 |
2.2 |
|
RtrSolicitationInterval |
unsignedInt(4000:) |
W |
Retransmission interval in milliseconds, as defined in [Section 6.3.7/RFC4861]. For auto-configuration purposes, RtrSolicitationInterval specifies the delay between consecutive Router Solicitation transmissions. This parameter was DEPRECATED in 2.21 in favor of NDP.RtrSolicitationInterval. Changes since 2.20:
|
4000 |
2.2 |
|
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. This parameter was DEPRECATED in 2.21 in favor of NDP.MaxRtrSolicitations. Changes since 2.20:
|
3 |
2.2 |
|
NUDEnable |
boolean |
W |
Enables or disables Neighbor Unreachability Detection (NUD) [Section 7/RFC4861]. This parameter was DEPRECATED in 2.21 in favor of NDP.NUDEnable. Changes since 2.20:
|
- |
2.2 |
|
RSEnable |
boolean |
W |
Enables or disables Router Solicitation (RS) on Interface [Section 4.1/RFC4861]. This parameter was DEPRECATED in 2.21 in favor of NDP.RSEnable. Changes since 2.20:
|
- |
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 |
|
Enable |
boolean |
W |
Enables or disables NDP functionality for this specific interface. This parameter works in conjunction with Enable. If Enable is false, then NDP is considered disabled for this interface regardless of this parameter's value. |
true |
2.21 |
|
Status |
string |
R |
The status of this NDP. Enumeration of:
A value of Error_Misconfigured indicates that the referenced Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack). |
- |
2.21 |
|
DADTransmits |
unsignedInt |
W |
The number of consecutive Neighbor Solicitation messages sent while performing Duplicate Address Detection on a tentative address (see[Section 5.1/RFC4862]). A value of zero indicates that Duplicate Address Detection is not performed on tentative addresses. A value of one indicates a single transmission with no follow-up retransmissions. If the value is greater than 1, RetransTimer defines the delay between consecutive messages. |
1 |
2.21 |
|
RetransTimer |
unsignedInt |
W |
Retransmission interval in milliseconds, as defined in [RFC4861]. For auto-configuration purposes, RetransTimer specifies the delay between consecutive Neighbor Solicitation transmissions performed during Duplicate Address Detection (DAD) [Section 5.4/RFC4862], as well as the time a node waits after sending the last Neighbor Solicitation before ending the DAD process. |
1000 |
2.21 |
|
BaseReachableTime |
unsignedInt |
W |
The base time in milliseconds for how long a neighbor is considered valid and reachable in the neighbor cache [Section 6.3/RFC4861]. |
30000 |
2.21 |
|
RtrSolicitationInterval |
unsignedInt |
W |
Retransmission interval in milliseconds, as defined in [Section 6.3.7/RFC4861]. For auto-configuration purposes, RtrSolicitationInterval specifies the delay between consecutive Router Solicitation transmissions. If MaxRtrSolicitationInterval is configured, this parameter serves as the initial retransmission time (IRT), where IRT is set to RTR_SOLICITATION_INTERVAL, for the backoff algorithm, as described in [RFC7559]. |
4000 |
2.21 |
|
MaxRtrSolicitationInterval |
unsignedInt(1:) |
W |
The maximum retransmission time (MRT) in milliseconds between consecutive Router Solicitation transmissions when the device implements a back-off algorithm, as defined in [RFC7559]. It is used together with RtrSolicitationInterval to control back-off behavior. |
600000 |
2.21 |
|
UnlimitedMaxRtrSolicitations |
boolean |
W |
If true, the number of Router Solicitation transmissions is unlimited, overriding MaxRtrSolicitations. This corresponds to setting MAX_RTR_SOLICITATIONS to infinity, as allowed by [RFC7559]. If false, MaxRtrSolicitations is used. |
false |
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, This 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 |
|
NUDEnable |
boolean |
W |
Enables or disables Neighbor Unreachability Detection (NUD) [Section 7/RFC4861]. |
true |
2.21 |
|
RSEnable |
boolean |
W |
Enables or disables Router Solicitation (RS) on Interface [Section 4.1/RFC4861]. |
true |
2.21 |
|
MaxRtrSolicitationDelay |
unsignedInt |
W |
The maximum delay in milliseconds before sending the first Router Solicitation message after the interface is brought up, as defined in [Section 6.3.7/RFC4861]. The actual delay is a random value between 0 and MaxRtrSolicitationDelay. This random delay desynchronizes clients which start at the same time (for example, after a power outage). A value of 0 indicates no delay. Note: The random delay is not needed if Duplicate Address Detection (DAD) has already introduced sufficient randomization. |
1000 |
2.21 |
|
MaxRtrSolicitationDuration |
unsignedInt |
W |
The maximum duration in milliseconds during which the client is permitted to retransmit Router Solicitation messages, as defined in [RFC7559]. This parameter corresponds to the Maximum Retransmit Duration (MRD). When MaxRtrSolicitationInterval is configured, this parameter works together with the backoff algorithm to control the total time spent soliciting routers. A value of 0 indicates that no specific maximum duration is set. This parameter is ignored if UnlimitedMaxRtrSolicitations is false and MaxRtrSolicitations is reached before the duration expires. |
0 |
2.21 |
|
Device.NeighborDiscovery.InterfaceSetting.{i}.ARP. |
object |
R |
Contains all parameters related to the Address Resolution Protocol (ARP) [RFC826] for this interface. |
- |
2.21 |
|
Enable |
boolean |
W |
Enables or disables ARP functionality for this specific interface. This parameter works in conjunction with Enable. If Enable is false, then ARP is considered disabled for this interface regardless of this parameter's value. |
true |
2.21 |
|
Status |
string |
R |
The status of this ARP. Enumeration of:
A value of Error_Misconfigured indicates that the referenced Interface is not a valid reference to an IPv4-capable interface. |
- |
2.21 |
|
BaseReachableTime |
unsignedInt |
W |
The base time in milliseconds for how long a dynamically learned entry in the ARP cache is considered valid and reachable. This corresponds to the ARP cache aging time discussed in [RFC1122]. |
60000 |
2.21 |
|
MaxRetries |
unsignedInt |
W |
The maximum number of ARP requests to send before considering an address unreachable, as discussed in [RFC1122]. |
3 |
2.21 |
|
RetryInterval |
unsignedInt |
W |
The interval in milliseconds between consecutive ARP requests, as discussed in [RFC1122]. |
1000 |
2.21 |
|
ProxyARPEnable |
boolean |
W |
Enables or disables Proxy ARP, as defined in [RFC1027], on this interface. |
false |
2.21 |
|
Device.QoS. |
object |
R |
Queue management configuration object. |
- |
2.0 |
|
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 CPE 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. 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.20:
|
- |
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 highest ordered entry that matches the classification criteria is applied. All lower order entries are ignored.}}processed in descending order of this parameter (higher values mean higher precedence). 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 |
|
StopProcessing |
boolean |
W |
When true, this indicates that the processing of the classification entries should stop and return. |
true |
2.21 |
|
IPLengthMax |
unsignedInt |
W |
Classification criterion. Maximum IP Packet Length (including header) in bytes. A value of zero indicates that no maximum is specified (an umlimitedunlimited maximum length). |
0 |
2.0 |
|
HardwareOffloadEnabled |
boolean |
W |
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 |
|
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 CPE using DHCP as well as hosts with statically allocated IP addresses. It can also include non-IP hosts. |
- |
2.0 |
|
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 |
|
ScheduleNumberOfEntries |
unsignedInt |
R |
This parameter was DEPRECATED in 2.18 in favor of Schedules.. This parameter was OBSOLETED in 2.20. This parameter was DELETED in 2.21. The number of entries in the Schedule table. Changes since 2.20:
|
- |
2.14 |
|
Device.Hosts.AccessControl.{i}.Schedule.{i}. |
object(0:) |
W |
This object was DEPRECATED in 2.18 in favor of Schedules.. This object was OBSOLETED in 2.20. This object was DELETED in 2.21. Each instance of this object provides a schedule where access is enabled. 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.20:
|
- |
2.14 |
|
Device.DNS. |
object |
R |
Properties for Domain Name Service (DNS). |
- |
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]. Changes since 2.20:
|
- |
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. Changes since 2.20:
|
- |
2.17 |
|
MaxRetries |
unsignedInt |
W |
Maximum number of retries per DNS server in case of non-response in a period of time defined by ResponseTimeout (not considering error responses). A value of 0 means no retries after a failure to respond to a request. |
5 |
2.21 |
|
ResponseTimeout |
unsignedInt |
W |
The timeout, in milliseconds, for a response from DNS servers. If set to 0, the timeout for DNS queries may be incremented over time (e.g., based on an implementation-specific policy such as exponential backoff). |
0 |
2.21 |
|
ForwardingMode |
string |
W |
The strategy mode applied for sending DNS queries considering the DNS server list provided by Forwarders. Enumeration of:
|
Optimal |
2.21 |
|
FailbackMinTimer |
unsignedInt |
W |
This parameter applies only when ForwardingMode is set to StrictOrder. In this case the entry in the Forwarders list is identified as the primary DNS server. The parameter FailbackMinTimer is the minimum value for the timer, in milliseconds, before reverting to the primary DNS server. If both FailbackMinTimer and FailbackMaxTimer are set to 0, then no failback is performed. |
0 |
2.21 |
|
FailbackMaxTimer |
unsignedInt |
W |
This parameter applies only when ForwardingMode is set to StrictOrder. In this case the entry in the Forwarders list is identify 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 |
|
Device.DNS.Relay.Stats. |
object |
R |
DNS statistics for this DNS proxy (or relay). |
- |
2.21 |
|
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.21 |
|
TotalQueries |
unsignedLong |
R |
[StatsCounter64] The total number of DNS queries received. |
- |
2.21 |
|
CacheHits |
unsignedLong |
R |
[StatsCounter64] The number of DNS queries that were successfully answered using the DNS cache, without contacting an external DNS server. |
- |
2.21 |
|
CacheMisses |
unsignedLong |
R |
[StatsCounter64] The number of DNS queries that could not be answered using the DNS cache and thus required contacting an external DNS server. |
- |
2.21 |
|
RecursiveReplies |
unsignedLong |
R |
[StatsCounter64] The total number of replies received from recursive DNS queries, where the relay queried other DNS servers to resolve the query. |
- |
2.21 |
|
RequestListAvg |
unsignedLong |
R |
[StatsCounter64] The average number of requests being processed in the relay's request list at any given time. |
- |
2.21 |
|
RequestListMax |
unsignedLong |
R |
[StatsCounter64] The maximum number of requests that were ever in the request list at once. |
- |
2.21 |
|
RequestListOverwritten |
unsignedLong |
R |
[StatsCounter64] The number of times an entry in the request list was overwritten before it could be processed. |
- |
2.21 |
|
RequestListExceeded |
unsignedLong |
R |
[StatsCounter64] The number of times the request list capacity was exceeded, and additional requests were dropped. |
- |
2.21 |
|
RequestListCurrentAll |
unsignedLong |
R |
[StatsCounter64] The current number of requests in the relay's request list. |
- |
2.21 |
|
RequestListCurrentUser |
unsignedLong |
R |
[StatsCounter64] The current number of outstanding DNS requests in the relay's request list that originated from LAN/client-facing interfaces (i.e., requests received from subscriber devices), excluding requests initiated internally by the DNS relay/resolver itself (e.g., cache prefetch/refresh, health checks, or other maintenance queries generated by the platform). |
- |
2.21 |
|
QueryTypeA |
unsignedLong |
R |
[StatsCounter64] The number of DNS queries requesting an A record (IPv4 address). |
- |
2.21 |
|
QueryTypePTR |
unsignedLong |
R |
[StatsCounter64] The number of DNS queries requesting a PTR record (Pointer, typically used for reverse DNS lookups). |
- |
2.21 |
|
QueryTypeTXT |
unsignedLong |
R |
[StatsCounter64] The number of DNS queries requesting a TXT record (text information). |
- |
2.21 |
|
QueryTypeAAAA |
unsignedLong |
R |
[StatsCounter64] The number of DNS queries requesting an AAAA record (IPv6 address). |
- |
2.21 |
|
QueryTypeSRV |
unsignedLong |
R |
[StatsCounter64] The number of DNS queries requesting an SRV record (service location). |
- |
2.21 |
|
QueryTypeANY |
unsignedLong |
R |
[StatsCounter64] The number of DNS queries requesting any type of record. |
- |
2.21 |
|
QueryClassIN |
unsignedLong |
R |
[StatsCounter64] The number of DNS queries in the IN (Internet) class. |
- |
2.21 |
|
OpcodeQUERY |
unsignedLong |
R |
[StatsCounter64] The number of standard DNS queries (opcode QUERY). |
- |
2.21 |
|
QueryTCP |
unsignedLong |
R |
[StatsCounter64] The number of DNS queries received over TCP. |
- |
2.21 |
|
QueryIPv6 |
unsignedLong |
R |
[StatsCounter64] The number of DNS queries received over IPv6. |
- |
2.21 |
|
QueryFlagsQR |
unsignedLong |
R |
[StatsCounter64] The number of DNS queries with the QR (Query/Response) flag set, indicating a response. |
- |
2.21 |
|
QueryFlagsAA |
unsignedLong |
R |
[StatsCounter64] The number of DNS queries with the AA (Authoritative Answer) flag set, indicating the response is authoritative. |
- |
2.21 |
|
QueryFlagsTC |
unsignedLong |
R |
[StatsCounter64] The number of DNS queries with the TC (Truncated) flag set, indicating the response is truncated and the client should retry over TCP. |
- |
2.21 |
|
QueryFlagsRD |
unsignedLong |
R |
[StatsCounter64] The number of DNS queries with the RD (Recursion Desired) flag set, requesting recursive resolution. |
- |
2.21 |
|
QueryFlagsRA |
unsignedLong |
R |
[StatsCounter64] The number of DNS queries with the RA (Recursion Available) flag set, indicating the server supports recursive queries. |
- |
2.21 |
|
QueryFlagsAD |
unsignedLong |
R |
[StatsCounter64] The number of DNS queries with the AD (Authenticated Data) flag set, indicating the data has been authenticated. |
- |
2.21 |
|
QueryFlagsCD |
unsignedLong |
R |
[StatsCounter64] The number of DNS queries with the CD (Checking Disabled) flag set, indicating the client does not want DNSSEC validation. |
- |
2.21 |
|
QueryEDNSPresent |
unsignedLong |
R |
[StatsCounter64] The number of DNS queries using EDNS (Extension Mechanisms for DNS). |
- |
2.21 |
|
AnswerRCodeNOERROR |
unsignedLong |
R |
[StatsCounter64] The number of DNS responses with the NOERROR response code, indicating no error. |
- |
2.21 |
|
AnswerRCodeSERVFAIL |
unsignedLong |
R |
[StatsCounter64] The number of DNS responses with the SERVFAIL response code, indicating a server failure. |
- |
2.21 |
|
AnswerRCodeNXDOMAIN |
unsignedLong |
R |
[StatsCounter64] The number of DNS responses with the NXDOMAIN response code, indicating the domain name does not exist. |
- |
2.21 |
|
AnswerRCodeNoData |
unsignedLong |
R |
[StatsCounter64] The number of DNS responses with the NOERROR response code, but also no data. |
- |
2.21 |
|
UnwantedQueries |
unsignedLong |
R |
[StatsCounter64] The number of DNS queries that were unwanted or unsolicited. |
- |
2.21 |
|
UnwantedReplies |
unsignedLong |
R |
[StatsCounter64] The number of DNS replies that were unwanted or unsolicited. |
- |
2.21 |
|
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 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.RebindProtection. |
object |
R |
The DNS Rebind Protection object contains parameters to enable or disable protection against DNS rebind attacks. It prevents DNS-based malicious software that tries to bypass the browser’sbrowser's policies, by filtering or refusing DNS answers that point to private or local IP addresses, it stops external sites from reaching LAN devices. |
- |
2.20 |
|
Device.NAT. |
object |
R |
Properties for Network Address Translation (NAT). TheThis entireincludes {{object}}settings objectfor onlyIPv4 appliesNAT towithin IPv4.}}this object, and for IPv6-to-IPv6 Network Prefix Translation (NPTv6). Changes since 2.20:
|
- |
2.0 |
|
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 |
|
InterfaceSettingNumberOfEntries |
unsignedInt |
R |
The number of entries in the InterfaceSetting table. |
- |
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 |
|
Enable |
boolean |
W |
Enables or disables the InterfaceSetting entry, indicating if NPTv6 is enabled for the referenced IP Interface instance. On creation, an InterfaceSetting entry is disabled by default. |
false |
2.21 |
|
Status |
string |
R |
The status of this InterfaceSetting instance. The status of this entry. Enumeration of:
|
- |
2.21 |
|
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.21 |
|
Interface |
string |
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. The associated egress IP interface on which NPTv6 is to be enabled. |
- |
2.21 |
|
ExternalPrefix |
string(:49) |
W |
[IPv6Prefix] The IPv6 prefix to be used as the external prefix. This is the prefix that is translated to the InternalPrefix and MUST refer to a prefix that is part of the Interface IP Interface instance. An empty string is not allowed. |
- |
2.21 |
|
InternalPrefix |
string(:49) |
W |
[IPv6Prefix] The IPv6 prefix to be used as the internal prefix. This is the prefix that the ExternalPrefix is translated to. An empty string is not allowed. |
- |
2.21 |
|
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 CPE 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 CPE 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 CPE 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 |
|
Device.DHCPv4.Client.{i}.Retransmission. |
object |
R |
This object enables the configurionconfiguration of the DHCPv4 retransmission behavior according to the guidelines described in [Chapter 4.1/RFC2131]. |
- |
2.18 |
|
DiscoverInitialTimeout |
unsignedInt |
W |
Initial delay, expressed in seconds, before initiating the first DCHCPDISCOVERDHCPDISCOVER message. |
4 |
2.18 |
|
Device.DHCPv4.Client.{i}.Stats. |
object |
R |
Provide statistisstatistics for the embedded DHCP Client. |
- |
2.19 |
|
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 CPE 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 |
|
Device.DHCPv4.Server.Pool.{i}.StaticAddress.{i}. |
object(0:) |
W |
DHCP static address table. Entries in this table correspond to what [RFC2131] calls "manual allocation", where a client's IP address is assigned by the network administrator, and DHCP is used simply to convey the assigned address to the client. Each instance of this object specifies a hardware address (MAC address) and an IP address within the pool.pool's subnet. When serving from this pool, this IP address MUST, if available, be assigned to the DHCP client with this hardware address, and MUST NOT be assigned to any other client. Note that it is possible that an IP address in this table is present in one or more of the other conditional serving pools, in which case it is possible that such an address will be assigned to a different client. For enabled table entries, if the entry is inoperable due to a configuration error (such as Yiaddr being outside the pool's subnet) or a runtime conflict (such as a duplicate address), the device MUST set Status to the appropriate error state. See the Status parameter's enumeration for details on all possible states. 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 Chaddr. Changes since 2.20:
|
- |
2.0 |
|
Status |
string |
R |
Operational status of this StaticAddress entry. Enumeration of:
|
- |
2.21 |
|
Device.DHCPv4.Server.Pool.{i}.Option.{i}. |
object(0:) |
W |
This object specifies the DHCP options that MUST,that, if enabled, can be returned to clients whose DHCP requests are associated with this pool.}} The Force parameter determines if 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. Changes since 2.20:
|
- |
2.0 |
|
Force |
boolean |
W |
When set to true, the DHCP server will include this option in a DHCP offer, regardless of whether the client requested it in the Parameter Request List (DHCP Option 55). This can be used to ensure that clients receive certain options, even if not explicitly requested. |
true |
2.21 |
|
Device.DHCPv6. |
object |
R |
The Dynamic Host Configuration Protocol (DHCP) IPv6 object [RFC8415]. 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 CPE 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 CPE 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 CPE 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.20:
|
- |
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/RFC8415]. 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 |
|
Device.DHCPv6.Client.{i}.Retransmission. |
object |
R |
This object enables the configurionconfiguration of the DHCPv6 retransmission behavior according to the guidelines described in [Section 7.6/RFC8415]. |
- |
2.18 |
|
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 CPE 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 |
|
Device.DHCPv6.Server.Pool.{i}.Option.{i}. |
object(0:) |
W |
This object specifies the DHCPv6 options that MUST,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. Changes since 2.20:
|
- |
2.2 |
|
Force |
boolean |
W |
When set to true, the DHCP server will include this option in a DHCP offer, regardless of whether the client requested it in the Option Request Option (DHCP Option 6). This can be used to ensure that clients receive certain options, even if not explicitly requested. |
true |
2.21 |
|
Device.Users. |
object |
R |
Users object that contains the User, Group, and Role tables. |
- |
2.0 |
|
Device.Users.User.{i}. |
object(0:) |
W |
This object contains parameters relating to the user characteristics. 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 Username, or with a given value for UserID. Changes since 2.20:
|
- |
2.0 |
|
HomeDirectory |
string(:2048) |
W |
[FileURI] The user's home directory. This parameter MUST contain the path to the user's home directory, specified according to [RFC8089]. For example, '<file:///home/user>'. |
- |
2.21 |
|
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.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 CPE 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 CPE 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 |
|
SpecVersion |
string(:256) |
R |
The UPnP Device Architecture version extracted from the specVersion element in the Device Description Document of the discovered root device. The SpecVersion is encoded as "major revison.minorrevision.minor revision". Possible patterns:
|
- |
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 |
|
EventSubURL |
string(:2048) |
R |
The value of the UPnP eventSubURL element in the Device Description Document for this ServiceInstance and MUST be an absolute [URL]. The way to obtain an absolute URL from the eventSubURLLeventSubURL element is specified in [UPnP-DAv1] and [UPnP-DAv11]. If the eventSubURL is not provided by the device then this value MUST be an empty string |
- |
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. |
- |
2.0 |
|
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. 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 CPE 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 |
|
DSCPExclude |
boolean |
W |
If false, the rule matches only those packets that match the DSCP entry, if specified. If true, the rule matchessmatches all packets except those that match the DSCP entry, if specified. This parameter can only be modified if the Rule is Static (as explained in the object description). |
false |
2.2 |
|
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 |
|
RetryMaximumWaitInterval |
unsignedInt(1:4294967295) |
W |
Configures the data transfer retry maximum wait interval, in seconds. If the calculated interval is higher than the specifedspecified RetryMaximumWaitInterval value then RetryMaximumWaitInterval value should be used. |
4294967295 |
2.20 |
|
Device.Security. |
object |
R |
This object contains general information related to managing security features on the device. |
- |
2.4 |
|
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. |
- |
2.4 |
|
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.21 |
|
Name |
string(:64) |
R |
User-defined name to identify and categorize the certificate (e.g., "mqtt-broker", "webserver", "vpn-client"). The implementation MAY use this name to determine which secure storage to use and how to persist the key. |
- |
2.21 |
|
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 |
|
Device.FAP.GPS.ContinuousGPSStatus. |
object |
R |
When ContinuousGPS is true, the parameters in this object contain the GPS status as it is continuously monitored. When ContinuousGPS is false, the parameters in this object are not being updated and their values are not accurate. |
- |
2.4 |
|
LastFixTime |
dateTime |
R |
Represents the date and time when the last GPS Fix was acquired. The Unknown Time value defined in [Section 3.2/TR-106] is used when GotFix is false. This applies too after a reboot of the device until a valid location is determined and GotFix transsitionstransitions to true. Active Notification requests for this parameter MAY be denied. |
- |
2.4 |
|
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. Changes since 2.20:
|
- |
2.1 |
|
Device.SoftwareModules.ExecEnv.{i}. |
object(0:) |
R |
The Execution Environments that are available on the device, along with their properties and configurable settings. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.1 |
|
AllocatedDiskSpace |
int(-1:) |
R |
The amount of diskpersistent spacephysical storage measured in KiB allocated to this ExecEnv.Execution Environment. This constraint applies to persistent physical storage used by the Execution Environment and its child Deployment Units and Execution Units. The accounting of in-memory application data volumes is excluded.A value of -1 indicates that this parameter is not applicable.}}applicable (i.e., no persistent physical storage constraint is enforced for this ExecEnv). The default value SHOULD be -1. |
- |
2.1 |
|
AllocatedMemory |
int(-1:) |
R |
The amount of physical RAM measured in KiB allocated to this ExecEnv.Execution Environment. The accounting of application data volumes stored in persistent physical storage is excluded.A value of -1 indicates that this parameter is not applicable. The default value SHOULD be -1. |
- |
2.1 |
|
AvailableDiskSpace |
int(-1:) |
R |
The amount of diskpersistent spacephysical storage measured in KiB currently available to this ExecEnv. This value changes as the ExecutionUnit instances associated with this ExecEnv consumes diskphysical storage space. A value of -1 MUST be used for ExecEnv instances where this parameter is not applicable. Active Notification requests for this parameter MAY be denied. |
- |
2.1 |
|
ProcessorRefList |
string[] |
R |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.Processor. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the processors that this ExecEnv has available to it. This parameter was DEPRECATED in 2.18 because the referenced object,DeviceInfo.Processor., is deprecated. {{obsoleted|2.20}}}}This parameter was DELETED in 2.21. Changes since 2.20:
|
- |
2.1 |
|
Device.SoftwareModules.ExecEnv.{i}.ApplicationData.{i}. |
object(0:) |
R |
The ApplicationDataapplication data volumes which currently exist within this ExecEnv.}}Execution Environment. At most one entry in this table can exist with a given value for Alias, or with the same values for both ApplicationUUID and Name. |
- |
2.16 |
|
Name |
string(:64) |
R |
A name which is assigned to the ApplicationDataapplication data instance at the time of its creation, which distinguishes it from any other application data volumes owned by the same application. |
- |
2.16 |
|
Retain |
string |
R |
The level of persistencypersistence offor the volume.}}application data volume and its content. Enumeration of:
|
- |
2.16 |
|
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. |
- |
2.1 |
|
AllocatedDiskSpace |
int(-1:) |
R |
The amount of diskpersistent spacephysical storage measured in KiB allocated to this {{object}}.Execution Environment. This constraint applies to persistent physical storage used by the Execution Environment and its child Deployment Units and Execution Units. The accounting of in-memory application data volumes is excluded.A value of -1 MUSTindicates be used for {{object}} instances wherethat this parameter is not applicable.}}applicable (i.e., no persistent physical storage constraint is enforced for this ExecutionUnit). |
- |
2.16 |
|
DiskSpaceInUse |
int(-1:) |
R |
The amount of diskpersistent spacephysical storage measured in KiB currently being used by this ExecutionUnit. A value of -1 MUST be used for ExecutionUnit instances where this parameter is not applicable. Active Notification requests for this parameter MAY be denied. |
- |
2.1 |
|
CPUPercentInUse |
int(-1:100) |
R |
The CPU power currently being used by this by this ExecutionUnit, as a fraction (in %) of the CPU allocation of the ExecEnv in which this ExecutionUnit resides. A value of -1 MUST be used for ExecutionUnit instances where this parameter is not applicable. |
- |
2.16 |
|
Device.SoftwareModules.LocalManagement. |
object |
R |
This object records actions on SoftwareModules that are managed locally by the device. Locally managed actions are defined and executed by the device firmware, typically during system upgrade or factory reset procedures. These local actions are performed prior to the device accepting any remote action requests on Device.SoftwareModules. As such, they are designed to avoid interference or conflict with remote management operations. After the device firmware has completed its boot process following an upgrade or factory reset, no further locally managed actions are performed by the device. |
- |
2.21 |
|
SystemName |
string(:64) |
R |
A descriptive name for this LocalManagement, providing information about the local management system used by the device. This parameter is for informational purposes only. |
- |
2.21 |
|
ActionNumberOfEntries |
unsignedInt |
R |
The number of entries in the Action table. |
- |
2.21 |
|
Device.SoftwareModules.LocalManagement.Action.{i}. |
object(0:) |
R |
This table lists actions processed by the local management system. Each entry represents either a valid action that was recognized and executed by the local management system, or an unknown action resulting from issues such as invalid or corrupted local management configuration at the firmware level. This table facilitates tracking and diagnosis of problems that may affect the execution of locally managed actions on the device. At most one entry in this table can exist with a given value for Alias. |
- |
2.21 |
|
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.21 |
|
Action |
string |
R |
Indicates the type of action performed by the local management system. If the system fails to identify a valid action (i.e., the action or its required information is missing or invalid), the value "Invalid" is used. Supported actions are the same as those defined for a Deployment Unit. Enumeration of:
|
- |
2.21 |
|
UUID |
string(:36) |
R |
The unique identifier of the DeploymentUnit.{i} targeted by the action, corresponding to DeploymentUnit.{i}.UUID. The value is set to an empty string if the Action is Invalid and the system is unable to retrieve the UUID value from the configuration. Note: The referenced DeploymentUnit.{i} may no longer be present on the system if the action was Uninstall. |
- |
2.21 |
|
ExecEnvName |
string(:256) |
R |
The name of the execution environment (ExecEnv.{i}.Name) on which the action was performed. The value is set to an empty string if the Action is Invalid and the system is unable to retrieve the ExecEnvName value from the configuration. Note: The referenced ExecEnv.{i} may no longer be present on the system if the action was Uninstall. |
- |
2.21 |
|
PreviousModuleVersion |
string(:32) |
R |
The version of the DeploymentUnit.{i} on which the action was performed. The value is set to an empty string if the Action is Invalid and the system is unable to retrieve the PreviousModuleVersion value from the configuration. Note: The referenced DeploymentUnit.{i} may no longer be present on the system if the action was Uninstall. |
- |
2.21 |
|
CurrentModuleVersion |
string(:32) |
R |
The new version of the DeploymentUnit.{i} after an Update action. The value is set to an empty string if the Action is Invalid and the system is unable to retrieve the CurrentModuleVersion value from the configuration. This parameter MUST be an empty string if the Action is Uninstall. |
- |
2.21 |
|
Status |
string |
R |
Indicates the current status of the specified Action. Enumeration of:
|
- |
2.21 |
|
FaultMessage |
string(:256) |
R |
A human-readable, detailed description of the fault detected by the local management system. This parameter provides additional information to assist in understanding and diagnosing the reported fault. |
- |
2.21 |
|
Device.SoftwareModules.Config. |
object |
R |
This object contains configuration related to Software Modules. |
- |
2.21 |
|
RepositoryNumberOfEntries |
unsignedInt |
R |
The number of entries in the Repository table. |
- |
2.21 |
|
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. This is a global setting that can be overridden by specifying the Repository.{i}.Certificate parameter in a repository entry. |
- |
2.21 |
|
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. This is a global setting that can be overridden by specifying the Repository.{i}.CABundle parameter in a repository entry. |
- |
2.21 |
|
SupportedDUSignatureProtocols |
string[] |
R |
Comma-separated list of strings. Specifies the protocols that the device is capable of using to retrieve Deployment Unit signatures. Each list item is an enumeration of:
|
- |
2.21 |
|
DUSignatureProtocols |
string[] |
W |
Comma-separated list of strings. Each list item MUST be a member of the list reported by the SupportedDUSignatureProtocols parameter. This indicates the protocols the device is configured to allow for fetching Deployment Unit signatures from a remote server. The default value SHOULD be [HTTPS]. |
- |
2.21 |
|
Device.SoftwareModules.Config.Repository.{i}. |
object(0:) |
W |
This table contains information about a dedicated configuration for a repository, overriding the the default configuration. 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.21 |
|
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.21 |
|
Enable |
boolean |
W |
Enables or disables this repository entry. |
- |
2.21 |
|
Name |
string(:256) |
R |
The name of the repository. |
- |
2.21 |
|
BaseURL |
string(:2048) |
W |
[URL] Specifies the base URL or server address of the repository. When processing an InstallDU or Update request, the system will attempt to match this BaseURL against the schema (protocol), hostname, and port components of the requested URL (for a Deployment Unit or its signature). The matching process proceeds from most specific to least specific:
Example:
This parameter MUST be a valid URL as defined by the [RFC3986] and MUST NOT include the "userinfo" component. |
- |
2.21 |
|
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. This parameter overrides the global Certificate setting. |
<Empty> |
2.21 |
|
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. This parameter overrides the global CABundle setting. |
<Empty> |
2.21 |
|
Type |
string |
W |
Indicates the type of the repository entry. Enumeration of:
|
- |
2.21 |
|
Device.IEEE1905. |
object |
R |
This object represents the management functions for the 1905 capabilities as defined in [IEEE1905.1a]. Changes since 2.20:
|
- |
2.9 |
|
Version |
string |
R |
The 1905 profile version number of the AL as would be sent in a Higher Layer response message as defined in [Table 6-37: 1905 profile version TLV/IEEE1905.1a]. Enumeration of:
|
- |
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 |
|
RegistrarFreqBand |
string[] |
R |
Comma-separated list of strings. See [Table 6-25: SupportedFreqBand TLV/IEEE1905.1a]. Each list item is an enumeration of:
|
- |
2.9 |
|
Device.IEEE1905.AL.Interface.{i}. |
object(0:) |
R |
The 1905 interface table (described in [Sub-clause 5 Abstraction Layer Management/IEEE1905.1a]). At most one entry in this table can exist with a given value for InterfaceId. |
- |
2.9 |
|
Device.IEEE1905.AL.Interface.{i}.Link.{i}. |
object(0:) |
R |
This object defines the 1905 neighbors and link properties. At most one entry in this table can exist with the same values for both InterfaceId and IEEE1905Id. |
- |
2.9 |
|
Device.IEEE1905.AL.Interface.{i}.Link.{i}.Metric. |
object |
R |
This object represents the metrics for this Link as defined in [Tables 6-18: 1905 transmitter link metrics and Table 6-20: 1905 receiver link metrics/IEEE1905.1a]. |
- |
2.9 |
|
MACThroughputCapacity |
unsignedInt |
R |
The maximum MAC throughput in Mbps between this Interface and the Neighbor on this Link that is estimated at this Interface. Active Notification requests for this parameter MAY be denied. Changes since 2.20:
|
- |
2.9 |
|
PHYRate |
unsignedInt |
R |
The Physical Layer (PHY) rate in Mbps between this Interface and the Neighbor on this Link that is estimated at this Interface. Active Notification requests for this parameter MAY be denied. Changes since 2.20:
|
- |
2.9 |
|
Device.IEEE1905.AL.NetworkTopology. |
object |
R |
This object represents the 1905 Network Topology capabilities of this device. |
- |
2.9 |
|
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}. |
object(0:) |
R |
This object represents an instance of discovered 1905 Devices in the network (received Topology discovery message as defined in [Clause 6.3.1/IEEE1905.1a]). At most one entry in this table can exist with a given value for IEEE1905Id. |
- |
2.9 |
|
RegistrarFreqBand |
string[] |
R |
Comma-separated list of strings. of frequency bands identified as supported for a registrar role in an AP-autoconfiguration response message as defined in [Table 6-25: SupportedFreqBand TLV/IEEE1905.1a] Each list item is an enumeration of:
|
- |
2.9 |
|
ControlURL |
string(:2048) |
R |
Control [URL] received in Higher Layer response message as defined in defined in [Table 6-31: Control URL Type TLV/IEEE1905.1a]. |
- |
2.9 |
|
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.IPv4Address.{i}. |
object(0:) |
R |
This object represents represents all IPv4 addresses reported for a MAC address (AL or interface) in a Higher Layer response message for the IEEE1905Device as defined in [Table 6-32: IPv4 type TLV/IEEE1905.1a]. At most one entry in this table can exist with the same values for both MACAddress and IPv4Address. |
- |
2.9 |
|
DHCPServer |
string(:45) |
R |
[IPAddress] Either IPv4 address of DHCPv4 server or IPv6 address of DHCPv6 server.}}server |
- |
2.9 |
|
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.IPv6Address.{i}. |
object(0:) |
R |
This object represents represents all IPv6 addresses reported for a MAC address (AL or interface) in a Higher Layer response message for the IEEE1905Device as defined in [Table 6-34: IPv6 type TLV/IEEE1905.1a]. At most one entry in this table can exist with the same values for both MACAddress and IPv6Address. |
- |
2.9 |
|
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.VendorProperties.{i}. |
object(0:) |
R |
This object represents vendor specific information received in a message with a Vendor specific TLV (as defined in in [Table 6-7: Vendor specific TLV/IEEE1905.1a]). |
- |
2.9 |
|
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.L2Neighbor.{i}. |
object(0:) |
R |
This object represents an instance of an L2 Neighbor for the IEEE1905Device. These fields come from a Topology response message as defined in [Table 6-41: L2 neighbor device TLV/IEEE1905.1a]. At most one entry in this table can exist with the same values for both LocalInterface and NeighborInterfaceId. |
- |
2.9 |
|
BehindInterfaceIds |
string(:17)[] |
R |
[MACAddress] Comma-separated list of MAC Addresses. Behind MAC Addresses of the L2Neighbor. |
- |
2.9 |
|
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.IEEE1905Neighbor.{i}. |
object(0:) |
R |
This object represents an instance of an IEEE1905Neighbor for the IEEE1905Device. These values are from the Topology response message as defined in [Table 6-15: 1905 neighbor device TLV/IEEE1905.1a]. At most one entry in this table can exist with the same values for both LocalInterface and NeighborDeviceId. |
- |
2.9 |
|
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.IEEE1905Neighbor.{i}.Metric.{i}. |
object(0:) |
R |
This object represents the metrics included in a Link metric response from the IEEE1905Device where LocalInterface is the MAC address of an interface in the receiving 1905 AL as defined in [Table 6-17: 1905 transmitter link metric TLV/IEEE1905.1a]. At most one entry in this table can exist with a given value for NeighborMACAddress. |
- |
2.9 |
|
MACThroughputCapacity |
unsignedInt |
R |
The maximum MAC throughput in Mbps between this Interface and the Neighbor on this link that is estimated at this Interface. Changes since 2.20:
|
- |
2.9 |
|
PHYRate |
unsignedInt |
R |
The Physical Layer (PHY) rate in Mbps between this Interface and the Neighbor on this link that is estimated at this Interface. Changes since 2.20:
|
- |
2.9 |
|
Device.IEEE1905.AL.Security. |
object |
R |
This object represents the Security configuration for the 1905 device as defined in [Section 9.2 Security Setup Methods/IEEE1905.1a]. |
- |
2.9 |
|
SetupMethod |
string[] |
W |
Comma-separated list of strings. Supported security setup method(s) for the network. Each list item is an enumeration of:
|
- |
2.9 |
|
Device.IEEE1905.AL.NetworkingRegistrar. |
object |
R |
This object represents the detected Network Registrars detection function for the IEEE 1905 network. They are determined by received AP-autoconfiguration response messages with Registrar role, with supported band as defined in [Table 6-25: SupportedFreqBand TLV/IEEE1905.1a] Changes since 2.20:
|
- |
2.9 |
|
Registrar2dot4 |
string(:17)[] |
R |
[MACAddress] Comma-separated list of MAC Addresses. 1905 AL MAC addresses as determined by source MAC address in received AP-autoconfiguration response messages with supported frequency band of 802.11 2.4 GHz. |
- |
2.9 |
|
Registrar5 |
string(:17)[] |
R |
[MACAddress] Comma-separated list of MAC Addresses. 1905 AL MAC addresses as determined by source MAC address in received AP-autoconfiguration response messages with supported frequency band of 802.11 5 GHz. |
- |
2.9 |
|
Registrar6 |
string(:17)[] |
R |
[MACAddress] Comma-separated list of MAC Addresses. 1905 AL MAC addresses as determined by source MAC address in received AP-autoconfiguration response messages with supported frequency band of 802.11 6 GHz. |
- |
2.21 |
|
Registrar60 |
string(:17)[] |
R |
[MACAddress] Comma-separated list of MAC Addresses. 1905 AL MAC addresses as determined by source MAC address in received AP-autoconfiguration response messages with supported frequency band of 802.11 60 GHz. |
- |
2.9 |
|
Device.IEEE1905.Network. |
object |
R |
This object represents the Network Topology of the multi-hop mixed media IEEE 1905.1a data model. Device.IEEE1905.AL.NetworkTopology. provides the network topology view up to two hops from the perspective of this IEEE 1905 node. To obtain multi-hop topology information beyond two hops, network topology data from each device needs to be fetched individually. This object provides a consolidated, multi-hop, and hierarchical representation of the complete IEEE 1905 network topology, as viewed from the local device, encompassing all IEEE 1905 devices within the network. If this object is implemented in the 1905 data model, it is expected to use this object instead of Device.IEEE1905.AL.NetworkTopology.. |
- |
2.21 |
|
Enable |
boolean |
W |
Enables or disables the 1905 Network Topology reporting (via a Controller). |
- |
2.21 |
|
Status |
string |
R |
When Enable is set to true, this parameter indicates the transient phase of the discovery of the Network. Enumeration of:
|
- |
2.21 |
|
ALNumberOfEntries |
unsignedInt |
R |
The number of entries in the AL table. |
- |
2.21 |
|
Device.IEEE1905.Network.AL.{i}. |
object(0:) |
R |
Each entry in this table represents the management functions for the 1905 Abstraction Layer as defined in [Section 4.4 Abstraction Layer/IEEE1905.1a] of a 1905 device discovered in the network (received Topology discovery message as defined in [Clause 6.3.1/IEEE1905.1a]). At most one entry in this table can exist with a given value for IEEE1905Id. |
- |
2.21 |
|
IEEE1905Id |
string(:17) |
R |
[MACAddress] The 1905 AL MAC Address. |
- |
2.21 |
|
Version |
string |
R |
The 1905 profile version number from Higher Layer Response message, as defined in [Table 6-37: 1905 profile version TLV/IEEE1905.1a]. Enumeration of:
|
- |
2.21 |
|
RegistrarFreqBand |
string[] |
R |
Comma-separated list of strings. of frequency bands identified as supported for a registrar role in an AP-autoconfiguration response message as defined in [Table 6-25: SupportedFreqBand TLV/IEEE1905.1a] Each list item is an enumeration of:
|
- |
2.21 |
|
FriendlyName |
string(:64) |
R |
Friendly Name String received in Higher Layer response message as defined in [Table 6-30: Device Identification Type TLV/IEEE1905.1a]. |
- |
2.21 |
|
ManufacturerName |
string(:64) |
R |
Manufacturer Name String received in Higher Layer response message as defined in [Table 6-30: Device Identification Type TLV/IEEE1905.1a]. |
- |
2.21 |
|
ManufacturerModel |
string(:64) |
R |
Manufacturer Model String received in Higher Layer response message as defined in [Table 6-30: Device Identification Type TLV/IEEE1905.1a]. |
- |
2.21 |
|
ControlURL |
string(:2048) |
R |
Control [URL] received in Higher Layer response message as defined in [Table 6-31: Control URL Type TLV/IEEE1905.1a]. |
- |
2.21 |
|
AssocWiFiNetworkDeviceRef |
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. This parameter is a reference to a Wi-Fi Network Data Elements Device. Since IEEE 1905.1 is the protocol used by the Wi-Fi Alliance's EasyMesh specification for communications, this parameter allows the IEEE 1905.1 portion of the data model to reference the associated EasyMesh portion of the data model. The value of the ID parameter in the referenced object MUST match the value of the IEEE1905Id parameter in this object. |
- |
2.21 |
|
IPv4AddressNumberOfEntries |
unsignedInt |
R |
The number of entries in the IPv4Address table. |
- |
2.21 |
|
IPv6AddressNumberOfEntries |
unsignedInt |
R |
The number of entries in the IPv6Address table. |
- |
2.21 |
|
InterfaceNumberOfEntries |
unsignedInt |
R |
The number of entries in the Interface table. |
- |
2.21 |
|
BridgingTupleNumberOfEntries |
unsignedInt |
R |
The number of entries in the BridgingTuple table. |
- |
2.21 |
|
Device.IEEE1905.Network.AL.{i}.IPv4Address.{i}. |
object(0:) |
R |
This object represents all IPv4 addresses reported for a MAC address (AL or interface) in a Higher Layer response message for the IEEE1905Device as defined in [Table 6-32: IPv4 type TLV/IEEE1905.1a]. At most one entry in this table can exist with the same values for both MACAddress and IPv4Address. |
- |
2.21 |
|
MACAddress |
string(:17) |
R |
[MACAddress] MAC Address. |
- |
2.21 |
|
IPv4Address |
string(:45) |
R |
[IPv4Address] IPv4 Address. |
- |
2.21 |
|
IPv4AddressType |
string |
R |
The IPv4 Address Type of this IPv4Address. Enumeration of:
|
- |
2.21 |
|
DHCPServer |
string(:45) |
R |
[IPAddress] IP address of DHCP Server |
- |
2.21 |
|
Device.IEEE1905.Network.AL.{i}.IPv6Address.{i}. |
object(0:) |
R |
This object represents all IPv6 addresses reported for a MAC address (AL or interface) in a Higher Layer response message for the IEEE1905Device as defined in [Table 6-34: IPv6 type TLV/IEEE1905.1a]. At most one entry in this table can exist with the same values for both MACAddress and IPv6Address. |
- |
2.21 |
|
MACAddress |
string(:17) |
R |
[MACAddress] MAC Address. |
- |
2.21 |
|
IPv6Address |
string(:45) |
R |
[IPv6Address] IPv6 Address. |
- |
2.21 |
|
IPv6AddressType |
string |
R |
The IPv6 Address Type of this IPv6Address. Enumeration of:
|
- |
2.21 |
|
IPv6AddressOrigin |
string(:45) |
R |
[IPv6Address] The IPv6 address of the origin of this IPv6 address or "::" if the origin is unknown. |
- |
2.21 |
|
Device.IEEE1905.Network.AL.{i}.Interface.{i}. |
object(0:) |
R |
This object represents an instance of an interface for the IEEE1905Device. At most one entry in this table can exist with a given value for InterfaceId. |
- |
2.21 |
|
InterfaceId |
string(:17) |
R |
[MACAddress] MAC Address of the interface. This comes from the Topology response message as defined in [Table 6-10: 1905 device information type TLV/IEEE1905.1a]. |
- |
2.21 |
|
MediaType |
string |
R |
Media type of this Interface. This comes from the Topology response message as defined in [Table 6-10: 1905 device information type TLV/IEEE1905.1a]. Enumeration of:
|
- |
2.21 |
|
PowerState |
string |
R |
The Power State of this Interface. Off is used for interfaces identified in a Power Off Interface TLV as defined in [Table 6-38/IEEE1905.1a]. On is used for all other interfaces. PowerSave and Unsupported are not used at this time. Updated as a result of a received Interface Power Change response with values as 'request completed' or 'alternate change made' in Interface Power Change status parameter as defined in [Table 6-40: Interface Power Change status TLV/IEEE1905.1a]. Enumeration of:
|
- |
2.21 |
|
NetworkMembership |
string(:17) |
R |
[MACAddress] MACAddress Field from Media specific information for an 802.11 interface provided in a Topology response message 1905 device information type TLV as defined in [Table 6-13: IEEE 802.11 specific information/IEEE1905.1a]. |
- |
2.21 |
|
Role |
string |
R |
Field from Media specific information for an 802.11 interface provided in a Topology response message 1905 device information type TLV as defined in [Table 6-13: IEEE 802.11 specific information/IEEE1905.1a]. Enumeration of:
|
- |
2.21 |
|
APChannelBand |
hexBinary(1) |
R |
Hexadecimal digit. Field from Media specific information for an 802.11 interface provided in a Topology response message 1905 device information type TLV as defined in [Table 6-13: IEEE 802.11 specific information/IEEE1905.1a] |
- |
2.21 |
|
FrequencyIndex1 |
hexBinary(1) |
R |
Field from Media specific information for an 802.11 interface provided in a Topology response message 1905 device information type TLV as defined in [Table 6-13: IEEE 802.11 specific information/IEEE1905.1a] |
- |
2.21 |
|
FrequencyIndex2 |
hexBinary(1) |
R |
Field from Media specific information for an 802.11 interface provided in a Topology response message 1905 device information type TLV as defined in [Table 6-13: IEEE 802.11 specific information/IEEE1905.1a] |
- |
2.21 |
|
LinkNumberOfEntries |
unsignedInt |
R |
The number of entries in the Link table. |
- |
2.21 |
|
NonIEEE1905NeighborNumberOfEntries |
unsignedInt |
R |
The number of entries in the NonIEEE1905Neighbor table. |
- |
2.21 |
|
IEEE1905NeighborNumberOfEntries |
unsignedInt |
R |
The number of entries in the IEEE1905Neighbor table. |
- |
2.21 |
|
L2NeighborNumberOfEntries |
unsignedInt |
R |
The number of entries in the L2Neighbor table. |
- |
2.21 |
|
Device.IEEE1905.Network.AL.{i}.Interface.{i}.GenericPhy. |
object |
R |
This object represents the GenericPhy for this Interface as defined in [Table 6-29: Generic Phy device information type TLV/IEEE1905.1a]. |
- |
2.21 |
|
OUI |
string(6) |
R |
The OUI of the Generic Phy networking technology of the Neighbor's interface. This value is from a Generic Phy response message field as defined in [Table 6-29: Generic Phy Device Information type TLV/IEEE1905.1a]. Possible patterns:
|
- |
2.21 |
|
Variant |
hexBinary(1) |
R |
The Variant Index of the Generic Phy networking technology of the Neighbor's interface. This value is from a Generic Phy response message variant index field as defined in [Table 6-29: Generic Phy Device Information type TLV/IEEE1905.1a]. |
- |
2.21 |
|
URL |
string(:2048) |
R |
[URL] to the Generic Phy XML Description of the Generic Phy networking technology of the Neighbor's interface. This value is from a Generic Phy response message URL to Generic Phy field as defined in [Table 6-29: Generic Phy device information type TLV/IEEE1905.1a]. |
- |
2.21 |
|
Device.IEEE1905.Network.AL.{i}.Interface.{i}.Link.{i}. |
object(0:) |
R |
This object defines the 1905 neighbors and link properties. At most one entry in this table can exist with the same values for both InterfaceId and IEEE1905Id. |
- |
2.21 |
|
InterfaceId |
string(:17) |
R |
[MACAddress] MAC Address of the interface of the Neighbor for this Link. This value comes from the neighbor’s Topology discovery message as defined in [Table 6-9: MAC address type TLV/IEEE1905.1a]. |
- |
2.21 |
|
IEEE1905Id |
string(:17) |
R |
[MACAddress] MAC Address of the 1905 AL entity of the Neighbor device on this Link. This value comes from the neighbor’s Topology discovery message as defined in [Table 6-8: AL MAC address type TLV/IEEE1905.1a]. |
- |
2.21 |
|
MediaType |
string |
R |
Media type of this Link. This value is derived from the neighbor’s Topology response message 1905 device information type TLV Media Type field as defined in [Table 6-12: Media type/IEEE1905.1a]. Enumeration of:
|
- |
2.21 |
|
Device.IEEE1905.Network.AL.{i}.Interface.{i}.Link.{i}.GenericPhy. |
object |
R |
This object represents the GenericPhy for this Link as defined in [Table 6-29: Generic Phy device information type TLV/IEEE1905.1a]. |
- |
2.21 |
|
OUI |
string(6) |
R |
The OUI of the Generic Phy networking technology of the Neighbor's interface. This value is from a Generic Phy response message field as defined in [Table 6-29: Generic Phy Device Information type TLV/IEEE1905.1a]. Possible patterns:
|
- |
2.21 |
|
Variant |
hexBinary(1) |
R |
The Variant Index of the Generic Phy networking technology of the Neighbor's interface. This value is from a Generic Phy response message variant index field as defined in [Table 6-29: Generic Phy Device Information type TLV/IEEE1905.1a]. |
- |
2.21 |
|
URL |
string(:2048) |
R |
[URL] to the Generic Phy XML Description of the Generic Phy networking technology of the Neighbor's interface. This value is from a Generic Phy response message URL to Generic Phy field as defined in [Table 6-29: Generic Phy device information type TLV/IEEE1905.1a]. |
- |
2.21 |
|
Device.IEEE1905.Network.AL.{i}.Interface.{i}.Link.{i}.Metric. |
object |
R |
This object represents the metrics for this Link as defined in [Table 6-18: 1905 transmitter link metrics and Table 6-20: 1905 receiver link metrics/IEEE1905.1a]. |
- |
2.21 |
|
IEEE802dot1Bridge |
boolean |
R |
Indicates whether or not the 1905 link includes one or more IEEE 802.1 bridges. If false, the 1905 link does not include an IEEE 802.1 bridge. If true, the 1905 link does include one or more IEEE 802.1 bridges. |
- |
2.21 |
|
PacketErrors |
unsignedInt |
R |
[StatsCounter32] Estimated number of lost Packets on the transmit side of the link [Table 6-18: 1905 transmitter link metrics/IEEE1905.1a] during a measurement period. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
PacketErrorsReceived |
unsignedInt |
R |
[StatsCounter32] Estimated number of lost Packets on the receive side of the link [Table 6-20: 1905 receiver link metrics/IEEE1905.1a] during a measurement period. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
TransmittedPackets |
unsignedInt |
R |
[StatsCounter32] Estimated number of Packets sent to the Neighbor on this Link, in the same measurement period used to estimate PacketErrors. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
PacketsReceived |
unsignedInt |
R |
[StatsCounter32] Estimated number of Packets received from this Neighbor on this Link [Table 6-20: 1905 receiver link metrics/IEEE1905.1a], in the same measurement period used to estimate PacketErrorsReceived. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
MACThroughputCapacity |
unsignedInt |
R |
The maximum MAC throughput in Mbps between this Interface and the Neighbor on this Link that is estimated at this Interface. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
LinkAvailability |
unsignedInt(0:100) |
R |
The estimated average percent of time that the Link is available for data transmissions. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
PHYRate |
unsignedInt |
R |
The Physical Layer (PHY) rate in Mbps between this Interface and the Neighbor on this Link that is estimated at this Interface. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
RSSI |
unsignedInt(0:255) |
R |
The estimated Received Signal Strength Indicator (RSSI) level in dB between this Interface and the Neighbor on this Link that is estimated at the receive side of this Interface. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
Device.IEEE1905.Network.AL.{i}.Interface.{i}.NonIEEE1905Neighbor.{i}. |
object(0:) |
R |
This object represents an instance of a Non-IEEE1905 Neighbor for the AL. These fields come from a Topology response message as defined in [Table 6-14: Non-1905 neighbor device TLV/IEEE1905.1a]. At most one entry in this table can exist with a given value for NeighborInterfaceId. |
- |
2.21 |
|
NeighborInterfaceId |
string(:17) |
R |
[MACAddress] MAC Address of the interface for the NonIEEE1905Neighbor. |
- |
2.21 |
|
Device.IEEE1905.Network.AL.{i}.Interface.{i}.IEEE1905Neighbor.{i}. |
object(0:) |
R |
This object represents an instance of an IEEE1905Neighbor for the AL. These values are from the Topology response message as defined in [Table 6-15: 1905 neighbor device TLV/IEEE1905.1a]. At most one entry in this table can exist with a given value for NeighborDeviceId. |
- |
2.21 |
|
NeighborDeviceId |
string(:17) |
R |
[MACAddress] 1905 AL MAC Address of the Neighbor. |
- |
2.21 |
|
IEEE1905DeviceRef |
string(:256) |
R |
The value in this parameter is a reference to the 1905 device in the AL table, provided backhaul connectivity by this device. This can be used to construct a network topology from this 1905 device. Since the IEEE 1905.1 protocol forms a tree topology, there is one and only one path to the gateway for each 1905 Device, but each parent can support multiple child connections. The value MUST be the Path Name of a row in the IEEE1905.Network.AL. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. |
- |
2.21 |
|
IEEE802dot1Bridge |
boolean |
R |
Indicates whether or not there is at least one IEEE 802.1 bridge between this device and the neighbor. If false, no IEEE 802.1 bridge exists between this device and the neighbor. If true, there is at least one IEEE 802.1 bridge exists between this device and the neighbor. |
- |
2.21 |
|
Device.IEEE1905.Network.AL.{i}.Interface.{i}.L2Neighbor.{i}. |
object(0:) |
R |
This object represents an instance of an L2 Neighbor for the AL. These fields come from a Topology response message as defined in [Table 6-41: L2 neighbor device TLV/IEEE1905.1a]. At most one entry in this table can exist with a given value for NeighborInterfaceId. |
- |
2.21 |
|
NeighborInterfaceId |
string(:17) |
R |
[MACAddress] MAC Address of the L2Neighbor. |
- |
2.21 |
|
BehindInterfaceIds |
string(:17)[] |
R |
[MACAddress] Comma-separated list of MAC Addresses. Behind MAC Addresses of the L2Neighbor. |
- |
2.21 |
|
Device.IEEE1905.Network.AL.{i}.BridgingTuple.{i}. |
object(0:) |
R |
This object represents an instance of an BridgingTuple for the AL. These values come from the 1905 Device’s Topology response message as defined in [Table 6-11: Device bridging capability TLV/IEEE1905.1a]. |
- |
2.21 |
|
InterfaceList |
string(:256)[] |
R |
Comma-separated list of strings (maximum number of characters per item 256). Each list item MUST be the Path Name of a row in the AL.{i}.Interface. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. |
- |
2.21 |
|
Device.MQTT. |
object |
R |
MQTT Base object describing all MQTT related parameters and objects. Changes since 2.20:
|
- |
2.10 |
|
LogConnectionMessages |
boolean |
W |
If set to true, the log will include entries when any MQTT client connects or disconnects. These entries are written to the platform’s default system log facility. This parameter only controls logging of client connection lifecycle events and does not affect logging of other broker activities such as publish, subscribe, or authentication events. |
- |
2.21 |
|
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. Changes since 2.20:
|
- |
2.10 |
|
CipherList |
string[] |
R |
Comma-separated list of strings. Each item in this list specifies a cipher that the TLS client is allowed to use. When an empty string the system defaults are used. |
- |
2.21 |
|
Device.MQTT.BrokerSecurity. |
object |
R |
MQTT security configuration, including an Access Control List (ACL) to manage access to MQTT topics. |
- |
2.21 |
|
ACLNumberOfEntries |
unsignedInt |
R |
The number of entries in the ACL table. |
- |
2.21 |
|
ClientNumberOfEntries |
unsignedInt |
R |
The number of entries in the Client table. |
- |
2.21 |
|
Device.MQTT.BrokerSecurity.ACL.{i}. |
object(0:) |
W |
An entry in the Access Control List (ACL). Each entry specifies a single permission rule, defining which user or client can perform a specific operation (Publish or Subscribe) on a particular MQTT topic, and whether that action is allowed or denied. 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.21 |
|
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.21 |
|
Order |
unsignedInt(1:) |
W |
[Order] The order in which to evaluate this rule. Lower-ordered rules are evaluated first. Each rule MUST have a unique order value. |
- |
2.21 |
|
Enable |
boolean |
W |
Enables or disables this ACL rule. |
false |
2.21 |
|
Description |
string(:256) |
W |
A human-readable description of this ACL rule. |
<Empty> |
2.21 |
|
AllowAnonymous |
boolean |
W |
If true, this rule allows access to anonymous clients. |
false |
2.21 |
|
ClientList |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Device.MQTT.BrokerSecurity.Client. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. The MQTT client identity entries to which this rule applies. If this list is an empty string, the rule can apply to any client. Whether this rule also applies to anonymous clients is determined by this rule's AllowAnonymous parameter. |
<Empty> |
2.21 |
|
Topics |
string[] |
W |
Comma-separated list of strings. Each item specifies an MQTT topic filter to which this rule applies. The filter may include
MQTT-standard wildcards ( |
<Empty> |
2.21 |
|
Operations |
string[] |
W |
Comma-separated list of strings. The MQTT operations that this rule controls. This parameter works in conjunction with Access to determine whether the specified operations are allowed or denied. Each list item is an enumeration of:
|
Publish,Subscribe |
2.21 |
|
Access |
string |
W |
Whether to allow or deny the operations specified in Operations on the configured Topics. Enumeration of:
|
Deny |
2.21 |
|
Device.MQTT.BrokerSecurity.Client.{i}. |
object(0:) |
W |
Configuration for an MQTT client identity, which represents an entry in an authorization table that the local broker uses to authorize incoming MQTT client connections. This is different from the Client object, which defines the credentials that a specific MQTT client instance on this device should use when connecting to an external or internal MQTT broker. Client defines the credentials for a single client, which can be based on a ClientID, a Username/Password pair, or a certificate identity (which is not stored here but verified by the broker against these entries). 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.21 |
|
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.21 |
|
Enable |
boolean |
W |
Enables or disables this MQTT client identity entry. |
false |
2.21 |
|
Name |
string |
W |
A unique, human-readable name for this MQTT client identity entry. |
- |
2.21 |
|
Description |
string(:256) |
W |
A human-readable description of this MQTT client identity entry. |
- |
2.21 |
|
ClientID |
string |
W |
The MQTT protocol-level Client Identifier for this client, sent in the CONNECT packet (see [Section 3.1.3.1/MQTT50]). It uniquely identifies this client identity and can be used for matching ACL rules, either on its own or in conjunction with the Username from this entry. |
<Empty> |
2.21 |
|
Username |
string(:256) |
W |
Username for this client. When Device.MQTT.Broker.{i}.AuthenticationMethod is UsernamePassword, this username is used for authentication, matched against the username provided by the client. When certificate-based authentication is used (e.g., CertViaCN), this username is matched against the username derived from the client's certificate for authorization purposes. If an empty string, this rule may apply to anonymous clients, provided Device.MQTT.Broker.{i}.AllowAnonymous is true. |
<Empty> |
2.21 |
|
Password |
string(:256) |
W |
The password for this user, to be provided by the client. This parameter is only used for authentication when Device.MQTT.Broker.{i}.AuthenticationMethod is set to UsernamePassword. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.21 |
|
Device.MQTT.Broker.{i}. |
object(0:) |
W |
MQTTEach brokerentry table.in Containsthis table configures a listsingle oflistener configuredfor the local MQTT brokers.}}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. Changes since 2.20:
|
- |
2.10 |
|
ACLList |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Device.MQTT.BrokerSecurity.ACL. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Each item represents an Access Control List (ACL) rule that defines the permissions for clients connected to this broker instance. These rules are evaluated to determine if a client is authorized to publish to or subscribe from specific topics. |
- |
2.21 |
|
AuthenticationMethod |
string |
W |
The authentication method used by the broker to verify client identity. Enumeration of:
|
UsernamePassword |
2.21 |
|
AllowAnonymous |
boolean |
W |
If true, the broker will allow clients to connect without providing a username and password. If false, all clients must provide credentials. These anonymous clients can still be subject to ACL rules. |
false |
2.21 |
|
Username |
string(:256) |
W |
User name used to authenticate the MQTT clients, which connect to the MQTT broker. Note: If this parameter is an empty string, nothen authenticationAllowAnonymous MUST also be set to true, or the Client will not be authorized via this mechanism. Instead of using a single username and password across multiple devices, it is used.}}RECOMMENDED to use the per-client identity and access control lists defined within the Device.MQTT.BrokerSecurity object. Both mechanisms should not be used simultaneously. |
- |
2.10 |
|
Password |
string(:256) |
W |
Password used used to authenticate the MQTT clients, which connect to the MQTT broker. This password is only used if Username is not an empty string. Note: If Username is an empty string, then AllowAnonymous MUST also be set to true, or the Client will not be authorized via this mechanism. Instead of using a single username and password across multiple devices, it is RECOMMENDED to use the per-client identity and access control lists defined within the Device.MQTT.BrokerSecurity object. Both mechanisms should not be used simultaneously. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.10 |
|
CipherList |
string[] |
R |
Comma-separated list of strings. Each item in this list specifies a cipher that the TLS server is allowed to use. When an empty string the system defaults are used. |
- |
2.21 |
|
Process |
string |
R |
The value MUST be the Path Name of a row in the Device.DeviceInfo.ProcessStatus.Process. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This parameter identifies the row representing the running process associated with this MQTT broker instance. The referenced row contains process details, including the PID. |
- |
2.21 |
|
BrokerID |
unsignedInt(:65535) |
W |
BrokerID is an identifier used to group multiple broker instances (listeners) under a single broker process. Instances with the same BrokerID value share the process; instances with a new BrokerID value result in a new process being created. |
0 |
2.21 |
|
ConfFile |
string(:256) |
R |
The value MUST be the Path Name of a row in the Device.DeviceInfo.VendorConfigFile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This parameter identifies the row in the table that represents the configuration file used by the MQTT broker instance. |
- |
2.21 |
|
Device.MQTT.Broker.{i}.Bridge.{i}. |
object(0:) |
W |
Configures MQTT bridges, which are used to communicate with other MQTT brokers. 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. Changes since 2.20:
|
- |
2.10 |
|
CipherList |
string[] |
R |
Comma-separated list of strings. Each item in this list specifies a cipher that the TLS client is allowed to use. When an empty string the system defaults are used. |
- |
2.21 |
|
Device.DynamicDNS. |
object |
R |
Properties for Dynamic DNS. |
- |
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 CPE 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. Changes since 2.20:
|
- |
2.10 |
|
IPVersion |
int(4,6,-1) |
W |
Specifies the IP protocol version, following the definitions in [IANA-ipversionnumbers]. Valid values are: 4 (IPv4), 6 (IPv6), or -1 (No specific IP version is required). This indicates whether to update the A records (4), AAAA records (6) or both (-1). |
-1 |
2.21 |
|
Device.LEDs. |
object |
R |
This object describes the LEDs on the device. |
- |
2.11 |
|
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.20:
|
- |
2.11 |
|
Status |
string |
R |
The status of the LED. Enumeration of:
|
- |
2.11 |
|
ControllingPeripheral |
string |
R |
The value MUST be the Path Name of a table row. Indicates which interface or peripheral this LED is controlled by. For example, 'Device.Ethernet.Interface.1'. If an empty string, the LED is not controlled by a specific peripheral. |
- |
2.21 |
|
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.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 |
|
Device.LMAP.Event.{i}.CalendarTimer. |
object |
R |
This object defines a calendar timer instance. The calendar timer instance has attributes for when the timer is to begin (StartTime) and end (EndTime) as well as the schedule of the recurrence. The algrorithmalgorithm that defines how the schedule elements are evaluated is defined in [LMAPIFM]. If the value of any of the ScheduleMonths, ScheduleDaysOfMonth, ScheduleDaysOfWeek, ScheduleHoursOfDay, ScheduleMinutesOfHour or ScheduleSecondsOfMinute is an empty string then any actions that use this object will not be invoked. |
- |
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 |
|
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 |
|
Device.WWC.AccessNetwork.{i}.GUTI. |
object |
R |
A 5G Globally Unique Temporary Identity (GUTI) securely identifesidentifies an CPE by keeping the permanent User Equipment (UE identifier (IMSI) hidden. This identity is globally unique and assigned by the AMF at the time of registration. See [.Clause 2.10/3GPP-TS.23.003]. |
- |
2.14 |
|
AMFId |
unsignedInt |
R |
The AMFId identifies an AMF instance within a service provider's network. In conjunction with the PLMN, it forms a Globally Unique AMF Id (GUAMI) which globally uniquely identifesidentifies an AMF. See [Clause 2.10/3GPP-TS.23.003]. |
- |
2.14 |
|
TMSI |
unsignedInt |
R |
The Temporary Mobile Subscriber Identity (TMSI) is allocatredallocated by the AMF at the time of registration and uniquely identifies the CPE. 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. Changes since 2.20:
|
- |
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. Changes since 2.20:
|
- |
2.14 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
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 manger.)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. Changes since 2.20:
|
- |
2.16 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
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 |
|
InterfaceNumberOfEntries |
unsignedInt |
R |
The number of entries in the Interface table. |
- |
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 |
|
Enable |
boolean |
W |
Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.21 |
|
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]. |
- |
2.21 |
|
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.21 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE. |
- |
2.21 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
LastChange |
unsignedInt |
R |
The accumulated time in seconds since the interface entered its current operational state. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
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]. |
- |
2.21 |
|
Device.Logical.TUN.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.21 |
|
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.21 |
|
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packets received on the interface. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. |
- |
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 |
|
InterfaceNumberOfEntries |
unsignedInt |
R |
The number of entries in the Interface table. |
- |
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 |
|
Enable |
boolean |
W |
Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.21 |
|
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]. |
- |
2.21 |
|
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.21 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE. |
- |
2.21 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
LastChange |
unsignedInt |
R |
The accumulated time in seconds since the interface entered its current operational state. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
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]. |
- |
2.21 |
|
Device.Logical.TAP.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. |
- |
2.21 |
|
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.21 |
|
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packets received on the interface. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. |
- |
2.21 |
|
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. |
- |
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 |
|
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. Changes since 2.20:
|
- |
2.16 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). The upstream interface is the one that provides connectivity to the Internet or the next hop router. For example:
|
- |
2.19 |
|
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 CPE 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]. Changes since 2.20:
|
- |
2.16 |
|
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. |
- |
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 coresspondingcorresponding 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.UnixDomainSockets. |
object |
R |
This object contains information related to the Unix Domain Sockets used by USP Agent UDS MTP. |
- |
2.16 |
|
Device.UnixDomainSockets.Authentication.{i}. |
object(0:) |
W |
This object contains the authentication details for USP Endpoints connecting to Unix Domain Sockets requiring authentication. Endpoints not present in this table will be unable to authenticate successsfullysuccessfully on Unix Domain Sockets requiring authentication. At most one enabled entry in this table can exist with a given value for EndpointID. |
- |
2.20 |
|
Password |
string |
W |
Expected password to be used by the USP Endpoint to authenticate. If set to an empty string, the USP Endpoint will be unable to authenticate successsfullysuccessfully on Unix Domain Sockets requiring authentication. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.20 |
|
Device.Syslog. |
object |
R |
This object contains global parameters relating to the syslog implementations that is 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 either 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 |
|
Severity |
string |
W |
Specifies the Severity level filter rules. Defines the processing used to select log messages by comparing syslog message severity using the following processing rules: - if 'none', do not match. - if 'all', match. - else compare message severity with the specified severity according to the default compare rule (all messages of the specified severity and greater match). This must be used inconjuctionin conjunction with SeverityCompare and SeverityCompareAction. Enumeration of:
|
All |
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. Changes since 2.20:
|
- |
2.17 |
|
Device.Syslog.Source.{i}.UnixDomainSocket. |
object |
R |
This object describes the configuration parameters for receiving syslog information on a Unix Domain Socket (UDS). |
- |
2.21 |
|
Enable |
boolean |
W |
Enables or disables the functionality to receive syslog information on a UDS. |
- |
2.21 |
|
Path |
string(:2048) |
W |
[FileURI] File path of the Unix Domain Socket. Which MUST use the URI scheme file [The file URI Scheme/RFC8089]. Example: '<file:///tmp/syslog.sock>' |
- |
2.21 |
|
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 |
|
Device.Syslog.Action.{i}.LogFile. |
object |
R |
This object describes the configuration parameters for file logging. If file-archive limits are not supplied, it is assumed that the local implementation defined limits will be used. |
- |
2.17 |
|
FilePath |
string(:2048) |
W |
[FileURI] Destination path and filename of where to create and keep the logfiles. Which MUST use the uri scheme file [The file URI Scheme/RFC8089]. Changes since 2.20:
|
- |
2.17 |
|
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. Changes since 2.20:
|
- |
2.19 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Device.Hardware. |
object |
R |
Represents the hardware configuration of the device, including details about the CPU, memory, and other hardware components. Changes since 2.20:
|
- |
2.20 |
|
Device.Hardware.Buttons. |
object |
R |
This object contains the configuration and status of physical buttons present on the device. |
- |
2.21 |
|
ButtonNumberOfEntries |
unsignedInt |
R |
The number of entries in the Button table. |
- |
2.21 |
|
Device.Hardware.Buttons.Button.{i}. |
object(0:) |
R |
This object represents an individual physical button of the device. The button is typically discovered automatically from the system (e.g., via DeviceTree). At most one entry in this table can exist with a given value for Label, or with a given value for Alias, or with a given value for Name. |
- |
2.21 |
|
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.21 |
|
Name |
string |
W |
Name of the button. |
- |
2.21 |
|
Label |
string |
R |
The system-defined label for the button, often referencing its DeviceTree label. |
- |
2.21 |
|
Status |
string |
R |
The current operational status of the button. Enumeration of:
|
- |
2.21 |
|
Location |
string |
R |
The location of the button as the user looks at the front of the device in its typical orientation. Enumeration of:
|
- |
2.21 |
|
InputFile |
string(:2048) |
R |
[FileURI] Specifies the full path of the input device for the button. (Eg: <file:///dev/input/event0>) Which MUST use the uri scheme file [The file URI Scheme/RFC8089]. |
- |
2.21 |
|
TriggerConditionNumberOfEntries |
unsignedInt |
R |
The number of entries in the TriggerCondition table. |
- |
2.21 |
|
Device.Hardware.Buttons.Button.{i}.TriggerCondition.{i}. |
object(0:) |
W |
This object defines the conditions for interpreting physical button presses into specific button events, such as a short press, long press, or release. 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.21 |
|
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.21 |
|
Enable |
boolean |
W |
Enables or disables this TriggerCondition entry. |
false |
2.21 |
|
Name |
string |
W |
The name of the TriggerCondition. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.21 |
|
Type |
string |
W |
The type of trigger condition, which determines when this TriggerCondition is activated. Enumeration of:
|
- |
2.21 |
|
Min |
unsignedInt |
W |
Min and Max have to be set together. Both values MUST be expressed in milliseconds. If the button gets released between Min and Max, this TriggerCondition is activated. This parameter will only be used when Type is set to Released. |
- |
2.21 |
|
Max |
unsignedInt |
W |
Min and Max have to be set together. Both values MUST be expressed in milliseconds. If the button gets released between Min and Max, this TriggerCondition is activated. This parameter will only be used when Type is set to Released. |
- |
2.21 |
|
Timeout |
unsignedInt |
W |
This value MUST be expressed in milliseconds. If the button gets pressed for longer than Timeout, this TriggerCondition is activated. This parameter will only be used when Type is set to LongPressed |
- |
2.21 |
|
Active |
boolean |
R |
This Active indicates the activation status of the condition. It is set to true when this TriggerCondition is activated and will automatically reset to false after a duration defined by the ActiveTime parameter. |
- |
2.21 |
|
ActiveTime |
unsignedInt |
W |
This ActiveTime specifies the duration for which the Active parameter will remain true after this TriggerCondition is activated, expressed in milliseconds. |
- |
2.21 |
|
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. Changes since 2.20:
|
- |
2.20 |
|
Description |
string(:256) |
W |
A user-friendly description of the interface. |
- |
2.21 |
|
Device.WireGuard.Peer.{i}. |
object(0:) |
W |
WireGuard Peer table, an entry in this table represents a WireGuard peer. 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 PublicKey. |
- |
2.20 |
|
PublicKey |
string(44) |
W |
PublicThe base64 encoded public key of the peer. Note: The min and max length requirements have been changed in Device:2.21 to reflect the representation as a base64 encoded key of 32 bytes. Changes since 2.20:
|
- |
2.20 |
|
|
string(0,44) |
W |
The base64 encoded pre-shared key for this WireGuard Peer. When an empty string is provided, no pre-shared key is used. Note: The min and max length requirements have been changed in Device:2.21 to reflect the representation as a base64 encoded key of 32 bytes. When read, this parameter returns an empty string, regardless of the actual value. Changes since 2.20:
|
- |
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. |
- |
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 SecuredRoles parameter is appended to the Controller.{i}.AssignedRole parameter of the Controller instance that requires access to the content of secured parameters.. OnlyA ControllersController withthat 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 roleparameter assignedfor (andwhich it has the appropriate permissionsaccess set)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 bereturn ablean toempty have access to secured parameters content.}}string. |
- |
2.16 |
Generated by Broadband Forum bbfreport v2.4.0 (2025-11-11 version) on 2026-06-01 at 20:21:03 UTC.
report.py --include ../../install/cwmp --output tr-181-2-21-0-cwmp-diffs.html --show --transform diff --format html tr-181-2-20-1-cwmp.xml tr-181-2-21-0-cwmp.xml