Broadband Forum

Device:2 Root Data Model definition [USP] (changes)

tr-181-2-18-1-usp.xml

DATA MODEL DEFINITION

License

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

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The above license is used as a license under copyright only. Please reference the Forum IPR Policy for patent licensing terms https://www.broadband-forum.org/ipr-policy.

Any moral rights which are necessary to exercise under the above license grant are also deemed granted under this license.

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].
int -

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

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

long -

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

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

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

Unsigned integer in the range 0 to 4294967295, inclusive.

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

unsignedLong -

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

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

Alias string(:64)

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

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.
Dbm1000 int The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.
IPAddress string(:45)

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

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

  • 216.52.29.100
  • 192.168.1.254

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

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

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

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

IPPrefix string(:49)

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

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

This notation can also represent individual addresses by specifying all bits.

  • IPv4 example: 192.168.1.1/32
  • IPv6 example: 2001:edff:fe6a:f76::1/128

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:

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

IPv6 address.

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

MACAddress string(:17)

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

Possible patterns:

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

Represents a type of MoCA Privacy.

Enumeration of:

  • mocaReserved5
  • mocaReserved4
  • mocaReserved3
  • mocaReserved2
  • mocaReserved1
  • moca2EnhancedPrivacy
  • moca20Privacy
  • moca1Privacy
StatsCounter32 unsignedInt

A 32-bit statistics parameter, e.g. a byte counter.

This data type SHOULD NOT be used for statistics parameters whose values might become greater than the maximum value that can be represented as an unsignedInt (i.e. 0xffffffff, referred to below as maxval). StatsCounter64 SHOULD be used for such parameters.

The value maxval indicates that no data is available for this parameter. In the unlikely event that the actual value of the statistic is maxval, the CPE SHOULD return maxval - 1.

The actual value of the statistic might be greater than maxval. Such values SHOULD wrap around through zero.

The term packet is to be interpreted as the transmission unit appropriate to the protocol layer in question, e.g. an IP packet or an Ethernet frame.

StatsCounter64 unsignedLong

A 64-bit statistics parameter, e.g. a byte counter.

This data type SHOULD be used for all statistics parameters whose values might become greater than the maximum value that can be represented as an unsignedInt.

The maximum value that can be represented as an unsignedLong (i.e. 0xffffffffffffffff) indicates that no data is available for this parameter.

The term packet is to be interpreted as the transmission unit appropriate to the protocol layer in question, e.g. an IP packet or an Ethernet frame.

UERComplex int[2:2]

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

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

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

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

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

Universally Unique Identifier. See [RFC4122].

Possible patterns:

  • [A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}

References

[3GPP-TS.23.003] 3GPP TS 23.003, Numbering, addressing and identification, 3GPP CT WG4.
[3GPP-TS.23.501] 3GPP TS 23.501, System architecture for the 5G System (5GS); Stage 2, 3GPP SA WG2.
[3GPP-TS.24.008] 3GPP TS 24.008, Mobile radio interface Layer 3 specification; Core network protocols; Stage 3, 3GPP CT WG1.
[3GPP-TS.24.301] 3GPP TS 24.301, Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3, 3GPP CT WG1.
[3GPP-TS.24.501] 3GPP TS 24.501, Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3, 3GPP CT WG1.
[3GPP-TS.24.526] 3GPP TS 24.526, User Equipment (UE) policies for 5G System (5GS); Stage 3, 3GPP CT WG1.
[3GPP-TS.27.007] 3GPP TS 24.007, AT command set for User Equipment (UE), 3GPP CT WG1.
[802.11-2012] IEEE Std 802.11-2012, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, March 2012.
[802.11-2020] IEEE Std 802.11-2020, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, December 2020.
[802.11ac-2013] IEEE Std 802.11ac-2013, Enhancements for Very High Throughput for Operation in Bands below 6 GHz, IEEE, December 2013.
[802.11ax] IEEE Std 802.11ax, Enhancements for High Efficiency WLAN, IEEE, May 2021.
[802.11b-1999] IEEE Std 802.11b-1999, Higher Speed Physical Layer Extension in the 2.4 GHz band, IEEE, 1999.
[802.11g-2003] IEEE Std 802.11g-2003, Further Higher Data Rate Extension in the 2.4 GHz Band, IEEE, 2003.
[802.11n-2009] IEEE Std 802.11n-2009, Amendment 5: Enhancements for Higher Throughput, IEEE, 2009.
[802.1ad-2005] IEEE Std 802.1ad-2005, Virtual Bridged Local Area Networks Amendment 4: Provider Bridges, IEEE, May 2005.
[802.1AX-2014] IEEE Std 802.1AX-2014, IEEE Standard for Local and metropolitan area networks - Link Aggregation, IEEE, 2014.
[802.1D-2004] IEEE Std 802.1D-2004, Media Access Control (MAC) Bridges, IEEE, 2004.
[802.1Q-2005] IEEE Std 802.1Q-2005, Virtual Bridged Local Area Networks, IEEE, 2006.
[802.1Q-2011] IEEE Std 802.1Q-2011, MAC Bridges and Virtual Bridge Local Area Networks, IEEE, 2011.
[802.1x-2004] IEEE Std 802.1x-2004, Standards for Local and Metropolitan Area Networks: Port based Network Access Control, IEEE, 2004.
[802.3-2015] IEEE Std 802.3-2015, IEEE Standard for Ethernet, IEEE, 2015.
[CM-SP-MULPIv3.0] CM-SP-MULPIv3.0, DOCSIS 3.0 MAC and Upper Layer Protocols Interface Specification, CableLabs, December 2017.
[CM-SP-RFIv2.0] CM-SP-RFIv2.0, Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification, CableLabs, April 2009.
[DataElements] Data Elements Specification, Wi-Fi Data Elements Specification, Wi-Fi Alliance, September 2021.
[DNS-SD] RFC 6763, DNS-Based Service Discovery, IETF, 2013.
[DSLite] RFC 6333, Dual-Stack Lite Broadband Deployments Following IPv4 Exhaustion, IETF, 2011.
[EasyMesh] EasyMesh Specification, Wi-Fi EasyMesh Specification, Wi-Fi Alliance, December 2021.
[G.9807.1] G.9807.1, 10-Gigabit-capable symmetric passive optical network (XGS-PON), ITU-T, June 2016.
[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.9964] G.9964, Unified high-speed wire-line based home networking transceivers - Power spectral density specification, ITU-T.
[HTML4.01] HTML 4.01 Specification, W3C.
[IANA-ipversionnumbers] IANA IP Version Numbers, IP Version Numbers, IANA.
[IANA-protocolnumbers] IANA Protocol Numbers, Protocol Numbers, IANA.
[IANA-uri-schemes] IANA Uniform Resource Identifier (URI) Schemes Registry, Uniform Resource Identifier (URI) Schemes, IANA.
[IANAMauMIB] IANAMauMIB, IANA-MAU-MIB DEFINITIONS, IANA, 2022.
[IEEE1905.1a] IEEE 1905.1a, IEEE Std 1905.1a, Convergent Digital Home Network for Heterogeneous Technologies Amendment 1: Support of new MAC/PHYs and enhancements, IEEE, December 2014., IEEE, December 2014.
[IEEE_EUI64] Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, IEEE, March 1997.
[IKEv2-params] IKEv2 Parameters, Internet Key Exchange Version 2 (IKEv2) Parameters, IANA.
[IPDR-FTP] IPDR File Transfer Protocol, IPDR/File Transfer Protocol, TM Forum.
[IPDR-SP] IPDR Streaming Protocol, IPDR Streaming Protocol (IPDR/SP) Specification, TM Forum.
[LMAPIFM] RFC 8193, Information Model for Large-Scale Measurement Platforms (LMAPs), IETF, August 2017.
[MOCA20-MIB] 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.
[MoCAv2.5] MoCA v2.5, MoCA MAC/PHY Specification v2.5, MoCA Alliance, 2017.
[OUI] Organizationally Unique Identifiers (OUIs).
[RFC1035] RFC 1035, Domain Names - Implementation and Specification, IETF, 1987.
[RFC1332] RFC 1332, The PPP Internet Protocol Control Protocol (IPCP), IETF, 1992.
[RFC1661] RFC 1661, The Point-to-Point Protocol (PPP), IETF, 1994.
[RFC1877] RFC 1877, PPP Internet Protocol Control Protocol Extensions for Name Server Addresses, IETF, 1995.
[RFC2131] RFC 2131, Dynamic Host Configuration Protocol, IETF.
[RFC2132] RFC 2132, DHCP Options and BOOTP Vendor Extensions, IETF.
[RFC2782] RFC 2782, A DNS RR for specifying the location of services (DNS SRV), IETF, 2000.
[RFC2863] RFC 2863, The Interfaces Group MIB, IETF, 2000.
[RFC3004] RFC 3004, The User Class Option for DHCP, IETF.
[RFC3339] RFC 3339, Date and Time on the Internet: Timestamps, IETF, July, 2002.
[RFC3646] RFC 3646, DNS Configuration options for Dynamic Host Configuration Protocol for IPv6 (DHCPv6), IETF, 2003.
[RFC3925] RFC 3925, Vendor-Identifying Vendor Options for Dynamic Host Configuration Protocol version 4 (DHCPv4), IETF.
[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.
[RFC4193] RFC 4193, Unique Local IPv6 Unicast Addresses, IETF, 2005.
[RFC4291] RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006.
[RFC4292] RFC 4292, IP Forwarding Table MIB, IETF, 2006.
[RFC4293] RFC 4293, Management Information Base for the Internet Protocol (IP), IETF, 2006.
[RFC4301] RFC 4301, Security Architecture for the Internet Protocol, IETF, December 2005.
[RFC4302] RFC 4302, IP Authentication Header, IETF, December 2005.
[RFC4303] RFC 4303, IP Encapsulating Security Payload (ESP), IETF, December 2005.
[RFC4632] RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan, IETF, 2006.
[RFC4835] RFC 4835, Cryptographic Algorithm Implementation Requirements for Encapsulating Security Payload (ESP) and Authentication Header (AH), IETF, 2007.
[RFC4861] RFC 4861, Neighbor Discovery for IP version 6 (IPv6), IETF, 2007.
[RFC4862] RFC 4862, IPv6 Stateless Address Autoconfiguration, IETF, 2007.
[RFC5625] RFC 5625, DNS Proxy Implementation Guidelines, IETF, 2009.
[RFC5969] RFC 5969, IPv6 Rapid Deployment on IPv4 Infrastructures (6rd) - Protocol Specification, IETF, 2010.
[RFC5996] RFC 5996, Internet Key Exchange Protocol Version 2 (IKEv2), IETF, September 2010.
[RFC6120] RFC 6120, Extensible Messaging and Presence Protocol (XMPP) : Core, IETF, 2011.
[RFC6762] RFC 6762, Multicast DNS, IETF, February 2013.
[RFC6887] RFC 6887, Port Control Protocol (PCP), IETF, 2013.
[RFC7159] RFC7159, The JavaScript Object Notation (JSON) Data Interchange Format, IETF, March 2014.
[RFC7230] RFC 7230, Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing, IETF, June 2014.
[RFC7252] RFC 7252, The Constrained Application Protocol (CoAP), IETF, June 2014.
[RFC7291] RFC 7291, DHCP Options for the Port Control Protocol (PCP), IETF, 2014.
[RFC7594] RFC 7594, A Framework for Large-Scale Measurement of Broadband Performance (LMAP), IETF, September 2015.
[RFC7597] RFC 7597, Mapping of Address and Port with Encapsulation (MAP), IETF, July 2015.
[RFC7598] RFC 7598, DHCPv6 Options for configuration of Softwire Address and Port Mapped Clients, IETF, July 2015.
[RFC7599] RFC 7599, Mapping of Address and Port using Translation (MAP-T), IETF, July 2015.
[RFC8089] RFC 8089, The “file” URI Scheme, IETF, February 2017.
[RFC8106] RFC 8106, IPv6 Router Advertisement Options for DNS Configuration, IETF, March 2017.
[RFC8141] RFC 8141, Uniform Resource Names (URNs), IETF, April 2017.
[RFC8415] RFC 8415, Dynamic Host Configuration Protocol for IPv6 (DHCPv6), IETF, November 2018.
[RFC8966] RFC 8966, The Babel Routing Protocol, IETF, January 2021.
[RFC9046] RFC 9046, Babel Information Model, IETF, June 2021.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-069] TR-069 Amendment 6, CPE WAN Management Protocol, Broadband Forum, April 2018.
[TR-181i2] TR-181 Issue 2 Amendment 15, Device Data Model, Broadband Forum, January 2022.
[TR-232] TR-232, Bulk Data Collection, Broadband Forum, May 2012.
[TR-369] TR-369 Issue 1 Amendment 2, User Services Platform, Broadband Forum, January 2022.
[TR-390] TR-390, Performance Measurement from Customer Equipment to IP Edge, Broadband Forum, May 2017.
[TR-471] TR-471, Maximum IP-Layer Capacity Metric, Related Metrics, and Measurements, Broadband Forum, December 2023.
[YANGSYSLOG] draft-ietf-netmod-syslog-model, A YANG Data Model for Syslog Configuration, IETF, April 2023.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

Legend

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

Device:2.18 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 in 2.18:

Name Type Write Description Object Default Version
Device. object R The top-level object for a Device.

Changes in 2.18:

 - 2.0
Reboot() command - Reboot the entity associated with the containing Device.

Changes in 2.18:

  • Added Input. input
 - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Cause string W

The cause that will be contained within the Boot! Event. By default the Device SHOULD set this value to RemoteReboot.

Enumeration of:

  • LocalReboot (A Device. Event that was the result of a reboot triggered locally on the Device (NOT as a result of a Reboot() Command triggered by a remote trigger, e.g. another remote management protocol)}})
  • RemoteReboot (A Device. Event that was the result of a reboot triggered via the Reboot()} Command or other remote trigger, e.g. another remote management protocol)
 - 2.18
⇒ Reason string W

The reason of the boot (e.g. power on reset, watchdog, overheat, FAN fault, web userinterface, …).

When absent the implementation must set Reason to ‘Unknown’.

 - 2.18
Boot! event - Boot event indicating that the Device was rebooted.

Changes in 2.18:

 - 2.12
⇒ Cause string R

The cause of the boot.

