![]() | Device:2 Root Data Model definition [CWMP] (changes)tr-181-2-19-1-cwmp.xml | ||
DATA MODEL DEFINITION |
License
Copyright (c) 2010-2025, Broadband Forum
The undersigned members have elected to grant the copyright to
their contributed material used in this software:
Copyright (c) 2017-2019, 2021 ARRIS Enterprises, LLC.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The above license is used as a license under copyright only. Please reference the Forum IPR Policy for patent licensing terms https://www.broadband-forum.org/ipr-policy.
Any moral rights which are necessary to exercise under the above license grant are also deemed granted under this license.
Data Types
The Parameters defined in this specification make use of a limited subset of the default SOAP data types [SOAP1.1]. These data types and the named data types used by this specification are described below.
Note: A Parameter that is defined to be one of the named data types is reported as such at the beginning of the Parameter's description via a reference back to the associated data type definition (e.g. [MACAddress]). However, such parameters still indicate their SOAP data types.
Data Type | Base Type | Description |
---|---|---|
boolean |
- |
Boolean, where the allowed values are 0 or 1 (or equivalently, true or false). |
dateTime |
- |
The subset of the ISO 8601 date-time format defined by the SOAP dateTime type [SOAP1.1]. |
decimal |
- |
Decimal number, with optional sign and optional fractional part. For some decimal types, a value range is given using the form decimal(Min:Max) or decimal(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.0. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges. |
hexBinary |
- |
Hex encoded binary. A minimum and maximum allowed length can be indicated using the form hexBinary(Min:Max), where Min and Max are the minimum and maximum length in characters before Hex Binary encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in hexBinary(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges. |
int |
- |
Integer in the range -2147483648 to +2147483647, inclusive. For some int types, a value range is given using the form int(Min:Max) or int(Min:Max step Step) where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges. |
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. |
|
PLMNId |
Public Land Mobile Network Identifier. PLMN-Id is a concatenation of Mobile Country Code (MCC) and Mobile Network Code (MNC) as described in [Clause 12.1/3GPP-TS.23.003]. MCC value is always 3 digits, while the MNC value is either 2 or 3 digits. For example, a PLMN-Id value of 310410 refers to MCC 310 (USA) and MNC 410 (AT&T Mobility). A PLMN-Id value of 51001 refers to MCC 501 (Australia) and MNC 01 (Telstra). Refer <https://mcc-mnc.net> for the list of PLMN-Ids assigned to various operators around the world. |
|
SST |
Service Slice Type (SST). Enumeration of:
|
|
StatsCounter32 |
A 32-bit statistics parameter, e.g. a byte counter. This data type SHOULD NOT be used for statistics parameters whose values might become greater than the maximum value that can be represented as an unsignedInt (i.e. 0xffffffff, referred to below as maxval). StatsCounter64 SHOULD be used for such parameters. The value maxval indicates that no data is available for this parameter. In the unlikely event that the actual value of the statistic is maxval, the CPE SHOULD return maxval - 1. The actual value of the statistic might be greater than maxval. Such values SHOULD wrap around through zero. The term packet is to be interpreted as the transmission unit appropriate to the protocol layer in question, e.g. an IP packet or an Ethernet frame. |
|
StatsCounter64 |
A 64-bit statistics parameter, e.g. a byte counter. This data type SHOULD be used for all statistics parameters whose values might become greater than the maximum value that can be represented as an unsignedInt. The maximum value that can be represented as an unsignedLong (i.e. 0xffffffffffffffff) indicates that no data is available for this parameter. The term packet is to be interpreted as the transmission unit appropriate to the protocol layer in question, e.g. an IP packet or an Ethernet frame. |
|
ThreadLinkQuality |
unsignedInt(0:3) |
Encoded intervals representation of the Thread link quality:
|
URI |
string(:2048) |
Uniform Resource Identifier. See [RFC3986]. |
References
3GPP TS 23.003, Numbering, addressing and identification, 3GPP CT WG4. |
|
3GPP TS 23.501, System architecture for the 5G System (5GS); Stage 2, 3GPP SA WG2. |
|
3GPP TS 24.008, Mobile radio interface Layer 3 specification; Core network protocols; Stage 3, 3GPP CT WG1. |
|
3GPP TS 24.301, Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3, 3GPP CT WG1. |
|
3GPP TS 24.501, Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3, 3GPP CT WG1. |
|
3GPP TS 24.007, AT command set for User Equipment (UE), 3GPP CT WG1. |
|
3GPP TS 31.102, Characteristics of the USIM application, 3GPP. |
|
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. |
|
IEEE Std 802.1ad-2005, Virtual Bridged Local Area Networks Amendment 4: Provider Bridges, IEEE, May 2005. |
|
IEEE Std 802.1AX-2014, IEEE Standard for Local and metropolitan area networks - Link Aggregation, IEEE, 2014. |
|
IEEE Std 802.1D-2004, Media Access Control (MAC) Bridges, IEEE, 2004. |
|
IEEE Std 802.1Q-2005, Virtual Bridged Local Area Networks, IEEE, 2006. |
|
IEEE Std 802.1Q-2011, MAC Bridges and Virtual Bridge Local Area Networks, IEEE, 2011. |
|
IEEE Std 802.1x-2004, Standards for Local and Metropolitan Area Networks: Port based Network Access Control, IEEE, 2004. |
|
IEEE Std 802.3-2015, IEEE Standard for Ethernet, IEEE, 2015. |
|
[AFCSDI] |
AFC System to AFC Device Interface (SDI) Specification, Wi-Fi AFC System to AFC Device Interface (SDI) Specification, Wi-Fi Alliance, May 2024. |
CM-SP-MULPIv3.0, DOCSIS 3.0 MAC and Upper Layer Protocols Interface Specification, CableLabs, December 2017. |
|
CM-SP-RFIv2.0, Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification, CableLabs, April 2009. |
|
Data Elements Specification, Wi-Fi Data Elements Specification, Wi-Fi Alliance, 2024. |
|
[DNS-SD] |
RFC 6763, DNS-Based Service Discovery, IETF, 2013. |
Wi-Fi Easy Connect Specification, Wi-Fi Easy Connect Specification, Wi-Fi Alliance, November 2022. |
|
[EasyMesh] |
EasyMesh Specification, Wi-Fi EasyMesh Specification, Wi-Fi Alliance, August 2024. |
[G.9701] |
G.9701, Fast access to subscriber terminals (G.fast)- Physical layer specification, ITU-T, 2014. |
[G.988] |
G.988, ONU management and control interface (OMCI) specification, ITU-T, 2010. |
[G.993.1] |
G.993.1, Very high speed digital subscriber line transceivers, ITU-T. |
[G.9954] |
G.9954, Phoneline networking transceivers - Enhanced physical, media access, and link layer specifications (HPNA 3.0 and 3.1), ITU-T, 2007. |
[G.996.2] |
G.996.2, Single-ended line testing for digital subscriber lines (DSL), ITU-T. |
[G.9960] |
G.9960, Unified high-speed wire-line based home networking transceivers - System architecture and physical layer specification, ITU-T. |
[G.9961] |
G.9961, Unified high-speed wire-line based home networking transceivers - Data link layer specification, ITU-T. |
[G.9964] |
G.9964, Unified high-speed wire-line based home networking transceivers - Power spectral density specification, ITU-T. |
[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. |
|
IANAMauMIB, IANA-MAU-MIB DEFINITIONS, IANA, 2022. |
|
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. |
|
ITU E.118, The international telecommunication charge card, International Telecommunication Union, May 2006. |
|
ITU E.164, The international public telecommunication numbering plan, International Telecommunication Union, October 2010. |
|
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. |
Passpoint, Passpoint Specification, Wi-Fi Alliance. |
|
[RFC1661] |
RFC 1661, The Point-to-Point Protocol (PPP), IETF, 1994. |
[RFC2104] |
RFC 2104, HMAC: Keyed-Hashing for Message Authentication, IETF, 1997. |
[RFC2131] |
RFC 2131, Dynamic Host Configuration Protocol, IETF. |
[RFC2132] |
RFC 2132, DHCP Options and BOOTP Vendor Extensions, IETF. |
[RFC2784] |
RFC 2784, Generic Routing Encapsulation (GRE), IETF, November 2000. |
[RFC2863] |
RFC 2863, The Interfaces Group MIB, IETF, 2000. |
[RFC2890] |
RFC 2890, Key and Sequence Number Extensions to GRE, IETF, November 2000. |
[RFC3118] |
RFC 3118, Authentication for DHCP Messages, IETF, June 2001. |
[RFC3203] |
RFC 3203, DHCP reconfigure extension, IETF, December 2001. |
[RFC3315] |
RFC 3315, Dynamic Host Configuration Protocol for IPv6 (DHCPv6), IETF, 2003. |
[RFC3931] |
RFC 3931, Layer Two Tunneling Protocol - Version 3 (L2TPv3), IETF, March 2005. |
[RFC3986] |
RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF. |
[RFC4007] |
RFC 4007, IPv6 Scoped Address Architecture, IETF. |
[RFC4122] |
RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005. |
[RFC4291] |
RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006. |
[RFC4632] |
RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan, IETF, 2006. |
[RFC4719] |
RFC 4719, Transport of Ethernet Frames over Layer 2 Tunneling Protocol Version 3 (L2TPv3), IETF, November 2006. |
[RFC4868] |
RFC 4868, Using HMAC-SHA-256, HMAC-SHA-384, and HMAC-SHA-512 with IPsec, IETF, 2007. |
[RFC5625] |
RFC 5625, DNS Proxy Implementation Guidelines, IETF, 2009. |
[RFC6614] |
RFC 6614, Transport Layer Security (TLS) Encryption for RADIUS, IETF, May 2012. |
[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. |
[RFC7301] |
RFC 7301, Transport Layer Security (TLS) Application-Layer Protocol Negotiation Extension, IETF, July 2014. |
[RFC7348] |
RFC 7348, Virtual eXtensible Local Area Network (VXLAN), IETF, August 2014. |
[RFC7468] |
RFC 7468, Textual Encoding of PKIX, PKCS, and CMS Structures, IETF, April 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. |
[RFC7693] |
RFC 7693, The BLAKE2 Cryptographic Hash and Message Authentication Code (MAC), IETF, November 2015. |
[RFC8141] |
RFC 8141, Uniform Resource Names (URNs), IETF, April 2017. |
[RFC8415] |
RFC 8415, Dynamic Host Configuration Protocol for IPv6 (DHCPv6), IETF, November 2018. |
[RFC8822] |
RFC 8822, 5G Wireless Wireline Convergence User Plane Encapsulation (5WE), IETF, April 2021. |
[RFC8966] |
RFC 8966, The Babel Routing Protocol, IETF, January 2021. |
[RFC8967] |
RFC 8967, MAC Authentication for the Babel Routing Protocol, IETF, January 2021. |
[RFC8968] |
RFC 8968, Babel Routing Protocol over Datagram Transport Layer Security, IETF, January 2021. |
[RFC9046] |
RFC 9046, Babel Information Model, IETF, June 2021. |
[RFC9147] |
RFC 9147, The Datagram Transport Layer Security (DTLS) Protocol Version 1.3, IETF, April 2022. |
[SFF-8024] |
SFF-8024, SFF Module Management Reference Code Tables, SNIA, May 2021. |
[SFF-8079] |
SFF-8079, SFP Rate and Application Selection, SNIA, February 2005. |
[SFF-8431] |
SFF-8431, SFP+ 10 Gb/s and Low Speed Electrical Interface, SNIA, July 2009. |
[SFF-8472] |
SFF-8472, Management Interface for SFP+, SNIA, March 2021. |
[SOAP1.1] |
Simple Object Access Protocol (SOAP) 1.1, W3C. |
Thread Network Fundamentals, Thread Network Fundamentals, Version 3, Thread Group. |
|
Thread Specification, Thread Specification, Version 1.3, Thread Group. |
|
[TR-069] |
TR-069 Amendment 6, CPE WAN Management Protocol, Broadband Forum, April 2018. |
[TR-106] |
TR-106 Amendment 8, Data Model Template for CWMP Endpoints and USP Agents, Broadband Forum, May 2018. |
[TR-159] |
TR-159, Management Framework for xDSL Bonding, Broadband Forum, December 2008. |
[TR-181i2] |
TR-181 Issue 2 Amendment 15, Device Data Model, Broadband Forum, January 2022. |
[TR-471] |
TR-471, Maximum IP-Layer Capacity Metric, Related Metrics, and Measurements, Broadband Forum, December 2023. |
[UPA-PLC] |
Universal Powerline Association, UPA. |
[USB1.0] |
USB 1.0, USB 1.0 Specification, USB-IF, January 1996. |
[USB2.0] |
USB 2.0, USB 2.0 Specification, USB-IF, April 2000. |
[USB3.0] |
USB 3.0, USB 3.0 Specification, USB-IF, November 2008. |
draft-ietf-netmod-syslog-model, A YANG Data Model for Syslog Configuration, IETF, April 2023. |
|
ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007. |
Legend
Object definition. |
Parameter definition. |
Device:2.19 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.18:
- Changed name = Device:2.18 ⇒ Device:2.19
Name | Type | Write | Description | Object Default | Version |
---|---|---|---|---|---|
Device. |
object |
R |
The top-level object for a Device. Changes since 2.18:
|
- |
2.0 |
CollectionDeviceNumberOfEntries |
unsignedInt |
R |
The number of entries in the CollectionDevice table. |
- |
2.19 |
Device.DeviceInfo. |
object |
R |
This object contains general device information. Changes since 2.18:
|
- |
2.0 |
Device.DeviceInfo.PowerStatus. |
object |
R |
Status of the power consumption of the device. |
- |
2.19 |
PowerSensorNumberOfEntries |
unsignedInt |
R |
The number of entries in the PowerSensor table. |
- |
2.19 |
Device.DeviceInfo.PowerStatus.PowerSensor.{i}. |
object(0:) |
R |
Represents the power sensor parameters including voltage, current, and power measurements. At most one entry in this table can exist with a given value for Name, or with a given value for Alias. |
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.19 |
Enable |
boolean |
W |
Indicates whether or not the power sensor is enabled. |
- |
2.19 |
Status |
string |
R |
The status of this power sensor. Enumeration of:
|
- |
2.19 |
Name |
string |
R |
Name of this power sensor. This text MUST be sufficient to distinguish this power sensor from other power sensors. |
- |
2.19 |
LastUpdate |
dateTime |
R |
The time at which this power sensor's last good reading was obtained. The Unknown Time value, as defined in [TR-106], indicates a good reading has not been obtained since last reset. Active Notification requests for this parameter MAY be denied. |
- |
2.19 |
Voltage |
int |
R |
The voltage measured by the sensor, in mV. |
- |
2.19 |
Current |
int |
R |
The current measured by the sensor, in mA. |
- |
2.19 |
Power |
int |
R |
The power measured by the sensor, in mW. |
- |
2.19 |
Device.DeviceInfo.KernelFaults. |
object |
R |
A fault in the context of the Kernel refers to a situation where the kernel encounters a critical error or a bug that it cannot recover from. When this happens, the kernel generates a "fault message" or "kernel panic", which provides information about the error, the state of the system at the time of the error, and a stack trace of function calls leading up to the error. Changes since 2.18:
|
- |
2.17 |
RotateKernelFaultEntries |
boolean |
W |
When enabled and once the maximum KernelFault entries as indicated by MaxKernelFaultEntries are reached, the oldest entry, determined by KernelFault.{i}.TimeStamp, is removed to make space for a new one, which is assigned a new instance identifier and a new KernelFault.{i}.Alias. This setting does not affect the counting of Kernel faults. |
- |
2.19 |
MaxKernelFaultEntries |
unsignedInt |
W |
The maximum number of entries available in the KernelFault table. Defines the maximum number of KernelFault instances that can be stored on the device. IfWhen RotateKernelFaultEntries is false and this limit is hit, Nono new KernelFault instances will be created until sufficient Kernel fault instances are removed. When RotateKernelFaultEntries is true and this limit is hit, the table KernelFault is rotated as specified by RotateKernelFaultEntries. Set this parameter to 0 to completely disable the creation of KernelFault instances. Reducing the MaxKernelFaultEntries will cause for the implementation to delete the oldest KernelFault instances. This setting does not affect the counting of Kernel faults. |
- |
2.17 |
Device.DeviceInfo.ProcessFaults. |
object |
R |
Monitoring process faults and configuring the operating system to generate crash dumps and core files is essential for diagnosing and troubleshooting issues with applications and processes. Changes since 2.18:
|
- |
2.17 |
RotateProcessFaultEntries |
boolean |
W |
When enabled and once the maximum ProcessFault entries as indicated by MaxProcessFaultEntries are reached, the oldest entry, determined by ProcessFault.{i}.TimeStamp, is removed to make space for a new one, which is assigned a new instance identifier and a new ProcessFault.{i}.Alias. This setting does not affect the counting of Process faults. |
- |
2.19 |
MaxProcessFaultEntries |
unsignedInt |
W |
The maximum number of entries available in the ProcessFault table. Defines the maximum number of ProcessFault instances that can be stored on the device. IfWhen RotateProcessFaultEntries is false and this limit is hit, Nono new ProcessFault instances will be created until sufficient Process fault instances are removed. When RotateProcessFaultEntries is true and this limit is hit, the table ProcessFault is rotated as specified by RotateProcessFaultEntries. Set this parameter to 0 to completely disable the creation of ProcessFault instances. Reducing the MaxProcessFaultEntries will cause for the implementation to delete the oldest ProcessFault instances. This setting does not affect the counting of process fault instances are removed. Set this parameter to 0 to completely disable the creation of {{object|ProcessFault}} instances.}}{{div|{{classes}}|Reducing the {{param}} will cause for the implementation to delete the oldest {{object|ProcessFault}} instances.}}{{div|{{classes}}|This setting does not affect the counting of process faults. |
- |
2.17 |
Device.Time. |
object |
R |
This object contains global parameters relating to the NTP time clients and or servers that are active in the device. This object can be used to model SNTP and NTP clients and servers. Both NTP and SNTP have identical packet formats and use the same mathematical operations to calculate client time, clock offset, and roundtrip delay. From the perspective of an NTP or SNTP server, there is no difference between NTP and SNTP clients, and from the perspective of an NTP or SNTP client, there is no difference between NTP and SNTP servers. SNTP servers are stateless like NTP servers in non-symmetric modes and can handle numerous clients, but SNTP clients usually operate with only one server at a time, unlike most NTP clients. |
- |
2.0 |
Status |
string |
R |
Reflects the global time synchronisation status of the CPE. Enumeration of:
|
- |
2.0 |
NTPServer1 |
string(:64) |
W |
First NTP timeserver. Either a host name or IP address. This parameter was DEPRECATED in 2.16 due to the introduction of Client. This parameter was OBSOLETED in 2.18. This parameter was DELETED in 2.19. Changes since 2.18:
|
- |
2.0 |
NTPServer2 |
string(:64) |
W |
Second NTP timeserver. Either a host name or IP address. This parameter was DEPRECATED in 2.16 due to the introduction of Client. This parameter was OBSOLETED in 2.18. This parameter was DELETED in 2.19. Changes since 2.18:
|
- |
2.0 |
NTPServer3 |
string(:64) |
W |
Third NTP timeserver. Either a host name or IP address. This parameter was DEPRECATED in 2.16 due to the introduction of Client. This parameter was OBSOLETED in 2.18. This parameter was DELETED in 2.19. Changes since 2.18:
|
- |
2.0 |
NTPServer4 |
string(:64) |
W |
Fourth NTP timeserver. Either a host name or IP address. This parameter was DEPRECATED in 2.16 due to the introduction of Client. This parameter was OBSOLETED in 2.18. This parameter was DELETED in 2.19. Changes since 2.18:
|
- |
2.0 |
NTPServer5 |
string(:64) |
W |
Fifth NTP timeserver. Either a host name or IP address. This parameter was DEPRECATED in 2.16 due to the introduction of Client. This parameter was OBSOLETED in 2.18. This parameter was DELETED in 2.19. Changes since 2.18:
|
- |
2.0 |
Device.Time.Client.{i}. |
object(0:) |
W |
This object contains parameters relating to an time client instance. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. Changes since 2.18:
|
- |
2.16 |
Status |
string |
R |
Status of Time support for this client. Enumeration of:
Changes since 2.18:
|
- |
2.16 |
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.19 |
ServerInUse |
string |
R |
Specifies the server currently used for time synchronization. The value reported is the exact server entry as configured in the Servers parameter. If the server is specified as a Fully Qualified Domain Name (FQDN) in the Servers parameter, the configured FQDN will be reported here, not the resolved IP address or CNAME. |
- |
2.19 |
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. Changes since 2.18:
|
- |
2.16 |
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. Points toSpecifies the server certificate to be presented by the webserver interface.during Onlythe requiredTLS 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 {{param|Protocol}}a TLS session is setbeing to HTTPS.used. |
<Empty> |
2.16 |
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.19 |
CACertificate |
string |
W |
The value MUST be the Path Name of a row in the Security.Certificate. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Points to the CA certificate that must be used by the web interface. The CACertificate is used to validate the web client certificate. Protocol MUST be set to HTTPS.HTTPS This parameter was DEPRECATED in 2.19 Replaced by CABundle which can now contain one or more reference. Changes since 2.18:
|
<Empty> |
2.16 |
IPv4AllowedSourcePrefix |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. Allow only access from the provided list of IPv4 prefixes. When IPv4AllowedSourcePrefix is set to an empty string and AllowAllIPv4 is set to false, no incoming connections are allowed. When AllowAllIPv4 is set true, IPv4AllowedSourcePrefix is ignored. Changes since 2.18:
|
- |
2.18 |
IPv6AllowedSourcePrefix |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. Allow only access from the provided list of IPv6 prefixes. When IPv6AllowedSourcePrefix is set to an empty string and AllowAllIPv6 is set to false, no incoming connections are allowed. When AllowAllIPv6 is set true, IPv6AllowedSourcePrefix is ignored. Changes since 2.18:
|
- |
2.18 |
Device.UserInterface.RemoteAccess. |
object |
R |
This object contains parameters relating to remotely accessing the CPE's user interface. Remote access is defined as any entity not of a local subnet attempting to connect to the CPE. Remote access requires user authentication. To provide remote access authentication the CPE MUST support a "User" table with at least one instance that has "RemoteAccessCapable" set to true. This object was DEPRECATED in 2.16 due to the introduction of HTTPAccess. This object was OBSOLETED in 2.18. This object was DELETED in 2.19. Changes since 2.18:
|
- |
2.0 |
Device.SFPs. |
object |
R |
This object describes the Small Form-Factor Pluggable (SFP) cages and the transceivers hosted in them. The object definition is based on parts of [SFF-8024] and [SFF-8472]. This data model is extensible to support new SFP management protocol standards in the future. |
- |
2.19 |
SFPCageNumberOfEntries |
unsignedInt |
R |
The number of entries in the SFPCage table. |
- |
2.19 |
Device.SFPs.SFPCage.{i}. |
object(0:) |
R |
This object describes a cage into which an SFP is inserted. This object can also describe an instance of Small Form Factor (SFF) units soldered on to the platform. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.19 |
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.19 |
Name |
string |
R |
The internal name used to identify the SFP Cage instance. |
- |
2.19 |
SFPPresent |
boolean |
R |
The value true indicates the presence of a SFP in the SFP Cage instance. The value is always true for a SFF. Note: A value of 0x02 in SFF8024Identifier will also indicate the presence of an SFF. |
- |
2.19 |
SFF8024Identifier |
unsignedInt(0:255) |
R |
Ths identifier describes the type of SFP and the management protocol as per "Identifier Value" listed in [Table 4-1/SFF-8024]. |
- |
2.19 |
MgmtInterface |
string |
R |
This parameter indicates the management interface used by the SFP. Refer [Table 4-1/SFF-8024] and [SFF-8472]. Enumeration of:
|
- |
2.19 |
SFPType |
string |
R |
This value is applicable only when SFPPresent is true. The SFP Type is classified as one of: GPON, XGS-PON, Optical Ethernet, Copper Ethernet. If the SFP Type cannot be classified, the value is reported as "Unsupported". Enumeration of:
|
- |
2.19 |
SFPReference |
string |
R |
The value MUST be the Path Name of a row in the SFPs.Mgmt.SFF8472. table. The path to the SFP management object associated with this interface. |
- |
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 |
SFF8472NumberOfEntries |
unsignedInt |
R |
The number of entries in the SFF8472 table. |
- |
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 |
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.19 |
Name |
string |
R |
The internal name used to identify this SFP instance. |
- |
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 |
Connector |
hexBinary(1) |
R |
The connector value as per [Table 4-3/SFF-8024] indicates the external optical or electrical cable connector provided as the media interface. |
- |
2.19 |
Transceiver |
hexBinary(9) |
R |
This field contains code for electronic or optical compatibility as per [Table 5-3/SFF-8472] and [Table 4-4/SFF-8024]. It corresponds to the values of DMM address 0xA0, bytes 3-10 and 36. The associated bit significant indicators (as identified in the above referenced tables) define the electronic or optical interfaces that are supported by the transceiver. At least one bit will be set in this field. |
- |
2.19 |
Encoding |
unsignedInt(0:255) |
R |
This contains the code for high speed serial encoding algorithm as per [Table 4-2/SFF-8024]. |
- |
2.19 |
BRNominal |
int |
R |
This field contains the Nominal bit signaling rate, in units of 100 MBd as per [Section 5-6/SFF-8472]. The bit rate includes those bits necessary to encode and delimit the signal as well as those bits carrying data information. A value of 0 indicates that the bit rate is not specified and must be determined from the transceiver technology. If the value is 255 (indicating 25.4GBd) then BRMax contains rate in units of 250MBd. |
- |
2.19 |
RateIdentifier |
hexBinary(1) |
R |
The rate identifier byte as per [Table 5-6/SFF-8472] refers to several (optional) industry standard definitions of Rate_Select or Application_Select control behaviors, intended to manage transceiver optimization for multiple operating rates. |
- |
2.19 |
VendorName |
string(:16) |
R |
The vendor name is a string contains ASCII characters that contain the full name of the corporation, a commonly accepted abbreviation of the name of the corporation, the SCSI company code for the corporation, or the stock exchange code for the corporation. At least one of VendorName or VendorOUT shall contain valid data. |
- |
2.19 |
VendorOUI |
hexBinary(3) |
R |
The vendor organizationally unique identifier field (vendor OUI) is a string that contains the IEEE Company Identifier for the vendor. An empty value indicates that the vendor OUI is unspecified. |
- |
2.19 |
VendorPN |
string(:16) |
R |
The vendor part number provided by Transceiver vendor is a string of maximum 16 ASCII characters. An empty string indicates that the vendor PN is unspecified. |
- |
2.19 |
VendorRev |
string(:4) |
R |
The vendor revision number provided by Transceiver vendor is a string of maximum 4 ASCII characters. An empty string indicates that the vendor revision is unspecified. |
- |
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 |
VendorSN |
string(:16) |
R |
The serial number provided by the Transceiver vendor is a string of maximum 16 ASCII characters. An empty string indicates that the vendor SN is unspecified. |
- |
2.19 |
DateCode |
string(:8) |
R |
The transceiver vendor date code. The format is YYMMDDLL where YY - year (00 = 2000), MM - month (01 = January), DD - day (01 to 31), LL - optional vendor lot code. Possible patterns:
|
- |
2.19 |
LengthSMFkm |
unsignedInt(0:255) |
R |
This value specifies the link length in kilometers that is supported by the transceiver while operating in compliance with the applicable standards using single mode fiber. The value is in units of kilometers. A value of 255 means that the transceiver supports a link length greater than 254 km. A value of zero means that the transceiver does not support single mode fiber or that the length information must be determined from the transceiver technology. |
- |
2.19 |
LengthSMF |
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 km A value of zero means that the transceiver does not support 50 micron multimode fiber or that the length information must be determined from the transceiver technology. |
- |
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 km A value of zero means that the transceiver does not support 50 micron multimode 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 MHzkm at 850nm, 500 MHzkm 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 fiber or that the length information must be determined from the transceiver Technology. |
- |
2.19 |
Wavelength |
unsignedInt(0:65535) |
R |
This value denotes the nominal transmitter output wavelength at room temperature measured in nanometers. This field allows the user to read the laser wavelength directly, so it is not necessary to infer it from the transceiver “Code for Electronic Compatibility”. This also allows specification of wavelengths not covered in those fields, such as those used in coarse WDM systems. |
- |
2.19 |
VerCompliance |
hexBinary(1) |
R |
The value indicates which revision of SFF requirements the transceiver complies with. See [Table 8-8/SFF-8472]. |
- |
2.19 |
OptCooledTrans |
boolean |
R |
A value of false identifies a conventional uncooled (or unspecified) laser implementation. A value of true identifies a cooled laser transmitter implementation. See [Table 8-3/SFF-8472]. |
- |
2.19 |
OptPowerlvl |
boolean |
R |
A value of false identifies Power Level 1 (or unspecified) requirements. A value of true identifies Power Level 2 requirement. See [Table 8-3/SFF-8472]. |
- |
2.19 |
OptLinearRcvr |
boolean |
R |
A value of false identifies a conventional limiting (or unspecified) receiver output. A value of true identifies a linear receiver output. See [Table 8-3/SFF-8472]. |
- |
2.19 |
OptRateSelect |
boolean |
R |
A value of true indicates that the optional RATE_SELECT functionality is implemented. See [Table 8-3/SFF-8472]. |
- |
2.19 |
OptTxDisable |
boolean |
R |
A value of true indicates that the optional TX_DISABLE functionality is implemented. See [Table 8-3/SFF-8472]. |
- |
2.19 |
OptTxFault |
boolean |
R |
A value of true indicates that the optional Tx Fault monitoring is implemented. See [Table 8-3/SFF-8472]. |
- |
2.19 |
OptInvertedLOS |
boolean |
R |
A value of true indicates that Loss of Signal implemented with signal inverted from standard definition in SFP MSA (called “Signal Detect”) as per [Table 8-3/SFF-8472]. |
- |
2.19 |
OptLOS |
boolean |
R |
A value of true indicates that this optional transceiver signal for Loss of signal is implemented. See [Table 8-3/SFF-8472]. |
- |
2.19 |
DMCtypeImplemented |
boolean |
R |
A value of true indicates that Digital Diagnostic monitoring is implemented. See [ Section 8-8/SFF-8472]. If set to true, received power monitoring, transmitted power monitoring, bias current monitoring, supply voltage monitoring and temperature monitoring are all implemented. |
- |
2.19 |
DMCtypeInternalCal |
boolean |
R |
A value of true indicates that transceiver is Internally calibrated. The transceiver directly reports calibrated values in units of current, power etc. |
- |
2.19 |
DMCtypeExternalCal |
boolean |
R |
A value of true indicates that transceiver is Externally calibrated. The reported values are A/D counts which must be converted to real world units using calibration values read using additional information from the SFP memory. |
- |
2.19 |
DMCtypeRxAvgPwr |
boolean |
R |
This value indicates the Received power measurement type. If true, average received power is monitored. If false, OMA is monitored. |
- |
2.19 |
EOCalarmsImplemented |
boolean |
R |
A value of true indicates that Alarms/Warnings flags for monitored quantities are implemented in the transceiver. See [Table 8-6/SFF-8472]. |
- |
2.19 |
EOCSoftTxDisable |
boolean |
R |
A value of true indicates that Soft TX_DISABLE control and monitoring is implemented in the transceiver. See [Table 8-6/SFF-8472]. |
- |
2.19 |
EOCSoftTxFault |
boolean |
R |
A value of true indicates that soft TX_FAULT monitoring is implemented in the transceiver. See [Table 8-6/SFF-8472]. |
- |
2.19 |
EOCSoftRxLOS |
boolean |
R |
A value of true indicates that soft RX_LOS is implemented in the transceiver. See [Table 8-6/SFF-8472]. |
- |
2.19 |
EOCSoftRateSelect |
boolean |
R |
A value of true indicates that this soft Rate Select and Control is implemented in the transceiver. See [Table 8-6/SFF-8472]. |
- |
2.19 |
SFF8079AppSelect |
boolean |
R |
A value of true indicates that application rate select feature is implemented in the transceiver. See [Table 8-6/SFF-8472]. |
- |
2.19 |
SFF8431SoftRateSelect |
boolean |
R |
A value of true indicates that Soft Rate Select as per SFF-8431 is implemented in the transceiver. See [Table 8-6/SFF-8472]. |
- |
2.19 |
EMCSPowerLvlOp |
boolean |
R |
A value of true indicates Power Level Operation control and status is implemented in transceiver. See [Table 10-1/SFF-8472]. |
- |
2.19 |
EMCSPowerLvlSelect |
boolean |
R |
A value of true enables selection of power level to transmit. See [Table 10-1/SFF-8472]. |
- |
2.19 |
Device.SFPs.Mgmt.SFF8472.{i}.Transceiver.Thresholds. |
object |
R |
Each alarm and warning quantity has a corresponding high alarm, low alarm, high warning and low warning threshold. These factory preset values allows the determination of when a particular value is outside of “normal” limits as determined by the transceiver manufacturer. It is assumed that these values will vary with different technologies and different implementations and are vendor specific. The values here represent the values after any required calibration. See [Table 9-5/SFF-8472]. |
- |
2.19 |
HighTempAlarm |
int(-274:) |
R |
Temperature, measured in degrees celsius, at which a high temperature alarm will be triggered. |
- |
2.19 |
HighTempWarning |
int(-274:) |
R |
Temperature, measured in degrees celsius, at which a high temperature warning will be triggered. |
- |
2.19 |
LowTempWarning |
int(-274:) |
R |
Temperature, measured in degrees celsius, below which a low temperature warning will be triggered. |
- |
2.19 |
LowTempAlarm |
int(-274:) |
R |
Temperature, measured in degrees celsius, below which a low temperature alarm will be triggered. |
- |
2.19 |
HighVccAlarm |
unsignedInt(0:65535) |
R |
Voltage, measured in mV, above which a high Vcc alarm will be triggered. |
- |
2.19 |
HighVccWarning |
unsignedInt(0:65535) |
R |
Voltage, measured in mV, above which a high Vcc warning will be triggered. |
- |
2.19 |
LowVccWarning |
unsignedInt(0:65535) |
R |
Voltage, measured in mV, below which a low Vcc warning will be triggered. |
- |
2.19 |
LowVccAlarm |
unsignedInt(0:65535) |
R |
Voltage, measured in mV, below which a low Vcc alarm will be triggered. |
- |
2.19 |
HighTxBiasAlarm |
unsignedInt |
R |
Tx Bias, current measured in µA, above which a High Tx Bias alarm will be triggered. |
- |
2.19 |
HighTxBiasWarning |
unsignedInt |
R |
Tx Bias, current measured in µA, above which a High Tx Bias warning will be triggered. |
- |
2.19 |
LowTxBiasWarning |
unsignedInt |
R |
Tx Bias, current measured in µA, below which a Low Tx Bias warning will be triggered. |
- |
2.19 |
LowTxBiasAlarm |
unsignedInt |
R |
Tx Bias, current measured in µA, below which a Low Tx Bias alarm will be triggered. |
- |
2.19 |
HighTxPowerAlarm |
int |
R |
Tx Power, measured in 0.1 dBm, above which a High Tx Power alarm will be triggered. |
- |
2.19 |
HighTxPowerWarning |
int |
R |
Tx Power, measured in 0.1 dBm, above which a High Tx Power warning will be triggered. |
- |
2.19 |
LowTxPowerWarning |
int |
R |
Tx Power, measured in 0.1 dBm, below which a Low Tx Power warning will be triggered. |
- |
2.19 |
LowTxPowerAlarm |
int |
R |
Tx Power, measured in 0.1 dBm, below which a Low Tx Power alarm will be triggered. |
- |
2.19 |
HighRxPowerAlarm |
int |
R |
Rx Power, measured in 0.1 dBm, above which a High Rx Power alarm will be triggered. |
- |
2.19 |
HighRxPowerWarning |
int |
R |
Rx Power, measured in 0.1 dBm, above which a High Rx Power warning will be triggered. |
- |
2.19 |
LowRxPowerWarning |
int |
R |
Rx Power, measured in 0.1 dBm, below which a Low Rx Power warning will be triggered. |
- |
2.19 |
LowRxPowerAlarm |
int |
R |
Rx Power, measured in 0.1 dBm, below which a Low Rx Power alarm will be triggered. |
- |
2.19 |
Device.SFPs.Mgmt.SFF8472.{i}.Transceiver.Status. |
object |
R |
This object contains real time diagnostic and control values and status fields. See [Table 9-16/SFF-8472]. The 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.19 |
Temperature |
int(-274:) |
R |
Internally measured module temperature measured in degrees celsius. See [Table 9-16/SFF-8472]. A value of -274 indicates that a good reading could not be obtained. |
- |
2.19 |
Vcc |
unsignedInt(0:65535) |
R |
Internally measured supply voltage in transceiver measured in mV. See [Table 9-16/SFF-8472]. |
- |
2.19 |
TxBias |
unsignedInt |
R |
Internally measured TX Bias Current measured in µA. See [Table 9-16/SFF-8472]. |
- |
2.19 |
TxPower |
int |
R |
Measured TX output power measured in 0.1 dBm. See [Table 9-16/SFF-8472]. |
- |
2.19 |
RxPower |
int |
R |
Measured RX input power measured in 0.1 dBm. See [Table 9-16/SFF-8472]. |
- |
2.19 |
TxDisableState |
boolean |
R |
The digital state of the TX Disable Input Pin. Updated within 100ms of change on pin. See [Table 9-16/SFF-8472]. |
- |
2.19 |
SoftTxDisableSelect |
boolean |
R |
This optional status control bit allows software disable of laser. See [Table 9-16/SFF-8472]. Setting this flag true disables the laser. If Soft TX Disable is not implemented, the transceiver ignores the value of this bit. Default power up value is zero/low. |
- |
2.19 |
RS1State |
boolean |
R |
An optional digital state of SFP input pin AS(1) per [SFF-8079] or RS(1) per [SFF-8431]. Updated within 100ms of change on pin. See 0xA2 Byte 118, Bit 3 for Soft RS(1) Select control information. See [Table 9-16/SFF-8472]. |
- |
2.19 |
RateSelectState |
boolean |
R |
An optional digital state of SFP input pin AS(0) Rate_Select State [aka. “RS(0)”]. Updated within 100ms of change on pin. Note: This pin is also known as AS(0) in [SFF-8079] and RS(0) in [SFF-8431]. See [Table 9-16/SFF-8472]. |
- |
2.19 |
SoftRateSelectSelect |
boolean |
R |
Soft Rate_Select Select (aka. “RS(0)”). An optional Status or Control Bit. This flag allows software rate select control. Setting this flag true selects full bandwidth operation. This bit is logical OR with the hard Rate_Select, AS(0) or RS(0) pin value. Default at power up is logic zero/low. If Soft Rate Select is not implemented, the transceiver ignores the value of this bit. Note: Specific transceiver behaviors of this bit are identified in referenced documents. See [Table 9-16/SFF-8472]. |
- |
2.19 |
TXFaultState |
boolean |
R |
An optional digital state of the TX Fault Output Pin. Updated within 100ms of change on pin. See [Table 9-16/SFF-8472]. |
- |
2.19 |
RxLOSState |
boolean |
R |
An optional digital state of the RX_LOS Output Pin. Updated within 100ms of change on pin. |
- |
2.19 |
DataReadyBarState |
boolean |
R |
An optional flag that indicates the transceiver has achieved power up and data is ready. The flag remains high until data is ready to be read at which time the device sets the bit low. The default value SHOULD be false. See [Table 9-16/SFF-8472]. |
- |
2.19 |
Device.SFPs.Mgmt.SFF8472.{i}.Transceiver.Alarms. |
object |
R |
This object contains the state of the SFP internal Diagnostic Alarms Flags [Table 9-17/SFF-8472]. |
- |
2.19 |
TemperatureHigh |
boolean |
R |
Set to true when the internal temperature exceeds the high alarm level. |
- |
2.19 |
TemperatureLow |
boolean |
R |
Set to true when the internal temperature is below the low alarm level. |
- |
2.19 |
VccHigh |
boolean |
R |
Set to true when the internal supply voltage exceeds the high alarm level. |
- |
2.19 |
VccLow |
boolean |
R |
Set to true when the internal supply voltage is below the low alarm level. |
- |
2.19 |
TxBiasHigh |
boolean |
R |
Set to true when the TX Bias current exceeds the high alarm level. |
- |
2.19 |
TxBiasLow |
boolean |
R |
Set to true when the TX Bias current is below the low alarm level. |
- |
2.19 |
TxPowerHigh |
boolean |
R |
Set to true when the TX output power exceeds the high alarm level. |
- |
2.19 |
TxPowerLow |
boolean |
R |
Set to true when the TX output power is below the low alarm level. |
- |
2.19 |
RxPowerHigh |
boolean |
R |
Set to true when the Received Power exceeds the high alarm level. |
- |
2.19 |
RxPowerLow |
boolean |
R |
Set to true when the Received Power is below the low alarm level. |
- |
2.19 |
Device.SFPs.Mgmt.SFF8472.{i}.Transceiver.Warnings. |
object |
R |
This object contains the state of the SFP internal Diagnostic Warning Flags [Table 9-17/SFF-8472]. Warning flags indicate conditions outside the normally guaranteed bounds but not necessarily causes of immediate link failures. Certain warning flags may also be defined by the manufacturer as end-of-life indicators (such as for higher than expected bias currents in a constant power control loop). A flag is set for each warning that is active. Implementation is vendor specific. A SFP module has the ability to monitor and warn on a high or low readings for a number of situations. This ability is internal to the SFP and is part of the digital diagnostic interface common to many SFPs. The associated field changes from false to true to signal a warning and changes from true to false to indicate that the warning has cleared. It is recommended that detection of an asserted flag bit will be verified by a second read of the flag at least 100ms later. |
- |
2.19 |
TemperatureHigh |
boolean |
R |
Set to true when the internal temperature exceeds the high warning level. |
- |
2.19 |
TemperatureLow |
boolean |
R |
Set to true when the internal temperature is below the low warning level. |
- |
2.19 |
VccHigh |
boolean |
R |
Set to true when the internal supply voltage exceeds the high warning level. |
- |
2.19 |
VccLow |
boolean |
R |
Set to true when the internal supply voltage is below the low warning level. |
- |
2.19 |
TxBiasHigh |
boolean |
R |
Set to true when the TX Bias current exceeds the high warning level. |
- |
2.19 |
TxBiasLow |
boolean |
R |
Set to true when the TX Bias current is below the low warning level. |
- |
2.19 |
TxPowerHigh |
boolean |
R |
Set to true when the TX output power exceeds the high warning level. |
- |
2.19 |
TxPowerLow |
boolean |
R |
Set to true when the TX output power is below the low warning level. |
- |
2.19 |
RxPowerHigh |
boolean |
R |
Set to true when the Received Power exceeds the high warning level. |
- |
2.19 |
RxPowerLow |
boolean |
R |
Set to true when the Received Power is below the low warning level. |
- |
2.19 |
Device.DSL. |
object |
R |
This object models DSL lines, DSL channels, DSL bonding, and DSL diagnostics. The specific interface objects defined here are Line, Channel, and BondingGroup. Each Line models a layer 1 DSL Line interface, and each Channel models a layer 1 DSL Channel interface where multiple channels can run over a DSL line. In the case where bonding is configured, it is expected that BondingGroup is stacked above the Channel instances within its group. |
- |
2.0 |
Device.DSL.Line.{i}. |
object(0:) |
R |
DSL Line table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models physical DSL lines. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.0 |
Enable |
boolean |
W |
Enables or disables the DSL line.interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.0 |
Status |
string |
R |
The current operational state of the DSL lineinterface (see [Section 4.2.2/TR-181i2]). Enumeration of:
When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863]. Because the interface includes layer 1, the LowerLayerDown value SHOULD never be used. |
- |
2.0 |
Name |
string(:64) |
R |
The textual name of the DSL lineinterface as assigned by the CPE. |
- |
2.0 |
LastChange |
unsignedInt |
R |
The accumulated time in seconds since the DSL lineinterface entered its current operational state. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
Device.DSL.Line.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. Changes since 2.18:
|
- |
2.0 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
Device.DSL.Channel.{i}. |
object(0:) |
R |
DSL Channel table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models DSL channel(s) on top of physical DSL lines. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.0 |
Enable |
boolean |
W |
Enables or disables the channel.interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.0 |
Status |
string |
R |
The current operational state of the channelinterface (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.0 |
Name |
string(:64) |
R |
The textual name of the channelinterface as assigned by the CPE. |
- |
2.0 |
LastChange |
unsignedInt |
R |
The accumulated time in seconds since the channelinterface entered its current operational state. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
Device.DSL.Channel.{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]. Changes since 2.18:
|
- |
2.0 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
Device.DSL.BondingGroup.{i}. |
object(0:) |
R |
DSL bonding group table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each instance is a bonding group, and is expected to be stacked above a Channel instance or a FAST.Line instance for each bonded channel in the group. Many of the parameters within this object, including LowerLayers, are read-only because bonding is not expected to be configured by a Controller. The DSL bonding data model is closely aligned with [TR-159]. Corresponds to [TR-159] oBondingGroup. At most one entry in this table can exist with a given value for Alias, or with a given value for Name, or with a given value for GroupID. |
- |
2.0 |
Enable |
boolean |
W |
Enables or disables the bonding group.interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.0 |
Status |
string |
R |
The current operational state of the bonding groupinterface (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.0 |
Name |
string(:64) |
R |
The textual name of the bonding groupinterface as assigned by the CPE. |
- |
2.0 |
LastChange |
unsignedInt |
R |
The accumulated time in seconds since the bonding groupinterface entered its current operational state. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
Device.DSL.BondingGroup.{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]. Changes since 2.18:
|
- |
2.0 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
Device.FAST. |
object |
R |
This object models FAST (defined in ITU Recommendation [G.9701]) lines. Each Line models a layer 1 FAST Line interface. |
- |
2.11 |
Device.FAST.Line.{i}. |
object(0:) |
R |
FAST Line table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models physical FAST lines. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. Changes since 2.18:
|
- |
2.11 |
Enable |
boolean |
W |
Enables or disables the FAST line. interface.This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.11 |
Status |
string |
R |
The current operational state of the FAST lineinterface (see [Section 4.2.2/TR-181i2]). Enumeration of:
When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863]. Because the interface includes layer 1, the LowerLayerDown value SHOULD never be used. |
- |
2.11 |
Name |
string(:64) |
R |
The textual name of the FAST lineinterface as assigned by the CPE. |
- |
2.11 |
LastChange |
unsignedInt |
R |
The accumulated time in seconds since the FAST lineinterface entered its current operational state. Active Notification requests for this parameter MAY be denied. |
- |
2.11 |
Device.FAST.Line.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. Changes since 2.18:
|
- |
2.11 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.11 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.11 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.11 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.11 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.11 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.11 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.11 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.11 |
Device.Optical. |
object |
R |
This object models a generic optical interface. It defines an Interface object that models a layer 1 optical interface that is capable of transporting Ethernet packets. For historical reasons, the data model definition is based on parts of [G.988]. However, it is not intended to model anything specific to IEEE PON or ITU-T PON technologies. Note that this object is not intended to model the optical transceiver either. |
- |
2.4 |
Device.Optical.Interface.{i}. |
object(0:) |
R |
Optical interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models physical optical interfaces. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. Changes since 2.18:
|
- |
2.4 |
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863]. Because the interface includes layer 1, the LowerLayerDown value SHOULD never be used. |
- |
2.4 |
SFPReferenceList |
string(:256)[] |
R |
Comma-separated list of strings (maximum number of characters per item 256). Each list item MUST be the Path Name of a row in the SFPs.SFPCage. table, or an empty string. Small-form Factor Pluggable (SFP) entries associated with this interface. |
- |
2.19 |
Device.Optical.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.4 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.4 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.4 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.4 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.4 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.4 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.4 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.4 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.4 |
Device.Cellular. |
object |
R |
This object models cellular interfaces and access points. |
- |
2.8 |
Device.Cellular.Interface.{i}. |
object(0:) |
R |
Cellular interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each instance of this object models a cellular modem with a single radio and acan singlereference 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.18:
|
- |
2.8 |
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}}{{div|{{classes}}|{{li|*}} SHOULD change to Up if and only if the interface is able to transmit and receive network traffic.}}{{div|{{classes}}|{{li|*}}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)}}{{div|{{classes}}|{{li|*}}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}}{{div|{{classes}}|{{li|*}}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.}}{{div|{{classes}}|Because the interface includes layer 1 the {{enum|LowerLayerDown}} value SHOULD never be used. This parameter is based on ifOperStatus from [RFC2863]. Because the interface includes layer 1, the LowerLayerDown value SHOULD never be used. |
- |
2.8 |
RSRP |
int |
R |
The Reference Signal Received Power in dBm for LTE, NR values of CurrentAccessTechnology:
Active Notification requests for this parameter MAY be denied. |
- |
2.14 |
RSRQ |
int |
R |
The Reference Signal Received Quality in dBm for LTE, NR values of CurrentAccessTechnology:
Active Notification requests for this parameter MAY be denied. |
- |
2.14 |
SIMReferenceList |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the TrustedElements.SIM. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Each list item references a SIM with which the interface is associated. |
- |
2.19 |
Device.Cellular.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]. Changes since 2.18:
|
- |
2.8 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.8 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.8 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.8 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.8 |
ErrorsSent |
unsignedLong |
R |
[StatsCounter64] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.8 |
ErrorsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.8 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.8 |
DiscardPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.8 |
DiscardPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.8 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.8 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.8 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.8 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.8 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.8 |
UnknownProtoPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.8 |
Device.Cellular.Interface.{i}.USIM. |
object |
R |
USIM (Universal Subscriber Identity Module or SIM card) parameters for the interface. This object was DEPRECATED in 2.19 because moved to TrustedElements.SIM. Changes since 2.18:
|
- |
2.8 |
Device.Cellular.Interface.{i}.SMS. |
object |
R |
The object models SMS (Short Message Service) features. |
- |
2.19 |
StorageNumberOfEntries |
unsignedInt |
R |
The number of entries in the Storage table. |
- |
2.19 |
MessageNumberOfEntries |
unsignedInt |
R |
The number of entries in the Message table. |
- |
2.19 |
Device.Cellular.Interface.{i}.SMS.Storage.{i}. |
object(0:) |
R |
Represents a SMS storage location. Each instance of this object corresponds to a distinct SMS storage area. Multiple instances of this object may exist, each representing a different storage type (e.g., SM SIM card, ME device memory). At most one entry in this table can exist with a given value for Alias. |
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.19 |
Location |
string(:64) |
W |
Specifies the storage location e.g. SM SIM card, ME device memory. |
- |
2.19 |
Capacity |
unsignedInt |
R |
The maximum number of SMS messages in Device.Cellular.Interface.{i}.SMS.Message that can be stored in Storage. |
- |
2.19 |
StorageAvailable |
boolean |
R |
Indicates whether the SMS Storage is available to receive new messages. true means that there is storage still available; false means that the storage is full. |
- |
2.19 |
AvailableCapacity |
unsignedInt |
R |
The number of SMS messages in Device.Cellular.Interface.{i}.SMS.Message that the Storage entity has room to store, which can not exceed Capacity. |
- |
2.19 |
Device.Cellular.Interface.{i}.SMS.Incoming. |
object |
R |
This object models incoming SMS configuration. |
- |
2.19 |
StorageRef |
string |
W |
The value MUST be the Path Name of a row in the Device.Cellular.Interface.{i}.SMS.Storage. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the memory path where the messages are stored. |
- |
2.19 |
CapacityLimit |
int(-1:) |
W |
Maximum number of incoming SMS messages to be stored. If the number of incoming messages in Device.Cellular.Interface.{i}.SMS.Message exceeds CapacityLimit, the oldest incoming messages will be removed automatically to prevent storage overfilling. -1 disables automatic messages removal. |
- |
2.19 |
Device.Cellular.Interface.{i}.SMS.Outgoing. |
object |
R |
This object models outgoing SMS configuration. |
- |
2.19 |
StorageRef |
string |
W |
The value MUST be the Path Name of a row in the Device.Cellular.Interface.{i}.SMS.Storage. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the memory path where the messages are stored. |
- |
2.19 |
CapacityLimit |
int(-1:) |
W |
Maximum number of outgoing SMS messages to be stored. If the number of outgoing messages in Device.Cellular.Interface.{i}.SMS.Message exceeds CapacityLimit, the oldest outgoing messages will be removed automatically to prevent storage overfilling. -1 disables automatic messages removal. |
- |
2.19 |
Device.Cellular.Interface.{i}.SMS.Message.{i}. |
object(0:) |
W |
This object models individual SMS messages, including both received and sent entries. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.19 |
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.19 |
Sender |
string |
R |
Phone number of the SMS sender. |
- |
2.19 |
Receiver |
string |
R |
Phone number of the SMS receiver. |
- |
2.19 |
TimeStamp |
dateTime |
R |
Indicates the time an incoming SMS was received (when Status is Received) or when an outgoing SMS was sent (when Status is Sent). |
- |
2.19 |
Text |
string |
R |
Text of the SMS message. |
- |
2.19 |
StorageRef |
string |
R |
The value MUST be the Path Name of a row in the Device.Cellular.Interface.{i}.SMS.Storage. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the memory path where the messages are stored. |
- |
2.19 |
Status |
string |
R |
Indicates the status of the message. Enumeration of:
|
- |
2.19 |
Type |
string |
R |
Indicates the type of the message. Enumeration of:
|
- |
2.19 |
Device.Cellular.AccessPoint.{i}. |
object(0:) |
W |
Cellular Access Point table. Each entry is identified by an APN (Access Point Name) that identifies a gateway between the mobile network and another computer network. Note: Device 2.19 grouped the APN and Interface keys into one combined key. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both APN and Interface. |
- |
2.8 |
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.19 |
Type |
string[] |
W |
Comma-separated list of strings. This parameter specifies the type of APN being used. Common values are "default", "mms", "ims", "hipri", ... The specific values supported may vary depending on the network operator. If the APN type is not applicable, this parameter may be an empty string. |
- |
2.19 |
Device.TrustedElements. |
object |
R |
This object models Trusted Elements, specialized components in home gateways that create secure environments for sensitive data, cryptographic keys, and trusted applications. Essential for securing SIM/eSIM data, managing IoT devices, and encrypting network traffic, Trusted Elements protect home networks by preventing unauthorized access and ensuring data integrity. |
- |
2.19 |
SIMNumberOfEntries |
unsignedInt |
R |
The number of entries in the SIM table. |
- |
2.19 |
Device.TrustedElements.SIM.{i}. |
object(1:) |
R |
This object models SIM (Subscriber Identity Module) parameters for the interface, including support for eSIM (embedded SIM) functionality. This table MUST contain at least 1 entry. At most one entry in this table can exist with a given value for Alias. |
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.19 |
Status |
string |
W |
The current status of the SIM. Enumeration of:
|
- |
2.19 |
IMSI |
string(14:15) |
R |
International Mobile Subscriber Identity represented as a string with either 14 or 15 digits (digits 0-9). The first 3 digits are the mobile country code (MCC), which are followed by the mobile network code (MNC), either 2 digits (European standard) or 3 digits (North American standard), followed by the mobile subscription identification number (MSIN). Possible patterns:
|
- |
2.19 |
ICCID |
string(6:20) |
R |
Integrated Circuit Card Identifier represented as a string of up to 20 digits (digits 0-9). The number is composed of the following parts:
For cards using an ICCID according to [ITU-E.118] the maximum length is 19 Digits, for GSM cards 20 digits. Possible patterns:
|
- |
2.19 |
MSISDN |
string(14:15) |
R |
Mobile Subscriber Integrated Service Digital Network Number, a number uniquely identifying a subscription in a GSM, UMTS, or LTE mobile network. [ITU-E.164] Possible patterns:
|
- |
2.19 |
SMSC |
string |
W |
The SMSC (SMS Center address) is part of the mobile network provider's configuration and is included on the SIM card or in the network provisioning package when the phone is initialized. |
- |
2.19 |
EID |
string |
R |
Reports the unique identifier for the eUICC (Embedded Universal Integrated Circuit Card), which is a built-in SIM that can store multiple carrier profiles and be updated remotely. |
- |
2.19 |
ProfileNumberOfEntries |
unsignedInt |
R |
The number of entries in the Profile table. |
- |
2.19 |
ESIMProfileAddStatus |
string |
R |
Reports the operational status of the last network initiated Profile Add attempt for the embedded SIM (eSIM). The ESIM prefix indicates that this parameter is related to eSIM functionality. |
- |
2.19 |
ESIMClassEnabledProfile |
string |
R |
The value MUST be the Path Name of a row in the Profile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. References the currently activated Profile.. |
- |
2.19 |
ESIMTestMode |
boolean |
R |
Allows the cellular network to enable or disable the Test profile. When set to true, any currently active profile is disabled, and the ESIMClassEnabledProfile is ignored. When set to false, the previously active profile is re-enabled. |
- |
2.19 |
Type |
string |
R |
The current type of the SIM card. Enumeration of:
|
- |
2.19 |
GID1 |
string |
R |
A hexadecimal identifier used to differentiate between different SIM card tariffs or derive APNs. For more details, refer to [3GPP-TS.31.102]. |
- |
2.19 |
Usage |
string |
R |
Indicates the usage of the SIM instance. Enumeration of:
|
- |
2.19 |
PINCheck |
string |
W |
Controls the PIN verification of the USIM card. Enumeration of:
|
- |
2.19 |
PIN |
string(:4) |
W |
Allows the Controller to change the USIM PIN used for SIM card activation. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.19 |
ProtectionScheme |
unsignedInt(0:15) |
R |
Protection Scheme Field—This field is a 4-bit value ranging 0–15, which identifies the protection scheme used to generate the SUCI. The following values are currently defined:
|
- |
2.19 |
HomeNetworkPublicKeyID |
unsignedInt(0:255) |
R |
Home Network Public Key ID Field—This field is an 8-bit value ranging 0–255, which identifies the public key provisioned by the Home Public Land Mobile Network (HPLMN) and used for SUPI protection. When the Null Scheme is used, this field is set to 0. |
- |
2.19 |
RoutingIndicator |
unsignedInt(0:9999) |
R |
Routing Indicator Field—This field is a numerical value consisting of 1–4 decimal digits. It's assigned by the home network operator and securely provisioned within the SIM/eSIM profile. |
- |
2.19 |
Device.TrustedElements.SIM.{i}.Profile.{i}. |
object(1:) |
R |
Profile table for SIM. This table MUST contain at least 1 entry. At most one entry in this table can exist with a given value for Alias. |
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.19 |
Name |
string |
R |
Indicates the profile name. |
- |
2.19 |
IMSI |
string(14:15) |
R |
International Mobile Subscriber Identity represented as a string with either 14 or 15 digits (digits 0-9). The first 3 digits are the mobile country code (MCC), which are followed by the mobile network code (MNC), either 2 digits (European standard) or 3 digits (North American standard), followed by the mobile subscription identification number (MSIN). Possible patterns:
|
- |
2.19 |
ICCID |
string |
R |
Indicates the profile ICCID. |
- |
2.19 |
State |
string |
R |
Indicates the profile state. Enumeration of:
|
- |
2.19 |
Class |
string |
R |
Indicates the profile class. Enumeration of:
|
- |
2.19 |
GID1 |
string |
R |
Differentiate e.g. different tariffs of SIM card, derive APNs etc. (as ASCII Hex dump) |
- |
2.19 |
Device.ATM. |
object |
R |
Asynchronous Transfer Mode (ATM) object that contains the Link interface and Diagnostics.F5Loopback diagnostics. |
- |
2.0 |
Device.ATM.Link.{i}. |
object(0:) |
W |
ATM link-layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Models an ATM PVC virtual circuit and the ATM Adaption Layer (AAL). An ATM Link entry is typically stacked on top of either a DSL.Channel or a DSL.BondingGroup object. When an ATM Link interface is used, a lower-layer DSL.Channel interface MUST be configured with ATM encapsulation (see DSL.Channel.{i}.LinkEncapsulationUsed). At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.0 |
Device.ATM.Link.{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.0 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
Device.DOCSIS. |
object |
R |
DOCSIS object. This object models the DOCSIS 3.x cable interface objects. |
- |
2.15 |
Device.DOCSIS.Downstream.{i}. |
object(0:) |
R |
DOCSIS Downstream interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the PHY DOCSIS Downstream interface. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.15 |
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863]. Because the interface includes layer 1, the LowerLayerDown value SHOULD never be used. |
- |
2.15 |
Device.DOCSIS.Downstream.{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]. Changes since 2.18:
|
- |
2.15 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.15 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.15 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.15 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.15 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.15 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.15 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
Device.DOCSIS.Upstream.{i}. |
object(0:) |
R |
DOCSIS Upstream interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the PHY DOCSIS Upstream interface. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.15 |
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863]. Because the interface includes layer 1, the LowerLayerDown value SHOULD never be used. |
- |
2.15 |
Device.DOCSIS.Upstream.{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]. Changes since 2.18:
|
- |
2.15 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.15 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.15 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.15 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.15 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.15 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.15 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
Device.DOCSIS.Interface.{i}. |
object(0:) |
R |
DOCSIS Layer 2 (MAC) interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the MAC level DOCSIS interface. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.15 |
Device.DOCSIS.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]. Changes since 2.18:
|
- |
2.15 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.15 |
DiscardPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.15 |
DiscardPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.15 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.15 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.15 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.15 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
UnknownProtoPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.15 |
Device.PTM. |
object |
R |
Packet Transfer Mode ([Annex H/G.993.1]). This object contains the Link interface. |
- |
2.0 |
Device.PTM.Link.{i}. |
object(0:) |
W |
PTM link-layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Models a layer 2 variable-sized packet interface. A PTM Link entry is typically stacked on top of either a FAST.Line, DSL.Channel, or a DSL.BondingGroup object. When a PTM Link interface is used, a lower-layer DSL.Channel interface MUST be configured with PTM encapsulation (see DSL.Channel.{i}.LinkEncapsulationUsed). At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.0 |
Enable |
boolean |
W |
Enables or disables the link.interface. This parameter is based on ifAdminStatus from [RFC2863]. |
false |
2.0 |
Status |
string |
R |
The current operational state of the linkinterface (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.0 |
Name |
string(:64) |
R |
The textual name of the linkinterface as assigned by the CPE. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.0 |
LastChange |
unsignedInt |
R |
The accumulated time in seconds since the linkinterface entered its current operational state. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
Device.PTM.Link.{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]. Changes since 2.18:
|
- |
2.0 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
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.18:
|
- |
2.0 |
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863]. Because the interface includes layer 1, the LowerLayerDown value SHOULD never be used. |
- |
2.0 |
AdvertisedLinkModes |
unsignedInt[] |
W |
Comma-separated list of unsigned integers. Sets the advertised link modes. MUST be set in a compliant way as defined in [IANAifMauTypeListBits/IANAMauMIB]. For example, IANAifMauTypeListBits defines the following link mode types:
|
- |
2.19 |
LinkPartnerAdvertisedLinkModes |
unsignedInt[] |
R |
Comma-separated list of unsigned integers. Reports the link modes advertised by the link partner. MUST be reported in a compliant way as defined in [IANAifMauTypeListBits/IANAMauMIB]. For example, IANAifMauTypeListBits defines the following link mode types:
|
- |
2.19 |
EDPDCapability |
boolean |
R |
Indicates whether this physical ethernet port supports Energy Detect Power Down (EDPD). Implementations of this feature are vendor specific, Energy Detect Power Down is not part of the 802.3-2015 standard. |
- |
2.19 |
EDPDEnable |
boolean |
W |
Indicates whether Energy Detect Power Down (EDPD) support is currently enabled. When enabled, depending on the type of hardware, either the transmit power is disabled or the link impulses are sent at a greater interval. Implementations of this feature are vendor specific, Energy Detect Power Down is not part of the 802.3-2015 standard. |
- |
2.19 |
EDPDStatus |
string |
R |
Indicates the active state of Energy Detect Power Down (EDPD). Implementations of this feature are vendor specific, Energy Detect Power Down is not part of the 802.3-2015 standard. Enumeration of:
|
- |
2.19 |
SFPReferenceList |
string(:256)[] |
R |
Comma-separated list of strings (maximum number of characters per item 256). Each list item MUST be the Path Name of a row in the SFPs.SFPCage. table, or an empty string. Small-form Factor Pluggable (SFP) entries associated with this interface. |
- |
2.19 |
Device.Ethernet.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.0 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
Device.Ethernet.Link.{i}. |
object(0:) |
W |
Ethernet link layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Table entries model the Logical Link Control (LLC) layer. It is expected that an Ethernet Link interface can be stacked above any lower-layer interface object capable of carrying Ethernet frames. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for MACAddress. |
- |
2.0 |
Device.Ethernet.Link.{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.0 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
Device.Ethernet.VLANTermination.{i}. |
object(0:) |
W |
VLAN Termination table (a stackable interface object as described in [Section 4.2/TR-181i2]). A VLAN Termination entry is typically stacked on top of a Link object to receive and send frames with the configured VLANID. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.0 |
Device.Ethernet.VLANTermination.{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.0 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
Device.Ethernet.LAG.{i}. |
object(0:) |
W |
Ethernet Link Aggregation Group (LAG) table (a stackable interface object as described in [Section 4.2/TR-181i2]). Table entries model the Link Aggregation Sub-Layer as defined in [802.3-2015] and [802.1AX-2014]. It is expected that a LAG interface can only be stacked above Interface interfaces. The CPE can reject creation of additional LAG instances if this would exceed its capabilities. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for MACAddress. |
- |
2.12 |
Device.Ethernet.LAG.{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.12 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.12 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.12 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.12 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.12 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.12 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.12 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.12 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.12 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.12 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.12 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.12 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.12 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.12 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.12 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.12 |
Device.USB. |
object |
R |
Universal Serial Bus ([USB1.0], [USB2.0], [USB3.0]). This object contains the Interface, Port, and USBHosts objects. |
- |
2.0 |
Device.USB.Interface.{i}. |
object(0:) |
R |
USB interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models master and slave USB physical interfaces that support carrying Ethernet frames, e.g. via the USB Communication Device Class. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.0 |
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863]. Because the interface includes layer 1, the LowerLayerDown value SHOULD never be used. |
- |
2.0 |
MaxBitRate |
unsignedInt |
R |
The maximum upstream and downstream PHY bit rate supported by this interface (expressed in Mbps). |
- |
2.0 |
Device.USB.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]. Changes since 2.18:
|
- |
2.0 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
Device.USB.USBHosts. |
object |
R |
This object models the CPE's USB Host controllers. See [Appendix XVII/TR-181i2] for Theory of Operation. |
- |
2.0 |
Device.USB.USBHosts.Host.{i}. |
object(0:) |
R |
Table of 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 |
Type |
string |
R |
Type of USB Host Enumeration of:
Changes since 2.18:
|
- |
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. |
- |
2.0 |
Rate |
string |
R |
Speed of the USB device. Enumeration of:
Internal signaling between the connected USB device and the USB Host Controller provide the information needed to determine the negotiated rate. Changes since 2.18:
|
- |
2.0 |
Device.HPNA. |
object |
R |
HPNA object that contains the Interface and Diagnostics objects. The HPNA (also known as HomePNA) industry standard [G.9954] defines peer to peer communication for home networking over existing coax cables and telephone wiring within the home. |
- |
2.0 |
Device.HPNA.Interface.{i}. |
object(0:) |
R |
HPNA interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of an HPNA interface [G.9954]. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.0 |
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863]. Because the interface includes layer 1, the LowerLayerDown value SHOULD never be used. |
- |
2.0 |
MaxBitRate |
unsignedInt |
R |
The maximum HPNAupstream and downstream PHY bit rate supported by this interface (expressed in Mbps) of this interface.). |
- |
2.0 |
Device.HPNA.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]. Changes since 2.18:
|
- |
2.0 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
Device.MoCA. |
object |
R |
MoCA object that contains the Interface table [MoCAv1.0] [MoCAv1.1]. |
- |
2.0 |
Device.MoCA.Interface.{i}. |
object(0:) |
R |
MoCA interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of a MoCA interface [MoCAv1.0] [MoCAv1.1]. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.0 |
Status |
string |
R |
[mocaIfStatus/1.3.6.1.4.1.31621.1.2.1.7.1.1] The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863]. Because the interface includes layer 1, the LowerLayerDown value SHOULD never be used. |
- |
2.0 |
MaxBitRate |
unsignedInt |
R |
The maximum MoCAupstream and downstream PHY bit rate supported by this interface (expressed in Mbps). This parameter MUST NOT be implemented for MoCA 2.0 because it doesn't map to a MIB object. |
- |
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. Changes since 2.18:
|
- |
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. The factory default value MUST be 0. Changes since 2.18:
|
- |
2.0 |
Device.MoCA.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]. Changes since 2.18:
|
- |
2.0 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[mocaIfTxBytes/1.3.6.1.4.1.31621.1.2.1.8.1.8] [StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BytesReceived |
unsignedLong |
R |
[mocaIfRxBytes/1.3.6.1.4.1.31621.1.2.1.8.1.9] [StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsSent |
unsignedLong |
R |
[mocaIfTxPackets/1.3.6.1.4.1.31621.1.2.1.8.1.1] [StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsReceived |
unsignedLong |
R |
[mocaIfRxPackets/1.3.6.1.4.1.31621.1.2.1.8.1.3] [StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. This parameter MUST NOT be implemented for MoCA 2.0 because it doesn't map to a MIB object. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. This parameter MUST NOT be implemented for MoCA 2.0 because it doesn't map to a MIB object. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsSent |
unsignedLong |
R |
[mocaIfTxUnicast/1.3.6.1.4.1.31621.1.2.1.8.1.10] [StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsReceived |
unsignedInt |
R |
[mocaIfRxDrops/1.3.6.1.4.1.31621.1.2.1.8.1.5] [StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsSent |
unsignedLong |
R |
[mocaIfTxMulticast/1.3.6.1.4.1.31621.1.2.1.8.1.12] [StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsReceived |
unsignedLong |
R |
[mocaIfRxUnicast/1.3.6.1.4.1.31621.1.2.1.8.1.11] [StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsReceived |
unsignedLong |
R |
[mocaIfRxMulticast/1.3.6.1.4.1.31621.1.2.1.8.1.13] [StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsSent |
unsignedLong |
R |
[mocaIfTxBroadcast/1.3.6.1.4.1.31621.1.2.1.8.1.14] [StatsCounter64] The total number of packetspackets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsReceived |
unsignedLong |
R |
[mocaIfRxBroadcast/1.3.6.1.4.1.31621.1.2.1.8.1.15] [StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. This parameter MUST NOT be implemented for MoCA 2.0 because it doesn't map to a MIB object. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
Device.MoCA.Interface.{i}.AssociatedDevice.{i}. |
object(0:) |
R |
[mocaNodeTable/1.3.6.1.4.1.31621.1.2.1.11 mocaLinkStatsTable/1.3.6.1.4.1.31621.1.2.1.10] This table contains information about other MoCA devices currently associated with this MoCA interface. Entries in this table cannot be created or deleted by the network management system. All entries are created or deleted by the device software. At most one entry in this table can exist with a given value for MACAddress. |
- |
2.0 |
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. Changes since 2.18:
|
- |
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. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
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. Changes since 2.18:
|
- |
2.0 |
Device.Ghn. |
object |
R |
G.hn object that contains an Interface table for G.hn supported CPE. The ITU-T G.hn specifications [G.9960] and [G.9961] define Physical and MAC Layers for communication between two or more G.hn nodes in the home network over multiple wired media such as power line, phone line and coaxial cable. |
- |
2.4 |
Device.Ghn.Interface.{i}. |
object(0:) |
R |
G.hn interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY [G.9960] and MAC [G.9961] layers of a G.hn interface. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.4 |
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863]. Because the interface includes layer 1, the LowerLayerDown value SHOULD never be used. |
- |
2.4 |
MaxBitRate |
unsignedInt |
R |
The maximum upstream and downstream PHY bit rate supported by this interface (expressed in Mbps). |
- |
2.4 |
Device.Ghn.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface at the different G.hn reference points described in [Clause 8.1/G.9961]. The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. Changes since 2.18:
|
- |
2.4 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. More specifically, this is the total number of MPDU bytes transmitted or retransmitted by the node through a physical medium (i.e., PMI defined in [Clause 5.2.1/G.9960]), which correspond to data LPDUs (i.e., data packets) and framing overhead (e.g., LFH, LPH, LPCS defined in [Clause 8.1/G.9961]). It does not include transmitted bytes contributed by management LPDUs (i.e., management packets). Note: LPDUs in mixed LLC frame blocks are considered data LPDUs. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.4 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. More specifically, this is the total number of MPDU bytes received by the node through a physical medium, which correspond to data LPDUs and framing overhead. It does not include received bytes contributed by management LPDUs. It can include blocks with errors. Note: LPDUs in mixed LLC frame blocks are considered data LPDUs. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.4 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. More specifically, this is the total number of APDUs requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]) that were transmitted by the node through the physical medium. It does not include transmitted LCDUs. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.4 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. More specifically, this is the total number of APDUs delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) that were received by the node through the physical medium. It does not include received LCDUs. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.4 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]) but could not be transmitted because of errors (e.g., APDUs containing CRC errors). Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.4 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. More specifically, this is the total number of received APDUs that contained errors preventing them from being delivered to a higher layer (i.e., inbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]). The possible causes of error are: incorrect CRC, incorrect MIC, incorrect MIC size, and incorrect size of packet. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.4 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer. It includes APDUs that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.4 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) but chosen to be discarded even though no errors had been detected to prevent their being transmitted (e.g., buffer overflow). Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.4 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. More specifically, this is the total number of received APDUs that were chosen to be discarded even though no errors had been detected to prevent their being delivered. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.4 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer. It includes APDUs that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.4 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. More specifically, this is the total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.4 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. More specifically, this is the total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.4 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer. It includes APDUs that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.4 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. More specifically, this is the total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.4 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. More specifically, this is the total number of APDUs received by the management that were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.4 |
Device.HomePlug. |
object |
R |
HomePlug object that contains the Interface table. The HomePlug industry standard [HPAV1.1] defines peer to peer communication over powerline medium. |
- |
2.0 |
Device.HomePlug.Interface.{i}. |
object(0:) |
R |
HomePlug interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of a HomePlug interface [HPAV1.1]. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.0 |
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863]. Because the interface includes layer 1, the LowerLayerDown value SHOULD never be used. |
- |
2.0 |
MaxBitRate |
unsignedInt |
R |
The maximum upstream and downstream PHY bit rate supported by this interface (expressed in Mbps). |
- |
2.0 |
Device.HomePlug.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]. Changes since 2.18:
|
- |
2.0 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
Device.UPA. |
object |
R |
Universal Powerline Association [UPA-PLC]. This object contains the Interface and Diagnostics objects. |
- |
2.0 |
Device.UPA.Interface.{i}. |
object(0:) |
R |
UPA interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of a UPA interface [UPA-PLC]. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- |
2.0 |
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863]. Because the interface includes layer 1, the LowerLayerDown value SHOULD never be used. |
- |
2.0 |
MaxBitRate |
unsignedInt |
R |
The maximum upstream and downstream PHY bit rate supported by this interface (expressed in Mbps). |
- |
2.0 |
Device.UPA.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]. Changes since 2.18:
|
- |
2.0 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
Device.WiFi. |
object |
R |
The WiFi object is based on the IEEE 802.11 specifications ([802.11-2020]). It defines interface objects (Radio and SSID), and application objects (AccessPoint and EndPoint). |
- |
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. Changes since 2.18:
|
- |
2.13 |
ControllerID |
string |
R |
A unique identifier for a Multi-AP controller. It is recommended that this be the same as the IEEE 1905 ALID of the EasyMesh controller. |
- |
2.13 |
SteeringMandates |
unsignedLong |
R |
[StatsCounter64] Count of number of EasyMesh controller-initiated requests for Steering Mandates. [Section 17.2.57, Profile-2 Steering Request TLV, with field Request_Mode set to one/EasyMesh]. |
- |
2.19 |
SteeringOpportunities |
unsignedLong |
R |
[StatsCounter64] Count of number of EasyMesh controller-initiated requests for Steering Opportunities. [Section 17.2.57, Profile-2 Steering Request TLV, with field Request_Mode set to zero/EasyMesh]. |
- |
2.19 |
ProvisionedDPPNumberOfEntries |
unsignedInt |
R |
The number of entries in the ProvisionedDPP table. |
- |
2.19 |
Device.WiFi.DataElements.Network.SSID.{i}. |
object(0:) |
R |
This object specifies SSIDs for fronthaul use across all agents in this Wi-Fi Multi-AP network, or on this single-AP. Also specifies the Band for each SSID. The Alias can be used to uniquely refer to this table entry corresponding to a BSS even if the SSID were to change. Note that VLAN IDs (VIDs) can be configured per SSID with Device.{i}.SSIDtoVIDMapping.{i}. At most one entry in this table can exist with a given value for Alias. |
- |
2.15 |
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.19 |
Band |
string[] |
R |
Comma-separated list of strings. The band(s) (GHz) for which this SSID applies. Each list item is an enumeration of:
Changes since 2.18:
|
- |
2.15 |
Type |
string |
R |
Human-readable description for the BSS referenced by this SSID. For example Type could be one of Primary, Home, Guest, Public, Private, Children, Video, Backhaul, Not Children, or Public 2. |
- |
2.19 |
Device.WiFi.DataElements.Network.ProvisionedDPP.{i}. |
object(0:) |
W |
This table contains provisioned Device Provisioning Protocol (DPP) Boostrap URIs [Section 5.2.1/EasyConnect] which contain bootstrapping keys available to the Multi-AP controller for trusted third party onboarding of new Multi-AP agents. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.19 |
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.19 |
DPPURI |
string(:2048) |
W |
[URI] The boostrapping DPP URI information which contains the enrollee public key to use for DPP onboarding a Multi-AP agent as specified by [Section 5.2.1/EasyConnect]. |
- |
2.19 |
Device.WiFi.DataElements.Network.Device.{i}. |
object(0:) |
R |
Each instance of this object represents an individual EasyMesh Agent or single-AP device in the Wi-Fi network. At most one entry in this table can exist with a given value for ID. Changes since 2.18:
|
- |
2.13 |
ID |
string(:17) |
R |
[MACAddress] A unique identifier for this particular device within the Wi-Fi network as defined in [Section 3.1/DataElements]. If this Device is represented in Device.IEEE1905.AL.NetworkTopology., then this should match an IEEE 1905 AL MAC Address in Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.IEEE1905Id. |
- |
2.13 |
MaxReportingRate |
unsignedInt |
R |
Maximum rate for reporting unsuccessful association attempts in attempts per minute. This parameter was DEPRECATED in 2.19 because it was the same as MaxUnsuccessfulAssociationReportingRate. Changes since 2.18:
|
- |
2.15 |
APMetricsWiFi6 |
boolean |
R |
Associated Wi-Fi6 STA Status Inclusion Policy.
This parameter was DEPRECATED in 2.16 because it was the same as Radio.{i}.APMetricsWiFi6. This parameter was OBSOLETED in 2.18. This parameter was DELETED in 2.19. Changes since 2.18:
|
- |
2.15 |
AssociatedSTAinAPMetricsWiFi6 |
boolean |
W |
For EasyMesh [EasyMesh], this is the Associated Wi-Fi6 STA Status Inclusion Policy.
This parameter was DEPRECATED in 2.16 because it was the same as Radio.{i}.APMetricsWiFi6. This parameter was OBSOLETED in 2.18. This parameter was DELETED in 2.19. Changes since 2.18:
|
- |
2.15 |
BackhaulMACAddress |
string(:17) |
R |
[MACAddress] The MAC address of the interface on the network that is providing the backhaul for this EasyMesh Agent. For Wi-Fi backhaul, this is the BSSID or AP MLD address of the backhaul BSS. Interfaces of EasyMesh Agents that are downstream of this EasyMesh Agent are identified by BackhaulDown.{i}.BackhaulDownMACAddress. |
- |
2.17 |
BackhaulALID |
string(:17) |
R |
[MACAddress] The IEEE 1905 [IEEE1905.1a] Abstraction-Layer ID (ALID) of the EasyMesh Agent on the network that is providing the backhaul for this EasyMesh Agent. EasyMesh Agents that are downstream of this EasyMesh agent are identified by BackhaulDown.{i}.BackhaulDownALID. |
- |
2.17 |
BackhaulDownMACAddress |
string(:17)[] |
R |
[MACAddress] Comma-separated list of MAC Addresses. Each MAC address is that of a downstream EasyMesh agent's backhaul link. This parameter was DEPRECATED in 2.19 because it was replaced by BackhaulDown.{i}.BackhaulDownMACAddress. Changes since 2.18:
|
- |
2.17 |
BackhaulMediaType |
string |
R |
Media type of the backhaul link of this EasyMesh Agent. This value can be derived from the neighbor's topology response message 1905 device information type TLV Media Type field defined in [Table 6-12/IEEE1905.1a]. Enumeration of:
Changes since 2.18:
|
- |
2.17 |
BackhaulDownNumberOfEntries |
unsignedInt |
R |
The number of entries in the BackhaulDown table. |
- |
2.19 |
Device.WiFi.DataElements.Network.Device.{i}.CACStatus.{i}. |
object(0:) |
R |
Latest Channel Availability Check (CAC) Status Report from the device. At most one entry in this table can exist with a given value for TimeStamp. |
- |
2.15 |
Device.WiFi.DataElements.Network.Device.{i}.CACStatus.{i}.CACAvailableChannel.{i}. |
object(0:) |
R |
This object describes available channels identified by Channel Availability Check (CAC). At most one entry in this table can exist with the same values for both OpClass and Channel. |
- |
2.15 |
OpClass |
unsignedInt(:255) |
R |
OperatingThis is the operating class of an available channel, from [Table E-4/802.11ax]. |
- |
2.15 |
Device.WiFi.DataElements.Network.Device.{i}.CACStatus.{i}.CACNonOccupancyChannel.{i}. |
object(0:) |
R |
This object describes channels identified by Channel Availability Check (CAC) that may not be occupied. At most one entry in this table can exist with the same values for both OpClass and Channel. |
- |
2.15 |
OpClass |
unsignedInt(:255) |
R |
Operating class of a channel that is in the non-occupancy list, from [Table E-4/802.11ax]. |
- |
2.15 |
Device.WiFi.DataElements.Network.Device.{i}.CACStatus.{i}.CACActiveChannel.{i}. |
object(0:) |
R |
This object describes channels with ongoing Channel Availability Check (CAC). At most one entry in this table can exist with the same values for both OpClass and Channel. |
- |
2.15 |
OpClass |
unsignedInt(:255) |
R |
Operating class of a channel that has ongoing CAC, from [Table E-4/802.11ax]. |
- |
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 |
OpClass |
unsignedInt(:255) |
R |
The Operating Class per [Table E-4/802.11ax]. Note that the operating class identifies the band and channel width. |
- |
2.15 |
Device.WiFi.DataElements.Network.Device.{i}.AnticipatedChannelUsage.{i}. |
object(0:) |
R |
This object reports Wi-Fi 6 [802.11ax] anticipated medium usage on channels (and subsets of those channels) on which the device is operating. At most one entry in this table can exist with a given value for OpClass. |
- |
2.15 |
OpClass |
unsignedInt(:255) |
R |
The operating class per [Table E-4/802.11ax]. |
- |
2.15 |
Device.WiFi.DataElements.Network.Device.{i}.BackhaulDown.{i}. |
object(0:) |
R |
This object identifies EasyMesh Agents and their interfaces that are downstream of this EasyMesh Agent and have backhaul to this EasyMesh Agent. At most one entry in this table can exist with a given value for BackhaulDownALID. |
- |
2.19 |
BackhaulDownALID |
string(:17) |
R |
[MACAddress] The IEEE 1905 [IEEE1905.1a] Abstraction-Layer ID (ALID) of the EasyMesh Agent on the network that is downstream of this EasyMesh Agent and has backhaul to this EasyMesh Agent. |
- |
2.19 |
BackhaulDownMACAddress |
string(:17) |
R |
[MACAddress] MAC address of the EasyMesh Agent's interface that is downstream of this EasyMesh Agent and has backhaul to this EasyMesh Agent. |
- |
2.19 |
Device.WiFi.DataElements.Network.Device.{i}.AFCAvailableSpectrum. |
object |
R |
This object contains the Available Spectrum Inquiry request and response message defined by [Section 8.2.5/EasyMesh]. This provides information of 6 GHz spectrum availability as determined by an Automated Frequency Coordination (AFC) system [AFCSDI]. |
- |
2.19 |
AFCAvailableSpectrumInquiryRequest |
string |
R |
One JSON encoded AvailableSpectrumInquiryRequestMessage object as defined in [Section 8.2.5 and Section 17.2.104 Available Spectrum Inquiry Request TLV/EasyMesh]. |
- |
2.19 |
AFCAvailableSpectrumInquiryResponse |
string |
R |
One JSON encoded AvailableSpectrumInquiryResponseMessage object as defined in [Section 8.2.5 and Section 17.2.105 Available Spectrum Inquiry Response TLV/EasyMesh]. |
- |
2.19 |
Device.WiFi.DataElements.Network.Device.{i}.MultiAPDevice. |
object |
R |
This object represents an individual Access Point device. |
- |
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 |
Device.WiFi.DataElements.Network.Device.{i}.MultiAPDevice.Backhaul.CurrentOperatingClassProfile.{i}. |
object(0:) |
R |
Describes one of the current Operating Classes in use by this Radio. One Opeating Class is indicated for each current Operating Channel Bandwidth. The Channel indicated for the 20 MHz Operating Class is equal to the current primary channel. At most one entry in this table can exist with a given value for Class. |
- |
2.15 |
Class |
unsignedInt(:255) |
R |
The Operating Class per [Table E-4/802.11ax] that this radio is currently operating on. |
- |
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.18:
|
- |
2.13 |
MaxBSS |
unsignedInt(:255) |
R |
Maximum number of BSSs supported by this radio. [Section 17.2.7, AP Radio Basic Capabilities TLV/EasyMesh]. |
- |
2.19 |
OpClassPreferenceNumberOfEntries |
unsignedInt |
R |
The number of entries in the OpClassPreference table. |
- |
2.19 |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}. |
object(0:) |
R |
The list of neighboring Access Points discovered by a Radio organized per Operating Class and Channel tuple. |
- |
2.14 |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}. |
object(0:) |
R |
The Operating Class of neighboring Access Points discovered by a Radio during a channel scan. At most one entry in this table can exist with a given value for OperatingClass. |
- |
2.14 |
OperatingClass |
unsignedInt(:255) |
R |
The Operating Class per [Table E-4/802.11ax] of the OpClass and Channel tuple scanned by the Radio. For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid. Note that the Operating Class identifies the band and channel width. |
- |
2.14 |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}. |
object(0:) |
R |
The Channel associated with an Operating Class of neighboring Access Points discovered by a Radio during a channel scan. At most one entry in this table can exist with a given value for Channel. |
- |
2.14 |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.NeighborBSS.{i}. |
object(0:) |
R |
The neighboring BSS discovered by a Radio during a channel scan. For MLDs, MLDMACAddress identifies the APMLD for which this NeighborBSS.{i}. is an affilated AP, other affiliated APs in this NeighborBSS have the same value of MLDMACAddress. At most one entry in this table can exist with a given value for BSSID. |
- |
2.14 |
ChannelBandwidth |
string |
R |
Indicates the maximum bandwidth at which the neighboring BSS is operating. e.g. "1" or "2" or "4" or "8"” or "16" or "20" or "40" or "80" or "80+80" or "160" or "320" MHz. |
- |
2.14 |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanCapability. |
object |
R |
This object describes the channel scan capabilities of a radio. |
- |
2.15 |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanCapability.OpClassChannels.{i}. |
object(1:) |
R |
Table of the operating classes (selected from [Table E-4/802.11ax]) and channel numbers in each operating class that the radio is capable of scanning. This table MUST contain at least 1 entry. At most one entry in this table can exist with a given value for OpClass. |
- |
2.15 |
OpClass |
unsignedInt(:255) |
R |
The Operating Class per [Table E-4/802.11ax] For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid. Note that the operating class identifies the band and channel width. |
- |
2.15 |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.CACCapability. |
object |
R |
This object describes the Channel Availability Check (CAC) capabilities of a radio. |
- |
2.15 |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.CACCapability.CACMethod.{i}. |
object(0:4) |
R |
List of Channel Availability Check (CAC) method information for each type of CAC that the radio can perform. Each type is defined by a method and time to complete. For each type, the classes and channels allowed are enumerated. This table MUST contain at least 0 and at most 4 entries. At most one entry in this table can exist with a given value for Method. |
- |
2.15 |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.CACCapability.CACMethod.{i}.OpClassChannels.{i}. |
object(1:) |
R |
Table of the operating classes (selected from [Table E-4/802.11ax]) and channel numbers in each operating class supported for this method of CAC. This table MUST contain at least 1 entry. At most one entry in this table can exist with a given value for OpClass. |
- |
2.15 |
OpClass |
unsignedInt(:255) |
R |
The Operating Class per [Table E-4/802.11ax]. Note that the operating class identifies the band and channel width. |
- |
2.15 |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities. |
object |
R |
This object represents the capabilities of the radio which may be different from the current operational configuration. Changes since 2.18:
|
- |
2.13 |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.CapableOperatingClassProfile.{i}. |
object(0:) |
R |
Describes one of the possible Operating Classes supported by this Radio. At most one entry in this table can exist with a given value for Class. |
- |
2.13 |
Class |
unsignedInt(:255) |
R |
The Operating Class per [Table E-4/802.11ax] that this radio is capable of operating on. |
- |
2.13 |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.HaLowCapabilities. |
object |
R |
This object describes the capabilities of the Wi-Fi HaLow radio, most of which can be extracted from the Sub 1 GHz (S1G) capabilities Information Element (IE) in [Section 9.4.2.200.2/802.11-2020]. |
- |
2.19 |
BW4MHz |
boolean |
R |
Indicates support for 4 MHz operation. |
- |
2.19 |
BW8MHz |
boolean |
R |
Indicates support for 8 MHz operation. |
- |
2.19 |
BW16MHz |
boolean |
R |
Indicates support for 16 MHz operation. |
- |
2.19 |
S1GLong |
boolean |
R |
Indicates support for the reception of S1G_LONG Physical layer Protocol Data Units (PPDUs). |
- |
2.19 |
BW1MHzShortGI |
boolean |
R |
Indicates support for 1 MHz short Guard Interval (GI). |
- |
2.19 |
BW2MHzShortGI |
boolean |
R |
Indicates support for 2 MHz short GI. |
- |
2.19 |
BW4MHzShortGI |
boolean |
R |
Indicates support for 4 MHz short GI. |
- |
2.19 |
BW8MHzShortGI |
boolean |
R |
Indicates support for 8 MHz short GI. |
- |
2.19 |
BW16MHzShortGI |
boolean |
R |
Indicates support for 16 MHz short GI. |
- |
2.19 |
AMSDU |
boolean |
R |
Indicates support of Aggregated MAC Service Data Units (AMSDU). |
- |
2.19 |
AMPDU |
boolean |
R |
Indicates support of Aggregated MAC Protocol Data Units (AMPDU). |
- |
2.19 |
FlowControl |
boolean |
R |
Indicates support for Flow Control [Section 10.61/802.11-2020]. |
- |
2.19 |
CentralizedAuthenticationControl |
boolean |
R |
Indicates support for Centralized Authentication Control [Section 11.3.9.2/802.11-2020]. |
- |
2.19 |
DistributedAuthenticationControl |
boolean |
R |
Indicates support for Distributed Authentication Control (DAC) [Section 11.3.9.3/802.11-2020]. |
- |
2.19 |
MaxMPDULen |
string |
R |
Indicates the maximum MAC Protocol Data Unit (MPDU) length in octets. Enumeration of:
|
- |
2.19 |
NonTIMMode |
boolean |
R |
Indicates support of non-Traffic Indication Map (non-TIM) operation [Section 10.48/802.11-2020]. |
- |
2.19 |
DynamicAID |
boolean |
R |
Indicates support of Dynamic Association ID (AID) operation [Section 10.20/802.11-2020]. |
- |
2.19 |
GroupAID |
boolean |
R |
Indicates support of Group Association ID (AID) [Section 10.55/802.11-2020]. |
- |
2.19 |
BATSupport |
boolean |
R |
Indicates support for the use of the Block Acknowledgment TWT (BAT) frame in Block Agreements [Section 9.8.4.3/802.11-2020]. |
- |
2.19 |
RAWOperation |
boolean |
R |
Indicates support for Restricted access window (RAW) operation [Section 10.23.5/802.11-2020]. |
- |
2.19 |
PageSlicing |
boolean |
R |
Indicates support for Page Slicing Operation [Section 10.51/802.11-2020]. |
- |
2.19 |
PV1Frame |
boolean |
R |
Indicates support for Protocol Version 1 (PV1) frames [Section 9.8/802.11-2020]. |
- |
2.19 |
TxMCSNSS |
unsignedInt(:255) |
R |
Supported Tx S1G-MCS Map subfield and Coding Scheme (S1G-MCS) and Number of Spatial Streams (NSS) Set field as defined in [Figure 9-694/802.11-2020]. |
- |
2.19 |
RxMCSNSS |
unsignedInt(:255) |
R |
Supported Rx S1G-MCS Map subfield and Coding Scheme (S1G-MCS) and Number of Spatial Streams (NSS) Set field as defined in [Figure 9-694/802.11-2020]. |
- |
2.19 |
SUBeamformer |
boolean |
R |
Indicates support for Single-User (SU) Beamformer [Section 10.36.5 VHT sounding protocol/802.11-2020]. |
- |
2.19 |
SUBeamformee |
boolean |
R |
Indicates support for Single-User (SU) Beamformee [Section 10.36.5 VHT sounding protocol/802.11-2020]. |
- |
2.19 |
MUBeamformer |
boolean |
R |
Indicates support for Multi-User (MU) Beamformer [Section 10.36.5 VHT sounding protocol/802.11-2020]. |
- |
2.19 |
MUBeamformee |
boolean |
R |
Indicates support for Multi-User (MU) Beamformee [Section 10.36.5 VHT sounding protocol/802.11-2020]. |
- |
2.19 |
TravelingPilot |
boolean |
R |
Indicates support for or the reception of PPDUs with traveling pilots [Section 10.56 Traveling pilot operation/802.11-2020]. |
- |
2.19 |
TWTGrouping |
boolean |
R |
Indicates support for Target Wake Time (TWT) Grouping [Section 10.47.5 TWT grouping/802.11-2020]. |
- |
2.19 |
TWTRequestor |
boolean |
R |
Indicates support for Target Wake Time (TWT) Requestor [Section 10.47 Target wake time (TWT)/802.11-2020]. |
- |
2.19 |
TWTResponder |
boolean |
R |
Indicates support for Target Wake Time (TWT) TWTResponder [Section 10.47 Target wake time (TWT)/802.11-2020]. |
- |
2.19 |
AcceptSensorDevices |
boolean |
R |
Indicates if this Wi-Fi HaLow radio accepts sensor associated devices (STAs). |
- |
2.19 |
AcceptNonSensorDevices |
boolean |
R |
Indicates if this Wi-Fi HaLow radio accepts non-sensor associated devices (STAs). |
- |
2.19 |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.CurrentOperatingClassProfile.{i}. |
object(0:) |
R |
Describes one of the current Operating Classes in use by this Radio. One Operating Class is indicated for each current Operating Channel Bandwidth. The Channel indicated for the 20 MHz Operating Class is equal to the current primary channel. At most one entry in this table can exist with a given value for Class. |
- |
2.13 |
Class |
unsignedInt(:255) |
R |
The Operating Class per [Table E-4/802.11ax] that this radio is currently operating on. |
- |
2.13 |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.DisAllowedOpClassChannels.{i}. |
object(0:) |
W |
The operating classes, and list of channels for each operating class, which are not allowed to be used on this radio. At most one enabled entry in this table can exist with a given value for OpClass. |
- |
2.15 |
OpClass |
unsignedInt(:255) |
W |
The Operating Class per [Table E-4/802.11ax]. Note that the operating class identifies the band and channel width. |
- |
2.15 |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.OpClassPreference.{i}. |
object(0:) |
R |
Values represent Channel Preference TLV values in the most recent Channel Preference Report message [Section 17.2.13/EasyMesh]. Each entry in this table describes one of the operating classes for which Channel Preference has been reported. A Preference score of 15 must be inferred for all channel/operating classes not present in this table, unless that channel/operating class has been reported as statically non-operable in the most recent AP Radio Basic Capabilities TLV [Section 17.2.7/EasyMesh]. At most one entry in this table can exist with the same values for both OpClass and Preference. |
- |
2.19 |
OpClass |
unsignedInt(:255) |
R |
The operating class [Table E-4/802.11ax]. Note that the operating class identifies the band and channel width. Values represent the OpClass field of the Channel Preference TLV in the most recent Channel Preference Report message [Section 17.2.13/EasyMesh]. |
- |
2.19 |
ChannelList |
unsignedInt(:255)[] |
R |
The channel numbers in this operating class. Comma-separated list of unsigned integers (up to 255). Values represent the Channel List field of the Channel Preference TLV in the most recent Channel Preference Report message [Section 17.2.13/EasyMesh]. |
- |
2.19 |
Preference |
unsignedInt(:15) |
R |
The reported preference for this OpClass and ChannelList, as defined in [Section 17.2.13/EasyMesh]. Values represent the Preference field of the Channel Preference TLV in the most recent Channel Preference Report message [Section 17.2.13/EasyMesh]. |
- |
2.19 |
ReasonCode |
unsignedInt(:15) |
R |
Reason Code. Indicates the reason for the Preference, as defined in [Section 17.2.13/EasyMesh]. Values represent the Reason_Code field of the Channel Preference TLV in the most recent Channel Preference Report message [Section 17.2.13/EasyMesh]. |
- |
2.19 |
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.18:
|
- |
2.13 |
UnicastBytesSent |
unsignedLong |
R |
[StatsCounter64] Access Point (BSS) wide statistics for total unicast bytes transmitted. This counter does not include Multi-Link Device (MLD) traffic through this BSS. |
- |
2.13 |
UnicastBytesReceived |
unsignedLong |
R |
[StatsCounter64] Access Point (BSS) wide statistics for total unicast bytes received. This counter does not include MLD traffic through this BSS. |
- |
2.13 |
MulticastBytesSent |
unsignedLong |
R |
[StatsCounter64] Access Point (BSS) wide statistics for total multicast bytes transmitted. This counter does not include MLD traffic through this BSS. |
- |
2.13 |
MulticastBytesReceived |
unsignedLong |
R |
[StatsCounter64] Access Point (BSS) wide statistics for total multicast bytes received. This counter does not include MLD traffic through this BSS. |
- |
2.13 |
BroadcastBytesSent |
unsignedLong |
R |
[StatsCounter64] Access Point (BSS) wide statistics for total broadcast bytes transmitted. This counter does not include MLD traffic through this BSS. |
- |
2.13 |
BroadcastBytesReceived |
unsignedLong |
R |
[StatsCounter64] Access Point (BSS) wide statistics for total broadcast bytes received. This counter does not include MLD traffic through this BSS. |
- |
2.13 |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.SetQoSManagementInput. |
object |
R |
This object records inputs for setting QoS Management [Section 20/EasyMesh]. |
- |
2.19 |
QosMapEnable |
boolean |
R |
Indicates whether QoS Map is enabled on this BSS. |
- |
2.19 |
MSCSEnable |
boolean |
R |
Indicates whether Mirrored Stream Classification Service (MSCS) is enabled on this BSS. |
- |
2.19 |
SCSEnable |
boolean |
R |
Indicates whether Stream Classification Service (SCS) is enabled on this BSS. |
- |
2.19 |
DSCPPolicyEnable |
boolean |
R |
Indicates whether DSCP Policy is enabled on this BSS. |
- |
2.19 |
SCSTrafficDescriptionEnable |
boolean |
R |
Indicates whether the extensions to SCS using Traffic Descriptions is enabled on this BSS. |
- |
2.19 |
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. Changes since 2.18:
|
- |
2.13 |
PairwiseAKM |
hexBinary(4) |
R |
Pairwise AKM suite selector selected by the associated device (STA). The Pairwise AKM suite selector (OUI and type) is encoded as a 4-octet hex-encoded value without internal delimiters, e.g. 506F9A02 [Table 9-151/802.11-2020]. |
- |
2.19 |
PairwiseCipher |
hexBinary(4) |
R |
Pairwise AKM cipher selector selected by the associated device (STA). The Pairwise AKM cipher selector (OUI and type) is encoded as a 4-octet hex-encoded value without internal delimiters, e.g. 506F9A02 [Table 9-149, OUI field/802.11-2020]. |
- |
2.19 |
RSNCapabilities |
unsignedInt(:65535) |
R |
The RSN Capabilities selected by the STA during association [Section 9.4.2.24.4,/802.11-2020]. |
- |
2.19 |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.HaLowCapabilities. |
object |
R |
Describes the HaLow capabilities of the Associated Device (STA). most of which can be extracted from the Sub 1 GHz (S1G) capabilities Information Element (IE) in [Section 9.4.2.200.2/802.11-2020]. |
- |
2.19 |
BW4MHz |
boolean |
R |
Indicates support for 4 MHz operation. |
- |
2.19 |
BW8MHz |
boolean |
R |
Indicates support for 8 MHz operation. |
- |
2.19 |
BW16MHz |
boolean |
R |
Indicates support for 16 MHz operation. |
- |
2.19 |
S1GLong |
boolean |
R |
Indicates support for the reception of S1G_LONG Physical layer Protocol Data Units (PPDUs). |
- |
2.19 |
BW1MHzShortGI |
boolean |
R |
Indicates support for 1 MHz short Guard Interval (GI). |
- |
2.19 |
BW2MHzShortGI |
boolean |
R |
Indicates support for 2 MHz short GI. |
- |
2.19 |
BW4MHzShortGI |
boolean |
R |
Indicates support for 4 MHz short GI. |
- |
2.19 |
BW8MHzShortGI |
boolean |
R |
Indicates support for 8 MHz short GI. |
- |
2.19 |
BW16MHzShortGI |
boolean |
R |
Indicates support for 16 MHz short GI. |
- |
2.19 |
AMSDU |
boolean |
R |
Indicates support of Aggregated MAC Service Data Units (AMSDU). |
- |
2.19 |
AMPDU |
boolean |
R |
Indicates support of Aggregated MAC Protocol Data Units (AMPDU). |
- |
2.19 |
FlowControl |
boolean |
R |
Indicates support for Flow Control [Section 10.61/802.11-2020]. |
- |
2.19 |
CentralizedAuthenticationControl |
boolean |
R |
Indicates support for Centralized Authentication Control [Section 11.3.9.2/802.11-2020]. |
- |
2.19 |
DistributedAuthenticationControl |
boolean |
R |
Indicates support for Distributed Authentication Control (DAC) [Section 11.3.9.3/802.11-2020]. |
- |
2.19 |
MaxMPDULen |
string |
R |
Indicates the maximum MAC Protocol Data Unit (MPDU) length in octets. Enumeration of:
|
- |
2.19 |
NonTIMMode |
boolean |
R |
Indicates support of non-Traffic Indication Map (non-TIM) operation [Section 10.48/802.11-2020]. |
- |
2.19 |
DynamicAID |
boolean |
R |
Indicates support of Dynamic Association ID (AID) operation [Section 10.20/802.11-2020]. |
- |
2.19 |
GroupAID |
boolean |
R |
Indicates support of Group Association ID (AID) [Section 10.55/802.11-2020]. |
- |
2.19 |
BATSupport |
boolean |
R |
Indicates support for the use of the Block Acknowledgment TWT (BAT) frame in Block Agreements [Section 9.8.4.3/802.11-2020]. |
- |
2.19 |
RAWOperation |
boolean |
R |
Indicates support for Restricted access window (RAW) operation [Section 10.23.5/802.11-2020]. |
- |
2.19 |
PageSlicing |
boolean |
R |
Indicates support for Page Slicing Operation [Section 10.51/802.11-2020]. |
- |
2.19 |
PV1Frame |
boolean |
R |
Indicates support for Protocol Version 1 (PV1) frames [Section 9.8/802.11-2020]. |
- |
2.19 |
TxMCSNSS |
unsignedInt(:255) |
R |
Supported Tx S1G-MCS Map subfield and Coding Scheme (S1G-MCS) and Number of Spatial Streams (NSS) Set field as defined in [Figure 9-694/802.11-2020]. |
- |
2.19 |
RxMCSNSS |
unsignedInt(:255) |
R |
Supported Rx S1G-MCS Map subfield and Coding Scheme (S1G-MCS) and Number of Spatial Streams (NSS) Set field as defined in [Figure 9-694/802.11-2020]. |
- |
2.19 |
SUBeamformer |
boolean |
R |
Indicates support for Single-User (SU) Beamformer [Section 10.36.5 VHT sounding protocol/802.11-2020]. |
- |
2.19 |
SUBeamformee |
boolean |
R |
Indicates support for Single-User (SU) Beamformee [Section 10.36.5 VHT sounding protocol/802.11-2020]. |
- |
2.19 |
MUBeamformer |
boolean |
R |
Indicates support for Multi-User (MU) Beamformer [Section 10.36.5 VHT sounding protocol/802.11-2020]. |
- |
2.19 |
MUBeamformee |
boolean |
R |
Indicates support for Multi-User (MU) Beamformee [Section 10.36.5 VHT sounding protocol/802.11-2020]. |
- |
2.19 |
TravelingPilot |
boolean |
R |
Indicates support for or the reception of PPDUs with traveling pilots [Section 10.56 Traveling pilot operation/802.11-2020]. |
- |
2.19 |
TWTGrouping |
boolean |
R |
Indicates support for Target Wake Time (TWT) Grouping [Section 10.47.5 TWT grouping/802.11-2020]. |
- |
2.19 |
TWTRequestor |
boolean |
R |
Indicates support for Target Wake Time (TWT) Requestor [Section 10.47 Target wake time (TWT)/802.11-2020]. |
- |
2.19 |
TWTResponder |
boolean |
R |
Indicates support for Target Wake Time (TWT) TWTResponder [Section 10.47 Target wake time (TWT)/802.11-2020]. |
- |
2.19 |
IsSensorDevice |
boolean |
R |
Indicates if this is a sensor device. A value of false indicates this is a non-sensor device. |
- |
2.19 |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.UnassociatedSTA.{i}. |
object(0:) |
R |
Each instance represents a station (STA) that has been discovered by the Radio but is not associated to any of the BSS operating on the Radio. At most one entry in this table can exist with a given value for MACAddress. |
- |
2.13 |
OperatingClass |
unsignedInt(:255) |
R |
Operating class on which this unassociated STA was last detected, per [Table E-4/802.11ax]. |
- |
2.17 |
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.18:
|
- |
2.17 |
LinkToOpClassMapNumberOfEntries |
unsignedInt |
R |
The number of entries in the LinkToOpClassMap table. |
- |
2.19 |
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.APMLDConfig. |
object |
R |
This object describes the Wi-Fi 7 Multi-Link Operation (MLO) configuration of the Multi-Link Device (MLD) Access Point (AP), [EasyMesh] source: Agent AP MLD Configuration TLV. Changes since 2.18:
|
- |
2.17 |
EMLMREnabled |
boolean |
W |
Indicates if the Enhanced Multi-Link Multi-Radio (EMLMR) operation is enabled. Changes since 2.18:
|
- |
2.17 |
EMLSREnabled |
boolean |
W |
Indicates if Enhanced Multi-Link Single-Radio (EMLSR) operation is enabled. Changes since 2.18:
|
- |
2.17 |
STREnabled |
boolean |
W |
Indicates if Simultaneous Transmit and Receive (STR) operation is enabled. Changes since 2.18:
|
- |
2.17 |
NSTREnabled |
boolean |
W |
Indicates if Non-Simultaneous Transmit and Receive (NSTR) operation is enabled. Changes since 2.18:
|
- |
2.17 |
TIDLinkMapNegotiation |
boolean |
W |
Indicates if Traffic Identifier (TID) to Link Mapping Negotiation is enabled. [EasyMesh] source: TID-to-Link Mapping Policy TLV. Changes since 2.18:
|
- |
2.17 |
TIDToOpClassPolicyNumberOfEntries |
unsignedInt |
R |
The number of entries in the TIDToOpClassPolicy table. |
- |
2.19 |
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.APMLDConfig.TIDToOpClassPolicy.{i}. |
object(0:) |
W |
Table of Traffic Identifier (TID) to Operating Class to be used as a policy when configuring TID-to-Link Mapping in the Multi-Link Operation (MLO) capable access point (AP). Each table entry describes the mapping between a particular TID and direction and the required current Operating Class for any link to be used for this TID when constructing a TID-to-Link Map [Section 20.2.8/EasyMesh]. At most one enabled entry in this table can exist with the same values for both TID and Direction. |
- |
2.19 |
Enable |
boolean |
W |
This parameter indicates whether the TID-to-Link mapping entry is enabled for Multi-Link Operation (MLO) on the access point (AP). When set to "true", the mapping between the specified Traffic Identifier (TID), direction, and required Operating Class will be active, and the TID-to-Link mapping policy will be applied during Multi-Link operations. When set to "false", the entry will be ignored. |
false |
2.19 |
TID |
unsignedInt(0:255) |
W |
The traffic identifier (TID) for this mapping. This TID is a unique key for this table. |
- |
2.19 |
OpClass |
unsignedInt(:255)[] |
W |
Comma-separated list of unsigned integers (up to 255). The Operating class of an available channel, from [Table E-4/802.11ax]. The TID can be mapped to any link using a radio with a current operating class within this list. |
- |
2.19 |
Direction |
string |
W |
The direction of the traffic flow from the perspective the APMLD. Enumeration of:
|
- |
2.19 |
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.TIDLinkMap.{i}. |
object(0:) |
R |
Table of Traffic Identifier (TID) to Link Mappings of the Multi-Link Operation (MLO) capable access point (AP). Each table entry describes the mapping between a particular TID and direction and preferred link. [EasyMesh] source: TID-to-Link Mapping Policy TLV. At most one entry in this table can exist with a given value for TID. |
- |
2.17 |
LinkID |
unsignedInt(0:15)[] |
R |
Comma-separated list of unsigned integers (0 to 15). The Link ID of the preferred link (affiliated AP) to use for traffic with matching direction and TID values. Changes since 2.18:
|
- |
2.17 |
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.LinkToOpClassMap.{i}. |
object(0:) |
R |
This object describes the relationship between an Affiliated AP and the Operating Class (OpClass) of the Radio that the Affiliated AP is operating on [Section 20.2.8/EasyMesh]. At most one entry in this table can exist with a given value for LinkID. |
- |
2.19 |
LinkID |
unsignedInt(0:15) |
R |
The Link ID assigned to one of the affiliated APs of this APMLD. [Section 17.2.96, Agent AP MLD Configuration TLV/EasyMesh] |
- |
2.19 |
OpClass |
unsignedInt(:255) |
R |
One of the current Operating Class per [Table E-4/802.11ax] that the Radio on which the Affiliated AP with the given LinkID is operating on. |
- |
2.19 |
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.AffiliatedAP.{i}. |
object(0:) |
R |
The Access Points (APs) affiliated to the AP MLD. [EasyMesh] Source: Agent AP MLD Configuration TLV. Counters in this object only include all traffic, MLD and non-MLD.traffic. At most one entry in this table can exist with a given value for BSSID. |
- |
2.17 |
LinkID |
unsignedInt(0:15) |
R |
The Link ID assigned to this affiliated AP. [EasyMesh] source: Agent AP MLD Configuration TLV. Changes since 2.18:
|
- |
2.17 |
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.STAMLD.{i}. |
object(0:) |
R |
This object describes Multi-Link Operation (MLO) capable stations (STAs), also known as client Multilink Devices (MLDs), associated to this MLO capable Access Point. [EasyMesh] source: Associated Clients TLV. At most one entry in this table can exist with a given value for MLDMACAddress. Changes since 2.18:
|
- |
2.17 |
PairwiseAKM |
hexBinary(4) |
R |
Pairwise AKM suite selector selected by the STAMLD. The Pairwise AKM suite selector (OUI and type) is encoded as a 4-octet hex-encoded value without internal delimiters, e.g. 506F9A02 [Table 9-151/802.11-2020]. |
- |
2.19 |
PairwiseCipher |
hexBinary(4) |
R |
Pairwise AKM cipher selector selected by the STAMLD. The Pairwise AKM cipher selector (OUI and type) is encoded as a 4-octet hex-encoded value without internal delimiters, e.g. 506F9A02 [Table 9-149/802.11-2020]. |
- |
2.19 |
RSNCapabilities |
unsignedInt(:65535) |
R |
The RSN Capabilities selected by the STAMLD during association [Section 9.4.2.24.4/802.11-2020]. |
- |
2.19 |
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.STAMLD.{i}.STATIDLinkMap.{i}. |
object(0:) |
R |
Table of Traffic Identifier (TID) to Link Mappings of the Multi-Link Operation (MLO) capable station (STA). Each table entry describes the mapping between a particular TID and direction and preferred link. [EasyMesh] source: TID-to-Link Mapping Policy TLV. At most one entry in this table can exist with a given value for TID. |
- |
2.17 |
LinkID |
unsignedInt(0:15)[] |
R |
Comma-separated list of unsigned integers (0 to 15). The Link ID of the preferred link (affiliated AP) to use for traffic with matching direction and TID values. Changes since 2.18:
|
- |
2.17 |
Device.WiFi.DataElements.Network.Device.{i}.bSTAMLD. |
object |
R |
This object represents the Multi-Link Operation (MLO) capable backhaul station (bSTA) operating on this EasyMesh Agent. Only one MLO capable bSTA per EasyMesh Agent is allowed. [EasyMesh] source: Backhaul STA MLD Configuration TLV. |
- |
2.17 |
Device.WiFi.DataElements.Network.Device.{i}.bSTAMLD.bSTAMLDConfig. |
object |
R |
This object describes the Multi-Link Operation (MLO) configuration of a Multi-Link Device (MLD) backhaul STA (bSTA). [EasyMesh] source: Backhaul STA MLD Configuration TLV. |
- |
2.17 |
EMLMREnabled |
boolean |
W |
Indicates if the Enhanced Multi-Link Multi-Radio (EMLMR) operation is enabled. Changes since 2.18:
|
- |
2.17 |
EMLSREnabled |
boolean |
W |
Indicates if Enhanced Multi-Link Single-Radio (EMLSR) operation is enabled. Changes since 2.18:
|
- |
2.17 |
STREnabled |
boolean |
W |
Indicates if Simultaneous Transmit and Receive (STR) operation is enabled. Changes since 2.18:
|
- |
2.17 |
NSTREnabled |
boolean |
W |
Indicates if Non-Simultaneous Transmit and Receive (NSTR) operation is enabled. Changes since 2.18:
|
- |
2.17 |
TIDLinkMapNegotiation |
boolean |
W |
Indicates if Traffic Identifier (TID) to Link Mapping Negotiation is enabled. [EasyMesh] source: TID-to-Link Mapping Policy TLV. Changes since 2.18:
|
- |
2.17 |
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. Changes since 2.18:
|
- |
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. |
- |
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. Changes since 2.18:
|
- |
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. |
- |
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. Changes since 2.18:
|
- |
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. Changes since 2.18:
|
- |
2.15 |
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. |
- |
2.0 |
Enable |
boolean |
W |
Enables or disables the radio.interface. This parameter is based on ifAdminStatus from [RFC2863]. If the instance of this Radio is the same as Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}, then this parameter is the same as Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Enabled. |
- |
2.0 |
Status |
string |
R |
The current operational state of the radiointerface (see [Section 4.2.2/TR-181i2]). Enumeration of:
When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863]. Because the interface includes layer 1, the LowerLayerDown value SHOULD never be used. |
- |
2.0 |
Name |
string(:64) |
R |
The textual name of the radiointerface as assigned by the CPE. |
- |
2.0 |
LastChange |
unsignedInt |
R |
The accumulated time in seconds since the radiointerface entered its current operational state. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
MaxBitRate |
unsignedInt |
R |
The maximum upstream and downstream PHY bit rate supported by this interface (expressed in Mbps). |
- |
2.0 |
Device.WiFi.Radio.{i}.Stats. |
object |
R |
Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See {{bibref|TR-181i2|Appendix III}} for further details. The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. Packet counters here count 802.11 WiFi frames. See [Appendix III/TR-181i2] for further details. Changes since 2.18:
|
- |
2.0 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
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. |
- |
2.0 |
Enable |
boolean |
W |
Enables or disables the SSID entry.interface. This parameter is based on ifAdminStatus from [RFC2863]. If the instance of this SSID is the same as Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}., then this parameter is the same as Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.Enabled. |
false |
2.0 |
Status |
string |
R |
The current operational state of the SSID entryinterface (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.0 |
Name |
string(:64) |
R |
The textual name of the SSID entryinterface as assigned by the CPE. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.0 |
LastChange |
unsignedInt |
R |
The accumulated time in seconds since the SSIDinterface entered its current operational state. If the instance of this SSID is the same as Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}., then this parameter is the same as Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.LastChange. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
Device.WiFi.SSID.{i}.Stats. |
object |
R |
Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See {{bibref|TR-181i2|Appendix III}} for further details. The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. Packet counters here count 802.11 WiFi frames. See [Appendix III/TR-181i2] for further details. Changes since 2.18:
|
- |
2.0 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. These can be due to the number of retransmissions exceeding the retry limit, or from other causes. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
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. Changes since 2.18:
|
- |
2.0 |
Device.WiFi.AccessPoint.{i}.Interworking. |
object |
R |
This object contains the settings to the interworking element as described in [Section 9.4.2.91/802.11-2020]. |
- |
2.19 |
Enable |
boolean |
W |
Specifies whether the Interworking element is included in the wireless frames for this access point. |
- |
2.19 |
AccessNetworkType |
string |
W |
Type of access network to be specified in Interworking element as per [Table 9-236 Access Network Type/802.11-2020]. Enumeration of:
|
- |
2.19 |
InternetAvailable |
boolean |
W |
Indicates that Internet Access is available at the AP when set to true. This MUST be set to false in case of walled-garden environments, where the AP may limit Wi-Fi access to locally available content. See [Section 9.4.2.91/802.11-2020]. |
- |
2.19 |
ASRA |
boolean |
W |
Additional Step Required For Access as specified in the Interworking element of [Figure 9-484/802.11-2020]. Indicates that the network requires a further step for access when set to true. The Type of access is determined by ANQP.NetworkAuthTypes. |
- |
2.19 |
VenueGroup |
string |
W |
Specifies the venue group as descriped in [Table 9-65-Venue group codes and descriptions/802.11-2020]. Enumeration of:
|
- |
2.19 |
VenueType |
string |
W |
Specifies the Venue Type as described in [Table 9-66 Venue Type assignments/802.11-2020]. |
- |
2.19 |
HESSID |
string(:17) |
W |
[MACAddress] Specifies the 6-octet MAC address that identifies the homogeneous ESS as described in [Section 9.4.2.91/802.11-2020]. |
- |
2.19 |
EmergencyServiceReachable |
boolean |
W |
ESR (emergency services reachable) field of the Interworking element as described in [Section 9.4.2.91/802.11-2020]. |
- |
2.19 |
UnauthenticatedEmergencyServiceAvailable |
boolean |
W |
UESA (unauthenticated emergency service accessible) field of the interworking element as described in [Section 9.4.2.91/802.11-2020]. |
- |
2.19 |
Device.WiFi.AccessPoint.{i}.ANQP. |
object |
R |
This object contains the settings required for configuring the Access Network Query Protocol Information Elements as described in [Section 9.4.5/802.11-2020]. |
- |
2.19 |
Enable |
boolean |
W |
Specfies whether ANQP Element is sent as part of the wireless frames. |
false |
2.19 |
IPv4AddressAvailability |
string |
W |
Specifies the IPv4 address availabilty field as described in [Table 9-334-IPv4 Address field values/802.11-2020]. Enumeration of:
|
- |
2.19 |
IPv6AddressAvailability |
string |
W |
Specifies the IPv6 Address Type Availability ANQP-element as described in [Table 9-333-IPv6 Address field values/802.11-2020]. Enumeration of:
|
- |
2.19 |
VenueName |
string(:252) |
W |
Specifies venue name which can assist a user in selecting the appropriate BSS of which to become a member as described in [Section 9.4.5.4/802.11-2020]. |
- |
2.19 |
RoamingConsortiumOIs |
string[] |
W |
Comma-separated list of strings. Specifies the list of Roaming Consortiums whose networks are accessible via this AP as described in [Section 9.4.5.7/802.11-2020]. |
- |
2.19 |
NAIRealms |
string[] |
W |
Comma-separated list of strings. Specifies the list of network access identifier (NAI) realms corresponding to Subscription Service Provider or other entities whose networks or service are accessible via this AP as described in [Section 9.4.5.10/802.11-2020]. |
- |
2.19 |
Domains |
string[] |
W |
Comma-separated list of strings. Specifies the list of one or more domain names of the entity operating the IEEE 802.11 access network as described in [Section 9.4.5.15/802.11-2020]. |
- |
2.19 |
AdviceOfCharges |
string[] |
W |
Comma-separated list of strings. Specifies the list of financial advice of charges related to access as described in [Section 9.4.5.21/802.11-2020]. Each list item is an enumeration of:
|
- |
2.19 |
NetworkAuthTypes |
string[] |
W |
Comma-separated list of strings. Specifies the list of authentication types required when Interworking.ASRA is set to true as described in [Section 9.4.5.23/802.11-2020]. Each list item is an enumeration of:
|
- |
2.19 |
Cellular3GPPNetworkInfo |
unsignedInt[] |
W |
[PLMNId] Comma-separated list of PLMNIds. Specifies the Public Land Mobile Network (PLMN) IDs which denote the country code (MCC) and network code (MNC) as described in [Section 9.4.5.11 3GPP Cellular Network ANQP-element/802.11-2020]. Example:
|
- |
2.19 |
Device.WiFi.AccessPoint.{i}.Passpoint. |
object |
R |
This object describes Passpoint/HotSpot 2.0 elements as defined in [Passpoint]. |
- |
2.19 |
Enable |
boolean |
W |
Enables or Disables Hotspot 2.0 indication on the access point. |
false |
2.19 |
Version |
string |
R |
Passpoint specification version as described in [Table 5. Passpoint Specification version number definition/Passpoint]. Enumeration of:
|
- |
2.19 |
OperatorFriendlyName |
string(:252) |
W |
Indicates that operator's preferred friendly name used for Online Sign Up purposes to the Passpoint hotspot operator for advertisement as described in [Section 4.3/Passpoint]. |
- |
2.19 |
DGAFDisable |
boolean |
W |
Indicates the state of the Downstream group-addressed forwarding Disable bit in the HS2.0 Indication element as described in [Section 5.2/Passpoint]. |
- |
2.19 |
Device.WiFi.AccessPoint.{i}.Passpoint.OSU. |
object |
R |
This object implements Passpoint Online Sign Up as described in [Section 4.3/Passpoint]. |
- |
2.19 |
Enable |
boolean |
W |
Enables or Disables Online Sign Up feature on the access point. |
false |
2.19 |
SSID |
string |
W |
The SSID that the mobile device uses for Online Sign Up with all the Online Sign Up providers listed in FriendlyNames |
- |
2.19 |
Method |
string[] |
W |
Comma-separated list of strings. Specifies the list of protocols supported by the Online Sign Up provider as described in [Table 13-OSU Method values/Passpoint]. Each list item is an enumeration of:
|
- |
2.19 |
FriendlyNames |
string(:252)[] |
W |
Comma-separated list of strings (maximum number of characters per item 252). Specifies the list of Online Sign Up Provider names as described in [Section 4.8.1.1/Passpoint]. |
- |
2.19 |
ServerURIs |
string[] |
W |
Comma-separated list of strings. Specifies the list of Online Sign Up Server URI as described in [Section 4.8.1.2/Passpoint]. |
- |
2.19 |
ServiceDescriptions |
string(:252)[] |
W |
Comma-separated list of strings (maximum number of characters per item 252). Specifies the list of Online Sign Up service description as described in [Section 4.8.1.6/Passpoint]. |
- |
2.19 |
ProviderNAIs |
string[] |
W |
Comma-separated list of strings. Specifies the list of the Network Access Identifiers that is used for Online Sign Up as described in [Section 4.13/Passpoint]. |
- |
2.19 |
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 |
BorderRouterNumberOfEntries |
unsignedInt |
R |
The number of entries in the BorderRouter table. |
- |
2.19 |
RadioNumberOfEntries |
unsignedInt |
R |
The number of entries in the Radio table. |
- |
2.19 |
MLENumberOfEntries |
unsignedInt |
R |
The number of entries in the MLE table. |
- |
2.19 |
NodeNumberOfEntries |
unsignedInt |
R |
The number of entries in the Node table. |
- |
2.19 |
Device.Thread.BorderRouter.{i}. |
object(0:) |
R |
The BorderRouter is capable of forwarding between a Thread Network and a non-Thread Network. Each BorderRouter entry is associated with a particular Thread Network (or MLE) instance via the MLEReference parameter. At most one entry in this table can exist with a given value for Alias, or with a given value for BorderAgentID. |
- |
2.19 |
Enable |
boolean |
W |
Enables or disables this border router. |
- |
2.19 |
Status |
string |
R |
Indicates the status of this border router. Enumeration of:
|
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.19 |
BorderAgentID |
hexBinary(16) |
R |
Globally unique ID generated by the Thread Border Router. |
- |
2.19 |
MLEReference |
string |
W |
The value MUST be the Path Name of a row in the MLE. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Define the Thread network to which it belongs. |
- |
2.19 |
RoutingRef |
string |
R |
The value MUST be the Path Name of a row in the Routing.Router. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Define the routing and forwarding configuration of the BorderRouter, in order to access the Thread Network it manages. This is the way to manage ::/64 prefix used for global addressing of the mesh network (see Thread Specification [ThreadIPv6Addressing] "IPv6 Address Configuration"). |
- |
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. |
- |
2.19 |
Enable |
boolean |
W |
Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.19 |
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863]. Because the interface includes layer 1, the LowerLayerDown value SHOULD never be used. |
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.19 |
Name |
string(:64) |
R |
The textual name of the interface as assigned by the CPE. |
- |
2.19 |
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.19 |
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]. Note: Since Radio is a layer 1 interface, it is expected that LowerLayers will not be used. |
- |
2.19 |
MaxBitRate |
unsignedInt |
R |
The maximum upstream and downstream PHY bit rate supported by this interface (expressed in Mbps). |
- |
2.19 |
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
|
- |
2.19 |
TransmitPowerSupported |
int(-1:100)[] |
R |
Comma-separated list of integers (-1 to 100). List items represent supported transmit power levels as percentage of full power. For example, "0,25,50,75,100". A -1 item indicates auto mode (automatic decision by CPE). Auto mode allows the Radio to adjust transmit power accordingly. For example, this can be useful for power-save modes such as EU-CoC, where the Radio can adjust power according to activity in the CPE. |
- |
2.19 |
TransmitPower |
int(-1:100) |
W |
Indicates the current transmit power level as a percentage of full power. The value MUST be one of the values reported by the TransmitPowerSupported parameter. A value of -1 indicates auto mode (automatic decision by device). |
- |
2.19 |
HardwareVersion |
string |
R |
This radio's Thread hardware version. |
- |
2.19 |
FirmwareVersion |
string |
R |
This radio's Thread firmware version. |
- |
2.19 |
Device.Thread.Radio.{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.19 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
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.19 |
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.19 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. |
- |
2.19 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packets received on the interface. Active Notification requests for this parameter MAY be denied. |
- |
2.19 |
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.19 |
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.19 |
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.19 |
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.19 |
Device.Thread.MLE.{i}. |
object(0:) |
W |
This object models the Mesh Link Establishment (MLE) (a stackable interface object as described in [Section 4.2/TR-181i2]) used to establish and configure secure radio link of Thread network. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.19 |
Enable |
boolean |
W |
Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
false |
2.19 |
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.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.19 |
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.19 |
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.19 |
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.19 |
SupportedStandards |
string[] |
R |
Comma-separated list of strings. The items in the list indicate the supported Thread version. The associated border router can only support one standard at a time. Each list item is an enumeration of:
|
- |
2.19 |
OperatingStandard |
string |
R |
The value MUST be a member of the list reported by the SupportedStandards parameter. The operating standard this MLE instance is configured for. |
- |
2.19 |
DatasetNumberOfEntries |
unsignedInt |
R |
The number of entries in the Dataset table. |
- |
2.19 |
AssociatedNodeNumberOfEntries |
unsignedInt |
R |
The number of entries in the AssociatedNode table. |
- |
2.19 |
Device.Thread.MLE.{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.19 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
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.19 |
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.19 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. |
- |
2.19 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packets received on the interface. Active Notification requests for this parameter MAY be denied. |
- |
2.19 |
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.19 |
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.19 |
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.19 |
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.19 |
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.19 |
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.19 |
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.19 |
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.19 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. |
- |
2.19 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. |
- |
2.19 |
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.19 |
Device.Thread.MLE.{i}.LeaderData. |
object |
R |
Indicates the leader data. |
- |
2.19 |
DataVersion |
unsignedInt(0:65535) |
R |
The full Network Data Version the Node currently uses. |
- |
2.19 |
LeaderRouterID |
unsignedInt(0:65535) |
R |
The 8-bit LeaderRouterID the Node attempts to utilize upon becoming a router or leader on the Thread network. |
- |
2.19 |
PartitionID |
unsignedInt |
R |
The Thread Leader Partition ID for the Thread network to which the Node is joined. |
- |
2.19 |
StableDataVersion |
unsignedInt(0:65535) |
R |
The Network Data Version for the stable subset of data the Node currently uses. |
- |
2.19 |
Weighting |
unsignedInt(0:65535) |
R |
The Thread Leader weight used when operating in the Leader role. |
- |
2.19 |
Device.Thread.MLE.{i}.Dataset.{i}. |
object(0:2) |
R |
Thread network configuration parameters are managed using an active and one optional pending Operational Dataset objects. The active Operational Dataset includes parameters (defined in the Thread specification, see [ThreadSpec]) that are currently in use across an entire Thread network. The active Operational Dataset contains:
The pending Operational Dataset is used to communicate changes to the active Operational Dataset before they take effect. The pending Operational Dataset contains all the parameters from the Active Operational Dataset, with the addition of: Delay Timer. This table MUST contain at least 0 and at most 2 entries. At most one entry in this table can exist with a given value for Status, or with a given value for Alias. |
- |
2.19 |
Status |
string |
R |
Indicates the status of this dataset. Enumeration of:
|
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.19 |
TimeStamp |
dateTime |
R |
TimeStamp of the dataset, depending status, it represent :
|
- |
2.19 |
DelayTimer |
unsignedInt |
R |
An unsigned 32-bit number in milliseconds indicate the Time Remaining when pending Dataset will be activated. This value MUST be 0 for active dataset. |
- |
2.19 |
Channel |
unsignedInt(0:255) |
R |
The IEEE 802.15.4 channel value of the interface defined in [ThreadSpec] (Thread specification only supports the 2450 MHz channels). |
- |
2.19 |
NetworkName |
string |
R |
The name of the network link to the interface. |
- |
2.19 |
PanID |
hexBinary(2) |
R |
The IEEE 802.15.4 PAN ID value link to the interface. |
- |
2.19 |
ExtendedPanID |
hexBinary(8) |
R |
The IEEE 802.15.4 ExtPAN ID value link to the interface. |
- |
2.19 |
MeshLocalPrefix |
string(:49) |
R |
[IPv6Prefix] Indicate the mesh-local IPv6 prefix for the Thread network. |
- |
2.19 |
ChannelMask |
hexBinary(4) |
R |
Indicates the channels within channel page 0, in the 2.4GHz ISM band. The channels are represented in most significant bit order, with bit value 1 meaning selected, bit value 0 meaning unselected. |
- |
2.19 |
PSKc |
hexBinary(16) |
R |
Pre-Shared Key Credential for inband commissioning. |
- |
2.19 |
NetworkKey |
hexBinary(16) |
R |
Key of the network. |
- |
2.19 |
Device.Thread.MLE.{i}.Dataset.{i}.SecurityPolicy. |
object |
R |
The SecurityPolicy provide an administrator a way to enable or disable certain security related behaviors. |
- |
2.19 |
RotationTime |
unsignedInt(0:65535) |
R |
The rotation time of the security policy. |
- |
2.19 |
Flags |
string[] |
R |
Comma-separated list of strings. The flags indicates the current security policies for the Thread partition of the current dataset. The Flags is an ordered concatenation of case sensitive characters containing list elements (may be empty). Each list item is an enumeration of:
|
- |
2.19 |
Device.Thread.MLE.{i}.AssociatedNode.{i}. |
object(0:) |
R |
A table of the nodes currently associated to the Thread network defined by this MLE. instance. This includes the host nodes. At most one entry in this table can exist with a given value for Alias, or with a given value for ExtendedMAC. |
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.19 |
LastContactTime |
dateTime |
R |
The date and time in UTC when associated Thread node on the device has received data from remote node. |
- |
2.19 |
ExtendedMAC |
hexBinary(16) |
R |
Unique MacID of the node. |
- |
2.19 |
Rloc16 |
unsignedInt(0:65535) |
R |
Rloc of the node. |
- |
2.19 |
RoutingRole |
string |
R |
The current state of the Thread node. Enumeration of: |
- |
2.19 |
Mode |
string |
R |
Thread Device mode value. Enumeration of:
|
- |
2.19 |
RouteNumberOfEntries |
unsignedInt |
R |
The number of entries in the Route table. |
- |
2.19 |
NeighborNumberOfEntries |
unsignedInt |
R |
The number of entries in the Neighbor table. |
- |
2.19 |
IPv6AddressNumberOfEntries |
unsignedInt |
R |
The number of entries in the IPv6Address table. |
- |
2.19 |
Device.Thread.MLE.{i}.AssociatedNode.{i}.Neighbor.{i}. |
object(0:) |
R |
Entries in this table reference nodes that are immediate neighbors of the associated node instance. This table is empty if the RoutingRole is not a Router or Leader. At most one entry in this table can exist with a given value for NodeReference. |
- |
2.19 |
NodeReference |
string |
R |
The value MUST be the Path Name of a row in the AssociatedNode. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. References the Thread node that is an immediate neighbor of the AssociatedNode. By construction the RoutingRole of AssociatedNode MUST be Router or Leader. |
- |
2.19 |
AvgRSSI |
unsignedInt |
R |
The average Received Signal Strength Indicator (RSSI) is the average measurement of the signal strength received by the parent router node from the neighbor node. |
- |
2.19 |
Device.Thread.MLE.{i}.AssociatedNode.{i}.Route.{i}. |
object(0:) |
R |
Entries in this table depend on the associated node routing capabilities defined by the RoutingRole and Mode according to the Thread Specification (i.e. a child node has an empty Route table). It maintains information for each link to Router neighbor as follows:
At most one entry in this table can exist with a given value for ID. |
- |
2.19 |
ID |
unsignedInt(0:65535) |
R |
Router ID of the route table entry. |
- |
2.19 |
PathCost |
unsignedInt(0:65535) |
R |
The routing cost advertised by the Next Hop to reach ID. |
- |
2.19 |
LQIn |
unsignedInt(0:3) |
R |
[ThreadLinkQuality] Link Quality for messages received from ID, depending on the Link Margin value average of the received relative signal strength. |
- |
2.19 |
LQOut |
unsignedInt(0:3) |
R |
[ThreadLinkQuality] Link Quality for messages sent to ID, depending on the Link Margin value average of the sent relative signal strength. |
- |
2.19 |
Device.Thread.MLE.{i}.AssociatedNode.{i}.IPv6Address.{i}. |
object(0:) |
R |
This object represents the list of IPv6 addresses associated with the Thread node. At most one entry in this table can exist with the same values for both Alias and IPAddress. |
- |
2.19 |
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.19 |
Type |
string |
R |
The IPv6 address may by of one the following types. Enumeration of:
|
- |
2.19 |
IPAddress |
string(:45) |
R |
[IPv6Address] Router ID of the route table entry. |
- |
2.19 |
Device.Thread.Node.{i}. |
object(0:) |
R |
The table of nodes hosted on the device. At most one entry in this table can exist with a given value for ExtendedMAC. |
- |
2.19 |
ExtendedMAC |
hexBinary(16) |
R |
Unique MacID of the node. |
- |
2.19 |
Connected |
boolean |
W |
The connectivity status. When true this Node instance participates to the Thread network referenced by MLEReference. |
- |
2.19 |
MLEReference |
string |
R |
The value MUST be the Path Name of a row in the MLE. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Connect the node to the Thread network managed by the Mesh Link Established. |
- |
2.19 |
Device.ZigBee. |
object |
R |
Top level object for ZigBee capabilities based on the [ZigBee2007] specification. |
- |
2.7 |
Device.ZigBee.Interface.{i}. |
object(0:) |
R |
ZigBee interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the ZigBee interface of a ZigBee end device, ZigBee router or ZigBee coordinator. At most one entry in this table can exist with a given value for Alias, or with a given value for Name, or with a given value for ZDOReference. Changes since 2.18:
|
- |
2.7 |
Status |
string |
R |
The current operational state of the interface (see [Section 4.2.2/TR-181i2]). Enumeration of:
When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863]. Because the interface includes layer 1, the LowerLayerDown value SHOULD never be used. |
- |
2.7 |
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]. Note: Since Interface is a layer 1 interface, it is expected that LowerLayers will not be used. |
- |
2.7 |
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
|
- |
2.19 |
MaxBitRate |
unsignedInt |
R |
The maximum upstream and downstream PHY bit rate supported by this interface (expressed in Mbps). |
- |
2.19 |
Device.ZigBee.Interface.{i}.Stats. |
object |
R |
Throughput statistics for this interface. The CPE MUST reset the interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface's Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. Changes since 2.18:
|
- |
2.7 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets sent transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.7 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packets received byon the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.7 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packets discardedthat bycould interfacenot duebe totransmitted anybecause error.of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.7 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packets received that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.7 |
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. Changes since 2.18:
|
- |
2.7 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packets requested for transmission which were chosen to be discarded even though no errors had been detected to prevent the {{units}}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. Changes since 2.18:
|
- |
2.7 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packets received 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. Changes since 2.18:
|
- |
2.7 |
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. Changes since 2.18:
|
- |
2.7 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets, receiveddelivered 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. Changes since 2.18:
|
- |
2.7 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets, receiveddelivered by this layer to a higher layer, which were addressed to a multicast address at this layer and delivered by this layer to a higher layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.7 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.7 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets, receiveddelivered by this layer to a higher layer, which were addressed to a broadcast address at this layer and delivered by this layer to a higher layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.7 |
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.19 |
UnknownPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of ZigBee packets received which were discarded because of an unknown or unsupported protocol. This parameter was DEPRECATED in 2.19 because its name is a typo of UnknownProtoPacketsReceived. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.7 |
Device.Bridging. |
object |
R |
Layer 2 bridging configuration. Specifies bridges between different layer 2 interfaces. Bridges can be defined to include layer 2 filter criteria to selectively bridge traffic between interfaces. This object can be used to configure both 802.1D [802.1D-2004] and 802.1Q [802.1Q-2011] bridges. Not all 802.1D and 802.1Q features are modeled, and some additional features not present in either 802.1D or 802.1Q are modeled. 802.1Q [802.1Q-2011] bridges incorporate 802.1Q [802.1Q-2005] customer and 802.1ad [802.1ad-2005] provider bridges. |
- |
2.0 |
Device.Bridging.Bridge.{i}. |
object(0:) |
W |
Bridge table. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.0 |
Device.Bridging.Bridge.{i}.Port.{i}. |
object(0:) |
W |
Bridge Port table, which MUST contain an entry for each bridge port (a stackable interface object as described in [Section 4.2/TR-181i2]). There are two types of bridge ports: management (upward facing) and non-management (downward facing). This is determined by configuring the Boolean ManagementPort parameter. The CPE will automatically configure each management bridge port to appear in the interface stack above all non-management bridge ports that share the same Bridge instance. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.0 |
Enable |
boolean |
W |
Enables or disables the bridge port.interface. This parameter is based on ifAdminStatus from [RFC2863]. |
false |
2.0 |
Status |
string |
R |
The current operational state of the bridge portinterface (see [Section 4.2.2/TR-181i2]). Enumeration of:
When Enable is false then this parameterStatus SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then this parameterStatus 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.0 |
Name |
string(:64) |
R |
The textual name of the bridge portinterface as assigned by the CPE. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.0 |
LastChange |
unsignedInt |
R |
The accumulated time in seconds since the bridge portinterface entered its current operational state. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
Device.Bridging.Bridge.{i}.Port.{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]. Changes since 2.18:
|
- |
2.0 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
Device.PPP. |
object |
R |
Point-to-Point Protocol [RFC1661]. This object contains the Interface table. |
- |
2.0 |
Device.PPP.Interface.{i}. |
object(0:) |
W |
PPP interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.0 |
AuthenticationProtocol |
string |
R |
Describes the PPP authentication protocol. Enumeration of:
Changes since 2.18:
|
- |
2.0 |
Device.PPP.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]. Changes since 2.18:
|
- |
2.0 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
Device.IP. |
object |
R |
IP object that contains the Interface, ActivePort, and Diagnostics objects. |
- |
2.0 |
Device.IP.Interface.{i}. |
object(0:) |
W |
IP interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the layer 3 IP interface. Each IP interface can be attached to the IPv4 and/or IPv6 stack. The interface's IP addresses and prefixes are listed in the IPv4Address, IPv6Address and IPv6Prefix tables. Note that support for manipulating Loopback interfaces is OPTIONAL, so the implementation MAY choose not to create (or allow the Controller to create) Interface instances of type Loopback. When the Controller administratively disables the interface, i.e. sets Enable to false, the interface's automatically-assigned IP addresses and prefixes MAY be retained. When the Controller administratively enables the interface, i.e. sets Enable to true, these IP addresses and prefixes MUST be refreshed. It's up to the implementation to decide exactly what this means: it SHOULD take all reasonable steps to refresh everything but if it is unable, for example, to refresh a prefix that still has a significant lifetime, it might well choose to retain rather than discard it. Any Tunneled IP interface instances instantiated by the CPE MUST NOT have any statistics, writable parameters, IP addresses or IPv6 prefixes. Any read-only parameters, e.g. Status, MUST return the same information as for the corresponding Tunnel interface. The reason for these rules is that Tunneled IP interfaces exist only in order to be the targets of references (within the data model) and do not model any concepts over and above those already modeled by the Tunnel IP interfaces. Note that Tunnel and Tunneled IP interfaces are part of a legacy mechanism that is only used for IPv6rd, DSLite and IPsec tunnels and MUST NOT be used in any other context. For all other tunneling mechanisms Normal IP interfaces are stacked above technology-specific Tunnel Interfaces, e.g. above GRE.Tunnel.{i}.Interface or MAP.Domain.{i}.Interface objects. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- |
2.0 |
Device.IP.Interface.{i}.IPv4Address.{i}. |
object(0:) |
W |
IPv4 address table. Entries are auto-created and auto-deleted as IP addresses are added and deleted via DHCP, auto-IP, 3GPP-NAS,3GPP-NAS (3GPP Non Access Stratum), or IPCP. Static entries are created and configured by the Controller. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both IPAddress and SubnetMask. |
- |
2.0 |
Device.IP.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.0 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.0 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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 packetspackets will never cause this counter to increment. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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 packetspackets will never cause this counter to increment. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.0 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
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. Changes since 2.18:
|
- |
2.14 |
IPLayerCapacityAuthCodeNumberOfEntries |
unsignedInt |
R |
The number of entries in the IPLayerCapacityAuthCode table. |
- |
2.19 |
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. Changes since 2.18:
|
- |
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. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.14 |
MTU |
unsignedInt |
W |
The MTU to be used for this test. Common MTU settings are 1500, 1250 and 9000. The default value SHOULD be 1500. |
- |
2.19 |
LocalInterfaceRateIncluded |
boolean |
W |
When set to true, the client is invoked with the option which uses the bytes statistics on the interface along with the test traffic to determine the maximum IP layer capacity. When set to false, only test traffic is used to calculate IP layer capacity metrics. The default value SHOULD be true. |
- |
2.19 |
AuthenticationEnabled |
boolean |
W |
If true, client uses authentication for the test. If false, the client does not use authentication. Refer to Device.IP.Diagnostics.IPLayerCapacityMetrics for description on how the input arguments are provided to enable authentication for the test. The default value SHOULD be false. |
- |
2.19 |
AuthenticationCode |
string |
W |
The authentication code or key to use when the client connects to the server. Refer to Device.IP.Diagnostics.IPLayerCapacityMetrics for description on how the input arguments are provided to enable authentication for the test. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.19 |
AuthenticationAlias |
string |
W |
The reference to IPLayerCapacityAuthCode table by Alias. Refer to Device.IP.Diagnostics.IPLayerCapacityMetrics for description on how the input arguments are provided to enable authentication for the test. |
- |
2.19 |
AuthenticationKeyFileLocation |
string |
W |
The key file location the client uses to derive the AuthenticationCode and AuthenticationAlias to be used for authentication. Refer to Device.IP.Diagnostics.IPLayerCapacityMetrics for description on how the input arguments are provided to enable authentication for the test. |
- |
2.19 |
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. Changes since 2.18:
|
- |
2.14 |
MaximumTestBandwidth |
unsignedInt(:32767) |
W |
The rate limiting or admission control bandwidth to be configured on the client for the test. A value of 0 indicates the client does not use rate limiting or admission control. The value is expressed in Mbps. The default value SHOULD be 0. |
- |
2.19 |
StatusCode |
unsignedInt |
R |
Status code of the test returned by the client, if applicable. |
- |
2.19 |
StatusMessage |
string |
R |
Status message of the test returned by the client, if applicable. |
- |
2.19 |
RTTMinAtMax |
decimal |
R |
The value of minimum Round Trip Time (RTT) during the sub interval of MaxIPLayerCapacity. This value is expressed as a decimal to 9 decimal digits. |
- |
2.19 |
RTTMaxAtMax |
decimal |
R |
The value of maximum Round Trip Time (RTT) during the sub interval of MaxIPLayerCapacity. This value is expressed as a decimal to 9 decimal digits. |
- |
2.19 |
Device.IP.Diagnostics.IPLayerCapacityMetrics.IPLayerCapacityAuthCode.{i}. |
object(1:256) |
W |
Authentication Code table containing list of keys to be used by the client when connecting to the server. This table MUST contain at least 1 and at most 256 entries. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.19 |
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.19 |
AuthenticationKey |
string |
W |
A passphrase that is used by the client to authenticate with the server. When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.19 |
Device.GRE. |
object |
R |
This object contains parameters associated with the Generic Routing Encapsulation (GRE) Tunnel ([RFC2784]) with Key and Sequence Number extensions ([RFC2890]). This object also provides a means to treat packets that are encapsulated within a GRE Tunnel by using a set of Filter objects to determine the treatment of the packet. |
- |
2.8 |
Device.GRE.Tunnel.{i}. |
object(0:) |
W |
GRE Tunnel table, models the GRE Tunnel instance and represents the entry point and exit point of the tunnel in relation to the WAN interface. A Tunnel object has one or more Interface objects that further define the sessions or flows within the tunnel. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.8 |
Device.GRE.Tunnel.{i}.Interface.{i}. |
object(0:) |
W |
GRE Interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). The Interface object models the GRE Header as defined in [RFC2784] and extensions to the GRE Header as defined in [RFC2890]. The Interface object provides a way to discriminate how sessions or flows are encapsulated within the GRE Tunnel. In addition the Interface object represents the entry point and exit point of the tunnel in relation to the LAN interface. Unless the Key Identifier of [RFC2890] is supported there is only one instance of this Interface object per tunnel. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. Changes since 2.18:
|
- |
2.8 |
Enable |
boolean |
W |
Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. Changes since 2.18:
|
false |
2.8 |
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]. Changes since 2.18:
|
Down |
2.8 |
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.8 |
Device.GRE.Tunnel.{i}.Interface.{i}.Stats. |
object |
R |
StatisticsThroughput statistics for this GRE tunnel interface, i.e. all traffic that has passed through the interface. The deviceCPE 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.,(i.e. the interface's StatusStatus parameter transitions to a down state after the interface has beenis disabled) or when the interface becomes administratively up (i.e. the Enableinterface's Enable parameter transitionedtransitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. Changes since 2.18:
|
- |
2.8 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytes senttransmitted byout thisof interface.the interface, including framing characters. Active Notification requests for this parameter MAY be denied. |
- |
2.8 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytes received byon thisthe interface.interface, including framing characters. Active Notification requests for this parameter MAY be denied. |
- |
2.8 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets senttransmitted byout thisof the interface. Active Notification requests for this parameter MAY be denied. |
- |
2.8 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packets received byon thisthe interface. Active Notification requests for this parameter MAY be denied. |
- |
2.8 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packets discardedthat bycould thisnot interfacebe duetransmitted tobecause anyof error. errors.This can include packets dropped due to a lack of transmit buffers. Active Notification requests for this parameter MAY be denied. |
- |
2.8 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packets received by this interface that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. |
- |
2.8 |
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.19 |
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.19 |
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.19 |
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.19 |
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.19 |
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.19 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. |
- |
2.19 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. |
- |
2.19 |
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.19 |
Device.L2TPv3. |
object |
R |
This object contains parameters associated with the configuration and monitoring of stateless tunnels using the Layer Two Tunneling Protocol version 3 (L2TPv3) ([RFC3931]). This object also provides a means to treat packets that are encapsulated within a L2TPv3 Tunnel by using a set of Filter objects to determine the treatment of the packet. |
- |
2.12 |
Device.L2TPv3.Tunnel.{i}. |
object(0:) |
W |
L2TPv3 Tunnel table, models the L2TPv3 Tunnel instance and represents the entry point and exit point of the tunnel in relation to the WAN interface. A Tunnel object has one or more Interface objects that further define the sessions or flows within the tunnel. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
Device.L2TPv3.Tunnel.{i}.Interface.{i}. |
object(0:) |
W |
L2TPv3 Interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). The Interface object models the L2TPv3 Header as defined in [RFC3931] and the transport of L2 frames across over L2TPv3 as defined in [RFC4719]. The Interface object provides a way to discriminate how sessions or flows are encapsulated within the L2TPv3 Tunnel. In addition the Interface object represents the entry point and exit point of the tunnel in relation to the LAN interface. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. Changes since 2.18:
|
- |
2.12 |
Enable |
boolean |
W |
Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. Changes since 2.18:
|
false |
2.12 |
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]. Changes since 2.18:
|
Down |
2.12 |
LowerLayers |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. |
<Empty> |
2.12 |
Device.L2TPv3.Tunnel.{i}.Interface.{i}.Stats. |
object |
R |
StatisticsThroughput statistics for this L2TPv3 tunnel interface, i.e. all traffic that has passed through the interface. The deviceCPE 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.,(i.e. the interface's StatusStatus parameter transitions to a down state after the interface has beenis disabled) or when the interface becomes administratively up (i.e. the Enableinterface's Enable parameter transitionedtransitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. Changes since 2.18:
|
- |
2.12 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytes senttransmitted byout thisof interface.the interface, including framing characters. Active Notification requests for this parameter MAY be denied. |
- |
2.12 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytes received byon thisthe interface.interface, including framing characters. Active Notification requests for this parameter MAY be denied. |
- |
2.12 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets senttransmitted byout thisof the interface. Active Notification requests for this parameter MAY be denied. |
- |
2.12 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packets received byon thisthe interface. Active Notification requests for this parameter MAY be denied. |
- |
2.12 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packets discardedthat bycould thisnot interfacebe duetransmitted tobecause anyof error. errors.This can include packets dropped due to a lack of transmit buffers. Active Notification requests for this parameter MAY be denied. |
- |
2.12 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packets received by this interface that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. |
- |
2.12 |
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.19 |
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.19 |
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.19 |
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.19 |
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.19 |
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.19 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. |
- |
2.19 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. |
- |
2.19 |
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.19 |
Device.VXLAN. |
object |
R |
This object contains parameters associated with the configuration and monitoring of stateless tunnels using the Virtual eXtensible Local Area Network (VXLAN) ([RFC7348]). This object also provides a means to treat packets that are encapsulated within a VXLAN Tunnel by using a set of Filter objects to determine the treatment of the packet. |
- |
2.12 |
Device.VXLAN.Tunnel.{i}. |
object(0:) |
W |
VXLAN Tunnel table, models the VXLAN Tunnel instance and represents the entry point and exit point of the tunnel in relation to the WAN interface. A Tunnel object has one or more Interface objects that further define the sessions or flows within the tunnel. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.12 |
Device.VXLAN.Tunnel.{i}.Interface.{i}. |
object(0:) |
W |
VXLAN Interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). The Interface object models the VXLAN Header as defined in [RFC7348] for the transport of L2 frames across over VXLAN. The Interface object provides a way to discriminate how multiple LAN segments are encapsulated within the VXLAN Tunnel. In addition the Interface object represents the entry point and exit point of the tunnel in relation to the LAN interface. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. Changes since 2.18:
|
- |
2.12 |
Enable |
boolean |
W |
Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. Changes since 2.18:
|
false |
2.12 |
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]. Changes since 2.18:
|
Down |
2.12 |
LowerLayers |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. |
<Empty> |
2.12 |
Device.VXLAN.Tunnel.{i}.Interface.{i}.Stats. |
object |
R |
StatisticsThroughput statistics for this VXLAN tunnel interface, i.e. all traffic that has passed through the interface. The deviceCPE 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.,(i.e. the interface's StatusStatus parameter transitions to a down state after the interface has beenis disabled) or when the interface becomes administratively up (i.e. the Enableinterface's Enable parameter transitionedtransitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. Changes since 2.18:
|
- |
2.12 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytes senttransmitted byout thisof interface.the interface, including framing characters. Active Notification requests for this parameter MAY be denied. |
- |
2.12 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytes received byon thisthe interface.interface, including framing characters. Active Notification requests for this parameter MAY be denied. |
- |
2.12 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets senttransmitted byout thisof the interface. Active Notification requests for this parameter MAY be denied. |
- |
2.12 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packets received byon thisthe interface. Active Notification requests for this parameter MAY be denied. |
- |
2.12 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packets discardedthat bycould thisnot interfacebe duetransmitted tobecause anyof error. errors.This can include packets dropped due to a lack of transmit buffers. Active Notification requests for this parameter MAY be denied. |
- |
2.12 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packets received by this interface that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. |
- |
2.12 |
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.19 |
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.19 |
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.19 |
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.19 |
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.19 |
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.19 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. |
- |
2.19 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. |
- |
2.19 |
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.19 |
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 |
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]. Changes since 2.18:
|
Down |
2.8 |
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]. Note: Since this interface object is a MAP domain interface, it is expected that LowerLayers will not be used. |
<Empty> |
2.8 |
Device.MAP.Domain.{i}.Interface.Stats. |
object |
R |
Throughput statistics for this MAP domain 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]. Changes since 2.18:
|
- |
2.8 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.8 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.8 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.8 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.8 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.8 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.8 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.8 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.8 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.8 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.8 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.8 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.8 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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 packetspackets will never cause this counter to increment. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.8 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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 packetspackets will never cause this counter to increment. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.8 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.8 |
Device.Routing. |
object |
R |
Routing object that contains the Router table, the received router advertisement information RouteInformation, Babel, and RIP protocol objects. |
- |
2.0 |
Device.Routing.Router.{i}. |
object(0:) |
W |
This object allows the handling of the routing and forwarding configuration of the device. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.0 |
Device.Routing.Router.{i}.IPv4Forwarding.{i}. |
object(0:) |
W |
Layer 3 IPv4 forwarding table. In addition to statically configured routes, this table MUST include dynamic routes learned through layer 3 routing protocols, including RIP (i.e. RIP version 2), OSPF, DHCPv4, 3GPP-NAS (3GPP Non Access Stratum) and IPCP. The 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, ForwardingPolicy, GatewayIPAddress, Interface and ForwardingMetric. |
- |
2.0 |
Device.Routing.Babel. |
object |
R |
This object provides parameters for configuration, troubleshooting, and monitoring of the Babel routing protocol [RFC8966]. This data model is based on the Babel information model defined in [RFC9046]. |
- |
2.15 |
Device.Routing.Babel.MACKeySet.{i}. |
object(0:) |
W |
This object provides parameters related to use of the HMAC security mechanism [RFC8967] to sign and verify Babel packets. 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.15 |
Device.Routing.Babel.MACKeySet.{i}.MACKey.{i}. |
object(0:) |
W |
This object provides the MAC keys used to calculate MACs for verification and sending by the MACKeySet instance. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.15 |
KeyValue |
hexBinary |
W |
The value of the MAC key. This value is immutable, once written. This value is of a length suitable for the associated MACKeyAlgorithm. If the algorithm is based on the HMAC construction [RFC2104], the length MUST be between 0 and an upper limit that is at least the size of the output length (where "HMAC-SHA256" output length is 32 octets as described in [RFC4868]). Longer lengths MAY be supported but are not necessary if the management system has the ability to generate a suitably random value (e.g., by randomly generating a value or by using a key derivation technique as recommended in [Security Considerations/RFC8967]). If the algorithm is "BLAKE2s-128", the length MUST be between 0 and 32 bytes inclusive, as specified in [RFC7693]. Note: This parameter was changed to readWrite in the Device 2.19 version. When read, this parameter returns an empty string, regardless of the actual value. Changes since 2.18:
|
- |
2.15 |
Device.Routing.Babel.DTLSCertSet.{i}. |
object(0:) |
W |
This object provides parameters related to use of the DTLS security mechanism [RFC8968] to encrypt Babel packets. 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.15 |
Device.Routing.Babel.DTLSCertSet.{i}.DTLSCert.{i}. |
object(0:) |
W |
This object provides the certificates used for verification and signing by the DTLSCertSet instance with DTLS. 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.15 |
CertValue |
string(:256) |
W |
The DTLS certificate in PEM format [RFC7468]. This value is immutable, once written. Note: This parameter was changed to readWrite in the Device 2.19 version. Changes since 2.18:
|
- |
2.15 |
CertPrivateKey |
hexBinary |
W |
The private key of the certificate. CertPrivateKey is only given a value if the certificate belongs to this device. If CertPrivateKey is non-empty, this certificate can be supplied during DTLS handshaking. This value is immutable, once written. Note: This parameter was changed to readWrite in the Device 2.19 version. When read, this parameter returns an empty string, regardless of the actual value. Changes since 2.18:
|
- |
2.15 |
Device.QoS. |
object |
R |
Queue management configuration object. |
- |
2.0 |
Device.QoS.Classification.{i}. |
object(0:) |
W |
Classification table. For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Several of this object's parameters specify DHCP option values. Some cases are version neutral (the parameter can apply to both DHCPv4 and DHCPv6), but in other cases the representation of the option is different for DHCPv4 and DHCPv6, so it is necessary to define separate DHCPv4-specific and DHCPv6-specific parameters. Therefore, an instance of this object that uses DHCP option values as classification criteria will be associated with either DHCPv4 or DHCPv6, as indicated by the DHCPType parameter. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.0 |
IPVersion |
int(4,6,-1) |
W |
Classification criterion. Specifies the IP Protocolprotocol Versionversion, asfollowing specifiedthe definitions in [IANA-ipversionnumbers]. ForValid example:values are: 4 (IPv4), 6 (IPv6), or -1 (No specific IP version is required).{{div|{{classes}}|{{li|}}4 (IPv4)}}{{div|{{classes}}|{{li|}}6 (IPv6)}}{{div|{{classes}}|A value of -1 indicates this criterion is not used for matching.}} Changes since 2.18:
|
-1 |
2.16 |
Device.Hosts. |
object |
R |
This object provides information about each of the hosts on the LAN, including those whose IP address was allocated by the CPE using DHCP as well as hosts with statically allocated IP addresses. It can also include non-IP hosts. |
- |
2.0 |
Device.Hosts.AccessControl.{i}. |
object(0:) |
W |
Every instance of this object provides access control for a LAN device. Access is allowed if no instance of AccessControl is defined for a device. If access is not allowed, then the LAN device cannot access the broadband network. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for PhysAddress. |
- |
2.14 |
Origin |
string |
R |
Indicates the owner of the AccessControl instance. Note: This parameter was changed to writeOnceReadOnly in the Device:2.18 version. Note: This parameter was reverted back to readOnly in the Device 2.19 version. Enumeration of:
Changes since 2.18:
|
Controller |
2.17 |
Device.DNS. |
object |
R |
Properties for Domain Name Service (DNS). |
- |
2.0 |
Device.DNS.Zone.{i}. |
object(0:) |
W |
This object specifies Zone file configuration of the DNS server. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.17 |
Origin |
string |
R |
The mechanism via which the Zone was created. Note: This parameter was changed to writeOnceReadOnly in the Device:2.18 version. Note: This parameter was reverted back to readOnly in the Device 2.19 version. Enumeration of:
Changes since 2.18:
|
System |
2.17 |
Device.DNS.Zone.{i}.Host.{i}. |
object(0:) |
W |
This object specifies the resource records (RR) of the DNS zone. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.17 |
Origin |
string |
R |
Indicates the owner of the Host instance. Note: This parameter was changed to writeOnceReadOnly in the Device:2.18 version. Note: This parameter was reverted back to readOnly in the Device 2.19 version. Enumeration of:
Changes since 2.18:
|
System |
2.17 |
Device.DNS.Client. |
object |
R |
Client properties for Domain Name Service (DNS). The DNS client resolves FQDN on behalf of device internal (client) applications. |
- |
2.0 |
Device.DNS.Client.Server.{i}. |
object(0:) |
W |
This table contains the DNS Server IP address to be used by the DNS Client (it does not model a DNS Server). Entries are either automatically created as result of DHCP (v4 or v6), IPCP, 3GPP-NAS,3GPP-NAS (3GPP Non Access Stratum), or RA received DNS server information, or are statically configured by the Controller. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for DNSServer. |
- |
2.0 |
Device.DNS.Relay. |
object |
R |
DNS Relay object. The DNS proxy (or relay) function allows the forwarding of local network DNS queries to local or external DNS server(s) [RFC5625]. |
- |
2.0 |
Device.DNS.Relay.Forwarding.{i}. |
object(0:) |
W |
DNS Server forwarding policy to be used by the DNS Relay. Entries are either automatically created as result of DHCP (v4 or v6), IPCP, 3GPP-NAS (3GPP Non Access Stratum) or RA received DNS server information, or are statically configured by the Controller. Note: Management of re-directing queries to the device embedded DNS server is not defined in this version of the specification. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for DNSServer. |
- |
2.0 |
DNSServer |
string(:45) |
W |
[IPAddress] DNS server IP address. Note: DNSServer is only writable when Type is Static; otherwise, DNSServer is automatically configured as result of DHCP, IPCP, 3GPP-NAS or RA received DNS server information. |
- |
2.0 |
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. Specifies the IP interface over which the DNS query is sent. If the value is an empty string, the CPE MUST use its routing policy (IP Forwarding table entries), if necessary, to determine the appropriate interface. Note: Interface is only writable when Type is Static; otherwise, Interface is automatically configured as result of DHCP, IPCP, 3GPP-NAS or RA received DNS server information. |
<Empty> |
2.0 |
Type |
string |
R |
Method used to assign the DNSServer address. Enumeration of:
Table entries that are automatically created as result of DHCP, IPCP, 3GPP-NAS, or RA received DNS server information will have Type set to DHCPv4, DHCPv6, IPCP, 3GPP-NAS, or RouterAdvertisement, as the case may be. Manually created table entries will have their Type set to Static. Changes since 2.18:
|
Static |
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.SDDNS-SD service is disabled, the contents of the service table is implementation specific. Changes since 2.18:
|
- |
2.6 |
Status |
string |
R |
The status of the DNS service discovery. Enumeration of:
|
- |
2.19 |
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. Changes since 2.18:
|
- |
2.12 |
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 |
Origin |
string |
R |
Indicates the Origin of the PortMapping instance. Note: This parameter was changed to writeOnceReadOnly in the Device:2.18 version. Note: This parameter was reverted back to readOnly in the Device 2.19 version. Enumeration of:
Changes since 2.18:
|
Controller |
2.17 |
LeaseDuration |
unsignedInt |
W |
Determines the time to live, in seconds, of a port mapping lease, where "time to live" means the number of seconds before the port mapping expires. A value of 0 means the port mapping is static. Support for dynamic (non-static) port mappings is OPTIONAL. That is, the only value for LeaseDuration that MUST be supported is 0. For a dynamic (non-static) port mapping, when this parameter is read, the value represents the time remaining on the port mapping lease. That is, for ais the same as when the PortMapping was created. Note: the Device:2.19 version of the data model moved the dynamic port mapping, the value counts down toward 0. When a dynamic port mapping lease expires, the CPE MUST automatically terminate that port mapping, and MUST automatically delete the corresponding {{object}} table entry.countdown behavior, when reading the LeaseDuration, to the RemainingLeaseTime. Active Notification requests for this parameter MAY be denied. |
- |
2.0 |
InternalPort |
unsignedInt(0:65535) |
W |
The port on InternalClient that the gateway SHOULD forward traffic to. When ExternalPortEndRange is utilized, this range will also be applied accordingly, starting from the InternalPort number. Example: ExternalPort=3000 and ExternalPortEndRange=3010 with InternalPort=5000 means the ports are mapped as follows: * External port 3000 maps to internal port 5000 * External port 3001 maps to internal port 5001 * External port 3002 maps to internal port 5002 * ... * External port 3010 maps to internal port 5010 |
- |
2.0 |
Log |
boolean |
W |
Enable or disable logging, in a DeviceInfo.VendorLogFile, of packets matching this PortMapping. |
false |
2.19 |
LogRef |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Firewall.Log. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Specifies the logging rules for this PortMapping entry. The Log parameter MUST be set to true for this setting to take effect. When Log is true and LogRef is an empty string or contains an invalid reference, the system MUST treat the configuration as an error and set Status to Error_Misconfigured. |
<Empty> |
2.19 |
Device.NAT.PortTrigger.{i}. |
object(0:) |
W |
Firewall PortTrigger table. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.16 |
Origin |
string |
R |
Indicates the owner of the PortTrigger instance. Note: This parameter was changed to writeOnceReadOnly in the Device:2.18 version. Note: This parameter was reverted back to readOnly in the Device 2.19 version. Enumeration of:
Changes since 2.18:
|
Controller |
2.16 |
Log |
boolean |
W |
Enable or disable logging, in a DeviceInfo.VendorLogFile, of packets matching this PortTrigger. |
false |
2.19 |
LogRef |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Firewall.Log. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Specifies the logging rules for this PortTrigger entry. The Log parameter MUST be set to true for this setting to take effect. When Log is true and LogRef is an empty string or contains an invalid reference, the system MUST treat the configuration as an error and set Status to Error_Misconfigured. |
<Empty> |
2.19 |
Device.DHCPv4. |
object |
R |
The Dynamic Host Configuration Protocol (DHCP) IPv4 object [RFC2131]. This entire object applies to IPv4 only. It contains the Client, Server, and Relay objects. |
- |
2.0 |
Device.DHCPv4.Client.{i}. |
object(1:) |
W |
This object contains DHCP client settings for an associated IP Interface indicated by Interface. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The Client table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Client row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending Client row. This table MUST contain at least 1 entry. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface. Changes since 2.18:
|
- |
2.0 |
AuthenticationProtocol |
string |
W |
Specifies the authentication mechanism to be used. Enumeration of:
|
None |
2.19 |
DSCPMark |
unsignedInt(0:63) |
W |
Diffserv code point to be used for outgoing DHCP messages. |
48 |
2.19 |
Device.DHCPv4.Client.{i}.Stats. |
object |
R |
Provide statistis for the embedded DHCP Client. |
- |
2.19 |
Discover |
unsignedLong |
R |
[StatsCounter64] The total number of DHCPDISCOVER messages sent by the client, as defined in [DHCP Message Type/RFC2132]. |
- |
2.19 |
Offer |
unsignedLong |
R |
[StatsCounter64] The total number of DHCPOFFER messages received by the client, as defined in [DHCP Message Type/RFC2132]. |
- |
2.19 |
Request |
unsignedLong |
R |
[StatsCounter64] The total number of DHCPREQUEST messages sent by the client, as defined in [DHCP Message Type/RFC2132]. |
- |
2.19 |
Decline |
unsignedLong |
R |
[StatsCounter64] The total number of DHCPDECLINE messages sent by the client, as defined in [DHCP Message Type/RFC2132]. |
- |
2.19 |
Release |
unsignedLong |
R |
[StatsCounter64] The total number of DHCPRELEASE messages sent by the client, as defined in [DHCP Message Type/RFC2132]. |
- |
2.19 |
Inform |
unsignedLong |
R |
[StatsCounter64] The total number of DHCPINFORM messages sent by the client, as defined in [DHCP Message Type/RFC2132]. |
- |
2.19 |
ACK |
unsignedLong |
R |
[StatsCounter64] The total number of DHCPACK messages received by the client, as defined in [DHCP Message Type/RFC2132]. |
- |
2.19 |
NACK |
unsignedLong |
R |
[StatsCounter64] The total number of DHCPNACK messages received by the client, as defined in [DHCP Message Type/RFC2132]. |
- |
2.19 |
ForceRenew |
unsignedLong |
R |
[StatsCounter64] The total number of DHCPFORCERNEW messages received by the client, as defined in [DHCP reconfigure extension/RFC3203]. |
- |
2.19 |
DiscardedPackets |
unsignedLong |
R |
[StatsCounter64] The total number of DHCP packets discarded by the client. Packets can be discarded due to illegal message format and content, incorrect received bytes, etc. |
- |
2.19 |
TransmitFailure |
unsignedLong |
R |
[StatsCounter64] The total number of DHCP messages that failed to transmit. |
- |
2.19 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
Device.DHCPv4.Server. |
object |
R |
DHCP server configuration. Changes since 2.18:
|
- |
2.0 |
Device.DHCPv4.Server.Pool.{i}. |
object(0:) |
W |
DHCP conditional serving pool table. Each instance of this object defines a DHCP conditional serving pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCP options, and MAC address. Overlapping pool ranges MUST be supported. For enabled table entries, if Interface is not a valid reference, or MinAddress, MaxAddress, or SubnetMask is not a valid value, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Order. Changes since 2.18:
|
- |
2.0 |
WINSServers |
string(:45)[] |
W |
[IPv4Address] Comma-separated list of IPv4Addresses. Represent the WINS servers offered to DHCP clients. |
<Empty> |
2.19 |
DSCPMark |
unsignedInt(0:63) |
W |
Diffserv code point to be used for outgoing DHCP messages. |
48 |
2.19 |
Device.DHCPv4.Server.Stats. |
object |
R |
Provide statistics for the embedded DHCP Server. |
- |
2.19 |
Discover |
unsignedLong |
R |
[StatsCounter64] The total number of DHCPDISCOVER messages received by the server, as defined in [DHCP Message Type/RFC2132]. |
- |
2.19 |
Offer |
unsignedLong |
R |
[StatsCounter64] The total number of DHCPOFFER messages sent by the server, as defined in [DHCP Message Type/RFC2132]. |
- |
2.19 |
Request |
unsignedLong |
R |
[StatsCounter64] The total number of DHCPREQUEST messages received by the server, as defined in [DHCP Message Type/RFC2132]. |
- |
2.19 |
ACK |
unsignedLong |
R |
[StatsCounter64] The total number of DHCPACK messages sent by the server, as defined in [DHCP Message Type/RFC2132]. |
- |
2.19 |
NACK |
unsignedLong |
R |
[StatsCounter64] The total number of DHCPNACK messages sent by the server, as defined in [DHCP Message Type/RFC2132]. |
- |
2.19 |
Decline |
unsignedLong |
R |
[StatsCounter64] The total number of DHCPDECLINE messages received by the server, as defined in [DHCP Message Type/RFC2132]. |
- |
2.19 |
Release |
unsignedLong |
R |
[StatsCounter64] The total number of DHCPRELEASE messages received by the server, as defined in [DHCP Message Type/RFC2132]. |
- |
2.19 |
Inform |
unsignedLong |
R |
[StatsCounter64] The total number of DHCPINFORM messages received by the server, as defined in [DHCP Message Type/RFC2132]. |
- |
2.19 |
ForceRenew |
unsignedLong |
R |
[StatsCounter64] The total number of DHCPFORCERNEW messages sent by the server, as defined in [DHCP reconfigure extension/RFC3203]. |
- |
2.19 |
DiscardedPackets |
unsignedLong |
R |
[StatsCounter64] The total number of DHCP packets discarded by the server. Packets can be discarded due to illegal message format and content, incorrect received bytes, etc. |
- |
2.19 |
TransmitFailure |
unsignedLong |
R |
[StatsCounter64] The total number of DHCP messages that failed to transmit. |
- |
2.19 |
RelayOptionDropped |
unsignedLong |
R |
[StatsCounter64] The total number of DHCP messages with dropped relay options. |
- |
2.19 |
SecondServerDetected |
unsignedLong |
R |
[StatsCounter64] The total number of times a second DHCP server was detected. |
- |
2.19 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
Device.DHCPv6. |
object |
R |
The Dynamic Host Configuration Protocol (DHCP) IPv6 object [RFC8415]. This entire object applies to IPv6 only. It contains the Client and Server objects. |
- |
2.2 |
Device.DHCPv6.Client.{i}. |
object(1:) |
W |
This object contains DHCPv6 client settings for an associated IP Interface indicated by Interface. For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The Client table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Client row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending Client row. This table MUST contain at least 1 entry. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface. Changes since 2.18:
|
- |
2.2 |
AuthenticationProtocol |
string |
W |
Specifies the authentication protocol to be used, as explained in [Chapter 20.2 Summary of DHCP Authentication/RFC8415]. Enumeration of:
|
None |
2.19 |
DSCPMark |
unsignedInt(0:63) |
W |
Diffserv code point to be used for outgoing DHCP messages. |
48 |
2.19 |
Device.DHCPv6.Client.{i}.Stats. |
object |
R |
Provide statistics for the embedded DHCPv6 Client. |
- |
2.19 |
Solicit |
unsignedLong |
R |
[StatsCounter64] The total number of SOLICIT messages sent by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
Advertise |
unsignedLong |
R |
[StatsCounter64] The total number of ADVERTISE messages received by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
Request |
unsignedLong |
R |
[StatsCounter64] The total number of REQUEST messages sent by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
Confirm |
unsignedLong |
R |
[StatsCounter64] The total number of CONFIRM messages sent by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
Renew |
unsignedLong |
R |
[StatsCounter64] The total number of RENEW messages sent by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
Rebind |
unsignedLong |
R |
[StatsCounter64] The total number of REBIND messages sent by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
Reply |
unsignedLong |
R |
[StatsCounter64] The total number of REPLY messages received by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
Release |
unsignedLong |
R |
[StatsCounter64] The total number of RELEASE packets sent by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
Decline |
unsignedLong |
R |
[StatsCounter64] The total number of DECLINE messages sent by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
Reconfigure |
unsignedLong |
R |
[StatsCounter64] The total number of RECONFIGURE messages received by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
InformationRequest |
unsignedLong |
R |
[StatsCounter64] The total number of INFORMATION-REQUEST messages sent by the client, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
DiscardedPackets |
unsignedLong |
R |
[StatsCounter64] The total number of DHCP packets discarded by the client. Packets can be discarded due to illegal message format and content, incorrect received bytes, etc. |
- |
2.19 |
TransmitFailure |
unsignedLong |
R |
[StatsCounter64] The total number of DHCP messages that failed to transmit. |
- |
2.19 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
Device.DHCPv6.Server. |
object |
R |
DHCPv6 server configuration. Changes since 2.18:
|
- |
2.2 |
Device.DHCPv6.Server.Pool.{i}. |
object(0:) |
W |
DHCPv6 server pool table. Each instance of this object defines a DHCPv6 server pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCPv6 options, and source address. Overlapping pool ranges MUST be supported. For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack) then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Order. Changes since 2.18:
|
- |
2.2 |
DSCPMark |
unsignedInt(0:63) |
W |
Diffserv code point to be used for outgoing DHCP messages. |
48 |
2.19 |
Device.DHCPv6.Server.Stats. |
object |
R |
Provide statistics for the embedded DHCPv6 Server. |
- |
2.19 |
Solicit |
unsignedLong |
R |
[StatsCounter64] The total number of SOLICIT messages received by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
Advertise |
unsignedLong |
R |
[StatsCounter64] The total number of ADVERTISE messages sent by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
Request |
unsignedLong |
R |
[StatsCounter64] The total number of REQUEST messages received by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
Confirm |
unsignedLong |
R |
[StatsCounter64] The total number of CONFIRM messages received by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
Renew |
unsignedLong |
R |
[StatsCounter64] The total number of RENEW messages received by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
Rebind |
unsignedLong |
R |
[StatsCounter64] The total number of REBIND messages received by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
Reply |
unsignedLong |
R |
[StatsCounter64] The total number of REPLY messages sent by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
Release |
unsignedLong |
R |
[StatsCounter64] The total number of RELEASE packets received by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
Decline |
unsignedLong |
R |
[StatsCounter64] The total number of INFORM messages received by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
Reconfigure |
unsignedLong |
R |
[StatsCounter64] The total number of RECONFIGURE messages sent by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
InformationRequest |
unsignedLong |
R |
[StatsCounter64] The total number of INFORMATION-REQUEST messages received by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
RelayForward |
unsignedLong |
R |
[StatsCounter64] The total number of RELAY-FORW messages received by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
RelayReply |
unsignedLong |
R |
[StatsCounter64] The total number of RELAY-REPL messages sent by the server, as defined in [Dynamic Host Configuration Protocol for IPv6/RFC8415]. |
- |
2.19 |
DiscardedPackets |
unsignedLong |
R |
[StatsCounter64] The total number of DHCP packets discarded by the server. Packets can be discarded due to illegal message format and content, incorrect received bytes, etc. |
- |
2.19 |
TransmitFailure |
unsignedLong |
R |
[StatsCounter64] The total number of DHCP messages that failed to transmit. |
- |
2.19 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
Device.IEEE8021x. |
object |
R |
IEEE 802.1x object [802.1x-2004], where Supplicant models authentication supplicants. |
- |
2.0 |
Device.IEEE8021x.Supplicant.{i}. |
object(1:) |
W |
802.1x supplicant authentication provisioning and status information associated with an interface to be authenticated (e.g. an Ethernet.Link instance). For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The Supplicant table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Supplicant row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending Supplicant row. This table MUST contain at least 1 entry. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface. |
- |
2.0 |
Device.IEEE8021x.Supplicant.{i}.EAPTLS. |
object |
R |
802.1x Authentication Supplicant provisioning information used for TLS certificate authentication. This object will not exist if the EAP-TLS is not a supported authentication type. Changes since 2.18:
|
- |
2.0 |
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.19 |
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.19 |
Device.Users. |
object |
R |
Users object that contains the User, Group, and Role tables. |
- |
2.0 |
Device.Users.User.{i}. |
object(0:) |
W |
This object contains parameters relating to the user characteristics. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Username, or with a given value for UserID. |
- |
2.0 |
RemoteAccessCapable |
boolean |
W |
Allows this user to remotely access the UserInterface via the mechanism defined in UserInterface.HTTPAccess This parameter was DEPRECATED in 2.16 due to the introduction of UserInterface.HTTPAccess.{i}. and RoleParticipation. This parameter was OBSOLETED in 2.18. This parameter was DELETED in 2.19. Changes since 2.18:
|
false |
2.0 |
Device.Firewall. |
object |
R |
Firewall configuration object. The Config parameter enables and disables the Firewall, and can select either a predefined configuration (High or Low) or an explicitly-defined Advanced configuration. For an Advanced configuration, AdvancedLevel controls the currently active Firewall Level, and the Firewall Levels are defined in the Level, Chain and Chain.{i}.Rule tables. For an Policy configuration, PolicyLevel controls the currently active Firewall Level, and the Firewall Levels are defined in the Policy, Level, Chain and Chain.{i}.Rule tables. The Firewall rules modeled by Chain, DMZ and Pinhole operate only on the forwarding path. This means that they affect only routed traffic, and do not affect traffic that is destined for or generated by the device itself. Traffic destined for or generated by the device itself can use the Service object to model the appropriate Firewall rules. Note that any NAT processing on the ingress packet occurs before Firewall rules are applied so, for example, the Firewall rules will see the translated destination IP address and port in a downstream packet that has passed through the NAT. See [Appendix VIII/TR-181i2] for an example Advanced configuration. Changes since 2.18:
|
- |
2.0 |
LogNumberOfEntries |
unsignedInt |
R |
The number of entries in the Log table. |
- |
2.19 |
Device.Firewall.Policy.{i}. |
object(0:) |
W |
Firewall Policy table. When a Policy configuration is selected, PolicyLevel selects the currently active entry in this table. Each Policy table entry references the Chain that contains the rules for this policy. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.16 |
IPVersion |
int(4,6,-1) |
W |
Specifies the IP Protocolprotocol Versionversion, asfollowing specifiedthe definitions in [IANA-ipversionnumbers]. ForValid example:values are: 4 (IPv4), 6 (IPv6), or -1 (No specific IP version is required).{{div|{{classes}}|{{li|}}4 (IPv4)}}{{div|{{classes}}|{{li|}}6 (IPv6)}}{{div|{{classes}}|A value of -1 indicates this criterion is not used for matching.}} Changes since 2.18:
|
-1 |
2.16 |
Log |
boolean |
W |
Enable or disable logging, in a DeviceInfo.VendorLogFile, of packets matching this Policy. |
false |
2.19 |
LogRef |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Firewall.Log. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Specifies the logging rules for this Policy entry. The Log parameter MUST be set to true for this setting to take effect. When Log is true and LogRef is an empty string or contains an invalid reference, the system MUST treat the configuration as an error and set Status to Error_Misconfigured. |
<Empty> |
2.19 |
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.18:
|
- |
2.2 |
Log |
boolean |
W |
Enable or disable logging, in a DeviceInfo.VendorLogFile, of packets matching this Rule. If the Rule is not Static (as explained in the object description), whether changes to this parameter persist across re-boot is a local matter to the CPE. |
false |
2.2 |
LogRef |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Firewall.Log. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Specifies the logging rules for this Rule entry. The Log parameter MUST be set to true for this setting to take effect. When Log is true and LogRef is an empty string or contains an invalid reference, the system MUST treat the configuration as an error and set Status to Error_Misconfigured. |
<Empty> |
2.19 |
IPVersion |
int(4,6,-1) |
W |
{{object}}Specifies criterion.}}{{div|{{classes}}|the IP Protocolprotocol Versionversion, asfollowing specifiedthe definitions in [IANA-ipversionnumbers]. ForValid example:}}{{div|{{classes}}|{{li|*}}4values (IPv4)}}{{div|{{classes}}|{{li|*}}6are: (IPv6)}}{{div|{{classes}}|A value of -1 indicates this criterion is not used for matching.4 (IPv4), 6 (IPv6), or -1 (No specific IP version is required). This parameter can only be modified if the Rule is Static (as explained in the object description). Changes since 2.18:
|
-1 |
2.2 |
Device.Firewall.Pinhole.{i}. |
object(0:) |
W |
Firewall Pinhole object that is used for configuring pinholes. Pinholes are similar to port mapping entries but without the NAT support. The Pinhole table is used for allowing certain incoming traffic, on the Interface, to be routed to the internal network. For enabled table entries, if DestMACAddress and DestIP are an empty string, or if Interface is not a valid reference, then the table entry is inoperable and the device MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.16 |
Origin |
string |
R |
Indicates the Origin of the Pinhole instance. Note: This parameter was changed to writeOnceReadOnly in the Device:2.18 version. Note: This parameter was reverted back to readOnly in the Device 2.19 version. Enumeration of:
Changes since 2.18:
|
Controller |
2.16 |
IPVersion |
int(4,6,-1) |
W |
Specifies the IP Protocolprotocol Versionversion, asfollowing specifiedthe definitions in [IANA-ipversionnumbers]. ForValid example:values are: 4 (IPv4), 6 (IPv6), or -1 (No specific IP version is required).{{div|{{classes}}|{{li|}}4 (IPv4)}}{{div|{{classes}}|{{li|}}6 (IPv6)}}{{div|{{classes}}|A value of -1 indicates this criterion is not used for matching.}} Changes since 2.18:
|
-1 |
2.16 |
Log |
boolean |
W |
Enable or disable logging, in a DeviceInfo.VendorLogFile, of packets matching this Pinhole. |
false |
2.19 |
LogRef |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Firewall.Log. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Specifies the logging rules for this Pinhole entry. The Log parameter MUST be set to true for this setting to take effect. When Log is true and LogRef is an empty string or contains an invalid reference, the system MUST treat the configuration as an error and set Status to Error_Misconfigured. |
<Empty> |
2.19 |
Device.Firewall.DMZ.{i}. |
object(0:) |
W |
Firewall DMZ object that is be used for configuring a demilitarized zone. A DMZ network is a separate network perimeter that protects the internal network from untrusted traffic. Typically the DMZ is located between two firewalls, the firewall of the internal network and the firewall responsible for handling untrusted traffic. The device MUST forward all received packets that matches the SourcePrefix criteria to the IP address that is specified in DestIP. For enabled table entries, if DestIP is an empty string, or if Interface is not a valid reference, then the table entry is inoperable and the device MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both DestIP and SourcePrefix. |
- |
2.16 |
Origin |
string |
R |
Indicates who configured the DMZ instance. Note: This parameter was changed to writeOnceReadOnly in the Device:2.18 version. Note: This parameter was reverted back to readOnly in the Device 2.19 version. Enumeration of:
Changes since 2.18:
|
Controller |
2.16 |
Log |
boolean |
W |
Enable or disable logging, in a DeviceInfo.VendorLogFile, of packets matching this DMZ. |
false |
2.19 |
LogRef |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Firewall.Log. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Specifies the logging rules for this DMZ entry. The Log parameter MUST be set to true for this setting to take effect. When Log is true and LogRef is an empty string or contains an invalid reference, the system MUST treat the configuration as an error and set Status to Error_Misconfigured. |
<Empty> |
2.19 |
Device.Firewall.Service.{i}. |
object(0:) |
W |
Firewall Service object that is used for configuring the firewall for opening a port/protocol for a local network service. For example:
For enabled table entries, if Interface, DestPort and Protocol are an empty string, or if Interface is not a valid reference, then the table entry is inoperable and the device MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of Interface, DestPort, Protocol and SourcePrefixes. |
- |
2.16 |
IPVersion |
int(4,6,-1) |
W |
Specifies the IP Protocolprotocol Versionversion, asfollowing specifiedthe definitions in [IANA-ipversionnumbers]. ForValid example:values are: 4 (IPv4), 6 (IPv6), or -1 (No specific IP version is required).{{div|{{classes}}|{{li|}}4 (IPv4)}}{{div|{{classes}}|{{li|}}6 (IPv6)}}{{div|{{classes}}|A value of -1 indicates this criterion is not used for matching.}} Changes since 2.18:
|
-1 |
2.16 |
Log |
boolean |
W |
Enable or disable logging, in a DeviceInfo.VendorLogFile, of packets matching this Service. |
false |
2.19 |
LogRef |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Firewall.Log. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Specifies the logging rules for this Service entry. The Log parameter MUST be set to true for this setting to take effect. When Log is true and LogRef is an empty string or contains an invalid reference, the system MUST treat the configuration as an error and set Status to Error_Misconfigured. |
<Empty> |
2.19 |
Device.Firewall.Set.{i}. |
object(0:) |
W |
This object is used for configuring sets of IP, MAC addresses and/or port numbers which can then be used in conjunction with the firewall. It provides a more efficient way to manage large collections of addresses and ports compared to traditional methods of listing them individually within firewall rules. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name. |
- |
2.18 |
Origin |
string |
R |
Indicates the Origin of the Set instance. Note: This parameter was changed to readOnly in the Device 2.19 version. Enumeration of:
Changes since 2.18:
|
Controller |
2.18 |
IPVersion |
int(4,6,-1) |
W |
Specifies the IP Protocolprotocol Versionversion, asfollowing specifiedthe definitions in [IANA-ipversionnumbers]. ForValid example:values {{li|*}}4are: (IPv4) {{li|*}}6 (IPv6)4 (IPv4), 6 (IPv6), or -1 (No specific IP version is required). Changes since 2.18:
|
-1 |
2.18 |
Device.Firewall.Set.{i}.Rule.{i}. |
object(0:) |
W |
Firewall Rule object that is used for configuring the set lists. 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.18 |
IPAddressList |
string(:45)[] |
W |
[IPAddress] Comma-separated list of IP Addresses. SourceEach element of the list can specify the source IPv4 or IPv6 address or subnet mask. Note: The IP version of the IP address MUST correspond to the IP version set in IPVersion. Can not be used in combination with MACAddressList or PortList. |
<Empty> |
2.18 |
MACAddressList |
string(:17)[] |
W |
[MACAddress] Comma-separated list of MAC Addresses. SpecifiesEach element of the MACAddresslist can specify the MAC addresses that can be used by the Rule entry. Note: Can not be used in combination with IPAddressList or PortList. Changes since 2.18:
|
<Empty> |
2.18 |
PortList |
string[] |
W |
Comma-separated list of strings. SpecifiesEach element of the Portlist can specify the port number or a port range that can be used by the Rule entry. Syntax: A single port can be configured as e.g. '80'. A port range can be configured as '8000-80010'.'8000-8010'. Note: Can not be used in combination with MACAddressList or IPAddressList. |
<Empty> |
2.18 |
Device.Firewall.Log.{i}. |
object(0:) |
W |
Firewalls monitor network traffic and enforce security policies. To aid in debugging and troubleshooting potential issues, it's possible to capture specific information when certain rules are triggered. These captured details, known as traces, are then logged by the implementation for further analysis. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.19 |
Enable |
boolean |
W |
Enables or disables the firewall logging configuration for this entry. |
- |
2.19 |
Description |
string(:256) |
W |
Human-readable description associated with this entry. |
- |
2.19 |
Severity |
string |
W |
Specifies the severity level at which the message is logged. Enumeration of:
|
Debug |
2.19 |
Prefix |
string |
W |
Specifies the prefix that must be added to each logmessage. When Firewall.Chain.{i}.Rule.{i}.LogRef specifies multiple Log entries. The implementation may chose to combine both prefixes into one. When Prefix is an empty string no prefix will be added to the log message. The maximum allowed Prefix length is implementation specific. |
<Empty> |
2.19 |
Device.Firewall.Log.{i}.Filter. |
object |
R |
Defines the filter criteria used for configuring firewall log rules. These criteria determine which firewall events are logged based on specified parameters such as policy, source interface, and destination interface. |
- |
2.19 |
Policy |
string |
W |
Specifies the policy for filtering logs based on the type of firewall rule. This parameter allows you to select which types of rules (e.g., all rules, denied rules, or allowed rules) will have their events logged. Enumeration of:
|
All |
2.19 |
SourceInterface |
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. Filters logs based on the rule's source interface. This parameter specifies the network interface from which the traffic originates. If left empty, no filtering on the source interface will be applied. |
<Empty> |
2.19 |
DestinationInterface |
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. Filters logs based on the rule's destination interface. This parameter specifies the network interface to which the traffic is directed. If left empty, no filtering on the destination interface will be applied. |
<Empty> |
2.19 |
Device.Security. |
object |
R |
This object contains general information related to managing security features on the device. Changes since 2.18:
|
- |
2.4 |
CABundleNumberOfEntries |
unsignedInt |
R |
The number of entries in the CABundle table. |
- |
2.19 |
Device.Security.CABundle.{i}. |
object(0:) |
R |
This table stores information about a group of Certificate Authorities (CAs). A CA is a trusted entity that issues digital certificates used to verify the identity of servers, clients, or other entities in secure communication protocols like TLS. This group defines a collection of trusted CA certificates that can be used to validate server certificates during TLS connections. At most one entry in this table can exist with a given value for Name. |
- |
2.19 |
Enable |
boolean |
W |
Enables or disables this CA group. When disabled, the certificates within this group will not be used for validation. |
- |
2.19 |
Name |
string |
R |
The textual name assigned to this CA group for identification. |
- |
2.19 |
CACertificates |
string[] |
W |
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Security.Certificate. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Specifies the CA certificate(s) that the client must use to validate the certificate presented by the remote server. These CA certificates form a trust chain that the server certificate must match, ensuring that only servers with trusted certificates can establish a connection. This parameter supports multiple CA certificates to accommodate different server certificate issuers. This parameter is applicable only when a TLS session is being used. |
- |
2.19 |
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.ExecutionUnit.{i}. |
object(0:) |
R |
This table serves as the Execution Unit inventory and contains both status information about each Execution Unit as well as configurable parameters for each Execution Unit. Each DeploymentUnit that is installed can have zero or more Execution Units. Once a Deployment Unit is installed it populates this table with its contained Execution Units. When the Deployment Unit (that caused this ExecutionUnit to come into existence) is updated, this instance MAY be removed and new instances MAY come into existence. While the Deployment Unit (that caused this ExecutionUnit to come into existence) is being updated, all ExecutionUnit instances associated with the Deployment Unit will be stopped until the update is complete at which time they will be restored to the state that they were in before the update started. When the Deployment Unit (that caused this ExecutionUnit to come into existence) is uninstalled, this instance is removed. Each ExecutionUnit MAY also contain a set of vendor specific parameters displaying status and maintaining configuration that reside under the Extensions object. At most one entry in this table can exist with a given value for EUID, or with a given value for Alias. Changes since 2.18:
|
- |
2.1 |
Privileged |
boolean |
R |
The Privileged mode for this ExecutionUnit: true for Privileged, false for Unprivileged. |
- |
2.19 |
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.18:
|
- |
2.10 |
ALPN |
string(0:256)[] |
W |
Comma-separated list of strings (length 0 to 256). The supported protocol(s) to be advertised in a TLS handshake
using the If the parameter is empty, that is an indication that ALPN is not being used. A change of this parameter is only communicated to the MQTT server with the next MQTT CONNECT packet. If the change needs to be applied immediately, the parameter ForceReconnect has to be set as well. |
<Empty> |
2.19 |
Device.LEDs. |
object |
R |
This object describes the LEDs on the device. |
- |
2.11 |
Device.LEDs.LED.{i}. |
object(0:) |
R |
Each instance of this object describes an LED on the device. The default illumination characteristics (e.g., Color, Brightness) of an in use LED is vendor specific. When a cycle completes (i.e., CyclePeriodRepetitions = 0), the LED reverts back to its default illumination characteristics. When the value of the Status parameter is Controlled, then the value of 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. Changes since 2.18:
|
- |
2.11 |
Enable |
boolean |
W |
Switches on or off the power of the LED. |
- |
2.19 |
MaxBrightness |
unsignedInt |
R |
The maximum allowed brightness level for the LED. This value is determined by the hardware capabilities. |
- |
2.19 |
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. Changes since 2.18:
|
- |
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. |
- |
2.19 |
Device.PDU. |
object |
R |
The logical connection between the 5G-RG and data network is the Protocol Data Unit (PDU). The Device.PDU subtree describes each PDU sessions properties together with the QoS rules specific to that PDU session. This object was DEPRECATED in 2.19 because it is no longer a top level object. Changes since 2.18:
|
- |
2.14 |
Device.FWE. |
object |
R |
5G Wireline wireless Encapsulation transport for data plane. See [RFC8822]. |
- |
2.14 |
Device.FWE.Link.{i}. |
object(0:) |
R |
5G Wireline wireless Encapsulation link layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). At most one entry in this table can exist with a given value for Alias, or with a given value for Name. Changes since 2.18:
|
- |
2.14 |
Enable |
boolean |
W |
Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. |
- |
2.19 |
Status |
string |
R |
The current operational state of the linkinterface (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.14 |
Name |
string(:64) |
R |
The textual name of the linkinterface as assigned by the CPE. |
- |
2.14 |
LastChange |
unsignedInt |
R |
The accumulated time in seconds since the linkinterface entered its current operational state. Active Notification requests for this parameter MAY be denied. |
- |
2.14 |
Device.FWE.Link.{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).disabled) Operationalor 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]. Changes since 2.18:
|
- |
2.14 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
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. Changes since 2.18:
|
- |
2.14 |
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. Changes since 2.18:
|
- |
2.14 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.14 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.14 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.14 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.14 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.14 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.14 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.14 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.14 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.14 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.14 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.14 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.14 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.14 |
Device.Logical. |
object |
R |
Logical object. This object models several Logical interface objects, each representing a different stack layer, including: Interface. Interface is a logical interface which can point to other stackable interface layers. The intention of the logical interface is to simplify the configuration management of individual [TR-181i2] services. Instead of configuring the individual network services with a physical interface and deal with reconfiguration problems that may arise from switching between WAN interfaces. The intention is that the network services are configured with a logical interface and that this configuration stays unchanged during the switching between WAN interfaces. The software service (For example a WAN mode manger.) responsible for handling the WAN interface changes must then only care about rewriting the LowerLayers parameter of the Logical Interface Objects. |
- |
2.16 |
Device.Logical.Interface.{i}. |
object(0:) |
W |
Logical interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models only logical interfaces. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. Changes since 2.18:
|
- |
2.16 |
Enable |
boolean |
W |
Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. Changes since 2.18:
|
false |
2.16 |
Status |
string |
R |
The current operational state of the logical 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.16 |
LastChange |
unsignedInt |
R |
The accumulated time in seconds since the logical interface entered its current operational state. Active Notification requests for this parameter MAY be denied. |
- |
2.16 |
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.16 |
Device.Logical.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]. This information SHOULD be mirrored or aggregated from the active underlying interfaces. Changes since 2.18:
|
- |
2.16 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.16 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.16 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.16 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.16 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.16 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets that contained errors preventing them from being delivered to a higher-layer protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.16 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.16 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound packetspackets 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. Changes since 2.18:
|
- |
2.16 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound packetspackets 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. Changes since 2.18:
|
- |
2.16 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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. Changes since 2.18:
|
- |
2.16 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.16 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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. Changes since 2.18:
|
- |
2.16 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of packetspackets 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 packetspackets will never cause this counter to increment. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.16 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received packets,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 packetspackets will never cause this counter to increment. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.16 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of packetspackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.16 |
Device.XPON. |
object |
R |
This object models one or more xPON interfaces or ONUs as specified by the ITU based PON standards. It does not address IEEE based PON standards (like EPON). An ONU performs tasks such as traffic classification, VLAN manipulation, GEM port mapping, aggregation and/or forwarding between one or more UNIs and one or more ANIs. |
- |
2.16 |
Device.XPON.ONU.{i}. |
object(0:) |
R |
This object models one xPON interface or ONU as specified by the ITU based PON standards. At most one entry in this table can exist with a given value for Name. |
- |
2.16 |
Device.XPON.ONU.{i}.EthernetUNI.{i}. |
object(0:) |
R |
Ethernet UNI table (a stackable interface object as described in [Section 4.2/TR-181i2]). This object models User Network Interfaces carrying Ethernet frames. An EthernetUNI can be a virtual or a physical UNI. If the ONU is managed via OMCI, an EthernetUNI has an associated service, which is either a VEIP (see [Section 9.5.5/G.988]) or a PPTP Ethernet UNI (see [Section 9.5.1/G.988]). If the associated service is a VEIP, the ONU shows a VEIP ME in the OMCI MIB. If it's a PPTP Ethernet UNI, the ONU shows a PPTP Ethernet UNI ME in the OMCI MIB. It is expected the associated service is a VEIP for a virtual UNI, and that it is a PPTP Ethernet UNI for a physical UNI. However, some network operators require that the ONU shows a PPTP Ethernet UNI ME instead of a VEIP ME in its OMCI MIB even if the EthernetUNI models a virtual UNI. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. Changes since 2.18:
|
- |
2.16 |
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 becomesis 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.}}{{div|{{classes}}|If the ONU is managed via OMCI, then {{param}} can only be {{enum|Up}} if the ONU has been provisioned at OMCI level in such a way that this interface is able to pass traffic. This parameter is based on ifOperStatus from [RFC2863]. Because the interface includes layer 1, the LowerLayerDown value SHOULD never be used. If the ONU is managed via OMCI, then Status can only be Up if the ONU has been provisioned at OMCI level in such a way that this interface is able to pass traffic. |
- |
2.16 |
Name |
string(:64) |
R |
The textual name of the interface entry as assigned by the CPE. |
- |
2.16 |
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]. Note: Since EthernetUNI is a layer 1 interface, it is expected that LowerLayers will not be used: ifused. If EthernetUNI models a physical UNI, it represents a layer 1 interface; if EthernetUNI models a virtual UNI, it virtualizes a layer 1 interface. Changes since 2.18:
|
- |
2.16 |
Upstream |
boolean |
R |
Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
|
- |
2.19 |
Device.XPON.ONU.{i}.EthernetUNI.{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]. Transmit direction has PON as destination. Receive direction has PON as source. Changes since 2.18:
|
- |
2.16 |
Reset |
boolean |
W |
Set this to true to reset all this object's statistics counters to zero. |
- |
2.19 |
BytesSent |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes transmitted out of the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.16 |
BytesReceived |
unsignedLong |
R |
[StatsCounter64] The total number of bytesbytes received on the interface, including framing characters. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.16 |
PacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of Ethernet framespackets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.16 |
PacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of Ethernet framespackets received on the interface. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.16 |
ErrorsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound Ethernet framespackets that could not be transmitted because of errors. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.16 |
ErrorsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound Ethernet framespackets that contained errors preventing them from being delivered to thea TR-181higher-layer domain.protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.16 |
UnicastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of Ethernet framespackets 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. Changes since 2.18:
|
- |
2.16 |
DiscardPacketsSent |
unsignedInt |
R |
[StatsCounter32] The total number of outbound Ethernet framespackets 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. Changes since 2.18:
|
- |
2.16 |
DiscardPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of inbound Ethernet framespackets 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. Changes since 2.18:
|
- |
2.16 |
MulticastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of Ethernetpackets framesthat 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. Changes since 2.18:
|
- |
2.16 |
UnicastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of Ethernetreceived frames,packets, delivered by this interfacelayer to thea TR-181higher domain,layer, which were not addressed to a multicast or broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.16 |
MulticastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received Ethernet frames,packets, delivered by this interfacelayer to thea TR-181higher domain,layer, which were addressed to a multicast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.16 |
BroadcastPacketsSent |
unsignedLong |
R |
[StatsCounter64] The total number of Ethernet framespackets that thehigher-level TR-181 domainprotocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.16 |
BroadcastPacketsReceived |
unsignedLong |
R |
[StatsCounter64] The total number of received Ethernet frames,packets, delivered by this interfacelayer to thea TR-181higher domain,layer, which were addressed to a broadcast address at this layer. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.16 |
UnknownProtoPacketsReceived |
unsignedInt |
R |
[StatsCounter32] The total number of Ethernet framespackets received via the interface which were discarded because of an unknown or unsupported protocol. Active Notification requests for this parameter MAY be denied. Changes since 2.18:
|
- |
2.16 |
Device.XPON.ONU.{i}.ANI.{i}. |
object(0:) |
R |
Access Node Interface (ANI) table. An ANI models the xPON MAC/PHY as defined in the ITU-T PON standards. This object is not an interface object as described in [Section 4.2/TR-181i2], but it has many of the same core parameters as an interface object, and they follow largely the same conventions. The most important deviations are:
Because it's not an interface object, it does not occur in the InterfaceStack table. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. Changes since 2.18:
|
- |
2.16 |
SFPReferenceList |
string(:256)[] |
R |
Comma-separated list of strings (maximum number of characters per item 256). Each list item MUST be the Path Name of a row in the SFPs.SFPCage. table, or an empty string. Small-form Factor Pluggable (SFP) entries associated with this interface. |
- |
2.19 |
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.18:
|
- |
2.16 |
IPv4AllowedSourcePrefix |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. {{list}} Allow only access from the provided list of IPv4 prefixes. When IPv4AllowedSourcePrefix is set to an empty string and AllowAllIPv4 is set to false, no incoming connections are allowed. When AllowAllIPv4 is set true, IPv4AllowedSourcePrefix is ignored. |
- |
2.16 |
IPv6AllowedSourcePrefix |
string[](:1024) |
W |
Comma-separated list (maximum number of characters 1024) of strings. {{list}} Allow only access from the provided list of IPv6 prefixes. When IPv6AllowedSourcePrefix is set to an empty string and AllowAllIPv6 is set to false, no incoming connections are allowed. When AllowAllIPv6 is set true, IPv6AllowedSourcePrefix is ignored. |
- |
2.16 |
UserGroupAccess |
string |
W |
The value MUST be the Path Name of a row in the Users.Group. table. Restricts access to the SSH server instance to the given user group. When an empty string, everyone has access. |
<Empty> |
2.19 |
MaxAccessLogEntries |
int(-1:) |
W |
The maximum number of entries available in the AccessLog table. Defines the maximum number of AccessLog instances that can be stored on the device. When the maximum AccessLog entries as indicated by MaxAccessLogEntries are reached, the next boot entry overrides the object with the oldest AccessLog.{i}.TimeStamp. Set this parameter to 0 to completely disable the creation of AccessLog instances. Set this parameter to -1 to leave it open to the implementation to decide the maximum number of AccessLog instances that may be stored on the device. Reducing the MaxAccessLogEntries will cause for the implementation to delete the oldest AccessLog instances. This setting does not affect the counting of access logs. |
- |
2.19 |
AccessLogNumberOfEntries |
unsignedInt |
R |
- |
2.19 |
|
Device.SSH.Server.{i}.AccessLog.{i}. |
object(0:) |
R |
This table logs each SSH login attempt made on the device. When the number of entries reaches the maximum specified by MaxAccessLogEntries, the oldest entry (determined by TimeStamp) will be deleted and a new entry will be created for the newest login attempt. At most one entry in this table can exist with a given value for Alias. |
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.19 |
TimeStamp |
dateTime |
R |
The date and time when the SSH login attempt occurred. |
- |
2.19 |
User |
string |
R |
The username provided during the SSH access attempt. |
- |
2.19 |
IPAddress |
string(:45) |
R |
[IPAddress] The IP address of the client that attempted to access the SSH server. |
- |
2.19 |
Port |
unsignedInt |
R |
The port number of the client that attempted to access the SSH server. |
- |
2.19 |
Status |
string |
R |
Represents the outcome or status of the SSH access attempt or session. The parameter indicates whether the attempt was successful or encountered an error. Enumeration of:
|
- |
2.19 |
Device.SSH.Server.{i}.Stats. |
object |
R |
This table provides statistical data on SSH login attempts for the server instance. |
- |
2.19 |
NumberOfFailedAttempts |
unsignedInt |
R |
The total number of failed SSH login attempts since the device's last upgrade or initial boot. |
- |
2.19 |
NumberOfFailedAttemptsSinceActivation |
unsignedInt |
R |
The number of failed SSH login attempts since the SSH server instance was last activated. |
- |
2.19 |
NumberOfSuccessfulAttempts |
unsignedInt |
R |
The total number of successful SSH login attempts since the device's last upgrade or initial boot. |
- |
2.19 |
NumberOfSuccessfulAttemptsSinceActivation |
unsignedInt |
R |
The number of successful SSH login attempts since the SSH server instance was last activated. |
- |
2.19 |
Device.USPServices. |
object |
R |
This object contains information related to installed USP Services. Changes since 2.18:
|
- |
2.16 |
TrustNumberOfEntries |
unsignedInt |
R |
The number of entries in the Trust table. |
- |
2.19 |
Device.USPServices.Trust.{i}. |
object(0:) |
W |
This object contains permissions associated with the set of data model paths that a USP Agent within a USP Service is allowed to Register. If a USP Service's USP Agent is not present in this table then there are no permissions associated for that USP Service and it is not allowed to register any data model paths. At most one entry in this table can exist with a given value for EndpointID. On creation of a new table entry, the Agent MUST choose an initial value for EndpointID such that the new entry does not conflict with any existing entries. |
- |
2.19 |
EndpointID |
string |
W |
The unique USP identifier for the USP Agent associated with these permissions. The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.19 |
TargetPaths |
string[:1024] |
W |
Comma-separated list (up to 1024 items) of strings. Each entry in the list is an Object Path, Command Path, Event Path, or Parameter Path that determines the element(s) of the data model that the USP Service has permission to register. An empty string indicates that the USP Agent has no permissions. |
- |
2.19 |
Device.Syslog. |
object |
R |
This object contains global parameters relating to the syslog implementations that is active in the Device. Based on [A YANG Data Model for Syslog Configuration/YANGSYSLOG]. |
- |
2.17 |
Device.Syslog.Filter.{i}. |
object(0:) |
W |
This table defines the processing used to select log messages by comparing syslog message with the provided rules. A rule can consist either of FacilityLevel - Severity and or PatternMatch. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.17 |
Severity |
string |
W |
Specifies the Severity level filter rules. Defines the processing used to select log messages by comparing syslog message severity using the following processing rules:
This must be used inconjuction with SeverityCompare and SeverityCompareAction. Enumeration of:
Changes since 2.18:
|
All |
2.17 |
Device.Syslog.Source.{i}. |
object(0:) |
W |
This table describes where and how the syslog service receives log messages. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.17 |
Severity |
string |
W |
Specifies the default Severity. When an incoming message lacks a valid syslog header, this parameter can be used to configure the required Severity level. Enumeration of:
Changes since 2.18:
|
All |
2.17 |
Device.Syslog.Source.{i}.Network. |
object |
R |
This object describes the configuration parameters for receiving syslog information on a network socket. Changes since 2.18:
|
- |
2.17 |
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.19 |
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.19 |
PeerVerify |
boolean |
W |
Ensures authentic and secure connections by validating entity credentials such as certificates or tokens. Only applicable when Protocol is set to TLS. In order to validate a certificate, the entire certificate chain, including the CA certificate, must be valid. If any certificate in the chain is found to be invalid, the syslog service must reject the connection. |
false |
2.19 |
Device.Syslog.Action.{i}. |
object(0:) |
W |
This object describes the log action parameters for syslog. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.17 |
Device.Syslog.Action.{i}.LogRemote. |
object |
R |
This object describes the configuration parameters for forwarding syslog messages to remote relays or collectors. |
- |
2.17 |
Status |
string |
R |
Status of the remote log destination. Enumeration of:
|
- |
2.19 |
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. CertificateSpecifies the client certificate that must be presented to the remote server for mutual authentication. This certificate is used to authenticate the client by the syslogremote service.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.17 |
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.19 |
PeerVerify |
boolean |
W |
Ensures authentic and secure connections by validating entity credentials such as certificates or tokens. Only applicable when Protocol is set to TLS. In order to validate a certificate, the entire certificate chain, including the CA certificate, must be valid. If any certificate in the chain is found to be invalid, the syslog service must reject the connection. |
false |
2.17 |
Device.RadSecProxy. |
object |
R |
This object contains configurations pertaining to the RadSecProxy service which implements the RadSec protocol for transporting RADIUS datagrams over TCP and TLS as detailed in [Appendix B/RFC6614]. |
- |
2.19 |
Enable |
boolean |
W |
Enables or disables the RadSecProxy service. |
- |
2.19 |
Status |
string |
R |
Status of the RadSecProxy service. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- |
2.19 |
ListenConfigNumberOfEntries |
unsignedInt |
R |
The number of entries in the ListenConfig table. |
- |
2.19 |
SourceConfigNumberOfEntries |
unsignedInt |
R |
The number of entries in the SourceConfig table. |
- |
2.19 |
ClientNumberOfEntries |
unsignedInt |
R |
The number of entries in the Client table. |
- |
2.19 |
RealmNumberOfEntries |
unsignedInt |
R |
The number of entries in the Realm table. |
- |
2.19 |
ServerNumberOfEntries |
unsignedInt |
R |
The number of entries in the Server table. |
- |
2.19 |
TLSNumberOfEntries |
unsignedInt |
R |
The number of entries in the TLS table. |
- |
2.19 |
Device.RadSecProxy.ListenConfig.{i}. |
object(1:) |
R |
Specifies the Listen configurations of the RadSecProxy service for each type of Protocol. This table MUST contain at least 1 entry. At most one entry in this table can exist with a given value for Alias. |
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.19 |
Protocol |
string |
W |
Specifies the listening protocol. Enumeration of:
|
- |
2.19 |
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. The IP interface on which the RadSecProxy service listen for the corresponding Protocol. |
- |
2.19 |
Port |
unsignedInt(1:65535) |
W |
Specifies the port used to receive corresponding Protocol packets. UDP Protocol will default to port 1812 and TCP and TLS Protocol will default to 2083. |
- |
2.19 |
Device.RadSecProxy.SourceConfig.{i}. |
object(0:) |
R |
Specifies the source configurations of the RadSecProxy service which is used for connecting to servers in order to send messages for each type of Protocol. At most one entry in this table can exist with a given value for Alias. |
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.19 |
Protocol |
string |
W |
Specifies the source Protocol of the RadSecProxy service. Enumeration of:
|
- |
2.19 |
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. The IP interface which the RadSecProxy service uses as the source for the corresponding Protocol. |
- |
2.19 |
Port |
unsignedInt(1:65535) |
W |
Specifies the port used to receive corresponding Protocol packets. UDP Protocol will default to port 1812 and TCP and TLS Protocol will default to 2083. |
- |
2.19 |
Device.RadSecProxy.Realm.{i}. |
object(1:) |
W |
Realm block configuration of the RadSecProxy service as defined in [Appendix B/RFC6614]. This table MUST contain at least 1 entry. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Pattern. |
- |
2.19 |
Enable |
boolean |
W |
Enable or disable this Realm instance. |
- |
2.19 |
Status |
string |
R |
The status of this entry. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.19 |
Pattern |
string |
W |
Specifies the regular expression pattern against which the Username attribute in the Access-Request is matched to determine the corresponding Realm block. This is used to determine the Server to which the Access-Request should be forwarded. The format is implementation specific. |
- |
2.19 |
Server |
string(:256) |
W |
The value MUST be the Path Name of a row in the Server. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the server to which requests for this realm should be forwarded. If no server is configured, the RadSecProxy service will deny all Access-Requests for this realm. |
- |
2.19 |
AccountingServer |
string(:256) |
W |
The value MUST be the Path Name of a row in the Server. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the accounting Server. If no accounting Server is configured, the RadSecProxy service will silently ignore all Accounting-Requests for this realm unless AccountingResponse is set to true. |
- |
2.19 |
AccountingResponse |
boolean |
W |
Enable sending Accounting-Response instead of ignoring Accounting-Requests when no accounting servers are configured. |
false |
2.19 |
Device.RadSecProxy.Server.{i}. |
object(0:) |
W |
Server block configuration of the RadSecProxy service. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Address. |
- |
2.19 |
Enable |
boolean |
W |
Enable or disable this Server instance. |
- |
2.19 |
Status |
string |
R |
The status of this entry. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.19 |
Address |
string(:256) |
W |
Specifies the Fully Qualified Domain Name (FQDN) or IP address of the RADIUS server that the RadSecProxy service communicates with. |
- |
2.19 |
Protocol |
string |
W |
Specifies the type (protocol) of the Server. Enumeration of:
|
- |
2.19 |
Port |
unsignedInt(1:65535) |
W |
Specifies the port (UDP/TCP) to connect to. If omitted, UDP and TCP will default to 1812 while TLS and DTLS [RFC9147] will default to 2083. |
- |
2.19 |
Secret |
string |
W |
Specifies the shared RADIUS key with the client. This option is optional for TLS/DTLS and if omitted will default to "radsec". Note that using a secret other than "radsec" for TLS is a violation of the standard [RFC6614] and that the proposed standard for DTLS [RFC9147] stipulates that the secret must be "radius/dtls". When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.19 |
TLS |
string(:256) |
W |
The value MUST be the Path Name of a row in the TLS. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the TLS Block to be used for this server. |
- |
2.19 |
Device.RadSecProxy.Client.{i}. |
object(1:) |
W |
Client block configuration of the RadSecProxy service. This table MUST contain at least 1 entry. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Address. |
- |
2.19 |
Enable |
boolean |
W |
Enable or disable this Client instance. |
- |
2.19 |
Status |
string |
R |
The status of this entry. Enumeration of:
The Error value MAY be used by the CPE to indicate a locally defined error condition. |
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn't conflict with any existing entries. |
- |
2.19 |
Address |
string(:256) |
W |
Specifies the Fully Qualified Domain Name (FQDN) or IP address of RADIUS client that the RadSecProxy service communicates with. |
- |
2.19 |
Protocol |
string |
W |
Specifies the type (protocol) of the Client. Enumeration of:
|
- |
2.19 |
Secret |
string |
W |
Specifies the shared RADIUS key with the server. This option is optional for TLS/DTLS and if omitted will default to "radsec". Note that using a secret other than "radsec" for TLS is a violation of the standard [RFC6614] and that the proposed standard for DTLS stipulates that the secret must be "radius/dtls". When read, this parameter returns an empty string, regardless of the actual value. |
- |
2.19 |
TLS |
string(:256) |
W |
The value MUST be the Path Name of a row in the TLS. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Specifies the TLS Block to be used by this client. |
- |
2.19 |
Device.RadSecProxy.TLS.{i}. |
object(0:) |
W |
TLS block configuration of the RadSecProxy service. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- |
2.19 |
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.19 |
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.19 |
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.19 |
TLSVersion |
string |
W |
Specifies the TLS/DTLS protocol version to be used by the RadSecProxy service. Enumeration of:
|
- |
2.19 |
Device.SessionManagement. |
object |
R |
The logical connection between an RG and a data network using 3GPP technologies (FN-RG cellular and 5G-RG ALL) are considered data sessions. The Device.SessionManagement subtree describes each sessions properties together with the QoS rules specific to that access technology. |
- |
2.19 |
SessionNumberOfEntries |
unsignedInt |
R |
The number of entries in the Session table. |
- |
2.19 |
PDPNumberOfEntries |
unsignedInt |
R |
The number of entries in the PDP table. |
- |
2.19 |
PDNNumberOfEntries |
unsignedInt |
R |
The number of entries in the PDN table. |
- |
2.19 |
PDUNumberOfEntries |
unsignedInt |
R |
The number of entries in the PDU table. |
- |
2.19 |
Device.SessionManagement.Session.{i}. |
object(0:) |
R |
Contains all the properties of a 3GPP session instance common to all generations. This object contains the Session table. At most one entry in this table can exist with a given value for Alias, or with a given value for SessionID. |
- |
2.19 |
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.19 |
Interface |
string(:256) |
R |
The value MUST be the Path Name of a row in the IP.Interface. table, or the Path Name of an interface layered above such a row, e.g., a row in the Logical.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The IP Interface associated with the Session entry. |
- |
2.19 |
SessionID |
unsignedInt(1:15) |
R |
3GPP session identity. For 3G and 4G, this will be the cid as defined in TS27.007 10.1.1. For 5G see [Clause 9.4/3GPP-TS.24.501]. |
- |
2.19 |
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:
|
- |
2.19 |
APN |
string(:100) |
R |
The Access Point Name terminating the data session. For 3G and 4G it will be an APN, whilst 5G uses DNN. For all 3GPP generations, the APN can be specified at the time of session establishment or assigned by the network based on subscription. The format is defined in [Clause 9.11.2.1A/3GPP-TS.24.501]. |
- |
2.19 |
Reference |
string(:256) |
R |
The value MUST be the Path Name of a row in the PDP., PDN. or PDU. tables. If the referenced object is deleted, the parameter value MUST be set to an empty string. Indicates the data session type. When the Reference is an empty string the data session is unknown. |
- |
2.19 |
Device.SessionManagement.Session.{i}.PCO. |
object |
R |
Policy Configuration Options (PCO) is an optional set of configuration parameters supplied by the network as defined in [Clause 10.5.6.3/3GPP-TS.24.008]. |
- |
2.19 |
IPv6PCSCF |
string(:45) |
R |
[IPv6Address] The IPv6 address of the P-CSCF used for VoLTE telephony. |
- |
2.19 |
IPv6DNS |
string(:256)[] |
R |
Comma-separated list of strings (maximum number of characters per item 256). Each entry is an IPv6 DNS server. |
- |
2.19 |
IPv4PCSCF |
string(:45) |
R |
[IPv4Address] The IPv4 address of the P-CSCF used for VoLTE telephony. |
- |
2.19 |
IPv4DNS |
string(:256)[] |
R |
Comma-separated list of strings (maximum number of characters per item 256). Each entry is an IPv4 DNS server. |
- |
2.19 |
Device.SessionManagement.PDP.{i}. |
object(0:) |
R |
Contains all 3G specific attributes needed to establish a PDP Context. See [Clause 10.5.6.5/3GPP-TS.24.008] At most one entry in this table can exist with a given value for Alias. |
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.19 |
TrafficClass |
string |
R |
Indicates the type of application for which the PDP session is optimised. See [Clause 10.5.6.5/3GPP-TS.24.008]. Enumeration of:
|
- |
2.19 |
UpstreamMaxBitRate |
unsignedLong |
R |
Upstream Maximum Bit Rate in Kbps. See [Clause 10.5.6.5/3GPP-TS.24.008]. |
- |
2.19 |
DownstreamMaxBitRate |
unsignedLong |
R |
Downstream Maximum Bit Rate in Kbps. See [Clause 10.5.6.5/3GPP-TS.24.008]. |
- |
2.19 |
UpstreamGuaranteedBitRate |
unsignedLong |
R |
Upstream Guaranteed Bit Rate in Kbps. See [Clause 10.5.6.5/3GPP-TS.24.008]. |
- |
2.19 |
DownstreamGuaranteedBitRate |
unsignedLong |
R |
Downstream Guaranteed Bit Rate in Kbps. See [Clause 10.5.6.5/3GPP-TS.24.008]. |
- |
2.19 |
DeliveryOrder |
string |
R |
Indicates whether the PDP session shall provide in-sequence SDU delivery or not. See [Clause 10.5.6.5/3GPP-TS.24.008]. Enumeration of:
|
- |
2.19 |
MaximumSDUSize |
unsignedInt |
R |
Indicates the maximum allowed SDU size in octets. See [Clause 10.5.6.5/3GPP-TS.24.008]. |
- |
2.19 |
SDUErrorRatio |
string(:10) |
R |
Indicates the target value for the fraction of SDUs lost or detected as erroneous. SDUs. SDU error ratio is defined only for conforming traffic. The value is specified as "mEe". As an example a target residual bit error ratio of 5•10-3 would be specified as "5E3", "0E0" means subscribed value See [Clause 10.5.6.5/3GPP-TS.24.008]. |
- |
2.19 |
ResidualBitErrorRatio |
string(:10) |
R |
Indicates the target value for the undetected bit error ratio in the delivered SDUs. If no error detection is requested, Residual bit error ratio indicates the bit error ratio in the delivered SDUs. The value is specified as "mEe". As an example a target residual bit error ratio of 5•10-3 would be specified as "5E3" "0E0" means subscribed value See [Clause 10.5.6.5/3GPP-TS.24.008]. |
- |
2.19 |
DeliveryOfErroneousSDUs |
string |
R |
Indicates whether SDUs detected as erroneous shall be delivered or not. See [Clause 10.5.6.5/3GPP-TS.24.008]. Enumeration of:
|
- |
2.19 |
TransferDelay |
unsignedInt |
R |
indicates the targeted time between request to transfer an SDU at one SAP to its delivery at the other SAP, in Milliseconds. See [Clause 10.5.6.5/3GPP-TS.24.008]. |
- |
2.19 |
Device.SessionManagement.PDN.{i}. |
object(0:) |
R |
Contains all 4G specific attributes needed to establish a PDN session. At most one entry in this table can exist with a given value for Alias. |
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.19 |
QCI |
unsignedInt(0:254) |
R |
QoS Class Identifier. See [Clause 9.9.4.3/3GPP-TS.24.301]. |
- |
2.19 |
UpstreamMaxBitRate |
unsignedLong |
R |
Upstream Maximum Bit Rate in Kbps. See [Clause 9.9.4.3/3GPP-TS.24.301]. |
- |
2.19 |
DownstreamMaxBitRate |
unsignedLong |
R |
Downstream Maximum Bit Rate in Kbps. See [Clause 9.9.4.3/3GPP-TS.24.301]. |
- |
2.19 |
UpstreamGuaranteedBitRate |
unsignedLong |
R |
Upstream Guaranteed Bit Rate in Kbps. See [Clause 9.9.4.3/3GPP-TS.24.301]. |
- |
2.19 |
DownstreamGuaranteedBitRate |
unsignedLong |
R |
Downstream Guaranteed Bit Rate in Kbps. See [Clause 9.9.4.3/3GPP-TS.24.301]. |
- |
2.19 |
UpstreamAggregateBitRate |
unsignedLong |
R |
Upstream Aggregate Bit Rate in Kbps. See [Clause 9.9.4.3/3GPP-TS.24.301]. |
- |
2.19 |
DownstreamAggregateBitRate |
unsignedLong |
R |
Downstream Aggregate Bit Rate in Kbps. See [Clause 9.9.4.3/3GPP-TS.24.301]. |
- |
2.19 |
Device.SessionManagement.PDU.{i}. |
object(0:) |
R |
Contains all 5G specific attributes needed to establish a PDU session. At most one entry in this table can exist with a given value for Alias. |
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.19 |
PTI |
unsignedInt(1:254) |
R |
Procedure transaction identity. See [Clause 9.6/3GPP-TS.24.501]. |
- |
2.19 |
SSC |
unsignedInt(1:3) |
R |
Session and Service Continuity (SSC) Mode: Indicates that the traffic of the matching application shall be routed via a PDU Session supporting the included SSC Mode. See [Clause 9.11.4.16/3GPP-TS.24.501] |
- |
2.19 |
SessionAMBRDownlink |
unsignedLong |
R |
Downlink Aggregate Maximum Bit Rate in bits per second. See [Clause 9.11.4.14/3GPP-TS.24.501]. |
- |
2.19 |
SessionAMBRUplink |
unsignedLong |
R |
Uplink Aggregate Maximum Bit Rate in bits per second. See [Clause 9.11.4.14/3GPP-TS.24.501]. |
- |
2.19 |
RQTimerValue |
unsignedInt |
R |
Reflective QoS timeout in seconds. See [Clause 9.11.2.3/3GPP-TS.24.501]. |
- |
2.19 |
AlwaysOn |
boolean |
R |
Always on PDU session indication. The purpose of the Always-on PDU session indication information element is to indicate whether a PDU session is established as an always-on PDU session. |
- |
2.19 |
QoSRuleNumberOfEntries |
unsignedInt |
R |
The number of entries in the QoSRule table. |
- |
2.19 |
QoSFlowNumberOfEntries |
unsignedInt |
R |
The number of entries in the QoSFlow table. |
- |
2.19 |
Device.SessionManagement.PDU.{i}.NetworkSlice. |
object |
R |
Describes a S-NSSAI Information element providing network slice specification. |
- |
2.19 |
SliceServiceType |
string |
R |
[SST] The Slice Service Type (SST). Enumeration of:
|
- |
2.19 |
SliceDifferentiator |
unsignedInt |
R |
The Slice differentiator is an optional number used to differentiate network slices with the same SST. |
- |
2.19 |
Device.SessionManagement.PDU.{i}.QoSRule.{i}. |
object(0:) |
R |
This object describes the PDU QoS Rule table. The purpose of the QoS Rule table is to assign a QFI to mark traffic based on a set of classification rules. The rules are set by the network operator and are specific for each PDU. For example:
A full description can be found at [Clause 9.11.4.13/3GPP-TS.24.501] QoS Rules At most one entry in this table can exist with a given value for Alias, or with a given value for Identifier. |
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.19 |
Identifier |
unsignedInt(1:255) |
R |
The QoS rule identifier field is used to identify the QoS rule. |
- |
2.19 |
Precedence |
unsignedInt(0:255) |
R |
The QoS rule precedence field is used to specify the precedence of the QoS rule among all QoS rules. The higher the value of the QoS rule precedence field, the lower the precedence of that QoS rule is. |
- |
2.19 |
Segregation |
boolean |
R |
In the UE to network direction the segregation bit indicates whether the UE is requesting the network to bind service data flows described by the QoS rule to a dedicated QoS Flow. When true segregation is requested. |
- |
2.19 |
QFI |
unsignedInt(1:63) |
R |
QoS Flow identifier. |
- |
2.19 |
DQR |
boolean |
R |
Default QoS rule flag. When true this QoS rule is the default QoS rule. |
- |
2.19 |
FilterNumberOfEntries |
unsignedInt |
R |
The number of entries in the Filter table. |
- |
2.19 |
Device.SessionManagement.PDU.{i}.QoSRule.{i}.Filter.{i}. |
object(0:) |
R |
This object describes the PDU QoS Rule Filter table. As each packet filter is logically anded with the others, there shall not be more than one occurrence of each packet filter component type. At most one entry in this table can exist with a given value for Alias. |
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.19 |
Direction |
string |
R |
The packet filter direction field is used to indicate for what traffic direction the filter applies. See [Clause 9.11.4.13/3GPP-TS.24.501] Enumeration of:
|
- |
2.19 |
Type |
unsignedInt |
R |
Packet filter component type identifier. See [Clause 9.11.4.13/3GPP-TS.24.501]. |
- |
2.19 |
Value |
string(:1024) |
R |
Matching value for the component type. See [Clause 9.11.4.13/3GPP-TS.24.501]. |
- |
2.19 |
Device.SessionManagement.PDU.{i}.QoSFlow.{i}. |
object(0:) |
R |
Table of all QoS Flow Indicators (QFI) and their properties supported by the access network for this particular PDU. For example:
At most one entry in this table can exist with a given value for Alias, or with a given value for QFI. |
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.19 |
QFI |
unsignedInt(1:63) |
R |
QoS Flow Identifier. |
- |
2.19 |
FiveQI |
unsignedInt(1:255) |
R |
5G QoS Identifier. See [Clause 5.7.4/3GPP-TS.23.501] for a table of standardised 5QI QoS characteristics. |
- |
2.19 |
GFBRUplink |
unsignedLong |
R |
Guaranteed Flow Bitrate - Upstream (expressed in bits per second). |
- |
2.19 |
GFBRDownlink |
unsignedLong |
R |
Guaranteed Flow Bitrate - Downstream (expressed in bits per second). |
- |
2.19 |
MFBRUplink |
unsignedLong |
R |
Maximum Flow Bitrate - Upstream (expressed in bits per second). |
- |
2.19 |
MFBRDownlink |
unsignedLong |
R |
Maximum Flow Bitrate - Downstream (expressed in bits per second). |
- |
2.19 |
AveragingWindow |
unsignedInt |
R |
Averaging window for both uplink and downlink in milliseconds. |
- |
2.19 |
EPSBearer |
unsignedInt |
R |
EPS Bearer Identity. See [Clause 9.3.2/3GPP-TS.24.301]. |
- |
2.19 |
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}.MQTT. |
object(0:1) |
R |
If the USP Endpoint uses the MQTT Message Transfer Protocol (MTP), then this object contains MQTT Client specific configuration parameters related to how this Controller communicates with the MQTT broker. This object MUST be present if, and only if, Protocol is MQTT. 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.15 |
Reference |
string |
W |
The value MUST be the Path Name of a row in the MQTT.Client. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. A reference to the MQTT Client used by this Controller when communicating via the MQTT MTP. This parameter was DEPRECATED in 2.16 because AgentMTPReference was added. This parameter was OBSOLETED in 2.18. This parameter was DELETED in 2.19. Changes since 2.18:
|
<Empty> |
2.15 |
Device.USPAgent.ControllerTrust. |
object |
R |
This object contains information that an Agent applies when establishing a trust relationship with a Controller. |
- |
2.15 |
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 |
Device.CollectionDevice.{i}. |
object(0:) |
R |
A CollectionDevice is a device in the network that is represented in the Device data model in multiple places. An instance of CollectionDevice represents a physical device that is modeled via a set of data model objects that are distributed throughout the data model, and brings them together into a single Data Model Object. For example an entry with a WiFi.DataElements.Network.Device and a IEEE1905.AL.NetworkTopology.IEEE1905Device is the same device represented in two places. When the entry with IsNativeDevice is true, that entry will represent the Native Device which is modeled by the Root Object Device. At most one entry in this table can exist with a given value for Alias. |
- |
2.19 |
Alias |
string(:64) |
W |
[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
|
- |
2.19 |
IsNativeDevice |
boolean |
R |
If true this CollectionDevice models the top level Device only one instance can represent the top-level device. If false this CollectionDevice represents another device in the network. |
- |
2.19 |
DataElementsDeviceRef |
string |
R |
The value MUST be the Path Name of the WiFi.DataElements.Network.Device instance corresponding to this CollectionDevice, or an empty string if this CollectionDevice is not represented in the WiFi.DataElements.Network.Device table. If the referenced object is deleted, the parameter value MUST be set to an empty string. |
- |
2.19 |
IEEE1905DeviceRef |
string |
R |
The value MUST be the Path Name of the IEEE1905.AL.NetworkTopology.IEEE1905Device instance corresponding to this CollectionDevice, or an empty string if this CollectionDevice is not represented in the IEEE1905.AL.NetworkTopology.IEEE1905Device table. If the referenced object is deleted, the parameter value MUST be set to an empty string. |
- |
2.19 |
LLDPDeviceRef |
string |
R |
The value MUST be the Path Name of the LLDP.Discovery.Device instance corresponding to this CollectionDevice, or an empty string if this CollectionDevice is not represented in the LLDP.Discovery.Device table. If the referenced object is deleted, the parameter value MUST be set to an empty string. |
- |
2.19 |
UPnPDeviceRef |
string[] |
R |
Comma-separated list of strings. Each list item MUST be the Path Name of the UPnP.Discovery.Device instance corresponding to this CollectionDevice, or an empty string if this CollectionDevice is not represented in the UPnP.Discovery.Device table. If the referenced object is deleted, the corresponding item MUST be removed from the list. |
- |
2.19 |
HostDeviceRef |
string[] |
R |
Comma-separated list of strings. Each list item MUST be the Path Name of the Hosts.Host instance corresponding to this CollectionDevice, or an empty string if this CollectionDevice is not represented in the Hosts.Host table. If the referenced object is deleted, the corresponding item MUST be removed from the list. |
- |
2.19 |
GhnAssociatedDeviceRef |
string |
R |
The value MUST be the Path Name of the Ghn.Interface.{i}.AssociatedDevice instance corresponding to this CollectionDevice, or an empty string if this CollectionDevice is not represented in the Ghn.Interface.{i}.AssociatedDevice table. If the referenced object is deleted, the parameter value MUST be set to an empty string. |
- |
2.19 |
MoCAAssociatedDeviceRef |
string |
R |
The value MUST be the Path Name of the MoCA.Interface.{i}.AssociatedDevice instance corresponding to this CollectionDevice, or an empty string if this CollectionDevice is not represented in the MoCA.Interface.{i}.AssociatedDevice table. If the referenced object is deleted, the parameter value MUST be set to an empty string. |
- |
2.19 |
HomePlugAssociatedDeviceRef |
string |
R |
The value MUST be the Path Name of the HomePlug.Interface.{i}.AssociatedDevice instance corresponding to this CollectionDevice, or an empty string if this CollectionDevice is not represented in the HomePlug.Interface.{i}.AssociatedDevice table. If the referenced object is deleted, the parameter value MUST be set to an empty string. |
- |
2.19 |
HPNAAssociatedDeviceRef |
string |
R |
The value MUST be the Path Name of the HPNA.Interface.{i}.AssociatedDevice instance corresponding to this CollectionDevice, or an empty string if this CollectionDevice is not represented in the HPNA.Interface.{i}.AssociatedDevice table. If the referenced object is deleted, the parameter value MUST be set to an empty string. |
- |
2.19 |
UPAAssociatedDeviceRef |
string |
R |
The value MUST be the Path Name of the UPA.Interface.{i}.AssociatedDevice instance corresponding to this CollectionDevice, or an empty string if this CollectionDevice is not represented in the UPA.Interface.{i}.AssociatedDevice table. If the referenced object is deleted, the parameter value MUST be set to an empty string. |
- |
2.19 |
WiFiAssociatedDeviceRef |
string |
R |
The value MUST be the Path Name of the WiFi.AccessPoint.{i}.AssociatedDevice instance corresponding to this CollectionDevice, or an empty string if this CollectionDevice is not represented in the WiFi.AccessPoint.{i}.AssociatedDevice table. If the referenced object is deleted, the parameter value MUST be set to an empty string. |
- |
2.19 |
ZigBeeAssociatedDeviceRef |
string |
R |
The value MUST be the Path Name of the ZigBee.Interface.{i}.AssociatedDevice instance corresponding to this CollectionDevice, or an empty string if this CollectionDevice is not represented in the ZigBee.Interface.{i}.AssociatedDevice table. If the referenced object is deleted, the parameter value MUST be set to an empty string. |
- |
2.19 |
ThreadAssociatedNodeRef |
string |
R |
The value MUST be the Path Name of the Thread.MLE.{i}.AssociatedNode instance corresponding to this CollectionDevice, or an empty string if this CollectionDevice is not represented in the Thread.MLE.{i}.AssociatedNode table. If the referenced object is deleted, the parameter value MUST be set to an empty string. |
- |
2.19 |
Generated by Broadband Forum bbfreport v2.3.1 (2025-04-11 version) on 2025-04-23 at 16:39:20 UTC.
report.py --include ../../install/cwmp --output tr-181-2-19-1-cwmp-diffs.html --show --transform diff --format html tr-181-2-18-1-cwmp.xml tr-181-2-19-1-cwmp.xml