![]() | Device:2 Root Data Model definition [CWMP] (changes)tr-181-2-20-0-cwmp.xml | ||
DATA MODEL DEFINITION | |||
License
Copyright (c) 2010-2025, Broadband Forum
The undersigned members have elected to grant the copyright to
their contributed material used in this software:
Copyright (c) 2017-2019, 2021 ARRIS Enterprises, LLC.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The above license is used as a license under copyright only. Please reference the Forum IPR Policy for patent licensing terms https://www.broadband-forum.org/ipr-policy.
Any moral rights which are necessary to exercise under the above license grant are also deemed granted under this license.
Data Types
The Parameters defined in this specification make use of a limited subset of the default SOAP data types [SOAP1.1]. These data types and the named data types used by this specification are described below.
Note: A Parameter that is defined to be one of the named data types is reported as such at the beginning of the Parameter's description via a reference back to the associated data type definition (e.g. [MACAddress]). However, such parameters still indicate their SOAP data types.
| Data Type | Base Type | Description |
|---|---|---|
|
base64 |
- |
Base64 encoded binary (no line-length limitation). A minimum and maximum allowed length can be indicated using the form base64(Min:Max), where Min and Max are the minimum and maximum length in characters before Base64 encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in base64(Max). Multiple comma-separate ranges can be specified, in which case the length MUST be in one of the ranges. |
|
boolean |
- |
Boolean, where the allowed values are 0 or 1 (or equivalently, true or false). |
|
dateTime |
- |
The subset of the ISO 8601 date-time format defined by the SOAP dateTime type [SOAP1.1]. |
|
hexBinary |
- |
Hex encoded binary. A minimum and maximum allowed length can be indicated using the form hexBinary(Min:Max), where Min and Max are the minimum and maximum length in characters before Hex Binary encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in hexBinary(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges. |
|
int |
- |
Integer in the range -2147483648 to +2147483647, inclusive. For some int types, a value range is given using the form int(Min:Max) or int(Min:Max step Step) where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges. |
|
string |
- |
For strings, a minimum and maximum allowed length can be indicated using the form string(Min:Max), where Min and Max are the minimum and maximum string length in characters. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in string(Max). Multiple comma-separated ranges can be specified, in which case the string length will be in one of the ranges. |
|
unsignedInt |
- |
Unsigned integer in the range 0 to 4294967295, inclusive. For some unsignedInt types, a value range is given using the form unsignedInt(Min:Max) or unsigned(Min:Max step Step), where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges. |
|
unsignedLong |
- |
Unsigned long integer in the range 0 to 18446744073709551615, inclusive. For some unsignedLong types, a value range is given using the form unsignedLong(Min:Max) or unsignedLong(Min:Max step Step), where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges. |
|
Alias |
string(:64) |
A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
|
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. |
|
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:
|
|
MocaDB |
Represents one decibel or 1 dB. |
|
|
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 23.503, Policy and charging control framework for the 5G System (5GS); Stage 2, 3GPP CT WG4, 2019. |
|
|
3GPP TS 24.501, Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3, 3GPP CT WG1. |
|
|
3GPP TS 24.526, User Equipment (UE) policies 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. |
|
|
[802.11ax] |
IEEE Std 802.11ax, Enhancements for High Efficiency WLAN, IEEE, May 2021. |
|
Thread Specification, IEEE Standard for Low-Rate Wireless Networks, IEEE, July 2020. |
|
|
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.988] |
G.988, ONU management and control interface (OMCI) specification, ITU-T, 2010. |
|
[G.996.2] |
G.996.2, Single-ended line testing for digital subscriber lines (DSL), ITU-T. |
|
[G.9964] |
G.9964, Unified high-speed wire-line based home networking transceivers - Power spectral density specification, 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. |
|
|
IKEv2 Parameters, Internet Key Exchange Version 2 (IKEv2) Parameters, IANA. |
|
|
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. |
|
MOCA11-MIB, Remote Management of MoCA Interfaces using SNMP MIB, MoCA Alliance, 2009. |
|
|
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. |
|
[OUI] |
Organizationally Unique Identifiers (OUIs). |
|
[RFC2616] |
RFC 2616, Hypertext Transfer Protocol - HTTP/1.1, IETF, 1999. |
|
[RFC2863] |
RFC 2863, The Interfaces Group MIB, IETF, 2000. |
|
[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. |
|
[RFC4291] |
RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006. |
|
[RFC4292] |
RFC 4292, IP Forwarding Table MIB, 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. |
|
[RFC5996] |
RFC 5996, Internet Key Exchange Protocol Version 2 (IKEv2), IETF, September 2010. |
|
[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. |
|
[RFC7398] |
RFC 7398, A Reference Path and Measurement Points for Large-Scale Measurement of Broadband Performance, IETF, February 2015. |
|
[RFC7594] |
RFC 7594, A Framework for Large-Scale Measurement of Broadband Performance (LMAP), IETF, September 2015. |
|
[RFC7597] |
RFC 7597, Mapping of Address and Port with Encapsulation (MAP), IETF, July 2015. |
|
[RFC7598] |
RFC 7598, DHCPv6 Options for configuration of Softwire Address and Port Mapped Clients, IETF, July 2015. |
|
[RFC7599] |
RFC 7599, Mapping of Address and Port using Translation (MAP-T), IETF, July 2015. |
|
[RFC7616] |
RFC 7616, HTTP Digest Access Authentication, IETF, September 2015. |
|
[RFC7617] |
RFC 7617, The 'Basic' HTTP Authentication Scheme, IETF, September 2015. |
|
[RFC8141] |
RFC 8141, Uniform Resource Names (URNs), IETF, April 2017. |
|
[RFC9110] |
RFC 9110, HTTP Semantics, IETF, June 2022. |
|
[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-181i2] |
TR-181 Issue 2 Amendment 15, Device Data Model, Broadband Forum, January 2022. |
|
[TR-369] |
TR-369 Issue 1 Amendment 2, User Services Platform, Broadband Forum, January 2022. |
|
[TR-471] |
TR-471, Maximum IP-Layer Capacity Metric, Related Metrics, and Measurements, Broadband Forum, December 2023. |
|
[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. |
|
[WPA3v3.0] |
WPA3v3.0, Wi-Fi Protected Access 3 Specification Version 3.0.x, Wi-Fi Alliance. |
|
ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007. |
Legend
|
Object definition. |
|
Parameter definition. |
Device:2.20 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.19:
- Changed name = Device:2.19 ⇒ Device:2.20
| Name | Type | Write | Description | Object Default | Version |
|---|---|---|---|---|---|
|
Device. |
object |
R |
The top-level object for a Device. Changes since 2.19:
|
- |
2.0 |
|
RootDataModelVersion |
string(:32) |
R |
Root data model version, e.g. 2.4. For a vendor-defined root data model, this is the standard Broadband Forum model on which the vendor-defined model is based. Possible patterns:
This parameter MUST always be included in Inform messages. |
- |
2.4 |
|
Device.DeviceInfo. |
object |
R |
This object contains general device information. |
- |
2.0 |
|
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. This parameter was OBSOLETED in 2.20. Changes since 2.19:
|
- |
2.1 |
|
Device.DeviceInfo.ProcessStatus. |
object |
R |
Status of the processes on the device. |
- |
2.0 |
|
Device.DeviceInfo.ProcessStatus.CPU.{i}. |
object(0:) |
R |
EachThis instanceobject indescribes the tableutilization representsmetrics afor each CPU on thisthe device. HereIt CPUalso candefines implythe mainmonitoring CPUactions (wherethat systemare softwareautomatically istriggered executed)when orspecific hardware/networkutilization accelerationthresholds CPUare (responsible for data plane traffic).}}crossed. At most one entry in this table can exist with a given value for Name, or with a given value for Alias. |
- |
2.18 |
|
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. This object was OBSOLETED in 2.20. At most one entry in this table can exist with a given value for Alias. Changes since 2.19:
|
- |
2.1 |
|
Device.ManagementServer. |
object |
R |
This object contains parameters relating to the CPE's association with an ACS. Changes since 2.19:
|
- |
2.0 |
|
PendingScheduleInforms |
dateTime[] |
R |
Comma-separated list of date/times. Each entry in the list represents the absolute time at which the CPE is going to send a ScheduleInform RPC to the ACS. An empty string means that there are no pending ScheduledInform RPCs requested by the ACS. |
- |
2.20 |
|
UpgradePending |
boolean |
R |
Indicates whether a firmware upgrade is scheduled or in progress. A value of true signifies that an upgrade is pending (e.g., scheduled after a delay) or is actively being performed. A value of false indicates no upgrade is scheduled or in progress. The device MUST NOT enter a low-power state (I.e. Deep Standby) that could interrupt network connectivity or break the firmware upgrade process while this parameter is true. |
- |
2.20 |
|
DeliveredEvents |
string[] |
R |
Comma-separated list of strings. Each entry represents an Event Code and its associated Command Key, where applicable as defined in [Section 3.7.1.5/TR-069], that was delivered to the ACS during the last session. The format for each entry is the Event Code itself followed by the Command Key in parentheses with an empty set of parentheses if the Command Key is not applicable. Furthermore, any spaces in the values MUST be percent encoded as defined in [Chapter 3.2.2 Comma-separated Lists/TR-106]. E.g. DeliveredEvents = "4%20VALUE%20CHANGE,7%20TRANSFER%20COMPLETE,M%20Download(20326379)". |
- |
2.20 |
|
SessionStatus |
string |
R |
This parameter indicates the session status of the CWMP Agent. Enumeration of:
|
- |
2.20 |
|
AllowAllIPv4 |
boolean |
W |
Allow incoming IP connections from any IPv4 address. The source prefixes defined in IPv4AllowedSourcePrefix will be ignored. The default value SHOULD be true. |
- |
2.20 |
|
IPv4AllowedSourcePrefix |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. Allow only incoming IP connections from the provided list of IPv4 prefixes. When IPv4AllowedSourcePrefix is set to an empty string and AllowAllIPv4 is set to false, no incoming IP connections are allowed. When AllowAllIPv4 is set true, IPv4AllowedSourcePrefix is ignored. |
- |
2.20 |
|
AllowAllIPv6 |
boolean |
W |
Allow incoming IP connections from any IPv6 address. The source prefixes defined in IPv6AllowedSourcePrefix will be ignored. The default value SHOULD be true. |
- |
2.20 |
|
IPv6AllowedSourcePrefix |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. Allow only incoming IP connections from the provided list of IPv6 prefixes. When IPv6AllowedSourcePrefix is set to an empty string and AllowAllIPv6 is set to false, no incoming IP connections are allowed. When AllowAllIPv6 is set true, IPv6AllowedSourcePrefix is ignored. |
- |
2.20 |
|
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 |
|
AllowAllIPv4 |
boolean |
W |
Allow accessincoming IP connections from any IPv4 address. The source prefixes defined in IPv4AllowedSourcePrefix will be ignored. |
false |
2.18 |
|
IPv4AllowedSourcePrefix |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. Allow only accessincoming IP connections from the provided list of IPv4 prefixes. When IPv4AllowedSourcePrefix is set to an empty string and AllowAllIPv4 is set to false, no incoming IP connections are allowed. When AllowAllIPv4 is set true, IPv4AllowedSourcePrefix is ignored. |
- |
2.18 |
|
AllowAllIPv6 |
boolean |
W |
Allow accessincoming IP connections from any IPv6 address. The source prefixes defined in IPv6AllowedSourcePrefix will be ignored. |
false |
2.18 |
|
IPv6AllowedSourcePrefix |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. Allow only accessincoming IP connections from the provided list of IPv6 prefixes. When IPv6AllowedSourcePrefix is set to an empty string and AllowAllIPv6 is set to false, no incoming IP connections are allowed. When AllowAllIPv6 is set true, IPv6AllowedSourcePrefix is ignored. |
- |
2.18 |
|
Device.SFPs. |
object |
R |
This object describes the Small Form-Factor Pluggable (SFP) cages and the transceivers hosted in them. The object definition is based on parts of [SFF-8024] and [SFF-8472]. This data model is extensible to support new SFP management protocol standards in the future. |
- |
2.19 |
|
Device.SFPs.Mgmt. |
object |
R |
This object describes the elements of a SFP that are exposed through the given Managment 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 |
|
BRMax |
unsignedInt(0:255) |
R |
This is the upper bit rate margin in units of 1%, within which the transceiver will still meet its specifications (BR, max) is specified in units of 1% above the nominal bit rate. A value of zero indicates that this field is not specified. However this field may contain the nominal bit rate in units of 250MBd if the value in BRNominal is 255. See [Section 8.4/SFF-8472]} - Address 0xA0, Byte 66. |
- |
2.19 |
|
BRMin |
unsignedInt(0:100) |
R |
This is the lower bit rate margin in units of percent, within which the transceiver will still meet its specifications (BR, min) is specified in units of 1percent below the nominal bit rate. A value of zero indicates that this field is not specified. However this field may also specify range of signaling rates specified in units of +/- 1percent around the nominal signaling rate. See [Section 8.5/SFF-8472]} - Address 0xA0, Byte 67. |
- |
2.19 |
|
LengthSMF |
unsignedInt(0:255) |
R |
This value specifies the link length that is supported by the transceiver while operating in compliance with the applicable standards using 50 micron multimode OM2 [500MHz*km at 850nm]single-mode fiber. The value is in units of 100 meters. A value of 255 means that the transceiver supports a link length greater than 2.5425.4 kmkm. A value of zero means that the transceiver does not support 50 micron multimodesingle-mode fiber or that the length information must be determined from the transceiver technology. Changes since 2.19:
|
- |
2.19 |
|
LengthOM2 |
unsignedInt(0:255) |
R |
This value specifies link length that is supported by the transceiver while operating in compliance with applicable standards using 50 micron multimode OM2 [500MHz*km at 850nm,] fiber. The value is in units of 10 meters. A value of 255 means that the transceiver supports a link length greater than 2.54 kmkm. A value of zero means that the transceiver does not support 50 micron multimode OM2 fiber or that the length information must be determined from the transceiver technology. |
- |
2.19 |
|
LengthOM1 |
unsignedInt(0:255) |
R |
This value specifies link length that is supported by the transceiver while operating in compliance with applicable standards using 62.5 micron multimode OM1 [200 MHzkmMHz*km at 850nm, 500 MHzkmMHz*km at 1310nm] fiber. The value is in units of 10 meters . A value of 255 means that the transceiver supports a link length greater than 2.54 km. A value of zero means that the transceiver does not support 62.5 micron multimode fiber or that the length information must be determined from the transceiver technology. |
- |
2.19 |
|
LengthOM3 |
unsignedInt(0:255) |
R |
This value specifies link length that is supported by the transceiver while operating in compliance with applicable standards using 50 micron multimode OM3 [2000 MHz*km] fiber. The value is in units of 10 meters. A value of 255 means that the transceiver supports a link length greater than 2.54 km. A value of zero means that the transceiver does not support 50 micron multimode OM3 fiber or that the length information must be determined from the transceiver Technology.}}technology. |
- |
2.19 |
|
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.19:
|
- |
2.8 |
|
CurrentAccessTechnology |
string |
R |
The value MUST be a member of the list reported by the SupportedAccessTechnologies parameter, or else be Unknown. Access technology that is currently in use. Note: The Unknown value was added in Device:2.20. The factory default value MUST be Unknown. Changes since 2.19:
|
- |
2.8 |
|
Mode |
string |
R |
The current NR mode being used. Enumeration of:
|
- |
2.20 |
|
Device.Ethernet. |
object |
R |
Ethernet object. This object models several Ethernet interface objects, each representing a different stack layer, including: Interface, Link, and VLANTermination. Interface is media-specific and models a port, the PHY layer, and the 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]). 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.19:
|
- |
2.0 |
|
PowerCapability |
string[] |
R |
Comma-separated list of strings. Describes the possible power states of the Interface regardless of its current administrative state. Each list item is an enumeration of:
|
- |
2.20 |
|
PowerStatus |
string |
R |
Reports the current power status of the Interface. The value MUST be a member of the list reported by the PowerCapability parameter, or else be Error. Each list item is an enumeration of:
|
- |
2.20 |
|
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.Port.{i}. |
object(0:) |
R |
USB Port table. This table models master and slave USB physical ports on the 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.19:
|
- |
2.0 |
|
PowerCapability |
string[] |
R |
Comma-separated list of strings. Describes the possible power states of the Port regardless of its current administrative state. Each list item is an enumeration of:
|
- |
2.20 |
|
PowerStatus |
string |
R |
Reports the current power status of the Port. The value MUST be a member of the list reported by the PowerCapability parameter, or else be Error. Each list item is an enumeration of:
|
- |
2.20 |
|
Device.USB.USBHosts. |
object |
R |
This object models the CPE's USB Host controllers. See [Appendix XVII/TR-181i2] for Theory of Operation. Changes since 2.19:
|
- |
2.0 |
|
AllowedDeviceNumberOfEntries |
unsignedInt |
R |
The number of entries in the AllowedDevice table. |
- |
2.20 |
|
AllowAllDevices |
boolean |
W |
When set to true, all USB devices are allowed to connect to the Device and the configuration mentioned in USB.USBHosts.AllowedDevice. is ignored. When set to false, only USB devices listed in USB.USBHosts.AllowedDevice. are allowed to connect to the Device. Any USB device not explicitly listed will be rendered inactive. |
- |
2.20 |
|
Device.USB.USBHosts.Host.{i}. |
object(0:) |
R |
Table of CPE USB Host controllers. At most one entry in this table can exist with a given value for Name, or with a given value for Alias. |
- |
2.0 |
|
Device.USB.USBHosts.Host.{i}.Device.{i}. |
object(0:) |
R |
Table of connected USB devices. At most one entry in this table can exist with a given value for DeviceNumber. Changes since 2.19:
|
- |
2.0 |
|
DeviceState |
string |
R |
Indicates the low-level device state, directly mapping to the "Visible Device States" in [Table 9-1 Visible Device States/USB2.0]. Enumeration of:
|
- |
2.20 |
|
IsAllowed |
boolean |
R |
When true, the associated USB device is allowed to connect to the Device USB Host controller(s) based on the configuration in USB.USBHosts.AllowedDevice. and AllowAllDevices. When false, the associated USB device is not allowed to connect. |
- |
2.20 |
|
Device.USB.USBHosts.AllowedDevice.{i}. |
object(0:) |
W |
Table of USB devices permitted to connect to the Device USB Host controller(s). Each entry in this table defines an allowed device based on its e.g. USB Vendor ID and Product ID. Only USB devices listed here will be accepted by the Device; any USB device not explicitly listed will be rendered inactive. When a USB device is rendered inactive, the parameter value of Host.{i}.Device.{i}.IsAllowed is set to false, which prevents the Host.{i}.Device.{i}.DeviceState from reaching the Configured status. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.20 |
|
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.20 |
|
Enable |
boolean |
W |
Enables or disables whether the corresponding allowed USB device entry is active. If set to true, the device defined by this entry is permitted to connect to the system. If false, the device is ignored even if its identifiers match. |
- |
2.20 |
|
Description |
string(:64) |
W |
A user-friendly description of the allowed USB device entry. |
- |
2.20 |
|
DeviceClass |
string |
W |
Classification criterion. Class Code assigned by USB-IF, which can be expressed as a two-digit hexadecimal string
(e.g., Possible patterns:
|
- |
2.20 |
|
DeviceSubClass |
string |
W |
Classification criterion. Subclass code assigned by USB-IF, expressed as a two-digit hexadecimal string (e.g.,
Possible patterns:
|
- |
2.20 |
|
DeviceProtocol |
string |
W |
Classification criterion. Protocol code assigned by USB-IF, expressed as a two-digit hexadecimal string
(e.g., Possible patterns:
|
- |
2.20 |
|
ProductID |
string |
W |
Classification criterion. Product ID assigned by the manufacturer, expressed as a two- to four-digit hexadecimal
string (e.g., Possible patterns:
|
- |
2.20 |
|
VendorID |
string |
W |
Classification criterion. Vendor ID assigned by USB-IF, expressed as a two- to four-digit hexadecimal string (e.g.,
Possible patterns:
|
- |
2.20 |
|
Interfaces |
string[] |
W |
Comma-separated list of strings. Each item defines an allowed USB interface in the format
'InterfaceClass:InterfaceSubClass:InterfaceProtocol', using two-digit hexadecimal values
(e.g., The A connected device is allowed only if all of its interfaces match entries in this list.
Example: An USB Device might expose two interfaces:
These can be allowed by listing both explicitly, or using patterns like
When empty, the device is not classified by Interfaces. Each list item matches one of:
|
- |
2.20 |
|
Device.MoCA. |
object |
R |
MoCA object that contains the Interface table [MoCAv1.0] [MoCAv1.1]. |
- |
2.0 |
|
Device.MoCA.Interface.{i}. |
object(0:) |
R |
MoCA interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of a MoCA interface [MoCAv1.0] [MoCAv1.1]. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.0 |
|
PrivacyEnabled |
boolean |
R |
[mocaIfPrivacyEnable/1.3.6.1.4.1.31621.1.2.1.1.1.7] Indicates whether link-layer security is enabled or disabled. This parameter is based on mocaIfPrivacyEnable from [MOCA11-MIB]. This parameter was DEPRECATED in 2.17 because it and PrivacyEnabledSetting are associated with the same underlying MIB object and it is therefore unnecessary. If implemented, it MUST return the same value as PrivacyEnabledSetting. This parameter was OBSOLETED in 2.19. This parameter was DELETED in 2.20. Changes since 2.19:
|
- |
2.0 |
|
BeaconPowerLimit |
unsignedInt |
W |
[mocaIfBeaconPowerBackoff/1.3.6.1.4.1.31621.1.2.1.1.1.5] [MocaDB] The value in dB by which to reduce the setting of the transmit power of the Beacon from the maximum transmit power (BEACON_PWR_BACKOFF Managed Parameter). The beacon transmit power SHALL only be changed when Status is not Up, which means the interface is not part of a MoCA network. If changed, the parameter may not take effect until the MoCA interface is restarted. This parameter is based on mocaIfBeaconPowerLimit from [MOCA11-MIB]. Note that this parameter maps to different MIB objects for MoCA 1.0/1.1 and MoCA 2.0. This parameter was DEPRECATED in 2.17 for MoCA 2.5. This parameter was OBSOLETED in 2.19. This parameter was DELETED in 2.20. The factory default value MUST be 0. Changes since 2.19:
|
- |
2.0 |
|
NodeDropNcChgTrap |
unsignedInt |
R |
[moca25TrapNodeDropNcChg/1.3.6.1.4.1.31621.1.3.0.11] This trap is sent when NodeDropTrapEn is true},, indicates that there is a NC change when the Node is Non-Secured Admitted Node. This parameter is a counter that is incremented whenever the event occurs. |
- |
2.17 |
|
Device.MoCA.Interface.{i}.AssociatedDevice.{i}. |
object(0:) |
R |
[mocaNodeTable/1.3.6.1.4.1.31621.1.2.1.11 mocaLinkStatsTable/1.3.6.1.4.1.31621.1.2.1.10] This table contains information about other MoCA devices currently associated with this MoCA interface. Entries in this table cannot be created or deleted by the network management system. All entries are created or deleted by the device software. At most one entry in this table can exist with a given value for MACAddress. |
- |
2.0 |
|
TxPowerControlReduction |
unsignedInt |
R |
[mocaNodeTxPowerReduction/1.3.6.1.4.1.31621.1.2.1.11.1.6] [MocaDB] The reduction in transmitter level due to power control. This parameter is based on mocaNodeTxPowerReduction from [MOCA11-MIB]. This parameter was DEPRECATED in 2.17 since it is replaced by Device.MoCA.Interface.{i}.Mesh.{i}.PowerReduction. See [MOCA20-MIB]. This parameter was OBSOLETED in 2.19. This parameter was DELETED in 2.20. Changes since 2.19:
|
- |
2.0 |
|
RxPowerLevel |
unsignedInt |
R |
[mocaNodeRxPower/1.3.6.1.4.1.31621.1.2.1.11.1.7] The power level (in dBm) received at the MoCA interface from this remote device. This parameter is based on mocaNodeRxPower from [MOCA11-MIB]. This parameter was DEPRECATED in 2.17 since it is replaced by Device.MoCA.Interface.{i}.Mesh.{i}.Power. See [MOCA20-MIB]. This parameter was OBSOLETED in 2.19. This parameter was DELETED in 2.20. Active Notification requests for this parameter MAY be denied. Changes since 2.19:
|
- |
2.0 |
|
RxSNR |
unsignedInt |
R |
[mocaNodeSNR/1.3.6.1.4.1.31621.1.2.1.11.1.14] [MocaDB] The signal to noise level received at this interface from this remote device. This parameter is based on mocaNodeSNR from [MOCA11-MIB]. This parameter was DEPRECATED in 2.17 since it is replaced by Device.MoCA.Interface.{i}.Mesh.{i}.RxSNR. See [MOCA20-MIB]. This parameter was OBSOLETED in 2.19. This parameter was DELETED in 2.20. Changes since 2.19:
|
- |
2.0 |
|
Device.HomePlug. |
object |
R |
HomePlug object that contains the Interface table. The HomePlug industry standard [HPAV1.1] defines peer to peer communication over powerline medium. |
- |
2.0 |
|
Device.HomePlug.Interface.{i}. |
object(0:) |
R |
HomePlug interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of a HomePlug interface [HPAV1.1]. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.0 |
|
Type |
string |
W |
The type of HomePlug interface. Enumeration of:
|
- |
2.20 |
|
Interface |
string |
W |
The value MUST be the Path Name of a row in the Ethernet.Link. or Logical.Interface. tables, or the Path Name of an interface layered above such a row, e.g., a row in the Logical.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The Layer 2 Ethernet Interface over which the network protocol operates, when the Type parameter is Logical. |
- |
2.20 |
|
Device.HomePlug.Interface.{i}.AssociatedDevice.{i}. |
object(0:) |
R |
This table contains information about other HomePlug devices connected to this HomePlug interface. At most one entry in this table can exist with a given value for MACAddress. Changes since 2.19:
|
- |
2.0 |
|
Manufacturer |
string(:64) |
R |
The manufacturer of the remote HomePlug device. |
- |
2.20 |
|
FirmwareVersion |
string |
R |
The firmware version of the remote HomePlug device. |
- |
2.20 |
|
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.19:
|
- |
2.0 |
|
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 |
|
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. |
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.AnticipatedChannels.{i}. |
object(0:) |
R |
This object contains a table of Wi-Fi 6 [802.11ax] operating classes, and channels within those operating classes, which have anticipated channel preference. Operating Class contains an enumerated value from [Table E-4/802.11ax]}.}}. At most one entry in this table can exist with a given value for OpClass. |
- |
2.15 |
|
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. Changes since 2.19:
|
- |
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. Changes since 2.19:
|
- |
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. Changes since 2.19:
|
- |
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. Changes since 2.19:
|
- |
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. Changes since 2.19:
|
- |
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. Changes since 2.19:
|
- |
2.15 |
|
Device.WiFi.DataElements.Network.Device.{i}.MultiAPDevice.Backhaul.Stats. |
object |
R |
This object represents the statistics of the backhaul interface view from the current Device's ID |
- |
2.15 |
|
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytes transmitted across the backhaul medium (as identified by the value of the BackhaulMediaType}} parameter), including framing characters.}} |
- |
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. Changes since 2.19:
|
- |
2.13 |
|
RadioTemplateRef |
string |
R |
The value MUST be the Path Name of a row in the Templates.RadioTemplate. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. RadioTemplateRef is a reference to the RadioTemplate selected for this Radio. |
- |
2.20 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}. |
object(0:) |
R |
A single logical BSS operating on this radio. At most one entry in this table can exist with a given value for BSSID. Changes since 2.19:
|
- |
2.13 |
|
BSSTemplateRef |
string |
R |
The value MUST be the Path Name of a row in the Templates.BSSTemplate. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. BSSTemplateRef is a reference to the BSSTemplate selected for this BSS. |
- |
2.20 |
|
SecurityTemplateRef |
string |
R |
The value MUST be the Path Name of a row in the Templates.SecurityTemplate. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. SecurityTemplateRef is a reference to the SecurityTemplate selected for this BSS. |
- |
2.20 |
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}. |
object(0:) |
R |
Object describing a single Associated Device (STA). At most one entry in this table can exist with a given value for MACAddress. |
- |
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. Changes since 2.19:
|
- |
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. Changes since 2.19:
|
- |
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. Changes since 2.19:
|
- |
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. Changes since 2.19:
|
- |
2.17 |
|
APMLDTemplateRef |
string |
R |
The value MUST be the Path Name of a row in the Templates.APMLDTemplate. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. APMLDTemplateRef is a reference to the APMLDTemplate selected for this APMLD. |
- |
2.20 |
|
Device.WiFi.DataElements.AssociationEvent. |
object |
R |
This object contains the events generated when a STA associates to a BSS. |
- |
2.13 |
|
AssociationEventDataNumberOfEntries |
unsignedInt |
R |
The number of entries in the AssociationEventData table. This parameter was DEPRECATED in 2.17 because a corresponding USP event is defined instead. This parameter was OBSOLETED in 2.19. This parameter was DELETED in 2.20. Changes since 2.19:
|
- |
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. Changes since 2.19:
|
- |
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 |
|
DisassociationEventDataNumberOfEntries |
unsignedInt |
R |
The number of entries in the DisassociationEventData table. This parameter was DEPRECATED in 2.17 because a corresponding USP event is defined instead. This parameter was OBSOLETED in 2.19. This parameter was DELETED in 2.20. Changes since 2.19:
|
- |
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. Changes since 2.19:
|
- |
2.13 |
|
Device.WiFi.DataElements.FailedConnectionEvent. |
object |
R |
This object contains the events generated when a Station (STA) fails to connect to a Basic Service Set (BSS). |
- |
2.15 |
|
FailedConnectionEventDataNumberOfEntries |
unsignedInt |
R |
The number of entries in the FailedConnectionEventData table. This parameter was DEPRECATED in 2.17 because a corresponding USP event is defined instead. This parameter was OBSOLETED in 2.19. This parameter was DELETED in 2.20. Changes since 2.19:
|
- |
2.15 |
|
Device.WiFi.DataElements.FailedConnectionEvent.FailedConnectionEventData.{i}. |
object(0:) |
R |
This object describes the data provided with a failed connection event 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. Changes since 2.19:
|
- |
2.15 |
|
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 |
|
BSSTemplateNumberOfEntries |
unsignedInt |
R |
The number of entries in the BSSTemplate table. |
- |
2.20 |
|
RadioTemplateNumberOfEntries |
unsignedInt |
R |
The number of entries in the RadioTemplate table. |
- |
2.20 |
|
SecurityTemplateNumberOfEntries |
unsignedInt |
R |
The number of entries in the SecurityTemplate table. |
- |
2.20 |
|
SecurityGroupNumberOfEntries |
unsignedInt |
R |
The number of entries in the SecurityGroup table. |
- |
2.20 |
|
APMLDTemplateNumberOfEntries |
unsignedInt |
R |
The number of entries in the APMLDTemplate table. |
- |
2.20 |
|
SSCTemplateNumberOfEntries |
unsignedInt |
R |
The number of entries in the SSCTemplate table. |
- |
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 |
|
Enable |
boolean |
W |
Indicates whether any BSS may be deployed in the Wi-Fi network.
|
- |
2.20 |
|
TopologyFlag |
string[] |
W |
The TopologyFlag is used to specify a list of EasyMesh Agents on which BSS(es) are deployed according to the template matching process. If an EasyMesh Agent does not match any value in the list, then no BSS is deployed on this EasyMesh Agent. These values refer to the network topology role of the EasyMesh Agent as determined by the EasyMesh Controller. This flag matches if any of the list items match (logical OR). Comma-separated list of strings. Each list item is an enumeration of:
|
- |
2.20 |
|
IEEE1905ALID |
string(:17)[] |
W |
[MACAddress] Comma-separated list of MAC Addresses. IEEE 1905 [IEEE1905.1a] Abstraction-Layer ID (ALID). This matches if any of the list items match (logical OR). This should match an entry in DataElements.Network.Device.{i}.ID. |
- |
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. Incicates 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 |
|
PrimarySSCTemplateID |
string |
R |
Indicates the Primary SSCTemplate. The value must be the SSCTemplate.{i}.SSCTemplateID to identify an instance of SSCTemplate. If this value is empty, then Traffic Separation is not used. [Section 19/EasyMesh]. |
- |
2.20 |
|
Device.WiFi.Templates.BSSTemplate.{i}. |
object(0:) |
W |
Table of Basic Service Set (BSS) templates for Wi-Fi 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 BSSTemplateID. |
- |
2.20 |
|
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.20 |
|
BSSTemplateID |
string |
WO |
Static and persistent ID element. At most one BSSTemplate instance can exist with a given value for BSSTemplateID. Once it's been set, this parameter is immutable. |
- |
2.20 |
|
Priority |
unsignedInt(:255) |
W |
This value indicates in which order the BSSTemplate are to be matched for a reported radio. 255 is the highest priority, 0 is the lowest priority. |
- |
2.20 |
|
RadioTemplateReference |
string |
W |
The value MUST be the Path Name of a row in the RadioTemplate. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This BSSTemplate is linked to RadioTemplateReference. |
- |
2.20 |
|
SSCTemplateReference |
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. This BSSTemplate is linked to SSCTemplateReference. |
- |
2.20 |
|
APMLDTemplateReference |
string |
W |
The value MUST be the Path Name of a row in the APMLDTemplate. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This BSSTemplate is linked to APMLDTemplateReference. |
- |
2.20 |
|
SecurityGroupReference |
string |
W |
The value MUST be the Path Name of a row in the SecurityGroup. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This BSSTemplate is linked to SecurityGroupReference. |
- |
2.20 |
|
LinkedRadioTemplateID |
string |
R |
Indicates the RadioTemplate.{i}.RadioTemplateID that is linked with this BSSTemplate. |
- |
2.20 |
|
LinkedSSCTemplateID |
string |
R |
Indicates the SSCTemplate.{i}.SSCTemplateID that is linked with this BSSTemplate. |
- |
2.20 |
|
LinkedAPMLDTemplateID |
string |
R |
Indicates the APMLDTemplate.{i}.APMLDTemplateID that is linked with this BSSTemplate. |
- |
2.20 |
|
LinkedSecurityGroupID |
string |
R |
Indicates the SecurityGroup.{i}.SecurityGroupID of the SecurityGroup.{i} in which a matching SecurityTemplate is searched. |
- |
2.20 |
|
TopologyFlag |
string[] |
W |
The topology flag is used to specify a list of EasyMesh Agents for which this BSSTemplate is considered by the Configuration Template Manager during the matching process. If an Agent does not match any value in the list, then no BSS matching this BSSTemplate is deployed on the EasyMesh Agent. These values refer to the network topology point of the EasyMesh Agent as determined by the EasyMesh Controller. This flag matches if any of the list items match (logical OR). Comma-separated list of strings. Each list item is an enumeration of:
|
- |
2.20 |
|
IEEE1905ALID |
string(:17)[] |
W |
[MACAddress] Comma-separated list of MAC Addresses. IEEE 1905 [IEEE1905.1a] Abstraction-Layer ID (ALID). This flag matches if any of the list items match (logical OR). This should match an entry in DataElements.Network.Device.{i}.ID. |
- |
2.20 |
|
MaxWLANHopLimitFlag |
unsignedInt(:255) |
W |
Indicates the maximum number of wireless hops (consecutive or not) allowed between the EasyMesh Controller and the EasyMesh Agent. In single-AP deployment, this flag is ignored. |
- |
2.20 |
|
SecureEquipmentFlag |
string |
W |
Indicates the 1905 Security of the EasyMesh Agent [Section 17.2.77/EasyMesh]. Enumeration of:
|
- |
2.20 |
|
Enable |
boolean |
W |
Determines if this template is considered by the Configuration Template Manager in the template matching process. |
- |
2.20 |
|
SSID |
string |
W |
The Service Set Identifier (SSID) used as an identifier by all deployed BSSs linked to this BSSTemplate. |
- |
2.20 |
|
KeyPassphrase |
string |
W |
The KeyPassphrase to be used by all deployed BSSs linked to this BSSTemplate. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.20 |
|
AdvertisementEnable |
boolean |
W |
Indicates if the SSID is advertised in beacons
|
- |
2.20 |
|
Device.WiFi.Templates.RadioTemplate.{i}. |
object(0:) |
W |
Table of RadioTemplates for Wi-Fi 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 RadioTemplateID. |
- |
2.20 |
|
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.20 |
|
RadioTemplateID |
string |
WO |
Static and persistent ID element. At most one RadioTemplate instance can exist with a given value for RadioTemplateID. Note that RadioTemplateID is not the same as DataElements.Network.Device.{i}.Radio.{i}.ID. Once it's been set, this parameter is immutable. |
- |
2.20 |
|
Priority |
unsignedInt(:255) |
W |
This value indicates in which order the RadioTemplate are to be matched for a radio under configuration. 255 is the highest priority, 0 is the lowest priority. |
- |
2.20 |
|
Enable |
boolean |
W |
Determines if this RadioTemplate is considered by the Configuration Template Manager (CTM) in the template matching process. This value is independent from the value of any Radio.{i}.Enable. This value is also independent from the value of any DataElements.Network.Device.{i}.Radio.{i}.Enabled. |
- |
2.20 |
|
OpClassFlag |
unsignedInt(:255)[] |
W |
Comma-separated list of unsigned integers (up to 255). Each list item is a global valid operating class as defined in [Table E-4/802.11ax]). Indicates the Operating Classes the Radio can operate on. Exactly one of OpClassFlag or BandFlag must be empty and exactly one must be filled in. A Radio must be able to operate on at least one channel of each Operating Class specified in this list to satisfy this condition. |
- |
2.20 |
|
BandFlag |
string[] |
W |
Indicates frequency bands the Radio can operate on. All listed UNII bands are to be in the same 2.4, 5 or 6 GHz band. Exactly one of OpClassFlag or BandFlag must be empty. Comma-separated list of strings. Each list item is an enumeration of:
|
- |
2.20 |
|
SupportedGenerationFlag |
unsignedInt(1:255)[] |
W |
Comma-separated list of unsigned integers (1 to 255). Each list item indicates a supported Wi-Fi Generation. Each list item indicates a Supported Generation of Generational Capabilities Indication attribute. For example SupportedGenerationFlag could be "5,6,7". |
- |
2.20 |
|
DFSSupportFlag |
string |
W |
Indicates Dynamic Frequency Selection (DFS) support. Enumeration of:
|
- |
2.20 |
|
AFCSupportFlag |
string |
W |
Indicates Automated Frequency Coordination (AFC) support. Enumeration of:
|
- |
2.20 |
|
TransmitPowerLimit |
int(-128:127) |
W |
This is the upper limit on nominal transmit Equivalent Isotropically Radiated Power (EIRP) that this radio is allowed to use for the current operating class. In units of decibels relative to 1 mW dBm. |
- |
2.20 |
|
OperatingGeneration |
string[] |
W |
Comma-separated list of strings. Each list item indicates a Wi-Fi Generation deployed on this EasyMesh Agent or this device. The last list item may be followed by a "+" to indicate the inclusion of any existing Wi-Fi Generation above it. If an EasyMesh agent or device supports a Wi-Fi Generation not in the list, then that Wi-Fi Generation is disabled on the EasyMesh agent or device. For example, "6,7+" means Wi-Fi 6, Wi-Fi 7 and any newer Wi-Fi Generation. Note: OperatingGeneration may include Wi-Fi Generations not supported by a radio to which this RadioTemplate is deployed. |
- |
2.20 |
|
Device.WiFi.Templates.SecurityTemplate.{i}. |
object(0:) |
W |
Table of SecurityTemplates for Wi-Fi configuration [WPA3v3.0]. 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 |
|
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.20 |
|
SecurityTemplateID |
string |
WO |
Static and persistent ID element. At most one SecurityTemplate instance can exist with a given value for SecurityTemplateID. Once it's been set, this parameter is immutable. |
- |
2.20 |
|
Enable |
boolean |
W |
Determines if this template is considered by the Configuration Template Manager in the template matching process. |
- |
2.20 |
|
Priority |
unsignedInt(:255) |
W |
This value indicates in which order the SecurityTemplate are to be matched. 255 is the highest priority, 0 is the lowest priority. |
- |
2.20 |
|
RSNOSupportFlag |
string |
W |
Indicates support for Robust Security Network (RSN) Overriding (RSNO). RSN Overriding (RSNO) is also known as MRSNO and is used in WPA3-Personal Compatibility Mode. Enumeration of:
|
- |
2.20 |
|
SupportedAKMSuiteFlag |
string[] |
W |
Comma-separated list of strings. Authentication and Key Management (AKM) suite selector. Only the listed enumeration values are allowed in this string. Each list item is an enumeration of:
|
- |
2.20 |
|
SupportedAKMSuiteSelectorFlag |
hexBinary(4)[] |
W |
Comma-separated list of Hex binarys (length 4). AKM suite selector, the 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]. SupportedAKMSuiteSelectorFlag applies if SupportedAKMSuiteFlag includes value "SuiteSelector". |
- |
2.20 |
|
OperatingGenerationFlag |
unsignedInt(1:255)[] |
W |
Comma-separated list of unsigned integers (1 to 255). The AP advertises support in its beacon frames for each Wi-Fi generation in this list for this flag to match. For example OperatingGenerationFlag could be "5,6,7". |
- |
2.20 |
|
SecurityIEs |
hexBinary |
W |
Concatenation of all BSS Security related IEs with Element IDs, without delimiters as hex encoded octets [EasyMesh]. Note that this SecurityIEs and the RSNE, RSNOE, RSNO2E, RSNXE, RSNXOE objects are independent and may be set separately. If this SecurityIEs is not empty, the Configuration Template Manager (CTM) uses the value of this SecurityIEs and ignores the content of the RSNE/RSNOE/RSNO2E/RSNXE/RSNXOE objects. |
- |
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 |
|
GroupDataCipherSuite |
string |
W |
Cipher suite selector used to protect group addressed data frames. This is the name of a cipher suite, as defined in [Table 9-149/802.11-2020]. The following is an example value: "CCMP-128". |
- |
2.20 |
|
PairwiseCipherSuite |
string[] |
W |
Comma-separated list of strings. Each list item is a cipher suite selector used to protect individually addressed Data frames, as defined in [Table 9-149/802.11-2020]. The following is an example value: "CCMP-128". |
- |
2.20 |
|
AKMSuite |
string[] |
W |
Authentication and Key Management (AKM) suite [Table 9-151/802.11-2020]. Comma-separated list of strings. Each list item is an enumeration of:
|
- |
2.20 |
|
AKMSuiteSelector |
hexBinary(4)[] |
W |
Comma-separated list of Hex binarys (length 4). AKM suite selector, the 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]. AKMSuiteSelector applies if AKMSuite includes value "SuiteSelector". |
- |
2.20 |
|
MFP |
string |
W |
Indicates the expected support for Management Frame Protection (MFP), aka Protected Management Frame (PMF). [WPA3v3.0] and see also the WPA3 and Wi-Fi Enhanced Open Deployment Guide v1.1.pdf, Table 3, row PMF. Enumeration of:
|
- |
2.20 |
|
GroupManagementCipherSuite |
string |
W |
Cipher suite selector used to protect group addressed robust Management frames. This is the name of a cipher suite, as defined in [Table 9-149/802.11-2020]. The following is an example value: "BIP-CMAC-128". |
- |
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 |
|
GroupDataCipherSuite |
string |
W |
Cipher suite selector used to protect group addressed data frames. This is the name of a cipher suite, as defined in [Table 9-149/802.11-2020]. The following is an example value: "CCMP-128". |
- |
2.20 |
|
PairwiseCipherSuite |
string[] |
W |
Comma-separated list of strings. Each list item is a cipher suite selector used to protect individually addressed Data frames, as defined in [Table 9-149/802.11-2020]. The following is an example value: "CCMP-128". |
- |
2.20 |
|
AKMSuite |
string[] |
W |
Authentication and Key Management (AKM) suite [Table 9-151/802.11-2020]. Comma-separated list of strings. Each list item is an enumeration of:
|
- |
2.20 |
|
AKMSuiteSelector |
hexBinary(4)[] |
W |
Comma-separated list of Hex binarys (length 4). AKM suite selector, the 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]. AKMSuiteSelector applies if AKMSuite includes value "SuiteSelector". |
- |
2.20 |
|
MFP |
string |
W |
Indicates the expected support for Management Frame Protection (MFP), aka Protected Management Frame (PMF). [WPA3v3.0] and see also the WPA3 and Wi-Fi Enhanced Open Deployment Guide v1.1.pdf, Table 3, row PMF. Enumeration of:
|
- |
2.20 |
|
GroupManagementCipherSuite |
string |
W |
Cipher suite selector used to protect group addressed robust Management frames. This is the name of a cipher suite, as defined in [Table 9-149/802.11-2020]. The following is an example value: "BIP-CMAC-128". |
- |
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 |
|
GroupDataCipherSuite |
string |
W |
Cipher suite selector used to protect group addressed data frames. This is the name of a cipher suite, as defined in [Table 9-149/802.11-2020]. The following is an example value: "CCMP-128". |
- |
2.20 |
|
PairwiseCipherSuite |
string[] |
W |
Comma-separated list of strings. Each list item is a cipher suite selector used to protect individually addressed Data frames, as defined in [Table 9-149/802.11-2020]. The following is an example value: "CCMP-128". |
- |
2.20 |
|
AKMSuite |
string[] |
W |
Authentication and Key Management (AKM) suite [Table 9-151/802.11-2020]. Comma-separated list of strings. Each list item is an enumeration of:
|
- |
2.20 |
|
AKMSuiteSelector |
hexBinary(4)[] |
W |
Comma-separated list of Hex binarys (length 4). AKM suite selector, the 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]. AKMSuiteSelector applies if AKMSuite includes value "SuiteSelector". |
- |
2.20 |
|
MFP |
string |
W |
Indicates the expected support for Management Frame Protection (MFP), aka Protected Management Frame (PMF). [WPA3v3.0] and see also the WPA3 and Wi-Fi Enhanced Open Deployment Guide v1.1.pdf, Table 3, row PMF. Enumeration of:
|
- |
2.20 |
|
GroupManagementCipherSuite |
string |
W |
Cipher suite selector used to protect group addressed robust Management frames. This is the name of a cipher suite, as defined in [Table 9-149/802.11-2020]. The following is an example value: "BIP-CMAC-128". |
- |
2.20 |
|
Device.WiFi.Templates.SecurityTemplate.{i}.RSNXE. |
object |
R |
This object indicates the value the BSS transmits in the RSNXE element. This object is only used by the Configuration Template Manager if the SecurityIEs is empty. |
- |
2.20 |
|
SAEH2E |
boolean |
W |
Indicates if the BSS will support Simultaneous Authentication of Equals (SAE) hash-to-element true, or not false. true: BSS sets SAE hash-to-element to 1. false: BSS sets SAE hash-to-element to 0. |
- |
2.20 |
|
Device.WiFi.Templates.SecurityTemplate.{i}.RSNXOE. |
object |
R |
This object indicates the value the BSS transmits in the RSNXOE element. This object is only used by the Configuration Template Manager if the SecurityIEs is empty. |
- |
2.20 |
|
SAEH2E |
boolean |
W |
Indicates if the BSS will support Simultaneous Authentication of Equals (SAE) hash-to-element true, or not false. true: BSS sets SAE hash-to-element to 1. false: BSS sets SAE hash-to-element to 0. |
- |
2.20 |
|
Device.WiFi.Templates.SecurityGroup.{i}. |
object(0:) |
W |
Table of SecurityGroups for Wi-Fi configuration [WPA3v3.0]. 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 |
|
SecurityGroupID |
string |
W |
This is the friendly name of this SecurityGroup which may be advertised to the end user in a graphical interface. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.20 |
|
SecurityTemplateReferences |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the SecurityTemplate. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Indicates the list of SecurityTemplate for this SecurityGroup. |
- |
2.20 |
|
LinkedSecurityTemplateID |
string[] |
R |
Comma-separated list of strings. Indicates the SecurityTemplate.{i}.SecurityTemplateID in this entry of this SecurityGroup. |
- |
2.20 |
|
Device.WiFi.Templates.APMLDTemplate.{i}. |
object(0:) |
W |
Table of AP Multi-Link Device (MLD) templates (APMLDTemplate) for Wi-Fi configuration [Section 17.2.96, Agent AP MLD Configuration TLV/EasyMesh]. 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 APMLDTemplateID. |
- |
2.20 |
|
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.20 |
|
APMLDTemplateID |
string |
WO |
Static and persistent ID element. At most one APMLDTemplate instance can exist with a given value for APMLDTemplateID. Once it's been set, this parameter is immutable. |
- |
2.20 |
|
MLOEnable |
boolean |
W |
Indicates whether or not Multi-Link Operation (MLO) is enabled. If set to false, then MLO support is disabled and each deployment of a BSSTemplate related to this APMLDTemplate results in an AP MLD with a single affiliated AP. However, this does not disable the BSSs that are in the BSSTemplate.{i} linked to this APMLDTemplate. |
- |
2.20 |
|
STREnable |
boolean |
W |
Indicates whether or not Simultaneous Transmit and Receive (STR) mode is to be enabled on the AP MLD. |
- |
2.20 |
|
NSTREnable |
boolean |
W |
Indicates whether or not Non-Simultaneous Transmit and Receive (NSTR) mode is to be enabled on the AP MLD. |
- |
2.20 |
|
EMLSREnable |
boolean |
W |
Indicates whether or not Enhanced Multi-Link Single-Radio (EMLSR) mode is to be enabled on the AP MLD. |
- |
2.20 |
|
EMLMREnable |
boolean |
W |
Indicates whether or not Enhanced Multi-Link Multi-Radio (EMLMR) mode is to be enabled on the AP MLD. |
- |
2.20 |
|
TIDToLinkMapNegotiation |
boolean |
W |
Indicates whether the TID-to-link Mapping Negotiation Support subfield in the MLD Capabilities and Operations field of the Basic Multi-Link element is (to be) enabled by any deployed AP MLD linked to this APMLDTemplate. |
- |
2.20 |
|
Device.WiFi.Templates.SSCTemplate.{i}. |
object(0:) |
W |
Table of Service Set Collection (SSC) templates (SSCTemplate) for Wi-Fi 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 SSCTemplateID. |
- |
2.20 |
|
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.20 |
|
SSCTemplateID |
string |
WO |
Static and persistent ID element. At most one SSCTemplate instance can exist with a given value for SSCTemplateID. Once it's been set, this parameter is immutable. |
- |
2.20 |
|
SSCEnable |
boolean |
W |
If set to false, then all BSSs that are linked with this SSCTemplate are disabled, which means that these BSSs cease to offer service. |
- |
2.20 |
|
VID |
unsignedInt(:4095) |
W |
The VLAN ID (VID) for all BSSs that are part of this SSCTemplate. A value of 0 indicates that no VLAN shall be configured on the BSSs belonging to this SSCTemplate. |
- |
2.20 |
|
HaulType |
string[] |
W |
Indicates the use of the BSSs that are part of this SSCTemplate. Comma-separated list of strings. Each list item is an enumeration of:
|
- |
2.20 |
|
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.19:
|
- |
2.0 |
|
PowerCapability |
string[] |
R |
Comma-separated list of strings. Describes the possible power states of the Radio regardless of its current administrative state. Each list item is an enumeration of:
|
- |
2.20 |
|
PowerStatus |
string |
R |
Reports the current power status of the Radio. The value MUST be a member of the list reported by the PowerCapability parameter, or else be Error. Each list item is an enumeration of:
|
- |
2.20 |
|
RegulatoryDomain |
string(3) |
W |
The 802.11d Regulatory Domain. First two octets are [ISO3166-1] two-character country code. The third octet is either " " (all environments), "O" (outside) or "I" (inside). If the instance of this Device is the same as Device.WiFi.DataElements.Network.Device.{i}., then the first two octets of this parameter isare the same as Device.WiFi.DataElements.Network.Device.{i}.CountryCode. Possible patterns:
|
- |
2.0 |
|
ConfiguredReceiveAntennas |
int(-1,0:255) |
W |
The bit pattern of the configured receive antennas that need to be activated. This parameter uses a bitmap to specify which receive antennas need to be enabled. Each bit in the unsigned integer corresponds to a specific antenna. If a bit is set to '1', the corresponding antenna is activated for reception. If a bit is set to '0', the antenna is deactivated. How the Bitmap Works:
Examples:
The value MUST be within the range of SupportedReceiveAntennas, meaning you cannot attempt to activate an antenna that is not physically supported by the device. Valid values are: -1 (A value of -1 indicates the automatic selection of the receive antennas), or 0 to 255. |
- |
2.20 |
|
ConfiguredTransmitAntennas |
int(-1,0:255) |
W |
The bit pattern of the configured transmit antennas that need to be activated. This parameter uses a bitmap to specify which receive antennas need to be enabled. Each bit in the unsigned integer corresponds to a specific antenna. If a bit is set to '1', the corresponding antenna is activated for reception. If a bit is set to '0', the antenna is deactivated. How the Bitmap Works:
Examples:
The value MUST be within the range of SupportedReceiveAntennas, meaning you cannot attempt to activate an antenna that is not physically supported by the device. Valid values are: -1 (A value of -1 indicates the automatic selection of the transmit antennas), or 0 to 255. |
- |
2.20 |
|
SupportedReceiveAntennas |
int(0:8,-1) |
R |
Specifies the maximum number of antennas, used for receiving on this radio. Valid values are: 0 to 8, or -1 (A value of -1 means that this feature is not supported). |
- |
2.20 |
|
SupportedTransmitAntennas |
int(0:8,-1) |
R |
Specifies the maximum number of antennas, used for receiving on this radio. Valid values are: 0 to 8, or -1 (A value of -1 means that this feature is not supported). |
- |
2.20 |
|
ActiveReceiveAntennas |
int(0:255,-1) |
R |
The bit pattern of the receive antennas actively in use. This parameter uses a bitmap to specify which receive antennas are enabled. Each bit in the unsigned integer corresponds to a specific antenna. If a bit is set to '1', the corresponding antenna is activated for reception. If a bit is set to '0', the antenna is deactivated. Valid values are: 0 to 255, or -1 (A value of -1 means that this feature is not supported). |
- |
2.20 |
|
ActiveTransmitAntennas |
int(0:255,-1) |
R |
The bit pattern of the transmit antennas actively in use. This parameter uses a bitmap to specify which transmit antennas are enabled. Each bit in the unsigned integer corresponds to a specific antenna. If a bit is set to '1', the corresponding antenna is activated for reception. If a bit is set to '0', the antenna is deactivated. Valid values are: 0 to 255, or -1 (A value of -1 means that this feature is not supported). |
- |
2.20 |
|
Device.WiFi.NeighboringWiFiDiagnostic. |
object |
R |
This object defines access to other WiFi SSIDs that this device is able to receive. |
- |
2.7 |
|
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}. |
object(0:) |
R |
Neighboring SSID table. This table models other WiFi SSIDs that this device is able to receive. At most one entry in this table can exist with a given value for BSSID. |
- |
2.7 |
|
SecurityModeEnabled |
string |
R |
The type of encryption the neighboring WiFi SSID advertises. The WEP value indicates either WEP-64 or WEP-128. The WPA value is the same as WPA-Personal. The WPA2 value is the same as WPA2-Personal. The WPA-WPA2 value is the same as WPA-WPA2-Personal. The WPA3-SAE value is the same as WPA3-Personal. The WPA2-PSK-WPA3-SAE value is the same as WPA3-Personal-Transition. The WPA2-PSK-WPA3-SAE-RSNO value is the same as WPA3-Personal-Compatibility. Enumeration of:
Changes since 2.19:
|
- |
2.7 |
|
EncryptionMode |
string[] |
R |
Comma-separated list of strings. The type of encryption the neighboring WiFi SSID advertises. When SecurityModeEnabled is one of WPA3-SAE, WPA2-PSK-WPA3-SAE, or WPA2-PSK-WPA3-SAE-RSNO, or WPA3-Enterprise, TKIP is not valid, and should not be in the list. Each list item is an enumeration of:
|
- |
2.7 |
|
Device.WiFi.Radio.{i}.Capabilities. |
object |
R |
This object represents the capabilities of the radio which may be different from the current operational configuration. |
- |
2.20 |
|
Device.WiFi.Radio.{i}.Capabilities.WiFi7APRole. |
object |
R |
This object describes the Wi-Fi 7 capabilities for the AP role. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV. |
- |
2.20 |
|
EMLMRSupport |
boolean |
R |
Indicates if the Enhanced Multi-Link Multi-Radio (EMLMR) operation is supported. |
- |
2.20 |
|
EMLSRSupport |
boolean |
R |
Indicates if Enhanced Multi-Link Single-Radio (EMLSR) operation is supported. |
- |
2.20 |
|
STRSupport |
boolean |
R |
Indicates if Simultaneous Transmit and Receive (STR) operation is supported. |
- |
2.20 |
|
NSTRSupport |
boolean |
R |
Indicates if Non-Simultaneous Transmit and Receive (NSTR) operation is supported. |
- |
2.20 |
|
TIDLinkMapNegotiation |
boolean |
R |
Indicates if Traffic Identifier (TID) to Link Mapping Negotiation is supported. |
- |
2.20 |
|
EMLMRFreqSeparationNumberOfEntries |
unsignedInt |
R |
The number of entries in the EMLMRFreqSeparation table. |
- |
2.20 |
|
EMLSRFreqSeparationNumberOfEntries |
unsignedInt |
R |
The number of entries in the EMLSRFreqSeparation table. |
- |
2.20 |
|
STRFreqSeparationNumberOfEntries |
unsignedInt |
R |
The number of entries in the STRFreqSeparation table. |
- |
2.20 |
|
NSTRFreqSeparationNumberOfEntries |
unsignedInt |
R |
The number of entries in the NSTRFreqSeparation table. |
- |
2.20 |
|
Device.WiFi.Radio.{i}.Capabilities.WiFi7APRole.EMLMRFreqSeparation.{i}. |
object(0:) |
R |
This object describes the required frequency separation from the specified radio RUID for MLO Enhanced Multi-Link Multi-Radio (EMLMR) operation. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV. At most one entry in this table can exist with a given value for RUID. |
- |
2.20 |
|
RUID |
base64 |
R |
The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies. |
- |
2.20 |
|
FreqSeparation |
unsignedInt |
R |
Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (FreqSeparation - 1) x 80 MHz. |
- |
2.20 |
|
Device.WiFi.Radio.{i}.Capabilities.WiFi7APRole.EMLSRFreqSeparation.{i}. |
object(0:) |
R |
This object describes the required frequency separation from the specified radio RUID for MLO Enhanced Multi-Link Single-Radio (EMLSR) operation. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV. At most one entry in this table can exist with a given value for RUID. |
- |
2.20 |
|
RUID |
base64 |
R |
The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies. |
- |
2.20 |
|
FreqSeparation |
unsignedInt |
R |
Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (FreqSeparation - 1) x 80 MHz. |
- |
2.20 |
|
Device.WiFi.Radio.{i}.Capabilities.WiFi7APRole.STRFreqSeparation.{i}. |
object(0:) |
R |
This object describes the required frequency separation from the specified radio RUID for MLO Simultaneous Transmit and Receive (STR) operation. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV. At most one entry in this table can exist with a given value for RUID. |
- |
2.20 |
|
RUID |
base64 |
R |
The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies. |
- |
2.20 |
|
FreqSeparation |
unsignedInt |
R |
Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (FreqSeparation - 1) x 80 MHz. |
- |
2.20 |
|
Device.WiFi.Radio.{i}.Capabilities.WiFi7APRole.NSTRFreqSeparation.{i}. |
object(0:) |
R |
This object describes the required frequency separation from the specified radio RUID for MLO Non-Simultaneous Transmit and Receive (NSTR) operation. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV. At most one entry in this table can exist with a given value for RUID. |
- |
2.20 |
|
RUID |
base64 |
R |
The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies. |
- |
2.20 |
|
FreqSeparation |
unsignedInt |
R |
Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (FreqSeparation - 1) x 80 MHz. |
- |
2.20 |
|
Device.WiFi.Radio.{i}.Capabilities.WiFi7STARole. |
object |
R |
This object describes the Wi-Fi 7 capabilities for the backhaul Station (bSTA) role. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV. |
- |
2.20 |
|
EMLMRSupport |
boolean |
R |
Indicates if the Enhanced Multi-Link Multi-Radio (EMLMR) operation is supported. |
- |
2.20 |
|
EMLSRSupport |
boolean |
R |
Indicates if Enhanced Multi-Link Single-Radio (EMLSR) operation is supported. |
- |
2.20 |
|
STRSupport |
boolean |
R |
Indicates if Simultaneous Transmit and Receive (STR) operation is supported. |
- |
2.20 |
|
NSTRSupport |
boolean |
R |
Indicates if Non-Simultaneous Transmit and Receive (NSTR) operation is supported. |
- |
2.20 |
|
TIDLinkMapNegotiation |
boolean |
R |
Indicates if Traffic Identifier (TID) to Link Mapping Negotiation is supported. |
- |
2.20 |
|
EMLMRFreqSeparationNumberOfEntries |
unsignedInt |
R |
The number of entries in the EMLMRFreqSeparation table. |
- |
2.20 |
|
EMLSRFreqSeparationNumberOfEntries |
unsignedInt |
R |
The number of entries in the EMLSRFreqSeparation table. |
- |
2.20 |
|
STRFreqSeparationNumberOfEntries |
unsignedInt |
R |
The number of entries in the STRFreqSeparation table. |
- |
2.20 |
|
NSTRFreqSeparationNumberOfEntries |
unsignedInt |
R |
The number of entries in the NSTRFreqSeparation table. |
- |
2.20 |
|
Device.WiFi.Radio.{i}.Capabilities.WiFi7STARole.EMLMRFreqSeparation.{i}. |
object(0:) |
R |
This object describes the required frequency separation from the specified radio RUID for MLO Enhanced Multi-Link Multi-Radio (EMLMR) operation. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV. At most one entry in this table can exist with a given value for RUID. |
- |
2.20 |
|
RUID |
base64 |
R |
The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies. |
- |
2.20 |
|
FreqSeparation |
unsignedInt |
R |
Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (FreqSeparation - 1) x 80 MHz. |
- |
2.20 |
|
Device.WiFi.Radio.{i}.Capabilities.WiFi7STARole.EMLSRFreqSeparation.{i}. |
object(0:) |
R |
This object describes the required frequency separation from the specified radio RUID for MLO Enhanced Multi-Link Single-Radio (EMLSR) operation. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV. At most one entry in this table can exist with a given value for RUID. |
- |
2.20 |
|
RUID |
base64 |
R |
The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies. |
- |
2.20 |
|
FreqSeparation |
unsignedInt |
R |
Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (FreqSeparation - 1) x 80 MHz. |
- |
2.20 |
|
Device.WiFi.Radio.{i}.Capabilities.WiFi7STARole.STRFreqSeparation.{i}. |
object(0:) |
R |
This object describes the required frequency separation from the specified radio RUID for MLO Simultaneous Transmit and Receive (STR) operation. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV. At most one entry in this table can exist with a given value for RUID. |
- |
2.20 |
|
RUID |
base64 |
R |
The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies. |
- |
2.20 |
|
FreqSeparation |
unsignedInt |
R |
Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (FreqSeparation - 1) x 80 MHz. |
- |
2.20 |
|
Device.WiFi.Radio.{i}.Capabilities.WiFi7STARole.NSTRFreqSeparation.{i}. |
object(0:) |
R |
This object describes the required frequency separation from the specified radio RUID for MLO Non-Simultaneous Transmit and Receive (NSTR) operation. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV. At most one entry in this table can exist with a given value for RUID. |
- |
2.20 |
|
RUID |
base64 |
R |
The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies. |
- |
2.20 |
|
FreqSeparation |
unsignedInt |
R |
Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (FreqSeparation - 1) x 80 MHz. |
- |
2.20 |
|
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.19:
|
- |
2.0 |
|
MTU |
unsignedInt |
W |
Maximum Transmission Unit for this interface (expressed in bytes). |
- |
2.20 |
|
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]. Changes since 2.19:
|
- |
2.0 |
|
ModesSupported |
string[] |
R |
Comma-separated list of strings. Indicates which security modes this AccessPoint instance is capable of supporting. The WPA3-Personal value is the same as WPA3-SAE. The WPA3-Personal-Transition value is the same as WPA2-PSK-WPA3-SAE. The WPA3-Personal-Compatibility value is the same as WPA2-PSK-WPA3-SAE-RSNO. Each list item is an enumeration of:
Changes since 2.19:
|
- |
2.0 |
|
SAEGroupDependantHashEnable |
string |
W |
Enable SAE with group dependant hash usage in WPA3 security modes. This flag enables or disables the use of SAE with group dependant hash instead of simple SAE applicable when ModeEnabled is set to WPA3-Personal, WPA3-Personal-Transition, or WPA3-Enterprise. If SAEGroupDependantHashEnable is set to Disabled, then only AKM8 shall be used. If it is set to Transition, then both AKM8 and AKM24 shall be used. Finally, if SAEGroupDependantHashEnable is set to Enabled, then only AKM24 shall be used. Enabled is invalid when ModeEnabled is set to WPA3-Personal-Transition. Enumeration of:
|
Transition |
2.20 |
|
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.WiFi.EndPoint.{i}. |
object(0:) |
W |
This object models an 802.11 connection from the perspective of a wireless end point. Each EndPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter, and an associated active Profile instance via the ProfileReference parameter. The active profile is responsible for specifying the actual SSID and security settings used by the end point. For enabled table entries, if SSIDReference or ProfileReference is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The EndPoint table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated EndPoint row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending EndPoint row. At most one entry in this table (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.EndPoint.{i}.Security. |
object |
R |
This object contains security related parameters that apply to a WiFi end point [802.11-2007]. |
- |
2.0 |
|
ModesSupported |
string[] |
R |
Comma-separated list of strings. Indicates which security modes this EndPoint instance is capable of supporting. Each list item is an enumeration of:
Changes since 2.19:
|
- |
2.0 |
|
Device.WiFi.EndPoint.{i}.Profile.{i}. |
object(0:) |
W |
EndPoint Profile table. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of SSID, Location and Priority. |
- |
2.0 |
|
Device.WiFi.EndPoint.{i}.Profile.{i}.Security. |
object |
R |
This object contains security related parameters that apply to a WiFi End Point profile [802.11-2007]. Changes since 2.19:
|
- |
2.0 |
|
SAEGroupDependantHashEnable |
string |
W |
Enable SAE with group dependant hash usage in WPA3 security modes. This flag enables or disables the use of SAE with group dependant hash instead of simple SAE applicable when ModeEnabled is set to WPA3-Personal, WPA3-Personal-Transition, or WPA3-Enterprise. If SAEGroupDependantHashEnable is set to Disabled, then only AKM8 shall be used. If it is set to Transition, then both AKM8 and AKM24 shall be used. Finally, if SAEGroupDependantHashEnable is set to Enabled, then only AKM24 shall be used. Enabled is invalid when ModeEnabled is set to WPA3-Personal-Transition. Enumeration of:
|
Transition |
2.20 |
|
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.19:
|
- |
2.19 |
|
PowerCapability |
string[] |
R |
Comma-separated list of strings. Describes the possible power states of the Radio regardless of its current administrative state. Each list item is an enumeration of:
|
- |
2.20 |
|
PowerStatus |
string |
R |
Reports the current power status of the Radio. The value MUST be a member of the list reported by the PowerCapability parameter, or else be Error. Each list item is an enumeration of:
|
- |
2.20 |
|
Device.IP. |
object |
R |
IP object that contains the Interface, ActivePort, and Diagnostics objects. |
- |
2.0 |
|
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]. Files received in the IP Layer Capacity test do not require file storage on the CPE device. If AuthenticationEnabled is set to true, one of the following combinations of AuthenticationCode, AuthenticationAlias 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 AuthenticationAlias are provided but AuthenticationKeyFileLocation is not provided, the client uses the AuthenticationCode as the key and the AuthenticationAlias as key ID. The IPLayerCapacityAuthCode table is ignored. If only AuthenticationAlias is provided, the client uses the IPLayerCapacityAuthCode table to derive the IPLayerCapacityAuthCode.{i}.Alias to use as key ID, and the IPLayerCapacityAuthCode.{i}.AuthenticationKey as the key. If both AuthenticationAlias and AuthenticationKeyFileLocation are provided, but AuthenticationCode is not provided, the client uses the AuthenticationAlias as key ID along with AuthenticationKeyFileLocation as file location. The IPLayerCapacityAuthCode table is ignored. If only AuthenticationAlias is provided, and the IPLayerCapacityAuthCode does not contain the AuthenticationAlias, the client returns an error. If only AuthenticationKeyFileLocation is provided, the file specified MUST contain a single entry. Otherwise, the client returns an error. |
- |
2.14 |
|
Host |
string(:256) |
W |
The Fully Qualified Domain Name (FQDN) or IP address of the Test Endpoint to perform the UDP Capacity tests with. This parameter was DEPRECATED in 2.17 because it is superseded by ServerList with multi-flow and server capability. Refer to [TR-471] for details. This parameter was OBSOLETED in 2.19. This parameter was DELETED in 2.20. Changes since 2.19:
|
- |
2.14 |
|
Port |
unsignedInt(1:65535) |
W |
Port on the Test Endpoint host. This parameter was DEPRECATED in 2.17 because it is superseded by ServerList with multi-flow and server capability. Refer to [TR-471] for details. This parameter was OBSOLETED in 2.19. This parameter was DELETED in 2.20. Active Notification requests for this parameter MAY be denied. Changes since 2.19:
|
- |
2.14 |
|
NumberOfConnections |
unsignedInt(1:) |
W |
The number of connections to be used in the test. The default value SHOULD be 1. NumberOfConnections MUST NOT be set to a value greater than IPLayerMaxConnections. This parameter was DEPRECATED in 2.17 because it is superseded by ServerList with multi-flow and server capability and related parameters. Refer to [TR-471] for details. This parameter was OBSOLETED in 2.19. This parameter was DELETED in 2.20. Changes since 2.19:
|
- |
2.14 |
|
Device.IP.Diagnostics.IPLayerCapacityMetrics.IncrementalResult.{i}. |
object(0:) |
R |
Results for time segmented tests (tests where NumberTestSubIntervals > 1). This data is calculated across all connections in the test. A new object is created every TestSubInterval after that interval has completed. Instance numbers MUST start at 1 and sequentially increment as new instances are created. All instances are removed when new test is started or results are otherwise cleared. |
- |
2.14 |
|
IPLayerCapacity |
decimal |
R |
Results of measurements using the maximum IP-Layer Capacity metric calculation for a single interval from [TR-471] Equation 1, for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. Result is expressed in Mbps with 2 digits beyond the decimal. 106 bits/second = 1 Mbps. |
- |
2.14 |
|
TimeOfSubInterval |
dateTime |
R |
Time in UTC of end of sub-interval when IPLayerCapacity was measured. Value MUST be specified to TimestampResolution precision. For example: 2008-04-09T15:01:05.123456Z Active Notification requests for this parameter MAY be denied. |
- |
2.14 |
|
LossRatio |
decimal |
R |
Ratio of lost packets to total packets, for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. This value is expressed as a decimal to 9 decimal digits. |
- |
2.14 |
|
RTTRange |
decimal |
R |
The range of Round Trip Time (RTT), for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. See [TR-471] for description of how value is calculated. This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. |
- |
2.14 |
|
PDVRange |
decimal |
R |
The range of Packet Delay Variation (PDV), for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. See [TR-471] for description of how value is calculated. This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. |
- |
2.14 |
|
MinOnewayDelay |
decimal |
R |
The minimum one-way delay, for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. The minimum one-way delay is calculated at the conclusion of the test and SHALL be calculated using the conditional distribution of all packets with a finite one-way delay value (undefined delays are excluded). This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. |
- |
2.14 |
|
ReorderedRatio |
decimal |
R |
Ratio of reordered packets to total packets, for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. This value is expressed as a decimal to 9 decimal digits. |
- |
2.14 |
|
ReplicatedRatio |
decimal |
R |
Ratio of replicated packets to total packets, for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. This value is expressed as a decimal to 9 decimal digits. |
- |
2.15 |
|
InterfaceEthMbps |
decimal |
R |
The number of bits observed on the Interface during an IP-Layer Capacity test for time interval of duration TestSubInterval ending at TimeOfSubInterval, divided by the duration of TestSubInterval. Result is expressed in Mbps with 2 digits beyond the decimal. 106 bits/second = 1 Mbps. This is primarily a diagnostic measurement. Measurement direction follows the Role. |
- |
2.15 |
|
Device.IPsec. |
object |
R |
IPsec [RFC4301] object that supports the configuration of Encapsulating Security Payload (ESP) [RFC4303] and Authentication Header (AH) [RFC4302] in tunnel mode [Section 3.2/RFC4301]. Use of IKEv2 [RFC5996] is assumed. The IPsec object does not currently support static configuration of tunnels and child Security Associations (SAs). See the IPsec Theory of Operation [Appendix IX/TR-181i2] for a description of the working of this IPsec data model. |
- |
2.5 |
|
SupportedIntegrityAlgorithms |
string[] |
R |
Comma-separated list of strings. Supported integrity algorithms [Transform Type 3/IKEv2-params]. Each list item is an enumeration of:
Note that these are the names from the above reference, transformed as follows:
As additional algorithms are added to the above reference, this data model will be extended according to the above conventions. Changes since 2.19:
|
- |
2.5 |
|
Device.IPsec.IKEv2SA.{i}. |
object(0:) |
R |
Represents an IKEv2 Security Association (SA), corresponding to an IKEv2 session. Instances are automatically created and deleted as IKEv2 SAs are created and deleted. At most one entry in this table can exist with a given value for Tunnel, or with a given value for Alias. |
- |
2.5 |
|
Device.IPsec.IKEv2SA.{i}.Stats. |
object |
R |
Statistics for this IKEv2 Security Association (SA). The CPE MUST reset the IKEv2 SA's Stats parameters (unless otherwise stated in individual object or parameter descriptions) whenever the associated Tunnel instance's Stats parameters are reset. |
- |
2.5 |
|
DecryptionErrors |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packets to this IKEv2 SA discarded due to decryption errors. Note that this refers to IKEv2 protocol packets, and not to {units}}packets carried by other SAs.}} |
- |
2.5 |
|
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. |
- |
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. Changes since 2.19:
|
- |
2.8 |
|
Device.Routing. |
object |
R |
Routing object that contains the Router table, the received router advertisement information RouteInformation, Babel, and RIP protocol objects. Changes since 2.19:
|
- |
2.0 |
|
PolicyNumberOfEntries |
unsignedInt |
R |
The number of entries in the Policy table. |
- |
2.20 |
|
Device.Routing.Router.{i}. |
object(0:) |
W |
This object allows the handling of the routing and forwarding configuration of the device. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for ID, or with a given value for Name. |
- |
2.0 |
|
ID |
unsignedInt(0:255) |
R |
The identifier of the routing table, as defined by the system upon creation. |
- |
2.20 |
|
Name |
string(:256) |
W |
The name of the routing table. |
- |
2.20 |
|
Device.Routing.Router.{i}.IPv4Forwarding.{i}. |
object(0:) |
W |
Layer 3 IPv4 forwarding table. In addition to statically configured routes, this table MUST include dynamic routes learned through layer 3 routing protocols, including RIP (i.e. RIP version 2), OSPF, DHCPv4, 3GPP-NAS (3GPP Non Access Stratum) and IPCP. The CPE MAY reject attempts to delete or modify a dynamic route entry. For each incoming packet, the layer 3 forwarding decision is conceptually made as follows:
For enabled table entries, if Interface is not a valid reference to an IPv4-capable interface (that is attached to the IPv4 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The IPv4Forwarding table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated IPv4Forwarding row to then violate the table's unique key constraint; if this occurs, the CPE MUST disable the offending IPv4Forwarding row. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of DestIPAddress, DestSubnetMask, SourceIPAddress, SourceSubnetMask, ForwardingPolicy, GatewayIPAddress, Interface and ForwardingMetric. Changes since 2.19:
|
- |
2.0 |
|
SourceIPAddress |
string(:45) |
W |
[IPv4Address] Source IPv4 address is a filter to the packets for which the route applies. An empty string indicates no source address is specified. |
<Empty> |
2.20 |
|
SourceSubnetMask |
string(:45) |
W |
[IPv4Address] Source subnet mask. An empty string indicates no source subnet mask is specified. If a source subnet mask is specified, the SourceSubnetMask is ANDed with the source address before comparing with the SourceIPAddress. Otherwise, the full source address is used as is. |
<Empty> |
2.20 |
|
MTU |
unsignedInt(-1,576:) |
W |
Maximum Transmission Unit for this route (expressed in bytes). Valid values are: -1 bytes (A value of -1 indicates no MTU is specified), or at least 576 bytes. |
- |
2.20 |
|
Device.Routing.Router.{i}.IPv6Forwarding.{i}. |
object(0:) |
W |
Layer 3 IPv6 forwarding table. In addition to statically configured routes, this table MUST include dynamic routes learned through layer 3 routing protocols, including RIPng, OSPF, DHCPv6, 3GPP-NAS, and RA. The CPE MAY reject attempts to delete or modify a dynamic route entry. For each incoming packet, the layer 3 forwarding decision is conceptually made as follows:
For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. This object is based on inetCidrRouteTable from [RFC4292]. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of DestIPPrefix, ForwardingPolicy, NextHop, Interface and ForwardingMetric. Changes since 2.19:
|
- |
2.2 |
|
SourceIPPrefix |
string(:49) |
W |
[IPv6Prefix] Source IPv6 prefix. An empty string indicates that it matches all source prefixes. All bits to the right of the prefix MUST be zero, e.g. 2001:edff:fe6a:f76::/64. Routes with a 128-bit prefix length (/128) are host routes for a specific IPv6 source, e.g. 2001:db8:28:2:713e:a426:d167:37ab/128. |
<Empty> |
2.20 |
|
MTU |
unsignedInt(-1,1280:) |
W |
Maximum Transmission Unit for this route (expressed in bytes). Valid values are: -1 bytes (A value of -1 indicates no MTU is specified), or at least 1280 bytes. |
- |
2.20 |
|
Device.Routing.Policy.{i}. |
object(0:) |
W |
Routing policy table. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.20 |
|
Enable |
boolean |
W |
Enables or disables this Policy table entry. |
false |
2.20 |
|
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.20 |
|
Status |
string |
R |
The status of this Policy table entry. Enumeration of:
|
Disabled |
2.20 |
|
RouterRef |
string(:256) |
W |
The value MUST be the Path Name of a row in the Router. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specify the routing table to use for traffic matching criterion. Example: Device.Routing.Router.1. |
<Empty> |
2.20 |
|
Priority |
unsignedInt |
W |
The priority of this Policy table entry, determining the order in which rules are processed. A lower numerical value indicates higher precedence, meaning rules are evaluated in increasing order of priority. A value of 0 represents the highest precedence. |
- |
2.20 |
|
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). |
-1 |
2.20 |
|
Protocol |
int(-1:255) |
W |
Policy criterion. Protocol number. A value of -1 indicates this criterion is not used for matching. |
-1 |
2.20 |
|
SourceInterface |
string(:256) |
W |
Policy criterion. 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. Specify the ingress interface the packet is coming from. Example: Device.IP.Interface.1. |
<Empty> |
2.20 |
|
DestInterface |
string(:256) |
W |
Policy criterion. 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. Specify the egress interface the packet is sent to. Example: Device.IP.Interface.1. |
<Empty> |
2.20 |
|
SourceIPPrefix |
string(:49) |
W |
Source IP address prefix, represented as an IP routing prefix using CIDR notation (defined in [RFC4632]). The IP version of IPVersion determines whether SourceIPPrefix is interpreted as an IPv4 or IPv6 prefix. An an empty string indicates this criterion is not used for matching. |
<Empty> |
2.20 |
|
DestIPPrefix |
string(:49) |
W |
Destination IP address prefix, represented as an IP routing prefix using CIDR notation (defined in [RFC4632]). The IP version of IPVersion determines whether DestIPPrefix is interpreted as an IPv4 or IPv6 prefix. An an empty string indicates this criterion is not used for matching. |
<Empty> |
2.20 |
|
SourcePort |
int(-1:65535) |
W |
Policy criterion. Source port number. A value of -1 indicates this criterion is not used for matching. |
-1 |
2.20 |
|
SourcePortRangeMax |
int(-1:65535) |
W |
Policy criterion. If specified, indicates the Policy criterion is to include the port range from SourcePort through SourcePortRangeMax (inclusive). If specified, SourcePortRangeMax MUST be greater than or equal to SourcePort. A value of -1 indicates that no port range is specified. |
-1 |
2.20 |
|
DestPort |
int(-1:65535) |
W |
Policy criterion. Destination port number. A value of -1 indicates this criterion is not used for matching. |
-1 |
2.20 |
|
DestPortRangeMax |
int(-1:65535) |
W |
Policy criterion. If specified, indicates the Policy criterion is to include the port range from DestPort through DestPortRangeMax (inclusive). If specified, DestPortRangeMax MUST be greater than or equal to DestPort. A value of -1 indicates that no port range is specified. |
-1 |
2.20 |
|
ForwardingPolicy |
int(-1:) |
W |
Identifier of a set of classes or flows that have the corresponding ForwardingPolicy value as defined in the QoS object. A value of -1 indicates no ForwardingPolicy is specified. If specified, this Policy entry is to apply only to traffic associated with the specified classes and flows. |
-1 |
2.20 |
|
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. Changes since 2.19:
|
- |
2.0 |
|
CleanupHostsThreshold |
int(-1:) |
W |
Specifies the threshold related to the number of Host entries that are retained in the Device.Hosts.Host.{i}. table. If this threshold is exceeded, the device removes the inactive Host entry with the oldest Host.{i}.ActiveLastChange timestamp that is, the Host entry for which Host.{i}.Active is false and the host entry for which has been inactive the longest. A value of '-1' disables this mechanism. |
- |
2.20 |
|
Device.Hosts.Host.{i}. |
object(0:) |
R |
Host table. At most one entry in this table can exist with a given value for PhysAddress. |
- |
2.0 |
|
Active |
boolean |
R |
Whether or not the host is currently present on the LAN. The method of presence detection is a local matter to the CPE. The ability to list inactive hosts is OPTIONAL. If the CPE includes inactive hosts in this table, Active MUST be set to false for each inactive host. The length of time an inactive host remains listed in this table is a local matter to the CPE. Entries in Device.Hosts.Host SHOULD NOT be removed when they become inactive if there are WANStats statistics collected for the entry in the past seven days.}}days, unless requested by a Controller or if the CleanupHostsThreshold parameter value is reached. |
- |
2.0 |
|
ActiveLastChange |
dateTime |
R |
The datetime when Active last changed from true to false or from false to true. The initial detection of a host SHOULD be treated as a transition from false to true, showing the datetime when the host was first detected. The ability to list inactive hosts is OPTIONAL. The length of time an inactive host remains listed in this table is a local matter to the CPE. Entries in Device.Hosts.Host SHOULD NOT be removed when they become inactive if there are WANStats statistics collected for the entry in the past seven days.}}days, unless requested by a Controller or if the CleanupHostsThreshold parameter value is reached. |
- |
2.10 |
|
Device.Hosts.AccessControl.{i}. |
object(0:) |
W |
Every instance of this object provides access control for a LAN device. Access is allowed if no instance of AccessControl is defined for a device. If access is not allowed, then the LAN device cannot access the broadband network. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for PhysAddress. |
- |
2.14 |
|
ScheduleRef |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Schedules.Schedule. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Each reference provides a time schedule wherethat timecontrols basedwhen accessthe canassociated befeature enabled.or resource is active or inactive. When ScheduleRef is an empty string the AccessControl is not scheduled, and the Enable defines the operational state. |
<Empty> |
2.18 |
|
ScheduleNumberOfEntries |
unsignedInt |
R |
This parameter was DEPRECATED in 2.18 in favor of Schedules.. This parameter was OBSOLETED in 2.20. The number of entries in the Schedule table. Changes since 2.19:
|
- |
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. 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.19:
|
- |
2.14 |
|
Device.DNS. |
object |
R |
Properties for Domain Name Service (DNS). Changes since 2.19:
|
- |
2.0 |
|
Device.DNS.SD. |
object |
R |
This object contains the DNS Service Discovery [DNS-SD] object and parameters necessary to discover services and their associated devices. Upon reboot the 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 |
|
AdvertisedInterfaces |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of the IP.Interface object instance from which DNS-SD services are advertised. If the referenced object is deleted, the corresponding item MUST be removed from the list. If this parameter is not supported by an implementation then DNS-SD services are advertised on all LAN interfaces. This parameter was DEPRECATED in 2.17 in favor of Advertise.{i}.Interface. This parameter was OBSOLETED in 2.19. This parameter was DELETED in 2.20. Changes since 2.19:
|
- |
2.12 |
|
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’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 |
|
Enable |
boolean |
W |
Enables or Disables protection against DNS rebind attacks |
- |
2.20 |
|
IPExceptions |
string(:45)[] |
W |
[IPAddress] Comma-separated list of IP Addresses. Each item of the list represents an IP address or a CIDR notation that should not be protected against rebind attacks. |
- |
2.20 |
|
DomainExceptions |
string[] |
W |
Comma-separated list of strings. Each item of the list represents a domain name and its subdomain names that should not be protected against rebind attacks. |
- |
2.20 |
|
Device.NAT. |
object |
R |
Properties for Network Address Translation (NAT). The entire NAT object only applies to IPv4. |
- |
2.0 |
|
Device.NAT.PortMapping.{i}. |
object(0:) |
W |
Port mapping table. This table MUST contain all NAT port mappings associated with this connection, including static and dynamic port mappings programmatically created via local control protocol, such as UPnP. This table MUST NOT contain dynamic NAT binding entries associated with the normal operation of NAT. If the CPE hosts a firewall, it is assumed that it will appropriately configure the firewall for the port mapping. For enabled table entries, if InternalClient is an empty string, or if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the 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 the same values for all of RemoteHost, ExternalPort and Protocol. |
- |
2.0 |
|
ScheduleRef |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Schedules.Schedule. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Each reference provides a time schedule wherethat timecontrols basedwhen accessthe canassociated befeature enabled.or resource is active or inactive. When ScheduleRef is an empty string the PortMapping is not scheduled, and the Enable defines the operational state. |
<Empty> |
2.18 |
|
Device.NAT.PortTrigger.{i}. |
object(0:) |
W |
Firewall PortTrigger table. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.16 |
|
ScheduleRef |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Schedules.Schedule. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Each reference provides a time schedule wherethat timecontrols basedwhen accessthe canassociated befeature enabled.or resource is active or inactive. When ScheduleRef is an empty string the PortTrigger is not scheduled, and the Enable defines the operational state. |
<Empty> |
2.18 |
|
Device.UPnP. |
object |
R |
This object contains all UPnP related objects and parameters including Device and Discovery related objects and parameters. |
- |
2.0 |
|
Device.UPnP.Device. |
object |
R |
This object defines the UPnP devices and UPnP services that are implemented by the CPE. Changes since 2.19:
|
- |
2.0 |
|
Device.UPnP.Device.IGD. |
object |
R |
When UPnPIGD is set to true, this object defines the configuration parameters of the UPnP-IGD service embedded in the device. |
- |
2.20 |
|
MaxLeaseLifetime |
unsignedInt |
W |
Specifies the maximum duration, in seconds, for a UPnP-IGD port mapping lease that the UPnP-IGD service will grant. When a UPnP control point requests a lease duration exceeding this value, the UPnP-IGD service will still grant the port mapping request, but the actual lease lifetime will be capped at this value. Once this maximum lifetime expires, the port mapping will be automatically removed. A value of 0 indicates no MaxLeaseLifetime is specified. The default value SHOULD be 86400. |
- |
2.20 |
|
CleanupInterval |
unsignedInt |
W |
Specifies the interval, in seconds, at which the Device's UPnP-IGD service automatically cleans up inactive UPnP port mappings. A port mapping is typically considered inactive if no network traffic has been observed traversing it for a predefined timeout period, which is an implementation-specific value within the UPnP-IGD service. During the cleanup process, mappings that meet this inactivity criteria are removed. A value of 0 disables this automatic cleanup mechanism, causing port mappings to persist until explicitly removed by the control point or the UPnP-IGD service restarts. The default value SHOULD be 0. |
- |
2.20 |
|
AllowReservedAddress |
boolean |
W |
Indicates whether the Device allows port forwarding requests from UPnP control points even when the external (WAN) interface of the IGD has a private or reserved IPv4 address. When set to true, the IGD service will process and attempt to establish port mappings despite having a non-public IP address on its WAN interface. When set to false, the IGD will prevent the establishment of port mappings if it detects a private or reserved IP address on its WAN interface. The default value SHOULD be false. |
- |
2.20 |
|
EnableIPv6 |
boolean |
W |
Enables or disables IPv6 support for the UPnP IGD service. The default value SHOULD be false. |
- |
2.20 |
|
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. Changes since 2.19:
|
- |
2.2 |
|
FloodLimit |
int(-1:65535) |
W |
Specifies the number of packets that can be processed per unit of time. A value of -1 indicates this criterion is not used for matching. |
-1 |
2.20 |
|
BurstLimit |
int(-1:65535) |
W |
Specifies the maximum number of packets that can be processed in a short burst before the FloodLimit is enforced again. A value of -1 indicates this criterion is not used for matching. |
-1 |
2.20 |
|
Device.Firewall.Pinhole.{i}. |
object(0:) |
W |
Firewall Pinhole object that is used for configuring pinholes. Pinholes are similar to port mapping entries but without the NAT support. The Pinhole table is used for allowing certain incoming traffic, on the Interface, to be routed to the internal network. For enabled table entries, if DestMACAddress and DestIP are an empty string, or if Interface is not a valid reference, then the table entry is inoperable and the device MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.16 |
|
ScheduleRef |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Schedules.Schedule. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Each reference provides a time schedule wherethat timecontrols basedwhen accessthe canassociated befeature enabled.or resource is active or inactive. When ScheduleRef is an empty string the Pinhole is not scheduled, and the Enable defines the operational state. |
<Empty> |
2.18 |
|
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 |
|
Enable |
boolean |
W |
Globally enables or disables the entire file transfer service managed by this object. When disabled, no file transfers will occur, regardless of individual profile or transfer configurations. |
- |
2.20 |
|
ProtocolsSupported |
string[] |
R |
Comma-separated list of strings. Indicates the protocols that are supported. Each list item is an enumeration of:
|
- |
2.20 |
|
TypesSupported |
string[] |
W |
Comma-separated list of strings. Indicates the file types that are supported for upload. Each list item is an enumeration of:
|
- |
2.20 |
|
HTTPCompressionsSupported |
string[] |
R |
Comma-separated list of strings. Indicates the HTTP Compression mechanism(s) supported by this Device for the purposes of transferring the data. Each list item is an enumeration of:
|
- |
2.20 |
|
HTTPMethodsSupported |
string[] |
R |
Comma-separated list of strings. Indicates the HTTP method(s) supported by this Device for the purposes of transferring data. Each list item is an enumeration of:
|
- |
2.20 |
|
ProfileNumberOfEntries |
unsignedInt |
R |
The number of entries in the Profile table. |
- |
2.20 |
|
TransferNumberOfEntries |
unsignedInt |
R |
The number of entries in the Transfer table. |
- |
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 |
|
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.20 |
|
Name |
string(:64) |
W |
The textual name of the profile as assigned by the Device. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.20 |
|
Protocol |
string |
W |
The value MUST be a member of the list reported by the ProtocolsSupported parameter. Protocol being used. |
- |
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 |
|
URL |
string(:2048) |
W |
[URL] The URL of the server receiving the periodic file uploads. |
- |
2.20 |
|
Username |
string(:256) |
W |
Username used to authenticate the Device when making a connection to the file upload server. An empty string indicates that the username will not be used during the authentication process. |
- |
2.20 |
|
Password |
string(:256) |
W |
Password used to authenticate the Device when making a connection to the file upload server. An empty string indicates that the password will not be used during the authentication process. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.20 |
|
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. |
<Empty> |
2.20 |
|
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. |
<Empty> |
2.20 |
|
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). |
-1 |
2.20 |
|
Compression |
string |
W |
The value MUST be a member of the list reported by the HTTPCompressionsSupported parameter, or else be None. The value of this parameter represents the HTTP Compression mechanism to be used by the Device when transferring data to the file upload server. |
- |
2.20 |
|
Method |
string |
W |
The value MUST be a member of the list reported by the HTTPMethodsSupported parameter. The value of this parameter represents the HTTP method to be used by the Device when transferring data to the file upload server. |
- |
2.20 |
|
RetryEnable |
boolean |
W |
When true, the Device retries unsuccessful attempts to transfer the remaining files. |
- |
2.20 |
|
RetryMinimumWaitInterval |
unsignedInt(1:65535) |
W |
Configures the data transfer retry wait interval, in seconds. The device MUST use a random value between RetryMinimumWaitInterval and (RetryMinimumWaitInterval * RetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. |
- |
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 specifed RetryMaximumWaitInterval value then RetryMaximumWaitInterval value should be used. |
4294967295 |
2.20 |
|
RetryIntervalMultiplier |
unsignedInt(1000:65535) |
W |
Configures the retry interval multiplier. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. The device MUST use a random value between RetryMinimumWaitInterval and (RetryMinimumWaitInterval * RetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. |
- |
2.20 |
|
RequestURIParameterNumberOfEntries |
unsignedInt |
R |
The number of entries in the RequestURIParameter table. |
- |
2.20 |
|
RequestHeaderParameterNumberOfEntries |
unsignedInt |
R |
The number of entries in the RequestHeaderParameter table. |
- |
2.20 |
|
Device.PeriodicFileTransfer.Profile.{i}.HTTP.RequestURIParameter.{i}. |
object(0:) |
W |
This object represents an instance of a parameter to be used in the report header used as part of the HTTP Request-URI transmitted by the CPE to the collection server using the Request-URI in addition to the parameters required by [Annex N.2.1/TR-069]. |
- |
2.20 |
|
Name |
string(:64) |
W |
Name of the Request-URI parameter. If Name is an empty string, the name of the Request-URI parameter is the value of Reference. |
- |
2.20 |
|
Reference |
string(:256) |
W |
The value MUST be the path name of a parameter to be used as the Request-URI parameter. If the value of this parameter is an empty string, then this object is not encoded in the report header. |
<Empty> |
2.20 |
|
Device.PeriodicFileTransfer.Profile.{i}.HTTP.RequestHeaderParameter.{i}. |
object(0:) |
W |
This object allows defining custom HTTP request header fields to be included in the outbound HTTP requests to the remote server when using this profile. As defined in [Section 5.3 Request Header Fields/RFC2616]. Each instance can specify either a static value or dynamically reference a device parameter. |
- |
2.20 |
|
Name |
string(:64) |
W |
The name of the custom HTTP header field to be added to the request. Either Value or Reference MUST be specified. If both are specified, the value of Value will be used. If both are an empty string, this object is not included in the HTTP request. |
- |
2.20 |
|
Value |
string(:64) |
W |
The static value of the HTTP header field. If this parameter is an empty string, the value of the header field will be the current value of the device parameter specified in Reference. |
- |
2.20 |
|
Reference |
string(:256) |
W |
The path name of a device parameter whose current value will be used as the value of this HTTP header field. |
<Empty> |
2.20 |
|
Device.PeriodicFileTransfer.Transfer.{i}. |
object(0:) |
W |
This object specifies the parameters for an individual file transfer task. Each instance specifies a file to be transferred, the method of transfer (periodic or on-demand), and a reference to a Profile.{i}. object containing the server connection details. The Status parameter reflects the current state of the transfer process, which can transition through the following sequences:
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.20 |
|
Enable |
boolean |
W |
Enables or disables this specific file transfer task. If this entry is disabled then the transfer is not performed. The default value SHOULD be false. |
- |
2.20 |
|
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.20 |
|
Status |
string |
R |
Indicates the current status of this file transfer task. Enumeration of:
|
- |
2.20 |
|
Origin |
string |
R |
Indicates the Origin of the Transfer instance. Enumeration of:
|
Controller |
2.20 |
|
Type |
string |
W |
The value MUST be a member of the list reported by the TypesSupported parameter. Specifies the type of file to be uploaded. The actual file path and any pre- or post-processing scripts associated with this file type are implementation-specific on the Device. |
- |
2.20 |
|
FileReference |
string |
W |
The value MUST be the Path Name of a row in the DeviceInfo.VendorLogFile. or DeviceInfo.LogRotate. tables. If the referenced object is deleted, the parameter value MUST be set to an empty string. The path reference to the object that contains the file(s) to be uploaded. Only applicable when Type matches values of VendorLogFile or LogRotate. For other Type values, this parameter is not applicable, because all files of the selected type will be uploaded, e.g. when Type equals ProcessFaults all process faults will be uploaded. When FileReference is an empty string, depending on the Type all references will be uploaded. |
<Empty> |
2.20 |
|
ProfileReference |
string |
W |
The value MUST be the Path Name of a row in the PeriodicFileTransfer.Profile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Reference to profile instance to be used to perform the transfer. |
- |
2.20 |
|
UploadInterval |
unsignedInt(1:) |
W |
The file upload interval in seconds. Each file upload is tried based on this interval and TimeReference. File upload intervals MUST begin every UploadInterval seconds. If UploadInterval is changed while Periodic File Upload is enabled, the first file upload interval begins immediately. For example, if UploadInterval is 86400 (a day) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then the Device will upload its file(s) at midnight every 24 hours. |
86400 |
2.20 |
|
TimeReference |
dateTime |
W |
An absolute time reference in UTC to determine when the file will be transmitted. Each file upload interval MUST complete at this reference time plus or minus an integer multiple of UploadInterval, unless unable to due to higher prioritized operations. TimeReference is used only to set the "phase" of the file upload intervals. The actual value of TimeReference can be arbitrarily far into the past or future. If TimeReference is changed while periodic file upload is enabled, the first file upload interval begins immediately. The Unknown Time value as defined in [TR-106] indicates that no particular time reference is specified. That is, the Device MAY locally choose the time reference, and is required only to adhere to the specified file upload intervals. If absolute time is not available to the Device, its file upload interval behavior MUST be the same as if the TimeReference parameter was set to the Unknown Time value. For example, if UploadInterval is 86400 (a day) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then the Device will upload its file(s) at midnight every 24 hours. Note that, if TimeReference is set to a time other than the Unknown Time, the first file upload interval (which has to begin immediately) will almost certainly be shorter than UploadInterval). This is why TimeReference is defined in terms of when file upload intervals complete rather than start. |
0001-01-01T00:00:00Z |
2.20 |
|
NextTransferDate |
dateTime |
R |
The UTC date and time of the next scheduled file upload for this periodic transfer task. |
0001-01-01T00:00:00Z |
2.20 |
|
Device.PeriodicFileTransfer.Transfer.{i}.Stats. |
object |
R |
This object provides statistical information about the success and failure of individual file transfer tasks. |
- |
2.20 |
|
LastSuccess |
dateTime |
R |
The date and time at which of the last successful transfer. |
- |
2.20 |
|
LastFailed |
dateTime |
R |
The date and time at which of the last failed transfer. |
- |
2.20 |
|
LastErrorCode |
unsignedLong |
R |
[StatsCounter64] Error code of the last failed transfer as described in https://tr369.org/tr-369-usp-error-code-details/. |
- |
2.20 |
|
SuccessCount |
unsignedLong |
R |
[StatsCounter64] Counter of successful transfer. |
- |
2.20 |
|
FailedCount |
unsignedLong |
R |
[StatsCounter64] Counter of failed transfer. |
- |
2.20 |
|
Device.PeriodicFileTransfer.Stats. |
object |
R |
This object provides aggregated statistical information about all file upload activities managed by the Device.PeriodicFileTransfer. object. |
- |
2.20 |
|
UploadSuccessful |
unsignedLong |
R |
[StatsCounter64] A counter representing the total number of successful file uploads across all transfer tasks since the last system reset or counter reset. |
- |
2.20 |
|
UploadFailed |
unsignedLong |
R |
[StatsCounter64] A counter representing the total number of failed file uploads across all transfer tasks since the last system reset or counter reset. |
- |
2.20 |
|
Device.SoftwareModules. |
object |
R |
Top level object for dynamically managed software applications. Since Device:2.15, the Software Module data model has undergone significant enhancements, particularly in expanding support for new concepts, e.g. ExecEnvClass.{i}., ExecEnv.{i}.ApplicationData.{i}., ExecutionUnit.{i}.AutoRestart., ExecutionUnit.{i}.NetworkConfig., ExecutionUnit.{i}.HostObject.{i}, and ExecutionUnit.{i}.EnvVariable.{i}.. However, the CWMP protocol lacks native capabilities to dynamically manage these new concepts. At best, CWMP can be used to view the available configurations. For more dynamic and interactive management of these concepts, the USP protocol should be utilized. |
- |
2.1 |
|
Device.SoftwareModules.ExecEnvClass.{i}. |
object(0:) |
R |
This table lists the kinds of Execution Environments which are available in this device. Rows in this table may possibly be be added, modified, or removed by as a result of respectively installing, updating, or removing a DeploymentUnit. At most one entry in this table can exist with a given value for Alias, or with the same values for all of Vendor, Name and Version. |
- |
2.16 |
|
DeploymentUnitRef |
string |
R |
The value MUST be the Path Name of a row in the DeploymentUnit. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. A reference to the DeploymentUnitDeployment Unit (if any) by which this ExecEnvClass was created. |
- |
2.16 |
|
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 |
|
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. This parameter was OBSOLETED in 2.20. Changes since 2.19:
|
- |
2.1 |
|
Device.SoftwareModules.ExecutionUnit.{i}. |
object(0:) |
R |
This table serves as the Execution Unit inventory and contains both status information about each Execution Unit as well as configurable parameters for each Execution Unit. Each DeploymentUnit that is installed can have zero or more Execution Units. Once a Deployment Unit is installed it populates this table with its contained Execution Units. When the Deployment Unit (that caused this ExecutionUnit to come into existence) is updated, this instance MAY be removed and new instances MAY come into existence. While the Deployment Unit (that caused this ExecutionUnit to come into existence) is being updated, all ExecutionUnit instances associated with the Deployment Unit will be stopped until the update is complete at which time they will be restored to the state that they were in before the update started. When the Deployment Unit (that caused this ExecutionUnit to come into existence) is uninstalled, this instance is removed. Each ExecutionUnit MAY also contain a set of vendor specific parameters displaying status and maintaining configuration that reside under the Extensions object. At most one entry in this table can exist with a given value for EUID, or with a given value for Alias. |
- |
2.1 |
|
AllocatedEUUID |
unsignedInt |
R |
This parameter is allocated by the host system. This is the user identifier within the execution unit's environment. This UID is local to the execution unit and is used by the EU'sExecution Unit's internal processes to manage permissions. By default, processes within the EUExecution Unit execute as root (UID 0) unless otherwise specified. |
- |
2.18 |
|
AllocatedEUGID |
string |
R |
This parameter is allocated by the host system. This is the group identifier within the execution unit's environment. This GID is local to the execution unit and is used by the EU'sExecution Unit's internal processes to manage permissions. |
- |
2.18 |
|
AllocatedHostUID |
unsignedInt |
R |
This parameter is allocated by the host system. This is the user identifier on the host system where this EUExecution Unit is running. This UID is system wide and is managed by the kernel. |
- |
2.18 |
|
AllocatedHostGID |
string |
R |
This parameter is allocated by the host system. This is the group identifier on the host system where this EUExecution Unit is running. This GID is system wide and is managed by the kernel. |
- |
2.18 |
|
CreationTime |
dateTime |
R |
The date and time when the EUExecution Unit was created. |
- |
2.18 |
|
Uptime |
unsignedInt |
R |
The amount of time in seconds that this EUExecution Unit has been up and running since it was activated. |
- |
2.18 |
|
Device.SoftwareModules.ExecutionUnit.{i}.AutoRestart. |
object |
R |
Configures the parameters of the auto-restart algorithm for this EU.Execution Unit. An auto-restart may be triggered if the Agent determines that the EUExecution Unit has terminated abnormally. An exponential backoff algorithm is applied (increasing each time the delay before the EUExecution Unit is re-launched) in order to prevent continual re-starting of the EU.Execution Unit. The retry interval range is controlled by two Parameters, RetryMinimumWaitInterval and RetryIntervalMultiplier. Let m be the value of RetryMinimumWaitInterval, k the value of RetryIntervalMultiplier, and n the current value of RetryCount. Then on the next occasion that the Agent determines that the EUExecution Unit has terminated abnormally, the delay before re-starting the EUExecution Unit must lie between m * (k/1000)^n^ and m * (k/1000)^(n+1)^ seconds, so long as m * (k/1000)^n^ evaluates to a value less than RetryMaximumWaitInterval. Once this point has been reached, on all subsequent occasion that the Agent determines that the EUExecution Unit has terminated abnormally the delay before re-starting the EUExecution Unit must lie between RetryMaximumWaitInterval* * (1000/k)* and RetryMaximumWaitInterval seconds. |
- |
2.16 |
|
Enable |
boolean |
W |
Enable the auto-restart feature for this EU.}}Execution Unit. The default value SHOULD be false. |
- |
2.16 |
|
RetryMinimumWaitInterval |
unsignedInt |
W |
Configures the initial delay in seconds between detecting that the EUExecution Unit has terminated abnormally and re-starting it. |
- |
2.16 |
|
RetryMaximumWaitInterval |
unsignedInt |
W |
Configures the maximum delay in seconds between detecting that the EUExecution Unit has terminated abnormally and re-starting it. |
- |
2.16 |
|
ResetPeriod |
unsignedInt |
W |
If the EUExecution Unit runs for this number of seconds without terminating abnormally the Agent MAY reset the RetryCount to zero, thereby resetting the exponential backoff algorithm. A value of zero disables this behavior. |
- |
2.16 |
|
RetryCount |
unsignedInt |
W |
The number times the EUExecution Unit has terminated abnormally and a restart has been attempted. Resetting this parameter to zero has the effect of re-initialising the exponential back-off algorithm. |
- |
2.16 |
|
Device.SoftwareModules.ExecutionUnit.{i}.NetworkConfig. |
object |
R |
Parameters of the network configuration for this ExecutionUnit. When no network configuration is provided, the EUExecution Unit will not have any network access. |
- |
2.17 |
|
AccessInterfaceRefList |
string[] |
R |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the IP.Interface. table, or the Path Name of an interface layered above such a row, e.g., a row in the Logical.Interface. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the network interface through which the traffic from the EUExecution Unit will be allowed. |
- |
2.17 |
|
PortMappingRefList |
string[] |
R |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the NAT.PortMapping. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the list of Port mappings associated with this EU.}}Execution Unit. |
- |
2.17 |
|
Device.SoftwareModules.ExecutionUnit.{i}.HostObject.{i}. |
object(0:) |
R |
This parameter describes the host OS objects (such as peripherals, files or directories, communication sockets, ...) which are accessible to the ExecutionUnit. At most one entry in this table can exist with a given value for Alias, or with a given value for Destination. |
- |
2.16 |
|
Destination |
string(:256) |
R |
The object identifier by which the object may be accessed by the ExecutionUnit. This object identifier MUST be valid in the context of the Execution Environment in which the ExecutionUnitExecution Unit is installed. |
- |
2.16 |
|
Device.MQTT. |
object |
R |
MQTT Base object describing all MQTT related parameters and objects. |
- |
2.10 |
|
Device.MQTT.Client.{i}. |
object(0:) |
W |
MQTT client table. Contains a list of configured MQTT clients. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. Changes since 2.19:
|
- |
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). |
-1 |
2.20 |
|
BrokerAddress |
string(:256) |
W |
Host name or IP address of the MQTT Broker. If the value of this parameter is an host name, the resolved IP address will be either IPv4 or IPv6, based on the value of the IPVersion parameter. |
- |
2.10 |
|
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. |
<Empty> |
2.20 |
|
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. |
<Empty> |
2.20 |
|
Device.MQTT.Broker.{i}. |
object(0:) |
W |
MQTT broker table. Contains a list of configured 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.19:
|
- |
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). |
-1 |
2.20 |
|
TransportProtocol |
string |
W |
The value MUST be a member of the list reported by the Capabilities.TransportProtocolSupported parameter. Indicates the transport protocol to be used for the MQTT broker connection. |
TLS |
2.20 |
|
Interface |
string(:256) |
W |
The value MUST be the Path Name of a row in the IP.Interface. table, or the Path Name of an interface layered above such a row, e.g., a row in the Logical.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. If an empty string is specified, the CPE MUST bind the MQTT broker to all available interfaces.}}interfaces, which depends on the value of the IPVersion parameter. Meaning that the broker will bind to an IPv4 address, an IPv6 address, or both. |
- |
2.10 |
|
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 server certificate to be presented by the server during the TLS handshake. This certificate is used to authenticate the server to remote clients, ensuring that the clients are connecting to a legitimate server. The server certificate must be issued by a trusted Certificate Authority (CA) and should match the server's private key. This parameter is applicable only when a TLS session is being used. |
<Empty> |
2.20 |
|
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 server must use to validate the certificate presented by the remote client. These CA certificates form a trust chain that the client certificate must match, ensuring that only clients with trusted certificates can establish a connection. This parameter supports multiple CA certificates to accommodate different client certificate issuers. This parameter is applicable only when a TLS session is being used. |
<Empty> |
2.20 |
|
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.19:
|
- |
2.10 |
|
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. |
<Empty> |
2.20 |
|
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. |
<Empty> |
2.20 |
|
Device.MQTT.Broker.{i}.Bridge.{i}.Server.{i}. |
object(0:) |
W |
Each Server instance represents a MQTT bridge server to be used for a Bridge. A remote MQTT broker, which is connected by a MQTT bridge can be reachable via several host addresses each represented by its own Server table entry. For an active MQTT bridge at least one enabled entry has to exist. If a MQTT bridge gets enabled by setting the parameter Bridge.{i}.Enable to true, which either has an empty Server table or the Server table only contains instances whose Enable is set to false, the Bridge.{i}.Status has to be set to Error_Misconfigured. Any attempt to delete an instance, which is currently in use (Bridge.{i}.ServerConnection refers to the instance to be deleted), has to be rejected. 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 Address and Port. Changes since 2.19:
|
- |
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). |
-1 |
2.20 |
|
Address |
string(:256) |
W |
Fully Qualified Domain Name (FQDN) or IP address of the MQTT broker server this Bridge connects to. If the value of this parameter is a FQDN that resolves to multiple addresses then each address SHOULD be attempted (in an implementation-specific order) until a connection can be made or all addresses are exhausted, in which case the next Server instance (based on rules defined over the selected Bridge.{i}.ServerSelectionAlgorithm) SHOULD be used. If the value of this parameter is an host name, the resolved IP address will be either IPv4 or IPv6, based on the value of the IPVersion parameter. |
- |
2.10 |
|
Device.LEDs. |
object |
R |
This object describes the LEDs on the device. Changes since 2.19:
|
- |
2.11 |
|
BrightnessLimiter |
unsignedInt(0:100) |
W |
The maximum allowed brightness level for all LEDs, expressed as a percentage. This value is relative to the maximum allowed brightness value of each LED, which is specified in LED.{i}.MaxBrightness. Valid values are: 0 percentage to 100 percentage (The value 0 indicates that all LEDs are turned off, while the value 100 indicates the maximum brightness). |
- |
2.20 |
|
Device.LEDs.LED.{i}. |
object(0:) |
R |
Each instance of this object describes an LED on the device. The default illumination characteristics (e.g., Color, Brightness) of an in use LED is vendor specific. When a cycle completes (i.e., CyclePeriodRepetitions = 0), the LED reverts back to its default illumination characteristics. When the value of the Status parameter is Controlled, then the value of CycleElementNumberOfEntries 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. At most one entry in this table can exist with a given value for Name, or with a given value for Alias. |
- |
2.11 |
|
Device.LEDs.LED.{i}.CycleElement.{i}. |
object(0:) |
W |
Each instance of this object describes the LED characteristics for a portion of the LED cycle period. The pattern of lighting for the LED corresponding to this table (i.e., the LED cycle period) is defined by the illumination of the LED according to the entries in this table, taken sequentially in the order specified by the Order parameter, with the duration for the portion of the LED illumination corresponding to a given instance specified by the Duration parameter. The other parameters of the instance of this object (e.g., Color, Brightness) describes the illumination characteristics applied to the LED for this CycleElement instance. The length of the complete LED cycle is the sum of the Duration parameters for all of the entries in this table. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Order. |
- |
2.11 |
|
Brightness |
unsignedInt(0:100) |
W |
The desired brightness level for this element of the cycle period, expressed as a percentage, relative to the maximum allowed brightness value specified in MaxBrightness. The value should not exceed the maximum brightness level specified in BrightnessLimiter. |
- |
2.19 |
|
Device.LMAP. |
object |
R |
This object represents the objects necessary to manage and control the functionality for Large-Scale Measurement of Broadband Performance[RFC7594] as defined in by [LMAPIFM]. |
- |
2.12 |
|
Device.LMAP.MeasurementAgent.{i}. |
object(0:) |
W |
This object represents the measurement agent that performs measurement tasks and reporting functions defined in [RFC7594]. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Identifier. |
- |
2.12 |
|
MeasurementPoint |
string(:256) |
W |
Identifier of the measurement point indicating where the measurement agent is located on a path as defined in [bibref\|RFC7398}}[RFC7398].}} |
- |
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.URSP.{i}. |
object(0:) |
R |
User equipment Router Selection Policy (URSP) is a table of rules used to determine which network slice and data network to route a PDU over. Typically a 5G-RG would search the URSP table in precedence order matching the traffic descriptor types against the service it was setting up. For example a 5G-RG would search for 'connection capabilities' matching 'ims' in order to establish a dedicated PDU session for telephony. See [Clause 5.2/3GPP-TS.24.526] for a full description of the URSP data elements. At most one entry in this table can exist with a given value for Alias, or with a given value for Precedence. |
- |
2.14 |
|
Device.WWC.URSP.{i}.TrafficDescriptor.{i}. |
object(0:) |
R |
A set of rules for a given precedence that must be matched in order to select a router in the form of data network and slice. Selection criteria range from destination IP addresses to connection capabilities. At most one entry in this table can exist with a given value for Alias. |
- |
2.14 |
|
Device.WWC.URSP.{i}.TrafficDescriptor.{i}.RouteSelectionDescriptor.{i}. |
object(0:) |
R |
This object describes the URSP Route Selection Descriptor table which provides a table of data networks and network slices used in PDU establishment. Table entries are used in precedence order until a successful PDU session is established. See ((bibref\|3GPP-TS.23.503\|Annex[Annex/3GPP-TS.23.503] A}} for an example URSP rule traversal.}} At most one entry in this table can exist with a given value for Alias, or with a given value for Precedence. |
- |
2.14 |
|
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. Changes since 2.19:
|
- |
2.16 |
|
PowerCapability |
string[] |
R |
Comma-separated list of strings. Describes the possible power states of the ONU regardless of its current administrative state. Each list item is an enumeration of:
|
- |
2.20 |
|
PowerStatus |
string |
R |
Reports the current power status of the ONU. The value MUST be a member of the list reported by the PowerCapability parameter, or else be Error. Each list item is an enumeration of:
|
- |
2.20 |
|
Device.XPON.ONU.{i}.PowerManagement. |
object |
R |
This object models the power reduction management capabilities of the ONU. It is based on [Section 9.1.14 ONU dynamic power management control/G.988]. When OLTSleepAllow is true then the ONU is allowed to enter a low power state. |
- |
2.20 |
|
PowerReductionManagementCapability |
string[] |
R |
Comma-separated list of strings. This parameter indicates the sleep mode capability of the PowerManagement. This parameter is based on [Section 9.1.14 ONU dynamic power management control/G.988]. An an empty string string indicates that no capabilities are supported. Each list item is an enumeration of:
|
- |
2.20 |
|
OLTSleepAllow |
boolean |
R |
This parameter indicates that the ONU is allowed, by the OLT, to apply the power reduction mode. |
- |
2.20 |
|
PowerReductionManagementStatus |
string |
R |
This parameter indicates the current power reduction management status of the ONU. The ONU can be in one of the following states: Enumeration of:
|
- |
2.20 |
|
ITransInit |
unsignedInt |
R |
Optical Network Unit (ONU) vendor's statement of the complete transceiver initialization time: the worst-case time required for the ONU to regain full functionality when leaving the asleep state (i.e., turning on both the receiver and the transmitter and acquiring synchronization to the downstream flow), measured in units of 125 microsecond PHY frames. The value zero indicates that the sleeping ONU can respond to a bandwidth grant without delay. Reference [Section 9.1.14 ONU dynamic power management control/G.988] |
- |
2.20 |
|
ITxInit |
unsignedInt |
R |
This parameter is the Optical Network Unit (ONU) vendor's statement of the transmitter initialization time: the time required for the ONU to regain full functionality when leaving the listen state (i.e., turning on the transmitter), measured in units of 125 microsecond PHY frames. The value zero indicates that the dozing ONU can respond to a bandwidth grant without delay. Reference [Section 9.1.14 ONU dynamic power management control/G.988] |
- |
2.20 |
|
MaxSleepInterval |
unsignedInt |
R |
The Isleep/Ilowpower attribute specifies the maximum time the ONU spends in its asleep, listen, or low-power states, as a count of 125 microsecond PHY frames. Local or remote events may truncate the ONU's sojourn in these states. The default value of this attribute is 0. |
- |
2.20 |
|
MinAwareInterval |
unsignedInt |
R |
The Iaware attribute specifies the time the ONU spends in its aware state, as a count of 125 microsecond PHY frames, before it re-enters asleep or listen states. Local or remote events may independently cause the ONU to enter an active state rather than returning to a sleep state. The default value of this attribute is 0. Reference [Section 9.1.14 ONU dynamic power management control/G.988] |
- |
2.20 |
|
MinActiveHeldInterval |
unsignedInt |
R |
The Ihold attribute specifies the minimum time during which the ONU remains in the active held state, as a count of 125 microsecond PHY frames. Its initial value is zero. Reference [Section 9.1.14 ONU dynamic power management control/G.988] |
- |
2.20 |
|
MaxSleepIntervalExtension |
unsignedLong |
R |
This parameter designates maximum sleep interval values for doze mode and cyclic sleep mode separately. When it supports this attribute, the ONU ignores the value of the maximum sleep interval attribute. Maximum sleep interval for doze mode and cyclic sleep mode are both 4 bytes. Maximum sleep interval for doze mode specifies the maximum time the ONU spends in its listen state, as a count of 125 microsecond PHY frames. Local or remote events may truncate the ONU's sojourn in these states. The default value is 0. Maximum sleep interval for cyclic sleep mode specifies the maximum time the ONU spends in its asleep state, as a count of 125 microsecond PHY frames. Local or remote events may truncate the ONU's sojourn in these states. The default value is 0. If watchful sleep is enabled, the ONU ignores this attribute. Reference [Section 9.1.14 ONU dynamic power management control/G.988] |
- |
2.20 |
|
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. Changes since 2.19:
|
- |
2.16 |
|
BanTime |
unsignedInt |
W |
The time, in seconds, that an IP address is banned after exceeding the MaxAuthTries. A value of 0 disables this feature. |
900 |
2.20 |
|
AllowAllIPv4 |
boolean |
W |
Allow accessincoming IP connections from any IPv4 address. The source prefixes defined in IPv4AllowedSourcePrefix will be ignored. |
false |
2.16 |
|
IPv4AllowedSourcePrefix |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. Allow only accessincoming IP connections from the provided list of IPv4 prefixes. When IPv4AllowedSourcePrefix is set to an empty string and AllowAllIPv4 is set to false, no incoming IP connections are allowed. When AllowAllIPv4 is set true, IPv4AllowedSourcePrefix is ignored. |
- |
2.16 |
|
AllowAllIPv6 |
boolean |
W |
Allow accessincoming IP connections from any IPv6 address. The source prefixes defined in IPv6AllowedSourcePrefix will be ignored. |
false |
2.16 |
|
IPv6AllowedSourcePrefix |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. Allow only accessincoming IP connections from the provided list of IPv6 prefixes. When IPv6AllowedSourcePrefix is set to an empty string and AllowAllIPv6 is set to false, no incoming IP connections are allowed. When AllowAllIPv6 is set true, IPv6AllowedSourcePrefix is ignored. |
- |
2.16 |
|
Device.UnixDomainSockets. |
object |
R |
This object contains information related to the Unix Domain Sockets used by USP Agent UDS MTP. Changes since 2.19:
|
- |
2.16 |
|
AuthenticationNumberOfEntries |
unsignedInt |
R |
The number of entries in the Authentication table. |
- |
2.20 |
|
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 successsfully on Unix Domain Sockets requiring authentication. At most one enabled entry in this table can exist with a given value for EndpointID. |
- |
2.20 |
|
Enable |
boolean |
W |
Enable/Disable this Authentication instance. |
- |
2.20 |
|
EndpointID |
string |
W |
The unique USP identifier of the USP Endpoint. |
- |
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 successsfully on Unix Domain Sockets requiring authentication. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.20 |
|
Device.UnixDomainSockets.UnixDomainSocket.{i}. |
object(0:) |
R |
This object contains parameters relating to a UnixDomainSocket configuration. At most one entry in this table can exist with a given value for Alias, or with a given value for Path. Changes since 2.19:
|
- |
2.16 |
|
AuthRequired |
boolean |
R |
When true, USP Endpoints connecting to this Unix Domain Socket MUST authenticate themselves. |
- |
2.20 |
|
RegistrationRestricted |
boolean |
R |
When true, USP Agents connecting to this Unix Domain Socket are only allowed to register data model paths permitted by the USPServices.Trust table. When false, USP Agents connecting to this Unix Domain Socket may register any data model paths (subject to the rules affecting USP Services). |
- |
2.20 |
|
Device.Schedules. |
object |
R |
This object is responsible for managing the schedules that are embedded within the Device. |
- |
2.18 |
|
Device.Schedules.Schedule.{i}. |
object(0:) |
W |
Each instance of this object providesRepresents a schedule wherethat accesscan isbe enabled.}}applied to a feature or resource. 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.18 |
|
Day |
string[] |
W |
Comma-separated list of strings, the days foron which accessthe schedule is enabledactive. Each list item is an enumeration of:
|
- |
2.18 |
|
Duration |
unsignedInt(1:) |
W |
The duration, in seconds, for which the accessassociated schedule is enabled.active. If the StartTime is not defined, this duration isrepresents the total time accessthe schedule is allowedactive during a calendar day. If a StartTime is defined, accessthe schedule is allowedactive for the {{param}}specified periodduration starting from StartTime. |
- |
2.18 |
|
InverseMode |
boolean |
W |
When enabled, thethis Inverseparameter Mode reversesinverts the default behavior of the schedule,associated creatingschedule. aActions dynamicthat wherewould normally be active during the defined schedule are instead inactive, and actions that arewould typicallynormally activatedbe inactive are nowinstead deactivated,active. For example: If a schedule defines Internet access on Monday from 16:00 to 17:00: * With InverseMode = false, Internet access is permitted only between 16:00 and vice17:00 versa.}}on Monday. * With InverseMode = true, Internet access is permitted at all times except between 16:00 and 17:00 on Monday. |
false |
2.18 |
|
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.19:
|
- |
2.19 |
|
Enable |
boolean |
W |
Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.20 |
|
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.20 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE. |
- |
2.20 |
|
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.20 |
|
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.20 |
|
SessionType |
string |
R |
The data session type indicating the protocol the session is capable of carrying. See [Clause 9.11.4.11/3GPP-TS.24.501]. Enumeration of:
Changes since 2.19:
|
- |
2.19 |
|
IPv4AddressNumberOfEntries |
unsignedInt |
R |
The number of entries in the IPv4Address table. |
- |
2.20 |
|
IPv6AddressNumberOfEntries |
unsignedInt |
R |
The number of entries in the IPv6Address table. |
- |
2.20 |
|
Device.SessionManagement.Session.{i}.IPv4Address.{i}. |
object(0:) |
R |
This object models IPv4 network information that the Cellular modem received from the network. At most one entry in this table can exist with a given value for Alias, or with the same values for both IPAddress and SubnetMask. |
- |
2.20 |
|
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.20 |
|
IPAddress |
string(:45) |
R |
[IPv4Address] IPv4 address. |
- |
2.20 |
|
SubnetMask |
string(:45) |
R |
[IPv4Address] Subnet mask. |
- |
2.20 |
|
GatewayIPAddress |
string(:45) |
R |
[IPv4Address] IPv4 address of the gateway. |
- |
2.20 |
|
MTU |
unsignedInt(576:) |
R |
Maximum Transmission Unit for this link (expressed in bytes). at least 576 bytes |
- |
2.20 |
|
Device.SessionManagement.Session.{i}.IPv6Address.{i}. |
object(0:) |
R |
This object models IPv6 network information that the Cellular modem received from the network. At most one entry in this table can exist with a given value for Alias, or with a given value for IPAddress. |
- |
2.20 |
|
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.20 |
|
IPAddress |
string(:45) |
R |
[IPv6Address] IPv6 address. |
- |
2.20 |
|
IPPrefix |
string(:49) |
R |
[IPv6Prefix] IPv6 prefix. An empty string indicates that it matches all destination prefixes (i.e. equivalent to "::/0"). All bits to the right of the prefix MUST be zero, e.g. 2001:edff:fe6a:f76::/64. Routes with a 128-bit prefix length (/128) are host routes for a specific IPv6 destination, e.g. 2001:db8:28:2:713e:a426:d167:37ab/128. |
- |
2.20 |
|
NextHop |
string(:45) |
R |
[IPv6Address] IPv6 address of the next hop. |
- |
2.20 |
|
MTU |
unsignedInt(1280:) |
R |
Maximum Transmission Unit for this link (expressed in bytes). at least 1280 bytes |
- |
2.20 |
|
Device.Hardware. |
object |
R |
Represents the hardware configuration of the device, including details about the CPU, memory, and other hardware components. |
- |
2.20 |
|
Device.Hardware.CPUs. |
object |
R |
Represents the system's CPU configuration, providing details about each individual processor core, its capabilities, and its current operating state. |
- |
2.20 |
|
CPUNumberOfEntries |
unsignedInt |
R |
The number of entries in the CPU table. |
- |
2.20 |
|
Device.Hardware.CPUs.CPU.{i}. |
object(0:) |
R |
Represents a single CPU instance with configurable parameters related to its operational settings. At most one entry in this table can exist with a given value for Alias. |
- |
2.20 |
|
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.20 |
|
Device.Hardware.CPUs.CPU.{i}.DVFS. |
object |
R |
Represents the CPU's Dynamic Voltage and Frequency Scaling (DVFS) configuration. DVFS allows the operating voltage and frequency of the CPU to be dynamically adjusted to optimize power consumption and performance based on workload demands. |
- |
2.20 |
|
Enable |
boolean |
W |
Enables or disables Dynamic Voltage and Frequency Scaling (DVFS) for this CPU. This parameter is only applicable if Supported is true. If Supported is false and this parameter is true the Status will be set to Unsupported. When this parameter is set to false, the Status will be set to Disabled. |
- |
2.20 |
|
Status |
string |
R |
Indicates the status of Dynamic Voltage and Frequency Scaling (DVFS) for this CPU. Enumeration of:
|
- |
2.20 |
|
Supported |
boolean |
R |
Indicates whether this CPU supports DVFS. |
- |
2.20 |
|
CurrentFrequency |
unsignedInt |
R |
The current operating frequency of the CPU in kHz. |
- |
2.20 |
|
MinFrequency |
unsignedInt |
R |
The minimum frequency that the CPU hardware is capable of operating at, in kHz. |
- |
2.20 |
|
MaxFrequency |
unsignedInt |
R |
The maximum frequency that the CPU hardware is capable of operating at, in kHz. |
- |
2.20 |
|
ScalingMinFrequency |
unsignedInt |
W |
The minimum operating frequency allowed for the CPU in kHz. This value must be between MinFrequency and MaxFrequency, and part of the ScalingAvailableFrequencies list. This value must be less than ScalingMaxFrequency. |
- |
2.20 |
|
ScalingMaxFrequency |
unsignedInt |
W |
The maximum operating frequency allowed for the CPU in kHz. This value must be between MinFrequency and MaxFrequency, and part of the ScalingAvailableFrequencies list. This value must be greater than ScalingMinFrequency. |
- |
2.20 |
|
ScalingAvailableFrequencies |
unsignedInt[] |
R |
Comma-separated list of unsigned integers. The available frequencies for CPU scaling in kHz. |
- |
2.20 |
|
ScalingGovernor |
string |
W |
The value MUST be a member of the list reported by the ScalingAvailableGovernors parameter. Indicates the CPU frequency governor to be used. |
- |
2.20 |
|
ScalingAvailableGovernors |
string[] |
R |
Comma-separated list of strings. A list of available CPU frequency governors for this CPU. Each list item is an enumeration of:
|
- |
2.20 |
|
Device.Hardware.PowerManagement. |
object |
R |
This object describes the overall power management capabilities and status of the device, typically referring to the main gateway's power states and features. |
- |
2.20 |
|
Device.Hardware.PowerManagement.Standby. |
object |
R |
This object provides the capability for the Device to enter and exit standby. This functionality allows the Device to operate in a low-power condition. |
- |
2.20 |
|
Capability |
string |
R |
Describes the possible standby states of the Device. Enumeration of:
|
- |
2.20 |
|
Status |
string |
R |
Indicates the current operational status of the standby feature. Enumeration of:
|
- |
2.20 |
|
ScheduleRef |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Schedules.Schedule. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Each reference provides a specific schedule entry that triggers the device to enter and exit standby mode. The referenced schedule defines when the standby transition should occur and when the device should wake up. Overlapping schedules are not allowed. |
- |
2.20 |
|
StandbyOccurred |
boolean |
R |
Indicates that the current boot cycle was a result of exiting standby mode. The parameter value is only set during the device boot process. |
- |
2.20 |
|
NetworkAware |
boolean |
R |
Indicates that the device is capable of maintaining a network connection and responding to communications via the network connection while in a standby state. |
- |
2.20 |
|
TimerAware |
boolean |
R |
Indicates that the device is capable of maintaining and responding to timers while in a standby state. |
- |
2.20 |
|
Device.ConnectionMonitoring. |
object |
R |
This object contains parameters for monitoring the connection status of interfaces. It allows the Device to monitor interfaces using ARP (Address Resolution Protocol) or ND (Neighbor Discovery) packets, depending on the IP version used by the interface. The CPE can enable or disable the connection monitor and configure individual entries for each interface. Each entry can be enabled or disabled independently, allowing for flexible monitoring configurations. |
- |
2.20 |
|
Enable |
boolean |
W |
Enables or disables the connection monitor. |
- |
2.20 |
|
Status |
string |
R |
The current operational state of the monitor. Enumeration of:
|
- |
2.20 |
|
ConnectionNumberOfEntries |
unsignedInt |
R |
The number of entries in the Connection table. |
- |
2.20 |
|
Device.ConnectionMonitoring.Connection.{i}. |
object(0:) |
W |
This object contains parameters for monitoring the connection. The device can enable or disable the connection monitor and configure individual entries for different interfaces. Depending on Method, the device can use different methods to test connectivity, such as ARP, ND, Ping, BFDEcho or DNS. During normal operation, a connectivity check is performed every MonitorInterval. If a check fails, due to no response within MaxResponseTimeout, then the device enters a failure state. In this failure state, it performs subsequent checks more frequently, every FailInterval. The NumberOfAttempts counter is incremented for each failed check and the value of the parameter MonitoringStatus status is set to Unresponsive. If this counter equals the Action.{i}.AttemptCount threshold, the configured Action.{i}.Action is triggered. If a check succeeds at any point, the NumberOfAttempts counter is reset, the monitor interval reverts to the normal MonitorInterval and the MonitoringStatus status is set to Up. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.20 |
|
Enable |
boolean |
W |
Enables or disables the entry. |
- |
2.20 |
|
Status |
string |
R |
The current operational state of the entry. Enumeration of:
|
- |
2.20 |
|
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.20 |
|
Interface |
string(:256) |
W |
The value MUST be the Path Name of a row in the IP.Interface. table, or the Path Name of an interface layered above such a row, e.g., a row in the Logical.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This parameter specifies the interface to be monitored. Typically this is the WAN interface. |
<Empty> |
2.20 |
|
MonitorInterval |
unsignedInt(1:60) |
W |
The interval at which the Device monitors the connection status of the interface, in second. |
60 |
2.20 |
|
FailInterval |
unsignedInt(1:60) |
W |
The interval at which the Device checks for connection failures after the initial monitor interval, in second. |
15 |
2.20 |
|
MaxResponseTimeout |
unsignedInt(1:60) |
W |
The maximum time the Device waits for a response after sending a connectivity test packet, in second. |
1 |
2.20 |
|
NumberOfAttempts |
unsignedInt |
R |
The current number of failed attempts when no reply is obtained. This parameter is reset to zero when the last Action has been executed or when a connectivity test succeeds. |
- |
2.20 |
|
Method |
string |
W |
The connectivity test method to be performed on the Interface. Enumeration of:
|
- |
2.20 |
|
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). |
-1 |
2.20 |
|
DestAddress |
string |
W |
The destination address (IP address or FQDN) to which connectivity test packets are sent. When IPVersion is set to '-1',the implementation will chose and use only one IP version for testing the connectivity. It will try to use IPv6 first, and if that fails, it will fall back to IPv4. When Method is set to ARP or ND this parameter specifies the IP address of the network device under test. The Device will send ARP requests (for IPv4) or Neighbor Solicitation messages (for IPv6) to this address to check connectivity. When an empty string the Device will use the default gateway IP address from the Interface specified in the Interface parameter. When Method is set to Ping this parameter specifies the IP address to which ICMP Echo Request packets are sent. The Device will send ICMP Echo Requests to this address to check connectivity. When an empty string the Device will use the default gateway IP address from the Interface specified in the Interface parameter. When Method is set to BFDEcho this parameter specifies the IP address to which BFD echo packets are sent. The Device will send BFD Echo packets to this address to check connectivity. When an empty string the Device will use the default gateway IP address from the Interface specified in the Interface parameter. When Method is set to DNS this parameter specifies the DNS server (IP address or FQDN) to which DNS queries are sent. When an empty string the Device will use the default DNS server configured on the Interface specified in the Interface parameter. |
- |
2.20 |
|
DSCPMark |
unsignedInt(0:63) |
W |
Diffserv code point to be used for outgoing connection monitoring traffic. |
48 |
2.20 |
|
EthernetPriority |
int(-1:7) |
W |
The Ethernet Priority for this Connection entry, also known as 802.1p Priority, is a 3-bit field used to indicate the priority of network traffic. A value of -1 indicates that the Ethernet priority should not be changed for this Connection. |
- |
2.20 |
|
MonitoringStatus |
string |
R |
The current monitoring status of the connection. Enumeration of:
|
- |
2.20 |
|
ActionNumberOfEntries |
unsignedInt |
R |
The number of entries in the Action table. |
- |
2.20 |
|
Device.ConnectionMonitoring.Connection.{i}.Action.{i}. |
object(0:) |
W |
This object contains parameters for actions to be taken when a connection failure is detected. Each action can be configured independently and can be enabled or disabled. The Device will perform the specified action when the value of NumberOfAttempts equals the value of AttemptCount parameter. Multiple actions can be defined for a connection. As failures persist, the NumberOfAttempts will continue to increment, which can trigger subsequent actions with higher AttemptCount values. The NumberOfAttempts counter is reset to zero only after the last action has been executed or when a connectivity test succeeds. 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 AttemptCount. |
- |
2.20 |
|
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.20 |
|
Enable |
boolean |
W |
Enables or disables the Action entry. |
- |
2.20 |
|
AttemptCount |
unsignedInt(1:100) |
W |
Indicates the action to be taken when the connection's NumberOfAttempts is equal to the value of this parameter. |
5 |
2.20 |
|
Action |
string |
W |
This parameter indicates the action taken by the Device when a connection failure is detected. It can be used to trigger specific actions such as restarting the DHCP client or Interface. Enumeration of:
|
- |
2.20 |
|
Reference |
string |
W |
The value MUST be the Path Name of a row in the IP.Interface., Logical.Interface. or DHCPv4.Client. tables, or the Path Name of an interface layered above such a row, e.g., a row in the Logical.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This parameter specifies the object path to which the Action applies. When Action is set to RestartDHCP, this parameter specifies the path
to the DHCPv4 Client instance (e.g., When Action is set to RestartInterface, this parameter specifies the path
to the Interface instance (e.g., When Action is set to Reboot or None, this parameter is not applicable and its value will be ignored. |
<Empty> |
2.20 |
|
Device.ConnectionMonitoring.Connection.{i}.Stats. |
object |
R |
This object contains statistics for the connection monitoring entry. It provides counters for connection test failures, total triggered actions. |
- |
2.20 |
|
TotalNumberOfAttempts |
unsignedLong |
R |
[StatsCounter64] The total number of failed attempts when no reply is obtained, since the last boot. Active Notification requests for this parameter MAY be denied. |
- |
2.20 |
|
TotalTriggeredActions |
unsignedLong |
R |
[StatsCounter64] Total amount of triggered actions since last boot. Active Notification requests for this parameter MAY be denied. |
- |
2.20 |
|
Device.WireGuard. |
object |
R |
This object contains configuration and status for the WireGuard subsystem. The WireGuard subsystem is used to create secure tunnels between devices using the WireGuard protocol. |
- |
2.20 |
|
TunnelNumberOfEntries |
unsignedInt |
R |
The number of entries in the Tunnel table. |
- |
2.20 |
|
PeerNumberOfEntries |
unsignedInt |
R |
The number of entries in the Peer table. |
- |
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 |
|
Enable |
boolean |
W |
Enables or disables the tunnel. |
- |
2.20 |
|
Status |
string |
R |
The current operational state of the tunnel. Enumeration of:
|
- |
2.20 |
|
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.20 |
|
PrivateKey |
base64 |
W |
The private key for this WireGuard tunnel. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.20 |
|
PublicKey |
base64 |
R |
The public key for this WireGuard tunnel, corresponding to the PrivateKey. |
- |
2.20 |
|
ListenPort |
unsignedInt(0:65535) |
W |
The port on which this WireGuard tunnel will listen for incoming connections. If set to 0, a random port will be chosen by the device. |
- |
2.20 |
|
PeerReferences |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Peer. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Each element represents a reference to the peers associated with this Tunnel entry. |
- |
2.20 |
|
InterfaceNumberOfEntries |
unsignedInt |
R |
The number of entries in the Interface table. |
- |
2.20 |
|
Device.WireGuard.Tunnel.{i}.Interface.{i}. |
object(0:) |
W |
WireGuard Interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). The Interface object provides a way to discriminate how sessions or flows are encapsulated within the WireGuard Tunnel. In addition the Interface object represents the entry point and exit point of the tunnel in relation to the LAN interface. Compared to other tunnel protocols, WireGuard does not have a concept of multiple interfaces within a tunnel. Therefore, a WireGuard Tunnel will only have one Interface instance. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.20 |
|
Enable |
boolean |
W |
Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
false |
2.20 |
|
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]. |
Down |
2.20 |
|
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.20 |
|
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.20 |
|
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.20 |
|
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]. |
<Empty> |
2.20 |
|
Device.WireGuard.Tunnel.{i}.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.20 |
|
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.20 |
|
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.20 |
|
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.20 |
|
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. |
- |
2.20 |
|
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packets received on the interface. Active Notification requests for this parameter MAY be denied. |
- |
2.20 |
|
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.20 |
|
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.20 |
|
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.20 |
|
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.20 |
|
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.20 |
|
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.20 |
|
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.20 |
|
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.20 |
|
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. Note that IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment. Active Notification requests for this parameter MAY be denied. |
- |
2.20 |
|
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. Note that IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment. Active Notification requests for this parameter MAY be denied. |
- |
2.20 |
|
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.20 |
|
Device.WireGuard.Tunnel.{i}.Stats. |
object |
R |
Statistics for this WireGuard tunnel, i.e. all traffic that has passed through the tunnel. The device MUST reset the tunnel's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the tunnel becomes operationally down due to a previous administrative down (i.e., Status parameter transitions to a disabled state after the tunnel has been disabled) or when the tunnel becomes administratively up (i.e. the Enable parameter transitioned from false to true). |
- |
2.20 |
|
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytes sent by the tunnel. |
- |
2.20 |
|
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytes received by the tunnel. |
- |
2.20 |
|
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets sent by the tunnel. |
- |
2.20 |
|
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packets received by the tunnel. |
- |
2.20 |
|
ErrorsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets discarded by the tunnel due to any error. This can include packets dropped due to a lack of transmit buffers. |
- |
2.20 |
|
ErrorsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packets received by the tunnel that contained errors preventing them from being delivered to a higher-layer protocol. |
- |
2.20 |
|
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 |
|
Enable |
boolean |
W |
Enables or disables this Peer configuration. |
- |
2.20 |
|
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.20 |
|
PublicKey |
string |
W |
Public key of the peer. |
- |
2.20 |
|
|
string |
W |
The pre-shared key for this WireGuard Peer. When an empty string is provided, no pre-shared key is used. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.20 |
|
AllowedIPs |
string(:45)[] |
W |
[IPAddress] Comma-separated list of IP Addresses. Each item represents an IPv4/v6 subnets in CIDR notation from which incoming traffic is allowed and to which outgoing traffic is directed for this peer. '0.0.0.0/0' maybe specified for matching all IPv4 addresses and '::/0' for matching all IPv6 addresses. When an empty string is provided, no traffic is routed to this peer. |
- |
2.20 |
|
EndpointAddress |
string |
W |
The remote network address (IP or hostname) of the peer. An empty string indicates that the endpoint address is not used. |
- |
2.20 |
|
EndpointPort |
int(-1,1:65535) |
W |
The UDP port of the remote peer. A value of |
- |
2.20 |
|
PersistentKeepalive |
unsignedInt(0:65535) |
W |
An interval in seconds to send an authenticated empty packet to the peer. This
is useful for keeping NAT mappings alive. A value of |
- |
2.20 |
|
LastHandshakeTime |
unsignedInt |
R |
The amount of time in seconds since the last handshake was sent with this peer. |
- |
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.Controller.{i}. |
object(0:) |
W |
Each instance of this table represents a USP Controller that has access to this USP Agent. On the deletion of an entry from this table, the Agent MUST send the ObjectDeletion notification to all subscribed recipients, even if the recipient is the deleted Controller itself. This notification is the last notification sent to this Controller. At most one entry in this table (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.15 |
|
Device.USPAgent.Controller.{i}.MTP.{i}. |
object(0:) |
W |
Each instance of this table represents a MTP used by this Controller. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Protocol. |
- |
2.15 |
|
Device.USPAgent.Controller.{i}.MTP.{i}.UDS. |
object(0:1) |
R |
If the USP Endpoint uses the Unix Domain Socket (UDS) Message Transfer Protocol (MTP), then this object contains UDS specific configuration parameters related to how this Agent communicates with a Controller on another USP Endpoint. An example of how to set up this MTP can be found in [ Section "Example Data Models for a USP Broker and USP Services"/TR-369]. This object MUST be present if, and only if, Protocol is UDS. This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time. |
- |
2.16 |
|
UnixDomainSocketRef |
string |
W |
The value MUST be the Path Name of a row in the UnixDomainSockets.UnixDomainSocket. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. A reference to the Unix Domain Socket used by thisthe AgentController when communicating via the UDS MTP. |
<Empty> |
2.16 |
|
Device.USPAgent.ControllerTrust. |
object |
R |
This object contains information that an Agent applies when establishing a trust relationship with a Controller. |
- |
2.15 |
|
Device.USPAgent.ControllerTrust.Role.{i}. |
object(0:) |
W |
Each instance of this table represents a Role that can be assigned to or inherited by a Controller via the Controller Trust mechanism. The Role contains a set of permissions that determine how the Controller can interact with the data model. If multiple permission entries associated with this table contain a Target that evaluates to the same instantiated Object/Parameter for multiple Roles, then the permissions to be used are a union of the identified permissions. At most one entry in this table (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.15 |
|
Device.USPAgent.ControllerTrust.Role.{i}.Permission.{i}. |
object(0:) |
W |
Each instance of this table represents the permissions that are extended to a set of Targets for a specified Role. If there are multiple entries in this table for a specific Role where the Targets overlap, the permissions for the entry with the highest value takes priority over all others. At most one entry in this table (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.15 |
|
Obj |
string(4) |
W |
The permissions of a Role for the specified Targets. A string of 4 characters where each character represents a permission (" The string is always in the same order ( The following describes the meaning of the permissions for Object type of Targets:
|
---- |
2.15 |
|
InstantiatedObj |
string(4) |
W |
The permissions of a Role for the specified Targets. A string of 4 characters where each character represents a permission (" The string is always in the same order ( The following describes the meaning of the permissions for Instantiated Object type of Targets:
|
---- |
2.15 |
Generated by Broadband Forum bbfreport v2.4.0 (2025-11-11 version) on 2025-11-11 at 23:07:50 UTC.
report.py --include ../../install/cwmp --output tr-181-2-20-0-cwmp-diffs.html --show --transform diff --format html tr-181-2-19-1-cwmp.xml tr-181-2-20-0-cwmp.xml