Enumeration of:

  • LocalReboot (A Device. Event that was the result of a reboot triggered locally on the Device (NOT as a result of a {{command: non-existent {{replaced: unexpected argument model after: #.Reboot(), .Reboot()}}}} Command triggered by a remote trigger, e.g. another remote management protocol)}})
  • RemoteReboot (A Device. Event that was the result of a reboot triggered via the {{command: non-existent {{replaced: unexpected argument model after: #.Reboot(), .Reboot()}}}}} Command or other remote trigger, e.g. another remote management protocol)
  • FactoryReset (A Device. Event that was the result of a factory reset triggered locally on the Device or remotely (as a result of a {{command: non-existent {{replaced: unexpected argument model after: #.FactoryReset(), .FactoryReset()}}}}} Command or other remote trigger, e.g. another remote management protocol), which is to be used when the Agent cannot differentiate between local and remote, added in 2.15)
  • LocalFactoryReset (A Device. Event that was the result of a factory reset triggered locally on the Device (NOT as a result of a {{command: non-existent {{replaced: unexpected argument model after: #.FactoryReset(), .FactoryReset()}}}}} Command triggered by a remote trigger, e.g. another remote management protocol))
  • RemoteFactoryReset (A Device. Event that was the result of a factory reset triggered via the {{command: non-existent {{replaced: unexpected argument model after: #.FactoryReset(), .FactoryReset()}}}} Command or other remote trigger, e.g. another remote management protocol)
 - 2.12
⇒ Reason string R The reason of the boot (e.g. power on reset, watchdog, overheat, FAN fault, web userinterface, …). - 2.18
FactoryReset() command - Factory reset the entity associated with the containing Device.

Changes in 2.18:

  • Added Input. input
 - 2.0
⇒ Input. arguments - Input arguments. -
⇒ Cause string W

The cause that will be contained within the Boot! Event. By default the Device SHOULD set this value to RemoteFactoryReset.

Enumeration of:

  • LocalFactoryReset (A Device. Event that was the result of a factory reset triggered locally on the Device (NOT as a result of a FactoryReset()} Command trigger by a remote trigger, e.g. another remote management protocol))
  • RemoteFactoryReset (A Device. Event that was the result of a factory reset triggered via the FactoryReset() Command or other remote trigger, e.g. another remote management protocol)
 - 2.18
⇒ Reason string W

The reason of the boot (e.g. power on reset, watchdog, overheat, FAN fault, web userinterface, …).

When absent the implementation must set Reason to ‘Unknown’.

 - 2.18
Device.DeviceInfo. object R This object contains general device information.

Changes in 2.18:

 - 2.0
ProcessorNumberOfEntries unsignedInt R
The number of entries in the Processor table.
This parameter was DEPRECATED in 2.18 because the only contained parameter, Processor.{i}.Architecture, is no longer relevant for modern devices.

Changes in 2.18:

  • Added status = deprecated
 - 2.1
PEN string(:10) R

Private Enterprise Number assigned and registered by IANA to the entity responsible for this Agent. Represented as a decimal encoding of the IANA-assingedIANA-assigned number.

This value MUST remain fixed over the lifetime of the Agent, including across firmware updates. Any change would indicate that it’s a new Agent and would therefore require a Boot! Event with a LocalFactoryReset enumerated value in the Boot!.Cause argument.

 - 2.0
Device.DeviceInfo.VendorConfigFile.{i}. object(0:) R

Every instance of this object is a Vendor Configuration File, and contains parameters associated with the Vendor Configuration File.

This table of Vendor Configuration Files is for information only and does not allow the Controller to operate on these files in any way.

Whenever the Agent successfully restores a configuration file as a result of the Restore() Command, the Agent MUST update this Object.

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

 - 2.0
UseForBackupRestore boolean R

When true, this parameter indicates that this VendorConfigFile instance is to be used for backup and restoration purposes.

Note: The backup and restore operations may require the use of multiple VendorConfigFile instances. In this scenario the mechanism for deteminingdetermining the order and combination of VendorConfigFile instances used for backup and restoration purposes is implementation specific.

 - 2.7
Device.DeviceInfo.MemoryStatus. object R Status of the device’s physical memory.

Changes in 2.18:

 - 2.0
Device.DeviceInfo.MemoryStatus.MemoryMonitor. object R This object specifies information that the device has obtained via sampling the memory utilization (RAM) on the device. - 2.18
Enable boolean W

Indicates whether or not memory monitoring is enabled.

The default value SHOULD be false.

 - 2.18
MemUtilization unsignedInt(:100) R Memory utilization, in percent, rounded to the nearest whole percent, is the percentage of memory used by the system which cannot be spontaneously reclaimed or repurposed by the system in case it is required. This metric is collected at the PollingInterval. This value is used to determine if a critical condition is reached i.e., the memory utilization exceeds CriticalRiseThreshold. - 2.18
PollingInterval unsignedInt W

The interval, measured in seconds, in which the device polls the memory utilization.

If the value is 0 then the device selects its own polling interval.

If the value is greater than 0 then the device MUST use this value as the polling interval.

 - 2.18
CriticalRiseThreshold unsignedInt(:100) W

Memory utilization rise threshold percent value. If the MemUtilization exceeds the rise threshold value, and the CriticalFallTimeStamp is greater than CriticalRiseTimeStamp (indicating that critical condition is reached), the following takes place:

The default value SHOULD be 80.

 - 2.18
CriticalFallThreshold unsignedInt(:100) W

Memory utilization fall threshold percent value. If the MemUtilization falls below the fall threshold value and CriticalRiseTimeStamp is greater than CriticalFallTimeStamp (indicating that the critical condition is no longer present), the following takes place:

The default value SHOULD be 60.

 - 2.18
CriticalRiseTimeStamp dateTime R Last date and time when the critical condition was reached. See CriticalRiseThreshold description for more details. - 2.18
CriticalFallTimeStamp dateTime R Last date and time when the critical condition was no longer present. See CriticalFallThreshold description for more details. - 2.18
EnableCriticalLog boolean W

This parameter indicates whether a critical log needs to be generated in the vendor log file.

  • If the value of EnableCriticalLog is true, then a critical log is generated in the vendor log file.
  • If the value of EnableCriticalLog is false, then no critical log is generated in the vendor log file.

The default value SHOULD be false.

 - 2.18
VendorLogFileRef string R

The value MUST be the Path Name of a row in the DeviceInfo.VendorLogFile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The reference to DeviceInfo.VendorLogFile is automatically constructed and the DeviceInfo.VendorLogFile is populated with the information based on FilePath.

E.g. When FilePath = file:///var/log/messages. The following entry is automatically added to DeviceInfo.VendorLogFile: file:///var/log/messages.

 - 2.18
FilePath string W Destination path and filename of where to create and keep the log files which MUST use the file URI scheme [The file URI Scheme/RFC8089]. This file is related to EnableCriticalLog. - 2.18
MemoryCriticalState! event - This event is generated indicating critical condition is reached i.e., when MemUtilization exceeds the rise threshold, the event is generated. - 2.18
⇒ MemUtilization unsignedInt(:100) R Memory utilization, in percent, rounded to the nearest whole percent, collected at the polling interval. - 2.18
Device.DeviceInfo.ProcessStatus. object R Status of the processes on the device.

Changes in 2.18:

 - 2.0
CPUUsage unsignedInt(:100) R

The total amount of the CPU, in percent, rounded up to the nearest whole percent. In the case that multiple CPU are present, this value represents the average of all CPU.

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
CPUNumberOfEntries unsignedInt R The number of entries in the CPU table. - 2.18
Device.DeviceInfo.ProcessStatus.CPU.{i}. object(0:) R

Each instance in the table represents a CPU on this device. Here CPU can imply main CPU (where system software is executed) or hardware/network acceleration CPU (responsible for data plane traffic).

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

 - 2.18
Alias string(:64) WO

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

The following mandatory constraints MUST be enforced:

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

Once it’s been set, this parameter is immutable.

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

 - 2.18
Name string(:256) R Name of this CPU. This text MUST be sufficient to distinguish this CPU from other CPUs. - 2.18
Enable boolean W

Enables or disables the CPU utilization monitoring.

The default value SHOULD be false.

 - 2.18
UpTime unsignedInt R Time in seconds since the CPU was last restarted. - 2.18
UserModeUtilization unsignedInt(:100) R

CPU utilization, in percent, rounded to the nearest whole percent, while executing at the user level. This includes utilization across all cores.

This value is calculated the same way as CPUUtilization. See CPUUtilization description for more details.

 - 2.18
SystemModeUtilization unsignedInt(:100) R

CPU utilization, in percent, rounded to the nearest whole percent, while executing at the system/kernel level. Note that this includes the time spent servicing interrupts as well. This includes utilization across all cores.

This value is calculated the same way as CPUUtilization. See CPUUtilization description for more details.

 - 2.18
IdleModeUtilization unsignedInt(:100) R

CPU utilization, in percent, rounded to the nearest whole percent, while the CPU was idle.

This value is calculated the same way as CPUUtilization. See CPUUtilization description for more details.

 - 2.18
CPUUtilization unsignedInt(:100) R

CPU utilization, in percent, rounded to the nearest whole percent. The CPU Utilization is calculated as a moving window average of NumSamples CPU utilization samples collected at the PollInterval.

For example, the CPU utilization is calculated as follows: CPU Utilization = (sample1 + sample2 + … + sampleN)/N where N is the number of CPU usage samples as represented by NumSamples and sample1, sample2, …, sampleN are CPU usage samples collected at every PollInterval seconds.

This parameter, which reflects system and user mode CPU utilization, is used to determine if the CPU is in critical condition. This value includes system mode and user mode utilization i.e., everything except idle mode utilization.

 - 2.18
PollInterval unsignedInt W

The interval, measured in seconds, over which the CPU usage is polled.

If the value is 0 then the device selects its own polling interval.

If the value is greater than 0 then the device MUST use this value as the poll interval.

The default value SHOULD be 5.

 - 2.18
NumSamples unsignedInt(1:300) W

This parameter indicates the number of CPU usage samples that is needed to calculate the average CPU utilization and populate the CPUUtilization

The default value SHOULD be 30.

 - 2.18
CriticalRiseThreshold unsignedInt(:100) W

CPU utilization rise threshold percent value. If the CPUUtilization exceeds the rise threshold value and the CriticalFallTimeStamp is greater than CriticalRiseTimeStamp (indicating that critical condition is reached), the following takes place:

The default value SHOULD be 80.

 - 2.18
CriticalFallThreshold unsignedInt(:100) W

CPU utilization fall threshold percent value. If the CPUUtilization falls below fall threshold value and CriticalRiseTimeStamp is greater than CriticalFallTimeStamp (indicating that critical condition is no longer present), the following takes place:

The default value SHOULD be 60.

 - 2.18
CriticalRiseTimeStamp dateTime R Last date and time when the critical condition was reached. See CriticalRiseThreshold description for more details. - 2.18
CriticalFallTimeStamp dateTime R Last date and time when the critical condition is no longer present. See CriticalFallThreshold description for more details. - 2.18
EnableCriticalLog boolean W

This parameter indicates whether a critical log needs to be generated in the vendor log file.

  • If the value of EnableCriticalLog is true, then a critical log is generated in the vendor log file.
  • If the value of EnableCriticalLog is false, then no critical log is generated in the vendor log file.

The default value SHOULD be false.

 - 2.18
VendorLogFileRef string R

The value MUST be the Path Name of a row in the DeviceInfo.VendorLogFile. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The reference to DeviceInfo.VendorLogFile is automatically constructed and the DeviceInfo.VendorLogFile is populated with the information based on FilePath.

E.g. When FilePath = file:///var/log/messages. The following entry is automatically added to DeviceInfo.VendorLogFile: file:///var/log/messages.

 - 2.18
FilePath string W Destination path and filename of where to create and keep the log files which MUST use the uri scheme file [The file URI Scheme/RFC8089]. This file is related to EnableCriticalLog. - 2.18
CPUCriticalState! event - This event is generated indicating critical condition is reached i.e., when the rise threshold is crossed, the event is generated. - 2.18
⇒ CPUUtilization unsignedInt(:100) R CPU utilization, in percent, rounded to the nearest whole percent. - 2.18
⇒ Name string(:256) R Name of this CPU. This text MUST be sufficient to distinguish this CPU from other CPUs. - 2.18
Device.DeviceInfo.Processor.{i}. object(0:) R
Each table entry represents a hardware or virtual processor that resides on this device.
This object was DEPRECATED in 2.18 because the only contained parameter, Architecture, is no longer relevant for modern devices.
At most one entry in this table can exist with a given value for Alias.

Changes in 2.18:

  • Removed dmr_noUniqueKeys = true
  • Added status = deprecated
 - 2.1
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. - 2.17
LastUpgradeCount unsignedInt R Total number of Kernel faults which occuredoccurred since last firmware upgrade. - 2.17
Device.DeviceInfo.KernelFaults.KernelFault.{i}. object(0:) R

Each table entry represents a Kernel fault that is stored on the device.

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

Changes in 2.18:

  • Removed dmr_noUniqueKeys = true
 - 2.17
Alias string(:64) WO

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

The following mandatory constraints MUST be enforced:

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

Once it’s been set, this parameter is immutable.

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

Changes in 2.18:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.17
FirmwareVersion string R The firmewarefirmware version that triggered the Kernel fault. - 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. - 2.17
LastUpgradeCount unsignedInt R Total number of process faults which occuredoccurred since last firmware upgrade. - 2.17
Device.DeviceInfo.ProcessFaults.ProcessFault.{i}. object(0:) R

Each table entry represents a process fault that is stored on the device.

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

Changes in 2.18:

  • Removed dmr_noUniqueKeys = true
 - 2.17
Alias string(:64) WO

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

The following mandatory constraints MUST be enforced:

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

Once it’s been set, this parameter is immutable.

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

Changes in 2.18:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.17
TimeStamp dateTime R The time when the process fault occured.occurred. - 2.17
FirmwareVersion string R The firmware version that triggered the the process fault. - 2.17
Device.DeviceInfo.Reboots. object R The monitoring of reboot reasons is essential for diagnosing and troubleshooting issues with applications and processes running on the Device. - 2.18
BootCount unsignedInt R The number of times the device has rebooted since the last factory reset. - 2.18
CurrentVersionBootCount unsignedInt R The number of times the device has rebooted since the latest firmware update. - 2.18
WatchdogBootCount unsignedInt R

The number of times the device has rebooted by a sw/hw watchdog since the last factory reset.

The watchdog is a component within the operating system kernel or Device responsible for monitoring user-space activities. If it detects non-responsiveness in user-space processes, it triggers a reboot of the device.

 - 2.18
ColdBootCount unsignedInt R The number of times the device has cold rebooted since the last factory reset. - 2.18
WarmBootCount unsignedInt R The number of times the device has warm rebooted since the last factory reset. - 2.18
MaxRebootEntries int(-1:) W

The maximum number of entries available in the Reboot table. Defines the maximum number of Reboot instances that can be stored on the device.

When the maximum Reboot entries as indicated by MaxRebootEntries are reached, the next boot entry overrides the object with the oldest Reboot.{i}.TimeStamp.

Set this parameter to 0 to completely disable the creation of Reboot instances.

Set this parameter to -1 to leave it open to the implementation to decide the maximum number of Reboot instances that may be stored on the device.

Reducing the MaxRebootEntries will cause for the implementation to delete the oldest Reboot instances.

This setting does not affect the counting of reboots.

 - 2.18
RebootNumberOfEntries unsignedInt R The number of entries in the Reboot table. - 2.18
RemoveAllReboots() command - [ASYNC] Removes all the Reboot.{i}. instances from the device, together with the associated data stored on the device. - 2.18
Device.DeviceInfo.Reboots.Reboot.{i}. object(0:) R

Each table entry represents a reboot reason that is stored on the device.

When the maximum Reboot entries as indicated by MaxRebootEntries are reached, the next boot entry overrides the object with the oldest TimeStamp.

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

 - 2.18
Alias string(:64) WO

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

The following mandatory constraints MUST be enforced:

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

Once it’s been set, this parameter is immutable.

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

 - 2.18
TimeStamp dateTime R The time when the reboot occurred. - 2.18
FirmwareUpdated boolean R true if the Device was rebooted as a result of a firmware update; otherwise false. - 2.18
Cause string R

The cause of the boot.

Enumeration of:

  • LocalReboot (A Device. Event that was the result of a reboot triggered locally on the Device (NOT as a result of a Reboot() Command triggered by a remote trigger, e.g. another remote management protocol)}})
  • RemoteReboot (A Device. Event that was the result of a reboot triggered via the Reboot()} Command or other remote trigger, e.g. another remote management protocol)
  • FactoryReset (A Device. Event that was the result of a factory reset triggered locally on the Device or remotely (as a result of a FactoryReset()} Command or other remote trigger, e.g. another remote management protocol), which is to be used when the Agent cannot differentiate between local and remote, added in 2.18)
  • LocalFactoryReset (A Device. Event that was the result of a factory reset triggered locally on the Device (NOT as a result of a FactoryReset()} Command triggered by a remote trigger, e.g. another remote management protocol))
  • RemoteFactoryReset (A Device. Event that was the result of a factory reset triggered via the FactoryReset() Command or other remote trigger, e.g. another remote management protocol)
 - 2.18
Reason string R

The reason of the boot (e.g. power on reset, watchdog, overheat, FAN fault, web userinterface, …).

The default value SHOULD be Unknown.

 - 2.18
Remove() command - [ASYNC] Remove this row from the table, together with the associated data stored on the device. - 2.18
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:

  • Disabled (Indicates that the CPE’s time client services are disabled)
  • Unsynchronized (Indicates that the CPE’s absolute time has not yet been set by any of the configured time clients)
  • Synchronized (Indicates that the CPE has acquired accurate absolute time; its current time is accurate. One or more time client was able to configure the time of the CPE)
  • Error_FailedToSynchronize (

This enumeration was DEPRECATED in 2.16 due to the introduction of Client.

This enumeration was OBSOLETED in 2.18.

Changes in 2.18:

  • Changed status = deprecated ⇒ obsoleted

)

  • Error (MAY be used by the CPE to indicate a locally defined error condition. None of the configured Time clients were able to synchronize the time, OPTIONAL)
 - 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.

Changes in 2.18:

  • Changed status = deprecated ⇒ obsoleted
 - 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.

Changes in 2.18:

  • Changed status = deprecated ⇒ obsoleted
 - 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.

Changes in 2.18:

  • Changed status = deprecated ⇒ obsoleted
 - 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.

Changes in 2.18:

  • Changed status = deprecated ⇒ obsoleted
 - 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.

Changes in 2.18:

  • Changed status = deprecated ⇒ obsoleted
 - 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 can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.16
Servers string[] W Comma-separated list of strings. Points to a CSV list of NTP servers or pools. A NTP server can either be specified as an IP address or a host name. It is expected that the NTP client resolves multiple addresses which can change over time when ResolveAddresses is enabled.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.16
ResolveMaxAddresses unsignedInt W When ResolveAddresses is enabled, This parameter specifies the maxiummaximum number of IP addresses that the NTP client can resolve. 0 means that all addresses must be resolved. 6 2.16
Device.Time.Server.{i}. object(0:) W

This object contains parameters relating to an time 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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.16
Device.Time.Server.{i}.Authentication. object R This object contains parameters relating to enabling security for the NTP Server. - 2.16
NTSNTPServer string[] W Comma-separated list of strings. Points to a CSV list of NTP servers. A NTP server can either be specified as an IP address or a host name. When used the NTS-KE server will tell the remote NTS-KE client the NTP hostname or address of the NTP server(s) that should be used. This allows to seperateseparate the NTP server and NTS-KE server implementation.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.16
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 localylocally 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 can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

Changes in 2.18:

 - 2.16
AllowedRoles string(:256)[] W 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 Users.Role. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Only allow users, defined in Users.User., to access the web instance represented by this HTTPAccess instance that have the following roles assigned that are defined in Users.Role..

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.16
AllowedPathPrefixes string[] W Comma-separated list of strings. Each string must be a partial path which will result in an incoming request being routed to this instance.

Changes in 2.18:

  • Changed default value = / ⇒ [/]
 / 2.16
AllowAllIPv4 boolean W Allow access from any IPv4 address. The source prefixes defined in IPv4AllowedSourcePrefix will be ignored. false 2.18
IPv4AllowedSourcePrefix string[]() W

Comma-separated list (length ) 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.

 - 2.18
AllowAllIPv6 boolean W Allow access from any IPv6 address. The source prefixes defined in IPv6AllowedSourcePrefix will be ignored. false 2.18
IPv6AllowedSourcePrefix string[]() W

Comma-separated list (length ) 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.

 - 2.18
Device.UserInterface.HTTPAccess.{i}.Session.{i}. object(0:) R

Web server session list.

Note: This parameter was demoted to readOnly in the Device:2.17 version.

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

Changes in 2.18:

  • Changed access = readWrite ⇒ readOnly
 - 2.16
User string(:256) R

The value MUST be the Path Name of a row in the Users.User. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The user to whom the session belongs. When the user is unknown an empty string string SHOULD be used.

Note: This parameter was demoted to readOnly in the Device:2.17 version.

Changes in 2.18:

  • Removed string(:256) syntax default
 - 2.16
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.

Changes in 2.18:

  • Changed status = deprecated ⇒ obsoleted
 - 2.0
Device.DSL. object R This object models DSL lines, DSL channels, DSL bonding, and DSL diagnostics. The specific interface objects defined here are Line, Channel, and BondingGroup. Each Line models a layer 1 DSL Line interface, and each Channel models a layer 1 DSL Channel interface where multiple channels can run over a DSL line. In the case where bonding is configured, it is expected that BondingGroup is stacked above the Channel instances within its group. - 2.0
Device.DSL.Diagnostics. object R The DSL Diagnostics object. - 2.0
SELTUER() command -

[ASYNC] This command performs a DSL Single Ended Line Test - Physical Medium Dependent (SELT-PMD) Uncalibrated Echo Response (UER).

This command is for the CPE, aka the Transmission Unit - Remote end (TU-R).

Reference: ITU-T Recommendation [Clause A.2, SELT-PMD management entity/G.996.2].

 - 2.13
⇐ Output. arguments - Output arguments. -
⇐ UER int[2:2][1:4096] R

The Uncalibrated Echo Response (UER) [a(0),b(0)], [a(1),b(1)], …

Comma-separated list (1 to 4096 items) of UERComplexs, with each list item consisting of the following.

[UERComplex] Pair of 32-bit signed integers a(i),b(i) with each pair representing a complex component of the uncalibrated echo response (UER);

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

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

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

The value of UER at frequency i*UERGroupSize*Df = (UERScaleFactor/(231))(a(i)+jb(i))/(231)/(231))(a(i)+jb(i))/(231) where Df = 4.3125 kHz.

This parameter is defined as CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation [Clause A.2.2.1/G.996.2].

 - 2.13
⇐ UERScaleFactor unsignedInt R

The Uncalibrated Echo Response (UER) scale factor.

This parameter is defined as part of the CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation [Clause A.2.2.1/G.996.2].

Note that the scale factor is chosen such that max(abs(a(i)), abs(b(i))) over all i is equal to 2^31231 - 1, which doesn’t allow UERScaleFactor to be zero.

 - 2.13
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 in 2.18:

 - 2.4
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

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.4
Name string(:64) R

The textual name of the optical interface as assigned by the CPE.

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

 - 2.4
LastChange unsignedInt R

The accumulated time in seconds since the optical interface entered its current operational state.

Value Change Notification requests for this parameter MAY be denied.

 - 2.4
MaxBitRate int(-1:) W

The maximum upstream and downstream PHY bit rate supported by this interface (expressed in Mbps).

A value of -1 indicates automatic selection of the maximum bit rate.

 - 2.18
LowerOpticalThreshold int R
Optical level that is used to declare the downstream low received optical power alarm.
[Dbm1000] ::: hide The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.

:::

Valid values are -127.5 dBm (coded as -127500) to 0 dBm (coded as 0) in 0.5 dB increments. The value -127500 indicates the device’s internal policy.
This parameter is based on Lower optical threshold from [Section 9.2.1/G.988].
This parameter was DEPRECATED in 2.15 because it is not intended for the device to raise an optical power alarm.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.4
UpperOpticalThreshold int R
Optical level that is used to declare the downstream high received optical power alarm.
[Dbm1000] ::: hide The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.

:::

Valid values are -127.5 dBm (coded as -127500) to 0 dBm (coded as 0) in 0.5 dB increments. The value -127500 indicates the device’s internal policy.
This parameter is based on Upper optical threshold from [Section 9.2.1/G.988].
This parameter was DEPRECATED in 2.15 because it is not intended for the device to raise an optical power alarm.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.4
LowerTransmitPowerThreshold int R
Minimum mean optical launch power that is used to declare the low transmit optical power alarm.
[Dbm1000] ::: hide The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.

:::

Valid values are -63.5 dBm (coded as -63500) to +63.5 dBm (coded as 63500) in 0.5 dB increments. The value -63500 indicates the device’s internal policy.
This parameter is based on Lower transmit power threshold from [Section 9.2.1/G.988].
This parameter was DEPRECATED in 2.15 because it is not intended for the device to raise an optical power alarm.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.4
UpperTransmitPowerThreshold int R
Maximum mean optical launch power that is used to declare the high transmit optical power alarm.
[Dbm1000] ::: hide The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.

:::

Valid values are -63.5 dBm (coded as -63500) to +63.5 dBm (coded as 63500) in 0.5 dB increments. The value -63500 indicates the device’s internal policy.
This parameter is based on Upper transmit power threshold from [Section 9.2.1/G.988].
This parameter was DEPRECATED in 2.15 because it is not intended for the device to raise an optical power alarm.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.4
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].

Changes in 2.18:

 - 2.4
Reset() command - Reset all this object’s statistics counters to zero. - 2.18
BytesSent unsignedLong R

[StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.4
BytesReceived unsignedLong R

[StatsCounter64] The total number of bytes received on the interface, including framing characters.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.4
PacketsSent unsignedLong R

[StatsCounter64] The total number of packets transmitted out of the interface.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.4
PacketsReceived unsignedLong R

[StatsCounter64] The total number of packets received on the interface.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.4
ErrorsSent unsignedInt R

[StatsCounter32] The total number of outbound packets that could not be transmitted because of errors.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.4
ErrorsReceived unsignedInt R

[StatsCounter32] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.4
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.4
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.4
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 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 (if not supplied by the Controller on creation) 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:

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

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.

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

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

 - 2.0
LastChange unsignedInt R

The accumulated time in seconds since the linkinterface entered its current operational state.

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2].

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 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].

Changes in 2.18:

 - 2.0
Reset() command - Reset all this object’s statistics counters to zero. - 2.18
BytesSent unsignedLong R

[StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
BytesReceived unsignedLong R

[StatsCounter64] The total number of bytes received on the interface, including framing characters.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
PacketsSent unsignedLong R

[StatsCounter64] The total number of packets transmitted out of the interface.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
PacketsReceived unsignedLong R

[StatsCounter64] The total number of packets received on the interface.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
ErrorsSent unsignedInt R

[StatsCounter32] The total number of outbound packets that could not be transmitted because of errors.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
ErrorsReceived unsignedInt R

[StatsCounter32] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
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.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
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.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
UnknownProtoPacketsReceived unsignedInt R

[StatsCounter32] The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
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 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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2].

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 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 in 2.18:

 - 2.0
SupportedLinkModes unsignedInt[] R

Comma-separated list of unsigned integers. Reports the supported link modes. MUST be reported in a compliant way as defined in [IANAifMauTypeListBits/IANAMauMIB]. For example, IANAifMauTypeListBits defines the following link mode types:

  • 1116 (10BASE-T(100BASE-TX full duplex mode)
  • 1426

(100BASE-T4)

  • 15

(1000BASE-SX (100BASE-TX halffull duplex mode)

  • 1630 (100BASE-TX(1000BASE-T full duplex mode)
  • 54 (10GBASE-T)
  • 103 (2.5GBASE-T)
  • 104 (5GBASE-T)
 - 2.16
DuplexMode string W

The duplex mode availablerequested tofor this connection.

Enumeration of:

  • Half
  • Full
  • Auto
 - 2.0
CurrentDuplexMode string R

The duplex mode currently in use by this connection.

Enumeration of:

  • Unknown
  • Half
  • Full
 - 2.18
MDIX string W

Configure the Medium Dependent Interface crossover functionality on the interface.

Enumeration of:

  • Auto
  • On
  • Off

The factory default value MUST be Auto.

 - 2.18
CurrentMDIX string R

The current Medium Dependent Interface crossover setting in use on the interface.

Enumeration of:

  • Unsupported
  • Unknown
  • On
  • Off
 - 2.18
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].

Changes in 2.18:

 - 2.0
Reset() command - Reset all this object’s statistics counters to zero. - 2.18
BytesSent unsignedLong R

[StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
BytesReceived unsignedLong R

[StatsCounter64] The total number of bytes received on the interface, including framing characters.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
PacketsSent unsignedLong R

[StatsCounter64] The total number of Ethernet framespackets transmitted out of the interface.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
PacketsReceived unsignedLong R

[StatsCounter64] The total number of Ethernet framespackets received on the interface.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
ErrorsSent unsignedInt R

[StatsCounter32] The total number of outbound Ethernet framespackets that could not be transmitted because of errors.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
ErrorsReceived unsignedInt R

[StatsCounter32] The total number of inbound Ethernet framespackets that contained errors preventing them from being delivered to a higher-layer protocol.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
MulticastPacketsSent unsignedLong R

[StatsCounter64] The total number of Ethernet framespackets 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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
UnicastPacketsReceived unsignedLong R

[StatsCounter64] The total number of Ethernet framesreceived packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
MulticastPacketsReceived unsignedLong R

[StatsCounter64] The total number of received Ethernet frames,packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
BroadcastPacketsSent unsignedLong R [StatsCounter64] The total number of Ethernet framespackets 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.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
BroadcastPacketsReceived unsignedLong R [StatsCounter64] The total number of received Ethernet frames,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
UnknownProtoPacketsReceived unsignedInt R

[StatsCounter32] The total number of Ethernet framespackets received via the interface which were discarded because of an unknown or unsupported protocol.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
Collisions unsignedLong R

[StatsCounter64] The total number of collisions on the interface.

Value Change Notification requests for this parameter MAY be denied.

 - 2.18
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 can exist with a given value for Alias, or with a given value for Name, or with a given value for MACAddress. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, Name and MACAddress such that the new entry does not conflict with any existing entries.

Changes in 2.18:

  • Added MTU parameter
  • Added NoARP parameter
 - 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:

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

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.

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

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

 - 2.0
LastChange unsignedInt R

The accumulated time in seconds since the linkinterface entered its current operational state.

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2].

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.0
MTU unsignedInt W Maximum Transmission Unit for this interface (expressed in bytes). - 2.18
NoARP boolean W Disables or enables sending of ARP messages on the Ethernet link. If true, the kernel will not send ARP requests and won’t send ARP replies. false 2.18
Device.Ethernet.Link.{i}.Stats. object R

Throughput statistics for this link.interface.

The CPE MUST reset the link’sinterface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the linkinterface becomes operationally down due to a previous administrative down (i.e. the link’sinterface’s Status parameter transitions to a down state after the linkinterface is disabled) or when the linkinterface becomes administratively up (i.e. the link’sinterface’s Enable parameter transitions from false to true). Administrative and operational linkinterface status is discussed in [Section 4.2.2/TR-181i2].

Changes in 2.18:

 - 2.0
Reset() command - Reset all this object’s statistics counters to zero. - 2.18
BytesSent unsignedLong R

[StatsCounter64] The total number of bytes transmitted out of the link,interface, including framing characters.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
BytesReceived unsignedLong R

[StatsCounter64] The total number of bytes received on the link,interface, including framing characters.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
PacketsSent unsignedLong R

[StatsCounter64] The total number of Ethernet framespackets transmitted out of the link.interface.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
PacketsReceived unsignedLong R

[StatsCounter64] The total number of Ethernet framespackets received on the link.interface.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
ErrorsSent unsignedInt R

[StatsCounter32] The total number of outbound Ethernet framespackets that could not be transmitted because of errors.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
ErrorsReceived unsignedInt R

[StatsCounter32] The total number of inbound Ethernet framespackets that contained errors preventing them from being delivered to a higher-layer protocol.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
MulticastPacketsSent unsignedLong R

[StatsCounter64] The total number of Ethernet framespackets 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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
UnicastPacketsReceived unsignedLong R

[StatsCounter64] The total number of received Ethernet frames,packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
MulticastPacketsReceived unsignedLong R

[StatsCounter64] The total number of received Ethernet frames,packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
BroadcastPacketsSent unsignedLong R [StatsCounter64] The total number of Ethernet framespackets 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.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
BroadcastPacketsReceived unsignedLong R [StatsCounter64] The total number of received Ethernet frames,packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
UnknownProtoPacketsReceived unsignedInt R

[StatsCounter32] The total number of Ethernet framespackets received via the linkinterface which were discarded because of an unknown or unsupported protocol.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
PausePacketsSent unsignedLong R

[StatsCounter64] The total number of Ethernet pause frames sent on the link.

Value Change Notification requests for this parameter MAY be denied.

 - 2.18
PausePacketsReceived unsignedLong R

[StatsCounter64] The total number of Ethernet pause frames received on the link.

Value Change Notification requests for this parameter MAY be denied.

 - 2.18
Device.Ethernet.VLANTermination.{i}. object(0:) W

VLAN Termination table (a stackable interface object as described in [Section 4.2/TR-181i2]). A VLAN Termination entry is typically stacked on top of a Link object to receive and send frames with the configured VLANID.

At most one entry in this table 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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

Changes in 2.18:

 - 2.0
Enable boolean W

Enables or disables the VLANTermination entry.interface.

This parameter is based on ifAdminStatus from [RFC2863].

 false 2.0
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

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 VLANTermination entryinterface as assigned by the CPE.

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

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

 - 2.0
LastChange unsignedInt R

The accumulated time in seconds since the VLANTerminationinterface entered its current operational state.

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2].

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.0
VLANPriority int(-1:7) W

The VLAN Priority for this VLANTermination entry, also known as 802.1p Priority, is a 3-bit field used to indicate the priority of network traffic within a VLAN.

A value of -1 indicates that the VLAN priority should not be changed for this VLANTermination.

 - 2.18
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].

Changes in 2.18:

 - 2.0
Reset() command - Reset all this object’s statistics counters to zero. - 2.18
BytesSent unsignedLong R

[StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
BytesReceived unsignedLong R

[StatsCounter64] The total number of bytes received on the interface, including framing characters.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
PacketsSent unsignedLong R

[StatsCounter64] The total number of packets transmitted out of the interface.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
PacketsReceived unsignedLong R

[StatsCounter64] The total number of packets received on the interface.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
ErrorsSent unsignedInt R

[StatsCounter32] The total number of outbound packets that could not be transmitted because of errors.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
ErrorsReceived unsignedInt R

[StatsCounter32] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
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.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
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.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
UnknownProtoPacketsReceived unsignedInt R

[StatsCounter32] The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 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 can exist with a given value for Alias, or with a given value for Name, or with a given value for MACAddress. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, Name and MACAddress such that the new entry does not conflict with any existing entries.

 - 2.12
Enable boolean W

Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

Changes in 2.18:

  • Added boolean syntax false default
 false 2.12
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL)

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 in 2.18:

  • Added string syntax Down default
 Down 2.12
Name string(:64) R

The textual name of the LAG interface as assigned by the CPE.

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

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

 - 2.12
LowerLayers string[](:1024) W

Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string.. See [Section 4.2.1/TR-181i2].

LowerLayers must reference to Device.Ethernet.Interface instances where Link Aggregation Group is configured by the CPE.

For example, “Device.Ethernet.Interface.1, Device.Ethernet.Interface.2”

Changes in 2.18:

  • Added string syntax [] default
 <Empty> 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].

Changes in 2.18:

 - 2.12
Reset() command - Reset all this object’s statistics counters to zero. - 2.18
Device.Ethernet.WoL. object R This object provides access to the WoL (Wake on LAN) funtionality.functionality. - 2.13
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
Device.HPNA.Interface.{i}.QoS. object R QoS configuration object. - 2.0
Device.HPNA.Interface.{i}.QoS.FlowSpec.{i}. object(0:) W

Flow specification table.

The QoS.Classification table is used to classify ingress traffic, where QoS.Classification.{i}.TrafficClass is one of the classification result outputs. This TrafficClass value can be used to look up the appropriate FlowSpec entry (i.e. the FlowSpec entry whose TrafficClasses list contains a matching traffic class).

For enabled table entries, if TrafficClasses is an empty string then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
TrafficClasses unsignedInt[](:256) W Comma-separated list (maximum number of characters 256) of unsigned integers. This list identifies the set of traffic classes associated with this flow spec.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 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
EnhancedPassword string(12:64,0) W

[moca25IfEnhancedPassword/1.3.6.1.4.1.31621.1.3.1.1.1.6] The MoCA Enhanced Password using an ASCII printable character.

This value must be 12 to 64 ASCII printable characters with decimal codes in the range 33 to 126 inclusive. Access is only allowed when used with SNMPv3 protocol, but not allowed when used with SNMPv1 or SNMPv2c protocol.

If this value changes, this node will drop from the network if PrivacyEnabledSetting is true. If this managed object is changed, it may not be possible to change this object again via the SNMP protocol. The mechanism to change this object again is out of the scope of this MIB definition draft.

See [Section 11.3.1/MoCAv2.5].

When read, this parameter returns an empty string, regardless of the actual value.

The factory default value MUST be an empty string.

Changes in 2.18:

  • Removed string(12:64,0) syntax hidden = true
  • Added string(12:64,0) syntax secured = true
 - 2.17
PrivacySupported string[] W

[moca25IfPrivacySupported/1.3.6.1.4.1.31621.1.3.1.1.1.22] [MocaPrivacy] Comma-separated list of Moca Privacys. Controls whether MoCA 2 Enhanced Privacy, MoCA 2.0 privacy, and MoCA 1 privacy are supported when privacy is enabled.

See [Section 11 and Table 17-1/MoCAv2.5].

The factory default value MUST be [moca1Privacy,moca20Privacy,moca2EnhancedPrivacy].

Changes in 2.18:

  • Changed default value = moca1Privacy,moca20Privacy,moca2EnhancedPrivacy ⇒ [moca1Privacy,moca20Privacy,moca2EnhancedPrivacy]
 - 2.17
NetworkState string R

[mocaIfNetworkState/1.3.6.1.4.1.31621.1.2.1.7.1.32] The current Link control state in the MoCA network for the MoCA Node. This network state is a MAC parameter determined by the NC (Network Coordinator) and broadcasted in the MAP to the rest of the MoCA Node.nodes.

beginNodeAdmissionState, newNodeTypeOneProbeTxState, newNodeTypeOneProbeRxState, newGcdDistributionState, beginPhyProfileState, steadyState refer to the Node Admission (see {{bibref: non-existent MoCAv2.5}}). The admission process of a new MoCA node depends on the operation mode of the MoCA Network that it is going to join (MoCA 1 mode, MoCA 2.0 mode or Mixed Mode). The Node Admission process is completed when the NC (Network Controller) changes the network state to Steady State (steadyState) at the end of the Node Admission process.

typeThreeProbeState, lmoTypeOneProbeState, lmoNodeGcdDistributionState, beginLmoPhyProfileState, lmoGcdTypeOneProbeLinkState, steadyState refer to the Regular Link Maintenance Operation (see {{bibref: non-existent MoCAv2.5}}).

alternateChannelQuietLineState, alternateChannelEvmProbeState, unsolicitedProbeReportState, beginUnsolicitedPhyProfileState, rxDeterminedProbeState, steadyState refer to the On-Demand Link Maintenance Operation (see {{bibref: non-existent MoCAv2.5}}).

calibrationState refer to the Network Operation after a Network CoordinatorNC handoff or failover (see {{bibref: non-existent MoCAv2.5}}).

Enumeration of:

  • beginNodeAdmissionState (“Begin Node Admission State” starts after completing the pre-admission discovery message exchange with the NC, then the joining node sends an admission request frame to the NC. During this state, the EVM (Error Vector Magnitude) probes and link acknowledgments are exchanged between the new node, the NC and the existing nodes in the network. Refer to {{bibref: non-existent MoCAv2.5}} for details.)
  • newNodeTypeOneProbeTxState (The NC advances the network state to “New Node Type I Probe Tx State” after receiving next link state indication from all the nodes. During this state, the Beacon Channel (in the presence of MoCA 1 nodes) from the MoCA 2 new nodes to all other existing nodes (including the NC) is characterized and the modulation used on this channel is optimized. The Primary Channel, MoCA 2.x bonded channels from the MoCA 2 new nodes to all other MoCA 2 Nodes (including NC) are characterized and the modulation on these channels is optimized. Refer to {{bibref: non-existent MoCAv2.5}} for details.)
  • newNodeTypeOneProbeRxState (The NC advances the network state to “New Node Type I Probe Rx State” after relaying Type I Probe Reports of all nodes, and after it has received next state indication from each node. Refer to {{bibref: non-existent MoCAv2.5}} for details.)
  • newGcdDistributionState (The NC advances the network state to “New Node GCD Distribution State” once it has received the next state indication from each node to “New Node GCD Distribution State”. In this state, the GCD (Greater Common Denominator) Distribution Reports are distributed. Refer to {{bibref: non-existent MoCAv2.5}} for details.)
  • beginPhyProfileState (The NC advances the network state to “Begin PHY Profile State” when all nodes indicate “Begin PHY Profile State” in their RR (Reservation Request). Upon reception of this state, the node (new or existing) activates the new computed PHY profiles. Refer to {{bibref: non-existent MoCAv2.5}} for details.)
  • steadyState (The node advances to “Steady State” after waiting for T15 or T16 (NC) in beginPhyProfileState. Refer to {{bibref: non-existent MoCAv2.5}} for details. The node advances to “Steady State” after waiting for T15 in beginUnsolicitedPhyProfileState or, in case of NC, after receiving “Steady State” indication from each node. Refer to {{bibref: non-existent MoCAv2.5}}. The node advances to “Steady State” after waiting for T15 or T16 (NC) in beginLmoPhyProfileState. Refer to [Section 8.9.1.7/MoCAv2.5] for details.)
  • typeThreeProbeState (During this first state of the Regular LMO, Type III Probes are exchanged between the LMO node and the rest of nodes. Refer to {{bibref: non-existent MoCAv2.5}} for details.)
  • lmoTypeOneProbeState (After the exchange of the EVM Reports during the state typeThreeProbeState, Type I Probes are exchanged between the LMO node and and all other 1.x nodes. This state finalizes after the LMO node receives the Composite OFDMA Probes from the MoCA 2 Nodes. Refer to {{bibref: non-existent MoCAv2.5}} for details.)
  • lmoNodeGcdDistributionState (After state lmoGcdTypeOneProbeLinkState, the LMO node distributes the new GCD Report to all nodes. Refer to {{bibref: non-existent MoCAv2.5}} for details.)
  • beginLmoPhyProfileState (The NC advances the network state to “Begin LMO PHY Profile State”. When a node receives the “Begin LMO PHY Profile” Link Control state notification, it can start using the newly computed PHY profiles. Refer to {{bibref: non-existent MoCAv2.5}} for details.)
  • lmoGcdTypeOneProbeLinkState (The NC advances the network state to “GCD Type I Probe Link State”. In this state, the LMO node broadcasts GCD Type I Probes to all nodes. For details, refer to {{bibref: non-existent MoCAv2.5}}.)
  • alternateChannelQuietLineState (The node moves into the “Alternate Channel Quite Line State” to measure quiet line noise and interference levels in the alternate MoCA channel. Refer to {{bibref: non-existent MoCAv2.5}} for details.)
  • alternateChannelEvmProbeState (The node moves into the “Alternate Channel EVM Probe State” to measure EVM Probe signal level in the alternate MoCA channel. Refer to {{bibref: non-existent MoCAv2.5}} for details.)
  • unsolicitedProbeReportState (The NC sets the network state to “Unsolicited Probe Report State” after a node request to move to this state in order to update a PHY Profile. Refer to {{bibref: non-existent MoCAv2.5}} for details.)
  • beginUnsolicitedPhyProfileState (After state unsolicitedProbeReportState, a node can begin using the new PHY profiles once the NC sets the network state to “Begin Unsolicited PHY Profile”.{{bibref: non-existent MoCAv2.5}})
  • rxDeterminedProbeState (In order to use Receiver-Determined probes, the receiver must move from steadyState to “Rx Determined Probe State”. Refer to {{bibref: non-existent MoCAv2.5}} for details.)
  • calibrationState (During network operations after switching to a new NC, the NC node sets the network state to “Calibration State”. During this state, any node can request time to perform calibration by sending probes. Refer to {{bibref: non-existent MoCAv2.5}} and [Section 8.14.2/MoCAv2.5].)
 - 2.17
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.MultiAP. object R
This object describes a Wi-Fi network containing 1 or more Access Point devices.
This object is related to a Wi-Fi network that contains multiple Access Points (Multi-AP) and utilizes software logic to optimize that Wi-Fi network (typically via steering STAs, also known as Associated Devices, to the best Access Point). This object exposes the view of the Wi-Fi netwtork from the perspective of the Multi-AP Controller. The Wi-Fi Alliance EasyMesh solution is one example of managing a Multi-AP network.
This object and all sub-objects have been moved to new objects.
This object was DEPRECATED in 2.15 because it has moved to WiFi.DataElements.Network MultiAP objects.
This object was OBSOLETED in 2.17.
This object was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
APDeviceNumberOfEntries unsignedInt R
The number of entries in the APDevice table.
This parameter was DEPRECATED in 2.15 because the APDevice.{i} is being deprecated.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
Device.WiFi.MultiAP.SteeringSummaryStats. object R
The summary of statistics related to Multi-AP Steering for the Wi-Fi network.
The counters contained in SteeringSummaryStats are all reset on reboot.
This object was DEPRECATED in 2.15 because it has moved to DataElements.Network.MultiAPSteeringSummaryStats.
This object was OBSOLETED in 2.17.
This object was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
Device.WiFi.MultiAP.APDevice.{i}. object(0:) R
Each instance of this object represents an individual Access Point device in the Wi-Fi network.
This object was DEPRECATED in 2.15 because ManufacturerOUI and LastContactTime have moved to DataElements.Network.Device.{i}.MultiAPDevice, Backhaul parameters have moved to DataElements.Network.Device.{i}.MultiAPDevice.Backhaul and MACAddress is duplicated in DataElements.Network.Device.{i}.ID. All the rest are deprecated as noted.
This object was OBSOLETED in 2.17.
This object was DELETED in 2.18.
At most one entry in this table can exist with a given value for MACAddress.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
MACAddress string(:17) R
[MACAddress] A unique identifier for this particular device within the Wi-Fi network.
This parameter was DEPRECATED in 2.15 because it has been replaced by DataElements.Network.Device.{i}.ID.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
Manufacturer string R
The manufacturer of the Access Point device (human readable string).
This parameter was DEPRECATED in 2.15 because this information will be part of Data Elements R2.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
ProductClass string(:64) R
Identifier of the class of product for which the serial number applies. That is, for a given manufacturer, this parameter is used to identify the product or class of product over which the SerialNumber parameter is unique.
This value MUST remain fixed over the lifetime of the device, including across firmware updates.
This parameter was DEPRECATED in 2.15 because this information will be part of Data Elements R2.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
SerialNumber string(:64) R
Identifier of the particular Access Point device that is unique for the indicated class of product and manufacturer.
This value MUST remain fixed over the lifetime of the device, including across firmware updates.
This parameter was DEPRECATED in 2.15 because this information will be part of Data Elements R2.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
SoftwareVersion string(:64) R
A string identifying the software version currently installed in the Access Point device (i.e. version of the overall firmware).
To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 3.0.21 where the components mean: Major.Minor.Build.
This parameter was DEPRECATED in 2.15 because this information will be part of Data Elements R2.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
DFSEnable boolean W
Enables or disables Dynamic Frequency Selection (DFS).
This parameter was DEPRECATED in 2.15 because this information will be part of Data Elements R2.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.14
RadioNumberOfEntries unsignedInt R
The number of entries in the Radio table.
This parameter was DEPRECATED in 2.15 because the Radio.{i} is being deprecated.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
Device.WiFi.MultiAP.APDevice.{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.
This object was DEPRECATED in 2.15 because MACAddress is duplicated in DataElements.Network.Device.{i}.Radio.{i}.ID and OperatingFrequencyBand is replaced with DataElements.Network.Device.{i}.Radio.{i}.CurrentOperatingClassProfile.{i}.Class. Channel is duplicated in DataElements.Network.Device.{i}.Radio.{i}.CurrentOperatingClassProfile.{i}.Channel. TransmitPower is duplicated in DataElements.Network.Device.{i}.Radio.{i}.CurrentOperatingClassProfile.{i}.TxPower. The remaining parameters deprecated as noted.
This object was OBSOLETED in 2.17.
This object was DELETED in 2.18.
At most one entry in this table can exist with a given value for MACAddress.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
MACAddress string(:17) R
[MACAddress] A unique identifier for this particular Radio within the identified Access Point.
This parameter was DEPRECATED in 2.15 because it is duplicated in DataElements.Network.Device.{i}.Radio.{i}.ID.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
OperatingFrequencyBand string R

Indicates the frequency band at which the radio is operating. Enumeration of:

  • 2.4GHz
  • 5GHz
  • 6GHz (Added in 2.16)
This parameter was DEPRECATED in 2.15 because it is replaced with DataElements.Network.Device.{i}.Radio.{i}.CurrentOperatingClassProfile.{i}.Class.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
OperatingStandards string[] R

Comma-separated list of strings. List items indicate which IEEE 802.11 standard this Radio instance is configured for. Each list item is an enumeration of:

If OperatingFrequencyBand is set to 2.4GHz, only values b, g, n, ax are applicable.
If OperatingFrequencyBand is set to 5GHz, only values a, n, ac, ax are applicable.
If OperatingFrequencyBand is set to 6GHz, only value ax is allowed.
For example, a value of “g,b” (or “b,g” - order is not important) means that the 802.11g standard [802.11g-2003] is used with a backwards-compatible mode for 802.11b [802.11b-1999]. A value of “g” means that only the 802.11g standard is in use.
This parameter was DEPRECATED in 2.15 because this information cannot be obtained by EasyMesh.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
Channel unsignedInt(1:255) W
The current radio channel used by the connection.
To request automatic channel selection, set Radio.{i}.AutoChannelEnable to true.
Whenever Radio.{i}.AutoChannelEnable is true, the value of the Channel parameter MUST be the channel selected by the automatic channel selection procedure.
For channels in “wide mode” (where a channel bandwidth strictly greater than 20 MHz is used), this parameter is used for Primary Channel only. The secondary or extension channel information is available through ExtensionChannel.
Note: Valid Channel values depend on the OperatingFrequencyBand value specified and the regulatory domain.
This parameter was DEPRECATED in 2.15 because it is replaced with DataElements.Network.Device.{i}.Radio.{i}.CurrentOperatingClassProfile.{i}.Channel.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
ExtensionChannel string R
The secondary extension channel position, applicable when operating in wide channel mode (i.e. when CurrentOperatingChannelBandwidth is 40MHz

If not operating in wide channel mode (i.e. when CurrentOperatingChannelBandwidth is something other than 40MHz, then the value of ExtensionChannel is None. Enumeration of:

  • None
  • AboveControlChannel
  • BelowControlChannel
This parameter was DEPRECATED in 2.15 because this information is not available via EasyMesh.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
PossibleChannels string[](:1024) R
Comma-separated list (maximum number of characters 1024) of strings. List items represent possible radio channels for the wireless standard (a, b, g, n, ac, ax) and the regulatory domain.
Ranges in the form “n-m” are permitted.
For example, for 802.11b and North America, would be “1-11”.
This parameter was DEPRECATED in 2.15 because it is not available via EasyMesh.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.14
CurrentOperatingChannelBandwidth string R

The channel bandwidth currently in use. Enumeration of:

  • 20MHz
  • 40MHz
  • 80MHz
  • 160MHz
This parameter was DEPRECATED in 2.15 because it is not available via EasyMesh.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
MCS int(0:15,16:31) R
The Modulation Coding Scheme index (applicable to 802.11n and 802.11ac specifications only). Values from 0 to 15 MUST be supported ([802.11n-2009]). Values from 0 to 9 MUST be supported for [802.11ac-2013].
This parameter was DEPRECATED in 2.15 because this information is not available in EasyMesh.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
TransmitPower int(-1:100) R
Indicates the current transmit power level as a percentage of full power.
This parameter was DEPRECATED in 2.15 because it is duplicated in DataElements.Network.Device.{i}.Radio.{i}.CurrentOperatingClassProfile.{i}.TxPower.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
TransmitPowerLimit int(-90:36) W
Indicates the maximum Effective Isotropic Radiated Power (EIRP) per 20 MHz bandwidth representing the nominal transmit power limit for this radio. The field is coded in units of dBm relative to 1 mW. [Clause 17.2.15/EasyMesh]
This parameter was DEPRECATED in 2.15 because it is not available in EasyMesh.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.14
APNumberOfEntries unsignedInt R
The number of entries in the AP table.
This parameter was DEPRECATED in 2.15 because the AP.{i}. is being deprecated.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.AP.{i}. object(0:) R
A single logical Access Point operating on this radio.
This object was DEPRECATED in 2.15 because it has moved to DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.MultiAPSteering. except SSID and BSSID which are duplicated in DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}..
This object was OBSOLETED in 2.17.
This object was DELETED in 2.18.
At most one entry in this table can exist with a given value for BSSID.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
AssociatedDeviceNumberOfEntries unsignedInt R
The number of entries in the AssociatedDevice table.
This parameter was DEPRECATED in 2.15 because the AssociatedDevice.{i}. is being deprecated.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.AP.{i}.AssociatedDevice.{i}. object(0:) R
Object describing a single Associated Device (STA).
This object was DEPRECATED in 2.15 because it has moved AssociationTime, Noise into DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.MultiAPSTA. and the remaining parameters are duplicated in DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}. except OperatingStandard which was deprecated as noted.
This object was OBSOLETED in 2.17.
This object was DELETED in 2.18.
At most one entry in this table can exist with a given value for MACAddress.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
OperatingStandard string R

The operating standard that this associated device is connected with. Enumeration of:

This parameter was DEPRECATED in 2.15 because this information cannot be obtained by EasyMesh.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
Active boolean R
Whether or not this associated device is currently present on the Wi-Fi Access Point device.
The ability to list inactive nodes is OPTIONAL. If the Access Point devices includes inactive nodes in this table, Active MUST be set to false for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE.
This parameter was DEPRECATED in 2.15 because this information cannot be obtained by EasyMesh.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
SteeringHistoryNumberOfEntries unsignedInt R
The number of entries in the SteeringHistory table.
This parameter was DEPRECATED in 2.15 because the MultiAP.APDevice.{i}.Radio.{i}.AP.{i}.AssociatedDevice.{i}.SteeringHistory.{i}. is being deprecated.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.AP.{i}.AssociatedDevice.{i}.Stats. object R
Object describing the Statistics for a single Associated Device (STA).
This object was DEPRECATED in 2.15 because it is duplicated in DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}..
This object was OBSOLETED in 2.17.
This object was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.AP.{i}.AssociatedDevice.{i}.SteeringSummaryStats. object R
The summary of statistics related to Multi-AP Steering for an individual STA on the Wi-Fi network.
The counters contained in SteeringSummaryStats are all reset on reboot.
This object was DEPRECATED in 2.15 because it has moved to DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.MultiAPSTA.SteeringSummaryStats..
This object was OBSOLETED in 2.17.
This object was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.AP.{i}.AssociatedDevice.{i}.SteeringHistory.{i}. object(0:) R
The history of Multi-AP Steering for an individual STA on the Wi-Fi network.
The contents of this multi-instance object are reset on reboot.
This object was DEPRECATED in 2.15 because it has moved to DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.MultiAPSTA.SteeringHistory.{i}..
This object was OBSOLETED in 2.17.
This object was DELETED in 2.18.
At most one entry in this table can exist with the same values for all of Time, APOrigin and APDestination.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
Device.WiFi.DataElements. object R This object represents the Wi-Fi Alliance Data Elements as defined in [DataElements] with extended capabilities in additional objects whose names begin with MultiAP. - 2.13
Device.WiFi.DataElements.Network. object R This object describes a Wi-Fi network containing 1 or more Access Point (AP) devices. - 2.13
TimeStamp dateTime R The time this group was collected. Formatted with the date-and-time string format as defined in [Section 3/RFC3339].

Changes in 2.18:

  • Changed syntax = string -> dateTime
 - 2.13
SetPreferredBackhauls() command - [ASYNC] This command sets preferred backhaul links for EasyMesh [EasyMesh] backhaul. - 2.15
⇒ Input. arguments - Input arguments. -
⇒ PreferredBackhauls.{i}. object(1:) W

Indicates preferred backhaul links for EasyMesh [EasyMesh] backhaul. Consists of a table of pairs of MAC addresses. For a WI-Fi connection pair, an entry contains the BSSID and bSTA MAC address. For a wired connection pair, an entry contains the interface MAC addresses. This command applies to all EasyMesh Agent devices in the Wi-Fi network.

Status is to be returned after implementation or failed implementation on all agents/devices/APs in this Multi-AP network.

This table MUST contain at least 1 entry. This table’s Instance Numbers MUST be 1, 2, 3… (assigned sequentially without gaps).

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

 - 2.15
⇒ bSTAMACAddress string(:17) W [MANDATORY] [MACAddress] The MAC address of the backhaul STA (bSTA), or similar Ethernet interface, on this preferred backhaul link.

Changes in 2.18:

  • Added dmr_noNameCheck = true
 - 2.15
Device.WiFi.DataElements.Network.Device.{i}. object(1:) R

Each instance of this object represents an individual EasyMesh Agent or single-AP device in the Wi-Fi network.

This table MUST contain at least 1 entry.

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

 - 2.13
APMetricsWiFi6 boolean R
Associated Wi-Fi6 STA Status Inclusion Policy.
true: Include Associated Wi-Fi6 STA Status TLV in AP Metrics Response.
false: Do not include Associated Wi-Fi6 STA Status TLV [3] in AP Metrics Response.
This parameter was DEPRECATED in 2.16 because it was the same as Radio.{i}.APMetricsWiFi6.
This parameter was OBSOLETED in 2.18.

Changes in 2.18:

  • Changed status = deprecated ⇒ obsoleted
 - 2.15
AssociatedSTAinAPMetricsWiFi6 boolean W
For EasyMesh [EasyMesh], this is the Associated Wi-Fi6 STA Status Inclusion Policy.
true: Include Associated Wi-Fi6 STA Status TLV in AP Metrics Response;
false: Do not include Associated Wi-Fi6 STA Status TLV in AP Metrics Response.
This parameter was DEPRECATED in 2.16 because it was the same as Radio.{i}.APMetricsWiFi6.
This parameter was OBSOLETED in 2.18.

Changes in 2.18:

  • Changed status = deprecated ⇒ obsoleted
 - 2.15
bSTAMLDMaxLinks unsignedInt(0:15) R The maximum number of affiliated bSTAs supported by the bSTAMLD on this EasyMesh Agent. Set to a value between 0 and 14, which is the number of affiliated bSTAs minus 1. The value of 15 is reserved. [EasyMesh] source: Wi-Fi 7 Agent Capabilities TLV.

Changes in 2.18:

  • Added dmr_noNameCheck = true
 - 2.17
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.

Changes in 2.18:

  • Added {OpClass,Channel} uniqueKey Channel parameterRef
 - 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.

Changes in 2.18:

  • Added {OpClass,Channel} uniqueKey Channel parameterRef
 - 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.

Changes in 2.18:

  • Added {OpClass,Channel} uniqueKey Channel parameterRef
 - 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
Device.WiFi.DataElements.Network.Device.{i}.AnticipatedChannelUsage.{i}.Entry.{i}. object(0:) R

This object reports an entry for anticipated channel usage [802.11ax].

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

 - 2.15
Repetitions unsignedInt R

Number of repetitions of the burst of channel usage;

0 = single burst,
2^32-1232-1 = indefinite/unknown.
 - 2.15
Device.WiFi.DataElements.Network.Device.{i}.MultiAPDevice. object R This object represents an individual Access Point device. - 2.15
ManufacturerOUI string(6) R

Organizationally unique identifier of the Access Point device manufacturer. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. Possible patterns:

  • [0-9A-F]{6}
The value MUST be a valid OUI as defined in [OUI].
This value MUST remain fixed over the lifetime of the device, including across firmware updates.
If the instance of this MultiAPDevice is the same as Device., then this parameter is the same as Device.DeviceInfo.ManufacturerOUI.
This parameter was DEPRECATED in 2.18 because it was essentially the same as Manufacturer.

Changes in 2.18:

  • Added status = deprecated
 - 2.15
EasyMeshControllerOperationMode string R

This parameter represents the status of Wi-Fi CERTIFIED EasyMeshTM controller functionality. Enumeration of:

  • NotSupported (Wi-Fi EasyMesh controller is not supported)
  • SupportedNotEnabled (Wi-Fi EasyMesh controller is supported but not enabled)
  • Running (Wi-Fi EasyMesh controller is running)
This parameter was DEPRECATED in 2.18 because it was the same as ControllerOperationMode.

Changes in 2.18:

  • Added status = deprecated
 - 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 - ({{param: non-existent BackhaulDeviceID{{inserted: unexpected argument deprecated after: []}}}}, {{param: non-existent BackhaulMACAddress{{inserted: unexpected argument deprecated after: []}}}}) of the uplinked Backhaul Device - {{param: non-existent MACAddress{{inserted: unexpected argument deprecated after: []}}}} of this Access Point

Device

{{param: reference to deprecated parameter Device.WiFi.DataElements.Network.Device.{i}.MultiAPDevice.Backhaul.BackhaulDeviceID}} / {{param: reference to deprecated parameter Device.WiFi.DataElements.Network.Device.{i}.MultiAPDevice.Backhaul.BackhaulMACAddress}} <– {{param: reference to deprecated parameter Device.WiFi.DataElements.Network.Device.{i}.MultiAPDevice.Backhaul.LinkType}} — < {{param: reference to deprecated parameter Device.WiFi.DataElements.Network.Device.{i}.MultiAPDevice.Backhaul.MACAddress}}

Device.

an empty string is reserved for the Backhaul instance that represents the Multi-AP Controller.

 - 2.15
LinkType string R

The medium being used to backhaul this Access Point Device to the Backhaul Access Point Device. The None value is reserved for the Backhaul instance that represents the Multi-AP Controller. Enumeration of:

  • None
  • Wi-Fi
  • MoCA
  • Ethernet
  • G.hn
  • HPNA
  • HomePlug
  • UPA
This parameter was DEPRECATED in 2.18 because it was essentially the same as BackhaulMediaType.

Changes in 2.18:

  • Added status = deprecated
 - 2.15
BackhaulMACAddress string(:17) R
[MACAddress] The MAC Address at the far end of the backhaul link of the interface on the network that is providing a backhaul for this Access Point Device. This along with {{param: non-existent BackhaulDeviceID{{inserted: unexpected argument deprecated after: []}}}}, helps to identfyidentify the backhaul interface endpoint.
an empty string is reserved for the Backhaul instance that represents the Multi-AP Controller.
This parameter was DEPRECATED in 2.18 because it was the same as BackhaulMACAddress.

Changes in 2.18:

  • Added status = deprecated
 - 2.15
BackhaulDeviceID string(:17) R
[MACAddress] The Device’s ID of the Device on the network that is providing a Backhaul Link for this Access Point Device.
This parameter was DEPRECATED in 2.18 because it was essentially the same as BackhaulALID.

Changes in 2.18:

  • Added status = deprecated
 - 2.15
MACAddress string(:17) R
[MACAddress] The MAC Address at the near end of the backhaul link of this Access Point Device’s backhaul interface that is connecting via {{param: non-existent ##.BackhaulMediaType}} to BackhaulMACAddress of the Backhaul Device identified by BackhaulDeviceID.
This parameter was DEPRECATED in 2.18 because it was the same as Radio.{i}.BackhaulSta.MACAddress.

Changes in 2.18:

  • Added status = deprecated
 - 2.15
Device.WiFi.DataElements.Network.Device.{i}.MultiAPDevice.Backhaul.Stats. object R This object represents the statistics of the backhaul interface view from the current Device’s ID - 2.15
BytesSent unsignedLong R [StatsCounter64] The total number of bytes transmitted across the backhaul medium (as identified by the value of the {{param: non-existent ###.BackhaulMediaType}} parameter), including framing characters.}}}} - 2.15
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received across the backhaul medium (as identified by the value of the {{param: non-existent ###.BackhaulMediaType}} parameter), including framing characters. - 2.15
PacketsSent unsignedLong R [StatsCounter64] The total number of packets transmitted across the backhaul medium (as identified by the value of the {{param: non-existent ###.BackhaulMediaType}} parameter), including framing characters. - 2.15
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets received across the backhaul medium (as identified by the value of the {{param: non-existent ###.BackhaulMediaType}} parameter), including framing characters. - 2.15
LinkUtilization unsignedInt(:100) R Current utilization (expressed in %) of the medium (as identified by the value of the {{param: non-existent ###.BackhaulMediaType}} parameter) being used to backhaul this Access Point device to the Multi-AP Controller. A value of 0 is used for the Stats instance that represents the Access Point on the Multi-AP Controller. - 2.15
SignalStrength unsignedInt(:255) R An indicator of radio signal strength of the backhaul link of the Access Point (AP) to the Multi-AP Controller, measured in dBm. RCPI is encoded per [Table 9-176/802.11-2020]. The value of this parameter is indeterminate if the value of the {{param: non-existent ###.BackhaulMediaType}} parameter is anything other than {{enum: reference to deprecated enumeration Device.WiFi.DataElements.Network.Device.{i}.MultiAPDevice.Backhaul.LinkType.Wi-Fi}}.a type of IEEE 802.11 Wi-Fi. - 2.15
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}. object(1:) R

This object represents all of the individual Radios contained within the identified Access Point device known to the controller.

This table MUST contain at least 1 entry.

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

 - 2.13
Utilization unsignedInt(0:255) R

(Total Channel Utililzation) The percentage of time (linearly scaled with 255 representing 100%) that the Access Point device sensed the medium was busy, as indicated by either the physical or virtual carier sense (CS) mechanism. This is essentially the amount of time spent transmitingtransmitting (both successful and failed transmissions), receiving (both local and non-local transmissions), and processing noise [Section 9.4.2.27/802.11-2020].

When more than one channel is in use for the BSS operating on the radio, the Utilization value is calculated only for the primary channel.

 - 2.13
ReceiveOther unsignedInt(0:255) R

(Receive Non-Local Channel Utilization) The percentage of time (linearly scaled with 255 representing 100%) that the radio has spent on receiving individually or group addressed non-local transmissions (i.e. valid IEEE 802.11 PPDUs that are not associated with any BSS operatinoperating gonon this radio).

When more than one channel is in use for the BSS operating on the radio, the ReceiveOther value is calculated only for the primary channel.

 - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}. object(0:) R The list of neighboring Access Points discovered by a Radio organized per Operating Class and Channel tuple. - 2.14
TimeStamp dateTime R The timestamp of the last scan. Formatted with the date-and-time string format as defined in [Section 3/RFC3339].

Changes in 2.18:

  • Changed syntax = string -> dateTime
 - 2.14
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}. object(0:) R

The Operating Class of neighboring Access Points discovered by a Radio during a channel scan.

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

 - 2.14
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}. object(0:) R

The Channel associated with an Operating Class of neighboring Access Points discovered by a Radio during a channel scan.

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

 - 2.14
TimeStamp dateTime R The timestamp of the last scan of the channel. Formatted with the date-and-time string format as defined in [Section 3/RFC3339].

Changes in 2.18:

  • Changed syntax = string -> dateTime
 - 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
Impact unsignedInt(1:4) R

Scan Impact of using this radio to perform a scan.

1: No impact,
2: Reduced number of spatial streams,
3: Time slicing impairment,
4: Radio unavailable for >= 2 seconds.

Changes in 2.18:

  • Changed 1:4 range maxInclusive = 3 ⇒ 4
  • Added 1:4 range minInclusive = 1
 - 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. - 2.13
HECapabilities base64(4:14) R
Describes the HE capabilities of the radio as defined by the HECapabilities TLV [Section 17.2.10/EasyMesh].
This parameter was DEPRECATED in 2.15 because it is superseded by WiFi6APRole and WiFi6bSTARole.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
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
TimeStamp dateTime R The time this group was collected. Formatted with the date-and-time string format as defined in [Section 3/RFC3339].

Changes in 2.18:

  • Changed syntax = string -> dateTime
 - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}. object(1:) R

A single logical BSS operating on this radio.

This table MUST contain at least 1 entry.

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

 - 2.13
TimeStamp dateTime R The time this group was collected. Formatted with the date-and-time string format as defined in [Section 3/RFC3339].

Changes in 2.18:

  • Changed syntax = string -> dateTime
 - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}. object(1:) R

Object describing a single Associated Device (STA).

This table MUST contain at least 1 entry.

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

 - 2.13
TimeStamp dateTime R The time this group was collected. Formatted with the date-and-time string format as defined in [Section 3/RFC3339].

Changes in 2.18:

  • Changed syntax = string -> dateTime
 - 2.13
HECapabilities base64(4:14) R
Describes the HE capabilities of the Associated Device (STA).
This parameter was DEPRECATED in 2.15 because it is superseded by WiFi6Capabilities.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
LastConnectTime unsignedInt R The time in seconds since this AssocatedAssociated Device (STA) was associated. - 2.13
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.MultiAPSTA. object R

The summary of statistics and operations for an individual STA on the Wi-Fi network.

The counters contained in MultiAPSTA are all reset on reboot.

 - 2.15
AssociationTime dateTime R
Date and time in UTC when the device was associated.
If the instance of this MultiAPSTA is the same as Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}., then this parameter is the same as Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.AssociationTime.
This parameter was DEPRECATED in 2.18 because it was essentially the same as LastConnectTime.

Changes in 2.18:

  • Added status = deprecated
 - 2.15
Noise unsignedInt(:255) R
An indicator of the average radio noise plus interference power measured on the uplink from the Associated Device (STA) to the Access Point (AP).
Encoded as defined for ANPI in [Section 11.10.9.4/802.11-2020].
If the instance of this MultiAPSTA is the same as Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}., then this parameter is the same as Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.Noise.
This parameter was DEPRECATED in 2.18 because it should be the same as Noise.

Changes in 2.18:

  • Added status = deprecated
 - 2.15
Disassociate() command -
[ASYNC] This command represents a request to disassociate this associated device.
This command was DEPRECATED in 2.18 because ClientSteer() and STABlock.{i}. cover the use cases for this (client steering and client blocking).

Changes in 2.18:

  • Added status = deprecated
 - 2.15
⇒ Input. arguments - Input arguments. -
⇒ DisassociationTimer unsignedInt W [MANDATORY] The time for which the associated device is to be disassociated in minutes. If set to 0, then the associated device is blocked indefinately.indefinitely. - 2.15
BTMRequest() command -
[ASYNC] This command requests initiation of a BSS Transition Management (BTM) request to influence this client’s roaming behavior to another BSS as defined in [Section 9.6.13.9/802.11-2020].
This command was DEPRECATED in 2.18 because it is superseded by ClientSteer().

Changes in 2.18:

  • Added status = deprecated
 - 2.15
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.MultiAPRadio. object R This object represents an individual Access Point Radio in the Wi-Fi network. - 2.15
RadarDetections unsignedInt[](:1024) R
Comma-separated list (maximum number of characters 1024) of unsigned integers. List items represent channels in the non-occupancy list due to radars detected by Dynamic Frequency Selection (DFS) Channel Availability Check (CAC).
This parameter was DEPRECATED in 2.18 because it was superseded by CACStatus.{i}..

Changes in 2.18:

  • Added status = deprecated
 - 2.15
FullScan() command -
[ASYNC] This command represents a request to initiate a full scan on this radio, including all channels supported by this radio, for a specific DwellTime and HomeTime. This command will result in updating Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.
If the instance of this MultiAPRadio is the same as Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}, then this command is similar to, Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ChannelScanRequest().
This command was DEPRECATED in 2.18 because is was superseded by ChannelScanRequest() and performed the same function as Radio.{i}.FullScan().

Changes in 2.18:

  • Added status = deprecated
 - 2.15
⇐ Output. arguments - Output arguments. -
⇐ ScanResult.{i}. object(0:) R

The list of neighboring Access Points discovered by a Radio organized per Operating Class and Channel tuple.

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

 - 2.15
⇐ TimeStamp dateTime R The timestamp of the last scan. Formatted with the date-and-time string format as defined in [Section 3/RFC3339].

Changes in 2.18:

  • Changed syntax = string -> dateTime
 - 2.15
⇐ ScanResult.{i}.OpClassScan.{i}. object(0:) R

The Operating Class of neighboring Access Points discovered by a Radio during a channel scan.

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

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

 - 2.15
⇐ 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.

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

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

 - 2.15
⇐ TimeStamp dateTime R The timestamp of the last scan of the channel. Formatted with the date-and-time string format as defined in [Section 3/RFC3339].

Changes in 2.18:

  • Changed syntax = string -> dateTime
 - 2.15
ChannelScan() command -
[ASYNC] This parameter represents a request to initiate a channel scan on this radio on the given channel using a specific DwellTime. This command should result in updating Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.
If the instance of this MultiAPRadio is the same as Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}, then this command is similar to, Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ChannelScanRequest().
This command was DEPRECATED in 2.18 because is was superseded by ChannelScanRequest() and performed the same function as Radio.{i}.ChannelScan().

Changes in 2.18:

  • Added status = deprecated
 - 2.15
⇐ Output. arguments - Output arguments. -
⇐ ScanResult.{i}. object(0:) R

The list of neighboring Access Points discovered by a Radio organized per Operating Class and Channel tuple.

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

 - 2.15
⇐ TimeStamp dateTime R The timestamp of the last scan. Formatted with the date-and-time string format as defined in [Section 3/RFC3339].

Changes in 2.18:

  • Changed syntax = string -> dateTime
 - 2.15
⇐ ScanResult.{i}.OpClassScan.{i}. object(0:) R

The Operating Class of neighboring Access Points discovered by a Radio during a channel scan.

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

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

 - 2.15
⇐ 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.

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

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

 - 2.15
⇐ TimeStamp dateTime R The timestamp of the last scan of the channel. Formatted with the date-and-time string format as defined in [Section 3/RFC3339].

Changes in 2.18:

  • Changed syntax = string -> dateTime
 - 2.15
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}. object(0:) R

Table of Multi-Link Operation (MLO) capable Access Points (APs) on this EasyMesh Agent or Single AP device. [EasyMesh] source: Agent AP MLD Configuration TLV.

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

 - 2.17
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.STAMLD.{i}. object(0:) R

This object describes Multi-Link Operation (MLO) capable stations (STAs), also known as client Multilink Devices (MLDs), associated to this MLO capable Access Point. [EasyMesh] source: Associated Clients TLV.

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

 - 2.17
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.STAMLD.{i}.WiFi7Capabilities. object R This object describes the Wi-Fi 7 capabilities for this STAMLD including Multi-Link Operation (MLO) capabilities. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV.

Changes in 2.18:

  • Removed numEntriesParameter = WiFi7CapabilitiesNumberOfEntries
 - 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.

Changes in 2.18:

  • Added dmr_noNameCheck = true
 - 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.

Changes in 2.18:

  • Added dmr_noNameCheck = true
 - 2.17
Device.WiFi.DataElements.Network.PreferredBackhauls.{i}. object(0:) R

This object specifies the preferred backhaul links as populated by SetPreferredBackhauls().

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

 - 2.17
bSTAMACAddress string(:17) R

[MACAddress] The MAC address of the backhaul Station STA (bSTA), or bSTAMLD, or similar Ethernet interface, on this preferred backhaul link.

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

Changes in 2.18:

  • Added dmr_noNameCheck = true
 - 2.17
Device.WiFi.DataElements.AssociationEvent. object R This object contains the events generated when a STA associates to a BSS. - 2.13
Associated! event - The event is generated when an Associated Device (STA) associates to a BSS. - 2.15
⇒ TimeStamp dateTime R The time this event happened. Formatted with the date-and-time string format as defined in [Section 3/RFC3339].

Changes in 2.18:

  • Changed syntax = string -> dateTime
 - 2.15
⇒ HECapabilities base64(4:14) R
Describes the HE capabilities of the Associated Device (STA).
This parameter was DEPRECATED in 2.16 because it is superseded by WiFi6Capabilities.
This parameter was OBSOLETED in 2.18.

Changes in 2.18:

  • Changed status = deprecated ⇒ obsoleted
 - 2.15
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.
 - 2.13
TimeStamp dateTime R The time this event happened. Formatted with the date-and-time string format as defined in [Section 3/RFC3339].

Changes in 2.18:

  • Changed syntax = string -> dateTime
 - 2.13
HECapabilities base64(4:14) R
Describes the HE capabilities of the Associated Device (STA).
This parameter was DEPRECATED in 2.16 because it is superseded by WiFi6Capabilities.
This parameter was OBSOLETED in 2.18.

Changes in 2.18:

  • Changed status = deprecated ⇒ obsoleted
 - 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
Disassociated! event - The event is generated when an Associated Device (STA) disassociates from a BSS. - 2.15
⇒ TimeStamp dateTime R The time this event happened. Formatted with the date-and-time string format as defined in [Section 3/RFC3339].

Changes in 2.18:

  • Changed syntax = string -> dateTime
 - 2.15
⇒ LastConnectTime unsignedInt R The time in seconds since this AssocatedAssociated Device (STA) was associated. - 2.17
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.
 - 2.13
TimeStamp dateTime R The time this event happened. Formatted with the date-and-time string format as defined in [Section 3/RFC3339].

Changes in 2.18:

  • Changed syntax = string -> dateTime
 - 2.13
LastConnectTime unsignedInt R The time in seconds since this AssocatedAssociated Device (STA) was associated. - 2.17
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
FailedConnection! event - The event is generated when an Associated Device (STA) fails to connect to a BSS. - 2.15
⇒ TimeStamp dateTime R The time this event happened. Formatted with the date-and-time string format as defined in [Section 3/RFC3339].

Changes in 2.18:

  • Changed syntax = string -> dateTime
 - 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.
 - 2.15
TimeStamp dateTime R The time this event happened. Formatted with the date-and-time string format as defined in [Section 3/RFC3339].

Changes in 2.18:

  • Changed syntax = string -> dateTime
 - 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
FullScan() command -

[ASYNC] This command represents a request to initiate a full scan on this radio, including all channels supported by this radio, for a specific DwellTime and HomeTime. This command will result in updating Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.

If the instance of this Radio is the same as Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}, then this command is similar to, Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ChannelScanRequest().

 - 2.15
⇐ Output. arguments - Output arguments. -
⇐ ScanResult.{i}. object(0:) R

The list of neighboring Access Points discovered by a Radio organized per Operating Class and Channel tuple.

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

 - 2.15
⇐ TimeStamp dateTime R The timestamp of the last scan. Formatted with the date-and-time string format as defined in [Section 3/RFC3339].

Changes in 2.18:

  • Changed syntax = string -> dateTime
 - 2.15
⇐ ScanResult.{i}.OpClassScan.{i}. object(0:) R

The Operating Class of neighboring Access Points discovered by a Radio during a channel scan.

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

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

 - 2.15
⇐ 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.

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

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

 - 2.15
⇐ TimeStamp dateTime R The timestamp of the last scan of the channel. Formatted with the date-and-time string format as defined in [Section 3/RFC3339].

Changes in 2.18:

  • Changed syntax = string -> dateTime
 - 2.15
ChannelScan() command -

[ASYNC] This parameter represents a request to initiate a channel scan on this radio on the given channel using a specific DwellTime. This command should result in updating Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.

If the instance of this Radio is the same as Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}, then this command is similar to, Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ChannelScanRequest().

 - 2.15
⇐ Output. arguments - Output arguments. -
⇐ ScanResult.{i}. object(0:) R

The list of neighboring Access Points discovered by a Radio organized per Operating Class and Channel tuple.

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

 - 2.15
⇐ TimeStamp dateTime R The timestamp of the last scan. Formatted with the date-and-time string format as defined in [Section 3/RFC3339].

Changes in 2.18:

  • Changed syntax = string -> dateTime
 - 2.15
⇐ ScanResult.{i}.OpClassScan.{i}. object(0:) R

The Operating Class of neighboring Access Points discovered by a Radio during a channel scan.

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

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

 - 2.15
⇐ 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.

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

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

 - 2.15
⇐ TimeStamp dateTime R The timestamp of the last scan of the channel. Formatted with the date-and-time string format as defined in [Section 3/RFC3339].

Changes in 2.18:

  • Changed syntax = string -> dateTime
 - 2.15
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 can exist with a given value for Alias, or with a given value for Name, or with a given value for BSSID. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, Name and BSSID such that the new entry does not conflict with any existing entries.

 - 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2].

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 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 can exist with a given value for Alias, or with a given value for SSIDReference. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
CpeOperationMode string W

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

Enumeration of:

  • Router (Indicates indicates operation as a router)
  • Bridge/Extender (Indicates operation as a range extender or access point in bridge mode)
 Router 2.14
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}. object(0:) R

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

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

 - 2.0
Noise int(-200:0) R

An indicator of radio noise on the uplink from the associated device to the access point, measured in dBm, as an average of the last 100 packets received from the device (see ANPI definition in [Clause 10.11.9.4/802.11-2012])

If the instance of this AssociatedDevice is the same as Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}., then this parameter is the same as {{param: non-existent Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.MultiAPSTA.Noise{{inserted: unexpected argument deprecated after: []}}}}.

 - 2.12
Device.WiFi.AccessPoint.{i}.AC.{i}. object(4:4) R

This object contains parameters related to WiFi QoS for different 802.11e access categories (priorities). Access categories are: BE, BK, VI, and VO. These parameters can help control and monitor 802.11e Enhanced distributed channel access (EDCA). The size of this table is fixed, with four entries which are identified by the AccessCategory parameter as follows:

  • BE (Best Effort)
  • BK (Background)
  • VI (Video)
  • VO (Voice)

This table MUST contain exactly 4 entries.

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

Changes in 2.18:

  • Added {Alias} uniqueKey
 - 2.8
AIFSN unsignedInt(2:15) W
Arbitration Inter Frame Spacing (Number). This is the number of time slots in the arbitration interframe space.
This parameter was DEPRECATED in 2.15 because it is superseded by the WMM Specification.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.8
ECWMin unsignedInt(0:15) W
Exponent of Contention Window (Minimum). This encodes the values of CWMin as an exponent: CWMin = 2^ECWMin2ECWMin - 1. For example, if ECWMin is 8, then CWMin is 2^828 - 1, or 255, (expressed in microseconds).
This parameter was DEPRECATED in 2.15 because it is superseded by the WMM Specification.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.8
ECWMax unsignedInt(0:15) W
Exponent of Contention Window (Maximum). This encodes the values of CWMax as an exponent: CWMax = 2^ECWMax2ECWMax - 1. For example, if ECWMax is 8, then CWMax is 2^828 - 1, or 255, (expressed in microseconds).
This parameter was DEPRECATED in 2.15 because it is superseded by the WMM Specification.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.8
TxOpMax unsignedInt(0:255) W
Maximum transmit opportunity, in multiples of 32 microseconds. A TXOP time interval of 0 means it is limited to a single MAC protocol data unit (MPDU).
This parameter was DEPRECATED in 2.15 because it is superseded by the WMM Specification.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.8
Device.WiFi.EndPoint.{i}. object(0:) W

This object models an 802.11 connection from the perspective of a wireless end point. Each EndPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter, and an associated active Profile instance via the ProfileReference parameter. The active profile is responsible for specifying the actual SSID and security settings used by the end point.

For enabled table entries, if SSIDReference or ProfileReference is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

Note: The EndPoint table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated EndPoint row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending EndPoint row.

At most one entry in this table can exist with a given value for Alias, or with a given value for SSIDReference. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Device.WiFi.EndPoint.{i}.AC.{i}. object(4:4) R

This object contains parameters related to WiFi QoS for different 802.11e access categories (priorities). Access categories are: BE, BK, VI, and VO. These parameters can help control and monitor 802.11e Enhanced distributed channel access (EDCA). The size of this table is fixed, with four entries which are identified by the AccessCategory parameter as follows:

  • BE (Best Effort)
  • BK (Background)
  • VI (Video)
  • VO (Voice)

This table MUST contain exactly 4 entries.

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

Changes in 2.18:

  • Added {Alias} uniqueKey
 - 2.8
AIFSN unsignedInt(2:15) W
Arbitration Inter Frame Spacing (Number). This is the number of time slots in the arbitration interframe space.
This parameter was DEPRECATED in 2.15 because it is superseded by the WMM Specification.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.8
ECWMin unsignedInt(0:15) W
Exponent of Contention Window (Minimum). This encodes the values of CWMin as an exponent: CWMin = 2^ECWMin2ECWMin - 1. For example, if ECWMin is 8, then CWMin is 2^828 - 1, or 255, (expressed in microseconds).
This parameter was DEPRECATED in 2.15 because it is superseded by the WMM Specification.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.8
ECWMax unsignedInt(0:15) W
Exponent of Contention Window (Maximum). This encodes the values of CWMax as an exponent: CWMax = 2^ECWMax2ECWMax - 1. For example, if ECWMax is 8, then CWMax is 2^828 - 1, or 255, (expressed in microseconds).
This parameter was DEPRECATED in 2.15 because it is superseded by the WMM Specification.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.8
TxOpMax unsignedInt(0:255) W
Maximum transmit opportunity, in multiples of 32 microseconds. A TXOP time interval of 0 means it is limited to a single MAC protocol data unit (MPDU).
This parameter was DEPRECATED in 2.15 because it is superseded by the WMM Specification.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.8
Device.ZigBee. object R Top level object for ZigBee capabilities based on the [ZigBee2007] specification. - 2.7
Device.ZigBee.Interface.{i}. object(0:) R

ZigBee interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the ZigBee interface of a ZigBee end device, ZigBee router or ZigBee coordinator.

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

 - 2.7
Device.ZigBee.Interface.{i}.AssociatedDevice.{i}. object(0:) R

This table provides information about other ZigBee devices that are directly accessible via this interface.

At most one entry in this table can exist with the same values for both IEEEAddress and NetworkAddress.

It is possible that instances of this object have the same key value when the value of IEEEAddress parameter is “FF:FF:FF:FF:FF:FF:FF:FF” and the ZigBee Coordinators on two or more separate area networks assign the same value for the NetworkAddress. This is because the ZigBee specification describes only intra-area network topologies [Section 1.1.4 Network Topology/ZigBee2007]. As such if two or more AssociatedDevice instances have the same key value the implemenationimplementation is undefined.

 - 2.7
Device.ZigBee.ZDO.{i}. object(0:) R

ZigBee Device Object (ZDO) provides management capabilities of the ZigBee Application Support (APS) and Network (NWK) layers of a ZigBee Device as defined in [Section 2.5/ZigBee2007].

At most one entry in this table can exist with the same values for both IEEEAddress and NetworkAddress, or with a given value for Alias.

It is possible that instances of this object have the same key value when the value of IEEEAddress parameter is “FF:FF:FF:FF:FF:FF:FF:FF” and the ZigBee Coordinators on two or more separate area networks assign the same value for the NetworkAddress. This is because the ZigBee specification describes only intra-area network topologies [Section 1.1.4 Network Topology/ZigBee2007]. As such if two or more ZDO instances have the same key value the implemenationimplementation is undefined

Changes in 2.18:

  • Added {Alias} uniqueKey
 - 2.7
Device.ZigBee.ZDO.{i}.PowerDescriptor. object R The PowerDescriptor object describes the power capabilities of the ZigBee device as defined in [Section 2.3.2.4 Node Power Descriptor/ZigBee2007]. - 2.7
AvailablePowerSource string[] R

Specifies the power sources available on this ZigBee device.

Comma-separated list of strings. Each list item is an enumeration of:

  • Constant (Constant (mains) power)
  • Rechargeable (Rechargeable battery)
  • Disposable (Disposable battery)
 - 2.7
CurrentPowerSource string R

The current power source field specifies the current power source being utilized by the node.

Enumeration of:

  • Constant (Constant (mains) power)
  • Rechargeable (Rechargeable battery)
  • Disposable (Disposable battery)
 - 2.7
Device.ZigBee.ZDO.{i}.NodeManager. object R The NodeManager object describes the configuration capabilities related for remote management of the ZigBee Area Network as defined in [Section 2.5.2.6 Node Manager/ZigBee2007]. - 2.7
Device.ZigBee.ZDO.{i}.NodeManager.RoutingTable.{i}. object(0:) R

The RoutingTable object describes the route table as defined in [Table 3.51 Routing Table Entry/ZigBee2007].

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

Changes in 2.18:

  • Removed dmr_noUniqueKeys = true
 - 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 can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) 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 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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.0
LowerLayers string[](:1024) W

Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2].

When ManagementPort is set to true the CPE MUST set LowerLayers to reference all non-management bridge ports that are within the same Bridge instance (and update LowerLayers when subsequent non-management bridge ports are added or deleted on that Bridge). The Controller SHOULD NOT set LowerLayers in this case.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.0
PriorityRegeneration unsignedInt(0:7)[8:8]() W Comma-separated list (8 items) (length ) of unsigned integers (0 to 7). List items represent user priority regeneration values for each ingress user priority on this Bridge Port.

Changes in 2.18:

  • Changed default value = 0,1,2,3,4,5,6,7 ⇒ [0,1,2,3,4,5,6,7]
 0,1,2,3,4,5,6,7 2.0
ServiceAccessPriorityTranslation unsignedInt(0:7)[8:8]() W

Comma-separated list (8 items) (length ) of unsigned integers (0 to 7). List items represent service access priority translation values for each ingress priority on this Port as described in [Section 6.13/802.1Q-2011].

The parameter is applicable to deployments of Bridge instances that are referenced by Bridging.ProviderBridge.{i}.SVLANcomponent.

Changes in 2.18:

  • Changed default value = 0,1,2,3,4,5,6,7 ⇒ [0,1,2,3,4,5,6,7]
 0,1,2,3,4,5,6,7 2.7
Device.Bridging.Bridge.{i}.Port.{i}.PriorityCodePoint. object R

PriorityCodePoint provides the management control for the processing of the Priority Code Point (PCP) field for the 802.1Q header as defined in [Section 6.9.3 Priority Code Point Encoding/802.1Q-2011].

The object is applicable to deployments of Bridging.ProviderBridge where the Bridge instance is referenced by Bridging.ProviderBridge.{i}.SVLANcomponent or Bridging.ProviderBridge.{i}.CVLANcomponents parameters.

 - 2.7
PCPEncoding string(31)[4:4]() W

Comma-separated list (4 items) (length ) of strings (length 31). This parameter provides the management control for the processing of the encoding of the Priority Code Point (PCP) field for the 802.1Q header as defined in [Section 6.9.3 Priority Code Point Encoding/802.1Q-2011] and [Table 6-3/802.1Q-2011].

The list is an ordered list that contains entries for the following 4 PCP Values: “8P0D”,“7P1D”, “6P2D” “5P3D”. Each list entry matches the following pattern:

Each list item matches one of:

  • ([0-7],){15}[0-7] (PCP for each priority and drop_eligible field (7, 7DE, 6, 6DE, …, 1, 1DE, 0, 0DE))

The value of this parameter MUST use square brackets to protect comma separators within nested lists. For example, this corresponds to Table 6-3 (mentioned above):

[7,7,6,6,5,5,4,4,3,3,2,2,1,1,0,0],[7,7,6,6,5,4,5,4,3,3,2,2,1,1,0,0],[7,7,6,6,5,4,5,4,3,2,3,2,1,1,0,0],[7,7,6,6,5,4,5,4,3,2,3,2,1,0,1,0]

Changes in 2.18:

  • Added 4:4 list nestedBrackets = required
 - 2.7
PCPDecoding string(15)[4:4]() W

Comma-separated list (4 items) (length ) of strings (length 15). This parameter provides the management control for the processing of the decoding of the Priority Code Point (PCP) field for the 802.1Q header as defined in [Section 6.9.3 Priority Code Point Encoding/802.1Q-2011] and [Table 6-4/802.1Q-2011].

The list is an ordered list that contains entries for the following 4 PCP Values: “8P0D”,“7P1D”, “6P2D” “5P3D”. Each list entry matches the following pattern:

Each list item matches one of:

  • ([0-7],[0-1],){7}[0-7],[0-1] (Priority (0-7) and drop_eligible field (0-1) for each PCP value (7, 6, …, 1, 0))

The value of this parameter MUST use square brackets to protect comma separators within nested lists. For example, this corresponds to Table 6-4 (mentioned above):

[7,0,6,0,5,0,4,0,3,0,2,0,1,0,0,0],[7,0,6,0,4,0,4,1,3,0,2,0,1,0,0,0],[7,0,6,0,4,0,4,1,2,0,2,1,1,0,0,0],[7,0,6,0,4,0,4,1,2,0,2,1,0,0,0,1]

Changes in 2.18:

  • Added 4:4 list nestedBrackets = required
 - 2.7
Device.Bridging.Filter.{i}. object(0:) W

Filter table containing classification filter entries, each of which expresses a set of classification criterion to classify ingress frames as member of a Bridge instance or a Bridge.{i}.VLAN instance.

Bridge VLAN classification only applies for 802.1Q [802.1Q-2011] Bridges.

For enabled table entries, if Bridge or Interface is an empty string then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

Several of this object’s parameters specify DHCP option values. Some cases are version neutral (the parameter can apply to both DHCPv4 and DHCPv6), but in other cases the representation of the option is different for DHCPv4 and DHCPv6, so it is necessary to define separate DHCPv4-specific and DHCPv6-specific parameters. Therefore, an instance of this object that uses DHCP option values as filter criteria will be associated with either DHCPv4 or DHCPv6, as indicated by the DHCPType parameter.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
EthertypeFilterList unsignedInt[](:256) W

Classification criterion.

Comma-separated list (maximum number of characters 256) of unsigned integers. Each list item represents an Ethertype value.

Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on Ethertype.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.0
SourceMACAddressFilterList string[](:512) W

Classification criterion.

Comma-separated list (maximum number of characters 512) of strings, each representing a MAC Address.

Each list entry MAY optionally specify a bit-mask, where matching of a packet’s MAC address is only to be done for bit positions set to one in the mask. If no mask is specified, all bits of the MAC Address are to be used for matching.

For example, the list might be: 01:02:03:04:05:06, 1:22:33:00:00:00/FF:FF:FF:00:00:00, 88:77:66:55:44:33

Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.0
DestMACAddressFilterList string[](:512) W

Classification criterion.

Comma-separated list (maximum number of characters 512) of strings. Each list item specifies a MAC Address. List items MAY optionally specify a bit-mask after the MAC Address, where matching of a packet’s MAC address is only to be done for bit positions set to one in the mask. If no mask is specified, all bits of the MAC Address are to be used for matching.

For example, the list might be: 01:02:03:04:05:06, 1:22:33:00:00:00/FF:FF:FF:00:00:00, 88:77:66:55:44:33

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.0
SourceMACFromVendorClassIDFilterv6 hexBinary(:65535) W

Classification criterion.

A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCPv6 Vendor Class Identifier (Option 16 as defined in {{bibref: non-existent RFC8415}}) was equal to the specified value. The option value is binary, so an exact match is REQUIRED.

Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address.

Note: This parameter is DHCPv6-specific. It only applies when DHCPType is DHCPv6.

 <Empty> 2.2
DestMACFromVendorClassIDFilterv6 hexBinary(:65535) W

Classification criterion.

A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCPv6 Vendor Class Identifier (Option 16 as defined in {{bibref: non-existent RFC8415}}) was equal to the specified value. The option value is binary, so an exact match is REQUIRED.

Note: This parameter is DHCPv6-specific. It only applies when DHCPType is DHCPv6.

 <Empty> 2.2
SourceMACFromClientIDFilter hexBinary(:65535) W

Classification criterion.

A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCP Client Identifier (via DHCP lease acquisition or renewal for DHCPv4) was equal to the specified value. The DHCP Client Identifier is Option 61 (as defined in [RFC2132]) for DHCPv4, or is Option 1 (as defined in {{bibref: non-existent RFC8415}}) for DHCPv6. The option value is binary, so an exact match is REQUIRED.

Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address.

Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535.

Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType.

Note: DHCPv6 Option 1 (Client Identifier) is sometimes referred to as DUID.

 <Empty> 2.0
DestMACFromClientIDFilter hexBinary(:65535) W

Classification criterion.

A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCP Client Identifier (via DHCP lease acquisition or renewal for DHCPv4) was equal to the specified value. The DHCP Client Identifier is Option 61 (as defined in [RFC2132]) for DHCPv4, or is Option 1 (as defined in {{bibref: non-existent RFC8415}}) for DHCPv6. The option value is binary, so an exact match is REQUIRED.

Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535.

Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType.

Note: DHCPv6 Option 1 (Client Identifier) is sometimes referred to as DUID.

 <Empty> 2.0
SourceMACFromUserClassIDFilter hexBinary(:65535) W

Classification criterion.

A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCP User Class Identifier (via DHCP lease acquisition or renewal for DHCPv4) was equal to the specified value. The DHCP User Class Identifier is Option 77 (as defined in [RFC3004]) for DHCPv4, or is Option 15 (as defined in {{bibref: non-existent RFC8415}}) for DHCPv6. The option value is binary, so an exact match is REQUIRED.

Note that neither 802.1D [802.1D-2004] nor 802.1Q [802.1Q-2011] support classification based on source MAC address.

Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535.

Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType.

 <Empty> 2.0
DestMACFromUserClassIDFilter hexBinary(:65535) W

Classification criterion.

A hexbinary string used to identify one or more devices via DHCP for which MAC address filtering would subsequently apply. A device is considered matching if the most recent DHCP User Class Identifier (via DHCP lease acquisition or renewal for DHCPv4) was equal to the specified value. The DHCP User Class Identifier is Option 77 (as defined in [RFC3004]) for DHCPv4, or is Option 15 (as defined in {{bibref: non-existent RFC8415}}) for DHCPv6. The option value is binary, so an exact match is REQUIRED.

Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535.

Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType.

 <Empty> 2.0
Device.Bridging.ProviderBridge.{i}. object(0:) W

Provider Bridge table.

A Provider Bridge is described in [Section 5.10 Provider Bridge conformance/802.1Q-2011] as an entity that is comprised of one S-VLAN component and zero or more C-VLAN components. S-VLAN and C-VLAN components are modelled as instances of Bridge objects.

When Type is configured with value of PE VLAN tags from the S-VLAN component (outer of 2 VLAN tags) are stacked on top of the VLAN tag from the C-VLAN component (inner of 2 VLAN tags).

When Type is configured with value of S-VLAN only VLAN tags from the S-VLAN component are utilized.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.7
CVLANcomponents string(:256)[] W Comma-separated list of strings (maximum number of characters per item 256). Each list item MUST be the Path Name of a Bridge instance that specifies a C-VLAN component for the ProviderBridge. If the referenced object is deleted, the corresponding item MUST be removed from the list.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.7
Device.PPP. object R Point-to-Point Protocol [RFC1661]. This object contains the Interface table. - 2.0
Device.PPP.Interface.{i}. object(0:) W

PPP interface table (a stackable interface object as described in [Section 4.2/TR-181i2]).

At most one entry in this table 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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.0
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2].

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.0
Device.PPP.Interface.{i}.IPCP. object R IP Control Protocol (IPCP) client object for this PPP interface [RFC1332]. IPCP only applies to IPv4. - 2.0
DNSServers string(:45)[:2]() R [IPv4Address] Comma-separated list (up to 2 items) (length ) of IPv4Addresses. Items represent DNS Server IPv4 address(es) received via IPCP [RFC1877].

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 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 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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.0
LowerLayers string[](:1024) W

Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2].

LowerLayers MUST be an empty string and read-only when Type is Loopback, Tunnel, or Tunneled.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 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, or IPCP. Static entries are created and configured by the Controller.

At most one entry in this table can exist with a given value for Alias, or with the same values for both IPAddress and SubnetMask. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and IPAddress such that the new entry does not conflict with any existing entries.

 - 2.0
AddressingType string R

Addressing method used to assign the IP address. Enumeration of:

Changes in 2.18:

  • Added string 3GPP-NAS enumeration
 Static 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].

Changes in 2.18:

 - 2.0
Reset() command - Reset all this object’s statistics counters to zero. - 2.18
BytesSent unsignedLong R

[StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
BytesReceived unsignedLong R

[StatsCounter64] The total number of bytes received on the interface, including framing characters.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
PacketsSent unsignedLong R

[StatsCounter64] The total number of packets transmitted out of the interface.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
PacketsReceived unsignedLong R

[StatsCounter64] The total number of packets received on the interface.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
ErrorsSent unsignedInt R

[StatsCounter32] The total number of outbound packets that could not be transmitted because of errors.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
ErrorsReceived unsignedInt R

[StatsCounter32] The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
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.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
BroadcastPacketsSent unsignedLong R

[StatsCounter64] The total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent.

Note that IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
BroadcastPacketsReceived unsignedLong R

[StatsCounter64] The total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer.

Note that IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment.

Changes in 2.18:

  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
UnknownProtoPacketsReceived unsignedInt R

[StatsCounter32] The total number of packets received via the interface which were discarded because of an unknown or unsupported protocol.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
Device.IP.Interface.{i}.TWAMPReflector.{i}. object(0:) W

This object contains parameters associated with the configuration that permits this interface to be used as Two-Way Active Measurement Protocol (TWAMP) reflector as defined in [TR-390].

At most one entry in this table can exist with a given value for Alias, or with a given value for Port. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.12
PortAllowedList string[](:255) W

Comma-separated list (maximum number of characters 255) of strings. List items represent source port ranges from which test packets MUST always be received. An empty string list will allow test packets to be received from any source port.

Each entry in the list MUST be either a port number or a range of port numbers separated by a hypenhyphen (-).

For example, an entry with the value: ‘2-40’ accepts test packets from any allowed source IP addresses with a source port between 2 and 40 inclusive. An entry of ‘3’ accepts test packets from allow source IP addresses with a port of 3.

 - 2.12
Device.IP.Interface.{i}.IPv6Address.{i}. object(0:) W

This table contains the IP interface’s IPv6 unicast addresses. There MUST be an entry for each such address, including anycast addresses.

There are several ways in which entries can be added to and deleted from this table, including:

  • Automatically via SLAAC [RFC4862], which covers generation of link-local addresses (for all types of device) and global addresses (for non-router devices).
  • Automatically via DHCPv6 {{bibref: non-existent RFC8415}}, which covers generation of any type of address (subject to the configured DHCP server policy).
  • Manually via a GUI or some other local management interface.
  • Manually via factory default configuration.
  • By the Controller.

This table MUST NOT include entries for the Subnet-Router anycast address [Section 2.6.1/RFC4291]. Such entries would be identical to others but with a zero interface identifier, and would add no value.

A loopback interface will always have address ::1 [Section 2.5.3/RFC4291] and MAY also have link-local address fe80::1.

This object is based on ipAddressTable from [RFC4293].

At most one entry in this table can exist with a given value for Alias, or with a given value for IPAddress. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.2
Origin string R

Mechanism via which the IP address was assigned. Enumeration of:

  • AutoConfigured (Automatically generated. For example, a link-local address as specified by SLAAC [Section 5.3/RFC4862], a global address as specified by SLAAC [Section 5.5/RFC4862], or generated via CPE logic (e.g. from delegated prefix as specified by {{bibref: non-existent RFC8415}}), or from ULA /48 prefix as specified by [RFC4193])
  • DHCPv6 (Assigned by DHCPv6 {{bibref: non-existent RFC8415}})
  • IKEv2 (Assigned by IKEv2 [RFC5996])
  • MAP (Assigned by MAP [RFC7597], i.e. is this interface’s MAP IPv6 address)
  • WellKnown (Specified by a standards organization, e.g. the ::1 loopback address, which is defined in [RFC4291])
  • 3GPP-NAS (Address assigned by the core network (fixed or cellular) using 3GPP NAS signalling methods. e.g. PDU Session Establishment Request [Clause 6.2.4.2/3GPP-TS.24.501], PDN Connectivity Request [Clause 6.2.2/3GPP-TS.24.301], PDP Context Activation Request [Clause 6.1.2A/3GPP-TS.24.008], … This information is available from the AT commands [Clause 10.1.23/3GPP-TS.27.007] PDP context read dynamic parameters +CGCONTRDP, added in 2.18)
  • Static (For example, present in the factory default configuration (but not WellKnown), created by the Controller, or created by some other management entity (e.g. via a GUI))

This parameter is based on ipOrigin from [RFC4293].

Changes in 2.18:

  • Added string 3GPP-NAS enumeration
 Static 2.2
Device.IP.Interface.{i}.IPv6Prefix.{i}. object(0:) W

This table contains the interface’s IPv6 prefixes. There MUST be an entry for each such prefix, not only for prefixes learned from router advertisements.

There are several ways in which entries can be added to and deleted from this table, including:

  • Automatically via [RFC4861] Router Advertisements. See also RouterAdvertisement.
  • Automatically via DHCPv6 {{bibref: non-existent RFC8415}} prefix delegation {{bibref: non-existent RFC8415}}. See also DHCPv6.Client.
  • Automatically via internal CPE logic, e.g. creation of child prefixes derived from a parent prefix.
  • Manually via a GUI or some other local management interface.
  • Manually via factory default configuration.
  • By the Controller.

The CPE MAY choose not to create IPv6Prefix entries for WellKnown prefixes or for the ULA /48 prefix [RFC4193]. If an IPv6Prefix entry exists for the ULA /48 prefix, it MUST be on a downstream interface (i.e. an interface for which the physical layer interface object has Upstream = false).

This object is based on ipAddressPrefixTable from [RFC4293].

At most one entry in this table can exist with a given value for Alias, or with a given value for Prefix. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.2
Origin string R

Mechanism via which the prefix was assigned or most recently updated. Enumeration of:

  • AutoConfigured (Generated via internal CPE logic (e.g. the ULA /48 prefix) or derived from an internal prefix that is not modeled in any IPv6Prefix table)
  • PrefixDelegation (Delegated via DHCPv6 {{bibref: non-existent RFC8415}} or some other protocol, e.g. IPv6rd [RFC5969]. Also see StaticType)
  • RouterAdvertisement (Discovered via router advertisement [RFC4861] Prefix Information Option)
  • WellKnown (Specified by a standards organization, e.g. fe80::/10 for link-local addresses, or ::1/128 for the loopback address, both of which are defined in [RFC4291])
  • Static (Created by the Controller, by some other management entity (e.g. via a GUI), or present in the factory default configuration (but not WellKnown). Unrelated to any shorter length prefix that might exist on the CPE. Also see StaticType. Can be used for RA (Prefix Information), DHCPv6 address assignment (IA_NA) or DHCPv6 prefix delegation (IA_PD))
  • Child (Derived from an associated AutoConfigured or PrefixDelegation parent prefix. Also see StaticType, ParentPrefix and ChildPrefixBits. Can be used for RA (Prefix Information), DHCPv6 address assignment (IA_NA) or DHCPv6 prefix delegation (IA_PD))

Note that:

  • PrefixDelegation and RouterAdvertisement prefixes can exist only on upstream interfaces (i.e. interfaces for which the physical layer interface object has Upstream = true),
  • AutoConfigured and WellKnown prefixes can exist on any interface, and
  • Static and Child prefixes can exist only on downstream interfaces (i.e. interfaces for which the physical layer interface object has Upstream = false).

Also note that a Child prefix’s ParentPrefix will always be an AutoConfigured, PrefixDelegation, or RouterAdvertisement prefix.

This parameter is based on ipAddressOrigin from [RFC4293].

 Static 2.2
Device.IP.Diagnostics. object R The IP Diagnostics object. - 2.0
UploadDiagnostics() command -

[ASYNC] This command defines the diagnostics configuration for a HTTP or FTP UploadDiagnostics test.

Files sent by the UploadDiagnostics do not require file storage on the CPE device, and MAY be an arbitrary stream of bytes.

 - 2.12
⇐ Output. arguments - Output arguments. -
⇐ TestBytesSent unsignedLong R [StatsCounter64] The number of bytes of the test file sent during the FTP/HTTP transaction including FTP/HTTP headers, between BOMTime and EOMTime acrosssacross all connections. - 2.12
IPLayerCapacity() command -

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

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

 - 2.14
⇒ Input. arguments - Input arguments. -
⇒ TimeoutNoTraffic unsignedInt(5:30) W
Timeout value. Value specified in seconds. The default value SHOULD be 5 seconds.
This parameter was DEPRECATED in 2.15 because it is superseded by TimeoutNoTestTraffic due to new precision requirement. Refer to [TR-471] for details.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.14
⇐ Output. arguments - Output arguments. -
⇐ MaxIPLayerCapacity decimal R The maximum IP-Layer Capacity metric from among all IncrementalResult.{i}.IPLayerCapacity values measured between BOMTime and EOMTime across all connections for this test. This is calculated according to [TR-471] Equation 1. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6106 bits/second = 1 Mbps. - 2.14
⇐ MaxETHCapacityNoFCS decimal R Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with Preamble and Inter-frame gap, but no ETH Frame Check Sequence. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6106 bits/second = 1 Mbps. - 2.15
⇐ MaxETHCapacityWithFCS decimal R Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with ETH Frame Check Sequence. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second106 bits/second = 1 Mbps. - 2.15
⇐ MaxETHCapacityWithFCSVLAN decimal R Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with ETH Frame Check Sequence and VLAN tag. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second106 bits/second = 1 Mbps. - 2.15
⇐ InterfaceEthMbpsAtMax decimal R The number of bits observed on the Interface during an IP-Layer Capacity test for time interval of duration TestSubInterval ending at IncrementalResult.{i}.TimeOfSubInterval corresponding to the MaxIPLayerCapacity, divided by the duration of TestSubInterval. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6106 bits/second = 1 Mbps. This is primarily a diagnostic measurement. Measurement direction follows the Role. - 2.15
⇐ IPLayerCapacitySummary decimal R The IP-Layer Capacity metric from among all IncrementalResult.{i}.IPLayerCapacity values measured between BOMTime and EOMTime across all connections for this test. This is calculated according to [TR-471] Equation 1. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6106 bits/second = 1 Mbps. - 2.15
⇐ InterfaceEthMbpsSummary decimal R The number of bits observed on the Interface during an IP-Layer Capacity test for the entire time interval of duration TestInterval, divided by the duration of TestInterval. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6106 bits/second = 1 Mbps. This is primarily a diagnostic measurement. Measurement direction follows the Role. - 2.15
⇐ ModalResult.{i}. object(1:) R

Modal test results. Only returned when bimodal test mode is enabled (NumberFirstModeTestSubIntervals >=1). If returned, it MUST contain 1 or more entries, with instance number 1 corresponding to the second mode and instance number 2 corresponding to the third mode.

Results for the Maximum in each mode/instance are calculated based on IncrementalResult.{i}. data within the boundary of its corresponding mode.

This table MUST contain at least 1 entry. This table’s Instance Numbers MUST be 1, 2, 3… (assigned sequentially without gaps).

 - 2.15
⇐ MaxIPLayerCapacity decimal R The maximum IP-Layer Capacity metric from among all IncrementalResult.{i}.IPLayerCapacity values within corresponding mode across all connections for this test. This is calculated according to [TR-471] Equation 1. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second106 bits/second = 1 Mbps. - 2.15
⇐ MaxETHCapacityNoFCS decimal R Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with Preamble and Inter-frame gap, but no ETH Frame Check Sequence. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second106 bits/second = 1 Mbps. - 2.15
⇐ MaxETHCapacityWithFCS decimal R Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with ETH Frame Check Sequence. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second106 bits/second = 1 Mbps. - 2.15
⇐ MaxETHCapacityWithFCSVLAN decimal R Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with ETH Frame Check Sequence and VLAN tag. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second106 bits/second = 1 Mbps. - 2.15
⇐ InterfaceEthMbpsAtMax decimal R The number of bits observed on the Interface during an IP-Layer Capacity test for time interval of duration TestSubInterval ending at IncrementalResult.{i}.TimeOfSubInterval corresponding to the MaxIPLayerCapacity, divided by the duration of TestSubInterval. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6106 bits/second = 1 Mbps. This is primarily a diagnostic measurement. Measurement direction follows the Role. - 2.15
⇐ IncrementalResult.{i}. object(0:) R

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

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

 - 2.14
⇐ IPLayerCapacity decimal R Results of measurements using the maximum IP-Layer Capacity metric calculation for a single interval from [TR-471] Equation 1, for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6106 bits/second = 1 Mbps. - 2.14
⇐ InterfaceEthMbps decimal R The number of bits observed on the Interface during an IP-Layer Capacity test for time interval of duration TestSubInterval ending at TimeOfSubInterval, divided by the duration of TestSubInterval. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6106 bits/second = 1 Mbps. This is primarily a diagnostic measurement. Measurement direction follows the Role. - 2.15
Device.IPsec. object R

IPsec [RFC4301] object that supports the configuration of Encapsulating Security Payload (ESP) [RFC4303] and Authentication Header (AH) [RFC4302] in tunnel mode [Section 3.2/RFC4301].

Use of IKEv2 [RFC5996] is assumed. The IPsec object does not currently support static configuration of tunnels and child Security Associations (SAs).

See the IPsec Theory of Operation [Appendix IX/TR-181i2] for a description of the working of this IPsec data model.

 - 2.5
Device.IPsec.Profile.{i}. object(0:) W

Profile table that represents the IPsec Security Policy Database (SPD) [Section 4.4.1/RFC4301] processing info. Each entry defines the IPsec treatment for packets that match the Filter entries that reference the entry.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.5
AHAllowedIntegrityAlgorithms string[] W Comma-separated list of strings. Each list item MUST be a member of the list reported by the IPsec.SupportedIntegrityAlgorithms parameter. Allowed AH integrity algorithms [Transform Type 3/IKEv2-params] [Section 3.2/RFC4835].

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.5
ESPAllowedIntegrityAlgorithms string[] W Comma-separated list of strings. Each list item MUST be a member of the list reported by the IPsec.SupportedIntegrityAlgorithms parameter. Allowed ESP integrity algorithms [Transform Type 3/IKEv2-params] [Section 3.1.1/RFC4835].

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.5
Device.IPsec.IKEv2SA.{i}. object(0:) R

Represents an IKEv2 Security Association (SA), corresponding to an IKEv2 session. Instances are automatically created and deleted as IKEv2 SAs are created and deleted.

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

Changes in 2.18:

  • Removed dmr_noUniqueKeys = true
  • Added {Alias} uniqueKey
 - 2.5
Device.IPsec.IKEv2SA.{i}.ChildSA.{i}. object(0:) R

Represents a child Security Association (SA) pair, i.e. an inbound child SA and an outbound child SA.

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

Changes in 2.18:

  • Added {Alias} uniqueKey
 - 2.5
Device.MAP. object R

The Mapping of Address and Port (MAP) object [RFC7597] [RFC7599] [RFC7598]. This object applies only to gateway devices that support IPv4 on the LAN side, include a NAT, and typically have only IPv6 connectivity on the WAN side.

See the MAP Theory of Operation [Appendix XV/TR-181i2] for a description of the working of this MAP data model.

 - 2.8
Device.MAP.Domain.{i}. object(0:) W

MAP domain settings [RFC7597] [RFC7599]. Each instance models a MAP domain.

MAP supports two transport modes, both of which use NAPT44 (modified to use a restricted port range):

Note: There is an n:1 relationship between a MAP domain and the associated WANInterface, i.e. in theory multiple MAP domains can be associated with a single WAN IP interface (each domain would have its own End-user IPv6 prefix and MAP IPv6 address).

Note: The Domain table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Domain row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending Domain row.

At most one entry in this table can exist with a given value for Alias, or with the same values for both WANInterface and IPv6Prefix. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, WANInterface and IPv6Prefix such that the new entry does not conflict with any existing entries.

 - 2.8
PSIDOffset unsignedInt(0:15) W
Port-set ID (PSID) offset in bits. The number of Port-sets is 2^PSIDOffset.^.
Corresponds to the [RFC7598] S46_PORTPARAMS (Port Parameters) option’s offset field.
This parameter was DEPRECATED in 2.12 because details changed between drafting this data model and the RFC being published. This parameter has been moved to the proper location within the Rule.{i}. object.
This parameter was OBSOLETED in 2.14-2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 6 2.8
PSIDLength unsignedInt(0:16) W
The length in bits of the Port-set id (PSID) configured in the PSID parameter.
Corresponds to the [RFC7598] S46_PORTPARAMS (Port Parameters) option’s PSID-len field.
This parameter was DEPRECATED in 2.12 because details changed between drafting this data model and the RFC being published. This parameter has been moved to the proper location within the Rule.{i}. object.
This parameter was OBSOLETED in 2.14-2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 0 2.8
PSID unsignedInt(0:65535) W
Port-set ID (PSID) to use in preference to the value extracted from the Embedded Address (EA) bits.
Only the high order PSIDLength bits of the PSID value are used, so the parameter is ignored when PSIDLength is zero.
Corresponds to the [RFC7598] S46_PORTPARAMS (Port Parameters) option’s PSID field.
This parameter was DEPRECATED in 2.12 because details changed between drafting this data model and the RFC being published. This parameter has been moved to the proper location within the Rule.{i}. object.
This parameter was OBSOLETED in 2.14-2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 0 2.8
IncludeSystemPorts boolean W
Whether to include low-numbered (system) ports in the Port-sets. Normally ports in the range 0:2^(16-PSIDOffset[)-1][)^-1]] are excluded, e.g. for the default PSIDOffset value of 6, ports [0:1023] are not included in the Port-sets.
This parameter is related to [RFC7597]’s N, which is defined as the number of ports (e.g., 1024) excluded from the lower end of the range. The parameter is relevant only when PSIDOffset is 0; false corresponds to N=1024 and true corresponds to N=0.
This parameter was DEPRECATED in 2.15 because details changed between drafting this data model and the RFC being published. This parameter has been moved to the proper location within the Rule.{i}. object.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 false 2.8
Device.MAP.Domain.{i}.Rule.{i}. object(0:) W

The MAP domain’s Mapping Rules [RFC7597]. The rule with the longest match between its IPv6Prefix and the end-user IPv6Prefix is the Basic Mapping Rule (BMR). Any of the rules (including the BMR) can be a Forwarding Mapping Rule.

At most one entry in this table can exist with a given value for Alias, or with a given value for IPv6Prefix, or with a given value for IPv4Prefix. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.8
PSIDOffset unsignedInt(0:15) W

Port-set ID (PSID) offset in bits. The number of Port-sets is 2^PSIDOffset.^.

Corresponds to the [RFC7598] S46_PORTPARAMS (Port Parameters) option’s offset field.

 6 2.12
IncludeSystemPorts boolean W

Whether to include low-numbered (system) ports in the Port-sets. Normally ports in the range 0:2^(16-PSIDOffset[)-1][)^-1]] are excluded, e.g. for the default PSIDOffset value of 6, ports [0:1023] are not included in the Port-sets.

This parameter is related to [RFC7597]’s N, which is defined as the number of ports (e.g., 1024) excluded from the lower end of the range. The parameter is relevant only when PSIDOffset is 0; false corresponds to N=1024 and true corresponds to N=0.

 false 2.15
Device.MAP.Domain.{i}.Interface. object R MAP interface (a stackable interface object as described in [Section 4.2/TR-181i2]). This models the LAN side MAP domain interface. - 2.8
Alias string(:64) WO
[Alias] ::: hide A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.
The following mandatory constraints MUST be enforced:
  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an “cpe-” prefix.

:::

This parameter was DEPRECATED in 2.18 because Domain already has an Alias parameter.
Once it’s been set, this parameter is immutable.

Changes in 2.18:

  • Added status = deprecated
 - 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 can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) 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 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:

  • Only enabled table entries with a matching ForwardingPolicy are considered, i.e. those that either do not specify a ForwardingPolicy, or else specify a ForwardingPolicy that matches that of the incoming packet.
  • Next, table entries that also have a matching destination address/mask are considered, and the matching entry with the longest prefix is applied to the packet (i.e. the entry with the most specific network). An unspecified destination address is a wild-card and always matches, but with a prefix length of zero.

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 can exist with a given value for Alias, or with the same values for all of DestIPAddress, DestSubnetMask, ForwardingPolicy, GatewayIPAddress, Interface and ForwardingMetric. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Origin string R

Protocol via which the IPv4 forwarding rule was learned. Enumeration of:

  • DHCPv4
  • OSPF
  • IPCP
  • RIP
  • 3GPP-NAS (Assigned by the core network (fixed or cellular) using 3GPP NAS signalling methods. e.g. PDU Session Establishment Request, PDN Connectivity Request, PDP Context Activation Request, … This information is available from the AT commands [Clause 10.1.23/3GPP-TS.27.007] PDP context read dynamic parameters +CGCONTRDP, added in 2.18)
  • Static (For example, present in the factory default configuration, created by the Controller, or created by some other management entity (e.g. via a GUI))

Changes in 2.18:

  • Added string 3GPP-NAS enumeration
 Static 2.2
Device.Routing.Router.{i}.IPv6Forwarding.{i}. object(0:) W

Layer 3 IPv6 forwarding table.

In addition to statically configured routes, this table MUST include dynamic routes learned through layer 3 routing protocols, including RIPng, OSPF, DHCPv6, 3GPP-NAS, and RA. The CPE MAY reject attempts to delete or modify a dynamic route entry.

For each incoming packet, the layer 3 forwarding decision is conceptually made as follows:

  • Only enabled table entries with a matching ForwardingPolicy are considered, i.e. those that either do not specify a ForwardingPolicy, or else specify a ForwardingPolicy that matches that of the incoming packet.
  • Next, table entries that also have a matching destination prefix are considered, and the matching entry with the longest prefix length is applied to the packet (i.e. the entry with the most specific network). An unspecified destination address is a wild-card and always matches, but with a prefix length of zero.

For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

This object is based on inetCidrRouteTable from [RFC4292].

At most one entry in this table can exist with a given value for Alias, or with the same values for all of DestIPPrefix, ForwardingPolicy, NextHop, Interface and ForwardingMetric. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.2
Origin string R

Protocol via which the IPv6 forwarding rule was learned. Enumeration of:

  • DHCPv6
  • OSPF
  • RA (Router Advertisement Route Information Option [RFC4191])
  • RIPng (RIPng for IPv6 [RFC2080])
  • 3GPP-NAS (Address assigned by the core network (fixed or cellular) using 3GPP NAS signalling methods. e.g. PDU Session Establishment Request, PDN Connectivity Request, PDP Context Activation Request, … This information is available from the AT commands [Clause 10.1.23/3GPP-TS.27.007] PDP context read dynamic parameters +CGCONTRDP, added in 2.18)
  • Static (For example, present in the factory default configuration, created by the Controller, or created by some other management entity (e.g. via a GUI))

Changes in 2.18:

  • Added string 3GPP-NAS enumeration
 Static 2.2
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.Route.{i}. object(0:) R

This object provides parameters for routes recievedreceived from neighbors and internal routes.

At most one entry in this table can exist with the same values for both RoutePrefix and SourceRouterID.

 - 2.15
Device.RouterAdvertisement. object R

The Router Advertisement (RA) object [RFC4861]. This object applies only to IPv6. It contains an InterfaceSetting table that defines the RA configuration for individual IP interfaces.

Information received via router advertisement messages is automatically propagated to the relevant IP.Interface sub-objects, e.g. to the IP.Interface.{i}.IPv6Address and IP.Interface.{i}.IPv6Prefix tables.

 - 2.2
Device.RouterAdvertisement.InterfaceSetting.{i}. object(0:) W

Per-interface Router Advertisement (RA) configuration [RFC4861]. Table entries are created for use in sending Router Advertisements.

For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

Note: The InterfaceSetting table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated InterfaceSetting row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending InterfaceSetting row.

At most one entry in this table can exist with a given value for Alias, or with a given value for Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.2
RDNSS string(:45)[] W

[IPv6Address] Comma-separated list of IPv6Addresses. The RDNSS parameter contains one or more IPv6 addresses of RDNSSes as described in [Section 5.1. Recursive DNS Server Option/RFC8106].

When RDNSSMode is not Static, this parameter will contain the list of IPv6 addresses, automatically filled in by the system, that needs to be advertised.

An empty string means that no RDNSS information is being advertised.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.17
DNSSL string[] W

Comma-separated list of strings. The DNSSL parameter contains one or more domain names of DNS suffixes as described in [Section 5.2. DNS Search List Option/RFC8106].

An empty string means that no DNSSL information is being advertised.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.17
ManualPrefixes string[:8]() W

Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list.

Manually-configured prefixes that will be sent in Router Advertisement messages. Each referenced prefix MUST have a IP.Interface.{i}.IPv6Prefix.{i}.StaticType of Static or Child. Router Advertisement messages MUST include Prefix Information Options [RFC4861] for all Valid (IP.Interface.{i}.IPv6Prefix.{i}.ValidLifetime is infinite or in the future) prefixes in this list.

Prefixes MUST be associated with the interface instance referenced by Interface.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.2
AdvManagedFlag boolean W The value placed in the “Managed address configuration” (M) flag field of Router Advertisement messages on this interafceinterface (see [Section 4.2/RFC4861], and [RFC4862]). false 2.2
Device.DSLite. object R

Settings allowing a CPE to configure and route IPv6 Dual-Stack Lite (DSLite) as specified in [DSLite]. The DS-Lite mechanism is intended to be implemented only on gateway devices that support IPv4 on the LAN side and only have IPv6 connectivity on the WAN side.

See the Dual-Stack Lite Theory of Operation [Appendix VII/TR-181i2] for a description of the working of this DS-Lite data model.

 - 2.2
Device.DSLite.InterfaceSetting.{i}. object(0:) R

DSLite [DSLite] settings.

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

 - 2.2
Origin string R

Method used to assign EndpointAddressInUse.

Enumeration of:

  • DHCPv6 (Assigned by DHCPv6 {{bibref: non-existent RFC8415}})
  • Static (For example, present in the factory default configuration, set by the Controller, or set by some other management entity (e.g. via a GUI))
 - 2.2
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 can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
SourceVendorClassIDv6 hexBinary(:65535) W

Classification criterion.

A hexbinary string used to identify one or more LAN devices, value of the DHCPv6 Vendor Class Identifier (Option 16) as defined in {{bibref: non-existent RFC8415}}. The option value is binary, so an exact match is REQUIRED.

An empty string indicates this criterion is not used for classification.

Note: This parameter is DHCPv6-specific. It only applies when DHCPType is DHCPv6.

 <Empty> 2.2
DestVendorClassIDv6 hexBinary(:65535) W

Classification criterion.

A hexbinary string used to identify one or more LAN devices, value of the DHCPv6 Vendor Class Identifier (Option 16) as defined in {{bibref: non-existent RFC8415}}. The option value is binary, so an exact match is REQUIRED.

An empty string indicates this criterion is not used for classification.

Note: This parameter is DHCPv6-specific. It only applies when DHCPType is DHCPv6.

 <Empty> 2.2
SourceClientID hexBinary(:65535) W

Classification criterion.

A hexbinary string used to identify one or more LAN devices, value of the DHCP Client Identifier. The DHCP Client Identifier is Option 61 (as defined in [RFC2132]) for DHCPv4, or is Option 1 (as defined in {{bibref: non-existent RFC8415}}) for DHCPv6. The option value is binary, so an exact match is REQUIRED.

An empty string indicates this criterion is not used for classification.

Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535.

Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType.

Note: DHCPv6 Option 1 (Client Identifier) is sometimes referred to as DUID.

 <Empty> 2.0
DestClientID hexBinary(:65535) W

Classification criterion.

A hexbinary string used to identify one or more LAN devices, value of the DHCP Client Identifier. The DHCP Client Identifier is Option 61 (as defined in [RFC2132]) for DHCPv4, or is Option 1 (as defined in {{bibref: non-existent RFC8415}}) for DHCPv6. The option value is binary, so an exact match is REQUIRED.

An empty string indicates this criterion is not used for classification.

Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535.

Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType.

Note: DHCPv6 Option 1 (Client Identifier) is sometimes referred to as DUID.

 <Empty> 2.0
SourceUserClassID hexBinary(:65535) W

Classification criterion.

A hexbinary string used to identify one or more LAN devices, value of the DHCP User Class Identifier. The DHCP User Class Identifier is Option 77 (as defined in [RFC3004]) for DHCPv4, or is Option 15 (as defined in {{bibref: non-existent RFC8415}}) for DHCPv6. The option value is binary, so an exact match is REQUIRED.

An empty string indicates this criterion is not used for classification.

Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535.

Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType.

 <Empty> 2.0
DestUserClassID hexBinary(:65535) W

Classification criterion.

A hexbinary string used to identify one or more LAN devices, value of the DHCP User Class Identifier. The DHCP User Class Identifier is Option 77 (as defined in [RFC3004]) for DHCPv4, or is Option 15 (as defined in {{bibref: non-existent RFC8415}}) for DHCPv6. The option value is binary, so an exact match is REQUIRED.

An empty string indicates this criterion is not used for classification.

Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535.

Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType.

 <Empty> 2.0
SourceVendorSpecificInfo hexBinary(:65535) W

Classification criterion.

A hexbinary string used to identify one or more LAN devices, value of the DHCP Vendor-specific Information, matched according to the criteria in SourceVendorSpecificInfoEnterprise and SourceVendorSpecificInfoSubOption. The DHCP Vendor-specific Information is Option 125 (as defined in [RFC3925]) for DHCPv4, or is Option 17 (as defined in {{bibref: non-existent RFC8415}}) for DHCPv6.

An empty string indicates this criterion is not used for classification.

Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535.

Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType.

 <Empty> 2.0
DestVendorSpecificInfo hexBinary(:65535) W

Classification criterion.

A hexbinary string used to identify one or more LAN devices, value of the DHCP Vendor-specific Information, matched according to the criteria in DestVendorSpecificInfoEnterprise and DestVendorSpecificInfoSubOption. The DHCP Vendor-specific Information is Option 125 (as defined in [RFC3925]) for DHCPv4, or is Option 17 (as defined in {{bibref: non-existent RFC8415}}) for DHCPv6.

An empty string indicates this criterion is not used for classification.

Note: DHCPv4 Option values are limited to a length of 255, while DHCPv6 Option values can have a maximum length of 65535.

Note: This parameter is DHCP version neutral. The specific DHCP version in use with this parameter is indicated by DHCPType.

 <Empty> 2.0
IPLengthMin unsignedInt W

Classification criterion.

Minimum IP Packet Length (including header) in bytes.bytes.

Changes in 2.18:

  • Added unsignedInt bytes units
 0 2.0
IPLengthMax unsignedInt W

Classification criterion.

Maximum IP Packet Length (including header) in bytes.bytes.

A value of zero indicates that no maximum is specified (an umlimited maximum length).

Changes in 2.18:

  • Added unsignedInt bytes units
 0 2.0
Device.QoS.Flow.{i}. object(0:) W

Flow 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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
TypeParameters string(:256)[] W Comma-separated list of strings (maximum number of characters per item 256). Each entry is a name-value pair representing additional criteria to identify the flow type. The use and interpretation is specific to the particular FlowType URN.Encoded using the “x-www-form-urlencoded” content type defined in [HTML4.01].

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.0
Device.QoS.Policer.{i}. object(0:) W

Policer 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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
CommittedRate unsignedLong W

Committed rate allowed for this policer in bits per second.

Note: To be able to support higher bit rates, this parameter was changed to unsignedLong in the Device:2.18 version.

Changes in 2.18:

  • Changed syntax = unsignedInt -> unsignedLong
 0 2.0
CommittedBurstSize unsignedInt W Committed Burstsize in bytes.bytes.

Changes in 2.18:

  • Added unsignedInt bytes units
 0 2.0
ExcessBurstSize unsignedInt W

Excess Burstsize in bytes.bytes.

Applied for a SingleRateThreeColor meter.

Changes in 2.18:

  • Added unsignedInt bytes units
 0 2.0
PeakRate unsignedLong W

Peak rate allowed for this Meter in bits per second.

Applied for TwoRateThreeColor meters.

Note: To be able to support higher bit rates, this parameter was changed to unsignedLong in the Device:2.18 version.

Changes in 2.18:

  • Changed syntax = unsignedInt -> unsignedLong
 0 2.0
PeakBurstSize unsignedInt W

Peak Burstsize in bytes.bytes.

Applied for TwoRateThreeColor meters.

Changes in 2.18:

  • Added unsignedInt bytes units
 0 2.0
Device.QoS.Queue.{i}. object(0:) W

Queue table. Each entry is associated with a set of traffic classes, which are specified via the TrafficClasses parameter, and is configured with weight, precedence, drop algorithm, scheduler algorithm etc as appropriate for the traffic classes. An entry can be associated either with all egress interfaces (in which case an actual queue will be instantiated on each egress interface on which traffic of that traffic class can be generated) or else with a single specified egress interface.

For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
TrafficClasses unsignedInt[](:256) W

Comma-separated list (maximum number of characters 256) of unsigned integers. Each list item identifies the set of traffic classes associated with this queue.

Traffic is sent to this queue if a Classification, App or Flow table entry specifies a traffic class, e.g. via the Classification.{i}.TrafficClass parameter.

If more than one queue on a given egress interface is associated with a given traffic class, the implementation will choose which queue to send traffic of this class to.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.0
BufferLength unsignedInt R

Number of bytesbytes in the buffer.

Queue buffer size for all egress interfaces for which this queue exists. If the buffer size is not the same for all such egress interfaces, this parameter MUST be 0.

Changes in 2.18:

  • Added unsignedInt bytes units
 - 2.0
ShapingRate long(-1:) W

Rate to shape this queue’s traffic to. For leaky bucket (constant rate shaping), this is the constant rate. For token bucket (variable rate shaping), this is the average rate.

If <= 100, in percent of the rate of the highest rate-constrained layer over which the packet will travel on egress.

If > 100, in bits per second.

A value of -1 indicates no shaping.

For example, for packets destined for a WAN DSL interface, if the egress will be on a PPP or IP link with a specified ShapingRate, the percentage is calculated relative to this rate. Otherwise, if the ATM layer is rate-constrained, then the rate is calculated relative to this rate. Otherwise, the rate is calculated relative to the physical-layer DSL rate.

Note: To be able to support higher bit rates, this parameter was changed to unsignedLong in the Device:2.18 version.

Changes in 2.18:

  • Changed syntax = int(-1:) -> long(-1:)
 -1 2.0
CurrentShapingRate long(-1:) R

If the Queue is active, the CurrentShapingRate must reflect the actual configured ShapingRate, in bits per second per second. -1 means no rate due to do Queue not active.

Note: To be able to support higher bit rates, this parameter was changed to unsignedLong in the Device:2.18 version.

Changes in 2.18:

  • Changed syntax = int(-1:) -> long(-1:)
 -1 2.16
AssuredRate long(-1:) W

Minimum rate to shape this queue’s traffic to.

If <= 100, in percent of the rate of the highest rate-constrained layer over which the packet will travel on egress.

If > 100, in bits per second.

A value of -1 indicates no shaping.

Note: To be able to support higher bit rates, this parameter was changed to unsignedLong in the Device:2.18 version.

Changes in 2.18:

  • Changed syntax = int(-1:) -> long(-1:)
 -1 2.16
CurrentAssuredRate long(-1:) R

If the Queue is active, the CurrentAssuredRate must reflect the actual configured AssuredRate, in bits per second. -1 means no rate due to do Queue not active.

Note: To be able to support higher bit rates, this parameter was changed to unsignedLong in the Device:2.18 version.

Changes in 2.18:

  • Changed syntax = int(-1:) -> long(-1:)
 -1 2.16
ShapingBurstSize unsignedInt W Burst size in bytes.bytes. For both leaky bucket (constant rate shaping) and token bucket (variable rate shaping) this is the bucket size and is therefore the maximum burst size.

Changes in 2.18:

  • Added unsignedInt bytes units
 - 2.0
Device.QoS.QueueStats.{i}. object(0:) W

Queue statistics table. This table is managed by the Controller, which will create entries only for those {Queue, Interface} combinations for which statistics are to be collected.

Note: The QueueStats table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated QueueStats row to then violate the table’s unique key constraint; if this occurs, the CPE MUST disable the offending QueueStats row.

At most one entry in this table can exist with a given value for Alias, or with the same values for both Queue and Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
OutputBytes unsignedInt R

Number of bytesbytes output through the queue.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Added unsignedInt bytes units
 0 2.0
DroppedBytes unsignedInt R

Number of bytesbytes dropped by the queue.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Added unsignedInt bytes units
 0 2.0
Device.QoS.Shaper.{i}. object(0:) W

Shaper table. Used to shape the queue(s) associated with Interface. In case of a single queue for that interface, determines the egress rate of the queue. In case of multiple queues for that interface (possibly with per queue shaping rates), determines the aggregate egress rate on that interface.

For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

Note: The Shaper table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Shaper row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending Shaper row.

At most one entry in this table can exist with a given value for Alias, or with a given value for Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
ShapingRate long(-1:) W

Rate to shape the associated interface connection’s egress traffic to. For leaky bucket (constant rate shaping), this is the constant rate. For token bucket (variable rate shaping), this is the average rate.

If <= 100, in percent of the rate of the highest rate-constrained layer over which the packet will travel on egress.

If > 100, in bits per second.

A value of -1 indicates no shaping.

For example, for packets destined for a WAN DSL interface, if the ATM layer is rate-constrained, then the rate is calculated relative to this rate. Otherwise, the rate is calculated relative to the physical-layer DSL rate.

Note: To be able to support higher bit rates, this parameter was changed to unsignedLong in the Device:2.18 version.

Changes in 2.18:

  • Changed syntax = int(-1:) -> long(-1:)
 -1 2.0
ShapingBurstSize unsignedInt W Burst size in bytes.bytes. For both leaky bucket (constant rate shaping) and token bucket (variable rate shaping) this is the bucket size and is therefore the maximum burst size.

Changes in 2.18:

  • Added unsignedInt bytes units
 - 2.0
Device.QoS.Scheduler.{i}. object(0:) W

Scheduler table. Each entry is used to model a scheduler object.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.16
ShapingRate long(-1:) W

Rate to shape this scheduler’s traffic to. For leaky bucket (constant rate shaping), this is the constant rate. For token bucket (variable rate shaping), this is the average rate.

If <= 100, in percent of the rate of the highest rate-constrained layer over which the packet will travel on egress.

If > 100, in bits per second.

A value of -1 indicates no shaping.

Note: To be able to support higher bit rates, this parameter was changed to unsignedLong in the Device:2.18 version.

Changes in 2.18:

  • Changed syntax = int(-1:) -> long(-1:)
 -1 2.16
AssuredRate long(-1:) W

Minimum guaranteed rate to shape this scheduler’s traffic to.

Must be > 0 and < ShapingRate, for a valid rate.

A value of -1 indicates the ShapingRate’s value is not used.

Note: To be able to support higher bit rates, this parameter was changed to unsignedLong in the Device:2.18 version.

Changes in 2.18:

  • Changed syntax = int(-1:) -> long(-1:)
 -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 can exist with a given value for Alias, or with a given value for PhysAddress. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and PhysAddress such that the new entry does not conflict with any existing entries.

Changes in 2.18:

 - 2.14
Origin string WO

Indicates the owner of the AccessControl instance.

Note: This parameter was changed to writeOnceReadOnly in the Device:2.18 version.

Enumeration of:

  • User (Used for indicating that the access control rule was created by the end-user. For example through the web user interface)
  • System (Used for indicating that the access control rule was created by the system itself)
  • Controller (Used for indicating that the access control rule was created by a Controller)

Once it’s been set, this parameter is immutable.

Changes in 2.18:

  • Changed access = readOnly ⇒ writeOnceReadOnly
 Controller 2.17
AccessPolicy string W

Allows or denies access for a device.

If AccessPolicy is set to “Allow”, device access is allowed based on the {{object: non-existent .Schedules.Schedule}} objects.objects referenced by the ScheduleRef parameter. Access is enabled if there is no {{object: non-existent .Schedules.Schedule}} object defined.referenced by the ScheduleRef parameter.

If AccessPolicy is set to “Deny”, defined {{object: non-existent .Schedules.Schedule}} objects referenced by the ScheduleRef parameter are ignored and no access is allowed for the device.

Enumeration of:

  • Allow
  • Deny
 Allow 2.14
ScheduleRef string[] W Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Schedules.Schedule. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Each reference provides a schedule where time based access can be enabled. When ScheduleRef is an empty string the AccessControl is not scheduled, and the Enable defines the operational state. <Empty> 2.18
ScheduleNumberOfEntries unsignedInt R
This parameter was DEPRECATED in 2.18 in favor of Schedules..
The number of entries in the Schedule table.

Changes in 2.18:

  • Added status = deprecated
 - 2.14
Device.Hosts.AccessControl.{i}.Schedule.{i}. object(0:) W
This object was DEPRECATED in 2.18 in favor of Schedules..
Each instance of this object provides a schedule where access is enabled.
At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

Changes in 2.18:

  • Added status = deprecated
 - 2.14
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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.17
Origin string WO

The mechanism via which the Zone was created.

Note: This parameter was changed to writeOnceReadOnly in the Device:2.18 version.

Enumeration of:

  • User (Used for indicating that the entry was created by the end-user. For example through the web user interface)
  • System (Used for indicating that the entry was created by the system itself)
  • Controller (Used for indicating that the entry was created by a Controller)

Once it’s been set, this parameter is immutable.

Changes in 2.18:

  • Changed access = readOnly ⇒ writeOnceReadOnly
 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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.17
Origin string WO

Indicates the owner of the Host instance.

Note: This parameter was changed to writeOnceReadOnly in the Device:2.18 version.

Enumeration of:

  • User (Used for indicating that the entry was created by the end-user. For example through the web user interface)
  • System (Used for indicating that the entry was created by the system itself)
  • Controller (Used for indicating that the entry was created by a Controller)

Once it’s been set, this parameter is immutable.

Changes in 2.18:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 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, or RA received DNS server information, or are statically configured by the Controller.

At most one entry in this table can exist with a given value for DNSServer, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for DNSServer and Alias such that the new entry does not conflict with any existing entries.

 - 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.

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

 - 2.0
Interface string(:256) W

The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This parameter 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:

  • DHCP (This enumeration was OBSOLETED in 2.14 because it’s been replaced by DHCPv4. This enumeration was DELETED in 2.16)
  • DHCPv4
  • DHCPv6
  • RouterAdvertisement
  • IPCP
  • 3GPP-NAS (Assigned by the core network (fixed or cellular) using 3GPP NAS signalling methods. e.g. PDU Session Establishment Request using the extended Protocol Configuration Options, PDN Connectivity Request using the Protocol Configuration Options, PDP Context Activation Request using the Protocol Configuration Options [Clause 10.5.6.3/3GPP-TS.24.008], … This information is available from the AT commands [Clause 10.1.23/3GPP-TS.27.007] PDP context read dynamic parameters +CGCONTRDP, added in 2.18)
  • Static

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 entiresentries will have their Type set to Static.

Changes in 2.18:

  • Added string 3GPP-NAS enumeration
 Static 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.Config.{i}. object(0:) W

This object is used to specify the cache configuration for each Forwarding relay.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.17
Forwarders string(:256)[] W 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 Forwarding. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Specifies the list of the DNS forwarders to be used.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.17
CacheMinTTL unsignedInt R

Specifies the miniumminimum TTL amount of time, in seconds, that an entry MUST be kept in the cache regardless of what has been specified by the domain owner.

When ‘0’ is specified, then the TTL chosen by the domain owner will be applied.

 0 2.17
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, 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 can exist with a given value for DNSServer, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for DNSServer and Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Type string R

Method used to assign the DNSServer address. Enumeration of:

  • DHCP (This enumeration was OBSOLETED in 2.14 because it’s been replaced by DHCPv4. This enumeration was DELETED in 2.16)
  • DHCPv4
  • DHCPv6
  • RouterAdvertisement
  • IPCP
  • Static

Table entries that are automatically created as result of DHCP, IPCP, or RA received DNS server information will have Type set to DHCPv4, DHCPv6, IPCP, or RouterAdvertisement, as the case may be. Manually created table entiresentries will have their Type set to Static.

 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.SD service is disabled, the contents of the service table is implementation specific.

 - 2.6
Device.DNS.SD.Advertise.{i}. object(0:) W

The Advertise table contains DNS-SD services that MUST be advertised. DNS.SD service information is provided in DNS RR SRV records [RFC2782]. The Service Instance Name [Section 4.1 Structured Instance Names/DNS-SD] further specifies information about the service name (RFC2782 Service field) and domain name (RFC2782 Name field) in the form:

Service Instance Name = [InstanceName] . [Service] . [Domain]

[Service] = _[ApplicationProtocol] . _[TransportProtocol]

RFC2782 Service field will always be equal to [InstanceName]. [Service]

RFC2782 Name field will always be equal to [Domain]

For example, an SSH service might have:

*InstanceName = “Secure Shell (SSH))”

*ApplicationProtocol = “ssh”

*TransportProtocol = “TCP”

*Port = 22

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.17
InstanceName string(:63) W

Human-readable instance name [Section 4.1.1 Instance Names/DNS-SD] (i.e. The “[InstanceName]” portion of the ‘“Service Instance Name’“).

Note: This parameter was promoted to readWrite in the Device:2.18 version.

Changes in 2.18:

  • Changed access = readOnly ⇒ readWrite
 - 2.17
ApplicationProtocol string(:15) W

The Application Protocol, without the leading underscore, associated with the service (e.g., daap) as defined by the DNS-SD service [Section 7 Application Protocol Names/DNS-SD].

Note: This parameter was promoted to readWrite in the Device:2.18 version.

Changes in 2.18:

  • Changed access = readOnly ⇒ readWrite
 - 2.17
TransportProtocol string W

The Transport Protocol associated with the service as defined by the DNS-SD service [Section 4.1.2 Service Names/DNS-SD].

Note: This parameter was promoted to readWrite in the Device:2.18 version.

Enumeration of:

  • TCP
  • UDP

Changes in 2.18:

  • Changed access = readOnly ⇒ readWrite
 - 2.17
Domain string(:256) W

The value to be entered into the Name field of the DNS SRV record [RFC2782] which represents the fully qualified domain name (FQDN) associated with the service as defined by the DNS-SD service [Section 4.1.3 Domain Names/DNS-SD].

Note: This parameter was promoted to readWrite in the Device:2.18 version.

Changes in 2.18:

  • Changed access = readOnly ⇒ readWrite
 local 2.17
Port unsignedInt(:65535) W

The value to be entered into the Port field of the DNS SRV record [RFC2782] that is used to contact the service.

Note: This parameter was promoted to readWrite in the Device:2.18 version.

Changes in 2.18:

  • Changed access = readOnly ⇒ readWrite
 - 2.17
Device.DNS.SD.Advertise.{i}.TextRecord.{i}. object(0:) W

This object maintains an instance of a (key/value pairs) of the service. The information is to be provided in the DNS TXT records [RFC1035] of the advertised service.

When multiple instances of the TextRecord table have the same value for the Key parameter, the implementation is CPE specific.

Note: This object was promoted to readWrite in the Device:2.18 version.

Changes in 2.18:

  • Changed access = readOnly ⇒ readWrite
 - 2.17
Device.NAT. object R

Properties for Network Address Translation (NAT).

The entire NAT object only applies to IPv4.

 - 2.0
Device.NAT.InterfaceSetting.{i}. object(0:) W

NAT settings for an associated IP Interface on which NAT is enabled.

For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

Note: The InterfaceSetting table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated InterfaceSetting row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending InterfaceSetting row.

At most one entry in this table can exist with a given value for Alias, or with a given value for Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
SourceNetwork string(:256)[] W

Comma-separated list of strings (maximum number of characters per item 256). Each list item MUST be the Path name of a IP.Interface.{i}.IPv4Address. table or of one of its rows. If the referenced object is deleted, the corresponding item MUST be removed from the list.

Specifies the source IPv4 network(s) that MUST be translated for all outgoing traffic associated with the Interface (e.g. Device.IP.Interface.2.IPv4Address. (table) or Device.IP.Interface.2.IPv4Address.1. (row)).

The IP.Interface.{i}.IPv4Address.{i}.IPAddress and IP.Interface.{i}.IPv4Address.{i}.SubnetMask are used to construct an additional filter rule that specifies which address range needs to be translated.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.16
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 can exist with a given value for Alias, or with the same values for all of RemoteHost, ExternalPort and Protocol. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, ExternalPort and Protocol such that the new entry does not conflict with any existing entries.

Changes in 2.18:

 - 2.0
Status string R

The status of this entry. Enumeration of:

  • Disabled
  • Enabled
  • Inactive (Indicates that the port mapping is still enabled but has been temporarily deactivated due to the Schedules defined in ScheduleRef, added in 2.18)
  • Error_Misconfigured
  • Error (OPTIONAL)

The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid.

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

Changes in 2.18:

  • Added string Inactive enumeration
 Disabled 2.0
Origin string WO

Indicates the Origin of the PortMapping instance.

Note: This parameter was changed to writeOnceReadOnly in the Device:2.18 version.

Enumeration of:

  • User (Used for indicating that the port mapping entry was created by the end-user. For example through the web user interface)
  • System (Used for indicating that the port mapping entry was created by the system itself)
  • UPnP (Used for indicating that the port mapping entry was created by a device using UPnP-IGD)
  • Controller (Used for indicating that the port mapping entry was created by a Controller)

Once it’s been set, this parameter is immutable.

Changes in 2.18:

  • Changed access = readOnly ⇒ writeOnceReadOnly
 Controller 2.17
RemainingLeaseTime unsignedInt R

For a dynamic (non-static) port mapping, when this parameter is read, the value represents the time (in seconds) remaining on the port mapping lease. That is, for a dynamic port mapping, the value counts down toward 0. When a dynamic port mapping lease expires, the device MUST automatically terminate that port mapping, and MUST automatically delete the corresponding PortMapping table entry.

For a static port mapping, this parameter is irrelevant and should return 0.

Value Change Notification requests for this parameter MAY be denied.

 - 2.18
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.

 - 2.0
ScheduleRef string[] W Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Schedules.Schedule. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Each reference provides a schedule where time based access can be enabled. When ScheduleRef is an empty string the PortMapping is not scheduled, and the Enable defines the operational state. <Empty> 2.18
Device.NAT.PortTrigger.{i}. object(0:) W

Firewall PortTrigger table.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

Changes in 2.18:

 - 2.16
Status string R

The status of this PortTrigger entry.

Enumeration of:

  • Disabled (Indicates that the PortTrigger entry is disabled)
  • Enabled (Indicates that the PortTrigger entry is enabled)
  • Inactive (Indicates that the PortTrigger is still enabled but has been temporary deactivated due to the Schedules defined in ScheduleRef, added in 2.18)
  • Error_Misconfigured (Indicates that a necessary configuration value is undefined or invalid)
  • Error (MAY be used to define an error condition, OPTIONAL)

Changes in 2.18:

  • Added string Inactive enumeration
 Disabled 2.16
Origin string WO

Indicates the owner of the PortTrigger instance.

Note: This parameter was changed to writeOnceReadOnly in the Device:2.18 version.

Enumeration of:

  • User (Used for indicating that the PortTrigger entry was created by the end-user. For example through the web user interface)
  • System (Used for indicating that the PortTrigger entry was created by the system itself)
  • Controller (Used for indicating that the PortTrigger entry was created by a Controller)

Once it’s been set, this parameter is immutable.

Changes in 2.18:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 Controller 2.16
ActivationDate dateTime R

Indicates when the port trigger was enabled. When the port trigger is no longer active.

Note: This parameter was demoted to readOnly in the Device:2.18 version.

Changes in 2.18:

  • Changed access = readWrite ⇒ readOnly
 0001-01-01T00:00:00Z 2.16
ScheduleRef string[] W Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Schedules.Schedule. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Each reference provides a schedule where time based access can be enabled. When ScheduleRef is an empty string the PortTrigger is not scheduled, and the Enable defines the operational state. <Empty> 2.18
Device.PCP. object R

Properties for Port Control Protocol (PCP) [RFC6887].

See the PCP Theory of Operation [Appendix XIV/TR-181i2] for a description of the working of this PCP data model.

 - 2.8
Device.PCP.Client.{i}. object(0:) W

Client properties for Port Control Protocol (PCP). The PCP Client interacts with a PCP Server as defined in [RFC6887] for internal device applications or LAN device applications via Interworking functions.

At most one entry in this table can exist with a given value for Alias, or with a given value for WANInterface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and WANInterface such that the new entry does not conflict with any existing entries.

 - 2.8
Device.PCP.Client.{i}.Server.{i}. object(0:) W

This table contains the PCP Servers to be used by the PCP Client. Entries are either statically configured or automatically created via DHCP options OPTION_V4_PCP_SERVER and OPTION_V6_PCP_SERVER, as per [RFC7291].

Each OPTION_V4_PCP_SERVER or OPTION_V6_PCP_SERVER option corresponds to a Server instance. If an option returns multiple addresses then that Server instance has multiple addresses.

At most one entry in this table can exist with a given value for Alias, or with a given value for ServerNameOrAddress. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and ServerNameOrAddress such that the new entry does not conflict with any existing entries.

 - 2.8
Device.PCP.Client.{i}.Server.{i}.InboundMapping.{i}. object(0:) W

Inbound Mapping table.

This table contains all Inbound Mappings requested by this PCP Client on this PCP Server. Such a mapping is created by a PCP request with OpCode MAP, as described in [Section 11/RFC6887].

These requests can be issued from internal device applications, from static configuration or from other LAN device applications via interworking functions such as UPnP IGD or PCP proxies. The Origin parameter indicates which mechanism requested the mapping.

For non-Static mappings (here Static refers to the mechanism that created the mapping, not to the Lifetime), the Controller MAY modify the Enable parameter but MUST NOT modify any other parameters in the mapping or its sub-objects.

At most one entry in this table can exist with a given value for Alias, or with the same values for all of InternalPort, ProtocolNumber and ThirdPartyAddress. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, InternalPort, ProtocolNumber and ThirdPartyAddress such that the new entry does not conflict with any existing entries.

 - 2.8
Device.PCP.Client.{i}.Server.{i}.InboundMapping.{i}.Filter.{i}. object(0:) W

Filter table.

This table contains all Filters restricting this Inbound Mapping, as defined in [RFC6887].

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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.8
RemotePortEndRange unsignedInt(0:65535) W

Indicates the last port of the remote port range that starts with RemotePort.

If an external port range is specified, then the behavior described for RemotePort applies to all ports within the range.

A value of zero (0) indicates that no remote port range is specified, i.e. that the range consists only of RemotePort.

Note: This parameter was promoted to readWrite in the Device:2.18 version.

Changes in 2.18:

  • Changed access = readOnly ⇒ readWrite
 0 2.8
Device.DHCPv4. object R The Dynamic Host Configuration Protocol (DHCP) IPv4 object [RFC2131]. This entire object applies to IPv4 only. It contains the Client, Server, and Relay objects. - 2.0
Device.DHCPv4.Client.{i}. object(1:) W

This object contains DHCP client settings for an associated IP Interface indicated by Interface.

For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the 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 can exist with a given value for Alias, or with a given value for Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

Changes in 2.18:

 - 2.0
IPRouters string(:45)[](:256) R

[IPv4Address] Comma-separated list (maximum number of characters 256) of IPv4Addresses. Items represent IP Router IPv4 Address(es) received from the DHCP server. An empty string when Status is not equal to Bound.

Value is information received via DHCP Options 3, 33 or 121.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.0
DNSServers string(:45)[](:256) R

[IPv4Address] Comma-separated list (maximum number of characters 256) of IPv4Addresses. Items represent DNS Server IPv4 Address(es) received from the DHCP server. An empty string when Status is not equal to Bound.

Value is information received via DHCP Option 6.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.0
Device.DHCPv4.Client.{i}.Retransmission. object R This object enables the configurion of the DHCPv4 retransmission behavior according to the guidelines described in [Chapter 4.1/RFC2131]. - 2.18
DiscoverInitialTimeout unsignedInt W Initial delay, expressed in seconds, before initiating the first DCHCPDISCOVER message. 4 2.18
DiscoverMaxTimeout unsignedInt W

Maximum duration, expressed in seconds, between two DHCPDISCOVER message retransmission.

According to [Chapter 4.1/RFC2131], the recommended value for this parameter is 64 seconds.

 64 2.18
DiscoverMaxDuration unsignedInt W

Maximum duration, expressed in seconds, during which the DHCPv4 client is permitted to retransmit DHCPDISCOVER message

A value of ‘0’ indicates that no specific maximum duration is set.

 0 2.18
RequestInitialTimeout unsignedInt W Initial delay, expressed in seconds, before initiating the first DHCPREQUEST message. 4 2.18
RequestMaxTimeout unsignedInt W

Maximum duration, expressed in seconds, between two DHCPREQUEST message retransmission.

According to [Chapter 4.1/RFC2131], the recommended value for this parameter is 64 seconds.

 64 2.18
RequestMaxDuration unsignedInt W

Maximum duration, expressed in seconds, during which the DHCPv4 client is permitted to retransmit DHCPREQUEST message.

A value of ‘0’ indicates that no specific maximum duration is set.

 0 2.18
TimeoutRandomize int W

The Randomization factor for the retransmission timeout, in ms, as defined in [Section 4.1 Constructing and sending DHCP messages/RFC2131].

E.g. a timeout of 2000ms with a randomization of 1000 will end up between 1000 and 3000 ms.

 1000 2.18
Device.DHCPv4.Server. object R DHCP server configuration. - 2.0
Device.DHCPv4.Server.Pool.{i}. object(0:) W

DHCP conditional serving pool table.

Each instance of this object defines a DHCP conditional serving pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCP options, and MAC address.

Overlapping pool ranges MUST be supported.

For enabled table entries, if Interface is not a valid reference, or MinAddress, MaxAddress, or SubnetMask is not a valid value, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

At most one entry in this table can exist with a given value for Alias, or with a given value for Order. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Order such that the new entry does not conflict with any existing entries.

 - 2.0
ReservedAddresses string(:45)[:32]() W [IPv4Address] Comma-separated list (up to 32 items) (length ) of IPv4Addresses. List items represent addresses marked reserved from the address allocation pool.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.0
Device.DHCPv6. object R The Dynamic Host Configuration Protocol (DHCP) IPv6 object {{bibref: non-existent 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 can exist with a given value for Alias, or with a given value for Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

Changes in 2.18:

 - 2.2
DUID hexBinary(:130) R The client’s DHCP Unique Identifier (DUID) {{bibref: non-existent RFC8415}}. DUID is set by the CPE. - 2.2
RequestAddresses boolean W Enables or disables inclusion of the Identity Association (IA) for Non-Temporary Address option OPTION_IA_NA(3) {{bibref: non-existent RFC8415}} in Solicit messages. true 2.2
RequestPrefixes boolean W

Enables or disables inclusion of the Identity Association (IA) for Prefix Delegation option OPTION_IA_PD(25) {{bibref: non-existent RFC8415}} in Solicit messages.

Note that this is only appropriate for an upstream interface on a requesting router, e.g. for an RG WAN interface.

 false 2.2
RapidCommit boolean W Enables or disables inclusion of the Rapid Commit option OPTION_RAPID_COMMIT(14) {{bibref: non-existent RFC8415}} in Solicit messages. false 2.2
SuggestedT1 int(-1:) W

T1 value, in seconds, that the client SHOULD use when sending IA options, e.g. OPTION_IA_NA {{bibref: non-existent RFC8415}} and OPTION_IA_PD {{bibref: non-existent RFC8415}}.

A value of -1 indicates that no T1 value is specified.

 - 2.2
SuggestedT2 int(-1:) W

T2 value, in seconds, that the client SHOULD use when sending IA options, e.g. OPTION_IA_NA {{bibref: non-existent RFC8415}} and OPTION_IA_PD {{bibref: non-existent RFC8415}}.

A value of -1 indicates that no T2 value is specified.

 - 2.2
RequestedOptions unsignedInt[] W

Comma-separated list of unsigned integers. An ordered list of the top-level options (i.e. not encapsulated options) that the client will explicitly request from the server.

This parameter is intended only for options that are not necessary for the basic operation of the protocol, and are not modeled elsewhere. For example, it is appropriate for OPTION_DNS_SERVERS [RFC3646] but is not appropriate for OPTION_SERVERID (which is part of the protocol), OPTION_IA_NA (which is modeled via RequestAddresses) or OPTION_IA_PD (which is modeled via RequestPrefixes). However, the CPE MUST NOT reject an attempt to set this parameter to a value that includes options that it regards as inappropriate; instead, it MUST accept the requested options and handle them as best it can.

Loosely speaking, these are the options that the client will include in OPTION_ORO {{bibref: non-existent RFC8415}} but the client is free to decide (in accordance with {{bibref: non-existent RFC8415}}) in which messages to request which option, whether also to request additional options, whether not to request inappropriate options, and in which order to request any options that are also in SupportedOptions.

 - 2.2
Device.DHCPv6.Client.{i}.Server.{i}. object(0:) R

This is a transitory table that lists the discovered DHCPv6 servers (it does not model a local DHCP server). Table entries are automatically created to correspond with these servers. However, it is a local matter to the CPE when to delete old table entries.

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

 - 2.2
DUID hexBinary(:130) R The server’s DHCP Unique Identifier (DUID) {{bibref: non-existent RFC8415}} as received via OPTION_SERVERID. - 2.2
Device.DHCPv6.Client.{i}.SentOption.{i}. object(0:) W

The top-level options and option values (including any encapsulated options) that the client will send to the server.

This table is intended only for options that are not part of the basic operation of the protocol, and whose values are simple, do not often change and are not modeled elsewhere. For example, it is appropriate for OPTION_USER_CLASS (whose value is a list of user classes) but is not appropriate for OPTION_RECONF_MSG (which is part of the protocol), OPTION_IA_NA (which is modeled via RequestAddresses) or OPTION_RAPID_COMMIT (which is modeled via RapidCommit).

At most one entry in this table can exist with a given value for Alias, or with a given value for Tag. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Tag such that the new entry does not conflict with any existing entries.

 - 2.2
Tag unsignedInt(0:65535) W

Option tag (code) {{bibref: non-existent RFC8415}}.

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

 - 2.2
Value hexBinary(0:65535) W

A hexbinary encoded option data {{bibref: non-existent RFC8415}}.

Note: The length of the option data is option-len octets, as specified in {{bibref: non-existent RFC8415}}.

 <Empty> 2.2
Device.DHCPv6.Client.{i}.ReceivedOption.{i}. object(0:) R

This is a transitory table that lists all the options received from all servers. Table entries are automatically created to correspond with received options. However, it is a local matter to the CPE when to delete old table entries.

If the same option is received multiple times, whether from one or more servers, it is up to the CPE to decide which entries to include (i.e. whether the same option will be present multiple times). In order to allow for the same option to be present multiple times within the table, this table has no unique key defined.

 - 2.2
Tag unsignedInt(0:65535) R Option tag (code) {{bibref: non-existent RFC8415}}. - 2.2
Value hexBinary(0:65535) R A hexbinary encoded option data {{bibref: non-existent RFC8415}}. - 2.2
Device.DHCPv6.Client.{i}.Retransmission. object R This object enables the configurion of the DHCPv6 retransmission behavior according to the guidelines described in [Section 7.6/RFC8415]. - 2.18
SolicitMaxDelay unsignedInt W Maximum delay of first Solicit, expressed in seconds. 1 2.18
SolicitInitialTimeout unsignedInt W Initial solicit, expressed in seconds. 1 2.18
SolicitMaxTimeout unsignedInt W Maximum solicit timeout value, expressed in seconds. 3600 2.18
RequestInitialTimeout unsignedInt W Initial request timeout, expressed in seconds. 1 2.18
RequestMaxTimeout unsignedInt W Maximum request timeout, expressed in seconds. 30 2.18
RequestMaxRetry unsignedInt W Maximum request retry attempts. 10 2.18
ConfirmMaxDelay unsignedInt W Maximum delay of first confirm, expressed in seconds. 1 2.18
ConfirmInitialTimeout unsignedInt W Initial confirm timeout, expressed in seconds. 1 2.18
ConfirmMaxTimeout unsignedInt W Maximum confirm timeout, expressed in seconds. 4 2.18
ConfirmMaxDuration unsignedInt W Maximum confirm duration, expressed in seconds. 10 2.18
RenewInitialTimeout unsignedInt W Initial renew timeout, expressed in seconds. 10 2.18
RenewMaxTimeout unsignedInt W Maximum renew timeout value, expressed in seconds. 600 2.18
RebindInitialTimeout unsignedInt W Initial rebind timeout, expressed in seconds. 10 2.18
RebindMaxTimeout unsignedInt W Maximum rebind timeout value, expressed in seconds. 600 2.18
InformationRequestMaxDelay unsignedInt W Maximum delay of first information-request, expressed in seconds. 1 2.18
InformationRequestInitialTimeout unsignedInt W Initial information-request timeout, expressed in seconds. 1 2.18
InformationRequestMaxTimeout unsignedInt W Maximum information-request timeout, expressed in seconds. 3600 2.18
ReleaseInitialTimeout unsignedInt W Initial Release timeout, expressed in seconds. 1 2.18
ReleaseMaxAttempts unsignedInt W Maximum release retry attempts. 4 2.18
DeclineInitialTimeout unsignedInt W Initial Decline timeout, expressed in seconds. 1 2.18
DeclineMaxAttempts unsignedInt W Maximum decline retry attempts. 4 2.18
ReconfigureInitialTimeout unsignedInt W Initial reconfigure timeout, expressed in seconds. 2 2.18
ReconfigureMaxAttempts unsignedInt W Maximum reconfigure attempts. 8 2.18
HopCountLimit unsignedInt W Maximum hop count in a relay-forward message. 32 2.18
InformationRefreshTime unsignedInt W Default information refresh time, expressed in seconds. 86400 2.18
MinInformationRefreshTime unsignedInt W Minimum information refresh time, expressed in seconds. 600 2.18
MaxWaitTime unsignedInt W Maximum required time to wait for a response, expressed in seconds. 60 2.18
TimeoutRandomize int W

The Randomization factor for the retransmission timeout, in ms, as defined in [Section 15 Reliability of Client-Initiated Message Exchanges/RFC8415].

E.g. a timeout of 1000ms with a randomization of 100 will end up between 900 and 1100 ms.

 100 2.18
Device.DHCPv6.Server. object R DHCPv6 server configuration. - 2.2
Device.DHCPv6.Server.Pool.{i}. object(0:) W

DHCPv6 server pool table.

Each instance of this object defines a DHCPv6 server pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCPv6 options, and source address.

Overlapping pool ranges MUST be supported.

For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack) then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

At most one entry in this table can exist with a given value for Alias, or with a given value for Order. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Order such that the new entry does not conflict with any existing entries.

 - 2.2
DUID hexBinary(:130) W

Pool association criterion.

A hexbinary string used to identify one or more LAN devices, value of the DHCPv6 Client Identifier (Option 1) {{bibref: non-existent RFC8415}}. The option value is binary, so an exact match is REQUIRED.

An empty string indicates this criterion is not used.

Note: DHCPv6 Option 1 (DUID) is sometimes referred to as Client Identifier.

 <Empty> 2.2
VendorClassID hexBinary(:65535) W

Pool association criterion.

A hexbinary string used to identify one or more LAN devices, value of the DHCPv6 Vendor Class Identifier (Option 16) {{bibref: non-existent RFC8415}}. The option value is binary, so an exact match is REQUIRED.

An empty string indicates this criterion is not used.

 <Empty> 2.2
UserClassID hexBinary(:65535) W

Pool association criterion.

A hexbinary string used to identify one or more LAN devices, value of the DHCPv6 User Class Identifier (Option 15) {{bibref: non-existent RFC8415}}.

An empty string indicates this criterion is not used.

 <Empty> 2.2
IANAManualPrefixes string[:8]() W

Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list.

Manually-configured prefixes from which IA_NA addresses will be assigned. Each referenced prefix MUST have a IP.Interface.{i}.IPv6Prefix.{i}.StaticType of Static or Child. All clients that request IA_NA and match filter criteria on this Interface MUST be offered IA_NA addresses from all of the Valid (IP.Interface.{i}.IPv6Prefix.{i}.ValidLifetime is infinite or in the future) /64 prefixes in this list.

Prefixes MUST be associated with the interface instance referenced by Interface.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.2
IAPDManualPrefixes string[:8]() W

Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list.

Manually-configured prefixes from which IA_PD prefixes will be derived. This list can include:

All clients that request IA_PD and match filter criteria on this Interface MUST be offered IA_PD prefixes derived from all of the Valid (IP.Interface.{i}.IPv6Prefix.{i}.ValidLifetime is infinite or in the future) prefixes in this list.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.2
Device.DHCPv6.Server.Pool.{i}.Client.{i}. object(0:) R

DHCPv6 client table.

This table lists details of DHCPv6 clients that matched the filter criteria of this Pool entry.

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

 - 2.2
Device.DHCPv6.Server.Pool.{i}.Client.{i}.Option.{i}. object(0:) R DHCPv6 options supplied by this client, e.g. DUID (Option 1), UserClassID (Option 15) or VendorClassID (option 16). - 2.2
Tag unsignedInt(0:65535) R Option tag (code) {{bibref: non-existent RFC8415}}. - 2.2
Device.DHCPv6.Server.Pool.{i}.Option.{i}. object(0:) W

This object specifies the DHCPv6 options that MUST, if enabled, be offered to clients whose DHCPv6 requests are associated with this pool. If PassthroughClient is specified, and the referenced client has a value for a given option then the PassthroughClient option value will be sent instead of Value. Otherwise, Value will be sent.

At most one entry in this table can exist with a given value for Alias, or with a given value for Tag. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Tag such that the new entry does not conflict with any existing entries.

 - 2.2
Tag unsignedInt(0:65535) W

Option tag (code) {{bibref: non-existent RFC8415}}.

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

 - 2.2
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 can exist with a given value for Alias, or with a given value for Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Device.IEEE8021x.Supplicant.{i}.Stats. object R 802.1x Authentication Supplicant EAP statistics information for this resource.

Changes in 2.18:

 - 2.0
SuccessCount unsignedInt R [StatsCounter32] Count of the number of successful authentications from the perspective of this supplicant. - 2.18
FailureCount unsignedInt R [StatsCounter32] Count of the number of failed authentications from the perspective of this supplicant. - 2.18
Reset() command - Reset all this object’s statistics counters to zero. - 2.18
Device.Users. object R Users object that contains the User, Group, and Role tables.

Changes in 2.18:

 - 2.0
SupportedCapabilities string[] R

Comma-separated list of strings. This parameter contains the supported capabilities on this system. These are privileges that allow precise control for individual processes. Essentially, capabilities can be assigned to processes giving them necessary permissions to perform certain functions. Please refer to Linux man page on capabilities (“capabilities(7) - Linux manual page”).

Each list item is an enumeration of:

  • CAP_AUDIT_CONTROL
  • CAP_AUDIT_READ
  • CAP_AUDIT_WRITE
  • CAP_BLOCK_SUSPEND
  • CAP_BPF
  • CAP_CHECKPOINT_RESTORE
  • CAP_CHOWN
  • CAP_DAC_OVERRIDE
  • CAP_DAC_READ_SEARCH
  • CAP_FOWNER
  • CAP_FSETID
  • CAP_IPC_LOCK
  • CAP_IPC_OWNER
  • CAP_KILL
  • CAP_LEASE
  • CAP_LINUX_IMMUTABLE
  • CAP_MAC_ADMIN
  • CAP_MAC_OVERRIDE
  • CAP_MKNOD
  • CAP_NET_ADMIN
  • CAP_NET_BIND_SERVICE
  • CAP_NET_BROADCAST
  • CAP_NET_RAW
  • CAP_PERFMON
  • CAP_SETGID
  • CAP_SETFCAP
  • CAP_SETPCAP
  • CAP_SETUID
  • CAP_SYS_ADMIN
  • CAP_SYS_BOOT
  • CAP_SYS_CHROOT
  • CAP_SYS_MODULE
  • CAP_SYS_NICE
  • CAP_SYS_PACCT
  • CAP_SYS_PTRACE
  • CAP_SYS_RAWIO
  • CAP_SYS_RESOURCE
  • CAP_SYS_TIME
  • CAP_SYS_TTY_CONFIG
  • CAP_SYSLOG
  • CAP_WAKE_ALARM
 - 2.18
Device.Users.User.{i}. object(0:) W

This object contains parameters relating to the user characteristics.

At most one entry in this table can exist with a given value for Username, or with a given value for Alias, or with a given value for UserID. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and UserID such that the new entry does not conflict with any existing entries.

 - 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.

Changes in 2.18:

  • Changed status = deprecated ⇒ obsoleted
 false 2.0
GroupParticipation string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of a row in the Group. table. The Groups of which this User is a member.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.0
RoleParticipation string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of a row in the Role. table. The Roles which are assigned to this User.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.0
Device.Users.Group.{i}. object(0:) W

This object contains parameters relating to the characteristics of a user group.

At most one entry in this table can exist with a given value for Groupname, or with a given value for Alias, or with a given value for GroupID. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and GroupID such that the new entry does not conflict with any existing entries.

 - 2.15
RoleParticipation string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of a row in the Role. table. These Roles are assigned to any User which is member of this Group, for so long as they remain a member of the Group.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.15
Device.Users.Role.{i}. object(0:) W

This object contains parameters relating to the role characteristics.

At most one entry in this table can exist with a given value for RoleName, or with a given value for Alias, or with a given value for RoleID. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and RoleID such that the new entry does not conflict with any existing entries.

Changes in 2.18:

 - 2.15
RequiredCapabilities string[] W Comma-separated list of strings. Each list item MUST be a member of the list reported by the Users.SupportedCapabilities parameter. Capabilities that have been assigned to this Role. - 2.18
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 in 2.18:

 - 2.0
SetNumberOfEntries unsignedInt R The number of entries in the Set table. - 2.18
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 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 (if not supplied by the Controller on creation) 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 can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

Changes in 2.18:

 - 2.2
DestMatchSet string W

The value MUST be the Path Name of a row in the Set. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Rule criterion.

Destination Match Set, Matches packets if their destination is found in the designated Set. reference. An empty string indicates this criterion is not used for matching.

 <Empty> 2.18
DestMatchSetExclude string W

The value MUST be the Path Name of a row in the Set. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Rule criterion.

Destination Exclude Match Set, Matches packets if their destination is not found in the designated Set. reference. An empty string indicates this criterion is not used for matching.

 <Empty> 2.18
SourceMatchSet string W

The value MUST be the Path Name of a row in the Set. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Rule criterion.

Source Match Set, Matches packets if their source is found in the designated Set. reference. An empty string indicates this criterion is not used for matching.

 <Empty> 2.18
SourceMatchSetExclude string W

The value MUST be the Path Name of a row in the Set. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Rule criterion.

Source Exclude Match Set, Matches packets if their source is not found in the designated Set. reference. An empty string indicates this criterion is not used for matching.

 <Empty> 2.18
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 can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

Changes in 2.18:

 - 2.16
Status string R

The status of this Pinhole entry.

Enumeration of:

  • Disabled (Indicates that the pinhole is disabled)
  • Enabled (Indicates that the pinhole is enabled)
  • Inactive (Indicates that the pinhole is still enabled but has been temporarily deactivated due to the Schedules defined in ScheduleRef, added in 2.18)
  • Error_Misconfigured (Indicates that a necessary configuration value is undefined or invalid)
  • Error (MAY be used to define an error condition, OPTIONAL)

Changes in 2.18:

  • Added string Inactive enumeration
 Disabled 2.16
Origin string WO

Indicates the Origin of the Pinhole instance.

Note: This parameter was changed to writeOnceReadOnly in the Device:2.18 version.

Enumeration of:

  • User (Used for indicating that the pinhole rule was created by the end-user. For example through the web user interface)
  • System (Used for indicating that the pinhole rule was created by the system itself)
  • UPnP (Used for indicating that the pinhole rule was created by a device using UPnP-IGD, added in 2.17)
  • Controller (Used for indicating that the pinhole rule was created by a Controller)

Once it’s been set, this parameter is immutable.

Changes in 2.18:

  • Changed access = readOnly ⇒ writeOnceReadOnly
 Controller 2.16
SourcePortRangeMax int(-1:65535) W

If specified, indicates the Pinhole criterion is to include the port range from SourcePort through SourcePortRangeMax (inclusive). If specified, SourcePortRangeMax MUST be greater than or equal to SourcePort.

A value of -1 indicates that no port range is specified.

 -1 2.18
DestPortRangeMax int(-1:65535) W

If specified, indicates the Pinhole criterion is to include the port range from DestPort through DestPortRangeMax (inclusive). If specified, DestPortRangeMax MUST be greater than or equal to DestPort.

A value of -1 indicates that no port range is specified.

 -1 2.18
Protocol int(-1:255)[] W

Comma-separated list of integers (-1 to 255). Protocol number as specified in [IANA-protocolnumbers] For example:

  • 6 (TCP)
  • 17(UDP)17 (UDP)A value of -1 indicates this criterion is not used for matching.

Changes in 2.18:

  • Changed default value = -1 ⇒ [-1]
 -1 2.16
ScheduleRef string[] W Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Schedules.Schedule. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Each reference provides a schedule where time based access can be enabled. When ScheduleRef is an empty string the Pinhole is not scheduled, and the Enable defines the operational state. <Empty> 2.18
Device.Firewall.DMZ.{i}. object(0:) W

Firewall DMZ object that is be used for configuring a demilitarized zone. A DMZ network is a seperateseparate 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 can exist with a given value for Alias, or with the same values for both DestIP and SourcePrefix. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and DestIP such that the new entry does not conflict with any existing entries.

 - 2.16
Origin string WO

Indicates who configured the DMZ instance.

Note: This parameter was changed to writeOnceReadOnly in the Device:2.18 version.

Enumeration of:

  • User (Used for indicating that the DMZ rule was created by the end-user. For example through the web user interface)
  • System (Used for indicating that the DMZ rule was created by the system itself)
  • Controller (Used for indicating that the DMZ rule was created by a Controller,)

Once it’s been set, this parameter is immutable.

Changes in 2.18:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 Controller 2.16
Device.Firewall.Service.{i}. object(0:) W

Firewall Service object that is used for configuring the firewall for opening a port/protocol for a local network service. For example:

  • SSH Server
  • Web Server

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 can exist with a given value for Alias, or with the same values for all of Interface, DestPort, Protocol and SourcePrefixes. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.16
DestPort int(-1:65535)[] W Comma-separated list of integers (-1 to 65535). Destination port number. A value of -1 indicates this criterion is not used for matching.

Changes in 2.18:

  • Changed default value = -1 ⇒ [-1]
 -1 2.16
Protocol int(-1:255)[] W

Comma-separated list of integers (-1 to 255). Protocol number as specified in [IANA-protocolnumbers] For example:

  • 6 (TCP)
  • 17(UDP)17 (UDP)A value of -1 indicates this criterion is not used for matching.

Changes in 2.18:

  • Changed default value = -1 ⇒ [-1]
 -1 2.16
SourcePrefixes string(:49)[] W [IPPrefix] Comma-separated list of IPPrefixs. Only allow incoming connections that match one or more of the source IP addresses or prefixes that are specified in SourcePrefixes for the applied service.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.16
Device.Firewall.InterfaceSetting.{i}. object(0:) W

Firewall settings for an associated IP Interface.

For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the device MUST set Status to Error_Misconfigured.

Note: The InterfaceSetting includes a unique key that is a strong reference. If a strongly referenced object is deleted, the device will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated InterfaceSetting row to then violate the table’s unique key constraint; if this occurs, the device MUST set Status to Error_Misconfigured and disable the offending InterfaceSetting row.

At most one entry in this table can exist with a given value for Alias, or with a given value for Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

Changes in 2.18:

 - 2.17
IPv6PassThroughICMPEchoRequest boolean W When true the ‘ICMPv6 echo request’ packet must be forward to the LAN device. When false the ‘ICMPv6 echo request’ packet must be dropped. - 2.18
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 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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.18
Alias string(:64) WO

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

The following mandatory constraints MUST be enforced:

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

Once it’s been set, this parameter is immutable.

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

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

 - 2.18
Enable boolean W Enables or disables this Set entry. false 2.18
Origin string WO

Indicates the Origin of the Set instance.

Enumeration of:

  • User (Used for indicating that the set rule was created by the end-user. For example through the web-ui)
  • System (Used for indicating that the set rule was created by the system itself)
  • Controller (Used for indicating that the set rule was created by a Controller)

Once it’s been set, this parameter is immutable.

 Controller 2.18
Name string(:31) W

Human-readable name associated with this Set entry.

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

 - 2.18
Type string W

Describes the intention of the Rule entries and what it contains.

Enumeration of:

  • IPAddresses (The Rule set entry describes only a list of IPaddresses)
  • Ports (The Rule set entry describes only a list of ports)
  • MACAddresses (The Rule set entry describes only a list of MAC addresses)
 IPAddresses 2.18
IPVersion unsignedInt(4,6) W IP Protocol Version as specified in [IANA-ipversionnumbers]. For example:
  • 4 (IPv4)
  • 6 (IPv6)
 6 2.18
RuleNumberOfEntries unsignedInt R The number of entries in the Rule table. - 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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.18
Alias string(:64) WO

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

The following mandatory constraints MUST be enforced:

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

Once it’s been set, this parameter is immutable.

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

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

 - 2.18
Exclude boolean W Specifies if this rule entry should match or not match the configured criteria. false 2.18
IPAddressList string(:45)[] W

[IPAddress] Comma-separated list of IP Addresses. 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] Specifies the MACAddress that can be used by the Rule entry.

Note: Can not be used in combination with IPAddressList or PortList.

 <Empty> 2.18
PortList string[] W

Comma-separated list of strings. Specifies 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’.

Note: Can not be used in combination with MACAddressList or IPAddressList.

 <Empty> 2.18
Device.PeriodicStatistics. object R

This object configures collection of periodic statistics for the device.

Periodic statistics are measured over a sample interval (which can be aligned with absolute time) and are made available to the Controller as a comma-separated list of the most recent samples.

This object provides a single set of global settings that affect the entire device unless overridden locally.

 - 2.0
Device.PeriodicStatistics.SampleSet.{i}. object(0:) W

Periodic statistics sample set table. Each sample set has its own sample interval etc.

At most one entry in this table can exist with a given value for Name, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Status string R

Indicates availability of Sample statistics. Enumeration of:

  • Disabled (Collection is disabled)
  • Enabled (Collection is enabled)
  • Trigger (Collection is enabled and the Controller SHOULD now fetch the collected data)
The Trigger value is only used for triggering the Controller to fetch the collected data and can only be used when FetchSamples is in the range [1:ReportSamples].
The transition from Enabled to Trigger to Enabled MUST be instantaneous and so will result in only a single value change for notification purposes.
This parameter was DEPRECATED in 2.16 because the periodic statistics are sent through a USP Push! event.
This parameter was OBSOLETED in 2.18.

Changes in 2.18:

  • Changed status = deprecated ⇒ obsoleted
 Disabled 2.0
SampleSeconds unsignedInt[] R

Comma-separated list of unsigned integers. Each entry indicates the number of seconds during which data was collected during the sample interval.

Individual SampleSeconds values can be less than SampleInterval, for several reasons, including:

TimeReference has been set to a time other than the Unknown Time and the current sample interval started part of the way through a scheduled sample interval.
Device.PeriodicStatistics.SampleSet.{i}.ForceSample() has been used to force statistics for the current sample to be calculated and updated in the data model.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.0
Device.PeriodicStatistics.SampleSet.{i}.Parameter.{i}. object(0:) W

Periodic statistics parameter table for this sample set. This table contains entries for parameters whose values are to be sampled.

Note that the comma-separated lists in this object (SampleSeconds, SuspectData and Values) only ever change (a) when first enabled, (b) when Device.PeriodicStatistics.SampleSet.{i}.ForceSample() has been used to force statistics for the current sample to be calculated (a “sneak preview” of the current sample), or (c) at the end of the sample interval.

At most one entry in this table can exist with a given value for Reference, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

Changes in 2.18:

 - 2.0
CalculationMode string W

Controls how this parameter’s statistic is calculated from the sampled value(s) of each internal sample interval. Enumeration of:

  • Latest (Statistic is sampled value at end of sample interval)
  • Minimum (Statistic is minimum sampled value during sample interval)
  • Maximum (Statistic is maximum sampled value during sample interval)
  • Average (Statistic is average (mean) sampled value during sample interval)
  • Histogram (Statistic is a histogram representing the sampled values during the sample interval with histogram bin spacing defined by HistogramBinBoundaries. With this selection, the output is in ValuesIfHistogram, added in 2.18)

Parameters of non-numeric types can only support Latest. The value of the CalculationMode MUST be ignored for such parameters.

SampleMode MUST be applied before CalculationMode, i.e. the inputs to the calculation will have already accounted for SampleMode.

Changes in 2.18:

  • Added string Histogram enumeration
 Latest 2.0
SampleSeconds unsignedInt[] R

Comma-separated list of unsigned integers. Each entry indicates the number of seconds during which data was collected for this parameter during the sample interval.

Individual SampleSeconds values can be less than SampleInterval, for several reasons, including:

Any of the reasons for which SampleSeconds values might be less than SampleInterval.
The parameter doesn’t exist, or was created or deleted during a sample interval.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.0
SuspectData unsignedInt(:1)[] R

Comma-separated list of unsigned integers (up to 1). Each entry is 0 if the sampled value is believed to be valid, or 1 if an event that might affect the validity of the sampled value occurred during the sample interval.

For example, if the parameter value were to be reset during the sample interval then it would be appropriate to set SuspectData to 1.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.0
Values string[] R

Comma-separated list of strings. Each entry indicates the value of the referenced parameter, as determined by SampleMode, during the sample interval.

The statistics values in this comma-separated list MUST be in time order, with the oldest one first and the most recent one last.

If the SampleMode parameter is not present, or is inappropriate for the referenced parameter, the statistics values MUST be collected in Current mode.

if CalculationMode has value “Histogram” then the values of the referenced parameter are in ValuesIfHistogram.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.0
ValuesIfHistogram string[] R

Comma-separated list of strings. Each entry indicates the value of the referenced parameter, as determined by SampleMode, during the sample interval.

The statistics values in this comma-separated list MUST be in time order, with the oldest one first and the most recent one last.

If the SampleMode parameter is not present, or is inappropriate for the referenced parameter, the statistics values MUST be collected in Current mode.

This parameter applies only if CalculationMode has value “Histogram” and then this parameter is the values of the sampled histograms, where each histogram bin is the count of the number of samples within the corresponding HistogramBinBoundaries, and this parameter is expressed using square brackets to protect comma separators within nested lists. For example, [12,5,1,0,1],[12,3,2,1,0] represents two histograms.

Value Change Notification requests for this parameter MAY be denied.

 <Empty> 2.18
HistogramBinBoundaries string[] W Comma-separated list of strings. Definition of the boundaries between histogram bins. Applies if CalculationMode has value “Histogram”. Each value is the minimum value of this bin, and the next value is just above the maximum value of this bin. For example, “0,1,4,8,” defines the four histogram bins: 0 to 1 but not including values identically equal to 1, 1 to 4 but not including values identically equal to 4, 4 to 8 but not including values identically equal to 8, and greater than or equal to 8. (No value after the last comma means no upper bound.) If this parameter is set to an empty string, then no histogram will be collected. - 2.18
Device.BulkData. object R

This object provides bulk data collection capabilities and global collection settings that affect the entire device.

Bulk Data utilizes various solutions (e.g., IPDR, HTTP) to collect data from devices and transfer the data to a collection server.

The IPDR solution is based on a service specification described in [TR-232].

The HTTP solution is based on transfer mechanisms described in [Annex A/TR-369].

The USPEventNotif solution is based on sending a Profile.{i}.Push! Event Notification via USP [TR-369].

The Bulk Data Collection Profiles are measured over a reporting interval (which can be aligned with absolute time) and are made available to the collection server.

 - 2.5
Protocols string[] R

Comma-separated list of strings. Represents the IPDR and transport protocols that this device is capable of supporting.

Each list item is an enumeration of:

  • Streaming (

IPDR Streaming Protocol [IPDR-SP]

This enumeration was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP.

This enumeration was OBSOLETED in 2.17.

This enumeration was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted

)

  • File (

IPDR File Transfer Protocol [IPDR-FTP]

This enumeration was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP.

This enumeration was OBSOLETED in 2.17.

This enumeration was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted

)

  • HTTP (Hypertext Transfer Protocol [RFC2616])
  • MQTT (Message Queuing Telemetry Transport [MQTT31], [MQTT311], and [MQTT50])
  • USPEventNotif (User Services Platform (USP - [Annex A/TR-369]) Event Notification)
 - 2.5
EncodingTypes string[] R

Comma-separated list of strings. Represents the Encoding Types for the protocols that this device is capable of supporting.

Each list item is an enumeration of:

  • XML (

Used with the IPDR Streaming and File Protocols. [IPDR-XML]

This enumeration was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP.

This enumeration was OBSOLETED in 2.17.

This enumeration was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted

)

  • XDR (

Used with the IPDR Streaming and File Protocols. [IPDR-XDR]

This enumeration was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP.

This enumeration was OBSOLETED in 2.17.

This enumeration was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted

)

  • CSV (Comma Separated Values. Used with the HTTP and USPEventNotif Protocols. [RFC4180])
  • JSON (JavaScript Object Notation. Used with the HTTP and USPEventNotif Protocols. [RFC7159])
 - 2.5
Device.BulkData.Profile.{i}. object(0:) W

A set of Bulk Data Collection profiles.

Each profile represents a bulk data report, including its own timing configuration, communications configuration, and set of parameters. This allows the Controller to configure multiple reports to be generated at different times for different sets of data.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.5
StreamingHost string(:256) W
This is the host name or IP Address of the IPDR Collector to be used by the CPE to stream bulk data records if this collection profile is configured for the IPDR Streaming Protocol [IPDR-SP] (the Protocol parameter has a value of Streaming).
This parameter was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.5
StreamingPort unsignedInt(0:65535) W
This is the port number of the IPDR Collector to be used by the CPE to stream bulk data records if this collection profile is configured for the IPDR Streaming Protocol [IPDR-SP] (the Protocol parameter has a value of Streaming).
This parameter was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 4737 2.5
StreamingSessionID unsignedInt(48:57,65:90) W
This is the unique identification of an IPDR Session to be used when this collection profile is configured for the IPDR Streaming Protocol [IPDR-SP] (the Protocol parameter has a value of Streaming).
A Controller MUST NOT configure multiple IPDR Streaming Protocol collection profiles with the same StreamingSessionID. Doing so MUST cause the CPE to fail the SetParameterValues.
Within the IPDR Streaming Protocol specification the Session ID has a type of a single ‘char’, but we are restricting the range even further (ASCII values of ‘0’ - ‘9’ and ‘A’ - ‘Z’).
This parameter was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.5
FileTransferURL string(:2048) W
This is the [URL] within the CPE that is used by an IPDR Collector to retrieve the IPDRDocs when this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File).
This parameter was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.5
FileTransferUsername string(:64) W
Username used for authentication of the FileTransferURL.
This is the FileTransferUsername that the IPDR Collector uses to access the CPE when this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File).
This parameter was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.5
FileTransferPassword string(:64) W
Password used for authentication of the FileTransferURL.
This is the FileTransferPassword that the IPDR Collector uses to access the CPE when this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File).
This parameter was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.
When read, this parameter returns an empty string, regardless of the actual value.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.5
ControlFileFormat string(:128) W
If this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File) then the control file names will be of the following format:
_.
Where the following rules apply:
  • ControlFilePrefix MUST NOT contain an underscore ‘_’ or any other character not suitable for a file name.
  • ControlFilePolicy MUST contain one or more ‘N’ characters, where the number of ‘N’ characters denotes the number of digits in the sequence number, including leading zeros as necessary to match the number of ‘N’ characters.
  • ControlFileSuffix is a file extension.
For example, BulkData_NNNN.log where “BulkData” would be the prefix, “NNNN” would be the policy, and “log” would be the suffix. Files adhering to this file format would look like: BulkData_0000.log, BulkData_0001.log, etc.
This parameter was DEPRECATED in 2.15 because IPDR Bulk Data Collection is not supported in USP.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.5
Device.SoftwareModules. object R Top level object for dynamically managed software applications. - 2.1
InstallDU() command - [ASYNC] Install one or more Deployment Units (DUs) to the associated SoftwareModules.

Changes in 2.18:

 - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Privileged boolean W

This parameter indicates whether the Deployment Unit runs in privileged mode. false - Unprivileged Container. true - Privileged Container.

The default value MUST be false.

 - 2.18
⇒ NumRequiredUIDs unsignedInt W

Number of UIDs (EU User Identifiers) that this container will need as part of its user namespace. UIDs are unique identifiers associated with each user and system process that is used to determine the allocation and isolation of system resources.

The default value MUST be 1.

 - 2.18
⇒ ShutdownDelay unsignedInt W

The delay in seconds before which the container is shutdown. This delay ensures that the application has enough time to perform any cleanup before the Execution Unit transitions to idle state. The default value is 10 seconds.

The default value MUST be 10.

 - 2.18
⇒ RequiredUserRoles string(:256)[] W

Comma-separated list of strings (maximum number of characters per item 256). The User Roles which the application installed by this command will need to be assigned in order to be able to function at all. If any of these User Roles are not present in the ExecEnv.{i}.AvailableUserRoles of the ExecEnv into which the DU is to be installed then the command will fail. Some Agents may apply further filtering for User Roles which are considered security- or privacy-sensitive.

Each entry in the list is the Name of a row in Users.Role. If there is no such row then the command will fail, as installation requires a User Role which is not available on the Device.

If this argument is absent or empty then no User Roles are required in order for the application to function.

 - 2.18
⇒ AutoRestart. object W

Defines the parameters of the auto-restart algorithm for any ExecutionUnit which is created as a result of this command.

An auto-restart may be triggered if the Agent determines that the EU has terminated abnormally. An exponential backoff algorithm is applied (increasing each time the delay before the EU is re-launched) in order to prevent continual re-starting of the EU.

The retry interval range is controlled by two Parameters, RetryMinimumWaitInterval and RetryIntervalMultiplier.

Let m be the value of RetryMinimumWaitInterval, k the value of RetryIntervalMultiplier, and n the current value of ExecutionUnit.{i}.AutoRestart.RetryCount. Then on the next occasion that the Agent determines that the EU has terminated abnormally, the delay before re-starting the EU must lie between *m * (k/1000)^n*(k/1000)n* and m * (k/1000)^(n+1)*(k/1000)(n+1)* seconds, so long as m * (k/1000)^n*(k/1000)n* evaluates to a value less than RetryMaximumWaitInterval. Once this point has been reached, on all subsequent occasions that the Agent determines that the EU has terminated abnormally the delay before re-starting the EU must lie between RetryMaximumWaitInterval * (1000/k) and RetryMaximumWaitInterval seconds.

 - 2.16
⇒ NetworkConfig. object W

Specifies the network configuration for any ExecutionUnit generatedwhich duringis created by the installation or update of the DeploymentUnit.

When this argument or any of its child objects are missing from the SoftwareModules.InstallDU(),missing, the corresponding absent part is considered unnecessary and will not be available to the ExecutionUnit.When this argument is not present in the {{command|.SoftwareModules.DeploymentUnit.{i}.Update()}}, the network configuration remains unaltered.

 - 2.17
⇒ AccessInterfaces string(:256)[] W

Comma-separated list of strings (maximum number of characters per item 256). The logical network interfaces which the application installed by this command will be allowed to send traffic through it. If any of these access interface are not present in the SoftwareModules.ExecEnv.{i}.AvailableAccessInterfaces of the ExecEnv into which the DU is to be installed then the command will fail.

Some Agents may apply further filtering for access interfaces which are considered security- or privacy-sensitive. Each entry in the list is the Name of a row inwithin either Logical.Interface. or IP.Interface..

If Name is present in both Logical.Interface. and IP.Interface., the Interface referenced in Logical.Interface. must be selected. If there is no such row then the command will fail, as installation requires access to a network, through the logical interface, which is not available.

When this argument is absent or an empty string then no outgoing network access is required for the ExecutionUnit to function.

 - 2.17
⇒ NetworkConfig.PortMapping.{i}. object(0:) W

Defines the list of required port mapping rules for any ExecutionUnit which is created as a result of this callcommand. command.If this command encounters any issue in providing the requested mapping, such as the port already being used or reserved, then it will fail.

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

 - 2.17
⇒ Interface string(:256) W [MANDATORY] Name of a row within either Logical.Interface. or IP.Interface.. If Name is present in both Logical.Interface. and IP.Interface., the Interface referenced in Logical.Interface.. must be selected. Specifies the logical interface to which the port mapping applies. - 2.17
⇐ Output. arguments - Output arguments. -
⇐ UUID string(36) R

[UUID] The Universally Unique Identifier that was either provided by the Controller, or generated by the device, when this Deployment Unit was installed.

The format of this value is defined by [RFC4122] Version 5 (Name-Based) and [Annex C/TR-181i2].

 - 2.18
⇐ Version string(:32) R Version of the installed Deployment Unit. The format of this value is Execution Environment specific. - 2.18
⇐ ExecEnvRef string R The value MUST be the Path Name of a row in the ExecEnv. table. A reference to the ExecEnv where the Deployment Unit was installed. - 2.18
DUStateChange! event -

This event informs a Controller of the completion (successful or unsuccessful) of a DU state change.

When used, this event MUST be issued after the device has completed any file transfers and carried out all operations related to the DU State Change.

This event MAY contain the results from multiple DU state changes; it is implementation specific how the device chooses to aggregate the DU state changes, although the device MUST notify the Controller of any DU state changes within 24 hours of the time the operations were completed by the device.

The device SHOULD make every attempt to aggregate, as much as possible, the DU State Change notifications to the Controller in the interest of scalability.

 - 2.12
⇒ Fault. object R Fault Structure. If the operation was successful, the FaultCode MUST be zero. Otherwise a non-zero FaultCode is specified along with a FaultString indicating the failure reason. - 2.12
⇒ FaultCode unsignedInt R

The numerical fault code. Valid values are:

*If the operation was successful, the fault code is 0.

*If the device cannot complete the operation for some unknown reason, it SHOULD reject the operation with a 7002 (Request Denied) fault code.

*If the device detects the presence of the “userinfo” component in the file source URL, it SHOULD reject the operation with a 7004 (Invalid Arguments) fault code.

*If the device cannot find the Execution Environment specified in the Install or Update command, it SHOULD reject the operation with a 7223 (Unknown Execution Environment) fault code.

*If the device determines that the Deployment Unit being installed does not match either the Execution Environment specified or any Execution Environment on the device, it SHOULD reject the operation with a 7225 (Deployment Unit to Execution Environment Mismatch) fault code

*If the device detects that the Deployment Unit being installed already has the same version as one already installed on the same Execution Environment, it SHOULD reject the operation with a 7226 (Duplicate Deployment Unit) fault code.

*If the device detects that that there are no more system resources (disk space, memory, etc.) to perform the Install or Update of a Deployment Unit, it SHOULD reject the operation with a 7227 (System Resources Exceeded) fault code.

*If a requested operation attempts to alter the State of a Deployment Unit in a manner that conflicts with the Deployment Unit State Machine Diagram [Appendix I “Software Module Management”/TR-369], it SHOULD reject the operation with a 7229 (Invalid Deployment Unit State) fault code.

*If a requested operation attempts to Uninstall a DU that caused an EE to come into existence, where that EE has at least 1 installed DU or at least 1 child EE, then the device SHOULD reject the operation with a 7229 (Invalid Deployment Unit State) fault code.

*If a requested operation attempts to Uninstall a DU that caused an ExecEnvClass to come into existence, where at least one EE exists which instantiates that ExecEnvClass, then the device SHOULD reject the operation with a 7229 (Invalid Deployment Unit State) fault code.

*If a requested operation attempts to Install or Update a DU and the server specified in the URL is not currently reachable or the request times out, then the device SHOULD reject the operation with a 7033 (Server Unreachable) fault code.

*If a requested operation attempts to Install or Update a DU and the server specified in the URL fails security checks (e.g. by not presenting a valid certificate), then the device SHOULD reject the operation with a 7034 (Server Insecure) fault code.

*If a requested operation attempts to Install or Update a DU and the file returned by the server appears to be corrupt, then the device SHOULD reject the operation with a 7035 (Corrupt Data) fault code.

*If a requested operation attempts to Install or Update a DU and the file returned by the server does not match the signature provided, or a required signature is absent, then the device SHOULD reject the operation with a 7036 (Bad Signature) fault code.

*If a requested operation attempts to Install or Update a DU and includes a RequestedRole argument which contains at least one Role which is not in the EE’s AvailableRoles list, then the device SHOULD reject the operation with a 7032 (Unavailable Role) fault code.

*If a requested operation attempts to Install or Update a DU and includes a RequestedUserRole argument which contains at least one User Role which is not in the EE’s AvailableUserRoles list, then the device SHOULD reject the operation with a 7037 (Unavailable User Role) fault code.

 - 2.12
Device.SoftwareModules.ExecEnvClass.{i}. object(0:) R

This table lists the kinds of Execution Environments which are available in this device. Rows in this table may possibly be be added, modified, or removed by as a result of respectively installing, updating, or removing a DeploymentUnit.

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

 - 2.16
AddExecEnv() command - Create a new Execution Environment of this class.

Changes in 2.18:

 - 2.16
⇒ Input. arguments - Input arguments. -
⇒ AvailableUserRoles string(:256)[] W

Comma-separated list of strings (maximum number of characters per item 256). The User Roles which are available to Deployment Units installed into the new instance. Only the listed User Roles may be assigned to any DeploymentUnit installed into the instance. If this parameter is missing or an empty string then no User Roles may be assigned to any DeploymentUnit installed into the instance.

Each entry in the list is the Name of a row in Users.Role. If there is no such row then the entry will be ignored.

 - 2.18
⇐ Output. arguments - Output arguments. -
⇐ ExecEnvRef string R The value MUST be the Path Name of a row in the ExecEnv. table. A reference to the ExecEnv which was created.

Changes in 2.18:

  • Changed ##.ExecEnv. pathRef refType = weak ⇒ strong
 - 2.16
Device.SoftwareModules.ExecEnv.{i}. object(0:) R

The Execution Environments that are available on the device, along with their properties and configurable settings.

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

Changes in 2.18:

 - 2.1
ProcessorRefList string[] R
Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.Processor. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the processors that this ExecEnv has available to it.
This parameter was DEPRECATED in 2.18 because the referenced object,DeviceInfo.Processor., is deprecated.

Changes in 2.18:

  • Added status = deprecated
 - 2.1
AvailableUserRoles string[] R

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Device.Users.Role. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. The User Roles which are available to Deployment Units installed into this ExecEnv. Only the listed User Roles may be assigned to a DeploymentUnit.

If this parameter is missing or an empty string then no User Roles will be available to Deployment Units installed into this ExecEnv.

 - 2.18
SetRunLevel() command -

Provides a mechanism to remotely manipulate the run level of this ExecEnv, meaning that altering this comandcommand will change the value of the CurrentRunLevel.

Run levels dictate which Execution Units will be started. Execution Units will be started if CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true.

 - 2.12
ModifyAvailableRoles() command -

[ASYNC] Modify the roles which are available to Deployment Units installed into this ExecEnv.

The command will fail if the new list of roles doesn’t contain a required role of DeploymentUnit installed previously into the ExecEnv.

Changes in 2.18:

 - 2.16
⇒ Input. arguments - Input arguments. -
⇒ AvailableUserRoles string(:256)[] W

[MANDATORY] Comma-separated list of strings (maximum number of characters per item 256). The new list of User Roles which may be assigned to a DeploymentUnit installed into the ExecEnv; this list replaces the previous value of AvailableUserRoles. If this parameter is an empty string then no User Roles can be assigned to a DeploymentUnit installed into the ExecEnv.

Each entry in the list is the Name of a row in Users.Role.

 - 2.18
Restart() command -

[ASYNC] Restart this ExecEnv.

If the ExecEnv is currently disabled, this command will fail and the state of the ExecEnv will not change.

If the ExecEnv is currently enabled, this command has the following effect:

  1. The ExecEnv transitions to status Restarting.
  2. All Deployment Units installed to the ExecEnv will be unaffected, but any Execution Units currently running on the ExecEnv will automatically transition to Idle, exactly as if the ExecEnv had transitioned to status Disabled.
  3. As soon as all the Execution Units have transisitionedtransitioned to Idle, the ExecEnv transitions to status Up. The Execution Units which were running on the ExecEnv will be restarted according to their ExecutionUnit.{i}.AutoStart flag and ExecutionUnit.{i}.RunLevel.
 - 2.16
Device.SoftwareModules.DeploymentUnit.{i}. object(0:) R

This table serves as the Deployment Unit inventory and contains status information about each Deployment Unit.

A new instance of this table gets created during the installation of a Software Module.

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

 - 2.1
Update() command - [ASYNC] Update the associated DeploymentUnit.

Changes in 2.18:

 - 2.1
⇒ Input. arguments - Input arguments. -
⇒ URL string(:2048) W

The [URL] that specifies the location of the DU to be installed.

The URL MUST NOT include the “userinfo” component, as defined in [RFC3986].

The HTTPS transport MUST be supported, and the HTTP transport MAY be supported. Other optional transports MAY also be supported.

If the device receives an Update command with the same source URL as a previous Update or Install comamnd,command, the device MUST perform each Update as requested, and MUST NOT assume that the content of the file to be downloaded is the same each time.

 - 2.12
⇒ Privileged boolean W

This parameter determines whether the DeploymentUnit runs in priviled mode. false - Unprivileged Container. true - Privileged Container.

The default value MUST be false.

 - 2.18
⇒ NumRequiredUIDs unsignedInt W

Number of UIDs (EU User Identifiers) that this container will need as part of its user namespace. UIDs are unique identifiers associated with each user and system process that is used to determine the allocation and isolation of system resources.

The default value MUST be 1.

 - 2.18
⇒ RequiredUserRoles string(:256)[] W

Comma-separated list of strings (maximum number of characters per item 256). If this argument is present, it lists the User Roles which the application will need to be assigned in order to be able to function at all after this update. If it is absent then the required User Roles are unchanged from the previous version.

If any of these User Roles are not present in the ExecEnv.{i}.AvailableUserRoles of the ExecEnv in which the DU is installed then the command will fail. Some Agents may apply further filtering for User Roles which are considered security- or privacy-sensitive.

Each entry in the list is the Name of a row in Users.Role. If there is no such row then the command will fail, as installation requires a User Role which is not available on the Device.

If this argument is an empty string then no User Roles are required in order for the application to function.

 - 2.18
⇒ NetworkConfig. object W

Specifies the network configuration for any ExecutionUnit generatedwhich duringis created by the installation or update of the DeploymentUnit.

When thisThe argumentnew ornetwork configuration supersedes any ofprevious its child objects are missing from the SoftwareModules.InstallDU(), the corresponding absent part is considered unnecessary and will not be available to the ExecutionUnit.configuration.

When this argument is not present in the SoftwareModules.DeploymentUnit.{i}.Update(), the network configuration remains unaltered.

 - 2.17
⇒ AccessInterfaces string(:256)[] W

Comma-separated list of strings (maximum number of characters per item 256). The logical network interfaces which the application installedupdated by this command will be allowed to send traffic through it. If any of these access interface are not present in the SoftwareModules.ExecEnv.{i}.AvailableAccessInterfaces of the ExecEnv into which the DU is to be installedupdated then the command will fail.

Some Agents may apply further filtering for access interfaces which are considered security- or privacy-sensitive. Each entry in the list is the Name of a row inwithin either Logical.Interface. or IP.Interface..

If Name is present in both Logical.Interface. and IP.Interface., the Interface referenced in Logical.Interface. must be selected.

If there is no such row then the command will fail, as installationthe update requires access to a network, through the logical interface, which is not available.

When thisthe argument NetworkConfig is absent or an empty string thenfor the SoftwareModules.DeploymentUnit.{i}.Update(), the AccessInterfaces network configuration remains unaltered.

When the argument NetworkConfig provided in SoftwareModules.DeploymentUnit.{i}.Update(), AccessInterfaces configuration supersedes any previous configuration. If AccessInterfaces is absent or an empty string, it indicate that no outgoing network access is required for the resulting ExecutionUnit to function.

 - 2.17
⇒ NetworkConfig.PortMapping.{i}. object(0:) W

Defines the list of required port mapping rules for any ExecutionUnit which is created as a result of this call command. If this command encounters any issue in providing the requested mapping, such as the port already being used or reserved, then it will fail.

When the argument NetworkConfig is absent or an empty string for the SoftwareModules.DeploymentUnit.{i}.Update(), the PortMapping network configuration remains unaltered.

When the argument NetworkConfig provided in SoftwareModules.DeploymentUnit.{i}.Update(), PortMapping configuration supersedes any previous configuration. If PortMapping is absent or an empty string, it indicate that no port mapping is required for the resulting ExecutionUnit to function.

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

 - 2.17
⇒ Interface string(:256) W [MANDATORY] Name of a row within either Logical.Interface. or IP.Interface.. If Name is present in both Logical.Interface. and IP.Interface., the Interface referenced in Logical.Interface.. must be selected. Specifies the logical interface to which the port mapping applies. - 2.17
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 in 2.18:

 - 2.1
AllocatedEUUID unsignedInt R This parameter is allocated by the host system. This is the user identifier within the execution unit’s environment. This UID is local to the execution unit and is used by the EU’s internal processes to manage permissions. By default, processes within the EU execute as root (UID 0) unless otherwise specified. - 2.18
AllocatedEUGID string R This parameter is allocated by the host system. This is the group identifier within the execution unit’s environment. This GID is local to the execution unit and is used by the EU’s internal processes to manage permissions. - 2.18
AllocatedHostUID unsignedInt R This parameter is allocated by the host system. This is the user identifier on the host system where this EU is running. This UID is system wide and is managed by the kernel. - 2.18
AllocatedHostGID string R This parameter is allocated by the host system. This is the group identifier on the host system where this EU is running. This GID is system wide and is managed by the kernel. - 2.18
CreationTime dateTime R The date and time when the EU was created. - 2.18
Uptime unsignedInt R The amount of time in seconds that this EU has been up and running since it was activated. - 2.18
ShutdownDelay unsignedInt W

The delay in seconds before which the container is shutdown. This delay ensures that the application has enough time to perform any cleanup before the Execution Unit transitions to idle state.

The default value SHOULD be 10.

 - 2.18
Device.SoftwareModules.ExecutionUnit.{i}.AutoRestart. object R

Configures the parameters of the auto-restart algorithm for this EU.

An auto-restart may be triggered if the Agent determines that the EU has terminated abnormally. An exponential backoff algorithm is applied (increasing each time the delay before the EU is re-launched) in order to prevent continual re-starting of the EU.

The retry interval range is controlled by two Parameters, RetryMinimumWaitInterval and RetryIntervalMultiplier.

Let m be the value of RetryMinimumWaitInterval, k the value of RetryIntervalMultiplier, and n the current value of RetryCount. Then on the next occasion that the Agent determines that the EU has terminated abnormally, the delay before re-starting the EU must lie between *m * (k/1000)^n*(k/1000)n* and m * (k/1000)^(n+1)*(k/1000)(n+1)* seconds, so long as m * (k/1000)^n*(k/1000)n* evaluates to a value less than RetryMaximumWaitInterval. Once this point has been reached, on all subsequent occasion that the Agent determines that the EU has terminated abnormally the delay before re-starting the EU must lie between RetryMaximumWaitInterval * (1000/k) and RetryMaximumWaitInterval seconds.

 - 2.16
NextRestart dateTime R The time at which the next restart of the ExecutionUnit is scheduled to occur. The InfinteInfinite Time (9999-12-31T23:59:59Z) is used to indicate that no restart is currently scheduled. - 2.16
Device.XMPP. object R The XMPP represents the XMPP capabilities of the device. - 2.7
Device.XMPP.Connection.{i}. object(0:) W

The Connection represents a XMPP connection between the device and a server. The Username, Domain and Resource comprise the full identity (JabberID) of this Connection for this device.

At most one entry in this table can exist with a given value for Alias, or with the same values for all of Username, Domain and Resource. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, Username, Domain and Resource such that the new entry does not conflict with any existing entries.

 - 2.7
JabberID string R The complete Jabber ID as determined by the first-hop XMPP server at time of connection establishment. This Jabber ID will usually be the standard concatentationconcatenation of the local-part (Username), domain-part (Domain), and resource-part (Resource) as defined in [Section 2.1/RFC6120] (local-part@domain-part/resource-part), but since the Jabber ID is owned by the first-hop XMPP Server there are cases where the value will be different. - 2.7
Device.XMPP.Connection.{i}.Server.{i}. object(0:) W

The Server represents an XMPP server to be used for a Connection.

This table is only relevant when Connection.{i}.ServerConnectAlgorithm is set to ServerTable. If Connection.{i}.ServerConnectAlgorithm is set to DNS-SRV then any instances of this table are ignored by this Connection.

At most one entry in this table can exist with a given value for Alias, or with the same values for both ServerAddress and Port. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and ServerAddress such that the new entry does not conflict with any existing entries.

 - 2.7
ServerAddress string(:256) W

Fully Qualified Domain Name (FQDN) or IP address of the XMPP server for this Connection.

If the value of this Parameter is a FQDN that resolves to multiple addresses then each address SHOULD be attemtpedattempted (in an implemnetation-specificimplementation-specific order) until a connection can be made or all addresses are exhausted, in which case the next Server instance (based on Priority and Weight) SHOULD be used.

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

 - 2.7
Device.IEEE1905. object R This object represents the management functions for the 1905 capabilities as defined in [IEEE1905.1a]. - 2.9
Device.IEEE1905.AL. object R This object represents the management functions for the 1905 Abstraction Layer as defined in [Section 4.4 Abstraction Layer/IEEE1905.1a]. - 2.9
Device.IEEE1905.AL.Interface.{i}. object(0:) R

The 1905 interface table (described in [Sub-clause 5 Abstraction Layer Management/IEEE1905.1a]).

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

Changes in 2.18:

  • Removed dmr_noUniqueKeys = true
 - 2.9
Device.IEEE1905.AL.ForwardingTable. object R This object represents the rules to forward PDUs between interfaces within the 1905 Abstraction Layer. - 2.9
Device.IEEE1905.AL.ForwardingTable.ForwardingRule.{i}. object(0:) W The 1905 fowardingforwarding rule for the ALME-SET-FWD-RULE.request and ALME-GET-FWD-RULES.response with classification criteria as defined in [Table 5-9: ClassificationSet elements/IEEE1905.1a]. - 2.9
InterfaceList string(:256)[] W The list of interfaces to which a frame satisfying the following classification criteria should be forwarded (intfAddressList parameter as defined in [Table 5-8: ALME-SET-FWD-RULE.request parameters and Table 5-12: fwdRuleList elements/IEEE1905.1a]). Comma-separated list of strings (maximum number of characters per item 256). Each list item MUST be the path name of an object, which MUST be a row of an Interface object. If the referenced item is deleted, the corresponding item MUST be removed from the list.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.9
Device.IEEE1905.AL.NetworkTopology. object R This object represents the 1905 Network Topology capabilities of this device. - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}. object(0:) R

This object represents an instance of discovered 1905 Devices in the network (received Topology discovery message as defined in [Clause 6.3.1/IEEE1905.1a]).

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

 - 2.9
AssocWiFiNetworkDeviceRef string R The value MUST be the Path Name of a row in the WiFi.DataElements.Network.Device. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The value MUST be the Path Name of a row in the WiFi.DataElements.Network.Device. table. If the referenced object is deleted, the parameter value MUST be set to an empty string.AssocWiFiNetworkDeviceRef is a reference to a MultiAP.Device or Wi-Fi Network Data Elements Device. Since IEEE 1905.1 is the protocol used by the Wi-Fi Alliance’s EasyMesh specification for communications, this parameter allows the IEEE 1905.1 portion of the data model to reference the associated EasyMesh portion of the data model. - 2.13
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.IEEE1905Neighbor.{i}. object(0:) R

This object represents an instance of an IEEE1905Neighbor for the IEEE1905Device. These values are from the Topology response message as defined in [Table 6-15: 1905 neighbor device TLV/IEEE1905.1a].

At most one entry in this table can exist with the same values for both LocalInterface and NeighborDeviceId.

 - 2.9
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.IEEE1905Neighbor.{i}.Metric.{i}. object(0:) R

This object represents the metrics included in a Link metric response from the IEEE1905Device where LocalInterface is the MAC address of an interface in the receiving 1905 AL as defined in [Table 6-17: 1905 transmitter link metric TLV/IEEE1905.1a].

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

Changes in 2.18:

  • Removed dmr_noUniqueKeys = true
 - 2.9
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 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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

Changes in 2.18:

  • Removed dmr_fixedObject = true
 - 2.10
EnableEncryption boolean W
When true, encryption MUST be used for this MQTT Client instance.
This parameter was DEPRECATED in 2.15 because it duplicates the functionality already handled by the TransportProtocol parameter.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 true 2.14
ConnectRetryTime unsignedInt(1:) W

Connect retry time in seconds defines the wait time before a failed MQTT broker connection is retried.

A failure can either be on the connection level (the TCP/IP or TLS can not be established) or on the Protocol level, the MQTT client does not receive a MQTT CONNACK packet on a MQTT CONNECT packet sent.

If the parameter ConnectRetryIntervalMultiplier is defined, the MQTT client MUST use a random value between ConnectRetryTime*(ConnectRetryIntervalMultiplier/1000)^(n-1)/1000)(n-1) and ConnectRetryTime*(ConnectRetryIntervalMultiplier/1000)^n/1000)n for the connect retry time, with n equals the current retry number. The max number of n is 10, starting with the 11th retry always the value n = 10 is used.

If the parameters ConnectRetryIntervalMultiplier and ConnectRetryMaxInterval are defined, the MQTT client MUST use the value of ConnectRetryMaxInterval if the calculated random value exceeds the value of ConnectRetryMaxInterval.

 5 2.10
Device.MQTT.Client.{i}.Subscription.{i}. object(0:) W

List of MQTT subscriptions handled by the MQTT client.

The MQTT client MUST subscribe with the MQTT broker for all subscription instances, whose parameter Enable is set to true, when it establishes a new connection to the MQTT broker. Disabled subscription instances with Enable set to false will be ignored during connection establishment.

At most one entry in this table can exist with a given value for Alias, or with a given value for Topic. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Topic such that the new entry does not conflict with any existing entries.

Changes in 2.18:

  • Removed dmr_fixedObject = true
 - 2.10
Device.MQTT.Client.{i}.UserProperty.{i}. object(0:) W

List of user properties used by the MQTT client.

This table only applies if ProtocolVersion is set to 5.0.

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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

Changes in 2.18:

  • Removed dmr_fixedObject = true
 - 2.13
Device.MQTT.Client.{i}.Stats. object R

Contains the MQTT client statistics and usage information.

The CPE MUST reset the Stats parameters after the MQTT client gets (re-)enabled or if the MQTT client connects with a new MQTT broker (e.g. BrokerAddress has changed). The CPE MAY retain the values across a reboot if it reconnects with the same MQTT broker.

Changes in 2.18:

  • Removed dmr_fixedObject = true
 - 2.10
Device.MQTT.Broker.{i}. object(0:) W

MQTT broker table. Contains a list of configured MQTT brokers.

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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

Changes in 2.18:

  • Removed dmr_fixedObject = true
 - 2.10
Device.MQTT.Broker.{i}.Bridge.{i}. object(0:) W

Configures MQTT bridges, which are used to communicate with other MQTT brokers.

At most one entry in this table 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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

Changes in 2.18:

  • Removed dmr_fixedObject = true
 - 2.10
Device.MQTT.Broker.{i}.Stats. object R The MQTT broker statistics values. These will reset with each MQTT broker start, either after reboot or if the MQTT broker gets (re-)enabled.

Changes in 2.18:

  • Removed dmr_fixedObject = true
 - 2.10
Device.LMAP. object R This object represents the objects necessary to manage and control the functionality for Large-Scale Measurement of Broadband Performance[RFC7594] as defined in by [LMAPIFM]. - 2.12
Device.LMAP.Report.{i}. object(0:) R

This Report object instance represents a report that is generated by a reporting task where the reporting task is defined as a MeasurementAgent.{i}.Task.{i} and executed as a scheduled action (MeasurementAgent.{i}.Schedule.{i}.Action.{i}).

The Report replicates the MeasurementAgent.{i} object instance’s data at the time of the action exection.execution.

When a BulkData.Profile.{i} object instance is used to communicate a Report instance, the CPE adds a BulkData.Profile.{i}.Parameter.{i} object instance referring to this Report object instance.

 - 2.12
Device.LMAP.Report.{i}.Result.{i}. object(0:) R

The Result object provides the meta-data of the result report of a single executed action that produced the result.

At most one entry in this table can exist with the same values for all of ScheduleName, ActionName and StartTime.

Changes in 2.18:

  • Removed dmr_noUniqueKeys = true
 - 2.12
Device.WWC. object R Base object for Wireline Wireless Convergence. The controller can use this object to learn the supported 5G features and whether the 5G-RG is operating in 5G mode. - 2.14
Device.WWC.AccessNetwork.{i}. object(0:) R

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

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

 - 2.14
RegistrationStatus string R

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

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

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

 - 2.14
Device.WWC.AccessNetwork.{i}.GUTI. object R

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

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

 - 2.14
Device.WWC.URSP.{i}. object(0:) R

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

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

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

 - 2.14
Device.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. - 2.14
Device.PDU.Session.{i}. object(0:) R

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

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

 - 2.14
DNN string(:100) R The Data Network Name used by the PDU. The DNN value may be from the optional S-NSSAI specified at the time of PDU establishment or a default determined by the 5G core. A DNN is analagousanalogous to an LTE APN used the same format defined in [Clause 9.11.2.1A/3GPP-TS.24.501]. - 2.14
Device.PDU.Session.{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 netowrknetwork operator and are specific for each PDU.

For example:

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

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

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

 - 2.14
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 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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.16
Device.Logical.Interface.{i}.Stats. object R

Throughput statistics for this interface. The 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 underlayingunderlying interfaces.

 - 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}.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:

  • This object does not have a LowerLayers parameter.
  • The value LowerLayerDown is not a valid value for its Status parameter.

Because it’s not an interface object, it does not occur in the InterfaceStack table.

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

 - 2.16
Device.XPON.ONU.{i}.ANI.{i}.TC. object R This object represents an ITU-T PON TC layer device. - 2.16
Device.XPON.ONU.{i}.ANI.{i}.TC.PerformanceThresholds. object R Performance thresholds. - 2.16
SignalFail unsignedInt(3:8) R

Signal fail (SF) threshold.

This parameter specifies the downstream bit error rate (BER) threshold to detect the SF alarm. When this value is y, the BER threshold is 10^–y.10-y.

This parameter is based on Signal fail (SF) threshold from [Section 9.2.1/G.988].

 - 2.16
SignalDegrade unsignedInt(4:10) R

Signal degrade (SD) threshold.

This parameter specifies the downstream BER threshold to detect the SD alarm. When this value is x, the BER threshold for SD is 10^–x .10-x. The SD threshold must be lower than the SF threshold; i.e., x > y.

This parameter is based on Signal degrade (SD) threshold from [Section 9.2.1/G.988].

 - 2.16
Device.XPON.ONU.{i}.ANI.{i}.TC.Alarms. object R Alarms at TC level for this ANI. - 2.16
LODS boolean R Loss of downstream syncronization.synchronization. See [G.9807.1]. - 2.16
Device.SSH. object R This object contains global parameters relating to the Secure Shell clients and or servers implementations that are active in the CPE. - 2.16
Device.SSH.Server.{i}. object(0:) W

This object contains parameters relating to a SSH server instance.

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.16
Interface string(:256) W

The value MUST be the Path Name of a row in the IP.Interface. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The IP Interface associated with the Server entry.

If an empty string is specified, the CPEservice MUSTshould uselisten itson bridgingall or routing policy to determine the appropriate interface.interfaces.

 <Empty> 2.16
PID unsignedInt R

Current PIDProcess Identifier of the SSH server instance.

Note: This parameter was demoted to readOnly in the Device:2.18 version.

Changes in 2.18:

  • Changed access = readWrite ⇒ readOnly
 0 2.16
Device.SSH.Server.{i}.Session.{i}. object(0:) R

Active SSH session list.

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

Changes in 2.18:

  • Changed access = readWrite ⇒ readOnly
 - 2.16
User string(:256) R

The value MUST be the Path Name of a row in the Users.User. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The user to whom the session belongs to.

Note: This parameter was demoted to readOnly in the Device:2.18 version.

Changes in 2.18:

  • Changed access = readWrite ⇒ readOnly
  • Removed string(:256) syntax default
 - 2.16
Device.USPServices. object R This object contains information related to installed USP Services. - 2.16
Device.USPServices.USPService.{i}. object(0:) R

This object contains parameters relating to a USPService configuration.

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

Changes in 2.18:

 - 2.16
DeploymentUnitRef string[] R

Comma-separated list of strings. Each list item MUST be the Path Name of the SoftwareModules.DeploymentUnit. object instance that this USP Service is part off.of.. If the referenced object is deleted, the corresponding item MUST be removed from the list.

An empty string means that USP service doesn’t have a corresponding software module.

 - 2.16
ExecutionUnitRef string[] R

Comma-separated list of strings. Each list item MUST be the Path Name of the SoftwareModules.ExecutionUnit. object instance that this USP Service is part of.. If the referenced object is deleted, the corresponding item MUST be removed from the list.

An empty string means that USP service doesn’t have a corresponding software module.

 - 2.18
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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.17
FacilityLevel string[] W

Comma-separated list of strings. Only the log messages with following Facility levels must be logged.

Each list item is an enumeration of:

  • Kern (Kernel messages (0))
  • User (User-level messages (1))
  • Mail (Mail system messages (2))
  • Daemon (System daemons messages (3))
  • Auth (Security/authorization messages (4))
  • Syslog (Messages generated internally by syslogd (5))
  • LPR (Line printer subsystem messages (6))
  • News (Network news subsystem (7))
  • UUCP (UUCP subsystem messages (8))
  • Cron (Clock daemon messages (9))
  • AuthPriv (Security/authorization messages (10))
  • FTP (FTP daemon messages (11))
  • NTP (NTP subsystem messages (12))
  • Audit (Log audit messages (13))
  • Console (Log alert messages (14))
  • Cron2 (Second clock daemon messages (15))
  • Local0 (Local use 0 messages (16))
  • Local1 (Local use 1 messages (17))
  • Local2 (local use 2 messages (18))
  • Local3 (local use 3 messages (19))
  • Local4 (local use 4 messages (20))
  • Local5 (local use 5 messages (21))
  • Local6 (local use 6 messages (22))
  • Local7 (local use 7 messages (23))
  • All (All facilities are selected)

Changes in 2.18:

  • Changed default value = All ⇒ [All]
 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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.17
Device.Syslog.Source.{i}.Network. object R This object describes the configuration parameters for receiving syslog information on a network socket. - 2.17
Interface string(:256) W

The value MUST be the Path Name of a table row. The IP or Logical Interface on which the syslog information will be received. When an empty string is specified the syslog service will listen to all available network interfaces. Example:

  • Device.IP.Interface.1.Device.IP.Interface.1
  • Device.Logical.Interface.1.Device.Logical.Interface.1

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.

 <Empty> 2.17
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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.17
SourceRef string(:256)[] W 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 Source. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Mandatory parameter. Specifies one or multiple sources from where the log messages originate.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.17
FilterRef string(:256)[] W

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 Filter. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. The Filter associated with the Action entry.

When referencing multiple Filter rules, it is mandatory to execute them in the order listed within the parameter.

Example: FilterRef=.Syslog.Filter.3,.Syslog.Filter.1 First filter rule 3 must be executed and then filter rule 1.

When no Filter is specified the log message will not be filtered.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 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
Protocol string W

Protocol to be used to deliver the syslog messages to the remote server.

Note: This parameter was promoted to readWrite in the Device:2.18 version.

Enumeration of:

Changes in 2.18:

  • Changed access = readOnly ⇒ readWrite
 - 2.17
Device.Schedules. object R This object is responsible for managing the schedules that are embedded within the Device. - 2.18
Enable boolean W

Enables or disables the scheduling. If the scheduling is disabled then the status of any enabled Schedule entries will change to StackDisabled.

The default value SHOULD be true.

 - 2.18
ScheduleNumberOfEntries unsignedInt R The number of entries in the Schedule table. - 2.18
Device.Schedules.Schedule.{i}. object(0:) W

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

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.18
Alias string(:64) WO

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

The following mandatory constraints MUST be enforced:

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

Once it’s been set, this parameter is immutable.

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

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

 - 2.18
Enable boolean W Enables or disables this Schedule entry. false 2.18
Status string R

Status of the schedule.

Enumeration of:

  • Active
  • Inactive
  • StackDisabled (When the global Enable is false and the Enable parameter is true, the scheduling is disabled and the status of the enabled Schedule entry must change to StackDisabled. The value of the Enable parameter is not changed)
  • Error (OPTIONAL)
 - 2.18
Description string(:256) W A description of the schedule (human readable string). - 2.18
Day string[] W

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

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
 - 2.18
StartTime string(:5) W

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

Start time is in local time zone.

Possible patterns:

  • <Empty> (an empty string)
  • ([01][0-9]|2[0-3]):[0-5][0-9]
 - 2.18
Duration unsignedInt(1:) W

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

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

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

 - 2.18
InverseMode boolean W When enabled, the Inverse Mode reverses the default behavior of the schedule, creating a dynamic where actions that are typically activated are now deactivated, and vice versa. false 2.18
TimeLeft unsignedInt R

The number of seconds remaining before the next state change will occur. 0 means that schedule is disabled.

Value Change Notification requests for this parameter MAY be denied.

 - 2.18
Device.LocalAgent. 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.

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

Changes in 2.18:

 - 2.12
SupportedProtocols string[1:] R

Comma-separated list (at least 1 item) of strings. USP Message Transfer Protocols supported by this USP Agent. The USP Agent MUST support at least one Protocol.

Each list item is an enumeration of:

  • CoAP (

See [RFC7252].

This enumeration was DEPRECATED in 2.15 because the CoAP MTP was deprecated in USP 1.2.

This enumeration was OBSOLETED in 2.17.

This enumeration was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted

)

 - 2.12
WatchdogNumberOfEntries unsignedInt R The number of entries in the Watchdog table. - 2.18
Device.LocalAgent.MTP.{i}. object(0:) W

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

At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.12
EnableMDNS boolean W

This parameter, when true, enables the advertisement of DNS-SD services defined for this MTP instance using mDNS as defined in [RFC6762].

This parameter cannot be set to true if there are multiple MTP instances with the same value of the Protocol parameter.

When true, the hostname advertised in the SRV record MUST be a Fully Qualified Domain Name (FQDN).

The interfaces that advertise these DNS-SD services are restricedrestricted to the set of interfaces associated with this MTP instance and the interfaces defined by the DNS.SD.Advertise.{i}.Interface parameter.

 true 2.12
Device.LocalAgent.MTP.{i}.CoAP. object(0:1) R
If the USP Endpoint uses the CoAP Message Transfer Protocol (MTP), then this object contains CoAP specific configuration parameters.
This object was DEPRECATED in 2.15 because the CoAP MTP was deprecated in USP 1.2.
This object was OBSOLETED in 2.17.
This object was DELETED in 2.18.
This object MUST be present if, and only if, Protocol is CoAP.
This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.12
Device.LocalAgent.Watchdog.{i}. object(0:) W

Each Watchdog instance of this table represents a Watchdog Event. A Watchdog instance is used to detect the lack of an expected update of a parameter value within a certain time window ReloadTimerValue. In case this timer expires, meaning RemainingTimerValue becomes 0, a notification event Watchdog!, will be sent to the Controller. This is because timely parameter updates are required, e.g. for SLA or security reasons.

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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.18
Alias string(:64) WO

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

The following mandatory constraints MUST be enforced:

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

Once it’s been set, this parameter is immutable.

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

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

 - 2.18
Enable boolean W Enable/Disable this Watchdog instance. If the Watchdog instance is disabled, the Watchdog! will not be invoked, even if there is a Subscription instance that references it. The RemainingTimerValue will be set to 0. If the Watchdog instance is set to enabled, the RemainingTimerValue will be set to the value of ReloadTimerValue. false 2.18
ReloadTimerValue unsignedInt W Watchdog timer reload value in seconds. Every time the Reference value is updated, this ReloadTimerValue is used to reload the RemainingTimerValue. - 2.18
RemainingTimerValue unsignedInt R

This value is decreased every seconds. When 0, the Watchdog timer expires, an Watchdog! event will be generated.

Value Change Notification requests for this parameter MAY be denied.

 - 2.18
Status string R

The operational status of the Watchdog instance.

When the value of RemainingTimerValue becomes 0, this Status will become Expired and a Watchdog! event will be triggered. Watchdog will not be restarted, meaning that the RemainingTimerValue will stay at 0 until the Reset() command is invoked.

Enumeration of:

 Inactive 2.18
Reference string W The Reference consists of a Path Name or Search Path that determines the element(s) of the data model that the Watchdog is applicable to. When more than one Reference is used, the Watchdog timer will only be stopped if all Parameters, referenced by Reference are updated. If one of the referenced Parameters is not updated, either with the same or different value, an Watchdog! will be generated. If all parameters, referenced by Reference, are updated, the RemainingTimerValue is set to the value of the ReloadTimerValue. - 2.18
SeverityIndication string W

Provides an indication of the severity which will be included in the generated Watchdog! event when the Watchdog instance expires.

Enumeration of:

  • Info
  • Minor
  • Major
  • Critical
 Info 2.18
Controller string R

The value MUST be the Path Name of the Controller instance that created Watchdog. If the referenced object is deleted, this instance MUST also be deleted (so the parameter value will never be an empty string).

The value of this parameter is automatically populated by the USP Agent upon Watchdog creation using the reference to the USP Controller that created the instance.

The USP Controller referenced by this parameter also defines the set of permissions to use when evaluating the Watchdog. Furthermore, only the USP Controller referenced by this parameter will receive a Watchdog! Event (assuming it has an associated Subscription), even if another USP Controller has an associated Subscription.

 - 2.18
Reset() command - When the Reset() is invoked, the RemainingTimerValue will be set to the ReloadTimerValue and the Status to either Active or Inactive depending on the value of the Enable parameter. - 2.18
Watchdog! event -

Watchdog event requested via a Watchdog object.

When the RemainingTimerValue becomes 0 because the value of the Reference was not updated then the Watchdog Event will be invoked.

 - 2.18
⇒ Reference string R The parameter Reference for which the Watchdog has been triggered. - 2.18
⇒ ReloadTimerValue unsignedInt R The ReloadTimerValue Value in seconds. - 2.18
⇒ SeverityIndication string R The SeverityIndication Value. - 2.18
Device.LocalAgent.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 can exist with a given value for EndpointID, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.12
Device.LocalAgent.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 can exist with a given value for Protocol, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Protocol and Alias such that the new entry does not conflict with any existing entries.

 - 2.12
Device.LocalAgent.Controller.{i}.MTP.{i}.CoAP. object(0:1) R
If the USP Endpoint uses the CoAP Message Transfer Protocol (MTP), then this object contains CoAP specific configuration parameters.
This object was DEPRECATED in 2.15 because the CoAP MTP was deprecated in USP 1.2.
This object was OBSOLETED in 2.17.
This object was DELETED in 2.18.
This object MUST be present if, and only if, Protocol is CoAP.
This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 - 2.12
Device.LocalAgent.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.13
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.

Changes in 2.18:

  • Changed status = deprecated ⇒ obsoleted
 <Empty> 2.13
Device.LocalAgent.Controller.{i}.E2ESession. object R The E2ESession object represents the End to End (E2E) Session Context functionality for this Controller.{i} object instance. - 2.12
Enable boolean W
Enable/Disable this E2ESession instance.
When true, Session Context is used when exchanging USP Records with the remote endpoint represented by this Controller.{i} object instance.
When false, Session Context is not used when exchanging USP Records with the remote endpoint represented by this Controller.{i} object instance.
This parameter was DEPRECATED in 2.15 because it is replaced by SessionMode.
This parameter was OBSOLETED in 2.17.
This parameter was DELETED in 2.18.

Changes in 2.18:

  • Changed status = obsoleted ⇒ deleted
 false 2.12
SegmentedPayloadChunkSize unsignedInt(0,512:) W
The maximum size, in bytes, of the Record (payload(s) and headers) that can be transmitted to the remote endpoint. The smallest size, which can be configured is 512 bytes.
A value of 0 means that the segmentation function is effectively disabled.
This parameter was DEPRECATED in 2.16 because it is replaced by MaxUSPRecordSize.
This parameter was OBSOLETED in 2.18.

Changes in 2.18:

  • Changed status = deprecated ⇒ obsoleted
 0 2.12
Device.LocalAgent.ControllerTrust. object R This object contains information that an Agent applies when establishing a trust relationship with a Controller. - 2.12
Device.LocalAgent.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 can exist with a given value for Name, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Name and Alias such that the new entry does not conflict with any existing entries.

 - 2.12
Device.LocalAgent.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 can exist with a given value for Order, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.12
Targets string[] W

Comma-separated list of strings, each entry is a target to which the value of the permissions parameters are assigned.

When an entry is a value of a Partial Path, the permissions are associated to that Object and any child Object/Parameter.

When the value of an entry is an Object instance then the permissions are associated to all Parameters of the Object instance.

When an entry is a value of a Search Path as defined in [TR-369] that resolves to zero or more Parameter Paths, then all Parameter Paths that result from the evaluation of the Search Path are subject to the permissions assigned by this Permission instance.

Changes in 2.18:

  • Changed default value = ““ ⇒ []
 <Empty> 2.12
Param string(4) W

The permissions of a Role for the specified Targets.

A string of 4 characters where each character represents a permission (“r”(“r” for Read, “w”“w” for Write, “x”“x” for Execute“, and “n”“n” for Notify).

The string is always in the same order (rwxn)(rwxn) and the lack of a permission is signified by a “-”“-” character (e.g., r–n).r--n).

The following describes the meaning of the permissions for Parameter type of Targets:

  1. Read: Grants the capability to read the value of the Parameter via Get and read the meta-information of the Parameter via GetSupportedDM.
  2. Write: Grants the capability to update the value of the Parameter via Add or Set.
  3. Execute: Grants no capabilities; Parameters can not be executed.
  4. Notify: Grants the capability to receive Notify Messages of type ValueChange for this Parameter.
 ---- 2.12
Obj string(4) W

The permissions of a Role for the specified Targets.

A string of 4 characters where each character represents a permission (“r”(“r” for Read, “w”“w” for Write, “x”“x” for Execute“, and “n”“n” for Notify).

The string is always in the same order (rwxn)(rwxn) and the lack of a permission is signified by a “-”“-” character (e.g., r–n).r--n).

The following describes the meaning of the permissions for Object type of Targets:

  1. Read: Grants the capability to read the meta-information of the Object via GetSupportedDM.
  2. Write: Grants no capabilities for Static Objects. Grants the capability to create a new instance of a Multi-Instanced Object via Add (e.g. Device.LocalAgent.Controller.).
  3. Execute: Grants no capabilities; Objects are not executable and Commands are controlled by the CommandEventPermissions.
  4. Notify: Grants the capability to receive Notify Messages of type ObjectCreation for this Object (multi-instance objects only).
 ---- 2.12
InstantiatedObj string(4) W

The permissions of a Role for the specified Targets.

A string of 4 characters where each character represents a permission (“r”(“r” for Read, “w”“w” for Write, “x”“x” for Execute“, and “n”“n” for Notify).

The string is always in the same order (rwxn)(rwxn) and the lack of a permission is signified by a “-”“-” character (e.g., r–n).r--n).

The following describes the meaning of the permissions for Instantiated Object type of Targets:

  1. Read: Grants the capability to read the instance numbers and unique keys of the Instantiated Object via GetInstances and read the value of Parameters related to the Instantiated Object via a Get containing a search expression or wildcard in place of the instance identifier.
  2. Write: Grants the capability to remove an existing instance of an Instantiated Object via Delete (e.g. Device.LocalAgent.Controller.1.).
  3. Execute: Grants no capabilities; Object Instances are not executable and Commands are controlled by the CommandEventPermissions.
  4. Notify: Grants the capability to receive Notify Messages of type ObjectDeletion for this Instantiated Object.
 ---- 2.12
CommandEvent string(4) W

The permissions of a Role for the specified Targets.

A string of 4 characters where each character represents a permission (“r”(“r” for Read, “w”“w” for Write, “x”“x” for Execute“, and “n”“n” for Notify).

The string is always in the same order (rwxn)(rwxn) and the lack of a permission is signified by a “-”“-” character (e.g., r–n).r--n).

The following describes the meaning of the permissions for Command and Event type of Targets:

  1. Read: Grants the capability to read the meta-information of the Command (including input and output arguments) and Event (including arguments) via GetSupportedDM.
  2. Write: Grants no capabilities; Commands are executed instead of written to and Events are read only.
  3. Execute: Grants the capability to execute the Command via Operate, but grants no capabilities to an Event.
  4. Notify: Grants the capability to receive Notify Messages of type OperationComplete for this Event or Command.
 ---- 2.12
Device.LocalAgent.ControllerTrust.Credential.{i}. object(0:) W

Each instance of this table represents a trusted credential. The credential can be that of a certificate authority (CA) for a Controller whose EndpointID is unknown.

When a credential is supplied to the Agent by a Controller during authentication, the credentials in this table are used to determine if any of the supplied certificates (including those in the chain of trust) are considered “trusted”.

If the Controller authenticated via an entry in this table is not previously known to the Agent, the associated Roles specified in the **{{param: empty ref only valid in parameter descriptions}}**Role entry is parameter might be automatically applied to the Controller.applied, depending on the value of the AllowedUses parameter.

At most one entry in this table can exist with a given value for Credential, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Credential and Alias such that the new entry does not conflict with any existing entries.

 - 2.12
AllowedUses string W

Identifies what usages the Certificate Authority (CA) authenticated by the associated credential is trusted to authorize.

Enumeration of:

  • MTP-only (The CA can only authorize MTP (domain) connectivity, and cannot authenticate Controllers, i.e. no Roles are automatically applied.)
  • MTP-and-USP (The CA can authorize MTP (domain) connectivity and authenticate Controller, i.e. the Role parameter applies.)
  • MTP-and-broker (The CA can authorize MTP (domain) connectivity and the presenter of a certificate signed by such CA is trusted to have authenticated the identity of Endpoints whose Records it transmits. Any Controller communicating through such a Broker is automatically authenticated, i.e. the Role parameter applies. See [“Authentication and Authorization”/TR-369] for additional description of the Trusted Broker concept.)
 - 2.12
Device.LocalAgent.Subscription.{i}. object(0:) W

A Subscription dictates how a USP Agent issues USP Notification Messages to a USP Controller, executes an automated configuration action, or both, as controlled by TriggerAction.

At most one entry in this table can exist with a given value for Alias, or with the same values for both Recipient and ID. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, Recipient and ID such that the new entry does not conflict with any existing entries.

 - 2.12
TriggerConfigSettings string[:16] W

Comma-separated list (up to 16 items) of strings. Each entry is a name-value pair representing the name of the data model parameter to configure and the value to configure it with.

Each entry in the comma-separated list will use the following format: =

The Parameter Value will be formatted per the value type, which means that string values will be quoted while unsignedInt values will be unquoted numeric values, etc..

When the monitored event occurs, then the TriggerConfigSettings will be executed if the TriggerAction is set to Config or NotifyAndConfig.

Changes in 2.18:

  • Changed access = readOnly ⇒ readWrite
 - 2.16
Device.ProxiedDevice.{i}. object(0:) R

Each entry in the table is a ProxiedDevice object that is a mount point. Each ProxiedDevice represents distinct hardware Devices. ProxiedDevice objects are virtual and abstracted representation of functionality, that exists on hardware other than that which the Agent is running.

This object is a mount point, under which mountable objects can be mounted.

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

 - 2.12
Device.ProxiedDevice.{i}.Node.{i}. object(0:) R

Each Node instance represents distinct functional devices, which are virtual and abstracted representation of functionality.

This object is a mount point, under which mountable objects can be mounted.

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

 - 2.13
Alias string(:64) WO

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

The following mandatory constraints MUST be enforced:

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

Once it’s been set, this parameter is immutable.

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

Changes in 2.18:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.13
Device.IoTCapability.{i}. object(0:) R

This list of IoT capability objects.

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

 - 2.13
Alias string(:64) WO

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

The following mandatory constraints MUST be enforced:

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

Once it’s been set, this parameter is immutable.

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

Changes in 2.18:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.13
Device.IoTCapability.{i}.BinarySensor. object(0:1) R

BinarySensor is used to reflect the functionality of a sensor that reports a Value. The Sensitivity configures the degree of sensitivity that the sensor uses for detection.

Timed BinarySensor profile - To provide the ability to add time based control over the Value attribute. How long the Value remains true is controlled by the HoldTime. RestTime controls how soon, after being activated, the sensor will respond to continuous events.

This object MUST be present if, and only if, Class is BinarySensor.

This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time.

Changes in 2.18:

 - 2.13
LastContactTime dateTime R The date and time in UTC when the BinarySensor has received data. - 2.18
Device.IoTCapability.{i}.LevelSensor. object(0:1) R

LevelSensor is used to reflect the functionality of a sensor that reports a Value in Unit.

This object MUST be present if, and only if, Class is LevelSensor.

This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time.

Changes in 2.18:

 - 2.13
LastContactTime dateTime R The date and time in UTC when the LevelSensor has received data. - 2.18
Device.IoTCapability.{i}.MultiLevelSensor. object(0:1) R

MultiLevelSensor is used to reflect the functionality of a sensor that reports multiple Values with the same Unit.

This object MUST be present if, and only if, Class is MultiLevelSensor.

This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time.

Changes in 2.18:

 - 2.13
LastContactTime dateTime R The date and time in UTC when the MultiLevelSensor has received data. - 2.18
Device.IoTCapability.{i}.EnumSensor. object(0:1) R

EnumSensor is used to reflect the functionality of a sensor that reports explicit non-continuous values.

This object MUST be present if, and only if, Class is EnumSensor.

This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time.

Changes in 2.18:

 - 2.13
LastContactTime dateTime R The date and time in UTC when the EnumSensor has received data. - 2.18
Device.Node.{i}. object(0:) R

Each Node instance represents distinct functional devices, which are virtual and abstracted representation of functionality.

This object is a mount point, under which mountable objects can be mounted.

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

 - 2.13
Alias string(:64) WO

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

The following mandatory constraints MUST be enforced:

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

Once it’s been set, this parameter is immutable.

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

Changes in 2.18:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.13

Generated by Broadband Forum bbfreport v2.2.0 (2024-07-23 version) on 2024-09-04 at 09:53:02 UTC.
report.py –include ../../install/cwmp –output –transform diff –format markdown tr-181-2-17-0-usp.xml tr-181-2-18-1-usp.xml

Table of Contents