Broadband Forum

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

tr-181-2-17-0-cwmp.xml

DATA MODEL DEFINITION

License

Copyright (c) 2010-2023, 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
base64 -

Base64 encoded binary (no line-length limitation).

A minimum and maximum allowed length can be indicated using the form base64(Min:Max), where Min and Max are the minimum and maximum length in characters before Base64 encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in base64(Max). Multiple comma-separate ranges can be specified, in which case the length MUST be in one of the ranges.

boolean - Boolean, where the allowed values are 0 or 1 (or equivalently, true or false).
dateTime - The subset of the ISO 8601 date-time format defined by the SOAP dateTime type [SOAP1.1].
hexBinary -

Hex encoded binary.

A minimum and maximum allowed length can be indicated using the form hexBinary(Min:Max), where Min and Max are the minimum and maximum length in characters before Hex Binary encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in hexBinary(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges.

int -

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

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

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

Unsigned integer in the range 0 to 4294967295, inclusive.

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

unsignedLong -

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

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

Alias string(:64)

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.
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.
DiagnosticsState string

Indicates the availability of diagnostics data. Enumeration of:

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Error (READONLY, OPTIONAL)

If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested.

When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test.

When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above.

If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate.

When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message.

After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None.

Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None.

While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None.

While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters.

While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with “Invalid Parameter value” (9007) to the ACS instead.

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.

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])
MocaBand string[]

Represents the MoCA Bands and sub-bands the device is configured to operate in or that the device supports. Each list item is an enumeration of:

  • reserved (READONLY)
  • bandFCBL
  • bandFSAT
  • bandE
  • bandExD
  • bandDH
  • bandDL
  • noBand

See [Section 15/MoCAv2.0].

MocaChannelIndex string

Represents the MoCA 2.0 primary or secondary channel, or MoCA 2.5 first, second, third, fourth, or fifth channel.

Enumeration of:

  • primary
  • secondary
  • m25first
  • m25second
  • m25third
  • m25fourth
  • m25fifth
MocaChannelMask hexBinary(8)

Represents one or more MoCA channel RF center frequencies using a hexadecimal encoded 64-bit mask.

Bit 63 (the leftmost bit of the leftmost character) is the most significant bit (highest frequency), and bit 0 (the rightmost bit of the rightmost character) is the least significant bit (lowest frequency). Not all bits are valid MoCA channels.

Each bit represents 25 MHz of spectrum, but the mapping from bits to frequencies varies with the MoCA version:

  • MoCA 1.0 and MoCA 1.1: bits 63 through 32 are not used, bit 31 represents 1575 MHz and bit 0 represents 800 MHz
  • MoCA 2.0 and MoCA 2.5: bit 63 represents 1975 MHz and bit 0 represents 400 MHz

For example, a MoCA 1.0 or MoCA 1.1 interface would use 0x000000001FFFC000 to represent 1150 MHz through 1500 MHz.

Note that the MoCA version is indicated by the HighestVersion parameter.

MocaDB unsignedInt Represents one decibel or 1 dB.
MocaDBm int

Represents a measure of power in mW expressed in decibels, and calculated as follows:

power = 10*log10( Vrms^2 / R * 1000 )

where Vrms is the root-mean-square Voltage of the received waveform and R is 75 ohms.

MocaFlowIngrClassRule string

Represents the MoCA 2.0 PQOS Ingress Classification Rule.

Enumeration of:

  • ruleDAVLANtag4or5
  • ruleDAonly
  • ruleDAandDSCPnoVLAN
  • ruleDAandVLANignoreDSCP
  • ruleDAandVLANorDSCP
MocaMacRate unsignedInt Represents the MAC throughput in Kbps.
MocaNodeID unsignedInt(0:15)

Represents a MoCA Node ID.

  • MoCA 1.0 network can have a maximum of 8 MoCA Nodes, so Node ID is 0 to 7.
  • MoCA 1.1, MoCA 2.0, or MoCA 2.5 network can have a maximum of 16 MoCA Nodes, so Node ID is 0 to 15.
MocaPhyRate unsignedInt(0:2048) Represents the transmit PHY rate in Mbps.
MocaPowerState string

Represents the Power State defined by the MoCA2.0 specification.

Enumeration of:

  • m0Active (Power State M0: Active)
  • m1LowPowerIdle (Power State M1: Low Power Idle)
  • m2Standby (Power State M2: Standby)
  • m3Sleep (Power State M3: Sleep)

See [Section 12/MoCAv2.0].

MocaPrivacy string

Represents a type of MoCA Privacy.

Enumeration of:

  • mocaReserved5
  • mocaReserved4
  • mocaReserved3
  • mocaReserved2
  • mocaReserved1
  • moca2EnhancedPrivacy
  • moca20Privacy
  • moca1Privacy
MocaScMod hexBinary

Represents the subcarrier modulation.

Binary string array (array of two hexadecimal characters) with 1 byte for each subcarrier. The value of each byte represents the subcarrier modulation for the corresponding subcarrier.

See [Section 14.3.6.3/MoCAv2.0] and [Appendix A/MOCA20-MIB] for the encoding of this parameter.

Order unsignedInt(1:)

Position of the object entry in the order of precedence. A value of 1 indicates the first entry to be considered (highest precedence).

When a object instance is created, or when an existing parameter value is modified, if the value matches that of an existing entry, the parameter values for the existing entry and all lower parameter entries are incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes parameter values to be compacted. When a value is changed, incrementing occurs before compaction.

If no parameter value is supplied on creation of a object instance, it MUST be assigned a value that is one more than the largest current value (lowest precedence).

RowStatus string

Cut-down version of SNMP RowStatus that supports only its “status” values, not its “control” values.

Enumeration of:

  • active (The row is available for use by the managed device)
  • notInService (The row exists in the Agent, but is unavailable for use by the managed device (see NOTE below); “notInService” has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device)
  • notReady (The row exists in the Agent, but is missing information necessary in order to be available for use by the managed device, i.e., one or more required parameter in the row have not been populated)
  • createAndGo (Not used)
  • createAndWait (Not used)
  • destroy (Not used)
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.

References

[3GPP-TS.23.501] 3GPP TS 23.501, System architecture for the 5G System (5GS); Stage 2, 3GPP SA WG2.
[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.
[802.11-2016] IEEE Std 802.11-2016, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, December 2016.
[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.11be] IEEE Std 802.11be, Enhancements for Exteremely High Throughput (EHT) WLAN - Draft, IEEE, March 2019.
[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-2012_section6] IEEE 802.3-2012 - Section Six, IEEE Standard for Ethernet - Section Six, IEEE, December 2012.
[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.
[EasyConnect] Wi-Fi Easy Connect Specification, Wi-Fi Easy Connect Specification, Wi-Fi Alliance, December 2020.
[EasyMesh] EasyMesh Specification, Wi-Fi EasyMesh Specification, Wi-Fi Alliance, December 2021.
[ETSIM2MFA] ETSI TS 102 690 v1.1.6, Machine-to-Machine Communications (M2M Functional Architecture), ETSI, June 2012.
[ETSIM2MInterfaces] ETSI TS 102 921 v1.1.6, M2M mIa, dIa and mId Interfaces, ETSI, August 2012.
[G.9701] G.9701, Fast access to subscriber terminals (G.fast)- Physical layer specification, ITU-T, 2014.
[G.9807.1] G.9807.1, 10-Gigabit-capable symmetric passive optical network (XGS-PON), ITU-T, June 2016.
[G.984.3] G.984.3, Gigabit-capable passive optical networks (G-PON): Transmission convergence layer specification, ITU-T, January 2010.
[G.987.3] G.987.3, 10-Gigabit-capable passive optical networks (XG-PON): Transmission convergence (TC) layer specification, ITU-T, January 2014.
[G.988] G.988, ONU management and control interface (OMCI) specification, ITU-T, 2010.
[G.989.3] G.989.3, 40-Gigabit-capable passive optical networks (NG-PON2): Transmission convergence layer specification, ITU-T, May 2021.
[G.992.3] G.992.3, Asymmetric digital subscriber line transceivers 2 (ADSL2), ITU-T.
[G.992.4] G.992.4, Splitterless asymmetric digital subscriber line transceivers 2 (splitterless ADSL2), ITU-T.
[G.992.5] G.992.5, Asymmetric Digital Subscriber Line (ADSL) transceivers - Extended bandwidth ADSL2 (ADSL2plus), ITU-T.
[G.993.1] G.993.1, Very high speed digital subscriber line transceivers, ITU-T.
[G.993.2] G.993.2, Very high speed digital subscriber line transceivers 2 (VDSL2), ITU-T.
[G.994.1] G.994.1, Handshake procedures for digital subscriber line (DSL) transceivers, ITU-T.
[G.9954] G.9954, Phoneline networking transceivers - Enhanced physical, media access, and link layer specifications (HPNA 3.0 and 3.1), ITU-T, 2007.
[G.996.2] G.996.2, Single-ended line testing for digital subscriber lines (DSL), ITU-T.
[G.9960] G.9960, Unified high-speed wire-line based home networking transceivers - System architecture and physical layer specification, ITU-T.
[G.9961] G.9961, Unified high-speed wire-line based home networking transceivers - Data link layer specification, ITU-T.
[G.9964] G.9964, Unified high-speed wire-line based home networking transceivers - Power spectral density specification, ITU-T.
[G.997.1] G.997.1, Physical layer management for digital subscriber line (DSL) transceivers, ITU-T.
[HPAV1.1] HomePlug™ AV Specification, Version 1.1, HomePlug Alliance, 2007.
[IANA-uri-schemes] IANA Uniform Resource Identifier (URI) Schemes Registry, Uniform Resource Identifier (URI) Schemes, IANA.
[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.
[LMAPIFM] RFC 8193, Information Model for Large-Scale Measurement Platforms (LMAPs), IETF, August 2017.
[MOCA11-MIB] MOCA11-MIB, Remote Management of MoCA Interfaces using SNMP MIB, MoCA Alliance, 2009.
[MOCA20-MIB] MOCA20-MIB, Remote Management of MoCA Interfaces using SNMP MIB v2.0, MoCA Alliance, 2020.
[MOCA25-MIB] MOCA25-MIB, Remote Management of MoCA Interfaces using SNMP MIB v2.5 (Approved draft), MoCA Alliance, 2018.
[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.
[RFC1035] RFC 1035, Domain Names - Implementation and Specification, IETF, 1987.
[RFC1661] RFC 1661, The Point-to-Point Protocol (PPP), IETF, 1994.
[RFC2131] RFC 2131, Dynamic Host Configuration Protocol, IETF.
[RFC2782] RFC 2782, A DNS RR for specifying the location of services (DNS SRV), IETF, 2000.
[RFC2784] RFC 2784, Generic Routing Encapsulation (GRE), IETF, November 2000.
[RFC2819] RFC 2819, Remote Network Monitoring Management Information Base, IETF, 2000.
[RFC2863] RFC 2863, The Interfaces Group MIB, IETF, 2000.
[RFC2890] RFC 2890, Key and Sequence Number Extensions to GRE, IETF, November 2000.
[RFC3315] RFC 3315, Dynamic Host Configuration Protocol for IPv6 (DHCPv6), IETF, 2003.
[RFC3633] RFC 3633, IPv6 Prefix Options for Dynamic Host Configuration Protocol (DHCP) version 6, IETF, 2003.
[RFC3931] RFC 3931, Layer Two Tunneling Protocol - Version 3 (L2TPv3), IETF, March 2005.
[RFC3986] RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF.
[RFC4007] RFC 4007, IPv6 Scoped Address Architecture, IETF.
[RFC4122] RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.
[RFC4191] RFC 4191, Default Router Preferences and More-Specific Routes, IETF, 2005.
[RFC4193] RFC 4193, Unique Local IPv6 Unicast Addresses, IETF, 2005.
[RFC4291] RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006.
[RFC4292] RFC 4292, IP Forwarding Table MIB, IETF, 2006.
[RFC4293] RFC 4293, Management Information Base for the Internet Protocol (IP), IETF, 2006.
[RFC4301] RFC 4301, Security Architecture for the Internet Protocol, IETF, December 2005.
[RFC4302] RFC 4302, IP Authentication Header, IETF, December 2005.
[RFC4303] RFC 4303, IP Encapsulating Security Payload (ESP), IETF, December 2005.
[RFC4632] RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan, IETF, 2006.
[RFC4719] RFC 4719, Transport of Ethernet Frames over Layer 2 Tunneling Protocol Version 3 (L2TPv3), IETF, November 2006.
[RFC4861] RFC 4861, Neighbor Discovery for IP version 6 (IPv6), IETF, 2007.
[RFC4862] RFC 4862, IPv6 Stateless Address Autoconfiguration, IETF, 2007.
[RFC5280] RFC 5280, Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile, IETF, May 2008.
[RFC5424] RFC 5424, The Syslog Protocol, IETF, May 2009.
[RFC5425] RFC 5425, Transport Layer Security (TLS) Transport Mapping for Syslog, IETF, May 2009.
[RFC5426] RFC 5426, Transmission of Syslog Messages over UDP, IETF, May 2009.
[RFC5625] RFC 5625, DNS Proxy Implementation Guidelines, IETF, 2009.
[RFC5969] RFC 5969, IPv6 Rapid Deployment on IPv4 Infrastructures (6rd) - Protocol Specification, IETF, 2010.
[RFC5996] RFC 5996, Internet Key Exchange Protocol Version 2 (IKEv2), IETF, September 2010.
[RFC6106] RFC 6106, IPv6 Router Advertisement Option for DNS Configuration, IETF, 2010.
[RFC6587] RFC 6587, Transmission of Syslog Messages over TCP, IETF, April 2012.
[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.
[RFC7348] RFC 7348, Virtual eXtensible Local Area Network (VXLAN), IETF, August 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.
[RFC862] RFC 862, Echo Protocol, IETF, 1983.
[RFC8822] RFC 8822, 5G Wireless Wireline Convergence User Plane Encapsulation (5WE), IETF, April 2021.
[RFC8966] RFC 8966, The Babel Routing Protocol, IETF, January 2021.
[RFC8967] RFC 8967, MAC Authentication for the Babel Routing Protocol, IETF, January 2021.
[RFC8968] RFC 8968, Babel Routing Protocol over Datagram Transport Layer Security, IETF, January 2021.
[RFC9046] RFC 9046, Babel Information Model, IETF, June 2021.
[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-143] TR-143 Amendment 1 Corrigendum 1, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, August 2015.
[TR-159] TR-159, Management Framework for xDSL Bonding, Broadband Forum, December 2008.
[TR-181i2] TR-181 Issue 2 Amendment 15, Device Data Model, Broadband Forum, January 2022.
[TR-232] TR-232, Bulk Data Collection, Broadband Forum, May 2012.
[TR-304] TR-304, Broadband Access Service Attributes and Performance Metrics, Broadband Forum, February 2015.
[TR-369] TR-369 Issue 1 Amendment 2, User Services Platform, Broadband Forum, January 2022.
[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.
[UPA-PLC] Universal Powerline Association, UPA.
[USB1.0] USB 1.0, USB 1.0 Specification, USB-IF, January 1996.
[USB2.0] USB 2.0, USB 2.0 Specification, USB-IF, April 2000.
[USB3.0] USB 3.0, USB 3.0 Specification, USB-IF, November 2008.
[WMM] Wi-Fi Multimedia Technical Specification, Wi-Fi Multimedia Technical Specification, Wi-Fi Alliance, May 2012.
[WPS 2.0] WSC 2.0, Wi-Fi Simple Configuration Technical Specification Version 2.0.x, Wi-Fi Alliance.
[WPSv1.0] Wi-Fi Protected Setup Specification Version 1.0h, Wi-Fi Alliance, 2006.
[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.
Parameter definition.

Device:2.17 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.17:

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

Changes in 2.17:

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

Changes in 2.17:

 - 2.0
LogRotateNumberOfEntries unsignedInt R The number of entries in the LogRotate table. - 2.17
Device.ManagementServer. object R This object contains parameters relating to the CPE’s association with an ACS. - 2.0
Device.ManagementServer.DownloadAvailability. object R This object contains multicast announcement and query parameters used for the purpose of downloading files. - 2.0
Device.ManagementServer.DownloadAvailability.Announcement. object R This object contains multicast announcement parameters used to download files. - 2.0
Device.ManagementServer.DownloadAvailability.Announcement.Group.{i}. object(0:) W

Multicast groups to which the CPE SHOULD listen for announcements.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for URL.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.3
Device.ManagementServer.InformParameter.{i}. object(0:) W

This table provides the ACS with the ability to control the Parameters that are delivered by the Inform RPC.

Any Parameter (identified by ParameterName) contained in this table MUST be included within the ParameterList argument of the Inform RPC whenever any Event within the EventList is being delivered.

This table does not include Forced Inform Parameters, and Forced Inform Parameters are not allowed to be inserted into this table. Any attempt by an ACS to configure this table to contain a Forced Inform Parameter MUST result in the failure of the SetParameterValues RPC with error code 9007.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for ParameterName.

 - 2.8
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.8
Device.DeviceInfo.VendorConfigFile.{i}. object(0:) R

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

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

Whenever the CPE successfully downloads a configuration file as a result of the Download RPC with the FileType argument of ‘‘3 Vendor Configuration File’’, the CPE MUST update this table.

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

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.DeviceInfo.TemperatureStatus. object R Status of the temperature of the device. - 2.0
Device.DeviceInfo.TemperatureStatus.TemperatureSensor.{i}. object(0:) R

This object represents information that the device has obtained via sampling an internal temperature sensor.

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

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.3
Device.DeviceInfo.Processor.{i}. object(0:) R

Each table entry represents a hardware or virtual processor that resides on this device.

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

 - 2.1
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.3
Device.DeviceInfo.LogRotate.{i}. object(0:) W

This Object details the available rotation settings for vendor log file rotation.

Based on [A YANG Data Model for Syslog Configuration/YANGSYSLOG].

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name.

 - 2.17
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

 - 2.17
Enable boolean W Enables or disables the log rotation functionality for this item. - 2.17
Name string W Specifies the full path and filename of the log file that must be rotated. Which MUST use the uri scheme file [The file URI Scheme/RFC8089]. - 2.17
NumberOfFiles unsignedInt(1:) W

Specifies the maximum number of log files retained. When during log rotation the maximum number of log files is reached, the oldest log file will be deleted.

Specify 1 for implementations that only support one log file.

 - 2.17
MaxFileSize unsignedInt W Specifies the maximum log file size in KiB. Log events that arrive after the maximum file size is reached will cause the current log file to be closed and a new log file to be opened. - 2.17
RollOver unsignedInt W Specifies the length of time, in minutes, that log events should be written to a specific log file. Log events that arrive after the rollover period cause the current log file to be closed and a new log file to be opened. - 2.17
Retention unsignedInt W Specifies the length of time, in minutes, that completed/closed log event files should be stored in the file system before they are removed. - 2.17
Compression string W

Specifies the post-rotation compression method that must be applied exclusively on the initial log file in a rotation sequence.

Enumeration of:

  • None
  • GZIP
  • BZIP2
  • LZO
  • XZ
  • ZSTD
 None 2.17
LogFileNumberOfEntries unsignedInt R The number of entries in the LogFile table. - 2.17
Device.DeviceInfo.LogRotate.{i}.LogFile.{i}. object(0:) R

Each table entry represents a Log File.

This table of log files is informational only and does not allow the Controller to operate on these files in any way.

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

 - 2.17
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

 - 2.17
Name string(:64) R Name of the rotated log file stored within the same directory that Name is specified. Which MUST use the uri scheme file [The file URI Scheme/RFC8089]. - 2.17
Size unsignedInt R The size of the log file in bytes. If the device doesn’t know the file size then Size will be 0. - 2.17
LastChange dateTime R

Last modification date of the file specified by Name.

Active Notification requests for this parameter MAY be denied.

 - 2.17
Device.DeviceInfo.VendorLogFile.{i}. object(0:) R

Each table entry represents a Vendor Log File.

This table of log files is informational only and does not allow the Controller to operate on these files in any way.

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

 - 2.1
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.1
Device.DeviceInfo.DeviceImageFile.{i}. object(0:) R

This object describes an image of the device.

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

 - 2.11
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.11
Device.DeviceInfo.FirmwareImage.{i}. object(0:) R

Top-level object for mapping firmware images.

This is a static table – the number of object instances in this table is defined by the firmware that is currently running.

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

 - 2.12
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.12
Status string R

Status of the firmware image, as determined by the Agent. Enumeration of:

  • NoImage (This Firmware Image instance is empty. This value could happen on an Agent that supports multiple firmware images, but only has a single image installed)
  • Active (This Firmware Image instance is the currently active image, added in 2.14)
  • Downloading (This Firmware Image instance is being downloaded)
  • Validating (This Firmware Image instance has been downloaded, and is in the process of being validated)
  • Available (This Firmware Image instance has been downloaded, validated, and installed, and is ready to be activated)
  • DownloadFailed (The Agent has attempted to download this Firmware Image instance, but ultimately failed while retrieving it from the source URL)
  • ValidationFailed (The Agent has attempted to validate a Firmware Image downloaded to this instance, but ultimately failed while validating it)
  • InstallationFailed (The Agent has attempted to install a Firmware Image downloaded and validated to this instance, but ultimately failed while installing it)
  • ActivationFailed (The Agent has attempted to activate this Firmware Image instance, but ultimately the activation failed.)
 - 2.12
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
StoragePath string R Path where the Kernel faults logs must be stored. - 2.17
LastUpgradeCount unsignedInt R Total number of Kernel faults which occured since last firmware upgrade. - 2.17
PreviousBootCount unsignedInt R The number of Kernel faults which occurred during the previous boot cycle. - 2.17
MinFreeSpace unsignedInt W Minimum free space in KiB on the device that must be free before attempting to create a KernelFault instance. This setting does not affect the counting of Kernel faults. - 2.17
MaxKernelFaultEntries unsignedInt W

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

If this limit is hit, No new KernelFault instances will be created until sufficient Kernel fault instances are removed. Set this parameter to 0 to completely disable the creation of KernelFault instances.

Reducing the MaxKernelFaultEntries will cause for the implementation to delete the oldest KernelFault instances.

This setting does not affect the counting of Kernel faults.

 - 2.17
KernelFaultNumberOfEntries unsignedInt R The number of entries in the KernelFault table. - 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.

 - 2.17
Alias string(:64) W

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.
 - 2.17
FaultLocation string R Specifies the location of where to create and keep the logs. Can either be a relative path or file within the StoragePath location. - 2.17
LastInstruction string R The last instruction executed when the Kernel fault was triggered. - 2.17
TimeStamp dateTime R The time when the Kernel fault was registered. - 2.17
FirmwareVersion string R The firmeware version that triggered the Kernel fault. - 2.17
ProcessName string R The name of the process that was active while the kernel fault occurred. - 2.17
Reason string R The reason why the kernel fault occurred. - 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
StoragePath string R Path where the process fault logs must be stored. - 2.17
LastUpgradeCount unsignedInt R Total number of process faults which occured since last firmware upgrade. - 2.17
PreviousBootCount unsignedInt R The number of process faults which occurred during the previous boot cycle. - 2.17
MinFreeSpace unsignedInt W Minimum free space in KiB on the device that must be free before attempting to create a ProcessFault instance. This setting does not affect the counting of process faults. - 2.17
MaxProcessFaultEntries unsignedInt W

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

If this limit is hit, No new ProcessFault instances will be created until sufficient process fault instances are removed. Set this parameter to 0 to completely disable the creation of ProcessFault instances.

Reducing the MaxProcessFaultEntries will cause for the implementation to delete the oldest ProcessFault instances.

This setting does not affect the counting of process faults.

 - 2.17
ProcessFaultNumberOfEntries unsignedInt R The number of entries in the ProcessFault table. - 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.

 - 2.17
Alias string(:64) W

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.
 - 2.17
ProcessID string R Process ID of the process that crashed. - 2.17
ProcessName string R Process Name of the process that crashed. - 2.17
FaultLocation string R Specifies the location of where to create and keep the process fault logs. Can either be a relative path or file within the StoragePath location. - 2.17
TimeStamp dateTime R The time when the process fault occured. - 2.17
FirmwareVersion string R The firmware version that triggered the the process fault. - 2.17
Arguments string R The command arguments that were used to start to the process. - 2.17
Reason string R The reason why the process fault occurred. - 2.17
Device.DeviceInfo.SupportedDataModel.{i}. object(0:) R

This table contains details of the device’s Current Supported Data Model.

The table MUST describe the device’s entire Supported Data Model. Therefore, if a device’s Supported Data Model changes at run-time, entries will need to be added or removed as appropriate.

Each table entry MUST refer to only a single Root Object or Service Object. The device MAY choose to use more than one table entry for a given Root Object or Service Object.

Considering that every device has some form of a data model, this table MUST NOT be empty.

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

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.3
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
Device.Time.Client.{i}. object(0:) W

This object contains parameters relating to an time client instance.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.16
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.16
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 localy or remotely available in the device. For example with Software Modules it is possible to install multiple services that embed a web interface like a Video service or Photo service.

An instance of the HTTPAccess can model a web interface that is embedded in the device firmware or installed through a Software Modules management system.

Access to the web interface MAY require user authentication. To have access authentication the device MUST support a Users.User. object with at least one instance and an assigned relevant role in Users.User.{i}.RoleParticipation.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.16
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.16
Order unsignedInt(1:) W

Position of the HTTPAccess entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence).

[Order] Position of the HTTPAccess entry in the order of precedence. A value of 1 indicates the first entry to be considered (highest precedence).

When a HTTPAccess instance is created, or when an existing Order value is modified, if the value matches that of an existing entry, the Order values for the existing entry and all lower Order entries are incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction.

If no Order value is supplied on creation of a HTTPAccess instance, it MUST be assigned a value that is one more than the largest current value (lowest precedence).

For each incoming connection, the highest ordered entry that matches the Host: HTTP header and path prefix is applied. All lower Order entries are ignored. When this value is set, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value.A deletion causes {{param}} values to be compacted. When a value is changed, incrementing occurs before compaction.

Changes in 2.17:

  • Removed unsignedInt(1:) syntax
  • Added Order
 - 2.16
Interface string(:256) W

The value MUST be the Path Name of a table row. The IP or Logical Interface associated with the HTTPAccess entry. 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.16
Protocol string W The value MUST be a member of the list reported by the HTTPAccessSupportedProtocols parameter. Protocol being used.

Changes in 2.17:

  • Changed access = readOnly ⇒ readWrite
 - 2.16
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.17:

  • 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.17:

  • Changed access = readWrite ⇒ readOnly
 <Empty> 2.16
Device.InterfaceStack.{i}. object(0:) R

This table contains information about the relationships between the multiple layers of interface objects ([Section 4.3/TR-181i2]). In particular, it contains information on which interfaces run on top of which other interfaces.

This table is auto-generated by the CPE based on the LowerLayers parameters on individual interface objects.

Each table row represents a “link” between two interface objects, a higher-layer interface object (referenced by HigherLayer) and a lower-layer interface object (referenced by LowerLayer). Consequently, if a referenced interface object is deleted, the CPE MUST delete the corresponding InterfaceStack row(s) that had referenced it.

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

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.3
Device.DSL. object R This object models DSL lines, DSL channels, DSL bonding, and DSL diagnostics. The specific interface objects defined here are Line, Channel, and BondingGroup. Each Line models a layer 1 DSL Line interface, and each Channel models a layer 1 DSL Channel interface where multiple channels can run over a DSL line. In the case where bonding is configured, it is expected that BondingGroup is stacked above the Channel instances within its group. - 2.0
Device.DSL.Line.{i}. object(0:) R

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

This table models physical DSL lines.

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

Changes in 2.17:

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
XTURVersion string(:16) R xTU-R version field as defined in [Section 7.4.6/G.997.1]. It shall contain the xTU-R firmware version and the xTU-R model, encoded in this order and separated by a space character, i.e., ‘(xTU-R firmware version) (xTU-R model)’. - 2.17
XTURSerial string(:32) R xTU-R serial number as defined in [Section 7.4.8/G.997.1]. It shall contain the equipment serial number, the equipment model and the equipment firmware version. All shall be encoded in this order and separated by space characters, i.e., ‘(equipment serial number) (equipment model) (equipment firmware version)’. - 2.17
XTURVendorSpecific hexBinary(2) R

xTU-R vendor-specific information as defined in [G.994.1]. This corresponds to the two-octet vendor-specific information, which MUST be represented as four hexadecimal digits.

Note: This parameter is OPTIONAL at the G and S/T interfaces in G.997.1 Amendment 1. If the parameter is implemented but no value is available, it MUST have the value “0000”.

Note: In [G.997.1], this parameter is called “xTU-R G.994.1 Vendor ID”. See ITU-T Recommendation [G.997.1].

 - 2.17
XTURSystemVendor hexBinary(4) R xTU-R system vendor identifier as defined in [Section 7.4.4/G.997.1]. This corresponds to the four-octet provider code, which MUST be represented as eight hexadecimal digits as defined in [G.994.1] as Vendor ID. - 2.17
XTURSystemVendorSpecific hexBinary(2) R

xTU-R system vendor-specific information as defined in [Section 7.4.4/G.997.1]. This corresponds to the two-octet vendor-specific information, which MUST be represented as four hexadecimal digits as defined in [G.994.1] as Vendor ID.

Note: If the parameter is implemented but no value is available, it MUST have the value “0000”.

 - 2.17
XTURSystemCountry hexBinary(2) R T.35 country code of the xTU-R system vendor as defined in [Section 7.4.4/G.997.1], where the two-octet value defined in [G.997.1] MUST be represented as four hexadecimal digits. - 2.17
XTUCVersion hexBinary(16) R The xTU-C version number is the version number as inserted by the xTU-C in the overhead messages ([G.992.3], [G.992.4], [G.992.5] and [G.993.2]). It is for version control and is vendor specific information. It consists of up to 16 binary octets. - 2.17
XTUCSerial string(:32) R xTU-C serial number as defined in [Section 7.4.7/G.997.1]. This corresponds to the equipment serial number. - 2.17
XTUCVendorSpecific hexBinary(2) R xTU-C vendor-specific information as defined in [Section 7.4.3/G.997.1]. This corresponds to the two-octet vendor-specific information, which MUST be represented as four hexadecimal digits as defined in G.994.1 as Vendor ID. - 2.17
XTUCSystemVendor hexBinary(4) R xTU-C system vendor identifier as defined in [Section 7.4.3/G.997.1]. This corresponds to the four-octet provider code, which MUST be represented as eight hexadecimal digits as defined in [G.994.1] as Vendor ID.. - 2.17
XTUCSystemVendorSpecific hexBinary(2) R

xTU-C system vendor-specific information as defined in [Section 7.4.4/G.997.1]. This corresponds to the two-octet vendor-specific information, which MUST be represented as four hexadecimal digits as defined in [G.994.1] as Vendor ID..

Note: If the parameter is implemented but no value is available, it MUST have the value “0000”.

 - 2.17
XTUCSystemCountry hexBinary(2) R T.35 country code of the xTU-C system vendor as defined in [Section 7.4.4/G.997.1], where the two-octet value defined in G.997.1 MUST be represented as four hexadecimal digits. - 2.17
Device.DSL.Channel.{i}. object(0:) R

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

This table models DSL channel(s) on top of physical DSL lines.

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

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.DSL.BondingGroup.{i}. object(0:) R

DSL bonding group table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each instance is a bonding group, and is expected to be stacked above a Channel instance or a FAST.Line instance for each bonded channel in the group.

Many of the parameters within this object, including LowerLayers, are read-only because bonding is not expected to be configured by a Controller.

The DSL bonding data model is closely aligned with [TR-159]. Corresponds to [TR-159] oBondingGroup.

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

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.DSL.BondingGroup.{i}.BondedChannel.{i}. object(0:) R

DSL bonded channel table. Each table entry represents a bonded channel within the bonding group, and is associated with exactly one Channel instance or one FAST.Line instance. There MUST be an instance of BondedChannel for each DSL channel or FAST line that is bonded.

When a Channel or FAST.Line is no longer bonded, then the CPE MUST delete the corresponding BondedChannel instance. However, when a bonded Channel or FAST.Line becomes disabled, the channel remains bonded and so the corresponding BondedChannel instance MUST NOT be deleted.

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

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.FAST. object R This object models FAST (defined in ITU Recommendation [G.9701]) lines. Each Line models a layer 1 FAST Line interface. - 2.11
Device.FAST.Line.{i}. object(0:) R

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

This table models physical FAST lines.

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

 - 2.11
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.11
Device.Optical. object R

This object models a generic optical interface. It defines an Interface object that models a layer 1 optical interface that is capable of transporting Ethernet packets. For historical reasons, the data model definition is based on parts of [G.988]. However, it is not intended to model anything specific to IEEE PON or ITU-T PON technologies.

Note that this object is not intended to model the optical transceiver either.

 - 2.4
Device.Optical.Interface.{i}. object(0:) R

Optical interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models physical optical interfaces.

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

 - 2.4
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.4
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.

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

  • Changed status = deprecated ⇒ obsoleted
 - 2.4
Device.Cellular. object R This object models cellular interfaces and access points. - 2.8
Device.Cellular.Interface.{i}. object(0:) R

Cellular interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each instance of this object models a cellular modem with a single radio and a single USIM.

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

 - 2.8
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.8
Device.Cellular.AccessPoint.{i}. object(0:) W

Cellular Access Point table. Each entry is identified by an APN (Access Point Name) that identifies a gateway between the mobile network and another computer network.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for APN, or with a given value for Interface.

 - 2.8
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.8
Device.ATM. object R Asynchronous Transfer Mode (ATM) object that contains the Link interface and Diagnostics.F5Loopback diagnostics. - 2.0
Device.ATM.Link.{i}. object(0:) W

ATM link-layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Models an ATM PVC virtual circuit and the ATM Adaption Layer (AAL). An ATM Link entry is typically stacked on top of either a DSL.Channel or a DSL.BondingGroup object.

When an ATM Link interface is used, a lower-layer DSL.Channel interface MUST be configured with ATM encapsulation (see DSL.Channel.{i}.LinkEncapsulationUsed).

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.DOCSIS. object R DOCSIS object. This object models the DOCSIS 3.x cable interface objects. - 2.15
Device.DOCSIS.Downstream.{i}. object(0:) R

DOCSIS Downstream interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the PHY DOCSIS Downstream interface.

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

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.15
Device.DOCSIS.Upstream.{i}. object(0:) R

DOCSIS Upstream interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the PHY DOCSIS Upstream interface.

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

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.15
Device.DOCSIS.DownstreamChannel.{i}. object(0:) R

[docsIfDownstreamChannelTable/1.3.6.1.2.1.10.127.1.1.1.1] This table describes the attributes of downstream channels (frequency bands).

See [Tables 6-16, and 6-17/CM-SP-RFIv2.0].

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

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.15
Device.DOCSIS.UpstreamChannel.{i}. object(0:) W

[docsIfUpstreamChannelTable/1.3.6.1.2.1.10.127.1.1.2.1] This table describes the attributes of attached upstream channels.

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

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.15
Device.DOCSIS.Interface.{i}. object(0:) R

DOCSIS Layer 2 (MAC) interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the MAC level DOCSIS interface.

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

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.15
Device.PTM. object R Packet Transfer Mode ([Annex H/G.993.1]). This object contains the Link interface. - 2.0
Device.PTM.Link.{i}. object(0:) W

PTM link-layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Models a layer 2 variable-sized packet interface. A PTM Link entry is typically stacked on top of either a FAST.Line, DSL.Channel, or a DSL.BondingGroup object.

When a PTM Link interface is used, a lower-layer DSL.Channel interface MUST be configured with PTM encapsulation (see DSL.Channel.{i}.LinkEncapsulationUsed).

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 {{object: non-existent #.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.17:

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
EEEStatus string R

Indicates the active state of Energy Efficient Ethernet [Section 78/802.3-2012_section6].

The Disabled value indicates that EEEEnable is disabled.

The Active value indicates that EEEEnable is enabled and that EEE support has been negotiated with the link partner. In this state EEE will be used.

The Inactive value indicates that EEEEnable is disabled, or that EEE support has not been negotiated with the link partner, either because the link parter is not EEE capable, or its support for EEE is disabled.

The Unsupported value indicates that this physical interface does not support EEE. In which case EEECapability will be false.

Enumeration of:

  • Disabled
  • Active
  • Inactive
  • Unsupported
 - 2.17
Device.Ethernet.Link.{i}. object(0:) W

Ethernet link layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Table entries model the Logical Link Control (LLC) layer. It is expected that an Ethernet Link interface can be stacked above any lower-layer interface object capable of carrying Ethernet frames.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for MACAddress.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.Ethernet.VLANTermination.{i}. object(0:) W

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

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.Ethernet.RMONStats.{i}. object(0:) W

Ethernet statistics based on the [RFC2819] RMON-MIB etherStatsTable, with some extensions inspired by [Section 9.3.32/G.988].

Each instance is associated with an interface capable of transporting Ethernet-encapsulated packets, and contains a set of unidirectional Ethernet statistics.

The statistics are sampled either on ingress or on egress. This is determined as follows:

  • If the instance is associated with an egress queue (or queues) via the Queue parameter or by setting AllQueues to true then data is sampled on egress. In this case Bytes etc measure the data that has been sent on the interface, possibly filtered by Queue or VLANID.
  • Otherwise data is sampled on ingress. In this case Bytes etc measure the data that has been received on the interface, possibly filtered by VLANID.

When sampling on egress, the term received means received by the queuing sub-system.

Multiple instances can be associated with a single interface: individual instances can be configured to collect data associated with the entire interface, or with a particular VLAN and/or queue.

The CPE MUST reset each instances’s Stats parameters whenever the instance is disabled and re-enabled. Whether this reset occurs when the instance becomes operationally disabled (Status = Disabled) or administratively enabled (Enable = true) is a local matter to the CPE. This is similar to the behavior of interface statistics, e.g. as specified for Interface.{i}.Stats. Furthermore, this instance’s Stats parameters MUST be reset whenever the referenced interface’s Stats parameters are reset, or when the referenced queue or VLAN is disabled and re-enabled.

For enabled table entries, if Interface references an interface that is not capable of transporting Ethernet-encapsulated packets, or if Queue references a queue that is not instantiated on Interface, or if Queue is not a valid reference and AllQueues is false, the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of Interface, VLANID and Queue.

 - 2.4
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.4
Device.Ethernet.LAG.{i}. object(0:) W

Ethernet Link Aggregation Group (LAG) table (a stackable interface object as described in [Section 4.2/TR-181i2]). Table entries model the Link Aggregation Sub-Layer as defined in [802.3-2015] and [802.1AX-2014]. It is expected that a LAG interface can only be stacked above Interface interfaces. The CPE can reject creation of additional LAG instances if this would exceed its capabilities.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for MACAddress.

 - 2.12
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.12
Device.USB. object R Universal Serial Bus ([USB1.0], [USB2.0], [USB3.0]). This object contains the Interface, Port, and USBHosts objects. - 2.0
Device.USB.Interface.{i}. object(0:) R

USB interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models master and slave USB physical interfaces that support carrying Ethernet frames, e.g. via the USB Communication Device Class.

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

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.USB.Port.{i}. object(0:) R

USB Port table. This table models master and slave USB physical ports on the device.

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

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.USB.USBHosts. object R

This object models the CPE’s USB Host controllers.

See [Appendix XVII/TR-181i2] for Theory of Operation.

 - 2.0
Device.USB.USBHosts.Host.{i}. object(0:) R

Table of CPE USB Host controllers.

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

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.3
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
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.MoCA. object R MoCA object that contains the Interface table [MoCAv1.0] [MoCAv1.1]. - 2.0
Device.MoCA.Interface.{i}. object(0:) R

MoCA interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of a MoCA interface [MoCAv1.0] [MoCAv1.1].

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

Changes in 2.17:

 - 2.0
AccessControlNumberOfEntries unsignedInt R The number of entries in the AccessControl table. - 2.17
RlapmNumberOfEntries unsignedInt R The number of entries in the Rlapm table. - 2.17
SapmNumberOfEntries unsignedInt R The number of entries in the Sapm table. - 2.17
MeshNumberOfEntries unsignedInt R The number of entries in the Mesh table. - 2.17
BridgeNumberOfEntries unsignedInt R The number of entries in the Bridge table. - 2.17
MeshScModNumberOfEntries unsignedInt R The number of entries in the MeshScMod table. - 2.17
Enable boolean W

[mocaIfEnable/1.3.6.1.4.1.31621.1.2.1.1.1.1] Enables or disables the interface.

This parameter is based on ifAdminStatus from [RFC2863].

The factory default value MUST be true.

Changes in 2.17:

  • Added id = mocaIfEnable/1.3.6.1.4.1.31621.1.2.1.1.1.1
  • Added boolean syntax true default
 - 2.0
Status string R

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

  • 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.17:

  • Added id = mocaIfStatus/1.3.6.1.4.1.31621.1.2.1.7.1.1
 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Name string(:64) R [mocaIfName/1.3.6.1.4.1.31621.1.2.1.7.1.8] The textual name of the interface as assigned by the CPE.

Changes in 2.17:

  • Added id = mocaIfName/1.3.6.1.4.1.31621.1.2.1.7.1.8
 - 2.0
LastChange unsignedInt R

[mocaIfStatus/1.3.6.1.4.1.31621.1.2.1.7.1.1] The accumulated time in seconds since the interface entered its current operational state.

Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

  • Added id = mocaIfStatus/1.3.6.1.4.1.31621.1.2.1.7.1.1
 - 2.0
MACAddress string(:17) R

[mocaIfMacAddress/1.3.6.1.4.1.31621.1.2.1.7.1.6] [MACAddress] The MAC Address of the interface.

Note: This is not necessarily the same as the Ethernet header source or destination MAC address, which is associated with the IP interface and is modeled via the Ethernet.Link.{i}.MACAddress parameter.

Changes in 2.17:

  • Added id = mocaIfMacAddress/1.3.6.1.4.1.31621.1.2.1.7.1.6
 - 2.0
FirmwareVersion string(:64) R

[mocaIfSoftwareVersion/1.3.6.1.4.1.31621.1.2.1.7.1.3] This interface’s firmware version.

This parameter is based on mocaIfSoftwareVersion from [MOCA11-MIB].

Changes in 2.17:

  • Added id = mocaIfSoftwareVersion/1.3.6.1.4.1.31621.1.2.1.7.1.3
 - 2.0
MaxBitRate unsignedInt R

The maximum MoCA PHY bit rate (expressed in Mbps).

This parameter MUST NOT be implemented for MoCA 2.0 because it doesn’t map to a MIB object.

 - 2.0
MaxIngressBW unsignedInt R

[mocaIfMaxIngressNodeThroughput/1.3.6.1.4.1.31621.1.2.1.7.1.18] [MocaMacRate] The maximum bandwidth of this interface for flows onto the MoCA network in {{units: missing units facet}}.network.

This parameter is based on mocaIfMaxIngressNodeBw from [MOCA11-MIB].

Changes in 2.17:

  • Added id = mocaIfMaxIngressNodeThroughput/1.3.6.1.4.1.31621.1.2.1.7.1.18
  • Changed syntax = unsignedInt -> MocaMacRate
 - 2.0
MaxEgressBW unsignedInt R

[mocaIfMaxEgressNodeThroughput/1.3.6.1.4.1.31621.1.2.1.7.1.19] [MocaMacRate] The maximum bandwidth of this interface for flows from the MoCA network in {{units: missing units facet}}.network.

This parameter is based on mocaIfMaxEgressNodeBw from [MOCA11-MIB].

Changes in 2.17:

  • Added id = mocaIfMaxEgressNodeThroughput/1.3.6.1.4.1.31621.1.2.1.7.1.19
  • Changed syntax = unsignedInt -> MocaMacRate
 - 2.0
CurrentVersion string(:64) R

[mocaIfNetworkVersion/1.3.6.1.4.1.31621.1.2.1.7.1.5] Identifies the MoCA version that the MoCA network is currently running.

This element MUST be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 1.0, where the components mean major.minor revision number. Possible patterns:

  • \d+(\.\d+)*

This parameter is based on mocaIfNetworkVersion from [MOCA11-MIB].

Changes in 2.17:

  • Added id = mocaIfNetworkVersion/1.3.6.1.4.1.31621.1.2.1.7.1.5
 - 2.0
NetworkCoordinator unsignedInt(0:15) R

[mocaIfNC/1.3.6.1.4.1.31621.1.2.1.7.1.10] [MocaNodeID] The Node ID of the current Network Coordinator (NC) for the MoCA network.

This parameter is based on mocaIfNC from [MOCA11-MIB].

Changes in 2.17:

  • Added id = mocaIfNC/1.3.6.1.4.1.31621.1.2.1.7.1.10
  • Changed syntax = unsignedInt -> MocaNodeID
 - 2.0
NodeID unsignedInt(0:15) R

[mocaIfNodeID/1.3.6.1.4.1.31621.1.2.1.7.1.7] [MocaNodeID] The Node ID of this interface.

This parameter is based on mocaIfNodeID from [MOCA11-MIB].

Changes in 2.17:

  • Added id = mocaIfNodeID/1.3.6.1.4.1.31621.1.2.1.7.1.7
  • Changed syntax = unsignedInt -> MocaNodeID
 - 2.0
MaxNodes boolean R

The maximum network node capability supported by the interface. If MaxNodes is true then the interface supports 16 nodes (the maximum for a MoCA 1.1 network). If MaxNodes is false then the interface supports 8 nodes (the maximum for a MoCA 1.0 network).

This parameter MUST NOT be implemented for MoCA 2.0 because it doesn’t map to a MIB object.

 - 2.0
NumNodes unsignedInt(0:16) R

[mocaIfNumNodes/1.3.6.1.4.1.31621.1.2.1.7.1.9] The numbers of 1’s in the GCD_BITMASK field reported in Type I Probe Reports. This value corresponds to the number of MoCA Nodes that this MoCA Node communicates to in the MoCA network.

This value may be smaller than the number of MoCA Nodes reported by the NC Node.

See [Section 3.6.3.2/MoCAv1.1].

 - 2.17
PreferredNC boolean W

[mocaIfPreferredNC/1.3.6.1.4.1.31621.1.2.1.1.1.9] Whether this interface is a preferred Network Coordinator (NC).

This parameter is based on mocaIfPreferredNC from [MOCA11-MIB].

The factory default value MUST be false.

Changes in 2.17:

  • Added id = mocaIfPreferredNC/1.3.6.1.4.1.31621.1.2.1.1.1.9
  • Added boolean syntax false default
 - 2.0
BackupNC unsignedInt(0:15) R

[mocaIfBackupNC/1.3.6.1.4.1.31621.1.2.1.7.1.11] [MocaNodeID] The Node ID of the backup Network Coordinator node.

This parameter is based on mocaIfBackupNC from [MOCA11-MIB].

Changes in 2.17:

  • Added id = mocaIfBackupNC/1.3.6.1.4.1.31621.1.2.1.7.1.11
  • Changed syntax = unsignedInt -> MocaNodeID
 - 2.0
PrivacyEnabledSetting boolean W

[mocaIfPrivacyEnable/1.3.6.1.4.1.31621.1.2.1.1.1.7] The configured privacy mode. This indicates whether link-layer security is enabled (true) or disabled (false) for network admission.The configured privacy setting MAY NOT match the current operational state ({{param|PrivacyEnabled}}), since this setting is only applied during network formation or admission.

The factory default value MUST be false.

Changes in 2.17:

  • Added id = mocaIfPrivacyEnable/1.3.6.1.4.1.31621.1.2.1.1.1.7
  • Added boolean syntax false default
 - 2.0
PrivacyEnabled boolean R
[mocaIfPrivacyEnable/1.3.6.1.4.1.31621.1.2.1.1.1.7] Indicates whether link-layer security is enabled or disabled.
This parameter is based on mocaIfPrivacyEnable from [MOCA11-MIB].
This parameter was DEPRECATED in 2.17 because it and PrivacyEnabledSetting are associated with the same underlying MIB object and it is therefore unnecessary. If implemented, it MUST return the same value as PrivacyEnabledSetting.

Changes in 2.17:

  • Added status = deprecated
  • Added id = mocaIfPrivacyEnable/1.3.6.1.4.1.31621.1.2.1.1.1.7
 - 2.0
AccessControlEnable boolean W

[mocaIfAccessEnable/1.3.6.1.4.1.31621.1.2.1.1.1.10] Enable MAC address access control on the MoCA interface if this value is true. Disable MAC address access control on the MoCA interface if this value is false.

Access control applies to subsequent MoCA Node admission.

The factory default value MUST be false.

 - 2.17
PhyThreshold unsignedInt(0:2048) W

[mocaIfPhyThreshold/1.3.6.1.4.1.31621.1.2.1.1.1.11] [MocaPhyRate] The minimum PHY rate.

If transmit PHY rate between all pairs of MoCA Nodes are greater than or equal to this value, and subsequently the transmit PHY rate of one pair of MoCA Nodes is less than this value, send BelowPhyThresholdTrap if PhyThresholdTrapEnable is true.

If transmit PHY rate between one or more pairs of MoCA Nodes are less than this value, and subsequently the transmit PHY rate between all pairs of MoCA Nodes are greater than or equal to this value, send AbovePhyThresholdTrap if PhyThresholdTrapEnable is true.

See [Section 3, Unusable Link definition/MoCAv2.0].

The factory default value MUST be 123.

 - 2.17
PhyThresholdTrapEnable boolean W

[mocaIfPhyThresholdEnable/1.3.6.1.4.1.31621.1.2.1.1.1.12] If transmit PHY rate between all pairs of MoCA Nodes are greater than or equal to PhyThreshold, and subsequently the transmit PHY rate of one pair of MoCA Node is less than PhyThreshold, send BelowPhyThresholdTrap if this value is true, do not send BelowPhyThresholdTrap if this value is false.

If transmit PHY rate between one or more pairs of MoCA Nodes are less than PhyThreshold, and subsequently the transmit PHY rate between all pairs of MoCA Nodes are greater than or equal to PhyThreshold, send AbovePhyThresholdTrap if this value is true, do not send AbovePhyThresholdTrap if this value is false.

Only one MoCA Node in the MoCA network should set PhyThresholdTrapEnable to true.

Only one MoCA Node in the MoCA network should set PhyThresholdTrapEnable to true.

The factory default value MUST be false.

 - 2.17
StatusChangeEnable boolean W

[mocaIfStatusChangeEnable/1.3.6.1.4.1.31621.1.2.1.1.1.13] If StatusChangeEnable is true and Status changes, then the trap StatusChangeTrap is sent.

The factory default value MUST be false.

 - 2.17
NumNodesChangeEnable boolean W

[mocaIfNumNodesChangeEnable/1.3.6.1.4.1.31621.1.2.1.1.1.14] If NumNodesChangeEnable is true and NumNodes changes, then the trap NumNodesChangeTrap is sent.

Only one MoCA Node in the MoCA network should set NumNodesChangeEnable to true.

The factory default value MUST be false.

 - 2.17
TpcTargetRateNper unsignedInt(0:2048) W [mocaIfTpcTargetRateNper/1.3.6.1.4.1.31621.1.2.1.1.1.15] [MocaPhyRate] The Target PHY Rate of the receiving MoCA 2.0 Node in order to optimize the long-term PHY rate and transmit power level between the transmitting and receiving MoCA Nodes when TPC is enabled and PERMODE = NPER. - 2.17
Band string[] W [mocaIfBand/1.3.6.1.4.1.31621.1.2.1.1.1.16] [MocaBand] Configure the band or sub-band for the MoCA Node to operate in (BND Managed Parameter). See [Section 15/MoCAv2.0]. - 2.17
LastOperFreqUpdateEnable boolean W [mocaIfLofUpdateEnable/1.3.6.1.4.1.31621.1.2.1.1.1.17] Controls whether the LOF is updated when joining a network (LOF_UPDATE_EN Managed Parameter). See [Section 8.1.1, and Table 17-1/MoCAv2.0]. - 2.17
FreqCapabilityMask hexBinary(8) R

[mocaIfChannelSupport/1.3.6.1.4.1.31621.1.2.1.7.1.22] HexadecimalThe encoded 64-bit mask of supported frequencies. This is the bit map of the spectrumfrequencies that the interface supports,supports. and each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency.

[MocaChannelMask] Represents one or more MoCA channel RF center frequencies using a hexadecimal encoded 64-bit mask.

Bit 63 (the leftmost bit of the leftmost character) is the most significant bit (highest frequency), and bit 0 (the rightmost bit of the rightmost character) is the least significant bit (lowest frequency). Not all bits are valid MoCA channels.

Each bit represents 25 MHz of spectrum, but the mapping from bits to frequencies varies with the MoCA version:

  • MoCA 1.0 and MoCA 1.1: bits 63 through 32 are not used, bit 31 represents 1575 MHz and bit 0 represents 800 MHz
  • MoCA 2.0 and MoCA 2.5: bit 63 represents 1975 MHz and bit 0 represents 400 MHz

For example, a MoCA 1.0 or MoCA 1.1 interface would use 0x000000001FFFC000 to represent 1150 MHz through 1500 MHz.

Note that the MoCA version is indicated by the HighestVersion parameter.

For example, an interface that supports 1150 MHz through 1500 MHz would have a value of 0x000000001FFFC000.

This parameter is based on mocaIfCapabilityMask from {{bibref|MOCA11-MIB}}.

Changes in 2.17:

  • Added id = mocaIfChannelSupport/1.3.6.1.4.1.31621.1.2.1.7.1.22
  • Changed syntax = hexBinary(8) -> MocaChannelMask
 - 2.0
FreqCurrentMaskSetting hexBinary(8) W

[mocaIfChannelMask/1.3.6.1.4.1.31621.1.2.1.1.1.2] The configured hexadecimal encoded 64-bit mask of enabled frequencies that the interface supports for network admission.

[MocaChannelMask] Represents one or more MoCA channel RF center frequencies using a hexadecimal encoded 64-bit mask.

Bit 63 (the leftmost bit of the leftmost character) is the most significant bit (highest frequency), and bit 0 (the rightmost bit of the rightmost character) is the least significant bit (lowest frequency). Not all bits are valid MoCA channels.

Each bit represents 25 MHz of spectrum, but the mapping from bits to frequencies varies with the MoCA version:

  • MoCA 1.0 and MoCA 1.1: bits 63 through 32 are not used, bit 31 represents 1575 MHz and bit 0 represents 800 MHz
  • MoCA 2.0 and MoCA 2.5: bit 63 represents 1975 MHz and bit 0 represents 400 MHz

For example, a MoCA 1.0 or MoCA 1.1 interface would use 0x000000001FFFC000 to represent 1150 MHz through 1500 MHz.

Note that the MoCA version is indicated by the HighestVersion parameter.

The configured frequencies MAYmight NOTnot match the current operational state (FreqCurrentMask), since this setting is only applied during network formation or admission.

Changes in 2.17:

  • Added id = mocaIfChannelMask/1.3.6.1.4.1.31621.1.2.1.1.1.2
  • Changed syntax = hexBinary(8) -> MocaChannelMask
 - 2.0
FreqCurrentMask hexBinary(8) R

[mocaIfChannelSupport/1.3.6.1.4.1.31621.1.2.1.7.1.22] HexadecimalThe encoded 64-bit mask of used frequencies. This is the bit map of the spectrumfrequencies that can be usedused. andThis is a subset of the FreqCapabilityMask. Each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency.frequencies.

This parameter is based on mocaIfChannelMask from [MOCA11-MIB].

[MocaChannelMask] Represents one or more MoCA channel RF center frequencies using a hexadecimal encoded 64-bit mask.

Bit 63 (the leftmost bit of the leftmost character) is the most significant bit (highest frequency), and bit 0 (the rightmost bit of the rightmost character) is the least significant bit (lowest frequency). Not all bits are valid MoCA channels.

Each bit represents 25 MHz of spectrum, but the mapping from bits to frequencies varies with the MoCA version:

  • MoCA 1.0 and MoCA 1.1: bits 63 through 32 are not used, bit 31 represents 1575 MHz and bit 0 represents 800 MHz
  • MoCA 2.0 and MoCA 2.5: bit 63 represents 1975 MHz and bit 0 represents 400 MHz

For example, a MoCA 1.0 or MoCA 1.1 interface would use 0x000000001FFFC000 to represent 1150 MHz through 1500 MHz.

Note that the MoCA version is indicated by the HighestVersion parameter.

Changes in 2.17:

  • Added id = mocaIfChannelSupport/1.3.6.1.4.1.31621.1.2.1.7.1.22
  • Changed syntax = hexBinary(8) -> MocaChannelMask
 - 2.0
CurrentOperFreq unsignedInt R

[mocaIfRFChannel/1.3.6.1.4.1.31621.1.2.1.7.1.12] Current Operational Frequency. The RF frequency in Hz to which the MoCA interface is currently tuned. This parameter is only valid when Status is Up.

This parameter is based on mocaIfRFChannel from [MOCA11-MIB].

Changes in 2.17:

  • Added id = mocaIfRFChannel/1.3.6.1.4.1.31621.1.2.1.7.1.12
 - 2.0
LastOperFreq unsignedInt W

[mocaIfLof/1.3.6.1.4.1.31621.1.2.1.1.1.18] Last Operational Frequency. The RF frequency in Hz to which the MoCA interface was tuned when last in the Up state.

This parameter is based on mocaIfLOF from [MOCA11-MIB].

(LOF Managed Parameter)

This parameter is writable only for MoCA 2.0.

Changes in 2.17:

  • Changed access = readOnly ⇒ readWrite
  • Added id = mocaIfLof/1.3.6.1.4.1.31621.1.2.1.1.1.18
 - 2.0
TpcEnable boolean W

[mocaIfTpcEnable/1.3.6.1.4.1.31621.1.2.1.1.1.3] Enable automatic power control if this value is true. Use a fixed transmit power level if this value is false.

(TPC_EN Managed Parameter)

The factory default value MUST be true.

 - 2.17
KeyPassphrase string(12:17) W

[mocaIfPassword/1.3.6.1.4.1.31621.1.2.1.1.1.8] MoCA Password. The value consists of numeric characters (0-9). Possible patterns:

  • \d+

This parameter is based on mocaIfPassword from [MOCA11-MIB].

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

Changes in 2.17:

  • Added id = mocaIfPassword/1.3.6.1.4.1.31621.1.2.1.1.1.8
 - 2.0
PerMode unsignedInt W

[mocaIfPerMode/1.3.6.1.4.1.31621.1.2.1.1.1.20] Controls which transmission PER mode the MoCA Node uses for MPDUs not belonging to PQoS Flows, where a value of 0 indicates NPER and 1 indicates VLPER. By default PER mode is set to 1 in band E, while it is set to 0 for all other bands (PER_MODE Managed Parameter).

See [Section 8.2 and Table 17-2/MoCAv2.0].

 - 2.17
TurboModeEnable boolean W

[mocaIfTurboModeEnable/1.3.6.1.4.1.31621.1.2.1.1.1.21] Controls whether the MoCA Node operates in point-to-point Turbo Mode or not.

When set to true the turbo mode is enabled; when set to false the turbo mode is disabled (TURBO_MODE_EN Managed Parameter).

See [Section 10 and Table 17-1/MoCAv2.0].

The factory default value MUST be false.

 - 2.17
PolicingEnable boolean W

[mocaIfPolicingEnable/1.3.6.1.4.1.31621.1.2.1.1.1.22] Controls whether policing of PQoS Flows is enabled or disabled. When false the policy is disabled, and when true the policy is enabled (POLICING_EN Managed Parameter).

See [Section 8.8 and Table 17-1/MoCAv2.0].

The factory default value MUST be false.

 - 2.17
TlpMin unsignedInt W

[mocaIfTlpMin/1.3.6.1.4.1.31621.1.2.1.1.1.23] The minimum time (in milliseconds) a MoCA Node is required to stay in the Listening Phase of the Network Search (TLP_MIN Managed Parameter).

See [Table 17-2/MoCAv2.0].

The factory default value MUST be 0.

 - 2.17
TlpMax unsignedInt W

[mocaIfTlpMax/1.3.6.1.4.1.31621.1.2.1.1.1.24] The maximum time (in milliseconds) a MoCA Node is required to stay in the Listening Phase of the Network Search (TLP_MAX Managed Parameter).

Default value of TlpMax depends on the band configuration as follows:

  • 20 seconds for band E
  • 35 seconds for band F
  • 95 seconds for Band ExD
  • 10 seconds for Band D-Low
  • 55 seconds for Band D-High

See [Section 8.1/MoCAv2.0].

 - 2.17
RlapmEnable boolean W

[mocaIfRlapmEnable/1.3.6.1.4.1.31621.1.2.1.1.1.25] Controls whether the RLAPM (Receive Level Added PHY Margin) function is enabled and the MoCA Node needs to apply it, or disabled and the MoCA Node needs to ignore it.

RLAPM function is enabled when set to true. RLAPM function is disabled when set to false.

The RLAPM function allows a Node to add a specific global PHY margin (RLAPM) to all the subcarriers’ bitloadings at each estimated aggregate receive power level. This RLAPM value is obtained from the RLAPM table Device.MoCA.Interface.{i}.Rlapm.{i}..

See [Section 7.15 and Table 17-1/MoCAv2.0].

 - 2.17
RlapmProfileSelect unsignedInt W

[mocaIfRlapmProfileSelect/1.3.6.1.4.1.31621.1.2.1.1.1.26] Controls which RLAPM (Receive Level Added PHY Margin) profile is Active.

See [Section 7.15.2 and Table 17-1/MoCAv2.0].

 - 2.17
SapmEnable boolean W

[mocaIfSapmEnable/1.3.6.1.4.1.31621.1.2.1.1.1.27] Controls whether the SAPM (Subcarrier Added PHY Margin) function is enabled and the MoCA Node needs to apply it, or disabled and the MoCA Node needs to ignore it.

SAPM function is enabled when set to true. SAPM function is disabled when set to false.

The SAPM function allows a Node to add a prespecified PHY margin to each subcarrier’s bitloading (SAPM value) whenever the aggregate received power levels (ARPLs) are below a pre-specified threshold. This SAPM value is obtained from the SAPM table Device.MoCA.Interface.{i}.Sapm.{i}..

See [Section 7.15 and Table 17-1/MoCAv2.0].

 - 2.17
SapmProfileSelect unsignedInt W

[mocaIfSapmProfileSelect/1.3.6.1.4.1.31621.1.2.1.1.1.28] Controls which SAPM (Subcarrier Added PHY Margin) profile is Active.

See [Section 7.15.1 and Table 17-1/MoCAv2.0].

 - 2.17
PowerStateRequest string W

[mocaIfPowerStateRequest/1.3.6.1.4.1.31621.1.2.1.1.1.29] [MocaPowerState] Carries a request to the MoCA Node to transition into a specified Power State (POWER_STATE_REQ Managed Parameter).

See [Section 12/MoCAv2.0].

The factory default value MUST be m0Active.

 - 2.17
SeqNumMr unsignedInt(0:65535) W

[mocaIfSeqNumMr/1.3.6.1.4.1.31621.1.2.1.1.1.30] Sequence Number used by the MR Transaction (SEQ_NUM_MR Managed Parameter).

See [Section 7.15 and Table 17-1/MoCAv2.0].

The factory default value MUST be 0.

 - 2.17
PowerStateTrapEnable boolean W

[mocaIfPowerStateTrapEnable/1.3.6.1.4.1.31621.1.2.1.1.1.31] Used for power state message trap.

  • When set to true it allows the MoCA Node to report a trap on each Power State transition.
  • When set to false no trap report is generated when the MoCA Node Power State changes.

See [Section 12/MoCAv2.0].

The factory default value MUST be false.

 - 2.17
LmoTrapEnable boolean W

[mocaIfLmoTrapEnable/1.3.6.1.4.1.31621.1.2.1.1.1.32] Used for LMO (Link Maintenance Operation) message trap.

  • When set to true it allows the MoCA Node to report a trap on transitioning to LMO.
  • When set to false no trap report the MoCA Node is not transitioning to LMO.

See [Section 12/MoCAv2.0].

The factory default value MUST be false.

 - 2.17
PrimaryOffset int(-25:1:25) W [mocaIfPrimaryOffset/1.3.6.1.4.1.31621.1.2.1.1.1.33] The offset in MHz of the primary channel relative to the beacon channel (PRIMARY_OFFSET Managed Parameter). - 2.17
SecondaryOffset int(-125:1:125) W

[mocaIfSecondaryOffset/1.3.6.1.4.1.31621.1.2.1.1.1.34] The offset in MHz of the secondary channel relative to the beacon channel (SECONDARY_OFFSET Managed Parameter).

A value of 0 indicates that there is no secondary channel.

 - 2.17
BeaconPowerDistributed int(-10:7,255) W

[moca25IfBeaconPowerDistributed/1.3.6.1.4.1.31621.1.3.1.1.1.1] The networkwide (see BeaconPowerMePie) value of Beacon transmit power in dBm sent by the NC (Network Coordinator) in Beacon Power PIEs (Power Information Elements).

A value of 255 indicates that no networkwide PIE is sent.

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

 - 2.17
BeaconPowerLocal int(-10:7) W [moca25IfBeaconPowerLocal/1.3.6.1.4.1.31621.1.3.1.1.1.2] The value of Beacon transmit power in dBm used by the Node when it transmits beacons. - 2.17
BeaconPowerMePie hexBinary(4) W

[moca25IfBeaconPowerMePie/1.3.6.1.4.1.31621.1.3.1.1.1.3] The Beacon Power PIE (Power Information Element) that the ME (Management Entity) wants the NC (Network Coordinator) to send to configure the Beacon Transmit Power of the different nodes. See [Section 7.1.5/MoCAv2.5].

This parameter specifies if the Beacon transmit power is intended to set the Beacon Power Local (individual type) or the Beacon Power Distributed (networkwide type) of the selected nodes.

It is encoded as specified in [Section 4.11/MOCA25-MIB].

 - 2.17
BeaconPowerMePieSend boolean W

[moca25IfBeaconPowerMePieSend/1.3.6.1.4.1.31621.1.3.1.1.1.4] When this parameter is written, instructs the Node (in case of Network Coordinator) to send a set of Beacon Power PIEs (Power Information Element) with the Beacon Power PIE fields set as specified in BeaconPowerMePie.

See [Section 7.1.5/MoCAv2.5].

 - 2.17
BeaconPowerNetConfig boolean W

[moca25IfBeaconPowerNetConfig/1.3.6.1.4.1.31621.1.3.1.1.1.5] Controls whether the Node is allowed to configure its Beacon power (both Beacon Power Distributed and Beacon Power Local) according to the Beacon Power PIE (Power Information Element) sent by the NC (Network Coordinator).

  • When set to true the Node is allowed to configure its Beacon power.
  • When set to false the Node is not allowed to configure its Beacon power.

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

 - 2.17
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.

 - 2.17
FirstOffset int(-4:0) W

[moca25IfFirstOffset/1.3.6.1.4.1.31621.1.3.1.1.1.7] The offset of the First Channel’s center frequency below the center frequency of the Primary Channel. Valid values are -4 to 0.

See [Table 17-1/MoCAv2.5].

 - 2.17
HandoffToLowerVersionEnable boolean W

[moca25IfHandoffToLowerVersionEnable/1.3.6.1.4.1.31621.1.3.1.1.1.8] Enable handoff to a MoCA 2 or MoCA 1 Node if this value is true. Disable handoff to a MoCA 2 or MoCA 1 Node if this value is false.

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

The factory default value MUST be false.

 - 2.17
MgntEntityNetIePayloadRespTimeout unsignedInt W

[moca25IfMgntEntityNetIePayloadRespTimeout/1.3.6.1.4.1.31621.1.3.1.1.1.9] The number of Discovery Request transmission opportunities a NN has to wait for a response to a Management Entity Response Network IE before continuing its network search.

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

The factory default value MUST be 1000.

 - 2.17
MgntEntityNetIePayloadTx hexBinary(2:62) W

[moca25IfMgntEntityNetIePayloadTx/1.3.6.1.4.1.31621.1.3.1.1.1.10] The payload of the Management Entity Request Network IE (when the Node is trying to join the network), or of the Management Entity Response Network IE (when the Node is the NC).

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

struct moca25IfMgntEntityNetIePayload { short vendorId; // 2 octets (MoCA Vendor ID) char information[60]; // 60 octets (Up to 60 bytes of vendor specific information) }

 - 2.17
MpsPrivacyDown boolean W

[moca25IfMpsPrivacyDown/1.3.6.1.4.1.31621.1.3.1.1.1.11] Controls whether the Node, during its MPS (MoCA Protected Setup) session, is allowed to accept privacy setting of Privacy Disabled from another Node when its own setting is Privacy Enabled. This parameter is valid only when MpsPrivacyReceive is set to true.

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

The factory default value MUST be false.

 - 2.17
MpsPrivacyReceive boolean W

[moca25IfMpsPrivacyReceive/1.3.6.1.4.1.31621.1.3.1.1.1.12] Controls whether the Node, during its MPS (MoCA Protected Setup) session, is allowed to accept privacy settings (Privacy Enabled / Disabled and Network Password and/or Enhanced Network Password) from another Node.

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

The factory default value MUST be true.

 - 2.17
MpsReset boolean W

[moca25IfMpsReset/1.3.6.1.4.1.31621.1.3.1.1.1.13] Resets the MPS (MoCA Protected Setup) state of the Node MpsState to un-Paired and reinitializes MPS local variables and relevant parameters when this parameter is written.

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

 - 2.17
MpsTriggered boolean W

[moca25IfMpsTriggered/1.3.6.1.4.1.31621.1.3.1.1.1.14] Signals the Node in Power State M0 (Active) or M1 (Low Power Idle) that MPS (MoCA Protected Setup) was triggered when this parameter is written.

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

 - 2.17
MpsUnpairedTime unsignedInt W

[moca25IfMpsUnpairedTime/1.3.6.1.4.1.31621.1.3.1.1.1.15] The minimum time in seconds the Node is required to stay in the un-Paired state after it starts network search if the Node creates or joins a network without using MPS (MoCA Protected Setup).

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

The factory default value MUST be 300.

 - 2.17
MpsWalkTime unsignedInt(12:1200) W

[moca25IfMpsWalkTime/1.3.6.1.4.1.31621.1.3.1.1.1.16] The allowed time interval in seconds to trigger MPS (MoCA Protected Setup) on two Nodes.

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

The factory default value MUST be 120.

 - 2.17
NetworkJoin boolean W

[moca25IfNetworkJoin/1.3.6.1.4.1.31621.1.3.1.1.1.17] Instructs the NN to join the latest network from which the NN forwarded a Management Entity Response Network IE: Yes if this value is true and No if this value is false.

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

 - 2.17
NetworkNameAdmissionRule string W

[moca25IfNetworkNameAdmissionRule/1.3.6.1.4.1.31621.1.3.1.1.1.18] Controls which Admission rule to follow.

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

Enumeration of:

  • none (Join no network)
  • all (Join any network)
  • name (Join only the network with a network name that matches NetworkNameNcNn)
  • osp (Wait for management entity instructions after exchanging OSP messages)

The factory default value MUST be none.

 - 2.17
NetworkNameNcNn string W

[moca25IfNetworkNameNcNn/1.3.6.1.4.1.31621.1.3.1.1.1.19] The Network Name the Node is to use for any MoCA network it creates.

When NetworkNameAdmissionRule is set to name, this object also indicates to the Node the name of the network to join.

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

 - 2.17
NumChannels unsignedInt(1:5) W

[moca25IfNumChannels/1.3.6.1.4.1.31621.1.3.1.1.1.20] The maximum number of 100MHz channels the Node uses when the Node forms the network.

See [Table 17-1/MoCAv2.5].

The factory default value MUST be 5.

 - 2.17
Per25Mode unsignedInt W

[moca25IfPer25Mode/1.3.6.1.4.1.31621.1.3.1.1.1.21] Controls which PER mode the receiver Node uses for calculating the bitloading of MoCA 2.5 Unicast profiles, where a value of 0 indicates NPER and 1 indicates VLPER.

See [Table 17-1/MoCAv2.5].

The factory default value MUST be 0.

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

 - 2.17
TrafficPermissionEthertype hexBinary(2) W

[moca25IfTrafficPermissionEthertype/1.3.6.1.4.1.31621.1.3.1.1.1.23] The EtherType value of MSDUs that are allowed to transmit/receive to/from a Non-Secured Admitted Node.

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

The factory default value MUST be 888E.

 - 2.17
TrafficPermissionLink hexBinary W

[moca25IfTrafficPermissionLink/1.3.6.1.4.1.31621.1.3.1.1.1.24] Up to 15 pairs of {Node ID, SOURCE_NODE_BITMASK} where SOURCE_NODE_BITMASK is the value for SOURCE_NODE_BITMASK for the Node with the given Node ID in an Authorized Link PIE that the ME of the Authorization Server wants to distribute if the Node is the Authorization Server; otherwise, the value of SOURCE_NODE_BITMASK in the last received Authorized Link PIE.

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

struct moca25IfTrafficPermissionLink { long nodeIdVector; // 8 octets; Bit value in the ith bit position indicates NodeID=(i) (LSB=bit0) int numNodes; // 4 octets (Number of Node IDs indicated in the NodeIdVector) struct { short SrcNodeBitmask; // 2 octets (SOURCE_NODE_BITMASK in the latest Authorized Link PIE) }[numNodes]; };

 - 2.17
ConnectedNodesChangeTrapEn boolean W

[moca25IfConnectedNodesChangeTrapEn/1.3.6.1.4.1.31621.1.3.1.1.1.25] Used to enable ConnectedNodesChangeTrap.

  • When set to true it allows the MoCA Node to report a trap on the change of NumNodes.
  • When set to false no trap report is generated when NumNodes changes.

The factory default value MUST be false.

 - 2.17
MgntEntityNetwIePayloadRecTrapEn boolean W

[moca25IfMgntEntityNetwIePayloadRecTrapEn/1.3.6.1.4.1.31621.1.3.1.1.1.26] Used to enable MgntEntityNetwIePayloadRecTrap.

  • When set to true it allows the MoCA Node to report a trap on reception of a Management Entity Request/Response Network IE.
  • When set to false no trap report is generated when a Management Entity Request/Response Network IE is received.

The factory default value MUST be false.

 - 2.17
MpsTrapEn boolean W

[moca25IfMpsTrapEn/1.3.6.1.4.1.31621.1.3.1.1.1.27] Used to enable the MPS-related traps: MpsInitScanRecTrap, MpsPairFailTrap, and MpsPrivacyChangedTrap.

The factory default value MUST be false.

 - 2.17
NcPrivSupportedRecTrapEn boolean W

[moca25IfNcPrivSupportedRecTrapEn/1.3.6.1.4.1.31621.1.3.1.1.1.28] Used to enable NcPrivacySupportedRecTrap.

  • When set to true it allows the MoCA Node to report a trap on reception of a new NC_PRIVACY_SUPPORTED value.
  • When set to false no trap report is generated when a new NC_PRIVACY_SUPPORTED value is received.

The factory default value MUST be false.

 - 2.17
NetworkNameRecTrapEn boolean W

[moca25IfNetworkNameRecTrapEn/1.3.6.1.4.1.31621.1.3.1.1.1.29] Used to enable NetworkNameRecTrap.

  • When set to true it allows the MoCA Node to report a trap on reception of a Network Name.
  • When set to false no trap report is generated when a Network Name is received.

The factory default value MUST be false.

 - 2.17
NodeDropTrapEn boolean W

[moca25IfNodeDropTrapEn/1.3.6.1.4.1.31621.1.3.1.1.1.30] Used to enable NodeDropAdmFailureTrap, NodeDropNcTrap, NodeDropMpsTriggeredTrap, and NodeDropNcChgTrap.

The factory default value MUST be false.

 - 2.17
TxPowerLimit unsignedInt W

[mocaIfTxPowerLimit/1.3.6.1.4.1.31621.1.2.1.1.1.4] [MocaDB] TransmitThe Power attenuationvalue in dB relativeby which to reduce the transmit power of the node from its maximum transmit power.{{replaced: unexpected argument [replaced(The, Status), ‘, which means the interface is not part of a MoCA network. If changed, the parameter may not take effect until the’] after: }}{{div|{{classes}}, [’ The transmit power SHALL only be changed when ’, param(Status), ’ is not ’, enum(Up)]}} MoCA interface SHOULD have Enable set to false for any change in this configuration. If the parameter is modified when Enable is true then this change might take several minutes to complete.restarted.

This parameter is based on mocaIfTxPowerLimit from [MOCA11-MIB].

The factory default value MUST be 0.

Changes in 2.17:

  • Added id = mocaIfTxPowerLimit/1.3.6.1.4.1.31621.1.2.1.1.1.4
  • Changed syntax = unsignedInt -> MocaDB
  • Added MocaDB syntax 0 default
 - 2.0
PowerCntlPhyTarget unsignedInt(0:2048) W

[mocaIfPowerControlTargetRate/1.3.6.1.4.1.31621.1.2.1.1.1.6] [MocaPhyRate] Target PHY rate in Mbps for the power control algorithm.

The MoCA interface SHOULD have Enable set to false for any change in this configuration. If the parameter is modified when Enable is true then this change might take several minutes to complete.

This parameter is based on mocaIfPowerControlTargetRate from [MOCA11-MIB].

The factory default value MUST be 630.

Changes in 2.17:

  • Added id = mocaIfPowerControlTargetRate/1.3.6.1.4.1.31621.1.2.1.1.1.6
  • Changed syntax = unsignedInt -> MocaPhyRate
  • Added MocaPhyRate syntax 630 default
 - 2.0
BeaconPowerLimit unsignedInt W

[mocaIfBeaconPowerBackoff/1.3.6.1.4.1.31621.1.2.1.1.1.5] [MocaDB] The value in dB by which to reduce the setting of the transmit power of the Beacon Transmit Power attenuation in {{units: missing units facet}} relative tofrom the maximum transmit power.

power (BEACON_PWR_BACKOFF Managed Parameter). The MoCAbeacon transmit power SHALL only be changed when Status is not Up, which means the interface SHOULD have Enable set to false for any change in this configuration.is not part of a MoCA network. If changed, the parameter is modified when Enable is true then this change mightmay not take several minutes to complete.effect until the MoCA interface is restarted.

This parameter is based on mocaIfBeaconPowerLimit from [MOCA11-MIB].
Note that this parameter maps to different MIB objects for MoCA 1.0/1.1 and MoCA 2.0.
This parameter was DEPRECATED in 2.17 for MoCA 2.5.
The factory default value MUST be 0.

Changes in 2.17:

  • Added status = deprecated
  • Added id = mocaIfBeaconPowerBackoff/1.3.6.1.4.1.31621.1.2.1.1.1.5
  • Changed syntax = unsignedInt -> MocaDB
  • Added MocaDB syntax 0 default
 - 2.0
NetworkTabooMask hexBinary(8) R

[mocaIfTabooChannelMask/1.3.6.1.4.1.31621.1.2.1.7.1.13] Hexadecimal encoded 64-bit mask ofThe MoCA taboo channels identified for the home network. This is the bit map of the spectrum that the interface supports, and each bit represents 25 MHz of spectrum. The least significant bit of the rightmost character corresponds to 800MHz, which is the lowest frequency.

This parameter is based on mocaIfTabooChannelMask from [MOCA11-MIB].

[MocaChannelMask] Represents one or more MoCA channel RF center frequencies using a hexadecimal encoded 64-bit mask.

Bit 63 (the leftmost bit of the leftmost character) is the most significant bit (highest frequency), and bit 0 (the rightmost bit of the rightmost character) is the least significant bit (lowest frequency). Not all bits are valid MoCA channels.

Each bit represents 25 MHz of spectrum, but the mapping from bits to frequencies varies with the MoCA version:

  • MoCA 1.0 and MoCA 1.1: bits 63 through 32 are not used, bit 31 represents 1575 MHz and bit 0 represents 800 MHz
  • MoCA 2.0 and MoCA 2.5: bit 63 represents 1975 MHz and bit 0 represents 400 MHz

For example, a MoCA 1.0 or MoCA 1.1 interface would use 0x000000001FFFC000 to represent 1150 MHz through 1500 MHz.

Note that the MoCA version is indicated by the HighestVersion parameter.

Changes in 2.17:

  • Added id = mocaIfTabooChannelMask/1.3.6.1.4.1.31621.1.2.1.7.1.13
  • Changed syntax = hexBinary(8) -> MocaChannelMask
 - 2.0
NodeTabooMask hexBinary(8) R

[mocaIfNodeTabooChannelMask/1.3.6.1.4.1.31621.1.2.1.7.1.14] Hexadecimal encoded 64-bit mask of supported frequencies. This is the bit map of the spectrum that the interface supports, and each bit represents 25 MHz of spectrum. The leastMoCA significanttaboo bitchannels ofidentified thefor rightmostthis character corresponds to 800MHz, which is the lowest frequency.device.

This parameter is based on mocaIfNodeTabooChannelMask from [MOCA11-MIB].

[MocaChannelMask] Represents one or more MoCA channel RF center frequencies using a hexadecimal encoded 64-bit mask.

Bit 63 (the leftmost bit of the leftmost character) is the most significant bit (highest frequency), and bit 0 (the rightmost bit of the rightmost character) is the least significant bit (lowest frequency). Not all bits are valid MoCA channels.

Each bit represents 25 MHz of spectrum, but the mapping from bits to frequencies varies with the MoCA version:

  • MoCA 1.0 and MoCA 1.1: bits 63 through 32 are not used, bit 31 represents 1575 MHz and bit 0 represents 800 MHz
  • MoCA 2.0 and MoCA 2.5: bit 63 represents 1975 MHz and bit 0 represents 400 MHz

For example, a MoCA 1.0 or MoCA 1.1 interface would use 0x000000001FFFC000 to represent 1150 MHz through 1500 MHz.

Note that the MoCA version is indicated by the HighestVersion parameter.

Changes in 2.17:

  • Added id = mocaIfNodeTabooChannelMask/1.3.6.1.4.1.31621.1.2.1.7.1.14
  • Changed syntax = hexBinary(8) -> MocaChannelMask
 - 2.0
SupportedBands string[] R [mocaIfSupportedBands/1.3.6.1.4.1.31621.1.2.1.7.1.15] [MocaBand] Lists all the supported bands and sub-bands by this device. - 2.17
TxBcastRate unsignedInt(0:2048) R

[mocaIfTxGcdRate/1.3.6.1.4.1.31621.1.2.1.7.1.20] [MocaPhyRate] The broadcast PHY transmit rate in {{units: missing units facet}} for this interface.

This parameter is based on mocaIfTxGcdRate from [MOCA11-MIB].

Changes in 2.17:

  • Added id = mocaIfTxGcdRate/1.3.6.1.4.1.31621.1.2.1.7.1.20
  • Changed syntax = unsignedInt -> MocaPhyRate
 - 2.0
TxBcastPowerReduction unsignedInt R

[mocaIfTxGcdPowerReduction/1.3.6.1.4.1.31621.1.2.1.7.1.16] [MocaDB] Transmit Power attenuation in {{units: missing units facet}} relative to the maximum transmit power for broadcast transmissions.

This parameter is based on mocaIfTxGcdPowerReduction from [MOCA11-MIB].

Changes in 2.17:

  • Added id = mocaIfTxGcdPowerReduction/1.3.6.1.4.1.31621.1.2.1.7.1.16
  • Changed syntax = unsignedInt -> MocaDB
 - 2.0
QAM256Capable boolean R

Whether this interface supports the 256 QAM feature.

This parameter is based on mocaIfQAM256Capable from [MOCA11-MIB].

This parameter MUST NOT be implemented for MoCA 2.0 because it doesn’t map to a MIB object.

 - 2.0
PacketAggregationCapability unsignedInt R

[mocaIfPduNumber/1.3.6.1.4.1.31621.1.2.1.7.1.17] The packet aggregation capability supported by the interface. Standard values are 0 (no support), 6 (6 packets) or 10 (10 packets).

This parameter is based on mocaIfPacketsAggrCapability from [MOCA11-MIB].

Note that this parameter maps to different MIB objects for MoCA 1.0/1.1 and MoCA 2.0. [XXX1: Need to modify the syntax to ‘unsignedInt’ because MoCA 2.0 requires a minimum of 20 packets and MoCA 2.5 requires a minimum of 80 packets.]

Changes in 2.17:

  • Added id = mocaIfPduNumber/1.3.6.1.4.1.31621.1.2.1.7.1.17
  • Removed unsignedInt 0:10 range
 - 2.0
PasswordHash hexBinary(2) R [mocaIfPasswordHash/1.3.6.1.4.1.31621.1.2.1.7.1.21] The 16 LSBs of a SHA1 performed on a 0-extended password (KeyPassphrase) concatenated with the SALT string “MocaPasswordHash”. This parameter allows to remotely validate the MoCA password configuration without exposing its value. This value must be 4 hexadecimal digits long. - 2.17
AggregationSize unsignedInt R [mocaIfAggregationSize/1.3.6.1.4.1.31621.1.2.1.7.1.23] The maximum number of bytes in one aggregate which can be received by the MoCA Node. - 2.17
AeNumber unsignedInt R [mocaIfAeNumber/1.3.6.1.4.1.31621.1.2.1.7.1.24] Maximum number of allocation elements, excluding the TAUs and the Dummy DAUs, in one MAP the MoCA Node can process. - 2.17
SupportedIngressPqosFlows unsignedInt R [mocaIfSupportedIngressPqosFlows/1.3.6.1.4.1.31621.1.2.1.7.1.25] Maximum number of Ingress PQoS Flows supported by the MoCA Node. - 2.17
SupportedEgressPqosFlows unsignedInt R [mocaIfSupportedEgressPqosFlows/1.3.6.1.4.1.31621.1.2.1.7.1.26] Maximum number of Egress PQoS Flows supported by the MoCA Node. - 2.17
PowerStateCap string R [mocaIfPowerStateCap/1.3.6.1.4.1.31621.1.2.1.7.1.27] [MocaPowerState] The Power State capabilities of the MoCA Node (e.g., which Power States it can transition to) (POWER_STATE_CAP Managed Parameter). This value can change over time (e.g. when a MoCA 1 Node joins the network). - 2.17
AvbSupport boolean R [mocaIfAvbSupport/1.3.6.1.4.1.31621.1.2.1.7.1.28] The support of the MoCA Node for the IEEE 802.1 Audio Video Bridge specification. AVB is supported if this value is true. AVB is not supported if this value is false. - 2.17
ResetCount unsignedInt R [mocaIfResetCount/1.3.6.1.4.1.31621.1.2.1.7.1.29] [StatsCounter32] Count of MoCA resets since the interface was enabled for this MoCA Node. - 2.17
LinkDownCount unsignedInt R [mocaIfLinkDownCount/1.3.6.1.4.1.31621.1.2.1.7.1.30] [StatsCounter32] The number of times that this MoCA Node has lost link with the MoCA network since the interface was enabled. - 2.17
LmoNodeID unsignedInt(0:15) R [mocaIfLmoNodeID/1.3.6.1.4.1.31621.1.2.1.7.1.31] [MocaNodeID] The ID of the MoCA Node currently undergoing LMO (Link Maintenance Operation), i.e. the LMO node. - 2.17
NetworkState string R

[mocaIfNetworkState/1.3.6.1.4.1.31621.1.2.1.7.1.32] The current MoCA network state of the MoCA Node.

beginNodeAdmissionState, newNodeTypeOneProbeTxState, newNodeTypeOneProbeRxState, newGcdDistributionState, beginPhyProfileState, steadyState refer to the Node Admission (see [Section 8.3/MoCAv2.0]).

typeThreeProbeState, lmoTypeOneProbeState, lmoNodeGcdDistributionState, beginLmoPhyProfileState, lmoGcdTypeOneProbeLinkState refer to the Regular Link Maintenance Operation (see [Section 8.9.1/MoCAv2.0]).

alternateChannelQuietLineState, alternateChannelEvmProbeState, unsolicitedProbeReportState, beginUnsolicitedPhyProfileState, rxDeterminedProbeState, steadyState refer to the On-Demand Link Maintenance Operation (see [Section 8.9.2/MoCAv2.0]).

calibrationState refer to the Network Operation after a Network Coordinator handoff or failover (see [Section 8.14/MoCAv2.0]).

Enumeration of:

 - 2.17
PrimaryChannelOffset int R [mocaIfPrimaryChannelOffset/1.3.6.1.4.1.31621.1.2.1.7.1.33] The offset in MHz of the primary channel relative to the beacon channel. The allowed values are -25, 0, and +25. - 2.17
SecondaryChannelOffset int R [mocaIfSecondaryChannelOffset/1.3.6.1.4.1.31621.1.2.1.7.1.34] The offset in MHz of the secondary channel relative to the beacon channel. The allowed values are -125 and +125. A value of 0 indicates that there is no secondary channel. - 2.17
ResetReason string(0:80) R [mocaIfResetReason/1.3.6.1.4.1.31621.1.2.1.7.1.35] Describes the reason for a MoCA link reset or failure to join a network. - 2.17
NcVersion string(0:64) R

[mocaIfNcVersion/1.3.6.1.4.1.31621.1.2.1.7.1.36] Indicates the MoCA version of the NC.

This element MUST be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 1.0, where the components mean major.minor revision number. Possible patterns:

  • \d+(.\d+)*
 - 2.17
LinkState hexBinary(3) R

[mocaIfLinkState/1.3.6.1.4.1.31621.1.2.1.7.1.37] This parameter is meaningful only after a Link Failure to indicate the state of the network the at the time of the Link failure. Each of the three chars (bytes) is represented as two hexadecimal digits.

struct mocaLinkState { char LINK_STATE; // LINK_STATE_II from the Tx/Rx MAP at the // time of the Link Failure char ACF_TYPE; // ACF_TYPE from the Tx/Rx BEACON // at the time of the Link Failure char ADD_ACF_TYPE; // ADDITIONAL_ACF_TYPE from the Tx/Rx // BEACON at the time of the Link Failure };

 - 2.17
ConnectedNodesInfo hexBinary(12:156) R

[moca25IfConnectedNodesInfo/1.3.6.1.4.1.31621.1.3.1.2.1.1] Indicates the information for each node connected in the network for up to 16 nodes.

See [Table 17-1/MoCAv2.5].

struct moca25ConnectedNodesInfo { long nodeIdVector; // 8 octets; Bit value in the ith bit position indicates NodeID=(i) (LSB=bit0) int numNodes; // 4 octets (Number of Node IDs indicated in the NodeIdVector) struct { char guid[8]; // 8 octets (Node GUID MAC Address) char mocaVersion; // 1 octet (MoCA Version) }[numNodes]; };

 - 2.17
MgntEntityNetIePayloadRx hexBinary(2:62) R

[moca25IfMgntEntityNetIePayloadRx/1.3.6.1.4.1.31621.1.3.1.2.1.2] Indicates the payload of the latest received Management Entity Request Network IE, or Management Entity Response Network IE.

See [Table 17-1/MoCAv2.5].

struct moca25IfMgntEntityNetIePayload { short vendorId; // 2 octets (MoCA Vendor ID) char information[60]; // 60 octets (Up to 60 bytes of vendor specific information) };

 - 2.17
Moca25PhyCapable boolean R

[moca25IfMoca25PhyCapable/1.3.6.1.4.1.31621.1.3.1.2.1.3] Indicate the MoCA Node supports MoCA 2.5 PHY if the value is true.

Indicate the MoCA Node does not support MoCA 2.5 PHY if this value is false.

See [Section 8.3.4.1.1/MoCAv2.5].

 - 2.17
MpsInitScanPayload hexBinary(4) R

[moca25IfMpsInitScanPayload/1.3.6.1.4.1.31621.1.3.1.2.1.4] Reports the channel number, NC’s (Network Coordinators) MoCA version, Network MPS (MoCA Protected Setup) trigger, and Network MPS parameters (if any) and Network Name of the latest MoCA network found during Initial MPS Scanning. See [Section 8.3.1.1.1/MoCAv2.5].

It is encoded as specified in [Section 4.6/MOCA25-MIB].

 - 2.17
MpsState boolean R

[moca25IfMpsState/1.3.6.1.4.1.31621.1.3.1.2.1.5] Indicates the MPS (MoCA Protected Setup) state of the Node: paired if the value is true and un-Paired if the value is false.

See [Section 8.3.1/MoCAv2.5].

 - 2.17
NetworkNamePayload hexBinary(0:32) R

[moca25IfNetworkNamePayload/1.3.6.1.4.1.31621.1.3.1.2.1.6] The payload of the latest received Network Name from the NC.

See [Section 8.3.3.2/MoCAv2.5].

 - 2.17
PrivacyNc string[] R

[moca25IfPrivacyNc/1.3.6.1.4.1.31621.1.3.1.2.1.7] [MocaPrivacy] Comma-separated list of Moca Privacys. The latest NC_PRIVACY_SUPPORTED value received from the NC. Before any NC_PRIVACY_SUPPORTED is received, reflects the value of PrivacySupported.

See [Table 17-1/MoCAv2.5].

 - 2.17
PowerStateResp boolean R

[moca25IfPowerStateResp/1.3.6.1.4.1.31621.1.3.1.2.1.8] Carries the response of the MoCA Node to a request (through POWER_STATEREQ) to transition into a desired Power State: yes if the value if true and no if the value is false.

See [Section 12/MoCAv2.5].

 - 2.17
PowerStateStatus string R [moca25IfPowerStateStatus/1.3.6.1.4.1.31621.1.3.1.2.1.9] [MocaPowerState] Reports the current Power State of the Node (POWER_STATE_STATUS Managed Parameter). - 2.17
ConnectedNodesDropReason hexBinary R

[moca25IfConnectedNodesDropReason/1.3.6.1.4.1.31621.1.3.1.2.1.10] Reports the GUID(s) of the dropped EN(s) and the reason of node drop for up to 15 nodes.

This object is valid only when the Node is the NC.

See [Table 17-1/MoCAv2.5].

struct moca25IfConnectedNodesDropReason { int numNodes; // 4 octets (Number of dropped nodes) struct { char guid[8]; // 8 octets (Node GUID MAC Address) char dropReason; // 1 octet (Reason of node drop: // 0x00 Admission Failure // 0x01 Key Response Timeout // 0x02 Heartbeat Transmission Timeout // 0x03 Power State M0 Transition Timeout // 0x04 Disadvantaged Node // 0x05 RR Transmission Timeout) }[numNodes]; };

 - 2.17
BelowPhyThresholdTrap unsignedInt R

[mocaTrapBelowPhyThreshold/1.3.6.1.4.1.31621.1.2.0.1] If transmit PHY rate between all pairs of MoCA Nodes are greater than or equal to PhyThreshold, and subsequently the transmit PHY rate of one pair of MoCA Nodes drops below PhyThreshold, send this notification if PhyThresholdTrapEnable is true.

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
AbovePhyThresholdTrap unsignedInt R

[mocaTrapAbovePhyThreshold/1.3.6.1.4.1.31621.1.2.0.2] If transmit PHY rate between one or more pairs of MoCA Nodes are less than PhyThreshold, and subsequently the transmit PHY rate between all pairs of MoCA Nodes goes above or is equal to PhyThreshold, send this notification if PhyThresholdTrapEnable is true.

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
StatusChangeTrap unsignedInt R

[mocaTrapIfStatusChange/1.3.6.1.4.1.31621.1.2.0.3] This trap is sent when StatusChangeEnable is true and Status changes value.

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
NumNodesChangeTrap unsignedInt R

[mocaTrapIfNumNodesChange/1.3.6.1.4.1.31621.1.2.0.4] This trap is sent when NumNodesChangeEnable is true and NumNodes changes value.

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
MrRstSuccessTrap unsignedInt R

[mocaTrapMrRstSuccess/1.3.6.1.4.1.31621.1.2.0.5] An MR Entry Node reports that the network got reset successfully (MRRST_SUCCESS Event).

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
MrRstFailTrap unsignedInt R

[mocaTrapMrRstFail/1.3.6.1.4.1.31621.1.2.0.6] An MR Entry Node reports that the network reset did not complete successfully (MRRST_FAIL Event).

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
MrNetworkSuccessTrap unsignedInt R

[mocaTrapMrNetworkSuccess/1.3.6.1.4.1.31621.1.2.0.7] An MR Entry Node reports that the network got reformed successfully following the MR transaction (MRNETWORK_SUCCESS Event).

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
MrNetworkFailTrap unsignedInt R

[mocaTrapMrNetworkFail/1.3.6.1.4.1.31621.1.2.0.8] An MR Entry Node reports that the MR transaction failed, and the network did not get reformed (MRNETWORK_FAIL Event).

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
PowerStateBcstRecTrap unsignedInt R

[mocaTrapPowerStateBcstRec/1.3.6.1.4.1.31621.1.2.0.9] When the MoCA Node is in Power State M1 or M2, indicates that the MoCA Node has received a Broadcast data MSDU, which is available at the data interface (POWER_STATEBCST_REC Event).

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
PowerStateM0NcTrap unsignedInt R

[mocaTrapPowerStateM0Nc/1.3.6.1.4.1.31621.1.2.0.10] When a MoCA Node is in Power State M1, indicates that it is going to move to Power State M0 due to the NCs instruction.

This parameter is a counter that is incremented whenever the event occurs (POWER_STATEM0_NC Event).

 - 2.17
PowerStateNc1xTrap unsignedInt R

[mocaTrapPowerStateNc1x/1.3.6.1.4.1.31621.1.2.0.11] When the MoCA Node is in Power State M1/M2/M3, indicates that MoCA 1 Node is the NC (POWER_STATENC_1X Event).

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
PowerStateNetVerTrap unsignedInt R

[mocaTrapPowerStateNetVer/1.3.6.1.4.1.31621.1.2.0.12] When the MoCA Node is in Power State M2 or M3, indicates that the network MoCA version is changed (POWER_STATENET_VER Event).

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
PowerStateRespTrap unsignedInt R

[mocaTrapPowerStateResp/1.3.6.1.4.1.31621.1.2.0.13] Carries the response of the MoCA Node to a request (through POWER_STATEREQ) to transition into a desired Power State (POWER_STATERESP Event).

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
PowerStateUcstPenTrap unsignedInt R

[mocaTrapPowerStateUcstPen/1.3.6.1.4.1.31621.1.2.0.14] When the MoCA Node is in Power State M2, indicates that a Unicast data MSDU destined to the MoCA Node is pending (POWER_STATEUCST_PEN Event).

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
PowerStateTrnsReqTrap unsignedInt R

[mocaTrapPowerStateTrnsReq/1.3.6.1.4.1.31621.1.2.0.15] When a MoCA Node is in Power State M1 or M2, requests to transition to Power State M0 (POWER_STATETRNS_REQ Event).

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
PowerStateWupUrTrap unsignedInt R

[mocaTrapPowerStateWupUr/1.3.6.1.4.1.31621.1.2.0.16] When the MoCA Node is in Power State M2, this reports a wakeup request from NC due to unspecified reasons (POWER_STATEWUP_UR Event).

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
LmoStatusTrap unsignedInt R

[mocaTrapLmoStatus/1.3.6.1.4.1.31621.1.2.0.17] When LmoTrapEnable is enabled, reports that the MoCA Node is starting LMO (Link Maintenance Operation).

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
LinkFailureTrap unsignedInt R

[mocaTrapLinkFailure/1.3.6.1.4.1.31621.1.2.0.18] Indicates a link failure. If the failure was an Admission or LMO failure, LinkState indicates when the link was dropped within the sequence.

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
ConnectedNodesChangeTrap unsignedInt R

[moca25TrapConnectedNodesChange/1.3.6.1.4.1.31621.1.3.0.1] This trap is sent when ConnectedNodesChangeTrapEn is true and ConnectedNodesInfo changes value.

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
MgntEntityNetwIePayloadRecTrap unsignedInt R

[moca25TrapMgntEntityNetwIePayloadRec/1.3.6.1.4.1.31621.1.3.0.2] This trap is sent when MgntEntityNetwIePayloadRecTrapEn is true and MgntEntityNetIePayloadRx changes value.

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
MpsInitScanRecTrap unsignedInt R

[moca25TrapMpsInitScanRec/1.3.6.1.4.1.31621.1.3.0.3] This trap is sent when MpsTrapEn is true and MpsInitScanPayload changes value.

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
MpsPairFailTrap unsignedInt R

[moca25TrapMpsPairFail/1.3.6.1.4.1.31621.1.3.0.4] This trap is sent when MpsTrapEn is true, indicates a MPS pairing failure.

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
MpsPrivacyChangedTrap unsignedInt R

[moca25TrapMpsPrivacyChanged/1.3.6.1.4.1.31621.1.3.0.5] This trap is sent when MpsTrapEn is true, indicates that the Node’s privacy settings (PRIVACYEN and/or PSWD) have been changed by MPS.

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
NcPrivacySupportedRecTrap unsignedInt R

[moca25TrapNcPrivacySupportedRec/1.3.6.1.4.1.31621.1.3.0.6] This trap is sent when NcPrivSupportedRecTrapEn is true and PrivacyNc changes value.

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
NetworkNameRecTrap unsignedInt R

[moca25TrapNetworkNameRec/1.3.6.1.4.1.31621.1.3.0.7] This trap is sent when NetworkNameRecTrapEn is true and NetworkNamePayload changes value.

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
NodeDropAdmFailureTrap unsignedInt R

[moca25TrapNodeDropAdmFailure/1.3.6.1.4.1.31621.1.3.0.8] This trap is sent when NodeDropTrapEn is true, indicates that the Node drops from the network due to admission failure.

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
NodeDropNcTrap unsignedInt R

[moca25TrapTrapNodeDropNc/1.3.6.1.4.1.31621.1.3.0.9] This trap is sent when NodeDropTrapEn is true, indicates that the Node is dropped by the NC as indicated in the NODE_BITMASK and LOW_POWER_NODE_BITMASK.

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
NodeDropMpsTriggeredTrap unsignedInt R

[moca25TrapNodeDropMpsTriggered/1.3.6.1.4.1.31621.1.3.0.10] This trap is sent when NodeDropTrapEn is true, indicates that MPS is locally triggered when the Node is un-Paired.

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
NodeDropNcChgTrap unsignedInt R

[moca25TrapNodeDropNcChg/1.3.6.1.4.1.31621.1.3.0.11] This trap is sent when NodeDropTrapEn is true}, indicates that there is a NC change when the Node is Non-Secured Admitted Node.

This parameter is a counter that is incremented whenever the event occurs.

 - 2.17
Device.MoCA.Interface.{i}.AccessControl.{i}. object(0:) W

[mocaIfAccessTable/1.3.6.1.4.1.31621.1.2.1.2] MoCA interface MAC access control table. This table contains a list of MAC addresses that are allowed to connect to the MoCA network. In addition to being in this access control list, a MoCA Node must have the proper FreqCurrentMask, PrivacyEnabledSetting, and KeyPassphrase before the MoCA Node can form or join a MoCA network.

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

 - 2.17
Enable boolean W Enables or disables this MAC address to be allowed to connect to the MoCA network. true 2.17
MACAddress string(:17) W [mocaIfAccessMacAddress/1.3.6.1.4.1.31621.1.2.1.2.1.2] [MACAddress] If AccessControlEnable is set to true, MoCA Node with this MAC address is allowed to join the MoCA network. It is not guaranteed that the MoCA Node with this MAC address can form or join a network. - 2.17
Device.MoCA.Interface.{i}.Rlapm.{i}. object(0:) W

[mocaIfRlapmTable/1.3.6.1.4.1.31621.1.2.1.3] Interface RLAPM Table supporting the configuration of RLAPM (Receive Level Added PHY Margin) function parameters for the selected profile.

The pairs [GlobalAggrRxPwrLevel (GARPLi ), PhyMargin (RLAPMi)] are used to determine the subcarriers’ bitloadings according [Section 7.15.2 and Table 17-1/MoCAv2.0].

At most one enabled entry in this table can exist with the same values for all of Profile, Frequency and GlobalAggrRxPwrLevel.

 - 2.17
Enable boolean W Enables or disables this Rlamp entry. true 2.17
Profile unsignedInt W [mocaIfRlapmProfile/1.3.6.1.4.1.31621.1.2.1.3.1.1] Profile index used for the RLAPM (Receive Level Added PHY Margin) table. - 2.17
Frequency unsignedInt W [mocaIfRlapmFrequency/1.3.6.1.4.1.31621.1.2.1.3.1.2] Frequency (band) index used for the RLAPM (Receive Level Added PHY Margin) table. - 2.17
GlobalAggrRxPwrLevel unsignedInt(0:65) W

[mocaIfRlapmGarpl/1.3.6.1.4.1.31621.1.2.1.3.1.3] Global Aggregated Receive Power Level (GARPL).

The parameter contains the “Ni” value, where GARPLi = -Ni dBm.

 - 2.17
PhyMargin unsignedInt(0:60) W

[mocaIfRlapmPhyMargin/1.3.6.1.4.1.31621.1.2.1.3.1.4] Receive Level Added Phy Margin (RLAPM).

The parameter contains the “Ni” value, where RLAPMi = 0.5*Ni dB.

 - 2.17
Status string R [mocaIfRlapmStatus/1.3.6.1.4.1.31621.1.2.1.3.1.5] [RowStatus] Reflects the status of a row in this table. - 2.17
Device.MoCA.Interface.{i}.Sapm.{i}. object(0:) W

[mocaIfSapmTable/1.3.6.1.4.1.31621.1.2.1.4] Interface SAPM Table supporting the configuration of SAPM (Subcarrier Added PHY Margin) function parameters for the selected profile.

When the aggregate received power level (ARPL) is below the pre-specified threshold AggrRxPwrLevelThreshold, for each subcarrier, its corresponding value on the list PhyMargin will be considered to determine the subcarriers’ bitloading according [Section 7.15.2 and Table 17-1/MoCAv2.0].

At most one enabled entry in this table can exist with the same values for both Profile and Frequency.

 - 2.17
Enable boolean W Enables or disables this Sapm entry. true 2.17
Profile unsignedInt W [mocaIfSapmProfile/1.3.6.1.4.1.31621.1.2.1.4.1.1] Profile index used for the SAPM (Subcarrier Added PHY Margin) table. - 2.17
Frequency unsignedInt W [mocaIfSapmFrequency/1.3.6.1.4.1.31621.1.2.1.4.1.2] Frequency (band) index used for the SAPM (Subcarrier Added PHY Margin) table. - 2.17
AggrRxPwrLevelThreshold unsignedInt(0:65) W

[mocaIfSapmARPLTHLD/1.3.6.1.4.1.31621.1.2.1.4.1.3] Aggregate Received Power Level Threshold (ARPL_THLD).

The parameter contains the “N” value, where ARPL_THLD = -N dBm.

 - 2.17
PhyMargin unsignedInt(0:120)[] W

[mocaIfSapmPhyMargin/1.3.6.1.4.1.31621.1.2.1.4.1.4] Comma-separated list of unsigned integers (0 to 120). Subcarrier Added PHY Margin (SAPM).

List of SAPM values representing the PHY margin the Node is required to add to the bitloading of each of the available subcarriers when the received power level is below ARPL_THLD (AggrRxPwrLevelThreshold).

Each value contains the “Ni” value for a OFDM subcarrier “i”, where SAPMi = 0.5*Ni dB.

 - 2.17
Status string R [mocaIfSapmStatus/1.3.6.1.4.1.31621.1.2.1.4.1.5] [RowStatus] Reflects the status of a row in this table. - 2.17
Device.MoCA.Interface.{i}.Aca. object R [mocaIfAcaTable/1.3.6.1.4.1.31621.1.2.1.5] This diagnostic test corresponds to the MoCA ACA (Alternate Channel Assessment) operation. When this test is Requested the managed MoCA Node will initiate a MoCA On Demand LMO (Link Maintenance Operation). - 2.17
DiagnosticsState string W

[mocaIfAcaInitiate/1.3.6.1.4.1.31621.1.2.1.5.1.5 mocaIfAcaStatus/1.3.6.1.4.1.31621.1.2.1.5.1.6 mocaIfAcaStatusCompletedTrap/1.3.6.1.4.1.31621.1.2.1.5.1.9] [DiagnosticsState] Indicates the availability of diagnostics data. Enumeration of:

Enumeration of:

  • None (READONLY)
  • Requested (ACA operation requested and in progress)
  • Canceled (OPTIONAL)
  • Complete (ACA operation completed successfully, READONLY)
  • Error (ACA operation failed (fail), READONLY)
  • Error_BadChannel (ACA operation failed because of bad channel (failBADCHANNEL), READONLY)
  • Error_NoEvmProbe (ACA operation failed because there was no Evm probe detected (failNOEVMPROBE), READONLY)

If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested.

When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test.

When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above.

If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate.

When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message.

After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None.

Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None.

While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None.

While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters.

While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with “Invalid Parameter value” (9007) to the ACS instead.

Enumeration of:

  • None (READONLY)
  • Requested (ACA operation requested and in progress)
  • Canceled (OPTIONAL)
  • Complete (ACA operation completed successfully, READONLY)
  • Error (ACA operation failed (fail), READONLY)
  • Error_BadChannel (ACA operation failed because of bad channel (failBADCHANNEL), READONLY)
  • Error_NoEvmProbe (ACA operation failed because there was no Evm probe detected (failNOEVMPROBE), READONLY)
 - 2.17
NodeID unsignedInt(0:15) W [mocaIfAcaNodeID/1.3.6.1.4.1.31621.1.2.1.5.1.1] [MocaNodeID] The Node ID of the MoCA Node to transmit the EVM Probe when the parameter Type = evm. - 2.17
Type string W

[mocaIfAcaType/1.3.6.1.4.1.31621.1.2.1.5.1.2] The ACA (Alternate Channel Assessment) type is either evm or quiet.

Enumeration of:

  • quiet
  • evm
 - 2.17
Channel unsignedInt W [mocaIfAcaChannel/1.3.6.1.4.1.31621.1.2.1.5.1.3] The channel number under assessment, starting from 0 in increments of 25 MHz. - 2.17
ReportNodeMask hexBinary(2) W

[mocaIfAcaReportNodeMask/1.3.6.1.4.1.31621.1.2.1.5.1.4] Specifies the MoCA Nodes that are requested to be part of the channel assessment: Setting bits corresponding to Node IDs of these MoCA Nodes to 1.

See [Section 6.2.1/MoCAv2.0]

 - 2.17
TotalRxPower int R [mocaIfAcaTotalRxPower/1.3.6.1.4.1.31621.1.2.1.5.1.7] [MocaDBm] dBm (-128 to +127 dBm). - 2.17
PowerProfile hexBinary R [mocaIfAcaPowerProfile/1.3.6.1.4.1.31621.1.2.1.5.1.8] Binary string array with 1 byte (represented as two hexadecimal digits) for each subcarrier. See [Appendix A/MOCA11-MIB] for the encoding of this object. - 2.17
Device.MoCA.Interface.{i}.Reset. object R [mocaIfMrTable/1.3.6.1.4.1.31621.1.2.1.6] Used by the managed MoCA Node to initiate MoCA Reset Transaction. - 2.17
NodeMask hexBinary(2) W

[mocaIfMrNodeMask/1.3.6.1.4.1.31621.1.2.1.6.1.1] The MoCA Nodes that must respond to the MR transaction L2ME request sent by the NC except for the MR Entry Node (LSB corresponds to Node ID 0x0).

See [Section 6.2.1/MoCAv2.0]

 - 2.17
StartTime unsignedInt W

[mocaIfMrStartTime/1.3.6.1.4.1.31621.1.2.1.6.1.2] Time in seconds after this parameter is written that a MoCA Node must initiate a MoCA Reset (MR).

See [Section 7.15/MoCAv2.0].

 - 2.17
StatusTrapEnable boolean W [mocaIfMrStatusTrapEnable/1.3.6.1.4.1.31621.1.2.1.6.1.3] Used to enable MrRstSuccessTrap and MrRstFailTrap that the network reset was completed successfully or failed for MR transaction status trap. - 2.17
NetworkTrapEnable boolean W [mocaIfMrNetworkTrapEnable/1.3.6.1.4.1.31621.1.2.1.6.1.4] Used to enable MrNetworkSuccessTrap and MrNetworkFailTrap that the network was reformed or not reformed successfully following the MR transaction. - 2.17
Device.MoCA.Interface.{i}.Stats. object R

Throughput statistics for this interface.

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

Changes in 2.17:

 - 2.0
BytesSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

  • Added id = mocaIfTxBytes/1.3.6.1.4.1.31621.1.2.1.8.1.8
  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
BytesReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

  • Added id = mocaIfRxBytes/1.3.6.1.4.1.31621.1.2.1.8.1.9
  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
PacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

  • Added id = mocaIfTxPackets/1.3.6.1.4.1.31621.1.2.1.8.1.1
  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
PacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

  • Added id = mocaIfRxPackets/1.3.6.1.4.1.31621.1.2.1.8.1.3
  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
RxCorrectedErrors unsignedLong R

[mocaIfRxCorrectedErrors/1.3.6.1.4.1.31621.1.2.1.8.1.4] [StatsCounter64] The number of received Ethernet packets that have errors and are corrected by this MoCA interface.

Active Notification requests for this parameter MAY be denied.

 - 2.17
ErrorsSent unsignedInt R

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

This parameter MUST NOT be implemented for MoCA 2.0 because it doesn’t map to a MIB object.

Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

  • 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.

This parameter MUST NOT be implemented for MoCA 2.0 because it doesn’t map to a MIB object.

Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

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

[mocaIfTxUnicast/1.3.6.1.4.1.31621.1.2.1.8.1.10] [StatsCounter64] The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent.

Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

  • Added id = mocaIfTxUnicast/1.3.6.1.4.1.31621.1.2.1.8.1.10
  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
UnicastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

  • Added id = mocaIfRxUnicast/1.3.6.1.4.1.31621.1.2.1.8.1.11
  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
DiscardPacketsReceived unsignedInt R

[mocaIfRxDrops/1.3.6.1.4.1.31621.1.2.1.8.1.5] [StatsCounter32] The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space.

Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

  • Added id = mocaIfRxDrops/1.3.6.1.4.1.31621.1.2.1.8.1.5
  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
MulticastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

  • Added id = mocaIfTxMulticast/1.3.6.1.4.1.31621.1.2.1.8.1.12
  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
MulticastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

  • Added id = mocaIfRxMulticast/1.3.6.1.4.1.31621.1.2.1.8.1.13
  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
BroadcastPacketsSent unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

  • Added id = mocaIfTxBroadcast/1.3.6.1.4.1.31621.1.2.1.8.1.14
  • Changed syntax = unsignedLong -> StatsCounter64
 - 2.0
BroadcastPacketsReceived unsignedLong R

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

Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

  • Added id = mocaIfRxBroadcast/1.3.6.1.4.1.31621.1.2.1.8.1.15
  • 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.

This parameter MUST NOT be implemented for MoCA 2.0 because it doesn’t map to a MIB object.

Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
Device.MoCA.Interface.{i}.QoS. object R The QoS object provides information on MoCA parameterized QoS for this interface [MoCAv1.1]. - 2.0
EgressNumFlows unsignedInt R

[mocaIfEgressNodeNumFlows/1.3.6.1.4.1.31621.1.2.1.8.1.6] The number of QoS flows that this interface has from the MoCA network.

This parameter is based on mocaIfEgressNodeNumFlows from [MOCA11-MIB].

Changes in 2.17:

  • Added id = mocaIfEgressNodeNumFlows/1.3.6.1.4.1.31621.1.2.1.8.1.6
 - 2.0
IngressNumFlows unsignedInt R

[mocaIfIngressNodeNumFlows/1.3.6.1.4.1.31621.1.2.1.8.1.7] The number of QoS flows that this interface has onto the MoCA network.

This parameter is based on mocaIfIngressNodeNumFlows from [MOCA11-MIB].

Changes in 2.17:

  • Added id = mocaIfIngressNodeNumFlows/1.3.6.1.4.1.31621.1.2.1.8.1.7
 - 2.0
Device.MoCA.Interface.{i}.QoS.FlowStats.{i}. object(0:) R

The flow statistics table provides information on the MoCA parameterized QoS flows this interface has allocated onto the MoCA network.

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

Changes in 2.17:

 - 2.0
FlowID string(:17) R

[mocaIfFlowID/1.3.6.1.4.1.31621.1.2.1.9.1.2] [MACAddress] The flow ID used to identify a flow in the network.

This parameter is based on mocaIfFlowID from [MOCA11-MIB].

Note that the data type has changed from unsignedInt to MACAddress. This is because the original data type was an error and could not have been implemented as specified.

Changes in 2.17:

  • Added id = mocaIfFlowID/1.3.6.1.4.1.31621.1.2.1.9.1.2
  • Changed syntax = unsignedInt -> MACAddress
 - 2.0
PacketDA string(:17) R

[mocaIfPacketDA/1.3.6.1.4.1.31621.1.2.1.9.1.3] [MACAddress] The Destination Address (DA) for the packets in this flow.

This parameter is based on mocaIfPacketDA from [MOCA11-MIB].

Changes in 2.17:

  • Added id = mocaIfPacketDA/1.3.6.1.4.1.31621.1.2.1.9.1.3
 - 2.0
MaxRate unsignedInt R

[mocaIfPeakDataRate/1.3.6.1.4.1.31621.1.2.1.9.1.4] Maximum required rate in Kbps.

This parameter is based on mocaIfPeakDataRate from [MOCA11-MIB].

Changes in 2.17:

  • Added id = mocaIfPeakDataRate/1.3.6.1.4.1.31621.1.2.1.9.1.4
 - 2.0
MaxBurstSize unsignedInt R

[mocaIfBurstSize/1.3.6.1.4.1.31621.1.2.1.9.1.5] Maximum burst size.

This parameter is based on mocaIfBurstSize from [MOCA11-MIB].

Changes in 2.17:

  • Added id = mocaIfBurstSize/1.3.6.1.4.1.31621.1.2.1.9.1.5
 - 2.0
LeaseTime unsignedInt R

[mocaIfLeaseTime/1.3.6.1.4.1.31621.1.2.1.9.1.6] Flow lease time (expressed in seconds).

A LeaseTime of 0 means unlimited lease time.

This parameter is based on mocaIfLeaseTime from [MOCA11-MIB].

Changes in 2.17:

  • Added id = mocaIfLeaseTime/1.3.6.1.4.1.31621.1.2.1.9.1.6
 - 2.0
Tag unsignedInt R [mocaIfFlowTag/1.3.6.1.4.1.31621.1.2.1.9.1.7] The FLOW_TAG of the PQoS flow identified by FlowID in which this MoCA interface is an Ingress Node for this PQoS flow. The FLOW_TAG carries application specific content of this PQoS flow. See [Section 6.3.13.1/MoCAv2.0]. - 2.17
LeaseTimeLeft unsignedInt R

[mocaIfLeaseTimeLeft/1.3.6.1.4.1.31621.1.2.1.9.1.8] Flow lease time remaining (expressed in seconds).

If LeaseTime is 0 then a LeaseTimeLeft of 0 means unlimited lease time; otherwise, a LeaseTimeLeft of 0 means expired.

This parameter is based on mocaIfLeaseTimeLeft from [MOCA11-MIB].

Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

  • Added id = mocaIfLeaseTimeLeft/1.3.6.1.4.1.31621.1.2.1.9.1.8
 - 2.0
FlowPackets unsignedInt R

[mocaIfTxPacketsFlow/1.3.6.1.4.1.31621.1.2.1.9.1.9] [StatsCounter32] The number of packets transmitted for this flow.

This parameter is based on mocaIfTxPacketsFlow from [MOCA11-MIB].

Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

  • Added id = mocaIfTxPacketsFlow/1.3.6.1.4.1.31621.1.2.1.9.1.9
  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
IngressGuid string(:17) R

[mocaIfFlowStatsIngressGuid/1.3.6.1.4.1.31621.1.2.1.9.1.10] [MACAddress] The MAC address of the MoCA Node specified by the INGRESS_NODE_ID parameter of the flow.

See [Section 6.3.13.1/MoCAv2.0].

 - 2.17
EgressGuid string(:17) R

[mocaIfFlowStatsEgressGuid/1.3.6.1.4.1.31621.1.2.1.9.1.11] [MACAddress] The MAC address of the MoCA Node specified by the EGRESS_NODE_ID parameter of the flow.

See [Section 6.3.13.1/MoCAv2.0].

 - 2.17
MaximumLatency unsignedInt R

[mocaIfFlowStatsMaximumLatency/1.3.6.1.4.1.31621.1.2.1.9.1.12] The MAXIMUM_LATENCY parameter of the flow in units of milliseconds. A value of 0 indicates no value available.

See [Section 6.3.13.1/MoCAv2.0].

 - 2.17
ShortTermAvgRatio unsignedInt R

[mocaIfFlowStatsShortTermAvgRatio/1.3.6.1.4.1.31621.1.2.1.9.1.13] The SHORT_TERM_AVERAGE_RATIO parameter of the flow.

See [Section 6.3.13.1/MoCAv2.0].

 - 2.17
FlowPer unsignedInt R

[mocaIfFlowStatsFlowPer/1.3.6.1.4.1.31621.1.2.1.9.1.15] The FLOW_PER parameter of this flow, where a value of 0 indicates NPER and 1 indicates VLPER.

See [Section 6.3.13.1/MoCAv2.0].

 - 2.17
IngressClassify string R

[mocaIfFlowStatsIngressClassify/1.3.6.1.4.1.31621.1.2.1.9.1.16] [MocaFlowIngrClassRule] The INGRESS_CLASSIFICATION_RULE parameter of the flow.

See [Section 6.3.13.1/MoCAv2.0].

 - 2.17
VlanTag unsignedInt R

[mocaIfFlowStatsVlanTag/1.3.6.1.4.1.31621.1.2.1.9.1.17] The VLAN_TAG parameter of the flow.

See [Section 6.3.13.1/MoCAv2.0].

 - 2.17
DscpMoca unsignedInt R

[mocaIfFlowStatsDscpMoca/1.3.6.1.4.1.31621.1.2.1.9.1.18] The DSCP_MOCA parameter of the flow.

See [Section 6.3.13.1/MoCAv2.0].

 - 2.17
Dfid unsignedInt R

[mocaIfFlowStatsDfid/1.3.6.1.4.1.31621.1.2.1.9.1.19] The destination flow ID of the flow assigned by the Ingress Node.

See [Section 7.8.1.2/MoCAv2.0].

 - 2.17
Device.MoCA.Interface.{i}.AssociatedDevice.{i}. object(0:) R

[mocaNodeTable/1.3.6.1.4.1.31621.1.2.1.11 mocaLinkStatsTable/1.3.6.1.4.1.31621.1.2.1.10] This table contains information about other MoCA devices currently associated with this MoCA interface.

Entries in this table cannot be created or deleted by the network management system. All entries are created or deleted by the device software.

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

Changes in 2.17:

 - 2.0
MACAddress string(:17) R [mocaNodeMacAddress/1.3.6.1.4.1.31621.1.2.1.11.1.3] [MACAddress] The MAC address of the associated device’s MoCA interface.

Changes in 2.17:

  • Added id = mocaNodeMacAddress/1.3.6.1.4.1.31621.1.2.1.11.1.3
 - 2.0
NodeID unsignedInt(0:15) R

[mocaNodeIndex/1.3.6.1.4.1.31621.1.2.1.11.1.1] [MocaNodeID] The Node ID of this remote device.

This parameter is based on mocaNodeIndex from [MOCA11-MIB].

Changes in 2.17:

  • Added id = mocaNodeIndex/1.3.6.1.4.1.31621.1.2.1.11.1.1
  • Changed syntax = unsignedInt -> MocaNodeID
 - 2.0
PreferredNC boolean R

[mocaNodePreferredNC/1.3.6.1.4.1.31621.1.2.1.11.1.8] Whether this remote device is a preferred Network Coordinator (NC).

This parameter is based on mocaNodePreferredNC from [MOCA11-MIB].

The factory default value MUST be false.

Changes in 2.17:

  • Added id = mocaNodePreferredNC/1.3.6.1.4.1.31621.1.2.1.11.1.8
  • Added boolean syntax false default
 - 2.0
HighestVersion string(:64) R

[mocaNodeMocaVersion/1.3.6.1.4.1.31621.1.2.1.11.1.2] Identifies the highest MoCA version that this remote device supports.

This element MUST be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, 1.0, where the components mean major.minor revision number. Possible patterns:

  • \d+(\.\d+)*

This parameter is based on mocaNodeMocaVersion from [MOCA11-MIB].

Changes in 2.17:

  • Added id = mocaNodeMocaVersion/1.3.6.1.4.1.31621.1.2.1.11.1.2
 - 2.0
PHYTxRate unsignedInt R

The PHY transmit rate (in Mbps) to this remote device.

This parameter is based on mocaMeshTxRate from [MOCA11-MIB].

This parameter MUST NOT be implemented for MoCA 2.0 because it doesn’t map to a MIB object.

 - 2.0
PHYRxRate unsignedInt R

The PHY receive rate (in Mbps) from this remote device.

This parameter MUST NOT be implemented for MoCA 2.0 because it doesn’t map to a MIB object.

 - 2.0
TxPowerControlReduction unsignedInt R
[mocaNodeTxPowerReduction/1.3.6.1.4.1.31621.1.2.1.11.1.6] [MocaDB] The reduction in transmitter level (in {{units: missing units facet}}) due to power control.
This parameter is based on mocaNodeTxPowerReduction from [MOCA11-MIB].
This parameter was DEPRECATED in 2.17 since it is replaced by Device.MoCA.Interface.{i}.Mesh.{i}.PowerReduction. See [MOCA20-MIB].

Changes in 2.17:

  • Added status = deprecated
  • Added id = mocaNodeTxPowerReduction/1.3.6.1.4.1.31621.1.2.1.11.1.6
  • Changed syntax = unsignedInt -> MocaDB
 - 2.0
RxPowerLevel unsignedInt R
[mocaNodeRxPower/1.3.6.1.4.1.31621.1.2.1.11.1.7] The power level (in dBm) received at the MoCA interface from this remote device.
This parameter is based on mocaNodeRxPower from [MOCA11-MIB].
This parameter was DEPRECATED in 2.17 since it is replaced by Device.MoCA.Interface.{i}.Mesh.{i}.Power. See [MOCA20-MIB].
Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

  • Added status = deprecated
  • Added id = mocaNodeRxPower/1.3.6.1.4.1.31621.1.2.1.11.1.7
 - 2.0
TxBcastRate unsignedInt(0:2048) R

[mocaNodeTxGcdRate/1.3.6.1.4.1.31621.1.2.1.11.1.4] [MocaPhyRate] The broadcast PHY transmit rate (in {{units: missing units facet}}) from this remote device.

This parameter is based on mocaNodeTxGcdRate from [MOCA11-MIB].

Changes in 2.17:

  • Added id = mocaNodeTxGcdRate/1.3.6.1.4.1.31621.1.2.1.11.1.4
  • Changed syntax = unsignedInt -> MocaPhyRate
 - 2.0
RxBcastPowerLevel int R

[mocaNodeRxGcdPower/1.3.6.1.4.1.31621.1.2.1.11.1.5] [MocaDBm] The power level (in {{units: missing units facet}}) received at the MoCA interface from this remote device.

This parameter is based on mocaNodeRxGcdPower from [MOCA11-MIB].

Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

  • Added id = mocaNodeRxGcdPower/1.3.6.1.4.1.31621.1.2.1.11.1.5
  • Changed syntax = unsignedInt -> MocaDBm
 - 2.0
TxPackets unsignedLong R

[mocaLinkTxPackets/1.3.6.1.4.1.31621.1.2.1.10.1.2] [StatsCounter64] The number of packets transmitted to this remote device (Note: Includes Broadcast, Multicast and Unicast packets).

Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

  • Added id = mocaLinkTxPackets/1.3.6.1.4.1.31621.1.2.1.10.1.2
  • Changed syntax = unsignedInt -> StatsCounter64
 - 2.0
TxDrops unsignedInt R [mocaLinkTxDrops/1.3.6.1.4.1.31621.1.2.1.10.1.3] [StatsCounter32] The number of Unicast EPDUs received at the ECL, destined to the associated MoCA Node, and not transmitted by this MoCA interface. - 2.17
RxPackets unsignedLong R

[mocaNodeRxPackets/1.3.6.1.4.1.31621.1.2.1.11.1.11] [StatsCounter64] The number of packets received from this remote device (Note: Includes Broadcast, Multicast and Unicast packets).

This parameter is based on mocaNodeRxPackets from [MOCA11-MIB].

Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

  • Added id = mocaNodeRxPackets/1.3.6.1.4.1.31621.1.2.1.11.1.11
  • Changed syntax = unsignedInt -> StatsCounter64
 - 2.0
RxCorrected unsignedLong R [mocaNodeRxCorrected/1.3.6.1.4.1.31621.1.2.1.11.1.12] [StatsCounter64] The number of Ethernet packets received by this MoCA interface that have errors and are corrected from the MoCA Node identified by MACAddress. - 2.17
RxErroredAndMissedPackets unsignedInt R

[mocaNodeRxDrops/1.3.6.1.4.1.31621.1.2.1.11.1.13] [StatsCounter32] The number of errored and missed packets received from this remote device.

This parameter is based on mocaNodeRxDrops from [MOCA11-MIB].

Changes in 2.17:

  • Added id = mocaNodeRxDrops/1.3.6.1.4.1.31621.1.2.1.11.1.13
  • Changed syntax = unsignedInt -> StatsCounter32
 - 2.0
BondingCapable boolean R [mocaNodeBondingCapable/1.3.6.1.4.1.31621.1.2.1.11.1.9] The MoCA Node identified by MACAddress supports Bonding if the value is true. The MoCA Node identified by MACAddress does not support Bonding if this value is false. - 2.17
QAM256Capable boolean R

Whether this remote device supports the 256 QAM feature.

This parameter is based on mocaNodeQAM256Capable from [MOCA11-MIB].

This parameter MUST NOT be implemented for MoCA 2.0 because it doesn’t map to a MIB object.

 - 2.0
PacketAggregationCapability unsignedInt R

[mocaNodePduNumber/1.3.6.1.4.1.31621.1.2.1.11.1.10] The packet aggregation capability supported by the remote device. Standard values are 0 (no support), 6 (6 packets) or 10 (10 packets).

This parameter is based on mocaNodePacketsAggrCapability from [MOCA11-MIB].

Note that this parameter maps to different MIB objects for MoCA 1.0/1.1 and MoCA 2.0. [XXX2: Need to modify the syntax to ‘unsignedInt’ because MoCA 2.0 requires a minimum of 20 packets and MoCA 2.5 requires a minimum of 80 packets.]

Changes in 2.17:

  • Added id = mocaNodePduNumber/1.3.6.1.4.1.31621.1.2.1.11.1.10
  • Removed unsignedInt 0:10 range
 - 2.0
RxSNR unsignedInt R
[mocaNodeSNR/1.3.6.1.4.1.31621.1.2.1.11.1.14] [MocaDB] The signal to noise level (in {{units: missing units facet}}) received at this interface from this remote device.
This parameter is based on mocaNodeSNR from [MOCA11-MIB].
This parameter was DEPRECATED in 2.17 since it is replaced by Device.MoCA.Interface.{i}.Mesh.{i}.RxSNR. See [MOCA20-MIB].

Changes in 2.17:

  • Added status = deprecated
  • Added id = mocaNodeSNR/1.3.6.1.4.1.31621.1.2.1.11.1.14
  • Changed syntax = unsignedInt -> MocaDB
 - 2.0
SupportedIngressPqosFlows unsignedInt R [mocaNodeSupportedIngressPqosFlows/1.3.6.1.4.1.31621.1.2.1.11.1.15] The number of Ingress PQoS Flows supported by this MoCA interface from the MoCA Node identified by MACAddress. - 2.17
SupportedEgressPqosFlows unsignedInt R [mocaNodeSupportedEgressPqosFlows/1.3.6.1.4.1.31621.1.2.1.11.1.16] The number of Egress PQoS Flows supported by this MoCA interface from the MoCA Node identified by MACAddress. - 2.17
AggregationSize unsignedInt R [mocaNodeAggregationSize/1.3.6.1.4.1.31621.1.2.1.11.1.17] The maximum number of bytes that can be aggregated in a MoCA frame that this MoCA Node supports. - 2.17
AeNumber unsignedInt R [mocaNodeAeNumber/1.3.6.1.4.1.31621.1.2.1.11.1.18] The maximum number of allocation elements, excluding the TAUs and the Dummy DAUs, in one MAP that this MoCA Node supports. - 2.17
PowerState string R [mocaNodePowerState/1.3.6.1.4.1.31621.1.2.1.11.1.19] [MocaPowerState] Power State of the MoCA Node identified by the MACAddress. - 2.17
PowerStateCapability string R [mocaNodePowerStateCapability/1.3.6.1.4.1.31621.1.2.1.11.1.20] [MocaPowerState] Power State capability of the MoCA Node identified by the MACAddress. - 2.17
PDelay int R [mocaNodePDelay/1.3.6.1.4.1.31621.1.2.1.11.1.21] Propagation delay measured in units of 10ns between the local MoCA Node and the MoCA Node identified by the MACAddress. - 2.17
EnhancedPrivacyCapable boolean R [moca25NodeEnhancedPrivacyCapable/1.3.6.1.4.1.31621.1.3.1.3.1.2] Indicates the MoCA Node identified by MACAddress supports MoCA 2 Enhanced Privacy if the value is true. Indicates the MoCA Node identified by MACAddress does not support MoCA 2 Enhanced Privacy if this value is false. - 2.17
LinkType string R

[moca25NodeLinkType/1.3.6.1.4.1.31621.1.3.1.3.1.3] Indicates the type of link used for unicast data transmissions between the managed MoCA Node and the MoCA Node identified by MACAddress.

Enumeration of:

  • moca1PHY (MoCA 1 PHY)
  • primary (Primary)
  • bonded (Bonded)
  • m25300MHz (300 MHz MoCA 2.5 PHY)
  • m25400MHz (400 MHz MoCA 2.5 PHY)
  • m25500MHz (500 MHz MoCA 2.5 PHY)
 - 2.17
Moca25PhyCapable boolean R [moca25NodeMoca25PhyCapable/1.3.6.1.4.1.31621.1.3.1.3.1.4] Indicates the MoCA Node identified by MACAddress supports MoCA 2.5 PHY if the value is true. Indicates the MoCA Node identified by MACAddress does not support MoCA 2.5 PHY if this value is false. - 2.17
RxPwrList string(2:6) R

[moca25NodeRxPwrList/1.3.6.1.4.1.31621.1.3.1.3.1.5] Per channel list of Receive power levels in dBm from the MoCA Node identified by MACAddress to the managed MoCA Node.

The power measurement should cover the preamble and/or at least a symbol time. The averaging method employed for this measurement is implementation specific and not specified. It is recommended but not required to utilize the LMO (Link Maintenance Operation) EVM probes for this measurement.

The field numValues is a function of LinkType:

  • MoCA 1 PHY - 1
  • Primary - 1
  • Bonded - 2
  • 300 MHz MoCA 2.5 PHY - 3
  • 400 MHz MoCA 2.5 PHY - 4
  • 500 MHz MoCA 2.5 PHY - 5

struct moca25NodePowerList { char numValues; // 1 octet (Number of Values to follow) struct { char power; // 1 octet (Rx Power Level in dBm) } [numValues]; };

 - 2.17
RxSNRList string(2:6) R

[moca25NodeRxSNRList/1.3.6.1.4.1.31621.1.3.1.3.1.6] Per channel list of Average Receive Signal to Noise Ratio (SNR) across all available subcarriers based on the EVM probe from the MoCA Node identified by MACAddress to the managed MoCA Node.

The field numValues is a function of LinkType:

  • MoCA 1 PHY - 1
  • Primary - 1
  • Bonded - 2
  • 300 MHz MoCA 2.5 PHY - 3
  • 400 MHz MoCA 2.5 PHY - 4
  • 500 MHz MoCA 2.5 PHY - 5

struct moca25NodeRxSNRList { char numValues; // 1 octet (Number of Values to follow) struct { char snr; // 1 octet (Rx SNR in dB) } [numValues]; };

 - 2.17
TxPwrList string(2:6) R

[moca25NodeTxPwrList/1.3.6.1.4.1.31621.1.3.1.3.1.7] Per channel list of Transmit power levels in dBm from the managed MoCA Node to the MoCA Node identified by MACAddress. The transmit power should be max power for the channel less the Transmit Power Control.

The field numValues is a function of LinkType:

  • MoCA 1 PHY - 1
  • Primary - 1
  • Bonded - 2
  • 300 MHz MoCA 2.5 PHY - 3
  • 400 MHz MoCA 2.5 PHY - 4
  • 500 MHz MoCA 2.5 PHY - 5

struct moca25NodePowerList { char numValues; // 1 octet (Number of Values to follow) struct { char power; // 1 octet (Tx Power Level in dBm) } [numValues]; };

 - 2.17
TxPwrReductionList string(2:6) R

[moca25NodeTxPwrReductionList/1.3.6.1.4.1.31621.1.3.1.3.1.8] Per channel list of Transmit Power Control (TPC) back-off in dB used for unicast transmissions from the managed MoCA Node to the MoCA Node identified by MACAddress.

TxPwrReductionList is identical to the TPC back-off utilized for transmission from the TPC backoff parameter TX_POWER_ADJUSTMENT_100MHZ.

The field numValues is a function of LinkType:

  • MoCA 1 PHY - 1
  • Primary - 1
  • Bonded - 2
  • 300 MHz MoCA 2.5 PHY - 3
  • 400 MHz MoCA 2.5 PHY - 4
  • 500 MHz MoCA 2.5 PHY - 5

struct moca25NodeTxPwrReductionList { char numValues; // 1 octet (Number of Values to follow) struct { char tpc; // 1 octet (TPC in dB) } [numValues]; };

 - 2.17
EgressNodeNumFlows unsignedInt R [mocaLinkEgressNodeNumFlows/1.3.6.1.4.1.31621.1.2.1.10.1.4] The number of PQoS flows in which this MoCA interface is an Egress Node for these PQoS flows. - 2.17
IngressNodeNumFlows unsignedInt R [mocaLinkIngressNodeNumFlows/1.3.6.1.4.1.31621.1.2.1.10.1.5] The number of PQoS flows in which this MoCA interface is an Ingress Node for these PQoS flows. - 2.17
Device.MoCA.Interface.{i}.Mesh.{i}. object(0:) R

[mocaMeshTable/1.3.6.1.4.1.31621.1.2.1.12] MoCA mesh PHY rate table. This table contains the unicast transmit PHY rate between all pairs of MoCA Nodes in the MoCA network.

Since TxRate is the transmit PHY rate from TxNodeIndex to RxNodeIndex, this table does not contain any entries with TxNodeIndex equals RxNodeIndex. In addition, a MoCA network can have less than 16 Nodes, hence some values of TxNodeIndex and RxNodeIndex in the range of 0 to 15 may not exist.

Entries in this table cannot be created or deleted by the network management system. All entries are created or deleted by the device software.

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

 - 2.17
TxNodeIndex unsignedInt(0:15) R [mocaMeshTableTxNodeIndex/1.3.6.1.4.1.31621.1.2.1.12.1.1] [MocaNodeID] The Node ID of the transmit MoCA Node is used as one of the index to order the mesh PHY rate table. - 2.17
RxNodeIndex unsignedInt(0:15) R [mocaMeshTableRxNodeIndex/1.3.6.1.4.1.31621.1.2.1.12.1.2] [MocaNodeID] The Node ID of the receive MoCA Node is used as one of the index to order the mesh PHY rate table. - 2.17
TxRate unsignedInt(0:2048) R [mocaMeshTxRate/1.3.6.1.4.1.31621.1.2.1.12.1.3] [MocaPhyRate] The transmit MoCA 1 PHY rate in Mbps from the MoCA Node identified by TxNodeIndex to the MoCA Node identified by RxNodeIndex. - 2.17
TxRateNper unsignedInt(0:2048) R [mocaMeshTxRateNper/1.3.6.1.4.1.31621.1.2.1.12.1.4] [MocaPhyRate] The transmit normal packet error PHY Rate from the MoCA Node identified by TxNodeIndex to the MoCA Node identified by RxNodeIndex. - 2.17
TxRateVlper unsignedInt(0:2048) R [mocaMeshTxRateVlper/1.3.6.1.4.1.31621.1.2.1.12.1.5] [MocaPhyRate] The transmit very low packet error PHY Rate from the MoCA Node identified by TxNodeIndex to the MoCA Node identified by RxNodeIndex. - 2.17
LinkType string R

[mocaMeshLinkType/1.3.6.1.4.1.31621.1.2.1.12.1.6] The type of link which exists from the MoCA Node identified by TxNodeIndex to the MoCA Node identified by RxNodeIndex. Enumeration of:

  • moca1PHY
  • primary
  • bonded

This parameter is only used for MoCA 2.0.

 - 2.17
Power hexBinary(2:3) R

[mocaMeshPower/1.3.6.1.4.1.31621.1.2.1.12.1.7] Per channel list of Transmit or Receive power levels in dBm. If the MoCA Node identified by TxNodeIndex is equal to NodeID, then indicates the unicast transmit power in dBm from the MoCA Node identified by TxNodeIndex to the MoCA Node identified by RxNodeIndex, else indicates the unicast receive power in dBm from the MoCA Node identified by TxNodeIndex at the MoCA Node identified by RxNodeIndex.

For transmit power, the power should be max power for the channel less the Transmit Power Control. For received power, the power measurement should cover the preamble and/or at least a symbol time. The averaging method employed for this measurement is implementation specific and not specified. It is recommended but not required to utilize the LMO (Link Maintenance Operation) EVM probes for this measurement.

The field numValues is a function of LinkType:

struct mocaPower { char numValues; // 1 octet (Number of Values to follow) { char power; // 1 octet (Tx or Rx Power Level in dB) } [numValues]; };

This parameter is only used for MoCA 2.0.

 - 2.17
PowerReduction hexBinary(2:3) R

[mocaMeshPowerReduction/1.3.6.1.4.1.31621.1.2.1.12.1.8] Per channel list of The Transmit Power Control (TPC) back-off in dB. If the MoCA Node identified by TxNodeIndex is equal to NodeID, then indicates the TPC in dB utilized to back-off transmission to the MoCA Node identified by RxNodeIndex. Otherwise indicates the TPC in dB that the MoCA Node identified by TxNodeIndex utilized to back-off its transmission.

PowerReduction is identical to the TPC back-off utilized for transmission and determined from the TPC backoff parameters TPC_BACKOFF_MAJOR and TPC_BACKOFF_MINOR as follows: PowerReduction = TPC_BACKOFF_MAJOR * 3 +TPC_BACKOFF_MINOR.

The field numValues is a function of LinkType:

struct mocaPowerReduction { char numValues; // 1 octet (Number of Values to follow) { char tpc; // 1 octet (TPC in dB) } [numValues]; };

This parameter is only used for MoCA 2.0.

 - 2.17
RxSNR hexBinary(2:3) R

[mocaMeshRxSNR/1.3.6.1.4.1.31621.1.2.1.12.1.9] Per channel list of average received Signal to Noise Ratio (SNR) in dB. If the MoCA Node identified by RxNodeIndex is not equal to NodeID or the MoCA Node identified by TxNodeIndex is equal to NodeID, then this parameter is not present. Otherwise indicates the average received SNR across all the available carriers based on the EVM probe from the MoCA Node identified by TxNodeIndex.

The field numValues is a function of LinkType:

struct mocaRxSNR { char numValues; // 1 octet (Number of Values to follow) { char rx_snr; // 1 octet (Rx SNR in dB) } [numValues]; };

This parameter is only used for MoCA 2.0.

 - 2.17
Device.MoCA.Interface.{i}.Bridge.{i}. object(0:) R

[mocaBridgeTable/1.3.6.1.4.1.31621.1.2.1.13] MoCA bridge Ethernet MAC address table. This table contains an entry for every MoCA Node in the MoCA network.

Entries in this table cannot be created or deleted by the network management system. All entries are created or deleted by the device software.

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

 - 2.17
NodeIndex unsignedInt(0:15) R [mocaBridgeNodeIndex/1.3.6.1.4.1.31621.1.2.1.13.1.1] [MocaNodeID] The Node ID is used as an index to order the MAC entries in the MoCA bridge table. - 2.17
MACAddresses string(:17)[] R [mocaBridgeMacAddress/1.3.6.1.4.1.31621.1.2.1.13.1.3] [MACAddress] Comma-separated list of MAC Addresses. The Ethernet MAC addresses identified by the Node ID. - 2.17
Device.MoCA.Interface.{i}.MeshScMod.{i}. object(0:) R

[mocaMeshScModTable/1.3.6.1.4.1.31621.1.2.1.14] MoCA mesh Subcarrier Modulation table. This table contains the Unicast transmit subcarrier modulation between all pairs of MoCA Nodes in the MoCA network.

Since Mod is the subcarrier modulation from TxNodeIndex to RxNodeIndex, this table does not contain any entries with TxNodeIndex equals RxNodeIndex. In addition, a MoCA network can have less than 16 MoCA Nodes, hence some values of TxNodeIndex and RxNodeIndex in the range of 0 to 15 may not exist. The ChannelIndex index is used to differentiate between the primary and secondary channels in a bonded channel network. The primary channel index is always present, the secondary channel index may not always be present.

Entries in this table cannot be created or deleted by the network management system. All entries are created or deleted by the device software.

At most one entry in this table can exist with the same values for all of TxNodeIndex, RxNodeIndex and ChannelIndex.

 - 2.17
TxNodeIndex unsignedInt(0:15) R [mocaMeshTxNodeIndex/1.3.6.1.4.1.31621.1.2.1.14.1.1] [MocaNodeID] The Node ID of the transmit MoCA Node is used as one of the index to order the mesh PHY rate table. - 2.17
RxNodeIndex unsignedInt(0:15) R [mocaMeshRxNodeIndex/1.3.6.1.4.1.31621.1.2.1.14.1.2] [MocaNodeID] The Node ID of the receive MoCA Node is used as one of the index to order the mesh subcarrier modulation. - 2.17
ChannelIndex string R

[mocaMeshChannelIndex/1.3.6.1.4.1.31621.1.2.1.14.1.3] [MocaChannelIndex] primary or secondary channel for MoCA 2.0 Node associated with Nper and Vlper. For MoCA 1 Node, the same as the primary channel associated with Mod. In a bonded MoCA 2.0 network, the primary and secondary channels each have their own subcarrier modulation data.

m25first, m25second, m25third, m25fourth or m25fifth channel for MoCA 2.5 Node associated with ModM25.

 - 2.17
Mod hexBinary R [mocaMeshScMod/1.3.6.1.4.1.31621.1.2.1.14.1.4] [MocaScMod] 1 Byte Hex array values with no delimiters where each byte indicates the subcarrier modulation of one subcarrier from the MoCA Node identified by TxNodeIndex to the MoCA Node identified by RxNodeIndex for the MoCA 1 Unicast transmission PHY profile. - 2.17
Nper hexBinary R [mocaMeshScModNper/1.3.6.1.4.1.31621.1.2.1.14.1.5] [MocaScMod] 1 Byte Hex array values with no delimiters where each byte indicates the unicast NPER subcarrier modulation of one subcarrier from the MoCA Node identified by TxNodeIndex to the MoCA Node identified by RxNodeIndex for the associated ChannelIndex. - 2.17
Vlper hexBinary R [mocaMeshScModVlper/1.3.6.1.4.1.31621.1.2.1.14.1.6] [MocaScMod] 1 Byte Hex array values with no delimiters where each byte indicates the unicast VLPER subcarrier modulation of one subcarrier from the MoCA Node identified by TxNodeIndex to the MoCA Node identified by RxNodeIndex for the associated ChannelIndex. - 2.17
ModM25 hexBinary R

[mocaMeshScModM25/1.3.6.1.4.1.31621.1.3.1.4.1.4] [MocaScMod] 1 Byte Hex array values with no delimiters where each byte indicates the MoCA 2.5 unicast subcarrier modulation for all subcarriers from the MoCA Node identified by TxNodeIndex to the MoCA Node identified by RxNodeIndex for the associated ChannelIndex.

For MoCA 2.5 First Channel, Second Channel, Third Channel, Fourth Channel and Fifth Channel, the total number of subcarriers is 512.

 - 2.17
Device.Ghn. object R G.hn object that contains an Interface table for G.hn supported CPE. The ITU-T G.hn specifications [G.9960] and [G.9961] define Physical and MAC Layers for communication between two or more G.hn nodes in the home network over multiple wired media such as power line, phone line and coaxial cable. - 2.4
Device.Ghn.Interface.{i}. object(0:) R

G.hn interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY [G.9960] and MAC [G.9961] layers of a G.hn interface.

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

 - 2.4
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.4
Device.HomePlug. object R HomePlug object that contains the Interface table. The HomePlug industry standard [HPAV1.1] defines peer to peer communication over powerline medium. - 2.0
Device.HomePlug.Interface.{i}. object(0:) R

HomePlug interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of a HomePlug interface [HPAV1.1].

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

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.UPA. object R Universal Powerline Association [UPA-PLC]. This object contains the Interface and Diagnostics objects. - 2.0
Device.UPA.Interface.{i}. object(0:) R

UPA interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of a UPA interface [UPA-PLC].

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

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.UPA.Interface.{i}.ActiveNotch.{i}. object(0:) W

This object contains the list of active notches of the UPA interface.

A UPA device can have notches in its spectrum, where no power is transmitted in a given part of the spectrum. These notches are typically located in amateur radio bands, to avoid interference.

Note: All ActiveNotch entries can be enabled/disabled as a group using the ActiveNotchEnable parameter.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.UPA.Interface.{i}.BridgeFor.{i}. object(0:) R

This object represents the bridge table of the UPA interface. Each instance is a bridge table entry.

It shows the MAC addresses of the remote UPA devices with their associated port number, and the MAC addresses of the end-devices (PCs, STBs, routers, etc) connected to Ethernet port of the powerline adapters with their associated logical port. In this way the system identifies to which UPA device an external device is connected to.

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

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.WiFi. object R The WiFi object is based on the IEEE 802.11 specifications ([802.11-2020]). It defines interface objects (Radio and SSID), and application objects (AccessPoint and EndPoint). - 2.0
Device.WiFi.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.

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

  • Changed status = deprecated ⇒ obsoleted
 - 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.
At most one entry in this table can exist with a given value for MACAddress.

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

  • Changed status = deprecated ⇒ obsoleted
 - 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.
At most one entry in this table can exist with a given value for MACAddress.

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

  • Changed status = deprecated ⇒ obsoleted
 - 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.
At most one entry in this table can exist with a given value for BSSID.

Changes in 2.17:

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

Changes in 2.17:

  • Changed status = deprecated ⇒ obsoleted
 - 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.
At most one entry in this table can exist with a given value for MACAddress.

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

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

Changes in 2.17:

  • Changed status = deprecated ⇒ obsoleted
 - 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.
At most one entry in this table can exist with the same values for all of Time, APOrigin and APDestination.

Changes in 2.17:

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

Changes in 2.17:

 - 2.13
ColocatedAgentID string(:17) R

[MACAddress] AL MAC address of the EasyMesh Agent that is co-located in the same device with the Wi-Fi EasyMesh Controller.

Set to null if there is no such collocated agent.

 - 2.17
STABlockNumberOfEntries unsignedInt R The number of entries in the STABlock table. - 2.17
Device.WiFi.DataElements.Network.SSID.{i}. object(0:) R

This object specifies SSIDs for fronthaul use across all agents in this Wi-Fi Multi-AP network, or on this single-AP. Also specifies the Band for each SSID.

Note that VLAN IDs (VIDs) can be configured per SSID with Device.{i}.SSIDtoVIDMapping.{i}.

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

Changes in 2.17:

 - 2.15
Enable boolean R

Enable or disable of this SSID. Disable stops the use of this SSID, but the object is retained.

true: this SSID is enabled.
false: this SSID is disabled.
 - 2.17
AKMsAllowed string[] R

Comma-separated list of strings. List items indicate Authentication and Key Management (AKM) suites/security modes allowed on this BSS. Each list item is an enumeration of:

  • psk (“psk” indicates one or more of the PSK and FT-PSK AKMs defined in [Table 9-151/802.11-2020] typically at least “00-0F-AC:2” for interoperability)
  • dpp (“dpp” indicates one or more of the DPP and FT-DPP AKMs defined in [Section 8.4/EasyConnect], typically at least “50-6F-9A:2” for interoperability)
  • sae (“sae” indicates one or more of the SAE and FT-SAE AKMs defined in [Table 9-151/802.11-2020] typically at least “00-0F-AC:8” for interoperability)
  • psk+sae
  • dpp+sae
  • dpp+psk+sae
  • SuiteSelector (“SuiteSelector” indicates an AKM suite selector, the value of which is indicated in SuiteSelector)
 - 2.17
SuiteSelector hexBinary(4) R

AKM suite selector, the AKM suite selector (OUI and type) is encoded as a 4-octet hex-encoded value without internal delimiters, e.g. 506F9A02 [Table 9-151/802.11-2020].

This parameter applies if AKMsAllowed includes value “SuiteSelector”.

 - 2.17
AdvertisementEnabled boolean R

Indicates if the SSID is advertised in beacons, or not.

true: this SSID is to be advertised in beacons.
false: this SSID is not to be advertised in beacons.
 - 2.17
MFPConfig string R

Management Frame Protection (MFP) configuration. Enumeration of:

  • Disabled
  • Optional
  • Required
 - 2.17
MobilityDomain string(:17) R [MACAddress] The IEEE 802.11 mobility domain [Section 9.4.2.46/802.11-2020]. - 2.17
HaulType string[] R

Comma-separated list of strings. Indicates the use of this SSID. Each list item is an enumeration of:

  • Fronthaul
  • Backhaul
 - 2.17
Device.WiFi.DataElements.Network.STABlock.{i}. object(0:) W

This object indicates stations (STAs) for which client association is blocked.

optionally the BSSID(s) the STA is blocked from associating to. In multi-AP cases, this should be implemented by Wi-Fi EasyMesh [EasyMesh] client association control.

Stations that are already associated shall be disassociated if STABlock.{i}.Schedule.{i}. indicates so.

At most one entry in this table can exist with a given value for BlockedSTA. On creation of a new table entry, the Agent MUST choose an initial value for BlockedSTA such that the new entry does not conflict with any existing entries.

 - 2.17
BlockedSTA string(:17) W

[MACAddress] MAC addresses of the STA that is blocked.

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

 - 2.17
BSSID string(:17)[] W [MACAddress] Comma-separated list of MAC Addresses. Indicates BSS from which the BlockedSTA is blocked from association and cannot associate to. A null list indicates that all SSIDs are blocked. - 2.17
ScheduleNumberOfEntries unsignedInt R The number of entries in the Schedule table. - 2.17
Device.WiFi.DataElements.Network.STABlock.{i}.Schedule.{i}. object(0:) W

Each instance of this object provides a schedule where client association is blocked for BlockedSTA [Section 11.6/EasyMesh].

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

 - 2.17
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

 - 2.17
Day string[] W

Comma-separated list of strings, the days for which the STA is blocked. Each list item is an enumeration of:

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
 - 2.17
StartTime string(:5) W

Start time of the STA block 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.17
Duration unsignedInt(1:) W The duration, in seconds, which the STA is blocked. If StartTime is defined, the STA is blocked for the Duration period starting from StartTime. - 2.17
Device.WiFi.DataElements.Network.Device.{i}. object(0:) R

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

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

Changes in 2.17:

 - 2.13
APMetricsReportingInterval unsignedInt(:255) W

AP Metrics Reporting Interval.

0: Do not report AP Metrics periodically;
1 –- 255: AP Metrics reporting interval in seconds.
 - 2.15
AssociatedSTAReportingInterval unsignedInt(:255) W

Associated STA Reporting Interval.

0: Do not report associated STA Metrics periodically;

1 - 255: Associated STA Metrics reporting interval in seconds.

 - 2.17
DSCPMap hexBinary(:64) R A hexadecimal string of 64 Priority Code Point (PCP) values (one octet per value) corresponding to the Differentiated Services Code Point (DSCP) markings 0x00 to 0x3F, ordered by increasing DSCP value. Each octet is in the range 0x00 –- 0x07. This is used to select a PCP value if a Service Prioritization Rule specifies Rule Output: 0x08 - 2.15
ControllerOperationMode string R

This parameter represents the status of Wi-Fi EasyMesh 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)
 - 2.17
BackhaulMACAddress string(:17) R [MACAddress] The MAC address of the interface on the network that is providing the backhaul for this EasyMesh Agent. For Wi-Fi backhaul, this is the BSSID or AP MLD address of the backhaul BSS. - 2.17
BackhaulALID string(:17) R [MACAddress] The IEEE 1905 [IEEE1905.1a] Abstraction-Layer ID (ALID) of the EasyMesh Agent on the network that is providing the backhaul for this EasyMesh Agent. - 2.17
BackhaulDownMACAddress string(:17)[] R [MACAddress] Comma-separated list of MAC Addresses. Each MAC address is that of a downstream EasyMesh agent’s backhaul link. - 2.17
BackhaulMediaType string R

Media type of the backhaul link of this EasyMesh Agent.

This value can be derived from the neighbor’s topology response message 1905 device information type TLV Media Type field defined in [Table 6-12/IEEE1905.1a]. Enumeration of:

  • IEEE 802.3u (IEEE 802.3u Fast Ethernet)
  • IEEE 802.3ab (IEEE 802.3ab Gigabit Ethernet)
  • IEEE 802.11b (IEEE 802.11b (2.4GHz))
  • IEEE 802.11g (IEEE 802.11g (2.4GHz))
  • IEEE 802.11a (IEEE 802.11a (5GHz))
  • IEEE 802.11n 2.4 (IEEE 802.11n (2.4GHz))
  • IEEE 802.11n 5.0 (IEEE 802.11n (5GHz))
  • IEEE 802.11ac (IEEE 802.11ac (5GHz))
  • IEEE 802.11ad (IEEE 802.11ad (60GHz))
  • IEEE 802.11af (IEEE 802.11af)
  • IEEE 802.11ax (IEEE 802.11ax)
  • IEEE 802.11be (IEEE 802.11be)
  • IEEE 1901 Wavelet (IEEE 1901 Wavelet)
  • IEEE 1901 FFT (IEEE 1901 FFT)
  • MoCAv1.1 (MoCAv1.1)
  • Generic PHY
 - 2.17
BackhaulPHYRate unsignedInt R The Physical Layer (PHY) rate in Mb/s on the backhaul link of this EasyMesh agent. - 2.17
TrafficSeparationCapability boolean R Indicator of EasyMesh Agent capability to support EasyMesh [EasyMesh] 802.1Q C-TAG Traffic Separation. - 2.17
EasyConnectCapability boolean R

Indicator of the device capability to support Wi-Fi Easy Connect onboarding.

Indicated in the DPP Onboarding field of the EasyMesh Profile-2 AP Capability TLV [EasyMesh].

 - 2.17
TestCapabilities unsignedInt R

Indicates EasyMesh agent support for running a throughput or latency test.

0 indicates that the EasyMesh Agent or single-AP does not support any throughput test and does not support a latency test.

1 indicates that the EasyMesh Agent or single-AP supports a throughput test but does not support a latency test.

2 indicates that the EasyMesh Agent or single-AP supports a latency test but does not support a throughput test.

3 indicates that the EasyMesh Agent or single-AP supports a throughput test and a latency test.

 - 2.17
MaxNumMLDs unsignedInt R The maximum number of MLDs that the EasyMesh Agent can support. [EasyMesh] source: Wi-Fi 7 Agent Capabilities TLV. - 2.17
APMLDMaxLinks unsignedInt(0:15) R The maximum number of affiliated APs supported by any APMLD on this EasyMesh Agent. Set to a value between 0 and 14, which is the number of affiliated APs minus 1. The value of 15 is reserved. [EasyMesh] source: Wi-Fi 7 Agent Capabilities TLV. - 2.17
bSTAMLDMaxLinks unsignedInt(0:15) R The maximum number of affiliated bSTAs supported by the 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. - 2.17
TIDLinkMapCapability string R

Indicates the EasyMesh Agent support for TID to Link mapping. [EasyMesh] source: Wi-Fi 7 Agent Capabilities TLV. Enumeration of:

  • 0 (The EasyMesh Agent does not support TID-to-link mapping)
  • 1 (The EasyMesh Agent supports the mapping of each TID to the same or different link set)
  • 2 (The EasyMesh Agent only supports the mapping of all TIDs to the same link set)
 - 2.17
APMLDNumberOfEntries unsignedInt R The number of entries in the APMLD table. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.SPRule.{i}. object(0:) R

This object describes a list of service prioritization (SP) rules [EasyMesh].

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

 - 2.15
Precedence unsignedInt(:254) R Rule Precedence –- higher number means higher priority. - 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
TransmitterIdentifier string(:17) R

[MACAddress] One of:

MAC address: if the entry corresponds to channel usage by a single client STA associated to an APthe BSS of the Agent;
BSSID: if the entry corresponds to channel usage by multiple or unspecified client STAs associated to an APthe BSS of the Agent;
BSS Color: (first 42-bits are zero) if the channel usage is caused by a source external to the BSSs operated by the Agent and the BSSID can’tcannot be decoded (since frame sent at high MCS) but the BSS Color in the PHY headers could still be identified;
Zero: if the channel usage is caused by a source external to the BSSs operated by the Agent.
 - 2.15
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}. object(0:) R

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

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

 - 2.13
STAReportingRCPIThreshold unsignedInt(:220) W

Station (STA) Metrics Reporting RCPI Threshold.

0: Do not report STA Metrics based on RCPI threshold.
1 –- 220: RCPI threshold (encoded per [Table 9-176/802.11-2020]).
 - 2.15
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.

Changes in 2.17:

 - 2.14
AggregateScanDuration unsignedInt R Total time spent performing the scan of this channel in milliseconds. - 2.17
ScanType boolean R Indicates whether the scan was performed passively (false) or with active probing (true). - 2.17
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}. object(0:) R

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

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

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

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

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

Changes in 2.17:

 - 2.14
ScanStatus string R

Status code to indicate whether a scan has been performed and if not the reason for failure Enumeration of:

  • 0 (Success)
  • 1 (Scan not supported on this opclass and channel)
  • 2 (Request too soon after last scan)
  • 3 (Radio too busy to perform scan)
  • 4 (Scan not completed)
  • 5 (Scan aborted)
  • 6 (Fresh scan not supported, radio only supports on boot scans)
  • 7 (reserved)
 - 2.17
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.NeighborBSS.{i}. object(0:) R

The neighboring BSS discovered by a Radio during a channel scan.

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

Changes in 2.17:

 - 2.14
SignalStrength unsignedInt(:255) R An indicator of radio signal strength (RSSI) of the Beacon or Probe Response frames of the neighboring BSS as received by the radio measured in dBm. (RSSI is encoded per [Table 9-176/802.11-2020]). Reserved: 221 - 255.NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details. - 2.14
MLDMACAddress string(:17) R [MACAddress] The Multi-Link Device (MLD) MAC address of the Multi-Link Operation (MLO) capable access point this neighboring BSS is affiliated to. Null if the neighboring BSS is not an affiliated AP. - 2.17
ReportingBSSID string(:17) R [MACAddress] The BSSID of the reporting BSSID if different from BSSID. This will be set if the NeigborBSS was discovered through, for example, a Reduced Neighbor Report. EasyMesh [EasyMesh] source: Channel Scan Result TLV. - 2.17
MultiBSSID boolean R Indicates if the neighboring BSS is part of a MultiBSSID set and may be a non-transmitted BSSID. - 2.17
BSSLoadElementPresent boolean R Set to true if the neighbour BSS Beacon/Probe Responses include a BSSLoad Element as defined in [Section 9.4.2.28/802.11-2020]. - 2.17
BSSColor unsignedInt(:63) R Set to the BSS Color from the BSS Color Information field in the BSS’s HE Operation element. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanCapability. object R This object describes the channel scan capabilities of a radio. - 2.15
OnBootOnly boolean R “OnOn boot only”only flag, Indicates whether the specified radio is capable only of “OnOn boot”boot scans. - 2.15
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities. object R This object represents the capabilities of the radio which may be different from the current operational configuration.

Changes in 2.17:

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

Changes in 2.17:

  • Changed status = deprecated ⇒ obsoleted
 - 2.13
MSCSCapability boolean R This parameter indicates support for Mirrored Stream Classification Service (MSCS) and EasyMesh configuration of MSCS [AP Radio Advanced Capabilities TLV/EasyMesh]. - 2.17
SCSCapability boolean R This parameter indicates support for Stream Classification Service (SCS) and EasyMesh [EasyMesh] configuration of SCS [AP Radio Advanced Capabilities TLV/EasyMesh]. - 2.17
QoSMapCapability boolean R This parameter indicates support for QoS Map [AP Radio Advanced Capabilities TLV/EasyMesh]. - 2.17
DSCPPolicyCapability boolean R This parameter indicates support for DSCP Mapping Table TLV based DSCP-to-UP mapping and EasyMesh distribution of QoS Map elements to associated STAs [AP Radio Advanced Capabilities TLV/EasyMesh]. - 2.17
SCSTrafficDescriptionCapability boolean R This parameter indicates support for QoS Management Stream Classification Service (SCS) Traffic Description and EasyMesh configuration of and/or extensions to SCS using traffic descriptions [AP Radio Advanced Capabilities TLV/EasyMesh]. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.WiFi6APRole. object R Describes the Wi-Fi 6 capabilities for the AP role.

Changes in 2.17:

 - 2.15
DLOFDMA boolean R Indicates support for Downlink (DL) Orthogonal Frequency Division Multiplexing (OFDMA). - 2.17
MaxDLMUMIMO unsignedInt(:255) R Max number of users supported per DL MU-MIMO Transmitter (TX) in anthe APBSS role. - 2.15
MaxULMUMIMO unsignedInt(:255) R Max number of users supported per UL MU-MIMO Receiver (RX) in anthe APBSS role. - 2.15
MaxDLOFDMA unsignedInt(:255) R Max number of users supported per Downlink (DL) OFDMA TX in anthe APBSS role. - 2.15
MaxULOFDMA unsignedInt(:255) R Max number of users supported per UL OFDMA RX in anthe APBSS role. - 2.15
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.WiFi6bSTARole. object R Describes the Wi-Fi 6 capabilities for the backhaul Station (bSTA) role.

Changes in 2.17:

 - 2.15
DLOFDMA boolean R Indicates support for Downlink (DL) Orthogonal Frequency Division Multiplexing (OFDMA). - 2.17
MaxDLMUMIMO unsignedInt(:255) R Max number of users supported per DL MU-MIMO Transmitter (TX) in anthe APBSS role. - 2.15
MaxULMUMIMO unsignedInt(:255) R Max number of users supported per UL MU-MIMO Receiver (RX) in anthe APBSS role. - 2.15
MaxDLOFDMA unsignedInt(:255) R Max number of users supported per Downlink (DL) OFDMA TX in anthe APBSS role. - 2.15
MaxULOFDMA unsignedInt(:255) R Max number of users supported per UL OFDMA RX in anthe APBSS role. - 2.15
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.WiFi7APRole. object R This object describes the Wi-Fi 7 capabilities for the AP role including Multi-Link Operation (MLO) capabilities. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV. - 2.17
EMLMRSupport boolean R Indicates if the Enhanced Multi-Link Multi-Radio (EMLMR) operation is supported. - 2.17
EMLSRSupport boolean R Indicates if Enhanced Multi-Link Single-Radio (EMLSR) operation is supported. - 2.17
STRSupport boolean R Indicates if Simultaneous Transmit and Receive (STR) operation is supported. - 2.17
NSTRSupport boolean R Indicates if Non-Simultaneous Transmit and Receive (NSTR) operation is supported. - 2.17
TIDLinkMapNegotiation boolean R Indicates if Traffic Identifier (TID) to Link Mapping Negotiation is supported. - 2.17
EMLMRFreqSeparationNumberOfEntries unsignedInt R The number of entries in the EMLMRFreqSeparation table. - 2.17
EMLSRFreqSeparationNumberOfEntries unsignedInt R The number of entries in the EMLSRFreqSeparation table. - 2.17
STRFreqSeparationNumberOfEntries unsignedInt R The number of entries in the STRFreqSeparation table. - 2.17
NSTRFreqSeparationNumberOfEntries unsignedInt R The number of entries in the NSTRFreqSeparation table. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.WiFi7APRole.EMLMRFreqSeparation.{i}. object(0:) R

This object describes the required frequency separation from the specified radio RUID for MLO Enhanced Multi-Link Multi-Radio (EMLMR) operation. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV.

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

 - 2.17
RUID base64 R The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies. - 2.17
FreqSeparation unsignedInt R Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (FreqSeparation - 1) x 80 MHz. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.WiFi7APRole.EMLSRFreqSeparation.{i}. object(0:) R

This object describes the required frequency separation from the specified radio RUID for MLO Enhanced Multi-Link Single-Radio (EMLSR) operation. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV.

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

 - 2.17
RUID base64 R The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies. - 2.17
FreqSeparation unsignedInt R Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (FreqSeparation - 1) x 80 MHz. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.WiFi7APRole.STRFreqSeparation.{i}. object(0:) R

This object describes the required frequency separation from the specified radio RUID for MLO Simultaneous Transmit and Receive (STR) operation. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV.

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

 - 2.17
RUID base64 R The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies. - 2.17
FreqSeparation unsignedInt R Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (FreqSeparation - 1) x 80 MHz. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.WiFi7APRole.NSTRFreqSeparation.{i}. object(0:) R

This object describes the required frequency separation from the specified radio RUID for MLO Non-Simultaneous Transmit and Receive (NSTR) operation. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV.

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

 - 2.17
RUID base64 R The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies. - 2.17
FreqSeparation unsignedInt R Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (FreqSeparation - 1) x 80 MHz. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.WiFi7bSTARole. object R This object describes the Wi-Fi 7 capabilities for the backhaul Station (bSTA) role including Multi-Link Operation (MLO) capabilities. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV. - 2.17
EMLMRSupport boolean R Indicates if the Enhanced Multi-Link Multi-Radio (EMLMR) operation is supported. - 2.17
EMLSRSupport boolean R Indicates if Enhanced Multi-Link Single-Radio (EMLSR) operation is supported. - 2.17
STRSupport boolean R Indicates if Simultaneous Transmit and Receive (STR) operation is supported. - 2.17
NSTRSupport boolean R Indicates if Non-Simultaneous Transmit and Receive (NSTR) operation is supported. - 2.17
TIDLinkMapNegotiation boolean R Indicates if Traffic Identifier (TID) to Link Mapping Negotiation is supported. - 2.17
EMLMRFreqSeparationNumberOfEntries unsignedInt R The number of entries in the EMLMRFreqSeparation table. - 2.17
EMLSRFreqSeparationNumberOfEntries unsignedInt R The number of entries in the EMLSRFreqSeparation table. - 2.17
STRFreqSeparationNumberOfEntries unsignedInt R The number of entries in the STRFreqSeparation table. - 2.17
NSTRFreqSeparationNumberOfEntries unsignedInt R The number of entries in the NSTRFreqSeparation table. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.WiFi7bSTARole.EMLMRFreqSeparation.{i}. object(0:) R

This object describes the required frequency separation from the specified radio RUID for MLO Enhanced Multi-Link Multi-Radio (EMLMR) operation. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV.

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

 - 2.17
RUID base64 R The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies. - 2.17
FreqSeparation unsignedInt R Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (FreqSeparation - 1) x 80 MHz. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.WiFi7bSTARole.EMLSRFreqSeparation.{i}. object(0:) R

This object describes the required frequency separation from the specified radio RUID for MLO Enhanced Multi-Link Single-Radio (EMLSR) operation. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV.

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

 - 2.17
RUID base64 R The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies. - 2.17
FreqSeparation unsignedInt R Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (FreqSeparation - 1) x 80 MHz. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.WiFi7bSTARole.STRFreqSeparation.{i}. object(0:) R

This object describes the required frequency separation from the specified radio RUID for MLO Simultaneous Transmit and Receive (STR) operation. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV.

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

 - 2.17
RUID base64 R The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies. - 2.17
FreqSeparation unsignedInt R Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (FreqSeparation - 1) x 80 MHz. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.WiFi7bSTARole.NSTRFreqSeparation.{i}. object(0:) R

This object describes the required frequency separation from the specified radio RUID for MLO Non-Simultaneous Transmit and Receive (NSTR) operation. [EasyMesh] Source: Wi-Fi 7 Agent Capabilities TLV.

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

 - 2.17
RUID base64 R The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies. - 2.17
FreqSeparation unsignedInt R Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (FreqSeparation - 1) x 80 MHz. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}. object(0:) R

A single logical BSS operating on this radio.

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

Changes in 2.17:

 - 2.13
FronthaulAKMsAllowed string[] W

Comma-separated list of strings. List items indicate Authentication and Key Management (AKM) suites/security modes allowed at this BSS for fronthaul. Each list item is an enumeration of:

  • psk (“psk” indicates one or more of the PSK and FT-PSK AKMs defined in [Table 9-151/802.11-2020] typically at least “00-0F-AC:2” for interoperability)
  • dpp (“dpp” indicates one or more of the DPP and FT-DPP AKMs defined in [Section 8.4/EasyConnect], typically at least “50-6F-9A:2” for interoperability)
  • sae (“sae” indicates one or more of the SAE and FT-SAE AKMs defined in [Table 9-151/802.11-2020] typically at least “00-0F-AC:8” for interoperability)
  • psk+sae
  • dpp+sae
  • dpp+psk+sae
  • SuiteSelector (“SuiteSelector” indicates an AKM suite selector, the value of which is indicated in FronthaulSuiteSelector)
 - 2.15
FronthaulSuiteSelector hexBinary(4) W

AKM suite selector, the AKM suite selector (OUI and type) is encoded as a 4-octet hex-encoded value without internal delimiters, e.g. 506F9A02 [Table 9-151/802.11-2020].

This parameter applies if FronthaulAKMsAllowed includes value “SuiteSelector”.

 - 2.17
BackhaulAKMsAllowed string[] W

Comma-separated list of strings. List items indicate Authentication and Key Management (AKM) suites/security modes allowed at this BSS for backhaul. Each list item is an enumeration of:

  • psk (“psk” indicates one or more of the PSK and FT-PSK AKMs defined in [Table 9-151/802.11-2020] typically at least “00-0F-AC:2” for interoperability)
  • dpp (“dpp” indicates one or more of the DPP and FT-DPP AKMs defined in [Section 8.4/EasyConnect], typically at least “50-6F-9A:2” for interoperability)
  • sae (“sae” indicates one or more of the SAE and FT-SAE AKMs defined in [Table 9-151/802.11-2020] typically at least “00-0F-AC:8” for interoperability)
  • psk+sae
  • dpp+sae
  • dpp+psk+sae
  • SuiteSelector (“SuiteSelector” indicates an AKM suite selector, the value of which is indicated in BackhaulSuiteSelector)
 - 2.15
BackhaulSuiteSelector hexBinary(4) W

AKM suite selector, the AKM suite selector (OUI and type) is encoded as a 4-octet hex-encoded value without internal delimiters, e.g. 506F9A02 [Table 9-151/802.11-2020].

This parameter applies if BackhaulAKMsAllowed includes value “SuiteSelector”.

 - 2.17
BasicDataTransmitRates unsignedInt[] R Comma-separated list of unsigned integers. The current basic data rates; the set of data rates, in kbps, that have to be supported by all stations that desire to join this BSS. The stations have to be able to receive and transmit at each of the data rates listed in BasicDataTransmitRates. Most control packets use a data rate in BasicDataTransmitRates. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.QMDescriptor.{i}. object(0:) R

This object contains a table of DescriptorElement.

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

Changes in 2.17:

 - 2.15
BSSID string(:17) R [MACAddress] The BSSID of BSS for which this descriptor applies. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.MUConfig. object R This object provides Multiuser (MU)-specific BSS configuration. - 2.17
DLOFDMAEnable boolean W Enable downlink (DL) Orthogonal Frequency-Division Multiple Access (OFDMA). - 2.17
ULOFDMAEnable boolean W Enable uplink (UL) OFDMA. - 2.17
DLMUMIMOEnable boolean W Enable DL Multi-User Multi-Input Multi-Output (MU-MIMO). - 2.17
ULMUMIMOEnable boolean W Enable UL MU-MIMO. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.MUStats. object R This object provides packet statistics for a Multiuser (MU) BSS. - 2.17
DLTotalPPDUCount unsignedInt R [StatsCounter32] Total number of Physical-layer Protocol Data Units (PPDUs) transmitted by the Wi-Fi Basic Service Set (BSS). - 2.17
DLHEPPDUCount unsignedInt R [StatsCounter32] Number of High-Efficiency (HE) PPDUs transmitted by the BSS. - 2.17
DLMUPPDUCount unsignedInt R [StatsCounter32] Number of Multi-User (MU) PPDUs transmitted by the BSS. - 2.17
DLOFDMAPPDUCount unsignedInt R [StatsCounter32] Number of Orthogonal Frequency-Division Multiple Access (OFDMA) PPDUs transmitted by the BSS. - 2.17
DLMUMIMOPPDUCount unsignedInt R [StatsCounter32] Number of Multi-Input Multi-Output (MU-MIMO) PPDUs transmitted by the BSS. - 2.17
DLOFDMAMUMIMOPPDUCount unsignedInt R [StatsCounter32] Number of PPDUs transmitted by the BSS with OFDMA and MU-MIMO. - 2.17
ULTotalPPDUCount unsignedInt R [StatsCounter32] Total number of PPDUs received by the BSS. - 2.17
ULHEPPDUCount unsignedInt R [StatsCounter32] Number of High-Efficiency (HE) PPDUs received by the BSS. - 2.17
ULMUPPDUCount unsignedInt R [StatsCounter32] Number of MU PPDUs received by the BSS. - 2.17
ULOFDMAPPDUCount unsignedInt R [StatsCounter32] Number of OFDMA PPDUs received by the BSS. - 2.17
ULMUMIMOPPDUCount unsignedInt R [StatsCounter32] Number of MU-MIMO PDDUs received by the BSS. - 2.17
ULOFDMAMUMIMOPPDUCount unsignedInt R [StatsCounter32] Number of PPDUs received by the BSS with OFDMA and MU-MIMO. - 2.17
DLRU26PPDUCount unsignedInt R [StatsCounter32] Number of PPDUs sent on the downlink using Resource Unit (RU) RU26. - 2.17
DLRU52PPDUCount unsignedInt R [StatsCounter32] Number of PPDUs sent on the downlink using RU52. - 2.17
DLRU106PPDUCount unsignedInt R [StatsCounter32] Number of PPDUs sent on the downlink using RU106. - 2.17
DLRU242PPDUCount unsignedInt R [StatsCounter32] Number of PPDUs sent on the downlink using RU242. - 2.17
DLRU484PPDUCount unsignedInt R [StatsCounter32] Number of PPDUs sent on the downlink using RU484. - 2.17
DLRU996PPDUCount unsignedInt R [StatsCounter32] Number of PPDUs sent on the downlink using RU996. - 2.17
DLRU1992PPDUCount unsignedInt R [StatsCounter32] Number of PPDUs sent on the downlink using RU1992. - 2.17
ULRU26PPDUCount unsignedInt R [StatsCounter32] Number of PPDUs received on the uplink using RU26. - 2.17
ULRU52PPDUCount unsignedInt R [StatsCounter32] Number of PPDUs received on the uplink using RU52. - 2.17
ULRU106PPDUCount unsignedInt R [StatsCounter32] Number of PPDUs received on the uplink using RU106. - 2.17
ULRU242PPDUCount unsignedInt R [StatsCounter32] Number of PPDUs received on the uplink using RU242. - 2.17
ULRU484PPDUCount unsignedInt R [StatsCounter32] Number of PPDUs received on the uplink using RU484. - 2.17
ULRU996PPDUCount unsignedInt R [StatsCounter32] Number of PPDUs received on the uplink using RU996. - 2.17
ULRU1992PPDUCount unsignedInt R [StatsCounter32] Number of PPDUs received on the uplink using RU1992. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.MultiAPSteering. object R A single logical Access Point operating on this radio. - 2.15
BTMAttempts unsignedLong R [StatsCounter64] Number of times a BTM (BSS Transition Management; {{bibref: non-existent {{replaced: unexpected argument sections 4.3.19.3 and 6.3.57 after: 802.11k, 802.11-2020}}}}) steer was attempted for this Access Point. - 2.15
BTMQueryResponses unsignedLong R [StatsCounter64] Number of asynchronous BTM (BSS Transition Management; {{bibref: non-existent {{replaced: unexpected argument sections 4.3.19.3 and 6.3.57 after: 802.11k, 802.11-2020}}}}) Queries for which a BTM Request was issued by this Access Point. - 2.15
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.ThroughputTestResult. object R Object containing the results of the most recent throughput (speed) test from the BSS to a station (STA). - 2.17
TimeStamp dateTime R Timestamp for the throughput test, indicating when the test completed. - 2.17
ClientMAC string(:17) R [MACAddress] MAC address of the STA that the throughput test ran to. - 2.17
VID unsignedInt(0:4095) R

The VLAN ID (VID) that the throughput test ran on.

A value of 0 indicates that no VLAN was specified.

 - 2.17
WMMUP unsignedInt(0:8) R

Wireless MultiMedia (WMM) User Priority (UP) [WMM] that the throughput test was requested to run on.

A value of 8 indicates that no UP was specified.

 - 2.17
TestDuration unsignedInt R Duration of the throughput test in milliseconds. - 2.17
TestLayer unsignedInt R The OSI layer that the throughput test ran on. - 2.17
TestAlgorithm string R The test algorithm that the throughput test used. - 2.17
DownlinkSpeed unsignedInt R Downlink speed found by the throughput test in kbps. - 2.17
UplinkSpeed unsignedInt R Uplink speed found by the throughput test in kbps. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.LatencyTestResult. object R Object containing the results of the most recent latency test set from the BSS to a station (STA). Each latency test set includes a number of individual echo tests. Each echo test result provides a sample of round-trip times and statistics on all the echo tests in this latency test are reported in this object. - 2.17
TimeStamp dateTime R Timestamp for the latency test, indicating when the last echo in the latency test set was received or timed-out. - 2.17
ClientMAC string(:17) R [MACAddress] MAC address of the station (STA) or EasyMesh Agent that the latency test ran to. - 2.17
VID unsignedInt(0:4095) R

The VLAN ID (VID) that the latency test ran on.

A value of 0 indicates that no VLAN was specified.

 - 2.17
WMMUP unsignedInt(0:8) R

Wireless MultiMedia (WMM) User Priority (UP) [WMM] that the latency test was requested to run on.

A value of 8 indicates that no UP was specified.

 - 2.17
DataBlockSize unsignedInt R

The size of each data block, in bytes, that was transmitted in each echo test. The data block excludes the packet or frame header.

A value of 0 indicates that no DataBlockSize was specified.

 - 2.17
TestLayer unsignedInt R The OSI layer that the latency test ran on. - 2.17
TestAlgorithm string R The test algorithm that the latency test used. - 2.17
SuccessCount unsignedInt R

The number of successfully received echo responses.

This parameter is an output of the latency test.

 - 2.17
LostCount unsignedInt R

The number of lost echoes in the latency test set.

This parameter is an output of the latency test.

 - 2.17
AverageResponseTime unsignedInt R

The average round-trip time of the results of the latency test set in milliseconds. This average is across successfully received echoes only.

This parameter is an output of the latency test.

 - 2.17
MinimumResponseTime unsignedInt R

The minimum round-trip time of the results of the latency test set in milliseconds. This minimum is across successfully received echoes only.

This parameter is an output of the latency test.

 - 2.17
MaximumResponseTime unsignedInt R

The maximum round-trip time of the results of the latency test set in milliseconds. This maximum is across successfully received echoes only.

This parameter is an output of the latency test.

 - 2.17
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}. object(0:) R

Object describing a single Associated Device (STA).

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

Changes in 2.17:

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

Changes in 2.17:

  • Changed status = deprecated ⇒ obsoleted
 - 2.13
SignalStrength unsignedInt(:255) R

An indicator of radio signal strength of the uplink from the associated STA to the access point - measured in dBm. RCPI is encoded per [Table 9-176/802.11-2020], and described in [Section 10.3.1/EasyMesh]). Reserved: 221 - 255.

NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details.

If the instance of this STA is the same as Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}, then this parameter is the same as Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}.SignalStrength.

 - 2.13
SleepMode string R

This parameter indicates the current operating sleep mode as recorded by the BSS [802.11-2020]. Enumeration of:

  • Not_Asleep
  • WNM_Sleep_Mode
  • TPU_Sleep
  • TDLS_Peer_Power_Save_Mode_(PSM)
  • AP_PS-Poll
  • TWT_Sleep
  • Light_Sleep
  • Deep_Sleep
 - 2.17
SecurityAssociation string R

This parameter indicates the current operating security state as defined in [Section 12.6.1.1/802.11-2020]. Enumeration of:

  • PMKSA
  • PMK-R0
  • PMK-R1
  • Mesh_PMKSA
  • Mesh_TKSA
  • PTKSA
  • GTKSA
  • IGTKSA
  • Mesh_GTKSA
  • BIGTKSA
  • TPKSA
  • Other
 - 2.17
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.WiFi6Capabilities. object R Describes the Wi-Fi 6 capabilities of the Associated Device (STA).

Changes in 2.17:

 - 2.15
DLOFDMA boolean R Indicates support for Downlink (DL) Orthogonal Frequency Division Multiplexing (OFDMA). - 2.17
MaxDLMUMIMO unsignedInt(:255) R Max number of users supported per DL MU-MIMO Transmitter (TX) in anthe APBSS role. - 2.15
MaxULMUMIMO unsignedInt(:255) R Max number of users supported per UL MU-MIMO Receiver (RX) in anthe APBSS role. - 2.15
MaxDLOFDMA unsignedInt(:255) R Max number of users supported per Downlink (DL) OFDMA TX in anthe APBSS role. - 2.15
MaxULOFDMA unsignedInt(:255) R Max number of users supported per UL OFDMA RX in anthe APBSS role. - 2.15
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.UnassociatedSTA.{i}. object(0:) R

Each instance represents a Non-APstation STA(STA) that has been discovered by the Radio but is not associated to any of the BSS operating on the Radio.

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

Changes in 2.17:

 - 2.13
SignalStrength unsignedInt(:255) R An indicator of radio signal strength (RCPI) of the uplink from the Non-AP STA - measured in dBm. RCPI is encoded per [Table 9-176/802.11-2020], and described in [Section 10.3.2/EasyMesh]. Reserved: 221 - 255.NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details. - 2.13
OperatingClass unsignedInt(:255) R Operating class on which this unassociated STA was last detected, per [Table E-4/802.11-2020]. - 2.17
Channel unsignedInt(:255) R Channel on which this unassociated STA was last detected. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.WPS. object R This object contains Wi-Fi Protected Setup (WPS) Push Button Configuration (PBC) configuration and status as specified in [WPSv1.0] or [WPS 2.0]). In EasyMesh [EasyMesh] this object applies to fronthaul only. - 2.17
Enable boolean W Enables or disables WPS functionality for this EasyMesh agent or single AP. - 2.17
Status string R

Indicates the current status of WPS. If the device goes to SetupLocked the WPS needs to be disabled and re-enabled to come out of this state.

Enumeration of:

  • Disabled
  • Error
  • Unconfigured
  • Configured
  • SetupLocked
  • InProgress
 - 2.17
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}. object(0:) R

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

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

 - 2.17
MLDMACAddress string(:17) R [MACAddress] The Multi-Link Device (MLD) MAC Address of the MLO Capable access point (AP). [EasyMesh] Source: Agent AP MLD Configuration TLV. - 2.17
TIDLinkMapNumberOfEntries unsignedInt R The number of entries in the TIDLinkMap table. - 2.17
AffiliatedAPNumberOfEntries unsignedInt R The number of entries in the AffiliatedAP table. - 2.17
STAMLDNumberOfEntries unsignedInt R The number of entries in the STAMLD table. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.APMLDConfig. object R This object describes the Wi-Fi 7 Multi-Link Operation (MLO) configuration of the Multi-Link Device (MLD) Access Point (AP), [EasyMesh] source: Agent AP MLD Configuration TLV. - 2.17
EMLMREnabled boolean R Indicates if the Enhanced Multi-Link Multi-Radio (EMLMR) operation is enabled. - 2.17
EMLSREnabled boolean R Indicates if Enhanced Multi-Link Single-Radio (EMLSR) operation is enabled. - 2.17
STREnabled boolean R Indicates if Simultaneous Transmit and Receive (STR) operation is enabled. - 2.17
NSTREnabled boolean R Indicates if Non-Simultaneous Transmit and Receive (NSTR) operation is enabled. - 2.17
TIDLinkMapNegotiation boolean R Indicates if Traffic Identifier (TID) to Link Mapping Negotiation is enabled. [EasyMesh] source: TID-to-Link Mapping Policy TLV. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.TIDLinkMap.{i}. object(0:) R

Table of Traffic Identifier (TID) to Link Mappings of the Multi-Link Operation (MLO) capable access point (AP). Each table entry describes the mapping between a particular TID and direction and preferred link. [EasyMesh] source: TID-to-Link Mapping Policy TLV.

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

 - 2.17
Direction string R

The direction of the traffic flow from the perspective of the APMLD. Enumeration of:

  • Up
  • Down
 - 2.17
TID unsignedInt(0:255) R The traffic identifier (TID) for this mapping. - 2.17
BSSID string(:17) R [MACAddress] The BSSID of the preferred link (affiliated AP) to use for traffic with matching direction and TID values. - 2.17
LinkID unsignedInt(0:255) R The Link ID of the preferred link (affiliated AP) to use for traffic with matching direction and TID values. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.AffiliatedAP.{i}. object(0:) R

The Access Points (APs) affiliated to the AP MLD. [EasyMesh] Source: Agent AP MLD Configuration TLV.

Counters in this object include all traffic, MLD and non-MLD.

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

 - 2.17
BSSID string(:17) R [MACAddress] The BSSID of the affiliated AP. This should be set to one of the values of Radio.{i}.BSS.{i}.BSSID. [EasyMesh] source: Agent AP MLD Configuration TLV. - 2.17
LinkID unsignedInt(0:255) R The Link ID assigned to this affiliated AP. [EasyMesh] source: Agent AP MLD Configuration TLV. - 2.17
RUID base64 R The Radio unique identifier (RUID) of the Radio that this affiliated AP is operating on. [EasyMesh] source: Agent AP MLD Configuration TLV. - 2.17
DisabledSubChannels unsignedInt(0:65535) R Disabled Subchannel Bitmap subfield from the EHT Operation element in transmitted Management frames. Null value or not present for stations. [EasyMesh] source: Static Puncturing Configuration TLV. - 2.17
PacketsSent unsignedInt R [StatsCounter32] The number of packets transmitted by the Affiliated AP. Note: this counter counts only MLD traffic through this BSSID, not legacy (non-MLD) traffic. [EasyMesh] source: Associated STA Traffic Stats TLV. - 2.17
PacketsReceived unsignedInt R [StatsCounter32] The total number of packets received from the affiliated STAs by this Affiliated AP. [EasyMesh] source: Associated STA Traffic Stats TLV. - 2.17
UnicastBytesSent unsignedInt R [StatsCounter32] Total number of unicast bytes transmitted to MLD STAs associated with the affiliated AP. [EasyMesh] source: Affiliated AP Metrics TLV. - 2.17
UnicastBytesReceived unsignedInt R [StatsCounter32] Total number of unicast bytes received from MLD STAs associated with the affiliated AP. [EasyMesh] source: Affiliated AP Metrics TLV. - 2.17
ErrorsSent unsignedInt R [StatsCounter32] The number of packets which could not be transmitted by the Affiliated AP due to errors. This counter counts only MLD traffic through this BSSID, not legacy (non-MLD) traffic. [EasyMesh] source: Affiliated AP Metrics TLV. - 2.17
MulticastBytesSent unsignedInt R [StatsCounter32] Total multicast bytes transmitted to MLD STAs associated with the affiliated AP. [EasyMesh] source: Affiliated AP Metrics TLV. - 2.17
MulticastBytesReceived unsignedInt R [StatsCounter32] Total multicast bytes received from MLD STAs associated with the affiliated AP. [EasyMesh] source: Affiliated AP Metrics TLV. - 2.17
BroadcastBytesSent unsignedInt R [StatsCounter32] Total broadcast bytes transmitted to MLD STAs associated with the affiliated AP. [EasyMesh] source: Affiliated AP Metrics TLV. - 2.17
BroadcastBytesReceived unsignedInt R [StatsCounter32] Total broadcast bytes received from MLD STAs associated with the affiliated AP. [EasyMesh] source: Affiliated AP Metrics TLV. - 2.17
EstServiceParametersBE base64(0:3) R Estimated Service Parameters information field for AC=BE, defined per [Figure 9-637/802.11-2020] and referenced in [Section 17.2.22/EasyMesh]. - 2.17
EstServiceParametersBK base64(0:3) R Estimated Service Parameters information field for AC=BK, defined per [Figure 9-637/802.11-2020] and referenced in [Section 17.2.22/EasyMesh]. - 2.17
EstServiceParametersVI base64(0:3) R Estimated Service Parameters information field for AC=VI, defined per [Figure 9-637/802.11-2020] and referenced in [Section 17.2.22/EasyMesh]. - 2.17
EstServiceParametersVO base64(0:3) R Estimated Service Parameters information field for AC=VO, defined per [Figure 9-637/802.11-2020] and referenced in [Section 17.2.22/EasyMesh]. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.STAMLD.{i}. object(0:) R

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

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

 - 2.17
MLDMACAddress string(:17) R [MACAddress] The Multi-Link Device (MLD) MAC Address of the client MLD STA. [EasyMesh] source: Associated STA MLD Configuration Report TLV. - 2.17
Hostname string R The Hostname for the client MLD STA. - 2.17
IPv4Address string(:45) R [IPv4Address] The IPv4 address allocated to the MLD MAC Address of this device. - 2.17
IPv6Address string(:45) R [IPv6Address] The IPv6 address allocated to the MLD MAC Address of this device. - 2.17
IsbSTA boolean R Indicates if the client MLD STA is a backhaul MLD STA (bSTAMLD). This is useful when the same AP MLD has both client MLD and bSTAMLDs associated. [EasyMesh] source: Backhaul STA MLD Configuration TLV. - 2.17
LastConnectTime unsignedInt R The time in seconds since this client MLD STA was associated. - 2.17
BytesSent unsignedInt R [StatsCounter32] The total number of bytes transmitted to the client MLD STA. [EasyMesh] source: Associated STA Traffic Stats TLV. - 2.17
BytesReceived unsignedInt R [StatsCounter32] The total number of bytes received from the client MLD STA. [EasyMesh] source: Associated STA Traffic Stats TLV. - 2.17
PacketsSent unsignedInt R [StatsCounter32] The total number of packets transmitted to the client MLD STA. [EasyMesh] source: Associated STA Traffic Stats TLV. - 2.17
PacketsReceived unsignedInt R [StatsCounter32] The total number of packets received from the client MLD STA. [EasyMesh] source: Associated STA Traffic Stats TLV. - 2.17
ErrorsSent unsignedInt R [StatsCounter32] The number of packets which could not be transmitted to the client MLD STA due to errors. [EasyMesh] source: Associated STA Traffic Stats TLV. - 2.17
ErrorsReceived unsignedInt R [StatsCounter32] The number of packets which were received with error from the client MLD STA. [EasyMesh] source: Associated STA Traffic Stats TLV. - 2.17
RetransCount unsignedInt R [StatsCounter32] The number of packets transmitted with the retry flag sent to the client MLD STA. [EasyMesh] source: Associated STA Traffic Stats TLV. - 2.17
STATIDLinkMapNumberOfEntries unsignedInt R The number of entries in the STATIDLinkMap table. - 2.17
AffiliatedSTANumberOfEntries unsignedInt R The number of entries in the AffiliatedSTA table. - 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. - 2.17
EMLMRSupport boolean R Indicates if the Enhanced Multi-Link Multi-Radio (EMLMR) operation is supported by this STAMLD. - 2.17
EMLSRSupport boolean R Indicates if Enhanced Multi-Link Single-Radio (EMLSR) operation is supported by this STAMLD. - 2.17
STRSupport boolean R Indicates if Simultaneous Transmit and Receive (STR) operation is supported by this STAMLD. - 2.17
NSTRSupport boolean R Indicates if Non-Simultaneous Transmit and Receive (NSTR) operation is supported by this STAMLD. - 2.17
TIDLinkMapNegotiation boolean R Indicates if Traffic Identifier (TID) to Link Mapping Negotiation is supported by this STAMLD. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.STAMLD.{i}.STAMLDConfig. object R This object describes the Wi-Fi 7 Multi-Link Operation (MLO) configuration of the Multi-Link Device (MLD) station (STA, also called associated device). Note this may differ from the WiFi7 capabilities of the device. [EasyMesh] source: Associated STA MLD Configuration Report TLV. - 2.17
EMLMREnabled boolean R Indicates if the Enhanced Multi-Link Multi-Radio (EMLMR) operation is enabled. - 2.17
EMLSREnabled boolean R Indicates if Enhanced Multi-Link Single-Radio (EMLSR) operation is enabled. - 2.17
STREnabled boolean R Indicates if Simultaneous Transmit and Receive (STR) operation is enabled. - 2.17
NSTREnabled boolean R Indicates if Non-Simultaneous Transmit and Receive (NSTR) operation is enabled. - 2.17
TIDLinkMapNegotiation boolean R Indicates if Traffic Identifier (TID) to Link Mapping Negotiation is enabled. [EasyMesh] source: TID-to-Link Mapping Policy TLV. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.STAMLD.{i}.STATIDLinkMap.{i}. object(0:) R

Table of Traffic Identifier (TID) to Link Mappings of the Multi-Link Operation (MLO) capable station (STA). Each table entry describes the mapping between a particular TID and direction and preferred link. [EasyMesh] source: TID-to-Link Mapping Policy TLV.

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

 - 2.17
Direction string R

The direction of the traffic flow from the perspective of the APMLD. Enumeration of:

  • Up
  • Down
 - 2.17
TID unsignedInt(0:255) R The traffic identifier (TID) for this mapping. - 2.17
BSSID string(:17) R [MACAddress] The BSSID of the preferred link (affiliated AP) to use for traffic with matching direction and TID values. - 2.17
LinkID unsignedInt(0:255) R The Link ID of the preferred link (affiliated AP) to use for traffic with matching direction and TID values. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.APMLD.{i}.STAMLD.{i}.AffiliatedSTA.{i}. object(0:) R

This object describes stations (STAs, also called associated devices) that are affiliated to this Multi-Link Device (MLD) STA. [EasyMesh] source: Associated STA MLD Configuration TLV.

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

 - 2.17
MACAddress string(:17) R [MACAddress] The MAC address of the affiliated STA. [EasyMesh] source: Associated STA MLD Configuration Report TLV. - 2.17
BSSID string(:17) R [MACAddress] The BSSID of the affiliated AP that the affiliated STA is associated to. [EasyMesh] source: Associated STA MLD Configuration Report TLV. - 2.17
BytesSent unsignedInt R [StatsCounter32] The total number of bytes transmitted to the affiliated STA. [EasyMesh] source: Associated STA Traffic Stats TLV. - 2.17
BytesReceived unsignedInt R [StatsCounter32] The total number of bytes received from the affiliated STA. [EasyMesh] source: Associated STA Traffic Stats TLV. - 2.17
PacketsSent unsignedInt R [StatsCounter32] The total number of packets transmitted to the affiliated STA. [EasyMesh] source: Associated STA Traffic Stats TLV. - 2.17
PacketsReceived unsignedInt R [StatsCounter32] The total number of packets received from the affiliated STA. [EasyMesh] source: Associated STA Traffic Stats TLV. - 2.17
ErrorsSent unsignedInt R [StatsCounter32] The number of packets which could not be transmitted to the affiliated STA due to errors. [EasyMesh] source: Associated STA Traffic Stats TLV. - 2.17
SignalStrength unsignedInt(:255) R An indicator of radio signal strength of the uplink from the affiliated STA to the access point - measured in dBm. RCPI is encoded per [Table 9-176/802.11-2020], and described in [Section 10.3.1/EasyMesh]). Reserved: 221 - 255. - 2.17
EstMACDataRateDownlink unsignedInt R Estimate of the MAC layer throughput in Mbps achievable in the downlink direction if 100% of channel airtime and BSS operating bandwidth were available, as defined in [Section 10.3.1/EasyMesh]. - 2.17
EstMACDataRateUplink unsignedInt R Estimate of the MAC layer throughput in Mbps achievable in the uplink direction if 100% of channel airtime and BSS operating bandwidth were available, as defined in [Section 10.3.1/EasyMesh]. - 2.17
LastDataDownlinkRate unsignedInt R The data transmit rate in kbps that was most recently used for transmission of data from the access point to the affiliated STA. - 2.17
LastDataUplinkRate unsignedInt R The data transmit rate in kbps that was most recently used for transmission of data from the affiliated STA to the access point. - 2.17
UtilizationReceive unsignedLong R The amount of time in milliseconds that the APMLD Radio has spent on the channel receiving data from the affiliated STA. - 2.17
UtilizationTransmit unsignedLong R The amount of time in milliseconds that the APMLD Radio has spent on the channel transmitting data to the affiliated STA. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.bSTAMLD. object R This object represents the Multi-Link Operation (MLO) capable backhaul station (bSTA) operating on this EasyMesh Agent. Only one MLO capable bSTA per EasyMesh Agent is allowed. [EasyMesh] source: Backhaul STA MLD Configuration TLV. - 2.17
MLDMACAddress string(:17) R [MACAddress] The Multi-Link Device (MLD) MAC Address of the MLO Capable bSTA. [EasyMesh] Source: Backhaul STA MLD Configuration TLV. - 2.17
BSSID string(:17) R [MACAddress] The MLD MAC address of the upstream APMLD that this bSTAMLD is associated to. [EasyMesh] source: Associated Clients TLV. - 2.17
AffiliatedbSTAList string(:17)[] R [MACAddress] Comma-separated list of MAC Addresses. backhaul STA MAC addresses affiliated to this bSTAMLD. [EasyMesh] source: Backhaul STA MLD Configuration TLV. - 2.17
Device.WiFi.DataElements.Network.Device.{i}.bSTAMLD.bSTAMLDConfig. object R This object describes the Multi-Link Operation (MLO) configuration of a Multi-Link Device (MLD) backhaul STA (bSTA). [EasyMesh] source: Backhaul STA MLD Configuration TLV. - 2.17
EMLMREnabled boolean R Indicates if the Enhanced Multi-Link Multi-Radio (EMLMR) operation is enabled. - 2.17
EMLSREnabled boolean R Indicates if Enhanced Multi-Link Single-Radio (EMLSR) operation is enabled. - 2.17
STREnabled boolean R Indicates if Simultaneous Transmit and Receive (STR) operation is enabled. - 2.17
NSTREnabled boolean R Indicates if Non-Simultaneous Transmit and Receive (NSTR) operation is enabled. - 2.17
TIDLinkMapNegotiation boolean R Indicates if Traffic Identifier (TID) to Link Mapping Negotiation is enabled. [EasyMesh] source: TID-to-Link Mapping Policy TLV. - 2.17
Device.WiFi.DataElements.AssociationEvent. object R This object contains the events generated when a STA associates to a BSS. - 2.13
AssociationEventDataNumberOfEntries unsignedInt R
The number of entries in the AssociationEventData table.
This parameter was DEPRECATED in 2.17 because a corresponding USP event is defined instead.

Changes in 2.17:

  • Added status = deprecated
 - 2.13
Device.WiFi.DataElements.AssociationEvent.AssociationEventData.{i}. object(0:) R
The events generated when an Associated Device (STA) associates to a BSS.
This object was DEPRECATED in 2.17 because a corresponding USP event is defined instead.

Changes in 2.17:

  • Added status = deprecated
 - 2.13
Device.WiFi.DataElements.AssociationEvent.AssociationEventData.{i}.WiFi6Capabilities. object R
Describes the Wi-Fi 6 capabilities of the Associated Device (STA).
This object was DEPRECATED in 2.17 because a corresponding USP event is defined instead.

Changes in 2.17:

  • Added status = deprecated
  • Added DLOFDMA parameter
 - 2.15
DLOFDMA boolean R Indicates support for Downlink (DL) Orthogonal Frequency Division Multiplexing (OFDMA). - 2.17
MaxDLMUMIMO unsignedInt(:255) R Max number of users supported per DL MU-MIMO Transmitter (TX) in anthe APBSS role. - 2.15
MaxULMUMIMO unsignedInt(:255) R Max number of users supported per UL MU-MIMO Receiver (RX) in anthe APBSS role. - 2.15
MaxDLOFDMA unsignedInt(:255) R Max number of users supported per Downlink (DL) OFDMA TX in anthe APBSS role. - 2.15
MaxULOFDMA unsignedInt(:255) R Max number of users supported per UL OFDMA RX in anthe APBSS role. - 2.15
Device.WiFi.DataElements.DisassociationEvent. object R This object contains the events generated when an Associated Device (STA) disassociates from a BSS. - 2.13
DisassociationEventDataNumberOfEntries unsignedInt R
The number of entries in the DisassociationEventData table.
This parameter was DEPRECATED in 2.17 because a corresponding USP event is defined instead.

Changes in 2.17:

  • Added status = deprecated
 - 2.13
Device.WiFi.DataElements.DisassociationEvent.DisassociationEventData.{i}. object(0:) R
The events generated when an Associated Device (STA) disassociates from a BSS.
This object was DEPRECATED in 2.17 because a corresponding USP event is defined instead.

Changes in 2.17:

 - 2.13
BSSID string(:17) R [MACAddress] The MAC Address of the logical BSS ( BSSID)(BSSID) which is reporting the Disassociation Event. - 2.13
LastDataDownlinkRate unsignedInt R The data transmit rate in kbps that was most recently used for transmission of data from the access point to the Associated Device (STA). - 2.17
LastDataUplinkRate unsignedInt R The data transmit rate in kbps that was most recently used for transmission of data from the Associated Device (STA) to the access point. - 2.17
UtilizationReceive unsignedLong R The amount of time in milliseconds that the Radio has spent on the Channel receiving data from the Associated Device (STA). - 2.17
UtilizationTransmit unsignedLong R The amount of time in milliseconds that the Radio has spent on the Channel transmitting data to the Associated Device (STA). - 2.17
EstMACDataRateDownlink unsignedInt R Estimate of the MAC layer throughput in Mbps achievable in the downlink direction to the Associated Device (STA) if 100% of channel airtime and BSS operating bandwidth were available, as defined in [Section 10.3.1/EasyMesh]. - 2.17
EstMACDataRateUplink unsignedInt R Estimate of the MAC layer throughput in Mbps achievable in the uplink direction from the Associated Device (STA) if 100% of channel airtime and BSS operating bandwidth were available, as defined in [Section 10.3.1/EasyMesh]. - 2.17
SignalStrength unsignedInt(:255) R An indicator of radio signal strength of the uplink from the Associated Device (STA) to the access point - measured in dBm. RCPI is encoded per [Table 9-176/802.11-2020], and described in [Section 10.3.1/EasyMesh]). Reserved: 221 - 255. - 2.17
LastConnectTime unsignedInt R The time in seconds since this Assocated Device (STA) was associated. - 2.17
Noise unsignedInt(:255) R

An indicator of the average radio noise plus interference power at the access point measured for the primary operating channel to this Associated Device (STA).

Encoded as defined for ANPI in [Section 11.10.9.4/802.11-2020].

 - 2.17
InitiatedBy string R

This parameter indicates the entity that initiated this Disassociation Event. Enumeration of:

  • STA
  • EasyMesh_Agent
  • EasyMesh_Controller
  • DE_Collector
  • Unknown
 - 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
FailedConnectionEventDataNumberOfEntries unsignedInt R
The number of entries in the FailedConnectionEventData table.
This parameter was DEPRECATED in 2.17 because a corresponding USP event is defined instead.

Changes in 2.17:

  • Added status = deprecated
 - 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.

Changes in 2.17:

  • Added status = deprecated
  • Added BSSID parameter
 - 2.15
BSSID string(:17) R [MACAddress] The MAC Address of the logical BSS (BSSID) which is reporting the failed connection event. - 2.17
MACAddress string(:17) R [MACAddress] STA MAC Address identifying the clientassociated device (STA) that has attempted to connect. - 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
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
SupportedStandards string[] R

Comma-separated list of strings. List items indicate which IEEE 802.11 standards this Radio instance can support simultaneously, in the frequency band specified by OperatingFrequencyBand. Each list item is an enumeration of:

Each value indicates support for the indicated standard.

If OperatingFrequencyBand is set to 2.4GHz, only values b, g, n, ax, be are allowed.

If OperatingFrequencyBand is set to 5GHz, only values a, n, ac, ax, be are allowed.

If OperatingFrequencyBand is set to 6GHz, only valuevalues ax is, be are allowed.

Changes in 2.17:

  • Added string be enumeration
 - 2.0
OperatingStandards string[] W

Each list item MUST be a member of the list reported by the SupportedStandards parameter. Comma-separated list of strings. List items indicate which IEEE 802.11 standard this Radio instance is configured for.

Each value indicates support for the indicated standard.

If OperatingFrequencyBand is set to 2.4GHz, only values b, g, n, ax, be are allowed.

If OperatingFrequencyBand is set to 5GHz, only values a, n, ac, ax, be are allowed.

If OperatingFrequencyBand is set to 6GHz, only valuevalues ax is, be are 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 can be used.

 - 2.0
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)ax, be) and the regulatory domain.

Ranges in the form “n-m” are permitted.

For example, for 802.11b and North America, would be “1-11”.

 - 2.0
SupportedOperatingChannelBandwidths string[] R

Comma-separated list of strings. These are the valid writable values for OperatingChannelBandwidth.

Each list item is an enumeration of: Each list item is an enumeration of:

  • 20MHz
  • 40MHz (wide mode)
  • 80MHz (802.11ac, 802.11ax and 802.11be only)
  • 160MHz (802.11ac, 802.11ax and 802.11be only)
  • 80+80MHz (802.11ac, 802.11ax and 802.11be only)
  • 320MHz-1 (802.11be only - channel center frequency 31, 95, 159, added in 2.17)
  • 320MHz-2 (802.11be only - channel center frequency 63, 127, 191, added in 2.17)
  • Auto

Changes in 2.17:

  • Added string 320MHz-1 enumeration
  • Added string 320MHz-2 enumeration
 - 2.12
OperatingChannelBandwidth string W The value MUST be a member of the list reported by the SupportedOperatingChannelBandwidths parameter. The preferred channel bandwidth to be used (applicable to 802.11n, 802.11ac, 802.11ax and 802.11ax802.11be specifications only). - 2.0
CurrentOperatingChannelBandwidth string R

The channel bandwidth currently in use. Enumeration of:

  • 20MHz
  • 40MHz
  • 80MHz
  • 160MHz
  • 80+80MHz
  • 320MHz-1 (Added in 2.17)
  • 320MHz-2 (Added in 2.17)

Changes in 2.17:

  • Added string 320MHz-1 enumeration
  • Added string 320MHz-2 enumeration
 - 2.11
GuardInterval string W

The guard interval value between OFDM symbols.

Enumeration of:

  • 400nsec (applicable to 802.11n, 802.11ac and 802.11be specifications only)
  • 800nsec (applicable to 802.11n, 802.11ac and 802.11be specifications only)
  • 1xLTF_0.8us (applicable to 802.11ax and 802.11be specifications only, added in 2.14)
  • 1xLTF_1.6us (applicable to 802.11ax and 802.11be specifications only, added in 2.14)
  • 2xLTF_0.8us (applicable to 802.11ax and 802.11be specifications only, added in 2.14)
  • 2xLTF_1.6us (applicable to 802.11ax and 802.11be specifications only, added in 2.14)
  • 4xLTF_0.8us (applicable to 802.11ax and 802.11be specifications only, added in 2.14)
  • 4xLTF_3.2us (applicable to 802.11ax and 802.11be specifications only, added in 2.14)
  • Auto
 - 2.0
CenterFrequencySegement0 unsignedInt W
When operating in 80+80MHz, this parameter determines the Center Frequency Segment 0 for the first 80 MHz channel. See [Section 9.4.2.161/802.11-2016] and Table 9-252.
This parameter was DEPRECATED in 2.14 due to a typo. Use CenterFrequencySegment0 instead.
This parameter was OBSOLETED in 2.16.
This parameter was DELETED in 2.17.

Changes in 2.17:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
CenterFrequencySegement1 unsignedInt W
When operating in 80+80MHz, this parameter determines the Center Frequency Segment 1 for the second 80 MHz channel. See [Section 9.4.2.161/802.11-2016] and Table 9-252.
This parameter was DEPRECATED in 2.14 due to a typo. Use CenterFrequencySegment1 instead.
This parameter was OBSOLETED in 2.16.
This parameter was DELETED in 2.17.

Changes in 2.17:

  • Changed status = obsoleted ⇒ deleted
 - 2.13
MCS int(-1:15,16:31) W The Modulation Coding Scheme index (applicable to 802.11n, 802.11ac, 802.11ax and 802.11ax802.11be specifications only). Values from 0 to 15 MUST be supported for ([802.11n-2009]). Values from 0 to 9 MUST be supported for [802.11ac-2013]. Values from 0 to 11 MUST be supported for [802.11ax]. Values from 0 to 15 MUST be supported for [802.11be]. A value of -1 indicates automatic selection of the MCS index. - 2.0
Device.WiFi.NeighboringWiFiDiagnostic. object R This object defines access to other WiFi SSIDs that this device is able to receive. - 2.7
DiagnosticsState string W

[DiagnosticsState] Indicates the availability of diagnostics data. Enumeration of:

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Error (READONLY, OPTIONAL)
  • Completed (

This enumeration was DEPRECATED in 2.13 because it’s a typo for Complete.

This enumeration was OBSOLETED in 2.16.

This enumeration was DELETED in 2.17.

Changes in 2.17:

  • Changed status = obsoleted ⇒ deleted

, READONLY)

If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested.

When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test.

When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above.

If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate.

When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message.

After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None.

Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None.

While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None.

While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters.

While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with “Invalid Parameter value” (9007) to the ACS instead.

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Error (READONLY, OPTIONAL)
  • Completed (

This enumeration was DEPRECATED in 2.13 because it’s a typo for Complete.

This enumeration was OBSOLETED in 2.16.

This enumeration was DELETED in 2.17.

Changes in 2.17:

  • Changed status = obsoleted ⇒ deleted

, READONLY)

 - 2.7
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}. object(0:) R

Neighboring SSID table. This table models other WiFi SSIDs that this device is able to receive.

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

 - 2.7
SupportedStandards string[] R

Comma-separated list of strings. List items indicate which IEEE 802.11 standards this Result instance can support simultaneously, in the frequency band specified by OperatingFrequencyBand. Each list item is an enumeration of:

Each value indicates support for the indicated standard.

If OperatingFrequencyBand is set to 2.4GHz, only values b, g, n, ax, be are allowed.

If OperatingFrequencyBand is set to 5GHz, only values a, n, ac, ax, be are allowed.

If OperatingFrequencyBand is set to 6GHz, only valuevalues ax is, be are allowed.

Changes in 2.17:

  • Added string be enumeration
 - 2.7
OperatingStandards string[] R

Each list item MUST be a member of the list reported by the SupportedStandards parameter. Comma-separated list of strings. List items indicate which IEEE 802.11 standard that is detected for this Result.

Each value indicates support for the indicated standard.

If OperatingFrequencyBand is set to 2.4GHz, only values b, g, n, ax, be are allowed.

If OperatingFrequencyBand is set to 5GHz, only values a, n, ac, ax, be are allowed.

If OperatingFrequencyBand is set to 6GHz, only value ax is, be are 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 can be used.

 - 2.7
OperatingChannelBandwidth string R

Indicates the bandwidth at which the channel is operating.

Enumeration of:

  • 20MHz
  • 40MHz
  • 80MHz
  • 160MHz
  • 320MHz-1 (Added in 2.17)
  • 320MHz-2 (Added in 2.17)
  • Auto

Changes in 2.17:

  • Added string 320MHz-1 enumeration
  • Added string 320MHz-2 enumeration
 - 2.7
Device.WiFi.SSID.{i}. object(0:) W

WiFi SSID table (a stackable interface object as described in [Section 4.2/TR-181i2]), where table entries model the MAC layer. A WiFi SSID entry is typically stacked on top of a Radio object.

WiFi SSID is also a multiplexing layer, i.e. more than one SSID can be stacked above a single Radio.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for BSSID.

Changes in 2.17:

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
MLDUnit int(-1:24,0:24) W MLD-BSS unit number specifying BSS across multiple radios that form a single Multi Link Device. Assigning the same MLD unit groups Basic Service Sets (BSS) across radios. A (default) value of -1 indicates that the interface is not part of any MLD. -1 2.17
Device.WiFi.AccessPoint.{i}. object(0:) W

This object models an 802.11 connection from the perspective of a wireless access point. Each AccessPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter.

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

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

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for SSIDReference.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}. object(0:) R

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

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

Changes in 2.17:

 - 2.0
OperatingStandard string R

The operating standard that this associated device is connected with.

Enumeration of:

Changes in 2.17:

  • Added string be enumeration
 - 2.10
MaxSupportedDataDownlinkRate unsignedInt(1000:) R Maximum supported data rate on the downlink from the associated device to the access point, measured in kbps. - 2.17
MaxSupportedDataUplinkRate unsignedInt(1000:) R Maximum supported data rate on the uplink from the associated device to the access point, measured in kbps. - 2.17
SNR unsignedInt R An indicator of signal to noise ratio, in dB, on the uplink from the associated device to the access point, measured in dB, as an average of the last 100 packets received from the device. - 2.17
MaxSupportedBandwidth string R

Specifies the maximum supported bandwidth for the associated device to the access point.

Enumeration of:

  • 20MHz
  • 40MHz
  • 80MHz
  • 160MHz
  • 320MHz
  • Unknown
 - 2.17
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.

 - 2.8
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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.

Changes in 2.17:

  • Changed status = deprecated ⇒ obsoleted
 - 2.8
ECWMin unsignedInt(0:15) W
Exponent of Contention Window (Minimum). This encodes the values of CWMin as an exponent: CWMin = 2ECWMin - 1. For example, if ECWMin is 8, then CWMin is 28 - 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.

Changes in 2.17:

  • Changed status = deprecated ⇒ obsoleted
 - 2.8
ECWMax unsignedInt(0:15) W
Exponent of Contention Window (Maximum). This encodes the values of CWMax as an exponent: CWMax = 2ECWMax - 1. For example, if ECWMax is 8, then CWMax is 28 - 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.

Changes in 2.17:

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

Changes in 2.17:

  • Changed status = deprecated ⇒ obsoleted
 - 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for SSIDReference.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.WiFi.EndPoint.{i}.Profile.{i}. object(0:) W

EndPoint Profile table.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of SSID, Location and Priority.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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.

 - 2.8
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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.

Changes in 2.17:

  • Changed status = deprecated ⇒ obsoleted
 - 2.8
ECWMin unsignedInt(0:15) W
Exponent of Contention Window (Minimum). This encodes the values of CWMin as an exponent: CWMin = 2ECWMin - 1. For example, if ECWMin is 8, then CWMin is 28 - 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.

Changes in 2.17:

  • Changed status = deprecated ⇒ obsoleted
 - 2.8
ECWMax unsignedInt(0:15) W
Exponent of Contention Window (Maximum). This encodes the values of CWMax as an exponent: CWMax = 2ECWMax - 1. For example, if ECWMax is 8, then CWMax is 28 - 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.

Changes in 2.17:

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

Changes in 2.17:

  • Changed status = deprecated ⇒ obsoleted
 - 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
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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.

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 implemenation is undefined

 - 2.7
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.7
Device.ZigBee.ZDO.{i}.Binding.{i}. object(0:) W

The Binding object describes the configuration capabilities related to maintaining a ZigBee Device’s Binding Table as defined in [Section 2.2.8.2 Binding/ZigBee2007].

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.7
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.7
Device.ZigBee.ZDO.{i}.Group.{i}. object(0:) W

The Group object describes the configuration capabilities related to maintaining a ZigBee Device’s Group Table as defined in [Section 2.5.2.7 Group Manager/ZigBee2007].

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for GroupId.

 - 2.7
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.7
Device.ZigBee.ZDO.{i}.ApplicationEndpoint.{i}. object(0:) W

The ApplicationEndpoint object describes the application endpoint as defined in [Section 2.1.2 Application Framework/ZigBee2007].

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for EndpointId.

 - 2.7
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.7
Device.ZigBee.Discovery. object R This object is used for managing the discovery of ZigBee devices within a ZigBee Area Network. ZigBee Devices are discovered via the ZDO instance associated with the ZigBee Coordinator of an Area Network. - 2.7
Device.ZigBee.Discovery.AreaNetwork.{i}. object(0:) W

This object specifies the ZigBee devices that are discovered by the Coordinator.

As the ZigBee specification does not provide a discovery protocol between the CWMP proxy and the ZigBee coordinator, the AreaNetwork object is provisioned and not discovered.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Coordinator.

 - 2.7
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.7
Device.Bridging. object R

Layer 2 bridging configuration. Specifies bridges between different layer 2 interfaces. Bridges can be defined to include layer 2 filter criteria to selectively bridge traffic between interfaces.

This object can be used to configure both 802.1D [802.1D-2004] and 802.1Q [802.1Q-2011] bridges.

Not all 802.1D and 802.1Q features are modeled, and some additional features not present in either 802.1D or 802.1Q are modeled.

802.1Q [802.1Q-2011] bridges incorporate 802.1Q [802.1Q-2005] customer and 802.1ad [802.1ad-2005] provider bridges.

 - 2.0
Device.Bridging.Bridge.{i}. object(0:) W

Bridge table.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.Bridging.Bridge.{i}.Port.{i}. object(0:) W

Bridge Port table, which MUST contain an entry for each bridge port (a stackable interface object as described in [Section 4.2/TR-181i2]).

There are two types of bridge ports: management (upward facing) and non-management (downward facing). This is determined by configuring the Boolean ManagementPort parameter. The CPE will automatically configure each management bridge port to appear in the interface stack above all non-management bridge ports that share the same Bridge instance.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.Bridging.Bridge.{i}.VLAN.{i}. object(0:) W

Bridge VLAN table. If this table is supported, if MUST contain an entry for each VLAN known to the Bridge.

This table only applies to an 802.1Q [802.1Q-2011] Bridge.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for VLANID.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.Bridging.Bridge.{i}.VLANPort.{i}. object(0:) W

Bridge VLAN egress port and untagged port membership table.

This table only applies to an 802.1Q [802.1Q-2011] Bridge.

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

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both VLAN and Port.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.Bridging.Filter.{i}. object(0:) W

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

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

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

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

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Order unsignedInt(1:) W

Position of the Filter entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence).

[Order] Position of the Filter entry in the order of precedence. A value of 1 indicates the first entry to be considered (highest precedence).

When a Filter instance is created, or when an existing Order value is modified, if the value matches that of an existing entry, the Order values for the existing entry and all lower Order entries are incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction.

If no Order value is supplied on creation of a Filter instance, it MUST be assigned a value that is one more than the largest current value (lowest precedence).

For each ingress frame on the Interface, the highest ordered entry that matches the filter criteria is applied. All lower order entries are ignored.

When this value is modified, if the value matches that of an existing entry, the {{param}} value for the existing entry and all lower {{param}} entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes {{param}} values to be compacted. When a value is changed, incrementing occurs before compaction.

The value of {{param}} on creation of a {{object}} table entry MUST be one greater than the largest current value (initially assigned the lowest precedence).

Changes in 2.17:

  • Removed unsignedInt(1:) syntax
  • Added Order
 - 2.0
Device.Bridging.ProviderBridge.{i}. object(0:) W

Provider Bridge table.

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

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

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

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.7
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.7
Device.PPP. object R Point-to-Point Protocol [RFC1661]. This object contains the Interface table. - 2.0
Device.PPP.Interface.{i}. object(0:) W

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

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.IP. object R IP object that contains the Interface, ActivePort, and Diagnostics objects. - 2.0
Device.IP.Interface.{i}. object(0:) W

IP interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the layer 3 IP interface.

Each IP interface can be attached to the IPv4 and/or IPv6 stack. The interface’s IP addresses and prefixes are listed in the IPv4Address, IPv6Address and IPv6Prefix tables.

Note that support for manipulating Loopback interfaces is OPTIONAL, so the implementation MAY choose not to create (or allow the Controller to create) Interface instances of type Loopback.

When the Controller administratively disables the interface, i.e. sets Enable to false, the interface’s automatically-assigned IP addresses and prefixes MAY be retained. When the Controller administratively enables the interface, i.e. sets Enable to true, these IP addresses and prefixes MUST be refreshed. It’s up to the implementation to decide exactly what this means: it SHOULD take all reasonable steps to refresh everything but if it is unable, for example, to refresh a prefix that still has a significant lifetime, it might well choose to retain rather than discard it.

Any Tunneled IP interface instances instantiated by the CPE MUST NOT have any statistics, writable parameters, IP addresses or IPv6 prefixes. Any read-only parameters, e.g. Status, MUST return the same information as for the corresponding Tunnel interface. The reason for these rules is that Tunneled IP interfaces exist only in order to be the targets of references (within the data model) and do not model any concepts over and above those already modeled by the Tunnel IP interfaces.

Note that Tunnel and Tunneled IP interfaces are part of a legacy mechanism that is only used for IPv6rd, DSLite and IPsec tunnels and MUST NOT be used in any other context. For all other tunneling mechanisms Normal IP interfaces are stacked above technology-specific Tunnel Interfaces, e.g. above GRE.Tunnel.{i}.Interface or MAP.Domain.{i}.Interface objects.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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, or IPCP. Static entries are created and configured by the Controller.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both IPAddress and SubnetMask.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

This parameter can only be modified if AddressingType is Static.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Port.

 - 2.12
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 [RFC3315], 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for IPAddress.

 - 2.2
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

This parameter can only be modified if Origin is Static.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 [RFC3315] prefix delegation [RFC3633]. 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Prefix.

 - 2.2
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

This parameter can only be modified if Origin is Static.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.2
Device.IP.Diagnostics. object R The IP Diagnostics object. - 2.0
Device.IP.Diagnostics.DownloadDiagnostics. object R

This object defines the diagnostics configuration for a HTTP and FTP DownloadDiagnostics Test.

Files received in the DownloadDiagnostics do not require file storage on the CPE device.

 - 2.0
DiagnosticsState string W

[DiagnosticsState] Indicates the availability of diagnostics data. Enumeration of:

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Completed (

This enumeration was DEPRECATED in 2.13 because it’s a typo for Complete.

This enumeration was OBSOLETED in 2.16.

This enumeration was DELETED in 2.17.

Changes in 2.17:

  • Changed status = obsoleted ⇒ deleted

, READONLY)

  • Error_CannotResolveHostName (READONLY)
  • Error_NoRouteToHost (READONLY)
  • Error_InitConnectionFailed (READONLY)
  • Error_NoResponse (READONLY)
  • Error_TransferFailed (READONLY)
  • Error_PasswordRequestFailed (READONLY)
  • Error_LoginFailed (READONLY)
  • Error_NoTransferMode (READONLY)
  • Error_NoPASV (READONLY)
  • Error_IncorrectSize (READONLY)
  • Error_Timeout (READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY)

If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested.

When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test.

When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above.

If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate.

When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message.

After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None.

Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None.

While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None.

While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters.

While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with “Invalid Parameter value” (9007) to the ACS instead.

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Completed (

This enumeration was DEPRECATED in 2.13 because it’s a typo for Complete.

This enumeration was OBSOLETED in 2.16.

This enumeration was DELETED in 2.17.

Changes in 2.17:

  • Changed status = obsoleted ⇒ deleted

, READONLY)

  • Error_CannotResolveHostName (READONLY)
  • Error_NoRouteToHost (READONLY)
  • Error_InitConnectionFailed (READONLY)
  • Error_NoResponse (READONLY)
  • Error_TransferFailed (READONLY)
  • Error_PasswordRequestFailed (READONLY)
  • Error_LoginFailed (READONLY)
  • Error_NoTransferMode (READONLY)
  • Error_NoPASV (READONLY)
  • Error_IncorrectSize (READONLY)
  • Error_Timeout (READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY)
 - 2.0
Device.IP.Diagnostics.UploadDiagnostics. object R

This object defines the diagnostics configuration for a HTTP or FTP UploadDiagnostics test.

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

 - 2.0
DiagnosticsState string W

[DiagnosticsState] Indicates the availability of diagnostics data. Enumeration of:

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Completed (

This enumeration was DEPRECATED in 2.13 because it’s a typo for Complete.

This enumeration was OBSOLETED in 2.16.

This enumeration was DELETED in 2.17.

Changes in 2.17:

  • Changed status = obsoleted ⇒ deleted

, READONLY)

  • Error_CannotResolveHostName (READONLY)
  • Error_NoRouteToHost (READONLY)
  • Error_InitConnectionFailed (READONLY)
  • Error_NoResponse (READONLY)
  • Error_PasswordRequestFailed (READONLY)
  • Error_LoginFailed (READONLY)
  • Error_NoTransferMode (READONLY)
  • Error_NoPASV (READONLY)
  • Error_NoCWD (READONLY)
  • Error_NoSTOR (READONLY)
  • Error_NoTransferComplete (READONLY)
  • Error_Timeout (READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY)

If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested.

When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test.

When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above.

If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate.

When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message.

After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None.

Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None.

While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None.

While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters.

While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with “Invalid Parameter value” (9007) to the ACS instead.

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Completed (

This enumeration was DEPRECATED in 2.13 because it’s a typo for Complete.

This enumeration was OBSOLETED in 2.16.

This enumeration was DELETED in 2.17.

Changes in 2.17:

  • Changed status = obsoleted ⇒ deleted

, READONLY)

  • Error_CannotResolveHostName (READONLY)
  • Error_NoRouteToHost (READONLY)
  • Error_InitConnectionFailed (READONLY)
  • Error_NoResponse (READONLY)
  • Error_PasswordRequestFailed (READONLY)
  • Error_LoginFailed (READONLY)
  • Error_NoTransferMode (READONLY)
  • Error_NoPASV (READONLY)
  • Error_NoCWD (READONLY)
  • Error_NoSTOR (READONLY)
  • Error_NoTransferComplete (READONLY)
  • Error_Timeout (READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY)
 - 2.0
Device.IP.Diagnostics.UDPEchoDiagnostics. object R This object defines the diagnostics configuration for a UDP Echo test [Appendix A.1/TR-143] defined in [RFC862] or a UDP Echo Plus test defined in [Appendix A.1/TR-143]. - 2.9
DiagnosticsState string W

[DiagnosticsState] Indicates the availability of diagnostics data. Enumeration of:

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Completed (

This enumeration was DEPRECATED in 2.13 because it’s a typo for Complete.

This enumeration was OBSOLETED in 2.16.

This enumeration was DELETED in 2.17.

Changes in 2.17:

  • Changed status = obsoleted ⇒ deleted

, READONLY)

  • Error_CannotResolveHostName (READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY)

If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested.

When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test.

When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above.

If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate.

When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message.

After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None.

Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None.

While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None.

While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters.

While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with “Invalid Parameter value” (9007) to the ACS instead.

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Completed (

This enumeration was DEPRECATED in 2.13 because it’s a typo for Complete.

This enumeration was OBSOLETED in 2.16.

This enumeration was DELETED in 2.17.

Changes in 2.17:

  • Changed status = obsoleted ⇒ deleted

, READONLY)

  • Error_CannotResolveHostName (READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY)

Active Notification requests for this parameter MAY be denied.

 - 2.9
Device.IP.Diagnostics.IPLayerCapacityMetrics. object R

This object defines the diagnostics configuration for a IP Layer Capacity test. IP Layer Capacity measurement is specified in [TR-471].

Files received in the IP Layer Capacity test do not require file storage on the CPE device.

Changes in 2.17:

 - 2.14
Host string(:256) W
The Fully Qualified Domain Name (FQDN) or IP address of the Test Endpoint to perform the UDP Capacity tests with.
This parameter was DEPRECATED in 2.17 because it is superseded by ServerList with multi-flow and server capability. Refer to [TR-471] for details.

Changes in 2.17:

  • Added status = deprecated
 - 2.14
ServerList string(:256,)[:100] W Comma-separated list (up to 100 items) of strings (length up to 256, or ). A list of servers intended as testing partners for the client. The client works through the server list attempting individual test flows in a round-robin sequence. One flow is attempted to each server and all flows are required for testing, unless the optional FlowCount and MaximumFlows parameters are specified. The list contains each server’s Fully Qualified Domain Name or IP address and listening port in the format server:port. - 2.17
Port unsignedInt(1:65535) W
Port on the Test Endpoint host.
This parameter was DEPRECATED in 2.17 because it is superseded by ServerList with multi-flow and server capability. Refer to [TR-471] for details.
Active Notification requests for this parameter MAY be denied.

Changes in 2.17:

  • Added status = deprecated
 - 2.14
NumberOfConnections unsignedInt(1:) W
The number of connections to be used in the test. The default value SHOULD be 1. NumberOfConnections MUST NOT be set to a value greater than IPLayerMaxConnections.
This parameter was DEPRECATED in 2.17 because it is superseded by ServerList with multi-flow and server capability and related parameters. Refer to [TR-471] for details.

Changes in 2.17:

  • Added status = deprecated
 - 2.14
FlowCount unsignedInt W Optional Number of flows required for a test. The default SHOULD be 0 (a magic number that indicates the parameter is not used). FlowCount MUST NOT be set to a value greater than IPLayerMaxConnections. - 2.17
MaximumFlows unsignedInt W

Optional number of flows to attempt. MaximumFlows must be greater than the size of ServerList or FlowCount.

The default SHOULD be 0 (a magic number that indicates the parameter is not used). MaximumFlows MUST NOT be set to a value greater than IPLayerMaxConnections.

 - 2.17
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.

Changes in 2.17:

  • Changed status = deprecated ⇒ obsoleted
 - 2.14
ActiveFlows unsignedInt(0:) R Number of flows set-up and used for a test. - 2.17
Device.IP.Diagnostics.UDPEchoDiagnostics.IndividualPacketResult.{i}. object(0:) R This object provides the results from individual UDPEchoPlus test packets collected during a test if EnableIndividualPacketResults is set to true. When DiagnosticsState is set to {{enum: non-existent Complete}} it should contain NumberOfRepetitions objects. Instance numbers MUST start at 1 and sequentially increment as new instances are created. The instance number should match the TestIterationNumber field of the request and response packet. All instances are removed when DiagnosticsState is set to Requested or None. - 2.9
Device.IP.Diagnostics.ServerSelectionDiagnostics. object R This object provides access to a diagnostics test that performs either an ICMP Ping or UDP Echo ping against multiple hosts determining which one has the smallest average response time. There MUST be a ping response to the transmitted ping, or timeout, before the next ping is sent out. - 2.9
DiagnosticsState string W

[DiagnosticsState] Indicates the availability of diagnostics data. Enumeration of:

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Completed (

This enumeration was DEPRECATED in 2.13 because it’s a typo for Complete.

This enumeration was OBSOLETED in 2.16.

This enumeration was DELETED in 2.17.

Changes in 2.17:

  • Changed status = obsoleted ⇒ deleted

, READONLY)

  • Error_CannotResolveHostName (READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY)

If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested.

When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test.

When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above.

If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate.

When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message.

After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None.

Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None.

While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None.

While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters.

While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with “Invalid Parameter value” (9007) to the ACS instead.

Enumeration of:

  • None (READONLY)
  • Requested
  • Canceled (OPTIONAL)
  • Complete (READONLY)
  • Completed (

This enumeration was DEPRECATED in 2.13 because it’s a typo for Complete.

This enumeration was OBSOLETED in 2.16.

This enumeration was DELETED in 2.17.

Changes in 2.17:

  • Changed status = obsoleted ⇒ deleted

, READONLY)

  • Error_CannotResolveHostName (READONLY)
  • Error_Internal (READONLY)
  • Error_Other (READONLY)

Active Notification requests for this parameter MAY be denied.

 - 2.9
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.Filter.{i}. object(0:) W

Filter table that represents the IPsec Security Policy Database (SPD) [Section 4.4.1/RFC4301] selection criteria. Each (ordered) entry defines a set of selection criteria and references a Profile table entry that specifies how matching packets will be processed.

SPD filtering is performed for all packets that might need to cross the IPsec boundary [Section 3.1/RFC4301]. Given that IPsec operates at the IP level, this means that SPD filtering conceptually occurs after bridging and before routing.

For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.5
Order unsignedInt(1:) W

Position of the Filter entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence).

[Order] Position of the Filter entry in the order of precedence. A value of 1 indicates the first entry to be considered (highest precedence).

When a Filter instance is created, or when an existing Order value is modified, if the value matches that of an existing entry, the Order values for the existing entry and all lower Order entries are incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction.

If no Order value is supplied on creation of a Filter instance, it MUST be assigned a value that is one more than the largest current value (lowest precedence).

For each packet, the highest ordered entry that matches the filter criteria is applied. All lower order entries are ignored.

When this value is modified, if the value matches that of an existing entry, the {{param}} value for the existing entry and all lower {{param}} entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes {{param}} values to be compacted. When a value is changed, incrementing occurs before compaction.

The value of {{param}} on creation of a {{object}} table entry MUST be one greater than the largest current value (initially assigned the lowest precedence).

Changes in 2.17:

  • Removed unsignedInt(1:) syntax
  • Added Order
 - 2.5
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.5
Device.IPsec.Profile.{i}. object(0:) W

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

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

 - 2.5
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.5
Device.IPsec.Profile.{i}.SentCPAttr.{i}. object(0:) W

Each instance of this object represents an IKEv2 Configuration Payload (CP) [Section 3.15/RFC5996] Attribute that MUST, if enabled, be sent in IKEv2 CP CFG_REQUEST messages. All such Attributes MUST be listed.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Type.

 - 2.5
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.5
Device.IPsec.Tunnel.{i}. object(0:) R

Represents an IPsec tunnel, i.e. a virtual IP interface that models an IPsec tunnel entry point and exit point. A Tunnel instance always references (and has the same lifetime as) a (Tunnel,Tunneled) IP.Interface pair. The Tunnel instance models the IPsec-specific concepts, the Tunnel IP.Interface instance models the generic concepts, and the Tunneled IP.Interface instance exists only so it can be referenced by forwarding or filter rules.

Tunnel instances are automatically created (as needed) when Filter instances are enabled and disabled.

Each instance’s Filters parameter references the Filter instances that require the Tunnel instance to exist. If this list ever becomes an empty string, e.g. because all the referenced Filter instances have been disabled or deleted, the CPE MAY choose not to delete the Tunnel instance (and its associated (Tunnel,Tunneled) IP.Interface pair). This can be desirable, because QoS.Classification, Routing.Router.{i}.IPv4Forwarding, Routing.Router.{i}.IPv6Forwarding etc instances might be referencing the IP.Interface instances.

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

 - 2.5
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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.

 - 2.5
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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.

 - 2.5
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.5
Device.GRE. object R This object contains parameters associated with the Generic Routing Encapsulation (GRE) Tunnel ([RFC2784]) with Key and Sequence Number extensions ([RFC2890]). This object also provides a means to treat packets that are encapsulated within a GRE Tunnel by using a set of Filter objects to determine the treatment of the packet. - 2.8
Device.GRE.Tunnel.{i}. object(0:) W

GRE Tunnel table, models the GRE Tunnel instance and represents the entry point and exit point of the tunnel in relation to the WAN interface. A Tunnel object has one or more Interface objects that further define the sessions or flows within the tunnel.

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

 - 2.8
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.8
Device.GRE.Tunnel.{i}.Interface.{i}. object(0:) W

GRE Interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). The Interface object models the GRE Header as defined in [RFC2784] and extensions to the GRE Header as defined in [RFC2890]. The Interface object provides a way to discriminate how sessions or flows are encapsulated within the GRE Tunnel. In addition the Interface object represents the entry point and exit point of the tunnel in relation to the LAN interface. Unless the Key Identifier of [RFC2890] is supported there is only one instance of this Interface object per tunnel.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.8
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.8
Device.GRE.Filter.{i}. object(0:) W

GRE Filter table. Entries in this table are applied against the packets that are to be encapsulated within the GRE Tunnel based on the following conditions:

For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.8
Order unsignedInt(1:) W

Position of the Filter entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence).

[Order] Position of the Filter entry in the order of precedence. A value of 1 indicates the first entry to be considered (highest precedence).

When a Filter instance is created, or when an existing Order value is modified, if the value matches that of an existing entry, the Order values for the existing entry and all lower Order entries are incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction.

If no Order value is supplied on creation of a Filter instance, it MUST be assigned a value that is one more than the largest current value (lowest precedence).

For each packet, the highest ordered entry that matches the filter criteria is applied. All lower order entries are ignored.

When this value is modified, if the value matches that of an existing entry, the {{param}} value for the existing entry and all lower {{param}} entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes {{param}} values to be compacted. When a value is changed, incrementing occurs before compaction.

The value of {{param}} on creation of a {{object}} table entry MUST be one greater than the largest current value (initially assigned the lowest precedence).

Changes in 2.17:

  • Removed unsignedInt(1:) syntax
  • Added Order
 - 2.8
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.8
Device.L2TPv3. object R

This object contains parameters associated with the configuration and monitoring of stateless tunnels using the Layer Two Tunneling Protocol version 3 (L2TPv3) ([RFC3931]).

This object also provides a means to treat packets that are encapsulated within a L2TPv3 Tunnel by using a set of Filter objects to determine the treatment of the packet.

 - 2.12
Device.L2TPv3.Tunnel.{i}. object(0:) W

L2TPv3 Tunnel table, models the L2TPv3 Tunnel instance and represents the entry point and exit point of the tunnel in relation to the WAN interface.

A Tunnel object has one or more Interface objects that further define the sessions or flows within the tunnel.

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

 - 2.12
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.12
Device.L2TPv3.Tunnel.{i}.Interface.{i}. object(0:) W

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

The Interface object models the L2TPv3 Header as defined in [RFC3931] and the transport of L2 frames across over L2TPv3 as defined in [RFC4719].

The Interface object provides a way to discriminate how sessions or flows are encapsulated within the L2TPv3 Tunnel.

In addition the Interface object represents the entry point and exit point of the tunnel in relation to the LAN interface.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.12
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.12
Device.L2TPv3.Filter.{i}. object(0:) W

L2TPv3 Filter table. Entries in this table are applied against the packets that are to be encapsulated within the L2TPv3 Tunnel based on the following conditions:

For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.12
Order unsignedInt(1:) W

Position of the Filter entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence).

[Order] Position of the Filter entry in the order of precedence. A value of 1 indicates the first entry to be considered (highest precedence).

When a Filter instance is created, or when an existing Order value is modified, if the value matches that of an existing entry, the Order values for the existing entry and all lower Order entries are incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction.

If no Order value is supplied on creation of a Filter instance, it MUST be assigned a value that is one more than the largest current value (lowest precedence).

For each packet, the highest ordered entry that matches the filter criteria is applied. All lower order entries are ignored.

When this value is modified, if the value matches that of an existing entry, the {{param}} value for the existing entry and all lower {{param}} entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes {{param}} values to be compacted. When a value is changed, incrementing occurs before compaction.

The value of {{param}} on creation of a {{object}} table entry MUST be one greater than the largest current value (initially assigned the lowest precedence).

Changes in 2.17:

  • Removed unsignedInt(1:) syntax
  • Added Order
 - 2.12
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.12
Device.VXLAN. object R

This object contains parameters associated with the configuration and monitoring of stateless tunnels using the Virtual eXtensible Local Area Network (VXLAN) ([RFC7348]).

This object also provides a means to treat packets that are encapsulated within a VXLAN Tunnel by using a set of Filter objects to determine the treatment of the packet.

 - 2.12
Device.VXLAN.Tunnel.{i}. object(0:) W

VXLAN Tunnel table, models the VXLAN Tunnel instance and represents the entry point and exit point of the tunnel in relation to the WAN interface.

A Tunnel object has one or more Interface objects that further define the sessions or flows within the tunnel.

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

 - 2.12
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.12
Device.VXLAN.Tunnel.{i}.Interface.{i}. object(0:) W

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

The Interface object models the VXLAN Header as defined in [RFC7348] for the transport of L2 frames across over VXLAN.

The Interface object provides a way to discriminate how multiple LAN segments are encapsulated within the VXLAN Tunnel.

In addition the Interface object represents the entry point and exit point of the tunnel in relation to the LAN interface.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.12
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.12
Device.VXLAN.Filter.{i}. object(0:) W

VXLAN Filter table. Entries in this table are applied against the packets that are to be encapsulated within the VXLAN Tunnel based on the following conditions:

For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.12
Order unsignedInt(1:) W

Position of the Filter entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence).

[Order] Position of the Filter entry in the order of precedence. A value of 1 indicates the first entry to be considered (highest precedence).

When a Filter instance is created, or when an existing Order value is modified, if the value matches that of an existing entry, the Order values for the existing entry and all lower Order entries are incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction.

If no Order value is supplied on creation of a Filter instance, it MUST be assigned a value that is one more than the largest current value (lowest precedence).

For each packet, the highest ordered entry that matches the filter criteria is applied. All lower order entries are ignored.

When this value is modified, if the value matches that of an existing entry, the {{param}} value for the existing entry and all lower {{param}} entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes {{param}} values to be compacted. When a value is changed, incrementing occurs before compaction.

The value of {{param}} on creation of a {{object}} table entry MUST be one greater than the largest current value (initially assigned the lowest precedence).

Changes in 2.17:

  • Removed unsignedInt(1:) syntax
  • Added Order
 - 2.12
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.12
Device.MAP. object R

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

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

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

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

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

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

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

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both WANInterface and IPv6Prefix.

 - 2.8
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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.
 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.
 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.
 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] 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.

Changes in 2.17:

  • Changed status = deprecated ⇒ obsoleted
 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for IPv6Prefix, or with a given value for IPv4Prefix.

 - 2.8
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.8
Device.MAP.Domain.{i}.Interface. object R MAP interface (a stackable interface object as described in [Section 4.2/TR-181i2]). This models the LAN side MAP domain interface. - 2.8
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.8
Device.Routing. object R Routing object that contains the Router tabletable, the received router advertisement information RouteInformation, Babel, and RIP protocol object.objects. - 2.0
Device.Routing.Router.{i}. object(0:) W

This object allows the handling of the routing and forwarding configuration of the device.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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, 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of DestIPAddress, DestSubnetMask, ForwardingPolicy, GatewayIPAddress, Interface and ForwardingMetric.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.Routing.Router.{i}.IPv6Forwarding.{i}. object(0:) W

Layer 3 IPv6 forwarding table.

In addition to statically configured routes, this table MUST include dynamic routes learned through layer 3 routing protocols, including RIPng, OSPF, DHCPv6, 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of DestIPPrefix, ForwardingPolicy, NextHop, Interface and ForwardingMetric.

 - 2.2
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.2
Device.Routing.RIP. object R Routing Information Protocol (RIP) object. - 2.0
Device.Routing.RIP.InterfaceSetting.{i}. object(0:) W

IP Interface RIP configuration table.

For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the 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.

Note: This object only applies to RIP2; i.e. version 2 of the RIP protocol is used to accept or send over the specified Interface.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.Routing.RouteInformation. object R Received Router Advertisement (RA) route information [RFC4191]. - 2.2
Device.Routing.RouteInformation.InterfaceSetting.{i}. object(0:) R

IP Interface RA route information table. Contains received RA route information [RFC4191]. As such, the data in this table cannot be modified.

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

 - 2.2
Device.Routing.RouteInformation.InterfaceSetting.{i}.Option.{i}. object(0:) R

This object specifies the received options in a Router Advertisement (RA) message [Section 4.6/RFC4861]. This includes support for receiving DNS information in the RA message as described in [RFC6106].

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

 - 2.16
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.16
Device.Routing.Babel. object R This object provides parameters for configuration, troubleshooting, and monitoring of the Babel routing protocol [RFC8966]. This data model is based on the Babel information model defined in [RFC9046]. - 2.15
Device.Routing.Babel.InterfaceSetting.{i}. object(0:) W

This object provides parameters related to the interfaces the Babel protocol is operating over and can act as a routing protocol for.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.15
Device.Routing.Babel.MACKeySet.{i}. object(0:) W

This object provides parameters related to use of the HMAC security mechanism [RFC8967] to sign and verify Babel packets.

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

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.15
Device.Routing.Babel.MACKeySet.{i}.MACKey.{i}. object(0:) W

This object provides the MAC keys used to calculate MACs for verification and sending by the MACKeySet instance.

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

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.15
Device.Routing.Babel.DTLSCertSet.{i}. object(0:) W

This object provides parameters related to use of the DTLS security mechanism [RFC8968] to encrypt Babel packets.

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

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.15
Device.Routing.Babel.DTLSCertSet.{i}.DTLSCert.{i}. object(0:) W

This object provides the certificates used for verification and signing by the DTLSCertSet instance with DTLS.

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

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.15
Device.NeighborDiscovery. object R The Neighbor Discovery Protocol (NDP) object [RFC4861]. This object applies only to IPv6. It contains an InterfaceSetting table that defines the NDP configuration for individual IP interfaces. - 2.2
Device.NeighborDiscovery.InterfaceSetting.{i}. object(0:) W

Per-interface Neighbor Discovery Protocol (NDP) configuration [RFC4861].

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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface.

 - 2.2
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.2
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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface.

Changes in 2.17:

 - 2.2
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.2
RDNSSMode string W

Describes which IPv6 address information MUST be specified in the RDNSS option field specified in [Section 5.1. Recursive DNS Server Option/RFC8106].

Enumeration of:

  • Static (The DNS Servers as defined in the RDNSS parameter should be used in the RA messages. A comma separated list of IPv6 addresses must be supported)
  • LLA (The link-local IPv6 address of the Interface is sent in the RA messages)
  • GUA (The global unique IPv6 addresses of the Interface are sent in the RA messages, OPTIONAL)
  • LLA_GUA (Both GUA and LLA of the Interface are sent in the RA messages, OPTIONAL)
 Static 2.17
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.

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

 <Empty> 2.17
AdvRDNSSLifetime unsignedInt(:4294967295) W

The Lifetime field in RDNSS specifies the maximum duration, in seconds, during which the provided RDNSS addresses can be used for name resolution relative to the time the packet is received. By default, the value of Lifetime is recommended to be at least 3 times the MaxRtrAdvInterval. The MaxRtrAdvInterval is defined in [RFC4861] and refers to the maximum interval between Router Advertisement (RA) messages.

When the Lifetime value is set to all one bits (0xffffffff), it indicates an infinite duration.

The Lifetime value of zero signifies that the RDNSS addresses must not be used anymore, as specified in [Section 5.1. Recursive DNS Server Option/RFC8106].

 0 2.17
AdvDNSSLLifetime unsignedInt(:4294967295) W

The Lifetime field in DNSSL specifies the maximum duration, in seconds, during which the provided DNSSL domain names can be used for name resolution relative to the time the packet is received. By default, the value of Lifetime is recommended to be at least 3 times the MaxRtrAdvInterval. The MaxRtrAdvInterval is defined in [RFC4861] and refers to the maximum interval between Router Advertisement (RA) messages.

When the Lifetime value is set to all one bits (0xffffffff), it indicates an infinite duration.

The Lifetime value of zero signifies that the DNSSL domain names must not be used anymore, as specified in [Section 5.2. DNS Search List Option/RFC8106].

 0 2.17
Device.RouterAdvertisement.InterfaceSetting.{i}.Option.{i}. object(0:) W

This object specifies the options in a Router Advertisement (RA) message [Section 4.6/RFC4861]. Option entries are created for use in sending Router Advertisements (enabled options MUST be included in RA messages sent). This includes support for sending DNS information in the RA message as described in [RFC6106].

This table is intended only for options that are not modeled elsewhere. For example, it is not appropriate for the MTU option (which is modeled via AdvLinkMTU).

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Tag.

 - 2.2
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.2
Device.IPv6rd. object R

Settings allowing a CPE to derive and route IPv6 Rapid Deployment (6rd) delegated prefixes as specified in [RFC5969]. The 6rd mechanism is intended to be implemented only on what [RFC5969] refers to as Customer Edge Routers, i.e. on gateway devices, that support IPv6 on the LAN side and only have IPv4 connectivity on the WAN side.

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

 - 2.2
Device.IPv6rd.InterfaceSetting.{i}. object(0:) R

6rd [RFC5969] settings.

A 6rd delegated prefix is expected to be of maximum length 64 bits, and is the concatenation of the following two items:

  • Service provider IPv6 prefix: specified via the SPIPv6Prefix parameter
  • IPv4 address suffix: the IPv4 address with the first IPv4MaskLength bits removed

This object definition is derived from [RFC5969] with some minor nomenclature changes.

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

 - 2.2
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Order unsignedInt(1:) W

Position of the Classification entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence).

[Order] Position of the Classification entry in the order of precedence. A value of 1 indicates the first entry to be considered (highest precedence).

When a Classification instance is created, or when an existing Order value is modified, if the value matches that of an existing entry, the Order values for the existing entry and all lower Order entries are incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction.

If no Order value is supplied on creation of a Classification instance, it MUST be assigned a value that is one more than the largest current value (lowest precedence).

For each packet, the highest ordered entry that matches the classification criteria is applied. All lower order entries are ignored.

When this value is modified, if the value matches that of an existing entry, the {{param}} value for the existing entry and all lower {{param}} entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes {{param}} values to be compacted. When a value is changed, incrementing occurs before compaction.

The value of {{param}} on creation of a {{object}} table entry MUST be one greater than the largest current value (initially assigned the lowest precedence).

Changes in 2.17:

  • Removed unsignedInt(1:) syntax
  • Added Order
 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.QoS.App.{i}. object(0:) W

Application table.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.QoS.Flow.{i}. object(0:) W

Flow table.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.QoS.Policer.{i}. object(0:) W

Policer table.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both Queue and Interface.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.QoS.Scheduler.{i}. object(0:) W

Scheduler table. Each entry is used to model a scheduler object.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.16
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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.Host.{i}. object(0:) R

Host table.

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

 - 2.0
Alias string(:64) WO
[Alias] ::: hide A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.
If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

:::

This parameter was DEPRECATED in 2.11 because Host is a transient object.
This parameter was OBSOLETED in 2.14.
This parameter was DELETED in 2.15.
Once it’s been set, this parameter is immutable.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.Hosts.AccessControl.{i}. object(0:) W

Every instance of this object provides access control for a LAN device.

Access is allowed if no instance of AccessControl is defined for a device.

If access is not allowed, then the LAN device cannot access the broadband network.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for PhysAddress.

Changes in 2.17:

 - 2.14
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.14
Origin string R

Indicates the owner of the AccessControl instance.

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)
 Controller 2.17
PhysAddressMask string(:64) W

Mask to be applied on PhysAddress. When set to ‘FF:FF:FF:FF:FF:FF’ the access control rule is applicable to a single host. Other possible values ‘FF:FF:FF:00:00:00’ to apply access control to a specific OUI.

When an empty string is set, no mask will be applied and the PhysAddress MUST be used as is.

 <Empty> 2.17
Device.Hosts.AccessControl.{i}.Schedule.{i}. object(0:) W

Each instance of this object provides a schedule where access is enabled.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.14
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.14
Device.DNS. object R Properties for Domain Name Service (DNS).

Changes in 2.17:

 - 2.0
ZoneNumberOfEntries unsignedInt R The number of entries in the Zone table. - 2.17
Device.DNS.Zone.{i}. object(0:) W

This object specifies Zone file configuration of the DNS server.

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

 - 2.17
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

 - 2.17
Enable boolean W Enables or disables the DNS zone. - 2.17
Name string(:128) W Domain name that is associated with the zone. - 2.17
Origin string R

The mechanism via which the Zone was created.

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)
 System 2.17
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. Specifies the Layer 3 interface on which the zone should be available. Example: Device.IP.Interface.1 or Device.Logical.Interface.1. <Empty> 2.17
HostNumberOfEntries unsignedInt R The number of entries in the Host table. - 2.17
Device.DNS.Zone.{i}.Host.{i}. object(0:) W

This object specifies the resource records (RR) of the DNS zone.

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

 - 2.17
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

 - 2.17
Enable boolean W Enables or disables the entry in the zone file. - 2.17
Name string(:128)[] W Comma-separated list of strings (maximum number of characters per item 128). List of hostnames that are associated with the Host. - 2.17
Origin string W

Indicates the owner of the Host instance.

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)
 System 2.17
Host string(:256) W The value MUST be the Path Name of a row in the Hosts.Host. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Host table entries associated with the device. - 2.17
LastUpdate dateTime R The date and time in UTC when the entry was last changed. - 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, or RA received DNS server information, or are statically configured by the Controller.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for DNSServer.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.DNS.Relay. object R DNS Relay object. The DNS proxy (or relay) function allows the forwarding of local network DNS queries to local or external DNS server(s) [RFC5625].

Changes in 2.17:

 - 2.0
ConfigNumberOfEntries unsignedInt R The number of entries in the Config table. - 2.17
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 choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.17
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t 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. <Empty> 2.17
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. Specifies the IP interface over which the DNS query is received. This is usually the LAN interface.

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
CacheSize unsignedInt R

Specifies the size of cache in kilobytes.

When ‘0’ is specified, no DNS results will be cached.

 0 2.17
CacheMinTTL unsignedInt R

Specifies the minium 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
CacheMaxTTL unsignedInt R

Specifies the maximum TTL amount of time, in seconds, than an entry MUST be kept in the cache regardless of what has been specified by the domain owner.

When ‘0’ is specified, then the TTL chosen by the domain owner will be applied.

 86400 2.17
Device.DNS.Relay.Forwarding.{i}. object(0:) W

DNS Server forwarding policy to be used by the DNS Relay. Entries are either automatically created as result of DHCP (v4 or v6), IPCP, or RA received DNS server information, or are statically configured by the Controller.

Note: Management of re-directing queries to the device embedded DNS server is not defined in this version of the specification.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for DNSServer.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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.

Changes in 2.17:

 - 2.6
AdvertiseNumberOfEntries unsignedInt R The number of entries in the Advertise table. - 2.17
AdvertisedInterfaces string[] W
Comma-separated list of strings. Each list item MUST be the Path Name of the IP.Interface object instance from which DNS-SD services are advertised. If the referenced object is deleted, the corresponding item MUST be removed from the list.
If this parameter is not supported by an implementation then DNS-SD services are advertised on all LAN interfaces.
This parameter was DEPRECATED in 2.17 in favor of Advertise.{i}.Interface.

Changes in 2.17:

  • Added status = deprecated
 - 2.12
Device.DNS.SD.Advertise.{i}. object(0:) W

The Advertise table contains DNS-SD services that MUST be advertised. DNS.SD service information is provided in DNS RR SRV records [RFC2782]. The Service Instance Name [Section 4.1 Structured Instance Names/DNS-SD] further specifies information about the service name (RFC2782 Service field) and domain name (RFC2782 Name field) in the form:

Service Instance Name = [InstanceName] . [Service] . [Domain]

[Service] = _[ApplicationProtocol] . _[TransportProtocol]

RFC2782 Service field will always be equal to [InstanceName]. [Service]

RFC2782 Name field will always be equal to [Domain]

For example, an SSH service might have:

*InstanceName = “Secure Shell (SSH))”

*ApplicationProtocol = “ssh”

*TransportProtocol = “TCP”

*Port = 22

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

 - 2.17
Enable boolean W Enables or disables the advertisement of the DNS-SD service. - 2.17
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

 - 2.17
Status string R

The status of the advertised Advertise.

Enumeration of:

  • Disabled (Indicates that the DNS-SD service advertisement is disabled)
  • Enabled (Indicates that the DNS-SD service advertisement is enabled)
  • Error_Misconfigured (Indicates that a necessary configuration value is undefined or invalid)
  • Error (MAY be used to define an error condition, OPTIONAL)
 Disabled 2.17
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 layer 3 interface on which the DNS-SD service MUST be advertised. Example: Device.IP.Interface.1 or 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.

 - 2.17
InstanceName string(:63) R Human-readable instance name [Section 4.1.1 Instance Names/DNS-SD] (i.e. The “[InstanceName]” portion of the ‘“Service Instance Name’“). - 2.17
ApplicationProtocol string(:15) R 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]. - 2.17
TransportProtocol string R

The Transport Protocol associated with the service as defined by the DNS-SD service [Section 4.1.2 Service Names/DNS-SD].

Enumeration of:

  • TCP
  • UDP
 - 2.17
Domain string(:256) R 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]. local 2.17
Port unsignedInt(:65535) R The value to be entered into the Port field of the DNS SRV record [RFC2782] that is used to contact the service. - 2.17
TextRecordNumberOfEntries unsignedInt R The number of entries in the TextRecord table. - 2.17
Device.DNS.SD.Advertise.{i}.TextRecord.{i}. object(0:) R

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.

 - 2.17
Key string(:255) W The key that identifies the text record - 2.17
Value string(:255) W The value of the text record. - 2.17
Device.DNS.SD.Service.{i}. object(0:) R

The Service table contains discovered DNS-SD services. DNS.SD service information is provided in DNS RR SRV records [RFC2782]. The Service Instance Name [Section 4.1 Structured Instance Names/DNS-SD] further specifies information about the service name (RFC2782 Service field) and domain name (RFC2782 Name field) in the form:

Service Instance Name =

. .

= _ . _

[InstanceName] . [Service] . [Domain]

[Service] = _[ApplicationProtocol] . _[TransportProtocol]

RFC2782 Service field will always be equal to . [InstanceName]. [Service]

RFC2782 Name field will always be equal to [Domain]

For example, an SSH service might have:

*InstanceName = “Secure Shell (SSH))”

*ApplicationProtocol = “ssh”

*TransportProtocol = “TCP”

*Domain = “example.com”

*Port = 22

*Target = “ssh.example.com.”

At most one entry in this table can exist with the same values for all of InstanceName, ApplicationProtocol, TransportProtocol and Domain.

 - 2.6
InstanceName string(:63) R Human-readable instance name [Section 4.1.1 Instance Names/DNS-SD] (i.e. The “<“InstanceName>“[]” portion of the ‘“Service Instance Name’“). - 2.6
Device.NAT. object R

Properties for Network Address Translation (NAT).

The entire NAT object only applies to IPv4.

Changes in 2.17:

 - 2.0
MaxNumberOfPortMappings unsignedInt R

The maximum number of port mappings that can exist at any given time.

If the value of this parameter is 0, then it means that the device doesn’t have a limit to the number of port mappings that can exist.

 - 2.17
MaxNumberOfPortTriggers unsignedInt R

The maximum number of port triggers that can exist at any given time.

If the value of this parameter is 0, then it means that the device doesn’t have a limit to the number of port mappings that can exist.

 - 2.17
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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.NAT.PortMapping.{i}. object(0:) W

Port mapping table.

This table MUST contain all NAT port mappings associated with this connection, including static and dynamic port mappings programmatically created via local control protocol, such as UPnP.

This table MUST NOT contain dynamic NAT binding entries associated with the normal operation of NAT.

If the CPE hosts a firewall, it is assumed that it will appropriately configure the firewall for the port mapping.

For enabled table entries, if InternalClient is an empty string, or if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of RemoteHost, ExternalPort and Protocol.

Changes in 2.17:

 - 2.0
Origin string R

Indicates the Origin of the PortMapping instance.

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)
 Controller 2.17
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

Note: There is no guarantee that the Alias value on automatically-created PortMapping instances will be retained. This is because automatically-created PortMapping instances can be transitory.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.NAT.PortTrigger.{i}. object(0:) W

Firewall PortTrigger table.

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

 - 2.16
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.16
Origin string W

Indicates the owner of the PortTrigger instance.

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)
 Controller 2.16
Device.NAT.PortTrigger.{i}.Rule.{i}. object(0:) W

Firewall PortTrigger Rule table.

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

 - 2.16
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.16
Device.PCP. object R

Properties for Port Control Protocol (PCP) [RFC6887].

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

 - 2.8
Device.PCP.Client.{i}. object(0:) W

Client properties for Port Control Protocol (PCP). The PCP Client interacts with a PCP Server as defined in [RFC6887] for internal device applications or LAN device applications via Interworking functions.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for WANInterface.

 - 2.8
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.8
Device.PCP.Client.{i}.Server.{i}. object(0:) W

This table contains the PCP Servers to be used by the PCP Client. Entries are either statically configured or automatically created via DHCP options OPTION_V4_PCP_SERVER and OPTION_V6_PCP_SERVER, as per [RFC7291].

Each OPTION_V4_PCP_SERVER or OPTION_V6_PCP_SERVER option corresponds to a Server instance. If an option returns multiple addresses then that Server instance has multiple addresses.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for ServerNameOrAddress.

 - 2.8
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.8
Device.PCP.Client.{i}.Server.{i}.InboundMapping.{i}. object(0:) W

Inbound Mapping table.

This table contains all Inbound Mappings requested by this PCP Client on this PCP Server. Such a mapping is created by a PCP request with OpCode MAP, as described in [Section 11/RFC6887].

These requests can be issued from internal device applications, from static configuration or from other LAN device applications via interworking functions such as UPnP IGD or PCP proxies. The Origin parameter indicates which mechanism requested the mapping.

For non-Static mappings (here Static refers to the mechanism that created the mapping, not to the Lifetime), the Controller MAY modify the Enable parameter but MUST NOT modify any other parameters in the mapping or its sub-objects.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of InternalPort, ProtocolNumber and ThirdPartyAddress.

 - 2.8
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.8
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.8
Device.PCP.Client.{i}.Server.{i}.OutboundMapping.{i}. object(0:) W

Outbound Mapping table.

This table contains all Outbound Mappings requested by this PCP Client on this PCP Server. Such a mapping is created by a PCP request with OpCode PEER, as described in [Section 12/RFC6887].

These requests can be issued from internal device applications, from static configuration or from other LAN device applications via interworking functions such as UPnP IGD or PCP proxies. The Origin parameter indicates which mechanism requested the mapping.

For non-Static mappings (here Static refers to the mechanism that created the mapping, not to the Lifetime), the Controller MAY modify the Enable parameter but MUST NOT modify any other parameters in the mapping or its sub-objects.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of InternalPort, ProtocolNumber, ThirdPartyAddress, RemoteHostIPAddress and RemotePort.

 - 2.8
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.DHCPv4.Client.{i}.SentOption.{i}. object(0:) W

Each instance of this object represents a DHCP option that MUST, if enabled, be sent in DHCP client requests. All sent DHCP options MUST be listed.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Tag.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.DHCPv4.Client.{i}.ReqOption.{i}. object(0:) W

Each instance of this object represents a DHCP option that MUST, if enabled, be requested in DHCP client requests. All requested DHCP options MUST be listed.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Tag.

 - 2.0
Order unsignedInt(1:) W

Position

[Order] Position of the ReqOption entry in the order of precedence. A value of 1 indicates the first entry to be considered (highest precedence).

When a ReqOption instance is created, or when an existing Order value is modified, if the value matches that of an existing entry, the Order values for the existing entry and all lower Order entries are incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction.

If no Order value is supplied on creation of a ReqOption instance, it MUST be assigned a value that is one more than the largest current value (lowest precedence).

This indicates the position of the option in the DHCP client request. A value of 1 indicates the first entry.

When this value is modified, if the value matches that of an existing entry, the {{param}} value for the existing entry and all lower {{param}} entries is incremented to ensure uniqueness of this value. A deletion causes {{param}} values to be compacted. When a value is changed, incrementing occurs before compaction.

The value of {{param}} on creation of a {{object}} table entry MUST be one greater than the largest current value.

Changes in 2.17:

  • Removed unsignedInt(1:) syntax
  • Added Order
 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.DHCPv4.Server. object R DHCP server configuration. - 2.0
Device.DHCPv4.Server.Pool.{i}. object(0:) W

DHCP conditional serving pool table.

Each instance of this object defines a DHCP conditional serving pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCP options, and MAC address.

Overlapping pool ranges MUST be supported.

For enabled table entries, if Interface is not a valid reference, or MinAddress, MaxAddress, or SubnetMask is not a valid value, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Order.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Order unsignedInt(1:) W

Position of the Pool entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence).

[Order] Position of the Pool entry in the order of precedence. A value of 1 indicates the first entry to be considered (highest precedence).

When a Pool instance is created, or when an existing Order value is modified, if the value matches that of an existing entry, the Order values for the existing entry and all lower Order entries are incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction.

If no Order value is supplied on creation of a Pool instance, it MUST be assigned a value that is one more than the largest current value (lowest precedence).

For each DHCP request, the highest ordered entry that matches the association criteria is applied. All lower order entries are ignored.

When this value is modified, if the value matches that of an existing entry, the {{param}} value for the existing entry and all lower {{param}} entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes {{param}} values to be compacted. When a value is changed, incrementing occurs before compaction.

The value of {{param}} on creation of a {{object}} table entry MUST be one greater than the largest current value (initially assigned the lowest precedence).

Changes in 2.17:

  • Removed unsignedInt(1:) syntax
  • Added Order
 - 2.0
Device.DHCPv4.Server.Pool.{i}.StaticAddress.{i}. object(0:) W

DHCP static address table.

Entries in this table correspond to what [RFC2131] calls “manual allocation”, where a client’s IP address is assigned by the network administrator, and DHCP is used simply to convey the assigned address to the client.

Each instance of this object specifies a hardware address (MAC address) and an IP address within the pool. When serving from this pool, this IP address MUST, if available, be assigned to the DHCP client with this hardware address, and MUST NOT be assigned to any other client.

Note that it is possible that an IP address in this table is present in one or more of the other conditional serving pools, in which case it is possible that such an address will be assigned to a different client.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Chaddr.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.DHCPv4.Server.Pool.{i}.Option.{i}. object(0:) W

This object specifies the DHCP options that MUST, if enabled, be returned to clients whose DHCP requests are associated with this pool.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Tag.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.DHCPv4.Server.Pool.{i}.Client.{i}. object(0:) R

DHCPv4 client table.

This table lists details of DHCPv4 clients that matched the filter criteria of this Pool entry.

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

 - 2.2
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

Note: There is no guarantee that the Alias value on automatically-created Client instances will be retained. This is because automatically-created Client instances can be transitory.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.2
Device.DHCPv4.Relay. object R DHCP Relay Agent (conditional relaying). - 2.0
Device.DHCPv4.Relay.Forwarding.{i}. object(0:) W

DHCP Relay Agent Forwarding table.

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

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Order unsignedInt(1:) W

Position of the Forwarding entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence).

[Order] Position of the Forwarding entry in the order of precedence. A value of 1 indicates the first entry to be considered (highest precedence).

When a Forwarding instance is created, or when an existing Order value is modified, if the value matches that of an existing entry, the Order values for the existing entry and all lower Order entries are incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction.

If no Order value is supplied on creation of a Forwarding instance, it MUST be assigned a value that is one more than the largest current value (lowest precedence).

For each DHCP request, the highest ordered entry that matches the association criteria is applied. All lower order entries are ignored.

When this value is modified, if the value matches that of an existing entry, the {{param}} value for the existing entry and all lower {{param}} entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes {{param}} values to be compacted. When a value is changed, incrementing occurs before compaction.

The value of {{param}} on creation of a {{object}} table entry MUST be one greater than the largest current value (initially assigned the lowest precedence).

Changes in 2.17:

  • Removed unsignedInt(1:) syntax
  • Added Order
 - 2.0
Device.DHCPv6. object R The Dynamic Host Configuration Protocol (DHCP) IPv6 object [RFC3315]. This entire object applies to IPv6 only. It contains the Client and Server objects. - 2.2
Device.DHCPv6.Client.{i}. object(1:) W

This object contains DHCPv6 client settings for an associated IP Interface indicated by Interface.

For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

This table MUST contain at least 1 entry.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface.

 - 2.2
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.2
Device.DHCPv6.Client.{i}.SentOption.{i}. object(0:) W

The top-level options and option values (including any encapsulated options) that the client will send to the server.

This table is intended only for options that are not part of the basic operation of the protocol, and whose values are simple, do not often change and are not modeled elsewhere. For example, it is appropriate for OPTION_USER_CLASS (whose value is a list of user classes) but is not appropriate for OPTION_RECONF_MSG (which is part of the protocol), OPTION_IA_NA (which is modeled via RequestAddresses) or OPTION_RAPID_COMMIT (which is modeled via RapidCommit).

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Tag.

 - 2.2
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.2
Device.DHCPv6.Server. object R DHCPv6 server configuration. - 2.2
Device.DHCPv6.Server.Pool.{i}. object(0:) W

DHCPv6 server pool table.

Each instance of this object defines a DHCPv6 server pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCPv6 options, and source address.

Overlapping pool ranges MUST be supported.

For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack) then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Order.

 - 2.2
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.2
Order unsignedInt(1:) W

Position of the Pool entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence).

[Order] Position of the Pool entry in the order of precedence. A value of 1 indicates the first entry to be considered (highest precedence).

When a Pool instance is created, or when an existing Order value is modified, if the value matches that of an existing entry, the Order values for the existing entry and all lower Order entries are incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction.

If no Order value is supplied on creation of a Pool instance, it MUST be assigned a value that is one more than the largest current value (lowest precedence).

For each DHCPv6 request, the highest ordered entry that matches the association criteria is applied. All lower order entries are ignored.

When this value is modified, if the value matches that of an existing entry, the {{param}} value for the existing entry and all lower {{param}} entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes {{param}} values to be compacted. When a value is changed, incrementing occurs before compaction.

The value of {{param}} on creation of a {{object}} table entry MUST be one greater than the largest current value (initially assigned the lowest precedence).

Changes in 2.17:

  • Removed unsignedInt(1:) syntax
  • Added Order
 - 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
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

Note: There is no guarantee that the Alias value on automatically-created Client instances will be retained. This is because automatically-created Client instances can be transitory.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Tag.

 - 2.2
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.0
Device.Users. object R Users object that contains the User, Group, and Role tables. - 2.0
Device.Users.User.{i}. object(0:) W

This object contains parameters relating to the user characteristics.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Username, or with a given value for UserID.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Groupname, or with a given value for GroupID.

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.15
Device.Users.SupportedShell.{i}. object(0:) W

This table provides a list of user accessible shells which can be used as a reference in User.{i}.Shell

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name.

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for RoleName, or with a given value for RoleID.

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.15
Device.SmartCardReaders. object R SmartCardReaders object that contains the SmartCardReader table. - 2.0
Device.SmartCardReaders.SmartCardReader.{i}. object(0:) R

This object describes the characteristics of the smart card reader.

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

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.3
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.17:

 - 2.0
InterfaceSettingNumberOfEntries unsignedInt R The number of entries in the InterfaceSetting table. - 2.17
Device.Firewall.Level.{i}. object(0:) W

Firewall Level table. When an Advanced or Policy configuration is selected, AdvancedLevel or PolicyLevel selects the currently active entry in this table. Each Level table entry references the Chain that contains the rules for this level.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.2
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.2
Order unsignedInt(1:) W

Position

[Order] Position of the Level entry in the order of precedence. A value of 1 indicates the first entry to be considered (highest precedence).

When a Level instance is created, or when an existing Order value is modified, if the value matches that of an existing entry, the Order values for the existing entry and all lower Order entries are incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction.

If no Order value is supplied on creation of a Level instance, it MUST be assigned a value that is one more than the largest current value (lowest precedence).

This indicates the order of the Level entry forin the user interface display;display. levelsLevels can be presented according to an increasing or decreasing level of security.

When this value is modified, if the value matches that of an existing entry, the {{param}} value for the existing entry and all greater-valued {{param}} entries is incremented to ensure uniqueness of this value. A deletion causes {{param}} values to be compacted. When a value is changed, incrementing occurs before compaction.

The value of {{param}} on creation of a {{object}} table entry MUST be one greater than the largest current value.

Changes in 2.17:

  • Removed unsignedInt(1:) syntax
  • Added Order
 - 2.2
Device.Firewall.Policy.{i}. object(0:) W

Firewall Policy table. When a Policy configuration is selected, PolicyLevel selects the currently active entry in this table. Each Policy table entry references the Chain that contains the rules for this policy.

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

 - 2.16
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.16
Device.Firewall.Chain.{i}. object(0:) W

Firewall Chain table. Each entry contains an ordered list of Rule objects which can themselves reference other Chain instances. A hierarchy of rules can therefore be created.

A given Firewall Chain’s rules are all created by the same entity, as indicated by the Creator parameter.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.2
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.2
Device.Firewall.Chain.{i}.Rule.{i}. object(0:) W

Firewall Rule table. Each entry defines a Firewall packet selection rule. The Target parameter defines the action to perform for traffic matching this rule: the packet can be dropped, accepted, rejected or passed to another Chain.

This table MUST NOT contain dynamic Firewall rules associated with Stateful Firewall sessions.

All entries are created by the creator of the parent Chain, as indicated by its Creator parameter. Rule entries in a Chain with a Creator of Defaults, ACS, UserInterface or (maybe) Other are referred to as Static Rules. Whether or not a Rule in a Chain with Creator Other is regarded as Static is a local matter to the CPE. Some of this object’s parameter descriptions refer to whether a Rule is Static when specifying whether or not the parameter value can be modified.

For enabled table entries, if SourceInterface is not a valid reference and SourceAllInterfaces is false, or if DestInterface is not a valid reference and DestAllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.2
Order unsignedInt(1:) W

Position of the Rule entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence).

[Order] Position of the Rule entry in the order of precedence. A value of 1 indicates the first entry to be considered (highest precedence).

When a Rule instance is created, or when an existing Order value is modified, if the value matches that of an existing entry, the Order values for the existing entry and all lower Order entries are incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction.

If no Order value is supplied on creation of a Rule instance, it MUST be assigned a value that is one more than the largest current value (lowest precedence).

For each packet, the highest ordered entry that matches the rule criteria is applied. All lower order entries are ignored.

When this value is modified, if the value matches that of an existing entry, the {{param}} value for the existing entry and all lower {{param}} entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes {{param}} values to be compacted. When a value is changed, incrementing occurs before compaction.

The value of {{param}} on creation of a {{object}} table entry MUST be one greater than the largest current value (initially assigned the lowest precedence).

Changes in 2.17:

  • Removed unsignedInt(1:) syntax
  • Added Order
 - 2.2
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.2
Device.Firewall.Pinhole.{i}. object(0:) W

Firewall Pinhole object that is used for configuring pinholes. Pinholes are similar to port mapping entries but without the NAT support. The Pinhole table is used for allowing certain incoming traffic, on the Interface, to be routed to the internal network.

For enabled table entries, if DestMACAddress and DestIP are an empty string, or if Interface is not a valid reference, then the table entry is inoperable and the device MUST set Status to Error_Misconfigured.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

Changes in 2.17:

 - 2.16
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.16
Origin string R

Indicates the ownerOrigin of the Pinhole instance.

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)

Changes in 2.17:

  • Changed access = readWrite ⇒ readOnly
  • Added string UPnP enumeration
 Controller 2.16
LeaseDuration unsignedInt W

Determines the time to live, in seconds, of a pin hole lease, where “time to live” means the number of seconds before the pin hole expires.

A value of 0 means the pin hole is static. Support for dynamic (non-static) pin hole is OPTIONAL. That is, the only value for LeaseDuration that MUST be supported is 0.

 - 2.17
RemainingLeaseTime unsignedInt R

For a dynamic (non-static) pin hole, when this parameter is read, the value represents the time (in seconds) remaining on the pin hole lease. That is, for a dynamic pin hole, the value counts down toward 0. When a dynamic pin hole lease expires, the device MUST automatically terminate that pin hole, and MUST automatically delete the corresponding Pinhole table entry.

For a static pin hole, this parameter is irrelevant and should return 0.

Active Notification requests for this parameter MAY be denied.

 - 2.17
Device.Firewall.DMZ.{i}. object(0:) W

Firewall DMZ object that is be used for configuring a demilitarized zone. A DMZ network is a seperate network perimeter that protects the internal network from untrusted traffic. Typically the DMZ is located between two firewalls, the firewall of the internal network and the firewall responsible for handling untrusted traffic.

The device MUST forward all received packets that matches the SourcePrefix criteria to the IP address that is specified in DestIP.

For enabled table entries, if DestIP is an empty string, or if Interface is not a valid reference, then the table entry is inoperable and the device MUST set Status to Error_Misconfigured.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both DestIP and SourcePrefix.

Changes in 2.17:

 - 2.16
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.16
Origin string W

Indicates who configured the DMZ instance.

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,)
 Controller 2.16
LeaseDuration unsignedInt W

Determines the time to live, in seconds, of a DMZ rule, where “time to live” means the number of seconds before the DMZ rule expires.

A value of 0 means the DMZ rule is static. Support for dynamic (non-static) DMZ rules is OPTIONAL. That is, the only value for LeaseDuration that MUST be supported is 0.

 - 2.17
RemainingLeaseTime unsignedInt R

For a dynamic (non-static) DMZ rule, when this parameter is read, the value represents the time (in seconds) remaining on the DMZ rule lease. That is, for a dynamic DMZ rule, the value counts down toward 0. When a dynamic DMZ rule lease expires, the device MUST automatically terminate that DMZ rule, and MUST automatically delete the corresponding DMZ table entry.

For a static DMZ rule, this parameter is irrelevant and should return 0.

Active Notification requests for this parameter MAY be denied.

 - 2.17
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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of Interface, DestPort, Protocol and SourcePrefixes.

 - 2.16
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface.

 - 2.17
Enable boolean W Enables or disables the InterfaceSetting entry, indicating if NAT is enabled for the referenced IP Interface instance. On creation, an InterfaceSetting entry is disabled by default. false 2.17
Status string R

The status of this entry. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error

The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid.

The Error value MAY be used by the device to indicate a locally defined error condition.

 Disabled 2.17
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

 - 2.17
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 associated IP interface on which NAT is to be enabled. <Empty> 2.17
IPv4SpoofingProtection boolean W

Enables or disables the IPv4 spoofing protection.

Spoofing protection prevents LAN devices from sending packets with a wrong source IP address.

A number of DDoS attacks are known to modify the source IP address of packets to initiate a DDoS attack. Spoofing protection checks if the source IP address of packets initiated in the LAN belongs to the LAN interface Address range, otherwise the packet will be dropped early in the network stack.

 - 2.17
IPv6SpoofingProtection boolean W

Enables or disables the IPv6 spoofing protection.

Spoofing protection prevents LAN devices from sending packets with a wrong source IP address.

A number of DDoS attacks are known to modify the source IP address of packets to initiate a DDoS attack. Spoofing protection checks if the source IP address of packets initiated in the LAN belongs to the LAN interface Address range, otherwise the packet will be dropped early in the network stack.

 - 2.17
IPv4AcceptICMPEchoRequest boolean W When true the ‘ICMPv4 echo request’ packet must be answered with an ‘ICMPv4 echo reply’. When false the ‘ICMPv4 echo request’ packet must be dropped. - 2.17
IPv6AcceptICMPEchoRequest boolean W When true the ‘ICMPv6 echo request’ packet must be answered with an ‘ICMPv6 echo reply’. When false the ‘ICMPv6 echo request’ packet must be dropped. - 2.17
StealthMode boolean W

Enables or disables the stealth mode. Stealth mode defines how the firewall must treat “unwanted” packets.

Typically the feature is enabled for WAN facing interface(s). Stealth mode is applicable for both IPv4 and IPv6, and UDP and TCP based protocols.

If set to true all ‘UDP/TCP’ packets are dropped silently. This prevents a possible attacker from knowing which ports are opened/closed on a gateway.

When StealthMode is set to false, the firewall will reply with an ICMP port unreachable.

If there are other firewall rules in effect, they will have priority over this parameter. i.e: If an ‘UDP’ port is set to ‘ACCEPT’, and the StealthMode is activated, then the port will be accepted and all the other ‘UDP’ ports will be blocked.

 - 2.17
Device.Firewall.ConnectionTracking. object R This Object contains the IP connection tracking related parameters. Application Layer Gateway (ALG) are used to provide Network Address Translation (NAT) support for various application-layer protocols. - 2.17
Device.Firewall.ConnectionTracking.SIP. object R SIP is an application-layer control protocol used to establish, modify, and terminate multimedia sessions. - 2.17
Enable boolean W Enables or disables the connection tracking support for the SIP protocol (SIP ALG). - 2.17
Ports int(0:65535)[] W Comma-separated list of integers (0 to 65535). Port numbers of the SIP servers that need to be monitored. - 2.17
DirectMedia boolean W

Allow media streams between signaling endpoints.

The default value SHOULD be true.

 - 2.17
DirectSignaling boolean W

Allow incoming calls from registrar.

The default value SHOULD be true.

 - 2.17
ExternalMedia boolean W

Allow media streams that are not passing through this router.

When this feature is activated, the logic will maintain the SDP payload as is when it identifies that the interface towards the invited party is the same as the one towards the media endpoint.

The default value SHOULD be false.

 - 2.17
TimeOut unsignedInt W SIP time out session. - 2.17
Device.Firewall.ConnectionTracking.H323. object R H.323 is a VoIP signalling protocol from ITU-T - 2.17
Enable boolean W Enables or disables the connection tracking support for the H323 protocol (H323 ALG). - 2.17
RegistrationRequestTTL unsignedInt W When no TTL is specified in the registration request message the TTL specified here will be used. - 2.17
GKRoutedOnly boolean W Only accept calls from the gatekeeper. - 2.17
CallForwardFilter boolean W Create call forwarding expectations only when both endpoints are on different sides, as determined by routing information. - 2.17
Device.Firewall.ConnectionTracking.FTP. object R Tracking FTP connections is difficult due to the requirement for specialized helpers to handle them, along with the complexities of masquerading and Network Address Translation. This involves supporting FTP on Layer 3 with independent connection tracking. - 2.17
Enable boolean W Enables or disables the connection tracking support for the FTP protocol (FTP ALG). - 2.17
Ports int(0:65535)[:8] W Comma-separated list (up to 8 items) of integers (0 to 65535). Port numbers of the FTP servers that need to be monitored. - 2.17
Loose boolean W The FTP protocol can enable a user to connect a FTP server to another FTP server. This could lead to a hole in the DMZ and it is therefore recommended to disable this feature. - 2.17
Device.Firewall.ConnectionTracking.PPTP. object R PPTP Connection Tracking configuration object. - 2.17
Enable boolean W Enables or disables the connection tracking support for the PPTP protocol (PPTP ALG). - 2.17
Device.Firewall.ConnectionTracking.TFTP. object R TFTP Connection Tracking configuration object. - 2.17
Enable boolean W Enables or disables the connection tracking support for the TFTP protocol (TFTP ALG). - 2.17
Ports int(0:65535)[:8] W Comma-separated list (up to 8 items) of integers (0 to 65535). Port numbers of the TFTP servers that need to be monitored. - 2.17
Device.Firewall.ConnectionTracking.IRC. object R IRC Connection Tracking configuration object. - 2.17
Enable boolean W Enables or disables the connection tracking support for the IRC protocol (IRC ALG). - 2.17
Ports int(0:65535)[] W Comma-separated list of integers (0 to 65535). Port numbers of the IRC servers that need to be monitored. - 2.17
MAXDCCChannels unsignedInt W Maximum number of Direct Client-to-Client (DCC) channels allowed per IRC session. - 2.17
DCCTimeout unsignedInt W Timeout duration for unestablished Direct Client-to-Client (DCC) channels. - 2.17
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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.3
SampleInterval unsignedInt(1:) W

The sample interval in seconds. Each statistic is measured over this sample interval.

The CPE MAY also support an internal sampling rate (implementation dependent) that is faster than the SampleInterval and allows the CPE to support the various options available in Parameter.{i}.CalculationMode.

The CPE MAY reject a request to set SampleInterval to less than MinSampleInterval.

Sample intervals MUST begin every SampleInterval seconds, with no delay between samples.

If SampleInterval is changed while collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately.

For example, if ReportSamples is 24 and SampleInterval is 3600 (an hour), the CPE can store up to a day’s worth of samples for each statistic.

 3600 2.0
Device.PeriodicStatistics.SampleSet.{i}.Parameter.{i}. object(0:) W

Periodic statistics parameter table for this sample set. This table contains entries for parameters whose values are to be sampled.

Note that the comma-separated lists in this object (SampleSeconds, SuspectData and Values) only ever change (a) when first enabled, (b) when Device.PeriodicStatistics.SampleSet.{i}.ForceSample has been used to force statistics for the current sample to be calculated (a “sneak preview” of the current sample), or (c) at the end of the sample interval.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Reference.

 - 2.0
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.3
SampleMode string W

Controls how this parameter’s value is sampled. Enumeration of:

  • Current (Sampled value is current value)
  • Change (Sampled value is change in value since start of each internal sample interval.)

Parameters of non-numeric types can only support Current. The value of the SampleMode MUST be ignored for such parameters.

 Current 2.0
CalculationMode string W

Controls how this parameter’s statistic is calculated from the sampled value(s).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)

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.

 Latest 2.0
Device.Security. object R This object contains general information related to managing security features on the device. - 2.4
Device.Security.Certificate.{i}. object(0:) R

This table provides information about all types of public key-based credentials, such as X.509 certificates, see [RFC5280].

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

 - 2.4
SubjectAlt string[](:256) R

Comma-separated list (maximum number of characters 256) of strings. Each item specifies an identity that is abound DNSto Name.the certificate’s subject, and thus bound to the Public Key.

The Subject Alternative Names extension field in an X.509 certificate, see [RFC5280].

 - 2.4
Device.FAP. object R This object is the container for all Femto related component objects, to prevent pollution of the so-called global namespace of the BBF with FAP specific objects. - 2.4
Device.FAP.PerfMgmt. object R This object contains parameters relating to Performance Management in a Femto-related environment. - 2.4
Device.FAP.PerfMgmt.Config.{i}. object(0:) W

This object contains parameters relating to File Management configuration for uploading of Performance Files to a designated File Server. Each table entry can be referenced by zero or more radio-specific objects contained in the FAPService instances. The periodic upload will upload data for all of the radio-specific objects that reference it.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of URL, PeriodicUploadInterval and PeriodicUploadTime.

 - 2.4
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.4
Device.BulkData. object R

This object provides bulk data collection capabilities and global collection settings that affect the entire device.

Bulk Data utilizes various solutions (e.g., IPDR, HTTP) to collect data from devices and transfer the data to a collection server.

The IPDR solution is based on a service specification described in [TR-232].

The HTTP solution is based on transfer mechanisms described in [Annex N/TR-069].

The Bulk Data Collection Profiles are measured over a reporting interval (which can be aligned with absolute time) and are made available to the collection server.

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

A set of Bulk Data Collection profiles.

Each profile represents a bulk data report, including its own timing configuration, communications configuration, and set of parameters. This allows the Controller to configure multiple reports to be generated at different times for different sets of data.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.5
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.5
Device.SoftwareModules. object R Top level object for dynamically managed software applications. - 2.1
Device.SoftwareModules.ExecEnvClass.{i}. object(0:) R

This table lists the kinds of Execution Environments which are available in this device. Rows in this table may possibly be be added, modified, or removed by as a result of respectively installing, updating, or removing a DeploymentUnit.

At most one entry in this table can exist with a given value for Alias, or with the same values for all of Vendor, Name and Version.

 - 2.16
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.16
Device.SoftwareModules.ExecEnv.{i}. object(0:) R

The Execution Environments that are available on the device, along with their properties and configurable settings.

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

 - 2.1
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.1
Device.SoftwareModules.ExecEnv.{i}.ApplicationData.{i}. object(0:) R

The ApplicationData volumes which currently exist within this ExecEnv.

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

 - 2.16
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.1
Device.SoftwareModules.ExecutionUnit.{i}. object(0:) R

This table serves as the Execution Unit inventory and contains both status information about each Execution Unit as well as configurable parameters for each Execution Unit.

Each DeploymentUnit that is installed can have zero or more Execution Units.

Once a Deployment Unit is installed it populates this table with its contained Execution Units.

When the Deployment Unit (that caused this ExecutionUnit to come into existence) is updated, this instance MAY be removed and new instances MAY come into existence. While the Deployment Unit (that caused this ExecutionUnit to come into existence) is being updated, all ExecutionUnit instances associated with the Deployment Unit will be stopped until the update is complete at which time they will be restored to the state that they were in before the update started.

When the Deployment Unit (that caused this ExecutionUnit to come into existence) is uninstalled, this instance is removed.

Each ExecutionUnit MAY also contain a set of vendor specific parameters displaying status and maintaining configuration that reside under the Extensions object.

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

Changes in 2.17:

 - 2.1
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.1
EnvVariableNumberOfEntries unsignedInt R The number of entries in the EnvVariable table. - 2.17
Device.SoftwareModules.ExecutionUnit.{i}.AutoRestart. object R

Configures the parameters of the auto-restart algorithm for this ExecutionUnit.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 and m * (k/1000)^(n+1) seconds, so long as m * (k/1000)^n evaluates to a value less than RetryMaximumWaitInterval. Once this point has been reached, on all subsequent occasion that the Agent determines that the EU has terminated abnormally the delay before re-starting the EU must lie between RetryMaximumWaitInterval* * (1000/k)* and RetryMaximumWaitInterval seconds.

 - 2.16
Enable boolean W

Enable the auto-restart feature for this ExecutionUnit.EU.

The default value SHOULD be false.

 - 2.16
ResetPeriod unsignedInt W If the ExecutionUnitEU runs for this number of seconds without terminating abnormally the Agent MAY reset the RetryCount to zero, thereby resetting the exponential backoff algorithm. A value of zero disables this behavior. - 2.16
RetryCount unsignedInt W The number oftimes the EU has terminated abnormally and a restart attempts which havehas been initiated so far.attempted. Resetting this parameter to zero has the effect of re-initialising the exponential back-off algorithm. - 2.16
Device.SoftwareModules.ExecutionUnit.{i}.NetworkConfig. object R

Parameters of the network configuration for this ExecutionUnit.

When no network configuration is provided, the EU will not have any network access.

 - 2.17
AccessInterfaceRefList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the Logical.Interface. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the network interface through which the traffic from the EU will be allowed. - 2.17
PortMappingRefList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the NAT.PortMapping. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the list of Port mappings associated with this EU. - 2.17
Device.SoftwareModules.ExecutionUnit.{i}.HostObject.{i}. object(0:) R

This parameter describes the host OS objects (such as peripherals, files or directories, communication sockets, …) which are accessible to the ExecutionUnit.

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

 - 2.16
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.16
Device.SoftwareModules.ExecutionUnit.{i}.EnvVariable.{i}. object(0:) R

This parameter describes the environment variables which are accessible to the ExecutionUnit.

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

 - 2.17
Key string(:2048) R The Environment variable name that needs to be passed to the Execution unit when the execution unit is activated. - 2.17
Value string(:2048) R The Environment variable value associated with the name that needs to be passed to the Execution unit it is activated. - 2.17
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

 - 2.17
Device.XMPP. object R The XMPP represents the XMPP capabilities of the device, as described in [Appendix III/TR-069]. - 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of Username, Domain and Resource.

 - 2.7
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both ServerAddress and Port.

 - 2.7
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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.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 **{{reference: invalid option deprecatedobsoleted}}**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.MQTT. object R MQTT Base object describing all MQTT related parameters and objects. - 2.10
Device.MQTT.Client.{i}. object(0:) W

MQTT client table. Contains a list of configured MQTT clients.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.10
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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.

Changes in 2.17:

  • Changed status = deprecated ⇒ obsoleted
 true 2.14
Device.MQTT.Client.{i}.Subscription.{i}. object(0:) W

List of MQTT subscriptions handled by the MQTT client.

The MQTT client MUST subscribe with the MQTT broker for all subscription instances, whose parameter Enable is set to true, when it establishes a new connection to the MQTT broker. Disabled subscription instances with Enable set to false will be ignored during connection establishment.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Topic.

 - 2.10
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name.

 - 2.13
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.13
Device.MQTT.Broker.{i}. object(0:) W

MQTT broker table. Contains a list of configured MQTT brokers.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.10
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.10
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.10
Device.MQTT.Broker.{i}.Bridge.{i}.Server.{i}. object(0:) W

Each Server instance represents a MQTT bridge server to be used for a Bridge. A remote MQTT broker, which is connected by a MQTT bridge can be reachable via several host addresses each represented by its own Server table entry. For an active MQTT bridge at least one enabled entry has to exist.

If a MQTT bridge gets enabled by setting the parameter Bridge.{i}.Enable to true, which either has an empty Server table or the Server table only contains instances whose Enable is set to false, the Bridge.{i}.Status has to be set to Error_Misconfigured.

Any attempt to delete an instance, which is currently in use (Bridge.{i}.ServerConnection refers to the instance to be deleted), has to be rejected.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both Address and Port.

 - 2.10
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.10
Device.MQTT.Broker.{i}.Bridge.{i}.Subscription.{i}. object(0:) W

List of MQTT subscriptions handled over the bridge.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both Topic and Direction.

 - 2.10
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.10
Device.DynamicDNS. object R Properties for Dynamic DNS. - 2.10
Device.DynamicDNS.Client.{i}. object(0:) W

Client properties for Dynamic DNS.

A dynamic DNS client is responsible for verifying IP address changes and updating information from a subscribed account on a Dynamic DNS Server.

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

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both Server and Username.

 - 2.10
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.10
Device.DynamicDNS.Server.{i}. object(0:) W

Table of Dynamic DNS servers available for this CPE.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name.

 - 2.10
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.10
Device.LEDs. object R This object describes the LEDs on the device. - 2.11
Device.LEDs.LED.{i}. object(0:) R

Each instance of this object describes an LED on the device.

The default illumination characteristics (e.g., Color, Brightness) of an in use LED is vendor specific. When a cycle completes (i.e., CyclePeriodRepetitions = 0), the LED reverts back to its default illumination characteristics.

When the value of the Status parameter is Controlled, then the value of CycleElementNumberOfEntries and CycleElementNumberOfEntries parameters SHOULD be 0.

When the value of the RelativeXPosition and RelativeYPosition parameters are 0, this indicates that the position of the LED is unknown.

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

 - 2.11
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.11
Device.LEDs.LED.{i}.CycleElement.{i}. object(0:) W

Each instance of this object describes the LED characteristics for a portion of the LED cycle period.

The pattern of lighting for the LED corresponding to this table (i.e., the LED cycle period) is defined by the illumination of the LED according to the entries in this table, taken sequentially in the order specified by the Order parameter, with the duration for the portion of the LED illumination corresponding to a given instance specified by the Duration parameter.

The other parameters of the instance of this object (e.g., Color, Brightness) describes the illumination characteristics applied to the LED for this CycleElement instance.

The length of the complete LED cycle is the sum of the Duration parameters for all of the entries in this table.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Order.

 - 2.11
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.11
Device.BASAPM. object R This object represents the objects necessary to manage and control the functionality for tests that utilize the Broadband Access Service Attributes and Performance Metrics measurement test framework as defined in by [TR-304]. - 2.12
Device.BASAPM.MeasurementEndpoint.{i}. object(0:) W

This object represents the measurement endpoint that provides additional contextual information regarding the measurement agent.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for MeasurementAgent.

 - 2.12
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.12
Device.LMAP. object R This object represents the objects necessary to manage and control the functionality for Large-Scale Measurement of Broadband Performance[RFC7594] as defined in by [LMAPIFM]. - 2.12
Device.LMAP.MeasurementAgent.{i}. object(0:) W

This object represents the measurement agent that performs measurement tasks and reporting functions defined in [RFC7594].

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Identifier.

 - 2.12
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.12
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}. object(0:) W

This object represents a schedule that is associated with a set of scheduled actions to be performed by a measurement agent.

Note: Actions of an occurrence of this Schedule are gracefully terminated by the defining either the End or Duration parameters. Only one of these parameters may be defined at a time.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name.

 - 2.12
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.12
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}. object(0:) W

This object represents an action that is associated with the this Schedule object.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.12
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.12
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}.Option.{i}. object(0:) W

This object represents an option associated with the Scheduled Action. When an option with the same Name exists between the Seheduled Action’s Option and The Task’s option, the option of the Scheduled Action takes precedence over the option associated with the Task.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name.

 - 2.12
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.12
Device.LMAP.MeasurementAgent.{i}.Task.{i}. object(0:) W

The Task object defines the configuration for a task that can be performed by MeasurementAgent objects.

Tasks are performed by MeasurementAgent objects when a Schedule object invokes the Task.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name.

 - 2.12
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.12
Device.LMAP.MeasurementAgent.{i}.Task.{i}.Registry.{i}. object(0:) W

This object represents a registry function and an associated list of roles for this task

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for RegistryEntry.

 - 2.12
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.12
Device.LMAP.MeasurementAgent.{i}.Task.{i}.Option.{i}. object(0:) W

This object represents an option associated with the task.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name.

 - 2.12
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.12
Device.LMAP.MeasurementAgent.{i}.CommunicationChannel.{i}. object(0:) W

This object represents the properties communication channel used to establish communication between a measurement agent and other elements of the LMAP framework (e.g., measurement controller, measurement collector). The value of the Name parameter used for conveying information is defined as an option in the Task’s or scheduled Task’s option parameter.

When this object uses the BulkData capability, a BulkData.Profile.{i} object instance referred to by this object.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name.

 - 2.12
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.12
Device.LMAP.MeasurementAgent.{i}.Instruction.{i}. object(0:) W

The Instruction object defines the instruction to the measurement agent by the measurement controller. At most one Instruction object for the MeasurementAgent instance is enabled at a time. .

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.12
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.12
Device.LMAP.MeasurementAgent.{i}.Instruction.{i}.MeasurementSuppression.{i}. object(0:) W

This object defines the schedules and actions that are suppressed based on criteria defined in the SuppressionMatch parameter.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name.

 - 2.12
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.12
Device.LMAP.Event.{i}. object(0:) W

This object defines the information associated with an event used within the measurement agent. Event instances may be referenced by various objects within the LMAP model.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name.

 - 2.12
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 descrption 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
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.14
Device.WWC.URSP.{i}.TrafficDescriptor.{i}. object(0:) R

A set of rules for a given precedence that must be matched in order to select a router in the form of data network and slice. Selection criteria range from destination IP addresses to connection capabilities.

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

 - 2.14
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.14
Device.WWC.URSP.{i}.TrafficDescriptor.{i}.RouteSelectionDescriptor.{i}. object(0:) R

This object describes the URSP Route Selection Descriptor table which provides a table of data networks and network slices used in PDU establishment. Table entries are used in precedence order until a successful PDU session is established.

See ((bibref|3GPP-TS.23.503|Annex A for an example URSP rule traversal.}}

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

 - 2.14
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 netowrk 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
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.14
Device.PDU.Session.{i}.QoSRule.{i}.Filter.{i}. object(0:) R

This object describes the PDU QoS Rule Filter table. As each packet filter is logically anded with the others, there shall not be more than one occurrence of each packet filter component type.

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

 - 2.14
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.14
Device.PDU.Session.{i}.QoSFlow.{i}. object(0:) R

Table of all QoS Flow Indicators (QFI) and their properties supported by the access network for this particular PDU.

For example:

  • A QoS Flow with a QFI of 1 used for general traffic has the following parameters.
  • FiveQI=8
  • A QoS Flow with a QFI of 32 used for voice traffic with a guaranteed bitrate of 150k has the following parameters.
  • FiveQI=1
  • GFBRUplink=150
  • GFBRDownlink=150

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

 - 2.14
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.14
Device.FWE. object R 5G Wireline wireless Encapsulation transport for data plane. See [RFC8822]. - 2.14
Device.FWE.Link.{i}. object(0:) R

5G Wireline wireless Encapsulation link layer table (a stackable interface object as described in [Section 4.2/TR-181i2]).

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

 - 2.14
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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 choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.16
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.16
Device.XPON. object R This object models one or more xPON interfaces or ONUs as specified by the ITU based PON standards. It does not address IEEE based PON standards (like EPON). An ONU performs tasks such as traffic classification, VLAN manipulation, GEM port mapping, aggregation and/or forwarding between one or more UNIs and one or more ANIs. - 2.16
Device.XPON.ONU.{i}. object(0:) R

This object models one xPON interface or ONU as specified by the ITU based PON standards.

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

 - 2.16
Device.XPON.ONU.{i}.EthernetUNI.{i}. object(0:) R

Ethernet UNI table (a stackable interface object as described in [Section 4.2/TR-181i2]). This object models User Network Interfaces carrying Ethernet frames.

An EthernetUNI can be a virtual or a physical UNI. If the ONU is managed via OMCI, an EthernetUNI has an associated service, which is either a VEIP (see [Section 9.5.5/G.988]) or a PPTP Ethernet UNI (see [Section 9.5.1/G.988]).

If the associated service is a VEIP, the ONU shows a VEIP ME in the OMCI MIB. If it’s a PPTP Ethernet UNI, the ONU shows a PPTP Ethernet UNI ME in the OMCI MIB. It is expected the associated service is a VEIP for a virtual UNI, and that it is a PPTP Ethernet UNI for a physical UNI. However, some network operators require that the ONU shows a PPTP Ethernet UNI ME instead of a VEIP ME in its OMCI MIB even if the EthernetUNI models a virtual UNI.

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

 - 2.16
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.16
Device.XPON.ONU.{i}.ANI.{i}.TC. object R This object represents an ITU-T PON TC layer device.

Changes in 2.17:

 - 2.16
Device.XPON.ONU.{i}.ANI.{i}.TC.Authentication. object R This object shows info related to authentication of the ONU to the OLT. - 2.17
Password string(:72) W

All ITU based PON standards specify authentication by PLOAM password or registration ID.

See:

All those standards mention that a method to enter the password is beyond their scope. This parameter and the parameter HexadecimalPassword standardize a method to enter the password.

In case of G-PON as PON mode, the password can be up to 10 bytes long. See [Section 9.2.4.2/G.984.3]. For the other PON modes, the password can be up to 36 bytes long. See:

If HexadecimalPassword is false, the password is in ASCII format. Then all 95 printable characters with decimal codes in the range 32 to 126 inclusive are allowed. Each character corresponds with 1 byte in the password.

If HexadecimalPassword is true, the password is in hexadecimal format. Then only the characters 0 to 9, a to f, and A to F are allowed. Each character corresponds with 1 nibble in the password.

Depending on the value of HexadecimalPassword and the PON mode, a different number of characters are applicable. If HexadecimalPassword is false:

  • In case of G-PON as PON mode, only the 1st 10 characters are applicable.
  • In case of another PON mode, only the 1st 36 characters are applicable.

If HexadecimalPassword is true:

  • In case of G-PON as PON mode, the 1st 20 characters are all relevant. The other characters are not applicable.
  • In case of another PON mode, all 72 characters are relevant.

This parameter is set to an empty string if no authentication via a password is required.

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

 - 2.17
HexadecimalPassword boolean W

If false, Password is in ASCII format. If true, Password is in hexadecimal format.

See Password for more info.

 - 2.17
Device.SSH. object R This object contains global parameters relating to the Secure Shell clients and or servers implementations that are active in the CPE. - 2.16
Device.SSH.Server.{i}. object(0:) W

This object contains parameters relating to a SSH server instance.

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

 - 2.16
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.16
AutoDisableDuration unsignedInt W The SSH server instance will be disabled when the the AutoDisableDuration elapses, and configuration must be done in minutes. At the end, the coressponding Enable parameter of the SSH server instance is automatically changed to false false. Any active sessions must be forcibly terminated. 0 means the the SSH server instance is always active.

Changes in 2.17:

  • Changed access = readOnly ⇒ readWrite
 0 2.16
Device.SSH.Server.{i}.Session.{i}. object(0:) W

Active SSH session list.

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

 - 2.16
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.16
Device.SSH.AuthorizedKey.{i}. object(0:) W

This object contains parameters relating to a SSH server instance.

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

 - 2.16
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.16
Device.UnixDomainSockets. object R This object contains information related to the Unix Domain Sockets used by USP Agent UDS MTP. - 2.16
Device.UnixDomainSockets.UnixDomainSocket.{i}. object(0:) R

This object contains parameters relating to a UnixDomainSocket configuration.

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

 - 2.16
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 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.

 - 2.16
Protocol string R

The Message TransportTransfer Protocol (MTP) to be used for communications by a USP Endpoint. Note: This parameter was demoted to readOnly in the Device:2.17 version.

Enumeration of:

Changes in 2.17:

  • Changed access = readWrite ⇒ readOnly
 - 2.16
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
Enable boolean W Enables or disables the Syslog service. - 2.17
Status string R

Indicates the syslog service operational state.

Enumeration of:

  • Disabled (Indicates that the Syslog service is disabled)
  • Enabled (Indicates that the Syslog service is enabled)
  • Error (Indicates that the Syslog service has encountered an error, OPTIONAL)
 - 2.17
FilterNumberOfEntries unsignedInt R The number of entries in the Filter table. - 2.17
SourceNumberOfEntries unsignedInt R The number of entries in the Source table. - 2.17
TemplateNumberOfEntries unsignedInt R The number of entries in the Template table. - 2.17
ActionNumberOfEntries unsignedInt R The number of entries in the Action table. - 2.17
Device.Syslog.Filter.{i}. object(0:) W

This table defines the processing used to select log messages by comparing syslog message with the provided rules.

A rule can consist either of FacilityLevel - Severity and or PatternMatch.

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

 - 2.17
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t 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)
 All 2.17
Severity string W

Specifies the Severity level filter rules.

Defines the processing used to select log messages by comparing syslog message severity using the following processing rules:

  • if ‘none’, do not match.
  • if ‘all’, match.
  • else compare message severity with the specified severity according to the default compare rule (all messages of the specified severity and greater match).

This must be used inconjuction with SeverityCompare and SeverityCompareAction.

Enumeration of:

  • Emergency (Indicates that the system is unusable)
  • Alert (Indicating that an action must be taken immediately)
  • Critical (Indicates a critical condition)
  • Error (Indicates a errors condition)
  • Warning (Indicates a warning condition)
  • Notice (Indicates a informational message)
  • Debug (Indicates a debug-level message)
  • All (All severities are selected)
  • None (No filtering will be applied)
 All 2.17
SeverityCompare string W

Describes the comparison method that must be applied when a syslog message is received. Not applicable when severity All and None is configured.

Enumeration of:

  • Equal (Specifies that the severity comparison operation will be equals)
  • EqualOrHigher (Specifies that the severity comparison operation will be equals or higher.“)
 EqualOrHigher 2.17
SeverityCompareAction string W

Specifies the process of handling a syslog message based on specified conditions. It defines the action that will be taken when the criteria of both Severity and SeverityCompare are met, determining the response to the syslog message.

Enumeration of:

  • Log (When the selected comparison is true the syslog message will be logged)
  • Block (When the selected comparison is true the syslog message will not be logged)
  • Stop (When the select comparison is true the syslog message will not be logged and no further processing will occur.“)
 Log 2.17
PatternMatch string W Regular expression pattern designed to match a syslog message that must be logged. The format is implementation specific. <Empty> 2.17
Device.Syslog.Source.{i}. object(0:) W

This table describes where and how the syslog service receives log messages.

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

 - 2.17
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

 - 2.17
KernelMessages boolean W This option enables the collection of kernel log messages that are specific to the Device. true 2.17
SystemMessages boolean W This option enables the collection of the system log messages that are specific to the Device. true 2.17
Severity string W

Specifies the default Severity. When an incoming message lacks a valid syslog header, this parameter can be used to configure the required Severity level.

Enumeration of:

  • Emergency (Indicates that the system is unusable)
  • Alert (Indicating that an action must be taken immediately)
  • Critical (Indicates a critical condition)
  • Error (Indicates a errors condition)
  • Warning (Indicates a warning condition)
  • Notice (Indicates a informational message)
  • Debug (Indicates a debug-level message)
  • All (All severities are selected)
  • None (No filtering will be applied)
 All 2.17
FacilityLevel string W

Specifies the default Facility Level. When an incoming message lacks a valid syslog header, this parameter can be used to configure the required Facility level.

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)
 All 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
Enable boolean W Enables or disables the functionality to receive 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.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
Port unsignedInt(1:65535) W Specifies the port number on which the syslog information will be received. 1099 2.17
Protocol string W

The protocol to be used for receiving syslog information.

Enumeration of:

 UDP 2.17
Device.Syslog.Template.{i}. object(0:) W

This table the describes the templates that can be referenced by objects that can use the template syntax. With templates, you have the flexibility to establish uniform message formats or even define standard filenames for different objects.

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

 - 2.17
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

 - 2.17
Expression string W Describes the template syntax used for transforming the syslog message. The format is implementation specific and can consist of strings, macros, and template functions. <Empty> 2.17
EscapeMessage boolean W Enabling this option will cause the following characters to be escaped ’, “ and . in the syslog message. false 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 choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.17
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t 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. <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.

 <Empty> 2.17
TemplateRef string(:256) W

The value MUST be the Path Name of a row in the Template. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The Template associated with the Action entry.

When no Template is specified the log message will not be altered by the template system.

 <Empty> 2.17
StructuredData boolean W This feature represents the ability to log messages in structured-data format. Reference [The Syslog Protocol/RFC5424]. false 2.17
Device.Syslog.Action.{i}.LogFile. object R This object describes the configuration parameters for file logging. If file-archive limits are not supplied, it is assumed that the local implementation defined limits will be used. - 2.17
Enable boolean W Enables or disables the LogFile functionality. - 2.17
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.17
FilePath string W Destination path and filename of where to create and keep the logfiles. Which MUST use the uri scheme file [The file URI Scheme/RFC8089]. - 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
Enable boolean W Enables or disables the LogRemote functionality. - 2.17
Address string W Host name or IP address of the remote server. <Empty> 2.17
Protocol string R

Protocol to be used to deliver the syslog messages to the remote server.

Enumeration of:

 - 2.17
Port unsignedInt(1:65535) W Port number of the remote server. 514 2.17
Certificate string W The value MUST be the Path Name of a row in the Security.Certificate. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Certificate that must be used by the syslog service. <Empty> 2.17
PeerVerify boolean W

Ensures authentic and secure connections by validating entity credentials such as certificates or tokens. Only applicable when TLS

In order to validate a certificate, the entire certificate chain, including the CA certificate, must be valid. If any certificate in the chain is found to be invalid, the syslog service must reject the connection.

 false 2.17
Device.USPAgent. object R This object contains general information about the USP Agent itself. For information related to the Device that hosts the Agent, please reference the DeviceInfo object. - 2.15
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.

Changes in 2.17:

  • Changed status = deprecated ⇒ obsoleted

)

 - 2.15
SupportedFingerprintAlgorithms string[] R

Comma-separated list of strings, each entry is an algorithm for calculating firgerprintsfingerprints that is supported by the Agent.

Each list item is an enumeration of:

  • SHA-1 (As specified in [RFC3174])
  • SHA-224 (As specified in [RFC6234])
  • SHA-256 (As specified in [RFC6234])
  • SHA-384 (As specified in [RFC6234])
  • SHA-512 (As specified in [RFC6234])
 - 2.15
Device.USPAgent.MTP.{i}. object(0:) W

Each instance of this table represents a MTP used by the local Agent.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.15
Protocol string W

The value MUST be a member of the list reported by the SupportedProtocols parameter. The Message TransportTransfer Protocol (MTP) to be used for communications by a USP Endpoint.

This parameter discriminates between the CoAP, STOMP, WebSocket, MQTT, UDS union objects.

 - 2.15
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 restriced to the set of interfaces associated with this MTP instance and the interfaces defined by the {{param: non-existent .DNS.SD.Advertise.{i}.Interface}} parameter.

 true 2.15
Device.USPAgent.MTP.{i}.CoAP. object(0:1) R
If the USP Endpoint uses the CoAP Message TransportTransfer 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 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.17:

  • Changed status = deprecated ⇒ obsoleted
 - 2.15
IsEncrypted boolean R
This parameter represents whether or not communications that utilize this CoAP object instance are encrypted.
This parameter was DEPRECATED in 2.14 because the EnableEncryption parameter will dictate whether all connections to this CoAP server instance are or are not encrypted.
This parameter was OBSOLETED in 2.16.
This parameter was DELETED in 2.17.

Changes in 2.17:

  • Changed status = obsoleted ⇒ deleted
 - 2.15
Device.USPAgent.MTP.{i}.STOMP. object(0:1) R

If the USP Endpoint uses the STOMP Message TransportTransfer Protocol (MTP), then this object contains STOMP Client specific configuration parameters related to how the Agent communicates with the STOMP Server.

This object MUST be present if, and only if, Protocol is STOMP.

This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time.

 - 2.15
Device.USPAgent.MTP.{i}.WebSocket. object(0:1) R

If the USP Endpoint uses the WebSocket Message TransportTransfer Protocol (MTP) as a WebSocket server, then this object contains WebSocket specific configuration parameters.

This object MUST be present if, and only if, Protocol is WebSocket.

This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time.

 - 2.15
Port unsignedInt(1:65535) W The port number used by the WebSocket Server to receive USP messages.

Changes in 2.17:

  • Changed default value = 5683 ⇒ 8443
 8443 2.15
Device.USPAgent.MTP.{i}.MQTT. object(0:1) R

If the USP Endpoint uses the MQTT Message TransportTransfer Protocol (MTP), then this object contains MQTT Client specific configuration parameters related to how the Agent communicates with the MQTT broker.

This object MUST be present if, and only if, Protocol is MQTT.

This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time.

 - 2.15
Device.USPAgent.MTP.{i}.UDS. object(0:1) R

If the USP Endpoint uses the Unix Domain Socket (UDS) Message Transfer Protocol (MTP), then this object contains UDS Client specific configuration parameters related to how thethis Agent communicates with thea UDSController Server.on another USP Endpoint.

An example of how to set up this MTP can be found in [Section “Example Data Models for a USP Broker and USP Services”/TR-369].

This object MUST be present if, and only if, Protocol is UDS.

This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time.

 - 2.16
Device.USPAgent.Controller.{i}. object(0:) W

Each instance of this table represents a USP Controller that has access to this USP Agent.

On the deletion of an entry from this table, the Agent MUST send the ObjectDeletion notification to all subscribed recipients, even if the recipient is the deleted Controller itself. This notification is the last notification sent to this Controller.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for EndpointID.

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.15
Device.USPAgent.Controller.{i}.MTP.{i}. object(0:) W

Each instance of this table represents a MTP used by this Controller.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Protocol.

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.15
Protocol string W

The value MUST be a member of the list reported by the SupportedProtocols parameter. The Message TransportTransfer Protocol (MTP) to be used for communications by a USP Endpoint.

This parameter discriminates between the CoAP, STOMP, WebSocket, MQTT, UDS union objects.

 - 2.15
Device.USPAgent.Controller.{i}.MTP.{i}.CoAP. object(0:1) R
If the USP Endpoint uses the CoAP Message TransportTransfer 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 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.17:

  • Changed status = deprecated ⇒ obsoleted
 - 2.15
Device.USPAgent.Controller.{i}.MTP.{i}.STOMP. object(0:1) R

If the USP Endpoint uses the STOMP Message TransportTransfer Protocol (MTP), then this object contains STOMP Client specific configuration parameters related to how this Controller communicates with the STOMP Server.

This object MUST be present if, and only if, Protocol is STOMP.

This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time.

 - 2.15
Device.USPAgent.Controller.{i}.MTP.{i}.WebSocket. object(0:1) R

If the USP Endpoint uses the WebSocket Message TransportTransfer Protocol (MTP) as a WebSocket client, then this object contains WebSocket specific configuration parameters.

This object MUST be present if, and only if, Protocol is WebSocket.

This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time.

 - 2.15
IsEncrypted boolean R
This parameter represents whether or not communications that utilize this WebSocket object instance are encrypted.
This parameter was DEPRECATED in 2.14 because the EnableEncryption parameter will dictate whether this WebSocket is or is not encrypted.
This parameter was OBSOLETED in 2.16.
This parameter was DELETED in 2.17.

Changes in 2.17:

  • Changed status = obsoleted ⇒ deleted
 - 2.15
Device.USPAgent.Controller.{i}.MTP.{i}.MQTT. object(0:1) R

If the USP Endpoint uses the MQTT Message TransportTransfer Protocol (MTP), then this object contains MQTT Client specific configuration parameters related to how this Controller communicates with the MQTT broker.

This object MUST be present if, and only if, Protocol is MQTT.

This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time.

 - 2.15
Device.USPAgent.Controller.{i}.MTP.{i}.UDS. object(0:1) R

If the USP Endpoint uses the Unix Domain Socket (UDS) Message TransportTransfer Protocol (MTP), then this object contains UDS Client specific configuration parameters related to how thethis ControllerAgent communicates with thea UDSController Server.on another USP Endpoint.

An example of how to set up this MTP can be found in [Section “Example Data Models for a USP Broker and USP Services”/TR-369].

This object MUST be present if, and only if, Protocol is UDS.

This object is a member of a union, i.e., it is a member of a group of objects of which only one can exist at a given time.

 - 2.16
Device.USPAgent.Certificate.{i}. object(0:) R

Each instance of this table represents information related to a X.509 certificate (see [RFC5280]) of a Controller or Certificate Authority. Instances are referenced from Controller.{i}.Credential and ControllerTrust.Credential.{i}.Credential.

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

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.15
Device.USPAgent.ControllerTrust. object R This object contains information that an Agent applies when establishing a trust relationship with a Controller. - 2.15
Device.USPAgent.ControllerTrust.Role.{i}. object(0:) W

Each instance of this table represents a Role that can be assigned to or inherited by a Controller via the Controller Trust mechanism. The Role contains a set of permissions that determine how the Controller can interact with the data model.

If multiple permission entries associated with this table contain a Target that evaluates to the same instantiated Object/Parameter for multiple Roles, then the permissions to be used are a union of the identified permissions.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name.

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.15
Device.USPAgent.ControllerTrust.Role.{i}.Permission.{i}. object(0:) W

Each instance of this table represents the permissions that are extended to a set of Targets for a specified Role.

If there are multiple entries in this table for a specific Role where the Targets overlap, the permissions for the entry with the highest value takes priority over all others.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Order.

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.15
Device.USPAgent.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 Role entry is automatically applied to the Controller.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Credential.

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.15
Device.USPAgent.ControllerTrust.Challenge.{i}. object(0:) W

Each instance of this table represents information that is used to challenge a Controller in order to assign a Role to the Controller or to determine the authenticity of a Certificate.

The Controller requests a type of challenge from an Agent using the RequestChallenge command.

The Agent returns the value of the Instruction for that type of challenge to the Controller which the Controller then provides a third-party.

The third-party responds to the Instruction which the Controller then sends to the Agent using the ChallengeResponse command.

The Agent verifies the response to the Challenges and executes an implementation specific Agent logic in order to establish trust with the Controller.

This could include (but is not limited to):

*Assignment of roles to the Controller is done by appending the non-duplicate roles of the Role parameter to the value of the Controller.{i}.AssignedRole parameter.

*Use the Controller’s certificate to which the challenge response was received in order to authenticate the identity of the Controller.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.15
Device.ETSIM2M. object R The ETSIM2M object represents the management object for the Remote Entity Functions (REM) functions defined in the M2M Functional Architecture [ETSIM2MFA]. - 2.6
Device.ETSIM2M.SCL.{i}. object(0:) W

This object represents an instance of a Service Capability Layer (SCL) for a M2M device or gateway.

The SCL MAY be maintained by the ACS or by the CPE.

When the SCL provides the administration of an SCL that is represented as a SoftwareModules.ExecutionUnit the SCL is maintained in the SoftwareModules.ExecutionUnit.{i}.References parameter.

Section 5.1.2 of the M2M Functional Architecture [ETSIM2MFA] describes the high level event flows for SCL registration.

Section 9.3.2.6.2 of the M2M Functional Architecture [ETSIM2MFA] describes the creation/registration of SCLs.

Section 9.3.2.6.4 of the M2M Functional Architecture [ETSIM2MFA] describes the update/re-registration of SCLs.

Section 9.3.2.6.5 of the M2M Functional Architecture [ETSIM2MFA] describes the deletion/deregistration of SCLs.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.6
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}. object(0:) W

This object describes the parameters necessary to administer the store-and-forward (SAF) handling policies applied to requests to access remotely hosted resources.

Policies are described by instances of SAFPolicySet. Which instances of SAFPolicySet are used by the SCL is determined by the PolicyScope parameter.

Section 9.3.1.5 of the M2M Functional Architecture [ETSIM2MFA] and Section 10.3.1.2.2 of the M2M mIa, dIa and mId Interfaces [ETSIM2MInterfaces] describe the behavior for SAF processing.

There is at most one SAFPolicySet instance with the PolicyScope containing a specific application id (APP-ID) URI value within the list.

There is exactly one SAFPolicySet instance with a PolicyScope value of “default”.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.6
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.ANPPolicy.{i}. object(0:) W

This table contains the SAF-handling policies which are controlled by the Access Network Provider(s).

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for ANName.

 - 2.6
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.ANPPolicy.{i}.BlockPeriod.{i}. object(0:) W

This table contains a list of block periods for a ANPPolicy.

A block period defines how long the device will wait before re-trying to establish connectivity via the access network after the previous attempt has failed.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for FailedAttempts.

 - 2.6
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.ANPPolicy.{i}.RequestCategory.{i}. object(0:) W

This table contains the Request Category (RCAT) policy items for defining when it is appropriate to use the access network for processing requests.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for RCAT.

 - 2.6
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.ANPPolicy.{i}.RequestCategory.{i}.Schedule.{i}. object(0:) W

This table contains the schedules that define when it is appropriate to use the access network for processing requests for the specified value of the RCAT.

The combination of all instances of the AbsTimeSpan along with the Schedules parameter makes up the complete schedule for this instance of a Schedule.

The Schedules parameter defines a recurrence of the schedule. If instances of AbsTimeSpan exist, these instances places constraints on the schedule recurrence.

If the value of the Schedules parameter is an empty string, at least one enabled instance of AbsTimeSpan MUST exist.

Processing behavior for the use of RCAT Schedules is defined in section 10.3.1.2.2 of the M2M mIa, dIa and mId Interfaces [ETSIM2MInterfaces] document.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.6
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.ANPPolicy.{i}.RequestCategory.{i}.Schedule.{i}.AbsTimeSpan.{i}. object(0:) W

This object defines an instance of a time span used for determining an RCAT schedule.

An instance of the AbsTimeSpan represents the time span in which the schedule recurrence defined in Schedules is constrained.

AbsTimeSpan instances with unknown values for the StartTime or EndTime are ignored.

All instances of the AbsTimeSpan within this Schedule MUST utilize the same time zone.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.6
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.M2MSPPolicy. object R This object maintains the SAF handling policies’ properties that are controlled by the M2M service provider for a request. - 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.M2MSPPolicy.RequestCategory.{i}. object(0:) W

This object maintains a list of properties to be used for forwarding requests with a specified RCAT.

Processing behavior for the use of M2M Service Provider policies is defined in section 10.3.1.2.2.1 of the M2M mIa, dIa and mId Interfaces [ETSIM2MInterfaces] document.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for RCAT.

 - 2.6
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.6
Device.STOMP. object R The STOMP represents the STOMP capabilities of the device as described in [TR-369]. - 2.15
Device.STOMP.Connection.{i}. object(0:) W

The Connection represents a STOMP connection between the Agent and a STOMP server.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of Host, Username and VirtualHost.

 - 2.15
Alias string(:64) WO

[Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.

If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a “cpe-” prefix.
  • The CPE MUST NOT change the parameter value.

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

The Agent MUST choose an initial value that doesn’t conflict with any existing entries.

Changes in 2.17:

  • Changed access = readWrite ⇒ writeOnceReadOnly
 - 2.15
IsEncrypted boolean R
This parameter represents whether or not communications that utilize this Connection object instance are encrypted.
This parameter was DEPRECATED in 2.14 because the EnableEncryption parameter will dictate whether all connections for this STOMP instance are or are not encrypted.
This parameter was OBSOLETED in 2.16.
This parameter was DELETED in 2.17.

Changes in 2.17:

  • Changed status = obsoleted ⇒ deleted
 - 2.15

Generated by Broadband Forum bbfreport v2.2.0 (2024-07-23 version) on 2024-09-04 at 10:49:17 UTC.
report.py –include ../../install/cwmp –output –transform diff –format markdown tr-181-2-16-0-cwmp.xml tr-181-2-17-0-cwmp.xml

Table of Contents