Broadband Forum

USP Device:2.12 Root Object definition (changes)

tr-181-2-12-0-usp.xml

DATA MODEL DEFINITION

License

Copyright (c) 2010-2018, Broadband Forum

The undersigned members have elected to grant the copyright to their contributed material used in this software:
    Copyright (c) 2017-2018 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.
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])
JSONObject string A JSON Object as defined in [Section 4/RFC7159].
MACAddress string(:17)

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

Possible patterns:

  • <Empty> (an empty string)
  • ([0-9A-Fa-f][0-9A-Fa-f]:){5}([0-9A-Fa-f][0-9A-Fa-f])
PSMBreakPointIndexAndLevel unsignedInt[2:2]
  1. The PSM breakpoint sub-carrier index in the range [0:4095], and
  2. the value of the level of the PSM at this sub-carrier expressed in 0.1 dBm/Hz with an offset of -140 dBm/Hz. Both values are represented as unsignedInt. [Clause 5.2/G.9964] defines limits on PSM breakpoint levels.
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.

UUID string(36)

Universally Unique Identifier. See [RFC4122].

Possible patterns:

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

References

[802.11-2007] IEEE Std 802.11-2007, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, 2007.
[802.11-2012] IEEE Std 802.11-2012, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, March 2012.
[802.11a-1999] IEEE Std 802.11a-1999, High-speed Physical Layer in the 5 GHz band, IEEE, 1999.
[802.11ac-2013] IEEE Std 802.11ac-2013, Enhancements for Very High Throughput for Operation in Bands below 6 GHz, IEEE, December 2013.
[802.11b-1999] IEEE Std 802.11b-1999, Higher Speed Physical Layer Extension in the 2.4 GHz band, IEEE, 1999.
[802.11g-2003] IEEE Std 802.11g-2003, Further Higher Data Rate Extension in the 2.4 GHz Band, IEEE, 2003.
[802.11n-2009] IEEE Std 802.11n-2009, Amendment 5: Enhancements for Higher Throughput, IEEE, 2009.
[802.1AB-2009] IEEE Std 802.1AB-2009, Station and Media Access Control Connectivity Discovery, IEEE, 2009.
[802.1ad-2005] IEEE Std 802.1ad-2005, Virtual Bridged Local Area Networks Amendment 4: Provider Bridges, IEEE, May 2005.
[802.1AX-2014] IEEE Std 802.1AX-2014, IEEE Standard for Local and metropolitan area networks - Link Aggregation, IEEE, 2014.
[802.1D-2004] IEEE Std 802.1D-2004, Media Access Control (MAC) Bridges, IEEE, 2004.
[802.1Q-2005] IEEE Std 802.1Q-2005, Virtual Bridged Local Area Networks, IEEE, 2006.
[802.1Q-2011] IEEE Std 802.1Q-2011, MAC Bridges and Virtual Bridge Local Area Networks, IEEE, 2011.
[802.1x-2004] IEEE Std 802.1x-2004, Standards for Local and Metropolitan Area Networks: Port based Network Access Control, IEEE, 2004.
[802.3-2015] IEEE Std 802.3-2015, IEEE Standard for Ethernet, IEEE, 2015.
[DNS-SD] RFC 6763, DNS-Based Service Discovery, IETF, 2013.
[DSLite] RFC 6333, Dual-Stack Lite Broadband Deployments Following IPv4 Exhaustion, IETF, 2011.
[ETSIBRAN] ETSI EN 301 893, Broadband Radio Access Networks (BRAN); 5 GHz high performance RLAN; Harmonized EN covering the essential requirements of article 3.2 of the RTTE Directive, ETSI.
[G.993.1] G.993.1, Very high speed digital subscriber line transceivers, ITU-T.
[G.993.2] G.993.2, Very high speed digital subscriber line transceivers 2 (VDSL2), ITU-T.
[G.9954] G.9954, Phoneline networking transceivers - Enhanced physical, media access, and link layer specifications (HPNA 3.0 and 3.1), ITU-T, 2007.
[G.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.
[G.9973] G.9973, Protocol for identifying home network topology, ITU-T, 2011.
[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.
[IPDR-SP] IPDR Streaming Protocol, IPDR Streaming Protocol (IPDR/SP) Specification, TM Forum.
[JJ-300.00] JJ-300.00, Home-network Topology Identifying Protocol, TTC, 2011.
[LMAPIFM] RFC 8193, Information Model for Large-Scale Measurement Platforms (LMAPs), IETF, August 2017.
[LMAPREG] draft-ietf-ippm-metric-registry-12, Registry for Performance Metrics, IETF, June 30, 2017.
[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.
[MQTT31] MQTT v3.1, MQ Telemetry Transport (MQTT) V3.1 Protocol Specification, 2010.
[MQTT311] MQTT Version 3.1.1, MQTT v3.1.1, OASIS Message Queuing Telemetry Transport (MQTT) TC, October 2014.
[OUI] Organizationally Unique Identifiers (OUIs).
[RFC1332] RFC 1332, The PPP Internet Protocol Control Protocol (IPCP), IETF, 1992.
[RFC1661] RFC 1661, The Point-to-Point Protocol (PPP), IETF, 1994.
[RFC1877] RFC 1877, PPP Internet Protocol Control Protocol Extensions for Name Server Addresses, IETF, 1995.
[RFC2131] RFC 2131, Dynamic Host Configuration Protocol, IETF.
[RFC2616] RFC 2616, Hypertext Transfer Protocol - HTTP/1.1, IETF, 1999.
[RFC2784] RFC 2784, Generic Routing Encapsulation (GRE), IETF, November 2000.
[RFC2863] RFC 2863, The Interfaces Group MIB, IETF, 2000.
[RFC2890] RFC 2890, Key and Sequence Number Extensions to GRE, IETF, November 2000.
[RFC3174] RFC 3174, US Secure Hash Algorithm 1 (SHA1), IETF, September, 2001.
[RFC3315] RFC 3315, Dynamic Host Configuration Protocol for IPv6 (DHCPv6), IETF, 2003.
[RFC3339] RFC 3339, Date and Time on the Internet: Timestamps, IETF, July, 2002.
[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.
[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.
[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.
[RFC6234] RFC 6234, US Secure Hash Algorithms (SHA and SHA-based HMAC and HKDF), IETF, May, 2011.
[RFC6455] RFC 6455, The WebSocket Protocol, IETF, December 2011.
[RFC6762] RFC 6762, Multicast DNS, IETF, February 2013.
[RFC6838] RFC 6838, Media Type Specifications and Registration Procedures, IETF, January 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.
[RFC7348] RFC 7348, Virtual eXtensible Local Area Network (VXLAN), IETF, August 2014.
[RFC7395] RFC 7395, An Extensible Messaging and Presence Protocol (XMPP) Subprotocol for WebSocket, IETF, October 2014.
[RFC7398] RFC 7398, A Reference Path and Measurement Points for Large-Scale Measurement of Broadband Performance, IETF, February 2015.
[RFC7594] RFC 7594, A Framework for Large-Scale Measurement of Broadband Performance (LMAP), IETF, September 2015.
[RFC7597] RFC 7597, Mapping of Address and Port with Encapsulation (MAP), IETF, July 2015.
[RFC7598] RFC 7598, DHCPv6 Options for configuration of Softwire Address and Port Mapped Clients, IETF, July 2015.
[RFC7599] RFC 7599, Mapping of Address and Port using Translation (MAP-T), IETF, July 2015.
[RFC8141] RFC 8141, Uniform Resource Names (URNs), IETF, April 2017.
[RFC862] RFC 862, Echo Protocol, IETF, 1983.
[RFC959] RFC 959, File Transfer Protocol, IETF, 1985.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[STOMP1.2] STOMP Protocol Specification, STOMP Protocol Specification, Version 1.2.
[TR-069] TR-069 Amendment 6, CPE WAN Management Protocol, Broadband Forum, April 2018.
[TR-069a5] TR-069 Amendment 5, CPE WAN Management Protocol, Broadband Forum, December 2013.
[TR-106a2] TR-106 Amendment 2, Data Model Template for TR-069-Enabled Devices, Broadband Forum, November 2008.
[TR-106a7] TR-106 Amendment 7, Data Model Template for TR-069-Enabled Devices, Broadband Forum, September 2013.
[TR-143a1] TR-143 Amendment 1, Enabling Network Throughput Performance Tests and Statistical Monitoring, Broadband Forum, December 2014.
[TR-157] TR-157 Amendment 10, Component Objects for CWMP, Broadband Forum, November 2015.
[TR-157a10] TR-157 Amendment 10, Component Objects for CWMP, Broadband Forum, November 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-181i2a2] TR-181 Issue 2 Amendment 2, Device Data Model for TR-069, Broadband Forum, February 2011.
[TR-181i2a5] TR-181 Issue 2 Amendment 5, Device Data Model for TR-069, Broadband Forum, 2012.
[TR-181i2a8] TR-181 Issue 2 Amendment 8, Device Data Model for TR-069, Broadband Forum, September 2014.
[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.
[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.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

Legend

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

Device:2.12 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.12:

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

Changes in 2.12:

 - 2.0
ProxiedDeviceNumberOfEntries unsignedInt R The number of entries in the ProxiedDevice table. - 2.12
Reboot() command - Reboot the entity associated with the containing Device. - 2.12
Boot! event - Boot event indicating that the Device was rebooted. - 2.12
⇒ CommandKey string R The command_key supplied when requesting the boot, or an empty string if the boot was not requested via a USP operation. - 2.12
⇒ Cause string R

The cause of the boot.

Enumeration of:

  • LocalReboot
  • RemoteReboot
  • LocalFactoryReset
  • RemoteFactoryReset
 - 2.12
⇒ FirmwareUpdated boolean R true if the firmware was updated as a result of the boot that caused this Event Notification; otherwise false. - 2.12
⇒ ParameterMap string R Boot parameters configured via the recipient Controller’s LocalAgent.Controller.{i}.BootParameter table. Formatted as a [JSONObject] A JSON Object as defined in [Section 4/RFC7159]. - 2.12
FactoryReset() command - Factory reset the entity associated with the containing Device. - 2.0
SelfTestDiagnostics() command - [ASYNC] This diagnostics test is vendor-specific and MAY include testing hardware, software, and/or firmware. - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Results string(:1024) R Results of self-test (vendor specific). - 2.0
Device.DeviceInfo. object R This object contains general device information.

Changes in 2.12:

 - 2.12
ManufacturerOUI string(6) R

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

  • [0-9A-F]{6} The value MUST be a valid OUI as defined in [OUI]. This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it’s a new deviceAgent and would therefore require a BOOTSTRAPBoot! Inform.Event with a LocalFactoryReset enumerated value in the Boot!.Cause argument.
 - 2.0
CID string(6) R

Company identifier assigned and registered by the IEEE Registration Authority to the entity responsible for this Agent. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. Possible patterns:

  • [0-9A-F]{6} This value MUST remain fixed over the lifetime of the Agent, including across firmware updates. Any change would indicate that it’s a new Agent and would therefore require a Boot! Event with a LocalFactoryReset enumerated value in the Boot!.Cause argument.
 - 2.12
SoftwareVersion string(:64) R A string identifying the software version currently installed in the CPE (i.e. version of the overall CPE 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. For CPEs that support multiple firmware images, the value for this parameter MUST be the software version of the active firmware image. - 2.0
ActiveFirmwareImage string R A full path reference to the row in the FirmwareImage table representing the currently running firmware image. - 2.12
BootFirmwareImage string W A full path reference to the row in the FirmwareImage table of the firmware image that is to be loaded the next time the device boots. This parameter value cannot be empty and must point to a valid and enabled FirmwareImage object where the (FirmwareImage.{i}.Available parameter is set to ‘true’). Out of the factory, this parameter should be set to point to the firmware image the CPE will attempt to boot when first powered on. The firmware image instance referenced by this parameter must also have an Available parameter value of ‘true’. Attempting to set this parameter to point to a non-enabled firmware image MUST result in the CPE responding with a CWMP fault (9007). In situations where the CPE cannot boot the firmware image specified by this parameter and manages to boot a different firmware image, the CPE MUST NOT modify this value to point to the alternate firmware image that is currently active. - 2.12
FirmwareImageNumberOfEntries unsignedInt R The number of entries in the FirmwareImage table. - 2.12
FriendlyName string(:32) W The friendly name of the device. In [TR-369] the friendly name is used during the advertisement of an endpoint - see section IANA-Registered USP Service Names of [TR-369]. - 2.12
PEN string(:10) R Private Enterprise Number assigned and registered by IANA to the entity responsible for this Agent. Represented as a decimal encoding of the IANA-assinged number. This value MUST remain fixed over the lifetime of the Agent, including across firmware updates. Any change would indicate that it’s a new Agent and would therefore require a Boot! Event with a LocalFactoryReset enumerated value in the Boot!.Cause argument. - 2.12
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 ACS 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.

Changes in 2.12:

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Backup() command - [ASYNC] This command is issued to upload the configuration file specified by this VendorConfigFile instance. All results of the actual upload will be contained within the Device.LocalAgent.TransferComplete! event. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ URL string(:256) W [MANDATORY] URL, as defined in [RFC3986], specifying the destination file location. HTTP and HTTPS transports MUST be supported. This argument specifies only the destination file location, and does not indicate in any way the name or location of the local file to be uploaded. If the Agent receives multiple upload requests with the same URL, the Agent MUST perform each upload as requested, and MUST NOT assume that the content of the file to be uploaded is the same each time. This URL MUST NOT include the “userinfo” component, as defined in [RFC3986]. - 2.12
⇒ Username string(:256) W [MANDATORY] Username to be used by the Agent to authenticate with the file server. This string is set to an empty string if no authentication is required. - 2.12
⇒ Password string(:256) W [MANDATORY] Password to be used by the Agent to authenticate with the file server. This string is set to an empty string if no authentication is required. - 2.12
Restore() command - [ASYNC] This command is issued to download a configuration file into this VendorConfigFile instance. All results of the actual download will be contained within the Device.LocalAgent.TransferComplete! event. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ URL string(:256) W [MANDATORY] URL, as defined in [RFC3986], specifying the source file location. HTTP and HTTPS transports MUST be supported. If the Agent receives multiple download requests with the same source URL, the Agent MUST perform each download as requested, and MUST NOT assume that the content of the file to be downloaded is the same each time. This URL MUST NOT include the “userinfo” component, as defined in [RFC3986]. - 2.12
⇒ Username string(:256) W [MANDATORY] Username to be used by the Agent to authenticate with the file server. This string is set to an empty string if no authentication is required. - 2.12
⇒ Password string(:256) W [MANDATORY] Password to be used by the Agent to authenticate with the file server. This string is set to an empty string if no authentication is required. - 2.12
⇒ FileSize unsignedInt W The size of the file to be downloaded in bytes. The FileSize argument is intended as a hint to the Agent, which the Agent MAY use to determine if it has sufficient space for the file to be downloaded, or to prepare space to accept the file. The Controller MAY set this value to zero. The Agent MUST interpret a zero value to mean that that the Controller has provided no information about the file size. In this case, the Agent MUST attempt to proceed with the download under the presumption that sufficient space is available, though during the course of download, the Agent might determine otherwise. The Controller SHOULD set the value of this Parameter to the exact size of the file to be downloaded. If the value is non-zero, the Agent MAY reject the ScheduleDownload request on the basis of insufficient space. If the Agent attempts to proceed with the download based on the value of this argument, but the actual file size differs from the value of this argument, this could result in a failure of the download. However, the Agent MUST NOT cause the download to fail solely because it determines that the value of this argument is inaccurate. - 2.12
⇒ TargetFileName string(:256) W The name of the file to be used on the target file system. This argument MAY be an empty string if the target file name can be extracted from the downloaded file itself, or from the URL argument, or if no target file name is needed. If this argument is specified, but the target file name is also indicated by another source (for example, if it is extracted from the downloaded file itself), this argument MUST be ignored. If the target file name is used, the downloaded file would replace any existing file of the same name (whether or not the Agent archives the replaced file is a local matter). If present, this Parameter is treated as an opaque string with no specific requirements for its format. That is, the TargetFileName value is to be interpreted based on the Agent’s vendor-specific file naming conventions. Note that this specification does not preclude the use of a file naming convention in which the file’s path can be specified as part of the file name. - 2.12
⇒ CheckSumAlgorithm string W

The hash algorithm to use when performing a checksum validation of the downloaded file. If the CheckSum input argument is specified, the Agent MUST validate the integrity of the downloaded file by comparing the value contained in the CheckSum input argument against a hash of the downloaded file.

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.12
⇒ CheckSum hexBinary W The hash value of the downloaded file used to validate the integrity of the downloaded file. If this argument is specified, the Agent MUST validate the integrity of the downloaded file by comparing the provided value against a hash of the downloaded file using the hashing algorithm specified in the CheckSumAlgorithm input argument. If this argument is an empty string, the Agent MUST NOT perform a checksum validation of the downloaded file. - 2.12
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.

Changes in 2.12:

  • Removed {{param: non-existent Reset ::: parameter
  • Added Reset() command}}
 - 2.0
Reset() command - Resets the temperature sensor. - 2.12
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 ACS 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.

Changes in 2.12:

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.1
Upload() command - [ASYNC] This command is issued to upload the log file specified by this Vendor Log File instance. All results of the actual upload will be contained within the Device.LocalAgent.TransferComplete! event. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ URL string(:256) W [MANDATORY] URL, as defined in [RFC3986], specifying the destination file location. HTTP and HTTPS transports MUST be supported. This argument specifies only the destination file location, and does not indicate in any way the name or location of the local file to be uploaded. If the Agent receives multiple upload requests with the same URL, the Agent MUST perform each upload as requested, and MUST NOT assume that the content of the file to be uploaded is the same each time. This URL MUST NOT include the “userinfo” component, as defined in [RFC3986]. - 2.12
⇒ Username string(:256) W [MANDATORY] Username to be used by the Agent to authenticate with the file server. This string is set to an empty string if no authentication is required. - 2.12
⇒ Password string(:256) W [MANDATORY] Password to be used by the Agent to authenticate with the file server. This string is set to an empty string if no authentication is required. - 2.12
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) 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.

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

 - 2.12
Name string(:64) R Firmware/software image name. Descriptive text of the image or filename. The value of Name is an empty string if Status is anything other than Available, InstallationFailed, or ActivationFailed. - 2.12
Version string(:64) R A string identifying the version of the firmware image represented by this FirmwareImage. Whenever this firmware image is active (ie, the device has booted this firmware image), the value of the DeviceInfo.SoftwareVersion parameter MUST be the same as the value contained in this parameter. 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. The value of Version is an empty string if Status is anything other than Available, InstallationFailed, or ActivationFailed. - 2.12
Available boolean W Specifies whether or not this particular firmware image can be used by the Agent. An Agent will only attempt to boot this particular firmware image if this parameter value is set to true. This value MUST be set to true whenever a new firmware image is installed. This value cannot be set to false if the firmware image is active or is referenced by the BootFirmwareImage parameter. Firmware image instances cannot be deleted, so a Controller MAY use this parameter to subsequently mark a particular firmware as being invalid, which will prevent the Agent from attempting to boot it. - 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)
  • 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 active this Firmware Image instance, but ultimately failed while being activated)
 - 2.12
BootFailureLog string R If the Agent is unable to boot into this firmware image, when specified, the Agent can use this parameter to record some information as to why the boot failed. If the Agent successfully boots into this firmware, the value of this parameter SHOULD be an empty string. When a new firmware image is installed into this object instance, this parameter MUST be cleared. The length of this string is defined as implementation-specific by the Agent. - 2.12
Download() command - [ASYNC] This command is issued to download a firmware into this Firmware Image instance. All results of the actual download will be contained within the Device.LocalAgent.TransferComplete! event. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ URL string(:256) W [MANDATORY] URL, as defined in [RFC3986], specifying the source file location. HTTP and HTTPS transports MUST be supported. If the Agent receives multiple download requests with the same source URL, the Agent MUST perform each download as requested, and MUST NOT assume that the content of the file to be downloaded is the same each time. This URL MUST NOT include the “userinfo” component, as defined in [RFC3986]. - 2.12
⇒ AutoActivate boolean W [MANDATORY] If true the Agent MUST automatically activate the firmware once it is successfully downloaded. If false the Agent MUST NOT activate the firmware until explicitly instructed to do so by either invoking Activate() or setting BootFirmwareImage and rebooting the Agent. - 2.12
⇒ Username string(:256) W Username to be used by the Agent to authenticate with the file server. This argument is omitted if no authentication is required. - 2.12
⇒ Password string(:256) W Password to be used by the Agent to authenticate with the file server. This argument is omitted if no authentication is required. - 2.12
⇒ FileSize unsignedInt W The size of the file to be downloaded in bytes. The FileSize argument is intended as a hint to the Agent, which the Agent MAY use to determine if it has sufficient space for the file to be downloaded, or to prepare space to accept the file. The Controller MAY set this value to zero. The Agent MUST interpret a zero value to mean that that the Controller has provided no information about the file size. In this case, the Agent MUST attempt to proceed with the download under the presumption that sufficient space is available, though during the course of download, the Agent might determine otherwise. The Controller SHOULD set the value of this Parameter to the exact size of the file to be downloaded. If the value is non-zero, the Agent MAY reject the ScheduleDownload request on the basis of insufficient space. If the Agent attempts to proceed with the download based on the value of this argument, but the actual file size differs from the value of this argument, this could result in a failure of the download. However, the Agent MUST NOT cause the download to fail solely because it determines that the value of this argument is inaccurate. - 2.12
⇒ CheckSumAlgorithm string W

The hash algorithm to use when performing a checksum validation of the downloaded file. If the CheckSum input argument is specified, the Agent MUST validate the integrity of the downloaded file by comparing the value contained in the CheckSum input argument against a hash of the downloaded file.

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.12
⇒ CheckSum hexBinary W The hash value of the downloaded file used to validate the integrity of the downloaded file. If this argument is specified, the Agent MUST validate the integrity of the downloaded file by comparing the provided value against a hash of the downloaded file using the hashing algorithm specified in the CheckSumAlgorithm input argument. If this argument is an empty string, the Agent MUST NOT perform a checksum validation of the downloaded file. - 2.12
Activate() command - [ASYNC] This command is issued to activate this FirmwareImage instance. A FirmwareImage instance can also be activated by setting the Device.DeviceInfo.BootFirmwareImage parameter and causing the Agent to reboot. A successful activation will result in a reboot of the device with this FirmwareImage as the currently running firmware image. Furthermore, this FirmwareImage will be referenced by the Device.DeviceInfo.ActiveFirmwareImage parameter. A failed activation will result in this FirmwareImage instance’s BootFailureLog being updated. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ TimeWindow.{i}. object(1:5) W

The time window(s) that dictate when the Agent activates the firmware image. An Agent MUST be able to accept a request with either one or two TimeWindow instances. The time windows MUST NOT overlap, i.e. if there are two time windows, the second window’s Start value has to be greater than or equal to the first window’s End value.

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

 - 2.12
⇒ Start unsignedInt W [MANDATORY] Start of this time window as an offset in seconds after invoking the command. An offset is used in order to avoid a dependence on absolute time. - 2.12
⇒ End unsignedInt W [MANDATORY] End of this time window as an offset in seconds after invoking the command. An offset is used in order to avoid a dependence on absolute time. - 2.12
⇒ Mode string W

[MANDATORY] Specifies when within this time window the Agent is permitted to activate the specified firmware image.

Enumeration of:

  • AnyTime (The Agent MAY activate the firmware image at any time during the time window even if this results in interruption of service for the subscriber)
  • Immediately (The Agent MUST activate the firmware image immediately at the start of the time window even if this results in interruption of service for the subscriber)
  • WhenIdle (The Agent MUST NOT cause an interruption of service from the subscriber’s standpoint while activating the firmware image during the time window. How the Agent determines this is outside the scope of this specification)
  • ConfirmationNeeded (The Agent MUST ask for and receive confirmation before activating the firmware image. It is outside the scope of this specification how the Agent asks for and receives this confirmation. If confirmation is not received, this time window MUST NOT be used)
 - 2.12
⇒ UserMessage string W A message that informs the user of a request to activate a new firmware image. The Agent MAY use this message when seeking confirmation from the user, e.g. when Mode is ConfirmationNeeded. When there is no need for such a message, it SHOULD be an empty string and MUST be ignored. - 2.12
⇒ MaxRetries int(-1:10) W The maximum number of retries for activating the firmware image before regarding the transfer as having failed. Refers only to this time window (each time window can specify its own value). A value of 0 means “No retries are permitted”. A value of -1 means “the Agent determines the number of retries”, i.e. that the Agent can use its own retry policy, not that it has to retry forever. Only applicable when the Mode input argument is ConfirmationNeeded, otherwise this input argument MUST be ignored. - 2.12
Device.UserInterface. object R This object contains parameters relating to the user interface of the CPE.

Changes in 2.12:

  • Removed {{param: non-existent PasswordReset ::: parameter
  • Added PasswordReset() command}}
 - 2.0
PasswordReset() command - Present only if the Agent provides a password-protected LAN-side user interface and supports LAN-side Auto-Configuration. Reset LANConfigSecurity.ConfigPassword to its factory value. - 2.12
AutoUpdateServer string(:256) W The server the CPE can check to see if an update is available for direct download to it. This MUST NOT be used by the CPE if the {{param: non-existent .ManagementServer.UpgradesManaged}} parameter is true. - 2.0
UserUpdateServer string(:256) W The server where a user can check via a web browser if an update is available for download to a PC. This MUST NOT be used by the CPE if the {{param: non-existent .ManagementServer.UpgradesManaged}} parameter is true. - 2.0
Device.DSL. object R This object models DSL lines, DSL channels, DSL bonding, and DSL diagnostics. The specific interface objects defined here are Line, Channel, and BondingGroup. Each Line models a layer 1 DSL Line interface, and each Channel models a layer 1 DSL Channel interface where multiple channels can run over a DSL line. In the case where bonding is configured, it is expected that BondingGroup is stacked above the Channel instances within its group. - 2.0
Device.DSL.Line.{i}. object(0:) R

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
AllowedProfiles string[] R

Comma-separated list of strings. List items indicate which VDSL2 profiles are allowed on the line. Each list item is an enumeration of:

  • 8a
  • 8b
  • 8c
  • 8d
  • 12a
  • 12b
  • 17a
  • 17b (

Changes in 2.12:

  • Added status = deleted

, DELETED)

  • 30a
  • 35b Note: In G.997.1, this parameter is called PROFILES. See ITU-T Recommendation [G.997.1]. 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, its value MUST be an empty string.

Changes in 2.12:

  • Added string 35b enumeration
 - 2.0
UpstreamAttenuation int R

The current upstream signal loss (expressed in 0.1dB). Doesn’t apply to VDSL2 [G.993.2]. Otherwise has the same value as the single element of TestParams.SATNus.

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
DownstreamAttenuation int R

The current downstream signal loss (expressed in 0.1dB). Doesn’t apply to VDSL2 [G.993.2]. Otherwise has the same value as the single element of TestParams.SATNds.

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
Device.DSL.Line.{i}.TestParams. object R This object contains the DSL line test parameters that are available during the L0 (i.e., Showtime) state. - 2.0
HLOGGds unsignedInt R

Number of sub-carriers per sub-carrier group in the downstream direction for HLOGpsds. Valid values are 1, 2, 4, 8, and 8.16. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
QLNGds unsignedInt R

Number of sub-carriers per sub-carrier group in the downstream direction for QLNpsds. Valid values are 1, 2, 4, 8, and 8.16. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
SNRGds unsignedInt R

Number of sub-carriers per sub-carrier group in the downstream direction for SNRpsds. Valid values are 1, 2, 4, 8, and 8.16. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1.

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
LATNds string[](:35) R

Comma-separated list (maximum number of characters 35) of strings. Indicates the downstream line attenuation peraveraged usableacross all sub-carriers in the frequency band, as computed during initialization. Number of elements is dependent on the number of downstream bands but will exceed one only for ITU-T G.993.2. Interpretation of LATNds is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1].

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Changed :35 size maxLength = 24 ⇒ 35
 - 2.0
LATNus string[](:35) R

Comma-separated list (maximum number of characters 35) of strings. Indicates the upstream line attenuation peraveraged usableacross all sub-carriers in the frequency band, as computed during initialization. Number of elements is dependent on the number of upstream bands but will exceed one only for ITU-T G.993.2. Interpretation of LATNus is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1].

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Changed :35 size maxLength = 24 ⇒ 35
 - 2.0
SATNds string[](:35) R

Comma-separated list (maximum number of characters 35) of strings. Indicates the downstream signal attenuation peraveraged usableacross all active sub-carriers in the frequency band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for ITU-T G.993.2. Interpretation of SATNds is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1].

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Changed :35 size maxLength = 24 ⇒ 35
 - 2.0
SATNus string[](:35) R

Comma-separated list (maximum number of characters 35) of strings. Indicates the upstream signal attenuation peraveraged usableacross all active sub-carriers in the frequency band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for ITU-T G.993.2. Interpretation of SATNus is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1].

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Changed :35 size maxLength = 24 ⇒ 35
 - 2.0
Device.DSL.Channel.{i}. object(0:) R

DSL Channel table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models DSL channel(s) on top of physical DSL lines.

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 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 DSL.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 via [TR-069]. 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) 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.

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 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 DSL.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 DSL.Channel or FAST.Line is no longer bonded, then the CPE MUST delete the corresponding BondedChannel instance. However, when a bonded DSL.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) 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.

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.DSL.Diagnostics. object R The DSL Diagnostics object.

Changes in 2.12:

  • Removed {{object: non-existent ADSLLineTest. ::: object
  • Added ADSLLineTest() command}}
 - 2.0
ADSLLineTest() command - [ASYNC] This command is to provide diagnostic information for a CPE with an ADSL2 or ADSL2+ modem WAN interface, but MAY also be used for ADSL. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Interface string(:256) W [MANDATORY] The value MUST be the Path Name of a row in the DSL.Channel. table. This is the interface over which the test is to be performed. - 2.0
⇐ Output. arguments - Output arguments. -
⇐ ACTPSDds int R Downstream actual power spectral density. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
⇐ ACTPSDus int R Upstream actual power spectral density. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
⇐ ACTATPds int R Downstream actual aggregate transmitter power. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
⇐ ACTATPus int R Upstream actual aggregate transmitter power. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
⇐ HLINSCds int R Downstream linear representation scale. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 2.0
⇐ HLINSCus int R Scaling used to represent the upstream linear channel characteristics. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 2.0
⇐ HLINGds unsignedInt R Number of sub-carriers per sub-carrier group in the downstream direction for HLINpsds. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 2.0
⇐ HLINGus unsignedInt R Number of sub-carriers per sub-carrier group in the downstream direction for HLINpsus. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 2.0
⇐ HLOGGds unsignedInt R Number of sub-carriers per sub-carrier group in the downstream direction for HLOGpsds. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 2.0
⇐ HLOGGus unsignedInt R Number of sub-carriers per sub-carrier group in the upstream direction for HLOGpsus. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 2.0
⇐ HLOGpsds string[](:2559) R Comma-separated list (maximum number of characters 2559) of strings. List items represent downstream logarithmic channel characteristics per sub-carrier group. The maximum number of elements is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGds but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: HLOGpsds is measured during initialization and is not updated during Showtime. - 2.0
⇐ HLOGpsus string[](:2559) R Comma-separated list (maximum number of characters 2559) of strings. List items represent upstream logarithmic channel characteristics per sub-carrier group. The maximum number of elements is 64 for G.992.3 and G.992.5. For G.993.2, the number of elements will depend on the value of HLOGGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. Note: HLOGpsus is measured during initialization and is not updated during Showtime. - 2.0
⇐ HLOGMTds unsignedInt R Indicates the number of symbols over which HLOGpsds was measured. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 2.0
⇐ HLOGMTus unsignedInt R Indicates the number of symbols over which HLOGpsus was measured. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 2.0
⇐ LATNpbds string[](:24) R Comma-separated list (maximum number of characters 24) of strings. List items represent downstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of LATNpbds is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
⇐ LATNpbus string[](:24) R Comma-separated list (maximum number of characters 24) of strings. List items represent upstream line attenuation per usable band, as computed during initialization. Number of elements is dependent on the number of upstream bands but will exceed one only for G.993.2. Interpretation of LATNpbus is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
⇐ SATNds string[](:24) R Comma-separated list (maximum number of characters 24) of strings. List items represent downstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNds is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
⇐ SATNus string[](:24) R Comma-separated list (maximum number of characters 24) of strings. List items represent upstream signal attenuation per usable band, as computed during the L0 (i.e., Showtime) state. Number of elements is dependent on the number of downstream bands but will exceed one only for G.993.2. Interpretation of SATNus is as defined in ITU-T Rec. G.997.1. Note: See ITU-T Recommendation [G.997.1]. - 2.0
⇐ HLINpsds int[](:61430) R Comma-separated list (maximum number of characters 61430) of integers. List items represent downstream linear channel characteristics per subcarrier group. Maximum number of complex pairs is 256 for G.992.3, and 512 for G.992.5. For G.993.2, the number of pairs will depend on the value of HLINGds but will not exceed 512. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: HLIN is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. - 2.0
⇐ HLINpsus string[](:61430) R Comma-separated list (maximum number of characters 61430) of strings. List items represent upstream linear channel characteristics per sub-carrier group. Maximum number of complex pairs is 64 for G.992.3, and G.992.5. For G.993.2, the number of pairs will depend on the value of HLINGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: HLIN is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. - 2.0
⇐ QLNGds unsignedInt R Number of sub-carriers per sub-carrier group in the downstream direction for QLNpsds. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 2.0
⇐ QLNGus unsignedInt R Number of sub-carriers per sub-carrier group in the upstream direction for QLNpsus. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 2.0
⇐ QLNpsds int[](:61430) R Comma-separated list (maximum number of characters 61430) of integers. List items represent downstream quiet line noise per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. For G.993.2, the number of elements will depend on the value of QLNGds but will not exceed 512. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: QLN is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. - 2.0
⇐ QLNpsus string[](:61430) R Comma-separated list (maximum number of characters 61430) of strings. List items represent upstream quiet line noise per subcarrier group. The maximum number of elements is 64 for G.992.3, and G.992.5. For G.993.2, the number of elements will depend on the value of QLNGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: QLN is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. - 2.0
⇐ QLNMTds unsignedInt R Indicates the number of symbols over which QLNpsds was measured. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 2.0
⇐ QLNMTus unsignedInt R Indicates the number of symbols over which QLNpsus was measured. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 2.0
⇐ SNRGds unsignedInt R Number of sub-carriers per sub-carrier group in the downstream direction for SNRpsds. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 2.0
⇐ SNRGus unsignedInt R Number of sub-carriers per sub-carrier group in the upstream direction for SNRpsus. Valid values are 1, 2, 4, and 8. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 1. - 2.0
⇐ SNRpsds int[](:61430) R Comma-separated list (maximum number of characters 61430) of integers. List items represent downstream SNR per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. For G.993.2, the number of elements will depend on the value of SNRGds but will not exceed 512. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Interpretation of the value is as defined in ITU-T Rec. G.997.1. Note: SNRps is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. - 2.0
⇐ SNRpsus string[](:61430) R Comma-separated list (maximum number of characters 61430) of strings. List items represent upstream SNR per subcarrier group. The maximum number of elements is 64 for G.992.3, and G.992.5. For G.993.2, the number of elements will depend on the value of SNRGus but will not exceed 512. Interpretation of the values is as defined in ITU-T Rec. G.997.1. Note: SNRps is not applicable in PLOAM for G.992.1 or G.992.2. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to None. - 2.0
⇐ SNRMTds unsignedInt R Indicates the number of symbols over which SNRpsds was measured. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 2.0
⇐ SNRMTus unsignedInt R Indicates the number of symbols over which SNRpsus was measured. Note: See ITU-T Recommendation [G.997.1]. For a multimode device operating in a mode in which this parameter does not apply, the value of this parameter SHOULD be set to 0. - 2.0
⇐ BITSpsds int[](:61430) R Comma-separated list (maximum number of characters 61430) of integers. List items represent downstream bit allocation per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. Interpretation of the value is as defined in ITU-T Rec. [G.997.1]. - 2.0
⇐ BITSpsus string[](:61430) R Comma-separated list (maximum number of characters 61430) of strings. List items represent upstream bit allocation per subcarrier group. Maximum number of elements is 256 for G.992.3, 512 for G.992.5. Interpretation of the value is as defined in ITU-T Rec. [G.997.1]. - 2.0
Device.ATM. object R Asynchronous Transfer Mode (ATM) object that contains the Link interface and {{object: non-existent Diagnostics.F5Loopback()}} diagnostics. - 2.0
Device.ATM.Link.{i}. object(0:) W

ATM link-layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Models an ATM PVC virtual circuit and the ATM Adaption Layer (AAL). An ATM Link entry is typically stacked on top of either a DSL.Channel. or a DSL.BondingGroup. object. When an ATM Link interface is used, a lower-layer DSL.Channel interface MUST be configured with ATM encapsulation (see DSL.Channel.{i}.LinkEncapsulationUsed).

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.ATM.Diagnostics. object R The ATM Diagnostics object.

Changes in 2.12:

  • Removed {{object: non-existent F5Loopback. ::: object
  • Added F5Loopback() command}}
 - 2.0
F5Loopback() command - [ASYNC] This command provides access to an ATM-layer F5 OAM loopback test. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Interface string(:256) W The value MUST be the Path Name of a row in the ATM.Link. table. This is the interface over which the test is to be performed. - 2.0
⇒ NumberOfRepetitions unsignedInt(1:) W Number of repetitions of the ping test to perform before reporting the results. - 2.0
⇒ Timeout unsignedInt(1:) W Timeout in milliseconds for the ping test. - 2.0
⇐ Output. arguments - Output arguments. -
⇐ SuccessCount unsignedInt R Result parameter indicating the number of successful pings (those in which a successful response was received prior to the timeout) in the most recent ping test. - 2.0
⇐ FailureCount unsignedInt R Result parameter indicating the number of failed pings in the most recent ping test. - 2.0
⇐ AverageResponseTime unsignedInt R Result parameter indicating the average response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 2.0
⇐ MinimumResponseTime unsignedInt R Result parameter indicating the minimum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 2.0
⇐ MaximumResponseTime unsignedInt R Result parameter indicating the maximum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 2.0
Device.PTM. object R Packet Transfer Mode ([Annex H/G.993.1]). This object contains the Link interface. - 2.0
Device.PTM.Link.{i}. object(0:) W

PTM link-layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Models a layer 2 variable-sized packet interface. A PTM Link entry is typically stacked on top of either a FAST.Line., DSL.Channel., or a DSL.BondingGroup. object. When a PTM Link interface is used, a lower-layer DSL.Channel interface MUST be configured with PTM encapsulation (see DSL.Channel.{i}.LinkEncapsulationUsed).

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

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

Changes in 2.12:

 - 2.0
LAGNumberOfEntries unsignedInt R The number of entries in the LAG table. - 2.12
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 also models the PHY and MAC level Ethernet interface.

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.Ethernet.Link.{i}. object(0:) W

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

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.Ethernet.LAG.{i}. object(0:) W

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

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

 - 2.12
Enable boolean W Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. - 2.12
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863].
 - 2.12
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.

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

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

 - 2.12
Name string(:64) R

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

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

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

 - 2.12
LastChange unsignedInt R

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string.. See [Section 4.2.1/TR-181i2]. LowerLayers must reference to Device.Ethernet.Interface instances where Link Aggregation Group is configured by the CPE. For example, “Device.Ethernet.Interface.1, Device.Ethernet.Interface.2” - 2.12
MACAddress string(:17) W

[MACAddress] MAC address of the Link Aggregation Interface.

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

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

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
BytesReceived unsignedLong R

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
PacketsSent unsignedLong R

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
PacketsReceived unsignedLong R

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
ErrorsSent unsignedInt R

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
ErrorsReceived unsignedInt R

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
UnicastPacketsSent unsignedLong R

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
UnicastPacketsReceived unsignedLong R

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
DiscardPacketsSent unsignedInt R

[StatsCounter32] The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space.

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
DiscardPacketsReceived unsignedInt R

[StatsCounter32] The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space.

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
MulticastPacketsSent unsignedLong R

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
MulticastPacketsReceived unsignedLong R

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
BroadcastPacketsSent unsignedLong R

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
BroadcastPacketsReceived unsignedLong R

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
UnknownProtoPacketsReceived unsignedInt R

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

Value Change Notification requests for this parameter MAY be denied.

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.USB.USBHosts. object R This object models the CPE’s USB Host controllers. See [Appendix I/TR-157] 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.

Changes in 2.12:

  • Removed {{param: non-existent Reset ::: parameter
  • Added Reset() command}}
 - 2.0
Reset() command - Reset the Host Controller and apply the reset signaling (see [Chapter 7.1.7.5/USB2.0]) to all of the Host Controller Hub downstream ports. - 2.12
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) 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.

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.HPNA.Interface.{i}.QoS. object R QoS configuration object. - 2.0
Device.HPNA.Interface.{i}.QoS.FlowSpec.{i}. object(0:) W

Flow specification table. The QoS.Classification table is used to classify ingress traffic, where QoS.Classification.{i}.TrafficClass is one of the classification result outputs. This TrafficClass value can be used to look up the appropriate FlowSpec entry (i.e. the FlowSpec entry whose TrafficClasses list contains a matching traffic class). For enabled table entries, if TrafficClasses is an empty string then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.HPNA.Diagnostics. object R The HPNA Diagnostics object.

Changes in 2.12:

  • Removed {{object: non-existent PHYThroughput. ::: object
  • Removed {{object: non-existent PerformanceMonitoring. object
  • Added PHYThroughput() command
  • Added PerformanceMonitoring() command}}}}
 - 2.0
PHYThroughput() command - [ASYNC] HPNA PHY throughput diagnostics configuration and results. When diagnostics are requested, all HPNA nodes for which the Interface.{i}.AssociatedDevice.{i}.PHYDiagnosticsEnable parameter is set enter PHY diagnostics mode. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Interface string(:256) W The value MUST be the Path Name of a row in the HPNA.Interface. table. This is the interface over which the test is to be performed. - 2.0
⇒ NumPacketsInBurst unsignedInt W Number of test packet in burst to be send during PHY diagnostics test from each HPNA device to other HPNA device in the HPNA network. - 2.0
⇒ BurstInterval unsignedInt W Test packet burst interval length (expressed in milliseconds). - 2.0
⇒ TestPacketPayloadLength unsignedInt(0:1480) W Payload length in the test packets. - 2.0
⇒ PayloadEncoding unsignedInt W HPNA payload encoding in PHY diagnostics. 0 is used for negotiated payload between devices according to line conditions. - 2.0
⇒ PayloadDataGen unsignedInt W Test packets payload data generator value. - 2.0
⇒ PayloadType string W

Test packets payload type. Enumeration of:

  • Pattern
  • IncrementByte In Pattern mode the PayloadDataGen value is repeated pattern in the payload. In IncrementByte mode LSByte in PayloadDataGen is used as first payload and next bytes in payload are incremented.
 - 2.0
⇒ PriorityLevel unsignedInt(0:7) W Priority level of PHY diagnostics packets (0 lowest -7 highest). - 2.0
⇐ Output. arguments - Output arguments. -
⇐ Result.{i}. object(0:) R

PHY throughput diagnostics results. Each result object corresponds to unidirectional traffic between two PHY diagnostics-enabled nodes (so there are two such objects for each such pair).

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

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

 - 2.0
⇐ SrcMACAddress string(:17) R [MACAddress] HPNA source MAC address. - 2.0
⇐ DestMACAddress string(:17) R [MACAddress] HPNA destination MAC address. - 2.0
⇐ PHYRate unsignedInt R PHY diagnostics HPNA PHY rate (expressed in Mbps). - 2.0
⇐ BaudRate unsignedInt R PHY Baud rate (expressed in Kbaud). - 2.0
⇐ SNR unsignedInt R PHY diagnostics SNR (expressed in 0.1dB). - 2.0
⇐ PacketsReceived unsignedInt R Number of received packets in PHY diagnostics mode. - 2.0
⇐ Attenuation unsignedInt R Measured attenuation (expressed in 0.1dB). - 2.0
PerformanceMonitoring() command - [ASYNC] HPNA performance monitoring configuration and results. Performance monitoring results are sampled from all nodes in the HPNA network. All packet related counters are sampled synchronized at all nodes in the HPNA network in order to derive packet loss calculations in the HPNA network. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Interface string(:256) W The value MUST be the Path Name of a row in the HPNA.Interface. table. This is the interface over which the test is to be performed. - 2.0
⇒ SampleInterval unsignedInt W Time in seconds between automatic collection of performance monitoring data. A value of zero disables automatic collection of data. The CPE MAY impose a minimum sample interval, in which case an attempt to set a (non-zero) interval that is less than this minimum MUST set the interval to the minimum and MUST NOT be regarded as an error. If SampleInterval is a simple fraction of a day, e.g. 900 (a quarter of an hour) or 3600 (an hour), the CPE MAY choose to align sample intervals with time of day, but is not required to do so. - 2.0
⇐ Output. arguments - Output arguments. -
⇐ Nodes. object R Per-node HPNA performance monitoring results. When automatic collection is enabled, i.e. SampleInterval is non-zero, the “current” interval is defined by the most recent automatic sample and the most recent subsequent manual sample, if any. When automatic collection is disabled, i.e. SampleInterval is zero, the “current” interval is defined by the three most recent manual samples. Note: Packets in statistics counters are Ethernet packets. - 2.0
⇐ CurrentStart dateTime R Start time for the current interval. When automatic collection is enabled, i.e. SampleInterval is non-zero, the current interval started at the most recent automatic sample. When automatic collection is disabled, i.e. SampleInterval is zero, the current interval started two manual samples ago. - 2.0
⇐ CurrentEnd dateTime R End time for the current interval. When automatic collection is enabled, i.e. SampleInterval is non-zero, the current interval ended at the most recent manual sample since the most recent automatic sample. If there has been no such manual sample, the current interval is empty. When automatic collection is disabled, i.e. SampleInterval is zero, the current interval ended at the most recent manual sample. - 2.0
⇐ NodeNumberOfEntries unsignedInt R {{numentries: not associated with a table}} This is the number of HPNA nodes for which performance monitoring results were collected during the current sample interval. - 2.0
⇐ Nodes.Node.{i}. object(1:) R

Per-node HPNA performance monitoring results during the current sample interval. Each table entry contains the results collected between an HPNA node (as indicated by MACAddress) and the local HPNA interface (as indicated by Interface). Note: Packet counters indicate the number of packets received between CurrentStart and CurrentEnd.

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

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

 - 2.0
⇐ MACAddress string(:17) R [MACAddress] The MAC address of the HPNA node. - 2.0
⇐ BytesSent unsignedLong R The total number of bytes sent by host equipment for transmission on the HPNA interface. - 2.0
⇐ BytesReceived unsignedLong R The total number of received bytes on the HPNA interface destined for the host equipment. - 2.0
⇐ PacketsSent unsignedLong R The total number of packets sent by host equipment for transmission on the HPNA interface. Number includes also short error packets and control packets. - 2.0
⇐ PacketsReceived unsignedLong R The total number of good packets received on the HPNA interface destined for the host equipment. - 2.0
⇐ BroadcastPacketsSent unsignedLong R The number of broadcast packets transmitted on the HPNA interface. - 2.0
⇐ BroadcastPacketsReceived unsignedLong R The number of broadcast packets received on the HPNA interface. - 2.0
⇐ MulticastPacketsSent unsignedLong R The number of multicast packets transmitted on the HPNA interface. - 2.0
⇐ MulticastPacketsReceived unsignedLong R The number of multicast packets received on the HPNA interface. - 2.0
⇐ PacketsCrcErrored unsignedInt R The number of packets received on the HPNA interface with CRC errors. - 2.0
⇐ PacketsCrcErroredHost unsignedInt R The number of CRC error packets received on the HPNA interface destined for the host equipment. - 2.0
⇐ PacketsShortErrored unsignedInt R The number of packets received on the HPNA interface that are too short to be valid. - 2.0
⇐ PacketsShortErroredHost unsignedInt R The number packets sent by the host equipment that are too short to be valid. - 2.0
⇐ RxPacketsDropped unsignedInt R The number of received packets dropped due to lack of resources. - 2.0
⇐ TxPacketsDropped unsignedInt R The number packets sent by the host equipment for transmission on the HPNA interface but dropped due to lack of resources. - 2.0
⇐ ControlRequestLocal unsignedInt R The number of HPNA control request packets from local host. - 2.0
⇐ ControlReplyLocal unsignedInt R The number of HPNA control reply packets to local host. - 2.0
⇐ ControlRequestRemote unsignedInt R The number of HPNA control request packets from remote host. - 2.0
⇐ ControlReplyRemote unsignedInt R The number of HPNA control reply packets to remote host. - 2.0
⇐ PacketsSentWire unsignedLong R The total number of packets transmitted to wire. - 2.0
⇐ BroadcastPacketsSentWire unsignedLong R The total number of broadcast packets transmitted to wire. - 2.0
⇐ MulticastPacketsSentWire unsignedLong R The total number of multicast packets transmitted to wire. - 2.0
⇐ PacketsInternalControl unsignedInt R The number of HPNA control request packets from internal node. - 2.0
⇐ BroadcastPacketsInternalControl unsignedInt R The number of HPNA broadcast control request packets from internal node. - 2.0
⇐ PacketsReceivedQueued unsignedInt R The number of received packets queued on host output queues. - 2.0
⇐ PacketsReceivedForwardUnknown unsignedInt R The number of packets received and forwarded to unknown hosts. - 2.0
⇐ NodeUtilization unsignedInt(0:1000) R The node utilization (expressed in 0.1%). - 2.0
⇐ Channels. object R Per-channel HPNA performance monitoring results. Note: channels are unidirectional. - 2.0
⇐ TimeStamp dateTime R Time at which channel data was last collected. - 2.0
⇐ ChannelNumberOfEntries unsignedInt R {{numentries: not associated with a table}} This is the number of HPNA channels for which performance monitoring results have been collected. - 2.0
⇐ Channels.Channel.{i}. object(0:) R

Per-channel HPNA performance monitoring results.

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

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

 - 2.0
⇐ HostSrcMACAddress string(:17) R [MACAddress] The host source MAC address associated with the channel. - 2.0
⇐ HostDestMACAddress string(:17) R [MACAddress] The host destination MAC address associated with the channel. - 2.0
⇐ HPNASrcMACAddress string(:17) R [MACAddress] The HPNA source MAC address associated with the channel. - 2.0
⇐ HPNADestMACAddress string(:17) R [MACAddress] The HPNA destination MAC address associated with the channel. - 2.0
⇐ PHYRate unsignedInt R Channel PHY rate (expressed in Mbps). - 2.0
⇐ BaudRate unsignedInt R PHY Baud rate (expressed in Kbaud). - 2.0
⇐ SNR unsignedInt R Channel actual SNR measured in receiver side (expressed in 0.1dB). - 2.0
⇐ PacketsSent unsignedInt R Number of packets sent in the channel. - 2.0
⇐ PacketsReceived unsignedInt R Pre-LARQ number of packets received in the channel. - 2.0
⇐ LARQPacketsReceived unsignedInt R Post-LARQ number of packets received in the channel. Valid only if LARQ is enabled. - 2.0
⇐ FlowSpec string(:256) R The value MUST be the Path Name of a row in the HPNA.Interface.{i}.QoS.FlowSpec. table. Identifies the FlowSpec associated with the channel. This parameter is only used for channels that correspond to egress traffic from the local HPNA interface. An empty string means that the channel is not associated with any specified flow specification in the QoS object. - 2.0
Device.MoCA. object R MoCA object that contains the Interface table [MoCAv1.0] [MoCAv1.1]. - 2.0
Device.MoCA.Interface.{i}. object(0:) R

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.Ghn. object R G.hn object that contains an Interface table for G.hn supported CPE. The ITU-T G.hn specifications [G.9960] and [G.9961] define Physical and MAC Layers for communication between two or more G.hn nodes in the home network over multiple wired media such as power line, phone line and coaxial cable. - 2.4
Device.Ghn.Interface.{i}. object(0:) R

G.hn interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY [G.9960] and MAC [G.9961] layers of a G.hn interface.

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

Changes in 2.12:

  • Added PSM parameter
 - 2.4
PSM unsignedInt[2:2][2:32] W Specifies the list of PSD shaping mask (PSM) breakpoints to be applied to the G.hn interface. Comma-separated list (2 to 32 items) of PSMBreak Point Index And Levels, with each list item consisting of:. [PSMBreakPointIndexAndLevel] 1. The PSM breakpoint sub-carrier index in the range [0:4095], and
  1. the value of the level of the PSM at this sub-carrier expressed in 0.1 dBm/Hz with an offset of -140 dBm/Hz. Both values are represented as unsignedInt. [Clause 5.2/G.9964] defines limits on PSM breakpoint levels. The PSM level is 0.1*(the value of the level of the PSM) - 140 dBm/Hz. For example, a PSM defined by two breakpoints (subcarrier 450, PSM level -80 dBm/Hz) and (subcarrier 1050, PSM level -90 dBm/Hz) is represented by PSM [450,600],[1050,500] .
 - 2.12
Device.Ghn.Interface.{i}.Stats. object R Throughput statistics for this interface at the different G.hn reference points described in [Clause 8.1/G.9961]. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2]. - 2.4
BytesSent unsignedLong R

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

More specifically, this is the total number of MPDU bytes transmitted or retransmitted by the node through a physical medium (i.e., PMI defined in [Clause 5.2.1/G.9960]), which correspond to data LPDUs (i.e., data packets) and framing overhead (e.g., LFH, LPH, LPCS defined in [Clause 8.1/G.9961]). It does not include transmitted bytes contributed by management LPDUs (i.e., management packets). Note: LPDUs in mixed LLC frame blocks are considered data LPDUs.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed unsignedLong syntax
 - 2.4
BytesReceived unsignedLong R

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

More specifically, this is the total number of MPDU bytes received by the node through a physical medium, which correspond to data LPDUs and framing overhead. It does not include received bytes contributed by management LPDUs. It can include blocks with errors. Note: LPDUs in mixed LLC frame blocks are considered data LPDUs.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed unsignedLong syntax
 - 2.4
PacketsSent unsignedLong R

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

More specifically, this is the total number of APDUs requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]) that were transmitted by the node through the physical medium. It does not include transmitted LCDUs.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed unsignedLong syntax
 - 2.4
PacketsReceived unsignedLong R

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

More specifically, this is the total number of APDUs delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) that were received by the node through the physical medium. It does not include received LCDUs.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed unsignedLong syntax
 - 2.4
ErrorsSent unsignedInt R

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

More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]) but could not be transmitted because of errors (e.g., APDUs containing CRC errors).

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed unsignedInt syntax
 - 2.4
ErrorsReceived unsignedInt R

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

More specifically, this is the total number of received APDUs that contained errors preventing them from being delivered to a higher layer (i.e., inbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]). The possible causes of error are: incorrect CRC, incorrect MIC, incorrect MIC size, and incorrect size of packet.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed unsignedInt syntax
 - 2.4
UnicastPacketsSent unsignedLong R

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

More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer. It includes APDUs that were discarded or not sent.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed unsignedLong syntax
 - 2.4
UnicastPacketsReceived unsignedLong R

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

More specifically, this is the total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed unsignedLong syntax
 - 2.4
DiscardPacketsSent unsignedInt R

[StatsCounter32] The total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space.

More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) but chosen to be discarded even though no errors had been detected to prevent their being transmitted (e.g., buffer overflow).

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed unsignedInt syntax
 - 2.4
DiscardPacketsReceived unsignedInt R

[StatsCounter32] The total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space.

More specifically, this is the total number of received APDUs that were chosen to be discarded even though no errors had been detected to prevent their being delivered.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed unsignedInt syntax
 - 2.4
MulticastPacketsSent unsignedLong R

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

More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer. It includes APDUs that were discarded or not sent.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed unsignedLong syntax
 - 2.4
MulticastPacketsReceived unsignedLong R

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

More specifically, this is the total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed unsignedLong syntax
 - 2.4
BroadcastPacketsSent unsignedLong R

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

More specifically, this is the total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer. It includes APDUs that were discarded or not sent.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed unsignedLong syntax
 - 2.4
BroadcastPacketsReceived unsignedLong R

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

More specifically, this is the total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed unsignedLong syntax
 - 2.4
UnknownProtoPacketsReceived unsignedInt R

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

More specifically, this is the total number of APDUs received by the management that were discarded because of an unknown or unsupported protocol.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed unsignedInt syntax
 - 2.4
Device.Ghn.Diagnostics. object R The G.hn Diagnostics object.

Changes in 2.12:

  • Removed {{object: non-existent PHYThroughput. ::: object
  • Removed {{object: non-existent PerformanceMonitoring. object
  • Added PHYThroughput() command
  • Added PerformanceMonitoring() command}}}}
 - 2.8
PHYThroughput() command - [ASYNC] G.hn PHY throughput diagnostics configuration and results. When diagnostics are requested, all G.hn nodes for which the Interface.{i}.PHYThroughputDiagnosticsEnable parameter is set enter PHY diagnostics mode. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Interface string W The value MUST be the Path Name of a row in the Ghn.Interface. table. The interface over which the test is to be performed. - 2.8
⇒ DiagnoseMACAddress string(:17) W [MACAddress] The MAC address of the originating G.hn interface of the link that is being diagnosed. Note: This MAC address might belong to another node of the domain. - 2.8
⇐ Output. arguments - Output arguments. -
⇐ Result.{i}. object(0:) R

PHY throughput diagnostics results.

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

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

 - 2.8
⇐ DestinationMACAddress string(:17) R [MACAddress] MAC address of the destination node of the link being measured. - 2.8
⇐ LinkState string R

Indicates the state of the link between the G.hn Interface with MAC address DiagnoseMACAddress and the G.hn Interface with MAC address DestinationMACAddress.

Enumeration of:

 - 2.8
⇐ TxPhyRate unsignedInt R PHY data rate in transmit direction in the link between the G.hn Interface with MAC address DiagnoseMACAddress and the G.hn Interface with MAC address DestinationMACAddress. It is represented in Mbps as defined in Note 1 to [Table 8-48/G.9961]. To convert from the value in the table, divide by 32K (32768) and round down. - 2.8
⇐ RxPhyRate unsignedInt R PHY data rate in receive direction in the link between the G.hn Interface with MAC address DiagnoseMACAddress and the G.hn Interface with MAC address DestinationMACAddress. It is represented in Mbps as defined in Note 1 to [Table 8-48/G.9961]. To convert from the value in the table, divide by 32K (32768) and round down. - 2.8
PerformanceMonitoring() command - [ASYNC] G.hn Performance Monitoring diagnostics configuration and results. When diagnostics are requested, all G.hn nodes for which the Interface.{i}.PerformanceMonitoringDiagnosticsEnable parameter is set enter PHY diagnostics mode. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Interface string W The value MUST be the Path Name of a row in the Ghn.Interface. table. The interface over which the test is to be performed. - 2.8
⇒ DiagnoseMACAddress string(:17) W [MACAddress] The MAC address of the originating G.hn interface of the link that is being diagnosed. Note: This MAC address might belong to another node of the domain. - 2.8
⇒ SampleInterval unsignedInt W Time in seconds between automatic collection of performance monitoring data. A value of zero disables automatic collection of data. The node MAY impose a minimum sample interval, in which case an attempt to set a (non-zero) interval that is less than this minimum MUST set the interval to the minimum and MUST NOT be regarded as an error. If SampleInterval is a simple fraction of a day, e.g. 900 (a quarter of an hour) or 3600 (an hour), the device MAY choose to align sample intervals with time of day, but is not required to do so. - 2.8
⇒ SNRGroupLength unsignedInt(1,2,4,8,16,32,64,128,256) W The number of sub-carriers in a group to be used for averaging SNR values when providing SNR information for a channel. - 2.8
⇐ Output. arguments - Output arguments. -
⇐ Nodes. object R Per-node G.hn performance monitoring results. When automatic collection is enabled, i.e. SampleInterval is non-zero, the “current” interval is defined by the most recent automatic sample and the most recent subsequent manual sample, if any. When automatic collection is disabled, i.e. SampleInterval is zero, the “current” interval is defined by the three most recent manual samples. Note: Packets in statistics counters are Ethernet packets. - 2.8
⇐ CurrentStart dateTime R Start time for the current interval. When automatic collection is enabled, i.e. SampleInterval is non-zero, the current interval started at the most recent automatic sample. When automatic collection is disabled, i.e. SampleInterval is zero, the current interval started two manual samples ago. - 2.8
⇐ CurrentEnd dateTime R End time for the current interval. When automatic collection is enabled, i.e. SampleInterval is non-zero, the current interval ended at the most recent manual sample since the most recent automatic sample. If there has been no such manual sample, the current interval is empty. When automatic collection is disabled, i.e. SampleInterval is zero, the current interval ended at the most recent manual sample. - 2.8
⇐ NodeNumberOfEntries unsignedInt R {{numentries: not associated with a table}} This is the number of G.hn nodes for which performance monitoring results were collected during the current sample interval. - 2.8
⇐ Nodes.Node.{i}. object(1:) R

Per-node G.hn performance monitoring results during the current sample interval. Each table entry contains the results collected between the G.hn nodes with MAC addresses DiagnoseMACAddress) and DestinationMACAddress). Note: Packet counters indicate the number of packets received between CurrentStart and CurrentEnd.

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

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

 - 2.8
⇐ DestinationMACAddress string(:17) R [MACAddress] MAC address of the destination node of the link being measured. - 2.8
⇐ BytesSent unsignedLong R [StatsCounter64] The total number of MPDU bytes transmitted or retransmitted by the node through a physical medium (i.e., PMI defined in [Clause 5.2.1/G.9960]), which correspond to data LPDUs (i.e., data packets) and framing overhead (e.g., LFH, LPH, LPCS defined in [Clause 8.1/G.9961]). It does not include transmitted bytes contributed by management LPDUs (i.e., management packets). Note: LPDUs in mixed LLC frame blocks are considered data LPDUs. - 2.8
⇐ BytesReceived unsignedLong R [StatsCounter64] The total number of MPDU bytes received by the node through a physical medium, which correspond to data LPDUs and framing overhead. It does not include received bytes contributed by management LPDUs. It might include blocks with errors. Note: LPDUs in mixed LLC frame blocks are considered data LPDUs. - 2.8
⇐ PacketsSent unsignedLong R [StatsCounter64] The total number of APDUs requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]) that were transmitted by the node through the physical medium. It does not include transmitted LCDUs. - 2.8
⇐ PacketsReceived unsignedLong R [StatsCounter64] The total number of APDUs delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) that were received by the node through the physical medium. It does not include received LCDUs. - 2.8
⇐ ErrorsSent unsignedInt R [StatsCounter32] The total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]). This parameter represents the total number of LCDUs requested for transmission by a management layer (i.e., outbound LCDUs generated in LLC defined in in [Clause 8.1.3/G.9961]) that were transmitted by the node through a physical medium) but could not be transmitted because of errors (e.g., APDUs containing CRC errors). - 2.8
⇐ ErrorsReceived unsignedInt R [StatsCounter32] The total number of received APDUs that contained errors preventing them from being delivered to a higher layer (i.e., inbound APDUs at the x1 reference point defined in [Clause 5.2.1/G.9960]). The possible causes of error are: incorrect CRC, incorrect MIC, incorrect MIC size, and incorrect size of packet. - 2.8
⇐ UnicastPacketsSent unsignedLong R [StatsCounter64] The total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer. It includes APDUs that were discarded or not sent. - 2.8
⇐ UnicastPacketsReceived unsignedLong R [StatsCounter64] The total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a unicast address at this layer. - 2.8
⇐ DiscardPacketsSent unsignedInt R [StatsCounter32] The total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) but chosen to be discarded even though no errors had been detected to prevent their being transmitted (e.g., buffer overflow). - 2.8
⇐ DiscardPacketsReceived unsignedInt R [StatsCounter32] The total number of received APDUs that were chosen to be discarded even though no errors had been detected to prevent their being delivered. - 2.8
⇐ MulticastPacketsSent unsignedLong R [StatsCounter64] The total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer. It includes APDUs that were discarded or not sent. - 2.8
⇐ MulticastPacketsReceived unsignedLong R [StatsCounter64] The total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a multicast address at this layer. - 2.8
⇐ BroadcastPacketsSent unsignedLong R [StatsCounter64] The total number of APDUs that were requested for transmission by a higher layer (i.e., outbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer. It includes APDUs that were discarded or not sent. - 2.8
⇐ BroadcastPacketsReceived unsignedLong R [StatsCounter64] The total number of received APDUs that were delivered to a higher layer (i.e., inbound APDUs at the x1 reference point) and which were addressed to a broadcast address at this layer. - 2.8
⇐ UnknownProtoPacketsReceived unsignedInt R [StatsCounter32] The total number of APDUs received by the management that were discarded because of an unknown or unsupported protocol. - 2.8
⇐ MgmtBytesSent unsignedLong R [StatsCounter64] The total number of MPDU bytes transmitted by the node through a physical medium, which correspond to management LPDUs and framing overhead. - 2.8
⇐ MgmtBytesReceived unsignedLong R [StatsCounter64] The total number of MPDU bytes received by the node through a physical medium, which correspond to management LPDUs and framing overhead. - 2.8
⇐ MgmtPacketsSent unsignedLong R [StatsCounter64] The total number of LCDUs requested for transmission by a management layer (i.e., outbound LCDUs generated in LLC defined in [Clause 8.1.3/G.9961]) that were transmitted by the node through a physical medium. - 2.8
⇐ MgmtPacketsReceived unsignedLong R [StatsCounter64] The total number of LCDUs delivered to a management layer (i.e., inbound LCDUs) that were received by the node through a physical medium. - 2.8
⇐ BlocksSent unsignedLong R [StatsCounter64] The total number of LPDUs that were transmitted by the node through a physical medium, regardless of new or retransmitted LPDUs. - 2.8
⇐ BlocksReceived unsignedLong R [StatsCounter64] The total number of LPDUs that were received by the node through a physical medium, with or without errors. - 2.8
⇐ BlocksResent unsignedInt R [StatsCounter32] The total number of LPDUs that were retransmitted. - 2.8
⇐ BlocksErrorsReceived unsignedInt R [StatsCounter32] The total number of received LPDUs that contained errors. Note the following relationships hold:
  • PacketsSent + ErrorsSent + DiscardPacketsSent = UnicastPacketsSent + MulticastPacketsSent + BroadcastPacketsSent.
  • PacketsReceived = UnicastPacketsReceived + MulticastPacketsReceived + BroadcastPacketsReceived.
  • Retransmission rate = BlocksResent / BlocksSent.
  • Block error rate = BlocksErrorReceived / BlocksReceived.
 - 2.8
⇐ Channels. object R Per-channel G.hn performance monitoring results. Note: channels are unidirectional. - 2.8
⇐ TimeStamp dateTime R Time at which channel data was last collected. - 2.8
⇐ ChannelNumberOfEntries unsignedInt R {{numentries: not associated with a table}} - 2.8
⇐ Channels.Channel.{i}. object(0:) R

Per-channel G.hn performance monitoring results during the current sample interval. Each table entry contains the results collected from the channel between a G.hn interface (as indicated by DiagnoseMACAddress) and a G.hn interface indicated by DestinationMACAddress)

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

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

 - 2.8
⇐ DestinationMACAddress string(:17) R [MACAddress] MAC address of the destination node of the link being measured. - 2.8
⇐ SNR unsignedInt[] R Comma-separated list of unsigned integers. The result of an SNR test performed over the channel. It is formatted as a comma-separated list of N/M unsigned integers that represents the result of Signal-to-Noise-Ratio measurement averaging in groups of M subcarriers. The number N depends on the bandplan used by the node and corresponds to the OFDM control parameter N of each medium as defined in [G.9964]. The number M corresponds to the parameter SNRGroupLength. - 2.8
Device.HomePlug. object R HomePlug object that contains the Interface table. The HomePlug industry standard [HPAV1.1] defines peer to peer communication over powerline medium. - 2.0
Device.HomePlug.Interface.{i}. object(0:) R

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.HomePlug.Interface.{i}.AssociatedDevice.{i}. object(0:) R

This table contains information about other HomePlug devices connected to this HomePlug interface.

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

 - 2.0
SNRPerTone unsignedInt[:1155]() R Comma-separated list (up to 1155 items) (length ) of unsigned integers. List items indicate Signal to Noise Ratio (SNR) per tone from this remote device (expressed in 0.1dB).

Changes in 2.12:

 - 2.0
EndStationMACs string(:17)[:16]() R [MACAddress] Comma-separated list (up to 16 items) (length ) of MAC Addresses. List items represent MAC addresses of end stations bridged by the remote HomePlug device. For example: “11:22:33:AA:BB:CC, 22:33:44:DD:EE:66”

Changes in 2.12:

  • Added :16 list size
 - 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) 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.

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.UPA.Diagnostics. object R The UPA Diagnostics object.

Changes in 2.12:

 - 2.0
InterfaceMeasurement() command - [ASYNC] This command provides access to either a Signal-to-Noise-Ratio (SNR) Port Measurement test or a Channel Frequency Response (CFR) Port Measurement test. The Type parameter is used to select which type of test to perform. CFR and SNR measurements are done between a two UPA devices (a local interface and a remote device belonging to the same network). - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Type string W

Indicates the type of port measurement test to be carried out. Enumeration of:

  • SNR (Signal-to-Noise-Ratio)
  • CFR (Channel Frequency Response) .
 - 2.0
⇒ Interface string(:256) W The value MUST be the Path Name of a row in the UPA.Interface. table. This is the local UPA interface from which the test is to be performed. - 2.0
⇒ Port unsignedInt(0:65535) W PLC port being measured. This identifies which PLC connection to measure between the local interface (indicated by Interface) and the remote device (implied by Port). - 2.0
⇐ Output. arguments - Output arguments. -
⇐ Measurements unsignedInt[:1536]() R Comma-separated list (up to 1536 items) (length ) of unsigned integers. Result of Signal-to-Noise-Ratio measurement (if Type is SNR) or Channel Frequency Response measurement (if Type is CFR). List items indicate measurements per carrier for a PLC port (expressed in 0.1dB). - 2.0
⇐ RxGain int R Reception gain of the adapter (expresssed in dB). - 2.0
Device.WiFi. object R The WiFi object is based on the WiFi Alliance 802.11 specifications ([802.11-2007]). It defines interface objects (Radio and SSID), and application objects (AccessPoint and EndPoint).

Changes in 2.12:

 - 2.7
ResetCounter unsignedInt R [StatsCounter32] This parameter counts the number of WiFi host or driver resets since the last device reset. This parameter is reset to zero after the device resets, and increments with each successive WiFi host or driver reset. - 2.12
NeighboringWiFiDiagnostic() command - [ASYNC] This command defines access to other WiFi SSIDs that this device is able to receive. - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Result.{i}. object(0:) R

Neighboring SSID table. This table models the other WiFi SSIDs that this device is able to receive.

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

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

 - 2.7
⇐ Radio string R The value MUST be the Path Name of a row in the Device.WiFi.Radio. table. The Radio that detected the neighboring WiFi SSID. - 2.7
⇐ SSID string(:32) R The current service set identifier in use by the neighboring WiFi SSID. The value MAY be empty for hidden SSIDs. - 2.7
⇐ BSSID string(:17) R [MACAddress] The BSSID used for the neighboring WiFi SSID. - 2.7
⇐ Mode string R

The mode the neighboring WiFi radio is operating in.

Enumeration of:

  • AdHoc
  • Infrastructure
 - 2.7
⇐ Channel unsignedInt(1:255) R The current radio channel used by the neighboring WiFi radio. - 2.7
⇐ SignalStrength int(-200:0) R An indicator of radio signal strength (RSSI) of the neighboring WiFi radio measured in dBm, as an average of the last 100 packets received. - 2.7
⇐ SecurityModeEnabled string R

The type of encryption the neighboring WiFi SSID advertises.

Enumeration of:

  • None
  • WEP
  • WPA
  • WPA2
  • WPA-WPA2
  • WPA-Enterprise
  • WPA2-Enterprise
  • WPA-WPA2-Enterprise
 - 2.7
⇐ EncryptionMode string[] R

Comma-separated list of strings. The type of encryption the neighboring WiFi SSID advertises.

Each list item is an enumeration of:

  • TKIP
  • AES
 - 2.7
⇐ OperatingFrequencyBand string R

Indicates the frequency band at which the radio this SSID instance is operating.

Enumeration of:

  • 2.4GHz
  • 5GHz
 - 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:

 - 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 are allowed. If OperatingFrequencyBand is set to 5GHz, only values a, n, ac 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
  • Auto
 - 2.7
⇐ BeaconPeriod unsignedInt R Time interval (in ms) between transmitting beacons. - 2.7
⇐ Noise int(-200:0) R Indicator of average noise strength (in dBm) received from the neighboring WiFi radio. - 2.7
⇐ BasicDataTransferRates string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Basic data transmit rates (in Mbps) for the SSID. For example, if BasicDataTransferRates is “1,2”, this indicates that the SSID is operating with basic rates of 1 Mbps and 2 Mbps. - 2.7
⇐ SupportedDataTransferRates string[](:256) R Comma-separated list (maximum number of characters 256) of strings. Data transmit rates (in Mbps) for unicast frames at which the SSID will permit a station to connect. For example, if SupportedDataTransferRates is “1,2,5.5”, this indicates that the SSID will only permit connections at 1 Mbps, 2 Mbps and 5.5 Mbps. - 2.7
⇐ DTIMPeriod unsignedInt R The number of beacon intervals that elapse between transmission of Beacon frames containing a TIM element whose DTIM count field is 0. This value is transmitted in the DTIM Period field of beacon frames. [802.11-2012] - 2.7
Reset() command - This parameter represents a request to reset or reboot the WiFi sub-system without resetting or rebooting the device. - 2.12
Device.WiFi.Radio.{i}. object(0:) R

This object models an 802.11 wireless radio on a device (a stackable interface object as described in [Section 4.2/TR-181i2]). If the device can establish more than one connection simultaneously (e.g. a dual radio device), a separate Radio instance MUST be used for each physical radio of the device. See [Appendix III.1/TR-181i2] for additional information. Note: A dual-band single-radio device (e.g. an 802.11a/b/g radio) can be configured to operate at 2.4 or 5 GHz frequency bands, but only a single frequency band is used to transmit/receive at a given time. Therefore, a single Radio instance is used even for a dual-band radio.

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

Changes in 2.12:

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example: * For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces. * For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface. * For an End Device, Upstream will be true for all interfaces. This parameter is DEPRECATED because it gives a wrong indication for multiple SSIDs. Use the SSID.{i}.Upstream parameter instead.

Changes in 2.12:

  • Added status = deprecated
 - 2.0
ChannelLastChange unsignedInt R

The accumulated time in seconds since the current Channel came into use.

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
ChannelLastSelectionReason string R

The cause of the last channel selection.

Enumeration of:

  • Manual (Manual selection of the Channel)
  • Auto_Startup (Automatic channel selection procedure launched at radio startup)
  • Auto_User (Automatic channel selection procedure triggered by the user (e.g. via a GUI))
  • Auto_Refresh (Automatic channel selection procedure triggered by the AutoChannelRefreshPeriod timer)
  • Auto_Dynamic (Automatic channel selection procedure dynamically triggered to adjust to environmental interference)
  • Auto_DFS (Automatic channel selection procedure triggered by Dynamic Frequency Selection (DFS) [ETSIBRAN])
  • Unknown
 - 2.12
MaxSupportedSSIDs unsignedInt(1:) R Maximum number of SSIDs supported on this radio. - 2.12
MaxSupportedAssociations unsignedInt(1:) R Maximum number of associated devices supported. - 2.12
FirmwareVersion string(:64) R This radio’s WiFi firmware version. - 2.12
SupportedOperatingChannelBandwidths string[] R

Comma-separated list of strings. These are the valid writable values for OperatingChannelBandwidth.

Each list item is an enumeration of:

  • 20MHz
  • 40MHz (wide mode)
  • 80MHz (802.11ac only)
  • 160MHz (802.11ac only)
  • Auto
 - 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 and 802.11ac specifications only).

Changes in 2.12:

  • Removed string 20MHz enumeration
  • Removed string 40MHz enumeration
  • Removed string 80MHz enumeration
  • Removed string 160MHz enumeration
  • Removed string Auto enumeration
  • Added string SupportedOperatingChannelBandwidths enumerationRef
 - 2.0
MCS int(-1:15,16:31) W 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]. A value of -1 indicates automatic selection of the MCS index.

Changes in 2.12:

  • Removed 16:31 range optional = true
 - 2.0
Device.WiFi.Radio.{i}.Stats. object R Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See [Appendix III/TR-181i2a5] for further details. The CPE MUST reset the interface’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interface’s Status parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interface’s Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2a5].

Changes in 2.12:

 - 2.0
TotalChannelChangeCount unsignedInt R The total number of times that the Channel has changed since the WiFi.Radio entered its current operating state. - 2.12
ManualChannelChangeCount unsignedInt R The number of times that the Channel has changed due to manual channel selection since the WiFi.Radio entered its current operating state. - 2.12
AutoStartupChannelChangeCount unsignedInt R The number of times that the Channel has changed due to automatic channel selection procedure launched at radio startup since the WiFi.Radio entered its current operating state. - 2.12
AutoUserChannelChangeCount unsignedInt R The number of times that the Channel has changed due to automatic channel selection procedure triggered by the user (e.g. via a GUI) since the WiFi.Radio entered its current operating state. - 2.12
AutoRefreshChannelChangeCount unsignedInt R The number of times that the Channel has changed due to automatic channel selection procedure triggered by the AutoChannelRefreshPeriod timer since the WiFi.Radio entered its current operating state. - 2.12
AutoDynamicChannelChangeCount unsignedInt R The number of times that the Channel has changed due to automatic channel selection procedure dynamically triggered to adjust to environmental interference since the WiFi.Radio entered its current operating state. - 2.12
AutoDFSChannelChangeCount unsignedInt R The number of times that the Channel has changed due to automatic channel selection procedure triggered by DFS [ETSIBRAN] since the WiFi.Radio entered its current operating state. - 2.12
Device.WiFi.SSID.{i}. object(0:) W

WiFi SSID table (a stackable interface object as described in [Section 4.2/TR-181i2]), where table entries model the MAC layer. A WiFi SSID entry is typically stacked on top of a Radio object. WiFi SSID is also a multiplexing layer, i.e. more than one SSID can be stacked above a single Radio.

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

Changes in 2.12:

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Upstream boolean R Indicates whether the interface points towards the Internet (true) or towards End Devices (false). For example:
  • For an Internet Gateway Device, Upstream will be true for all WAN interfaces and false for all LAN interfaces.
  • For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, Upstream will be true for the Ethernet interface and false for the WiFi Radio interface.
  • For an End Device, Upstream will be true for all interfaces. This parameter supersedes the deprecated {{param: reference to deprecated parameter Device.WiFi.Radio.{i}.Upstream}} parameter. If both exist, the parameter {{param: reference to deprecated parameter Device.WiFi.Radio.{i}.Upstream}} is ignored.
 - 2.12
Device.WiFi.AccessPoint.{i}. object(0:) W

This object models an 802.11 connection from the perspective of a wireless access point. Each AccessPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter. For enabled table entries, if SSIDReference is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The AccessPoint table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated AccessPoint row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending AccessPoint row.

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

Changes in 2.12:

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
MaxAllowedAssociations unsignedInt W Maximum number of associated devices allowed for this SSID. If the number is reached new device connections to this access point will be rejected. If the number is changed to a value less than the actual number of associated devices, new device connections will be rejected until the number of devices is below this number. It is not expected that any connections are dropped. If the parameter Radio.{i}.MaxSupportedAssociations exists, the value MUST be less than or equal to the maximum number specified in Radio.{i}.MaxSupportedAssociations. - 2.12
Device.WiFi.AccessPoint.{i}.Security. object R This object contains security related parameters that apply to a CPE acting as an Access Point [802.11-2007].

Changes in 2.12:

  • Removed {{param: non-existent Reset ::: parameter
  • Added Reset() command}}
 - 2.0
WEPKey hexBinary(5,13) W

A WEP key expressed as a hexadecimal string. WEPKey is used only if ModeEnabled is set to WEP-64 or WEP-128. A 5 byte WEPKey corresponds to security mode WEP-64 and a 13 byte WEPKey corresponds to security mode WEP-128.

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

Changes in 2.12:

  • Removed 5 size 40-bit encryption description
  • Removed 13 size 104-bit encryption description
 - 2.0
Reset() command - Reset this Security instance’s WiFi security settings to their factory default values. The affected settings include ModeEnabled, WEPKey, PreSharedKey , KeyPassphrase and WPS.PIN (if applicable). If the command cannot be executed, the agent MUST reject the command. Possible failure reasons include a lack of default values or if ModeEnabled is an Enterprise type, i.e. WPA-Enterprise, WPA2-Enterprise or WPA-WPA2-Enterprise. - 2.12
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.12:

 - 2.0
LastDataDownlinkRate unsignedInt(1000:) R

The data transmit rate in kbps that was most recently used for transmission from the access point to the associated device.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed 1000:600000 range maxInclusive = 600000
 - 2.0
LastDataUplinkRate unsignedInt(1000:) R

The data transmit rate in kbps that was most recently used for transmission from the associated device to the access point.

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed 1000:600000 range maxInclusive = 600000
 - 2.0
AssociationTime dateTime R Date and time in UTC when the device was associated - 2.12
Noise int(-200:0) R An indicator of radio noise on the uplink from the associated device to the access point, measured in dBm, as an average of the last 100 packets received from the device (see ANPI definition in [Clause 10.11.9.4/802.11-2012]) - 2.12
Device.WiFi.EndPoint.{i}. object(0:) W

This object models an 802.11 connection from the perspective of a wireless end point. Each EndPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter, and an associated active Profile instance via the ProfileReference parameter. The active profile is responsible for specifying the actual SSID and security settings used by the end point. For enabled table entries, if SSIDReference or ProfileReference is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The EndPoint table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated EndPoint row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending EndPoint row.

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.WiFi.EndPoint.{i}.Profile.{i}. object(0:) W

EndPoint Profile table.

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.WiFi.EndPoint.{i}.Profile.{i}.Security. object R This object contains security related parameters that apply to a WiFi End Point profile [802.11-2007]. - 2.0
WEPKey hexBinary(5,13) W

A WEP key expressed as a hexadecimal string. WEPKey is used only if ModeEnabled is set to WEP-64 or WEP-128. A 5 byte WEPKey corresponds to security mode WEP-64 and a 13 byte WEPKey corresponds to security mode WEP-128.

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

Changes in 2.12:

  • Removed 5 size 40-bit encryption description
  • Removed 13 size 104-bit encryption description
 - 2.0
Device.Bridging. object R Layer 2 bridging configuration. Specifies bridges between different layer 2 interfaces. Bridges can be defined to include layer 2 filter criteria to selectively bridge traffic between interfaces. This object can be used to configure both 802.1D [802.1D-2004] and 802.1Q [802.1Q-2011] bridges. Not all 802.1D and 802.1Q features are modeled, and some additional features not present in either 802.1D or 802.1Q are modeled. 802.1Q [802.1Q-2011] bridges incorporate 802.1Q [802.1Q-2005] customer and 802.1ad [802.1ad-2005] provider bridges. - 2.0
Device.Bridging.Bridge.{i}. object(0:) W

Bridge table.

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.Bridging.Bridge.{i}.Port.{i}. object(0:) W

Bridge Port table, which MUST contain an entry for each bridge port (a stackable interface object as described in [Section 4.2/TR-181i2]). There are two types of bridge ports: management (upward facing) and non-management (downward facing). This is determined by configuring the Boolean ManagementPort parameter. The CPE will automatically configure each management bridge port to appear in the interface stack above all non-management bridge ports that share the same Bridge instance.

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
PriorityRegeneration unsignedInt(0:7)[8:8]() W Comma-separated list (8 items) (length ) of unsigned integers (0 to 7). List items represent user priority regeneration values for each ingress user priority on this Bridge Port.

Changes in 2.12:

  • Added 8:8 list size
 0,1,2,3,4,5,6,7 2.0
ServiceAccessPrioritySelection boolean W This parameter controls the Service Access Priority selection function as described in [Section 6.13/802.1Q-2011]. The parameter is applicable to deployments of Bridge instances that are referenced by {{param: non-existent ###.Bridging.ProviderBridge.{i}.SVLANcomponent}}. false 2.7
ServiceAccessPriorityTranslation unsignedInt(0:7)[8:8]() W Comma-separated list (8 items) (length ) of unsigned integers (0 to 7). List items represent service access priority translation values for each ingress priority on this Port as described in [Section 6.13/802.1Q-2011]. The parameter is applicable to deployments of Bridge instances that are referenced by {{param: non-existent ###.Bridging.ProviderBridge.{i}.SVLANcomponent}}.

Changes in 2.12:

  • Added 8:8 list size
 0,1,2,3,4,5,6,7 2.7
Device.Bridging.Bridge.{i}.Port.{i}.PriorityCodePoint. object R PriorityCodePoint provides the management control for the processing of the Priority Code Point (PCP) field for the 802.1Q header as defined in [Section 6.9.3 Priority Code Point Encoding/802.1Q-2011]. The object is applicable to deployments of Bridging.ProviderBridge where the Bridge instance is referenced by {{param: non-existent ####.Bridging.ProviderBridge.{i}.SVLANcomponent}} or {{param: non-existent ####.Bridging.ProviderBridge.{i}.CVLANcomponents}} parameters. - 2.7
PCPEncoding string(31)[4:4]() W

Comma-separated list (4 items) (length ) of strings (length 31). This parameter provides the management control for the processing of the encoding of the Priority Code Point (PCP) field for the 802.1Q header as defined in [Section 6.9.3 Priority Code Point Encoding/802.1Q-2011] and [Table 6-3/802.1Q-2011]. The list is an ordered list that contains entries for the following 4 PCP Values: “8P0D”,“7P1D”, “6P2D” “5P3D”. Each list entry matches the following pattern:

Each list item matches one of:

  • ([0-7],){15}[0-7] (PCP for each priority and drop_eligible field (7, 7DE, 6, 6DE, …, 1, 1DE, 0, 0DE)) The value of this parameter MUST use square brackets to protect comma separators within nested lists. For example, this corresponds to Table 6-3 (mentioned above):
[7,7,6,6,5,5,4,4,3,3,2,2,1,1,0,0],[7,7,6,6,5,4,5,4,3,3,2,2,1,1,0,0],[7,7,6,6,5,4,5,4,3,2,3,2,1,1,0,0],[7,7,6,6,5,4,5,4,3,2,3,2,1,0,1,0]

Changes in 2.12:

  • Changed list = [4:4] -> 4:4
 - 2.7
PCPDecoding string(15)[4:4]() W

Comma-separated list (4 items) (length ) of strings (length 15). This parameter provides the management control for the processing of the decoding of the Priority Code Point (PCP) field for the 802.1Q header as defined in [Section 6.9.3 Priority Code Point Encoding/802.1Q-2011] and [Table 6-4/802.1Q-2011]. The list is an ordered list that contains entries for the following 4 PCP Values: “8P0D”,“7P1D”, “6P2D” “5P3D”. Each list entry matches the following pattern:

Each list item matches one of:

  • ([0-7],[0-1],){7}[0-7],[0-1] (Priority (0-7) and drop_eligible field (0-1) for each PCP value (7, 6, …, 1, 0)) The value of this parameter MUST use square brackets to protect comma separators within nested lists. For example, this corresponds to Table 6-4 (mentioned above):
[7,0,6,0,5,0,4,0,3,0,2,0,1,0,0,0],[7,0,6,0,4,0,4,1,3,0,2,0,1,0,0,0],[7,0,6,0,4,0,4,1,2,0,2,1,1,0,0,0],[7,0,6,0,4,0,4,1,2,0,2,1,0,0,0,1]

Changes in 2.12:

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 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 can exist with a given value for Alias, or with the same values for both VLAN and Port. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.Bridging.ProviderBridge.{i}. object(0:) W

Provider Bridge table. A Provider Bridge is described in [Section 5.10 Provider Bridge conformance/802.1Q-2011] as an entity that is comprised of one S-VLAN component and zero or more C-VLAN components. S-VLAN and C-VLAN components are modelled as instances of Bridge objects. When Type is configured with value of PE VLAN tags from the S-VLAN component (outer of 2 VLAN tags) are stacked on top of the VLAN tag from the C-VLAN component (inner of 2 VLAN tags). When Type is configured with value of S-VLAN only VLAN tags from the S-VLAN component are utilized.

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

Changes in 2.12:

  • Removed {{param: non-existent SVLANComponent ::: parameter
  • Changed parameter = {{param: non-existent CVLANComponents -> SVLANcomponent
  • Added CVLANcomponents parameter}}}}
 - 2.7
Status string R

The status of this ProviderBridge. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. For example when the Type is configured with value of PE but {{param: non-existent CVLANcomponents}} is an empty string. The Error value MAY be used by the CPE to indicate a locally defined error condition.
 Disabled 2.7
SVLANcomponent string(:256) W The value MUST be the Path Name of a Bridge instance that specifies the S-VLAN component for the ProviderBridge. If the referenced object is deleted, the parameter value MUST be set to an empty string. <Empty> 2.7
CVLANcomponents string(:256)[] W Comma-separated list of strings (maximum number of characters per item 256). Each list item MUST be the Path Name of a Bridge instance that specifies a C-VLAN component for the ProviderBridge. If the referenced object is deleted, the corresponding item MUST be removed from the list. <Empty> 2.7
Device.PPP. object R Point-to-Point Protocol [RFC1661]. This object contains the Interface table. - 2.0
Device.PPP.Interface.{i}. object(0:) W

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

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

Changes in 2.12:

  • Removed {{param: non-existent Reset ::: parameter
  • Added Reset() command}}
 - 2.0
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.

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Reset() command - On a reset the device MUST tear down the existing PPP connection represented by this object and establish a new one. The device MAY delay resetting the connection in order to avoid interruption of a user service such as an ongoing voice call. Reset on a disabled interface is a no-op (not an error). - 2.12
Device.PPP.Interface.{i}.PPPoE. object(0:1) R

PPPoE object that functionally groups PPPoE related parameters. PPPoE is only applicable when the lower layer provides Ethernet frames, e.g. ATM with EoA, PTM, or anything else that supports an Ethernet MAC.

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.0
Device.PPP.Interface.{i}.IPCP. object R IP Control Protocol (IPCP) client object for this PPP interface [RFC1332]. IPCP only applies to IPv4. - 2.0
DNSServers string(:45)[:2]() R [IPv4Address] Comma-separated list (up to 2 items) (length ) of IPv4Addresses. Items represent DNS Server IPv4 address(es) received via IPCP [RFC1877].

Changes in 2.12:

  • Added :2 list size
 <Empty> 2.0
Device.PPP.Interface.{i}.PPPoA. object(0:1) R

PPPoA object that functionally groups PPPoA related parameters. This object is OBSOLETED because it contains no standard parameters and its existence causes confusion.

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.2
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 ACS to create) Interface instances of type Loopback. When the ACS administratively disables the interface, i.e. sets Enable to false, the interface’s automatically-assigned IP addresses and prefixes MAY be retained. When the ACS administratively enables the interface, i.e. sets Enable to true, these IP addresses and prefixes MUST be refreshed. It’s up to the implementation to decide exactly what this means: it SHOULD take all reasonable steps to refresh everything but if it is unable, for example, to refresh a prefix that still has a significant lifetime, it might well choose to retain rather than discard it.

Any Tunneled IP interface instances instantiated by the CPE MUST NOT have any statistics, writable parameters, IP addresses or IPv6 prefixes. Any read-only parameters, e.g. Status, MUST return the same information as for the corresponding Tunnel interface. The reason for these rules is that Tunneled IP interfaces exist only in order to be the targets of references (within the data model) and do not model any concepts over and above those already modeled by the Tunnel IP interfaces.

Note that Tunnel and Tunneled IP interfaces are part of a legacy mechanism that is only used for IPv6rd, DSLite and IPsec tunnels and MUST NOT be used in any other context. For all other tunneling mechanisms Normal IP interfaces are stacked above technology-specific Tunnel Interfaces, e.g. above GRE.Tunnel.{i}.Interface or MAP.Domain.{i}.Interface objects.

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

Changes in 2.12:

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Reset() command - On a reset device MUST tear down the existing IP connection represented by this object and establish a new one. The device MAY delay resetting the connection in order to avoid interruption of a user service such as an ongoing voice call. Reset on a disabled interface is a no-op (not an error). - 2.12
TWAMPReflectorNumberOfEntries unsignedInt R The number of entries in the TWAMPReflector table. - 2.12
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 ACS.

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

 - 2.0
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. This parameter can only be modified if AddressingType is Static.

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.IP.Interface.{i}.TWAMPReflector.{i}. object(0:) W

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

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

 - 2.12
Enable boolean W Enables or disables the TWAMP reflector. - 2.12
Status string R

The current operational state of the TWAMP reflector.

Enumeration of:

  • Disabled
  • Active
  • Error (OPTIONAL)
 - 2.12
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.

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

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
Port unsignedInt(:65535) W The port used to listen for the TWAMP test packets. 862 2.12
MaximumTTL unsignedInt(1:255) W The maximum TTL of a received packet that this TWAMP reflector will reflect to the TWAMP controller. 1 2.12
IPAllowedList string[](:255) W Comma-separated list (maximum number of characters 255) of strings. List items represent source IP addresses and subnets from which test packets MUST always be received. An empty string list will allow test packets to be received from any source IP address. Each entry in the list MUST be either an IP address, or an IP prefix specified using Classless Inter-Domain Routing (CIDR) notation [RFC4632]. An IP prefix is specified as an IP address followed (with no intervening white space) by “/n”, where n (the prefix size) is an integer in the range 0-32 (for IPv4) or 0-128 (for IPv6) that indicates the number of (leftmost) ‘1’ bits of the prefix. IPv4 example:
  • 1.2.3.4 specifies a single IPv4 address, and 1.2.3.4/24 specifies a class C subnet with subnet mask 255.255.255.0.
  • 1.2.0.0/22 represents the 1024 IPv4 addresses from 1.2.0.0 to 1.2.3.255. IPv6 example:
  • fec0::220:edff:fe6a:f76 specifies a single IPv6 address.
  • 2001:edff:fe6a:f76::/64 represents the IPv6 addresses from 2001:edff:fe6a:f76:0:0:0:0 to 2001:edff:fe6a:f76:ffff:ffff:ffff:ffff.
 - 2.12
PortAllowedList string[](:255) W Comma-separated list (maximum number of characters 255) of strings. List items represent source port ranges from which test packets MUST always be received. An empty string list will allow test packets to be received from any source port. Each entry in the list MUST be either a port number or a range of port numbers separated by a hypen (-). For example, an entry with the value: ‘2-40’ accepts test packets from any allowed source IP addresses with a source port between 2 and 40 inclusive. An entry of ‘3’ accepts test packets from allow source IP addresses with a port of 3. - 2.12
Device.IP.Interface.{i}.IPv6Address.{i}. object(0:) W

This table contains the IP interface’s IPv6 unicast addresses. There MUST be an entry for each such address, including anycast addresses. There are several ways in which entries can be added to and deleted from this table, including:

  • Automatically via SLAAC [RFC4862], which covers generation of link-local addresses (for all types of device) and global addresses (for non-router devices).
  • Automatically via DHCPv6 [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 ACS. This table MUST NOT include entries for the Subnet-Router anycast address [Section 2.6.1/RFC4291]. Such entries would be identical to others but with a zero interface identifier, and would add no value. A loopback interface will always have address ::1 [Section 2.5.3/RFC4291] and MAY also have link-local address fe80::1. This object is based on ipAddressTable from [RFC4293].

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

 - 2.2
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. This parameter can only be modified if Origin is Static.

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 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 ACS. The CPE MAY choose not to create IPv6Prefix entries for WellKnown prefixes or for the ULA /48 prefix [RFC4193]. If an IPv6Prefix entry exists for the ULA /48 prefix, it MUST be on a downstream interface (i.e. an interface for which the physical layer interface object has Upstream = false). This object is based on ipAddressPrefixTable from [RFC4293].

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

 - 2.2
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. This parameter can only be modified if Origin is Static.

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.2
Device.IP.Diagnostics. object R The IP Diagnostics object.

Changes in 2.12:

 - 2.0
IPPing() command - [ASYNC] This command provides access to an IP-layer ping test. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Interface string(:256) W The value MUST be the Path Name of a row in the IP.Interface. or Bridging.Bridge.{i}.Port. tables. The layer 2 or layer 3 interface over which the test is to be performed. Example: Device.IP.Interface.1, Device.Bridge.1.Port.2 If an empty string is specified, the CPE MUST use the interface as directed by its bridging or routing policy (Forwarding table entries) to determine the appropriate interface. - 2.0
⇒ ProtocolVersion string W

Indicates the IP protocol to be used.

Enumeration of:

  • Any (Use either IPv4 or IPv6 depending on the system preference)
  • IPv4 (Use IPv4 for the Ping requests)
  • IPv6 (Use IPv6 for the Ping requests)
 - 2.8
⇒ Host string(:256) W Host name or address of the host to ping. In the case where Host is specified by name, and the name resolves to more than one address, it is up to the device implementation to choose which address to use. - 2.0
⇒ NumberOfRepetitions unsignedInt(1:) W Number of repetitions of the ping test to perform before reporting the results. - 2.0
⇒ Timeout unsignedInt(1:) W Timeout in milliseconds for the ping test. - 2.0
⇒ DataBlockSize unsignedInt(1:65535) W Size of the data block in bytes to be sent for each ping. - 2.0
⇒ DSCP unsignedInt(0:63) W DiffServ codepoint to be used for the test packets. By default the CPE SHOULD set this value to zero. - 2.0
⇐ Output. arguments - Output arguments. -
⇐ IPAddressUsed string(:45) R [IPAddress] Indicates which IP address was used to send the Ping request. - 2.8
⇐ SuccessCount unsignedInt R Result parameter indicating the number of successful pings (those in which a successful response was received prior to the timeout) in the most recent ping test. - 2.0
⇐ FailureCount unsignedInt R Result parameter indicating the number of failed pings in the most recent ping test. - 2.0
⇐ AverageResponseTime unsignedInt R Result parameter indicating the average response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 2.0
⇐ MinimumResponseTime unsignedInt R Result parameter indicating the minimum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 2.0
⇐ MaximumResponseTime unsignedInt R Result parameter indicating the maximum response time in milliseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 2.0
⇐ AverageResponseTimeDetailed unsignedInt R Result parameter indicating the average response time in microseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 2.7
⇐ MinimumResponseTimeDetailed unsignedInt R Result parameter indicating the minimum response time in microseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 2.7
⇐ MaximumResponseTimeDetailed unsignedInt R Result parameter indicating the maximum response time in microseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 2.7
TraceRoute() command - [ASYNC] This command defines access to an IP-layer trace-route test for the specified IP interface. - 2.0
⇒ Input. arguments - Input arguments. -
⇒ Interface string(:256) W The value MUST be the Path Name of a row in the IP.Interface. or Bridging.Bridge.{i}.Port. tables. The layer 2 or layer 3 interface over which the test is to be performed. Example: Device.IP.Interface.1, Device.Bridge.1.Port.2 If an empty string is specified, the CPE MUST use the interface as directed by its bridging or routing policy (Forwarding table entries) to determine the appropriate interface. - 2.0
⇒ ProtocolVersion string W

Indicates the IP protocol to be used.

Enumeration of:

  • Any (Use either IPv4 or IPv6 depending on the system preference)
  • IPv4 (Use IPv4 for the TraceRoute)
  • IPv6 (Use IPv6 for the TraceRoute)
 - 2.8
⇒ Host string(:256) W Host name or address of the host to find a route to. In the case where Host is specified by name, and the name resolves to more than one address, it is up to the device implementation to choose which address to use. - 2.0
⇒ NumberOfTries unsignedInt(1:3) W Number of tries per hop. Set prior to running Diagnostic. By default, the CPE SHOULD set this value to 3. - 2.0
⇒ Timeout unsignedInt(1:) W Timeout in milliseconds for each hop of the trace route test. By default the CPE SHOULD set this value to 5000. - 2.0
⇒ DataBlockSize unsignedInt(1:65535) W Size of the data block in bytes to be sent for each trace route. By default, the CPE SHOULD set this value to 38. - 2.0
⇒ DSCP unsignedInt(0:63) W DiffServ codepoint to be used for the test packets. By default the CPE SHOULD set this value to 0. - 2.0
⇒ MaxHopCount unsignedInt(1:64) W The maximum number of hop used in outgoing probe packets (max TTL). By default the CPE SHOULD set this value to 30. - 2.0
⇐ Output. arguments - Output arguments. -
⇐ IPAddressUsed string(:45) R [IPAddress] Indicates which IP address was used for TraceRoute. - 2.8
⇐ ResponseTime unsignedInt R Result parameter indicating the response time in milliseconds the most recent trace route test. If a route could not be determined, this value MUST be zero. - 2.0
⇐ RouteHops.{i}. object(0:) R

Contains the array of hop results returned. If a route could not be determined, this array will be empty

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

 - 2.0
⇐ Host string(:256) R Result parameter indicating the Host Name if DNS is able to resolve or IP Address of a hop along the discovered route. - 2.0
⇐ HostAddress string R If this parameter is not an empty string it will contain the last IP address of the host returned for this hop and the Host will contain the Host Name returned from the reverse DNS query. - 2.0
⇐ ErrorCode unsignedInt R Contains the error code returned for this hop. This code is directly from the ICMP CODE field. - 2.0
⇐ RTTimes unsignedInt[1:3](:16) R Comma-separated list (1 to 3 items) (maximum number of characters 16) of unsigned integers. Each list item contains one or more round trip times in milliseconds (one for each repetition) for this hop. A list item of 0 indicates that the corresponding response was not received. Round trip times of less than 1 milliseconds MUST be rounded up to 1. The number of list entries is determined by the value of NumberOfTries. - 2.0
DownloadTransports string[] R

Comma-separated list of strings. Supported DownloadDiagnostics transport protocols for a CPE device.

Each list item is an enumeration of:

  • HTTP
  • FTP (OPTIONAL)
 - 2.0
DownloadDiagnosticMaxConnections unsignedInt(1:) R Indicates the maximum number of connections that are supported by Download Diagnostics. - 2.9
DownloadDiagnosticsMaxIncrementalResult unsignedInt(1:) R The maximum number of rows in DownloadDiagnostics().IncrementalResult that the CPE will store. - 2.9
DownloadDiagnostics() command - [ASYNC] This command 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.12
⇒ Input. arguments - Input arguments. -
⇒ Interface string(:256) W The value MUST be the Path Name of a table row. The IP-layer interface over which the test is to be performed. Example: Device.IP.Interface.1 If an empty string is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface. - 2.0
⇒ DownloadURL string(:256) W The URL, as defined in [RFC3986], for the CPE to perform the download on. This parameter MUST be in the form of a valid HTTP [RFC2616] or FTP [RFC959] URL.
  • When using FTP transport, FTP binary transfer MUST be used.
  • When using HTTP transport, persistent connections MUST be used and pipelining MUST NOT be used.
  • When using HTTP transport the HTTP Authentication MUST NOT be used. Note: For time based tests (TimeBasedTestDuration > 0) the ACS MAY add a hint to duration of the test to the URL. See [Section 4.3/TR-143a1] for more details.
 - 2.0
⇒ DSCP unsignedInt(0:63) W The DiffServ code point for marking packets transmitted in the test. The default value SHOULD be zero. - 2.0
⇒ EthernetPriority unsignedInt(0:7) W Ethernet priority code for marking packets transmitted in the test (if applicable). The default value SHOULD be zero. - 2.0
⇒ TimeBasedTestDuration unsignedInt(0:999) W Controls time based testing [Section 4.3/TR-143a1]. When TimeBasedTestDuration > 0, TimeBasedTestDuration is the duration in seconds of a time based test. If TimeBasedTestDuration is 0, the test is not based on time, but on the size of the file to be downloaded. The default value SHOULD be 0. - 2.9
⇒ TimeBasedTestMeasurementInterval unsignedInt(0:999) W The measurement interval duration in seconds for objects in IncrementalResult for a time based FTP/HTTP download test (when TimeBasedTestDuration > 0). The default value SHOULD be 0, which implies IncrementalResult collection is disabled. For example if TimeBasedTestDuration is 90 seconds and TimeBasedTestMeasurementInterval is 10 seconds, there will be 9 results in IncrementalResult, each with a 10 seconds duration. - 2.9
⇒ TimeBasedTestMeasurementOffset unsignedInt(0:255) W This TimeBasedTestMeasurementOffset works in conjunction with TimeBasedTestMeasurementInterval to allow the interval measurement to start a number of seconds after BOMTime. The test measurement interval in IncrementalResult starts at time BOMTime + TimeBasedTestMeasurementOffset to allow for slow start window removal of file transfers. This TimeBasedTestMeasurementOffset is in seconds. The default value SHOULD be 0. - 2.9
⇒ ProtocolVersion string W

Indicates the IP protocol version to be used. The default value SHOULD be Any.

Enumeration of:

  • Any (Use either IPv4 or IPv6 depending on the system preference)
  • IPv4 (Use IPv4 for the requests)
  • IPv6 (Use IPv6 for the requests)
 - 2.9
⇒ 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 DownloadDiagnosticMaxConnections. - 2.9
⇒ EnablePerConnectionResults boolean W The results must be returned in the PerConnectionResult table for every connection when set to true. The default value SHOULD be false. - 2.9
⇐ Output. arguments - Output arguments. -
⇐ IPAddressUsed string(:45) R [IPAddress] Indicates which IP address was used to send the request. - 2.9
⇐ ROMTime dateTime R Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
  • For HTTP this is the time at which the client sends the GET command.
  • For FTP this is the time at which the client sends the RTRV command. If multiple connections are used, then ROMTime is set to the earliest ROMTime across all connections.
 - 2.0
⇐ BOMTime dateTime R Begin of transmission time in UTC, which MUST be specified to microsecond precision For example: 2008-04-09T15:01:05.123456Z
  • For HTTP this is the time at which the first data packet is received.
  • For FTP this is the time at which the client receives the first data packet on the data connection. If multiple connections are used, then BOMTime is set to the earliest BOMTime across all connections.
 - 2.0
⇐ EOMTime dateTime R End of transmission in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
  • For HTTP this is the time at which the last data packet is received.
  • For FTP this is the time at which the client receives the last packet on the data connection. If multiple connections are used, then EOMTime is set to the latest EOMTime across all connections.
 - 2.0
⇐ TestBytesReceived unsignedInt R The number of bytes received during the FTP/HTTP transaction including FTP/HTTP headers, between BOMTime and EOMTime across all connections. - 2.0
⇐ TotalBytesReceived unsignedInt R The total number of bytes (at the IP layer) received on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at BOMTime and at EOMTime and subtracting. - 2.0
⇐ TotalBytesSent unsignedInt R The total number of bytes (at the IP layer) sent on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at BOMTime and at EOMTime and subtracting. - 2.9
⇐ TestBytesReceivedUnderFullLoading unsignedInt R The number of bytes of the test file received between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime across all connections. - 2.9
⇐ TotalBytesReceivedUnderFullLoading unsignedInt R The total number of bytes (at the IP layer) received in between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at the latest PerConnectionResult.{i}.BOMTime and at the earliest PerConnectionResult.{i}.EOMTime and subtracting. - 2.9
⇐ TotalBytesSentUnderFullLoading unsignedInt R The total number of bytes (at the IP layer) sent between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at the latest PerConnectionResult.{i}.BOMTime and at the earliest PerConnectionResult.{i}.EOMTime and subtracting. - 2.9
⇐ PeriodOfFullLoading unsignedInt R The period of time in microseconds between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime of the test. - 2.9
⇐ TCPOpenRequestTime dateTime R Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
  • For HTTP this is the time at which the TCP socket open (SYN) was sent for the HTTP connection.
  • For FTP this is the time at which the TCP socket open (SYN) was sent for the data connection. Note: Interval of 1 microsecond SHOULD be supported. If multiple connections are used, then TCPOpenRequestTime is set to the latest TCPOpenRequestTime across all connections.
 - 2.0
⇐ TCPOpenResponseTime dateTime R Response time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
  • For HTTP this is the time at which the TCP ACK to the socket opening the HTTP connection was received.
  • For FTP this is the time at which the TCP ACK to the socket opening the data connection was received. Note: Interval of 1 microsecond SHOULD be supported. If multiple connections are used, then TCPOpenResponseTime is set to the latest TCPOpenResponseTime across all connections.
 - 2.0
⇐ PerConnectionResult.{i}. object(0:) R

Results for individual connections. This table is only populated when EnablePerConnectionResults is true. A new object is created for each connection specified in NumberOfConnections. Instance numbers MUST start at 1 and sequentially increment as new instances are created.

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

 - 2.9
⇐ ROMTime dateTime R Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
  • For HTTP this is the time at which the client sends the GET command.
  • For FTP this is the time at which the client sends the RTRV command.
 - 2.9
⇐ BOMTime dateTime R Begin of transmission time in UTC, which MUST be specified to microsecond precision For example: 2008-04-09T15:01:05.123456Z
  • For HTTP this is the time at which the first data packet is received.
  • For FTP this is the time at which the client receives the first data packet on the data connection.
 - 2.9
⇐ EOMTime dateTime R End of transmission in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
  • For HTTP this is the time at which the last data packet is received.
  • For FTP this is the time at which the client receives the last packet on the data connection.
 - 2.9
⇐ TestBytesReceived unsignedInt R The number of bytes of the test file received during the FTP/HTTP transaction including FTP/HTTP headers, between BOMTime and EOMTime. - 2.9
⇐ TotalBytesReceived unsignedInt R The total number of bytes (at the IP layer) received on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at BOMTime and at EOMTime and subtracting. - 2.9
⇐ TotalBytesSent unsignedInt R The total number of bytes (at the IP layer) sent on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at BOMTime and at EOMTime and subtracting. - 2.9
⇐ TCPOpenRequestTime dateTime R Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
  • For HTTP this is the time at which the TCP socket open (SYN) was sent for the HTTP connection.
  • For FTP this is the time at which the TCP socket open (SYN) was sent for the data connection.
 - 2.9
⇐ TCPOpenResponseTime dateTime R Response time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
  • For HTTP this is the time at which the TCP ACK to the socket opening the HTTP connection was received.
  • For FTP this is the time at which the TCP ACK to the socket opening the data connection was received.
 - 2.9
⇐ IncrementalResult.{i}. object(0:) R

Results for time segmented tests (tests where TimeBasedTestDuration > 0 and TimeBasedTestMeasurementInterval > 0). This data is totaled across all connections in the test. A new object is created every TimeBasedTestMeasurementInterval after that interval has completed. Instance numbers MUST start at 1 and sequentially increment as new instances are created.

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

 - 2.9
⇐ TestBytesReceived unsignedInt R Change in the value of TestBytesReceivedUnderFullLoading between StartTime and EndTime. - 2.9
⇐ TotalBytesReceived unsignedInt R The total number of bytes (at the IP layer) received on the Interface between StartTime and EndTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at StartTime and at EndTime and subtracting. - 2.9
⇐ TotalBytesSent unsignedInt R The total number of bytes (at the IP layer) sent on the Interface between StartTime and EndTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at StartTime and at EndTime and subtracting. - 2.9
⇐ StartTime dateTime R The start time of this interval which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z - 2.9
⇐ EndTime dateTime R The end time of this interval which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z - 2.9
UploadTransports string[] R

Comma-separated list of strings. Supported UploadDiagnostics transport protocols for a CPE device.

Each list item is an enumeration of:

  • HTTP
  • FTP (OPTIONAL)
 - 2.0
UploadDiagnosticsMaxConnections unsignedInt(1:) R Indicates the maximum number of connections that are supported by Upload Diagnostics. - 2.9
UploadDiagnosticsMaxIncrementalResult unsignedInt(1:) R The maximum number of rows in UploadDiagnostics().IncrementalResult that the CPE will store. - 2.9
UploadDiagnostics() command - [ASYNC] This command defines the diagnostics configuration for a HTTP or FTP UploadDiagnostics test. Files sent by the UploadDiagnostics do not require file storage on the CPE device, and MAY be an arbitrary stream of bytes. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Interface string(:256) W The value MUST be the Path Name of a table row. The IP-layer interface over which the test is to be performed. Example: Device.IP.Interface.1 If an empty string is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface. - 2.0
⇒ UploadURL string(:256) W The URL, as defined in [RFC3986], for the CPE to Upload to. This parameter MUST be in the form of a valid HTTP [RFC2616] or FTP [RFC959] URL.
  • When using FTP transport, FTP binary transfer MUST be used.
  • When using HTTP transport, persistent connections MUST be used and pipelining MUST NOT be used.
  • When using HTTP transport the HTTP Authentication MUST NOT be used.
 - 2.0
⇒ DSCP unsignedInt(0:63) W DiffServ code point for marking packets transmitted in the test. The default value SHOULD be zero. - 2.0
⇒ EthernetPriority unsignedInt(0:7) W Ethernet priority code for marking packets transmitted in the test (if applicable). The default value SHOULD be zero. - 2.0
⇒ TestFileLength unsignedInt W The size of the file (in bytes) to be uploaded to the server. The CPE MUST insure the appropriate number of bytes are sent. - 2.0
⇒ TimeBasedTestDuration unsignedInt(0:999) W Controls time based testing [Section 4.3/TR-143a1]. When TimeBasedTestDuration > 0, TimeBasedTestDuration is the duration in seconds of a time based test. If TimeBasedTestDuration is 0, the test is not based on time, but on the size of the file to be uploaded. The default value SHOULD be 0. - 2.9
⇒ TimeBasedTestMeasurementInterval unsignedInt(0:999) W The measurement interval duration in seconds for objects in IncrementalResult for a time based FTP/HTTP upload test (when TimeBasedTestDuration > 0). The default value SHOULD be 0, which implies IncrementalResult collection is disabled. For example if TimeBasedTestDuration is 90 seconds and TimeBasedTestMeasurementInterval is 10 seconds, there will be 9 results in IncrementalResult, each with a 10 seconds duration. - 2.9
⇒ TimeBasedTestMeasurementOffset unsignedInt(0:255) W This TimeBasedTestMeasurementOffset works in conjunction with TimeBasedTestMeasurementInterval and allows the interval measurement to start a number of seconds after BOMTime. The test measurement interval in IncrementalResult starts at time BOMTime + TimeBasedTestMeasurementOffset to allow for slow start window removal of file transfers. This TimeBasedTestMeasurementOffset is in seconds. The default value SHOULD be 0. - 2.9
⇒ ProtocolVersion string W

Indicates the IP protocol version to be used. The default value SHOULD be Any.

Enumeration of:

  • Any (Use either IPv4 or IPv6 depending on the system preference)
  • IPv4 (Use IPv4 for the requests)
  • IPv6 (Use IPv6 for the requests)
 - 2.9
⇒ 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 UploadDiagnosticsMaxConnections. - 2.9
⇒ EnablePerConnectionResults boolean W The results must be returned in the PerConnectionResult table for every connection when set to true. The default value SHOULD be false. - 2.9
⇐ Output. arguments - Output arguments. -
⇐ IPAddressUsed string(:45) R [IPAddress] Indicates which IP address was used to send the request. - 2.9
⇐ ROMTime dateTime R Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
  • For HTTP this is the time at which the client sends the GET command.
  • For FTP this is the time at which the client sends the RTRV command. If multiple connections are used, then ROMTime is set to the earliest ROMTime across all connections.
 - 2.0
⇐ BOMTime dateTime R Begin of transmission time in UTC, which MUST be specified to microsecond precision For example: 2008-04-09T15:01:05.123456Z
  • For HTTP this is the time at which the first data packet is received.
  • For FTP this is the time at which the client receives the first data packet on the data connection. If multiple connections are used, then BOMTime is set to the earliest BOMTime across all connections.
 - 2.0
⇐ EOMTime dateTime R End of transmission in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
  • For HTTP this is the time at which the last data packet is received.
  • For FTP this is the time at which the client receives the last packet on the data connection. If multiple connections are used, then EOMTime is set to the latest EOMTime across all connections.
 - 2.0
⇐ TestBytesSent unsignedInt R The number of bytes of the test file sent during the FTP/HTTP transaction including FTP/HTTP headers, between BOMTime and EOMTime acrosss all connections. - 2.9
⇐ TotalBytesReceived unsignedInt R The total number of bytes (at the IP layer) received on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at BOMTime and at EOMTime and subtracting. - 2.9
⇐ TotalBytesSent unsignedInt R The total number of bytes (at the IP layer) sent on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at BOMTime and at EOMTime and subtracting. - 2.0
⇐ TestBytesSentUnderFullLoading unsignedInt R The number of bytes of the test file sent between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime across all connections. - 2.9
⇐ TotalBytesReceivedUnderFullLoading unsignedInt R The total number of bytes (at the IP layer) received between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime across all connections in the test. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at the latest PerConnectionResult.{i}.BOMTime and at the earliest PerConnectionResult.{i}.EOMTime and subtracting. - 2.9
⇐ TotalBytesSentUnderFullLoading unsignedInt R The total number of bytes (at the IP layer) sent between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime across all connections in the test. This MAY be calculated by sampling Stats.bytesSent on the Interface object at the latest PerConnectionResult.{i}.BOMTime and at the earliest PerConnectionResult.{i}.EOMTime and subtracting. - 2.9
⇐ PeriodOfFullLoading unsignedInt R The period of time in microseconds between the latest PerConnectionResult.{i}.BOMTime and the earliest PerConnectionResult.{i}.EOMTime of the test. - 2.9
⇐ TCPOpenRequestTime dateTime R Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
  • For HTTP this is the time at which the TCP socket open (SYN) was sent for the HTTP connection.
  • For FTP this is the time at which the TCP socket open (SYN) was sent for the data connection. Note: Interval of 1 microsecond SHOULD be supported. If multiple connections are used, then TCPOpenRequestTime is set to the latest TCPOpenRequestTime across all connections.
 - 2.0
⇐ TCPOpenResponseTime dateTime R Response time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
  • For HTTP this is the time at which the TCP ACK to the socket opening the HTTP connection was received.
  • For FTP this is the time at which the TCP ACK to the socket opening the data connection was received. Note: Interval of 1 microsecond SHOULD be supported. If multiple connections are used, then TCPOpenResponseTime is set to the latest TCPOpenResponseTime across all connections.
 - 2.0
⇐ PerConnectionResult.{i}. object(0:) R

Results for individual connections. This table is only populated when EnablePerConnectionResults is true. A new object is created for each connection specified in NumberOfConnections. Instance numbers MUST start at 1 and sequentially increment as new instances are created.

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

 - 2.9
⇐ ROMTime dateTime R Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
  • For HTTP this is the time at which the client sends the GET command.
  • For FTP this is the time at which the client sends the RTRV command.
 - 2.9
⇐ BOMTime dateTime R Begin of transmission time in UTC, which MUST be specified to microsecond precision For example: 2008-04-09T15:01:05.123456Z
  • For HTTP this is the time at which the first data packet is received.
  • For FTP this is the time at which the client receives the first data packet on the data connection.
 - 2.9
⇐ EOMTime dateTime R End of transmission in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
  • For HTTP this is the time at which the last data packet is received.
  • For FTP this is the time at which the client receives the last packet on the data connection.
 - 2.9
⇐ TestBytesSent unsignedInt R The number of bytes of the test file sent during the FTP/HTTP transaction including FTP/HTTP headers, between BOMTime and EOMTime. - 2.9
⇐ TotalBytesReceived unsignedInt R The total number of bytes (at the IP layer) received on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at BOMTime and at EOMTime and subtracting. - 2.9
⇐ TotalBytesSent unsignedInt R The total number of bytes (at the IP layer) sent on the Interface between BOMTime and EOMTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at BOMTime and at EOMTime and subtracting. - 2.9
⇐ TCPOpenRequestTime dateTime R Request time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
  • For HTTP this is the time at which the TCP socket open (SYN) was sent for the HTTP connection.
  • For FTP this is the time at which the TCP socket open (SYN) was sent for the data connection.
 - 2.9
⇐ TCPOpenResponseTime dateTime R Response time in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z
  • For HTTP this is the time at which the TCP ACK to the socket opening the HTTP connection was received.
  • For FTP this is the time at which the TCP ACK to the socket opening the data connection was received.
 - 2.9
⇐ IncrementalResult.{i}. object(0:) R

Results for time segmented tests (tests where TimeBasedTestDuration > 0 and TimeBasedTestMeasurementInterval > 0). This data is totaled across all connections in the test. A new object is created every TimeBasedTestMeasurementInterval after that interval has completed. Instance numbers MUST start at 1 and sequentially increment as new instances are created.

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

 - 2.9
⇐ TestBytesSent unsignedInt R Change in the value of TestBytesSent between StartTime and EndTime. - 2.9
⇐ TotalBytesReceived unsignedInt R The total number of bytes (at the IP layer) received on the Interface between StartTime and EndTime. This MAY be calculated by sampling Stats.bytesReceived on the Interface object at StartTime and at EndTime and subtracting. - 2.9
⇐ TotalBytesSent unsignedInt R The total number of bytes (at the IP layer) sent on the Interface between StartTime and EndTime. This MAY be calculated by sampling Stats.bytesSent on the Interface object at StartTime and at EndTime and subtracting. - 2.9
⇐ StartTime dateTime R The start time of this interval which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z - 2.9
⇐ EndTime dateTime R The end time of this interval which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z - 2.9
UDPEchoDiagnosticsMaxResults unsignedInt(1:) R

The maximum number of rows in UDPEchoDiagnostics().IndividualPacketResult that the CPE will store. If a test would create more rows than UDPEchoDiagnosticsMaxResults only the first UDPEchoDiagnosticsMaxResults rows are present in UDPEchoDiagnostics().IndividualPacketResult.

Value Change Notification requests for this parameter MAY be denied.

 - 2.9
UDPEchoDiagnostics() command - [ASYNC] This command defines the diagnostics configuration for a UDP Echo test [Appendix A.1/TR-143a1] defined in [RFC862] or a UDP Echo Plus test defined in [Appendix A.1/TR-143a1]. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Interface string(:256) W The value MUST be the Path Name of the IP-layer interface over which the test is to be performed. Example: Device.IP.Interface.1 If an empty string is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface. - 2.9
⇒ Host string(:256) W Host name or address of the host to perform tests to. - 2.9
⇒ Port unsignedInt(1:65535) W Port on the host to perform tests to. - 2.9
⇒ NumberOfRepetitions unsignedInt(1:) W Number of repetitions of the test to perform before reporting the results. The default value SHOULD be 1. - 2.9
⇒ Timeout unsignedInt(1:) W Timeout in milliseconds for the test. That is, the amount of time to wait for the return of a packet that was sent to the Host. - 2.9
⇒ DataBlockSize unsignedInt(1:65535) W Size of the data block in bytes to be sent for each packet. The default value SHOULD be 24. - 2.9
⇒ DSCP unsignedInt(0:63) W DiffServ codepoint to be used for the test packets. The default value SHOULD be zero. - 2.9
⇒ InterTransmissionTime unsignedInt(1:65535) W The time in milliseconds between the NumberOfRepetitions of packets sent during a given test. The default value SHOULD be 1000. - 2.9
⇒ ProtocolVersion string W

Indicates the IP protocol version to be used. The default value SHOULD be Any.

Enumeration of:

  • Any (Use either IPv4 or IPv6 depending on the system preference)
  • IPv4 (Use IPv4 for the requests)
  • IPv6 (Use IPv6 for the requests)
 - 2.9
⇒ EnableIndividualPacketResults boolean W The results must be returned in the IndividualPacketResult table for every repetition of the test when set to true. The default value SHOULD be false. - 2.9
⇐ Output. arguments - Output arguments. -
⇐ IPAddressUsed string(:45) R [IPAddress] Indicates which IP address was used to send the request. - 2.9
⇐ SuccessCount unsignedInt R Result parameter indicating the number of successful packets (those in which a successful response was received prior to the timeout) in the most recent test. - 2.9
⇐ FailureCount unsignedInt R Result parameter indicating the number of failed packets (those in which a successful response was not received prior to the timeout) in the most recent test. - 2.9
⇐ AverageResponseTime unsignedInt R Result parameter indicating the average response time in microseconds over all repetitions with successful responses of the most recent test. If there were no successful responses, this value MUST be zero. - 2.9
⇐ MinimumResponseTime unsignedInt R Result parameter indicating the minimum response time in microseconds over all repetitions with successful responses of the most recent test. If there were no successful responses, this value MUST be zero. - 2.9
⇐ MaximumResponseTime unsignedInt R Result parameter indicating the maximum response time in microseconds over all repetitions with successful responses of the most recent test. If there were no successful responses, this value MUST be zero. - 2.9
⇐ 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. 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.

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

 - 2.9
⇐ PacketSuccess boolean R Indicates that the response to this UDP Echo Plus packet sent was received by the client. When this value is true, then all the remaining parameters in this instance are valid. Otherwise only the values originally set by the CPE client (e.g. PacketSendTime and TestGenSN) MAY be set to valid values. - 2.9
⇐ PacketSendTime dateTime R Time the client sent this UDP Echo Plus packet in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z - 2.9
⇐ PacketReceiveTime dateTime R Time the client receives the response packet in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z If this response is never received, PacketReceiveTime SHOULD be set to the Unknown Time value as specified in [Section 3.2.2/TR-106a7]. - 2.9
⇐ TestGenSN unsignedInt R The TestGenSN field in the UDPEcho Plus packet [Section A.1.4/TR-143a1] sent by the CPE client. - 2.9
⇐ TestRespSN unsignedInt R The TestRespSN field in the response packet [Section A.1.4/TR-143a1] from the UDP Echo Plus server (i.e. Host) for this Echo Plus packet sent by the CPE client. If PacketSuccess is false, TestRespSN SHOULD be 0. - 2.9
⇐ TestRespRcvTimeStamp unsignedInt R The TestRespRcvTimeStamp field in the response packet [Section A.1.4/TR-143a1] from the UDP Echo Plus server (i.e. Host) to record the reception time of this UDP Echo Plus packet sent from the CPE client. If PacketSuccess is false, TestRespRcvTimeStamp SHOULD be 0. - 2.9
⇐ TestRespReplyTimeStamp unsignedInt R The TestRespReplyTimeStamp field in the response packet [Section A.1.4/TR-143a1] from the UDP Echo Plus server (i.e. Host) to record the server reply time of this UDP Echo Plus packet sent from the CPE client. That is, the time that the server returned the UDP Echo Plus packet. If PacketSuccess is false, TestRespReplyTimeStamp SHOULD be 0. - 2.9
⇐ TestRespReplyFailureCount unsignedInt R The count value that was set by the UDP Echo Plus server (i.e. Host) to record the number of dropped echo response packets by the server. This count is incremented if a valid echo request packet is received at a UDP EchoPlus server but for some reason cannot be responded to (e.g. due to local buffer overflow, CPU utilization, etc…). If PacketSuccess is false, TestRespReplyFailureCount SHOULD be 0. - 2.9
ServerSelectionDiagnostics() command - [ASYNC] This command 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.12
⇒ Input. arguments - Input arguments. -
⇒ Interface string(:256) W The value MUST be the Path Name of the IP-layer interface over which the test is to be performed. Example: Device.IP.Interface.1 If an empty string is specified, the CPE MUST use the interface as directed by its routing policy (Forwarding table entries) to determine the appropriate interface. - 2.9
⇒ ProtocolVersion string W

Indicates the IP protocol version to be used.

Enumeration of:

  • Any (Use either IPv4 or IPv6 depending on the system preference)
  • IPv4 (Use IPv4 for the requests)
  • IPv6 (Use IPv6 for the requests)

The default value MUST be Any.

 - 2.9
⇒ Protocol string W

The protocol over which the test is to be performed.

Enumeration of:

  • ICMP
  • UDP Echo
 - 2.9
⇒ HostList string(:256)[:10]() W Comma-separated list (up to 10 items) (length ) of strings (maximum number of characters per item 256). Each entry is a Host name or address of a host to ping. - 2.9
⇒ NumberOfRepetitions unsignedInt(1:) W Number of repetitions of the ping test to perform for each HostList entry before reporting the results. - 2.9
⇒ Timeout unsignedInt(1:) W Timeout in milliseconds for each iteration of the ping test where the total number of iterations is the value of NumberOfRepetitions times the number of entities in the HostList Parameter. - 2.9
⇐ Output. arguments - Output arguments. -
⇐ FastestHost string R Result parameter indicating the Host (one of the items within the HostList Parameter) with the smallest average response time. - 2.9
⇐ MinimumResponseTime unsignedInt R Result parameter indicating the minimum response time in microseconds over all repetitions with successful responses of the most recent ping test for the Host identified in FastestHost. Success is defined by the underlying protocol used. If there were no successful responses across all Hosts, this value MUST be zero. - 2.9
⇐ AverageResponseTime unsignedInt R Result parameter indicating the average response time in microseconds over all repetitions with successful responses of the most recent ping test for the Host identified in FastestHost. Success is defined by the underlying protocol used. If there were no successful responses across all Hosts, this value MUST be zero. - 2.9
⇐ MaximumResponseTime unsignedInt R Result parameter indicating the maximum response time in microseconds over all repetitions with successful responses of the most recent ping test for the Host identified in FastestHost. Success is defined by the underlying protocol used. If there were no successful responses across all Hosts, this value MUST be zero. - 2.9
⇐ IPAddressUsed string(:45) R [IPAddress] Indicates which IP address was used to send the request to the host identified in FastestHost. - 2.9
Device.LLDP. object R This object contains Link Layer Discovery Protocol (LLDP) [802.1AB-2009] related objects and parameters. - 2.8
Device.LLDP.Discovery. object R This object is used for managing the discovery of LLDP devices. The CPE MAY, but need not, retain some or all of the information in this object across reboot. - 2.8
Device.LLDP.Discovery.Device.{i}. object(0:) R

This table contains information about discovered LLDP devices.

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

 - 2.8
Device.LLDP.Discovery.Device.{i}.Port.{i}. object(0:) R

This table contains information about ports on discovered LLDP devices.

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

 - 2.8
MACAddressList string(:17)[:255]() R [MACAddress] Comma-separated list (up to 255 items) (length ) of MAC Addresses. The device’s MAC addresses, which are included in the value of the LLDPDU’s Organizationally Specific TLV (TLV Type = 127), or an empty string if no list of MAC addresses has been received. The parameter is relevant when there is a LLDP device which has a MAC copy function and has two or more MAC addresses. Note: It is assumed that it might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the [OUI] in the third octet is E0271A (TTC-OUI) and the organizationally defined subtype in the sixth octet is 3 (MAC Address List).

Changes in 2.12:

  • Added :255 list size
 - 2.8
Device.LLDP.Discovery.Device.{i}.Port.{i}.LinkInformation. object R The port’s link information, which is included in the value of the LLDPDU’s Organizationally Specific TLV (TLV Type = 127). Note: It is assumed that this object might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the [OUI] in the third octet is E0271A (TTC-OUI) and the organizationally defined subtype in the sixth octet is 2 (Link Information). - 2.8
MACForwardingTable string(:17)[:255]() R [MACAddress] Comma-separated list (up to 255 items) (length ) of MAC Addresses. The port’s MAC forwarding table, or the value is an empty string if no forwarding table was supplied.

Changes in 2.12:

  • Added :255 list size
 - 2.8
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-181i2a5] for a description of the working of this IPsec data model. - 2.5
Device.IPsec.Profile.{i}. object(0:) W

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

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

 - 2.5
RemoteEndpoints string(:64)[:4]() W Comma-separated list (up to 4 items) (length ) of strings (maximum number of characters per item 64). The host name or IP address of the remote IPsec tunnel endpoint. If more than one name/address is supplied, they will be tried in turn, i.e. they are in decreasing order of precedence.

Changes in 2.12:

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

 - 2.8
RemoteEndpoints string(:256)[:4]() W Comma-separated list (up to 4 items) (length ) of strings (maximum number of characters per item 256). The Fully Qualified Domain Name (FQDN) or IP address of the remote GRE tunnel endpoint. If more than one name/address is supplied, they will be tried in turn, i.e. they are in decreasing order of precedence.

Changes in 2.12:

  • Added :4 list size
 - 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: * If the value of the AllInterfaces is true, then this entry will be applied to all Tunnel and Tunnel.{i}.Interface instances. * If the value of AllInterfaces is false and the value of Interface parameter is a reference to a row in the Tunnel table then this entry is applied to all Tunnel.{i}.Interface instances of the Tunnel reference. * If the value of AllInterfaces is false and the value of Interface parameter is a reference to a row in the Tunnel.{i}.Interface table then this entry is applied to the Tunnel.{i}.Interface reference. * If no entries are matched for the packet, then the default treatment (e.g., Tunnel.{i}.DefaultDSCPMark) is applied to the packet.

For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

 - 2.8
Alias string(:64) W

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object.

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

If the CPE supports the Alias-based Addressing 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.

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

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

Changes in 2.12:

  • Removed string(:64) syntax
  • Added Alias
 - 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
TunnelNumberOfEntries unsignedInt R The number of entries in the Tunnel table. - 2.12
FilterNumberOfEntries unsignedInt R The number of entries in the Filter table. - 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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.12
Enable boolean W Enables or disables the tunnel. - 2.12
Status string R

The current operational state of the tunnel.

Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL)
 - 2.12
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.

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

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
RemoteEndpoints string(:256)[:4] W Comma-separated list (up to 4 items) of strings (maximum number of characters per item 256). The Fully Qualified Domain Name (FQDN) or IP address of the remote L2TPv3 tunnel endpoint. If more than one name/address is supplied, they will be tried in turn, i.e. they are in decreasing order of precedence. - 2.12
KeepAlivePolicy string W

The mechanism used to keep the tunnel from timing out at the ConnectedRemoteEndpoint.

Enumeration of:

 None 2.12
KeepAliveTimeout unsignedInt W The tunnel keepalive timeout in seconds. 10 2.12
KeepAliveThreshold unsignedInt W Number of KeepAlive messages unacknowledged by the ConnectedRemoteEndpoint before the Tunnel is perceived failed. 3 2.12
DeliveryHeaderProtocol string W

The protocol used for the delivery header.

Enumeration of:

  • IPv4
  • IPv6
 - 2.12
DefaultDSCPMark unsignedInt W If the specified entries in the Filter table do not match this Tunnel object or an instance of the Interface object for this Tunnel object, then the value of this parameter is applied to the delivery header of the packets in this Tunnel. 0 2.12
TunnelEncapsulation string W

The protocol that this Tunnel will be encapsulated

Enumeration of:

  • IP
  • UDP
 IP 2.12
ConnectedRemoteEndpoint string(:256) R The Fully Qualified Domain Name (FQDN) name or IP address of the connected remote L2TPv3 tunnel endpoint. - 2.12
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.12
Device.L2TPv3.Tunnel.{i}.UDP. object R This UDP provides the parameters when the value of the Tunnel.{i}.TunnelEncapsulation parameter is UDP. - 2.12
SourcePort unsignedInt(:65535) W The source (local) port used to transmit PDUs. A value of 0 indicates that the port selection is performed by the device. 1701 2.12
RemotePort unsignedInt(:65535) W The remote port used to by the remote endpoint to transmit PDUs. 1701 2.12
EnableChecksum boolean W Enables or disables checksum processing. false 2.12
Device.L2TPv3.Tunnel.{i}.Stats. object R Statistics for this L2TPv3 tunnel, i.e. all traffic that has passed through the tunnel. The device MUST reset the tunnel’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the tunnel becomes operationally down due to a previous administrative down (i.e., Status parameter transitions to a disabled state after the tunnel has been disabled) or when the tunnel becomes administratively up (i.e. the Enable parameter transitioned from false to true). - 2.12
KeepAliveSent unsignedInt R [StatsCounter32] The total number of KeepAlive messages sent out the tunnel. - 2.12
KeepAliveReceived unsignedInt R [StatsCounter32] The total number of KeepAlive messages received by the tunnel. - 2.12
BytesSent unsignedLong R [StatsCounter64] The total number of bytes sent by the tunnel. - 2.12
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received by the tunnel. - 2.12
PacketsSent unsignedLong R [StatsCounter64] The total number of packets sent by the tunnel. - 2.12
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets received by the tunnel. - 2.12
ErrorsSent unsignedInt R [StatsCounter32] The total number of packets discarded by the tunnel due to any error. This can include packets dropped due to a lack of transmit buffers. - 2.12
ErrorsReceived unsignedInt R [StatsCounter32] The total number of packets received by the tunnel that contained errors preventing them from being delivered to a higher-layer protocol. - 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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.12
Enable boolean W Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. - 2.12
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863].
 - 2.12
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.

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

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
Name string(:64) R

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

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

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

 - 2.12
LastChange unsignedInt R

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. - 2.12
SessionID int(-1,1:65535) W The unique Session ID to be used in the L2TPv3 header of the tunnel. A Session ID with a value of -1 indicates that he CPE is to generate the session ids for this Interface instance. 1 2.12
CookiePolicy string W

The policy that defines how the Cookie is handled in this Interface instance.

Enumeration of:

  • Disabled (The device does not perform Cooking processing)
  • Configured (The value of the Cookie parameter is transmitted in the L2TPv3 header)
  • Generated (The device generates the value of the Cookie transmitted in the L2TPv3 header)
 Configured 2.12
Cookie unsignedLong W The Cookie transmitted in the L2TPv3 header. The default is to set the Cookie to the device’s MAC address that is encoded in the low order 6 bytes. - 2.12
Device.L2TPv3.Tunnel.{i}.Interface.{i}.Stats. object R Statistics for this L2TPv3 tunnel interface, i.e. all traffic that has passed through the interface. The device 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 has been disabled) or when the interface becomes administratively up (i.e. the Enable parameter transitioned from false to true). - 2.12
BytesSent unsignedLong R [StatsCounter64] The total number of bytes sent by this interface. - 2.12
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received by this interface. - 2.12
PacketsSent unsignedLong R [StatsCounter64] The total number of packets sent by this interface. - 2.12
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets received by this interface. - 2.12
ErrorsSent unsignedInt R [StatsCounter32] The total number of packets discarded by this interface due to any error. This can include packets dropped due to a lack of transmit buffers. - 2.12
ErrorsReceived unsignedInt R [StatsCounter32] The total number of packets received by this interface that contained errors preventing them from being delivered to a higher-layer protocol. - 2.12
DiscardChecksumReceived unsignedInt R [StatsCounter32] The total number of packets received by the tunnel interface that are discarded because of Checksum errors. - 2.12
DiscardSequenceNumberReceived unsignedInt R [StatsCounter32] The total number of packets received by the tunnel interface that are discarded because of Sequence Number errors. - 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 can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.12
Enable boolean W Enables or disables this filter. false 2.12
Status string R

The status of this filter. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPE to indicate a locally defined error condition.
 Disabled 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). 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 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 Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a Filter table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). - 2.12
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.

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

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

 - 2.12
Interface string(:256) W Filter criterion. The value MUST be the Path Name of a row in the Tunnel. or Tunnel.{i}.Interface. tables. If the referenced object is deleted, the parameter value MUST be set to an empty string. <Empty> 2.12
AllInterfaces boolean W Filter criterion. This specifies that all ingress L2TPv3 tunnel interfaces are associated with the entry. If true, the value of Interface is ignored since all ingress L2TPv3 tunnel interfaces are indicated. false 2.12
VLANIDCheck int(-1:) W Filter criterion. Current outer Ethernet VLAN ID as defined in 802.1Q. A value of -1 indicates this criterion is not used for filtering. -1 2.12
VLANIDExclude boolean W If false, the filter includes only those packets that match the VLANIDCheck entry, if specified. If true, the filter includes all packets except those that match the VLANIDCheck entry, if specified. false 2.12
DSCPMarkPolicy int(-2:63) W DSCP with which to mark the outer IP header for traffic that is associated with the interface criterion. Automatic DSCP marking behavior is a local matter to the device, possibly influenced by other Broadband Forum standards that it supports.
  • A value of -1 indicates copy from the upstream packet.
  • A value of -2 indicates automatic marking of DSCP.
 - 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
TunnelNumberOfEntries unsignedInt R The number of entries in the Tunnel table. - 2.12
FilterNumberOfEntries unsignedInt R The number of entries in the Filter table. - 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 (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.12
Enable boolean W Enables or disables the tunnel. - 2.12
Status string R

The current operational state of the tunnel.

Enumeration of:

  • Disabled
  • Enabled
  • Error (OPTIONAL)
 - 2.12
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.

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

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
RemoteEndpoints string(:256)[:4] W Comma-separated list (up to 4 items) of strings (maximum number of characters per item 256). The Fully Qualified Domain Name (FQDN) or IP address of the remote VXLAN tunnel endpoint. If more than one name/address is supplied, they will be tried in turn, i.e. they are in decreasing order of precedence. - 2.12
KeepAlivePolicy string W

The mechanism used to keep the tunnel from timing out at the ConnectedRemoteEndpoint.

Enumeration of:

 None 2.12
KeepAliveTimeout unsignedInt W The tunnel keepalive timeout in seconds. 10 2.12
KeepAliveThreshold unsignedInt W Number of KeepAlive messages unacknowledged by the ConnectedRemoteEndpoint before the Tunnel is perceived failed. 3 2.12
DeliveryHeaderProtocol string W

The protocol used for the delivery header.

Enumeration of:

  • IPv4
  • IPv6
 - 2.12
DefaultDSCPMark unsignedInt W If the specified entries in the Filter table do not match this Tunnel object or an instance of the Interface object for this Tunnel object, then the value of this parameter is applied to the delivery header of the packets in this Tunnel. 0 2.12
ConnectedRemoteEndpoint string(:256) R The Fully Qualified Domain Name (FQDN) name or IP address of the connected remote VXLAN tunnel endpoint. - 2.12
InterfaceNumberOfEntries unsignedInt R The number of entries in the Interface table. - 2.12
SourcePort unsignedInt(:65535) W The source (local) port used to transmit PDUs. A value of 0 indicates that the port selection is performed by the device. In such case, it is recommended that the UDP source port number be calculated using a hash of fields from the inner packet and that it is in the dynamic/private port range 49152-65535. 0 2.12
RemotePort unsignedInt(:65535) W The remote port used to by the remote endpoint to transmit PDUs. The well-known port allocated by IANA is 4789, but it should be configurable. 4789 2.12
Device.VXLAN.Tunnel.{i}.Stats. object R Statistics for this VXLAN tunnel, i.e. all traffic that has passed through the tunnel. The device MUST reset the tunnel’s Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the tunnel becomes operationally down due to a previous administrative down (i.e., Status parameter transitions to a disabled state after the tunnel has been disabled) or when the tunnel becomes administratively up (i.e. the Enable parameter transitioned from false to true). - 2.12
KeepAliveSent unsignedInt R [StatsCounter32] The total number of KeepAlive messages sent out the tunnel. - 2.12
KeepAliveReceived unsignedInt R [StatsCounter32] The total number of KeepAlive messages received by the tunnel. - 2.12
BytesSent unsignedLong R [StatsCounter64] The total number of bytes sent by the tunnel. - 2.12
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received by the tunnel. - 2.12
PacketsSent unsignedLong R [StatsCounter64] The total number of packets sent by the tunnel. - 2.12
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets received by the tunnel. - 2.12
ErrorsSent unsignedInt R [StatsCounter32] The total number of packets discarded by the tunnel due to any error. This can include packets dropped due to a lack of transmit buffers. - 2.12
ErrorsReceived unsignedInt R [StatsCounter32] The total number of packets received by the tunnel that contained errors preventing them from being delivered to a higher-layer protocol. - 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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.12
Enable boolean W Enables or disables the interface. This parameter is based on ifAdminStatus from [RFC2863]. - 2.12
Status string R

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

  • Up
  • Down
  • Unknown
  • Dormant
  • NotPresent
  • LowerLayerDown
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from [RFC2863].
 - 2.12
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.

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

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
Name string(:64) R

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

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

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

 - 2.12
LastChange unsignedInt R

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
LowerLayers string[](:1024) W Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object, or an empty string. See [Section 4.2.1/TR-181i2]. - 2.12
VNI int(-1:16777215,0:16777215) W The unique Virtual Network Identifier (VNI) to be used in the VXLAN header of the tunnel. A VNI with a value of -1 indicates that the CPE is to generate the VNI for this Interface instance. 1 2.12
Device.VXLAN.Tunnel.{i}.Interface.{i}.Stats. object R Statistics for this VXLAN tunnel interface, i.e. all traffic that has passed through the interface. The device 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 has been disabled) or when the interface becomes administratively up (i.e. the Enable parameter transitioned from false to true). - 2.12
BytesSent unsignedLong R [StatsCounter64] The total number of bytes sent by this interface. - 2.12
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received by this interface. - 2.12
PacketsSent unsignedLong R [StatsCounter64] The total number of packets sent by this interface. - 2.12
PacketsReceived unsignedLong R [StatsCounter64] The total number of packets received by this interface. - 2.12
ErrorsSent unsignedInt R [StatsCounter32] The total number of packets discarded by this interface due to any error. This can include packets dropped due to a lack of transmit buffers. - 2.12
ErrorsReceived unsignedInt R [StatsCounter32] The total number of packets received by this interface that contained errors preventing them from being delivered to a higher-layer protocol. - 2.12
DiscardChecksumReceived unsignedInt R [StatsCounter32] The total number of packets received by the tunnel interface that are discarded because of Checksum errors. - 2.12
DiscardSequenceNumberReceived unsignedInt R [StatsCounter32] The total number of packets received by the tunnel interface that are discarded because of Sequence Number errors. - 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 can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.12
Enable boolean W Enables or disables this filter. false 2.12
Status string R

The status of this filter. Enumeration of:

  • Disabled
  • Enabled
  • Error_Misconfigured
  • Error (OPTIONAL) The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPE to indicate a locally defined error condition.
 Disabled 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). 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 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 Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a Filter table entry MUST be one greater than the largest current value (initially assigned the lowest precedence). - 2.12
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.

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

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

 - 2.12
Interface string(:256) W Filter criterion. The value MUST be the Path Name of a row in the Tunnel. or Tunnel.{i}.Interface. tables. If the referenced object is deleted, the parameter value MUST be set to an empty string. <Empty> 2.12
AllInterfaces boolean W Filter criterion. This specifies that all ingress VXLAN tunnel interfaces are associated with the entry. If true, the value of Interface is ignored since all ingress VXLAN tunnel interfaces are indicated. false 2.12
VLANIDCheck int(-1:) W Filter criterion. Current outer Ethernet VLAN ID as defined in 802.1Q. A value of -1 indicates this criterion is not used for filtering. -1 2.12
VLANIDExclude boolean W If false, the filter includes only those packets that match the VLANIDCheck entry, if specified. If true, the filter includes all packets except those that match the VLANIDCheck entry, if specified. false 2.12
DSCPMarkPolicy int(-2:63) W DSCP with which to mark the outer IP header for traffic that is associated with the interface criterion. Automatic DSCP marking behavior is a local matter to the device, possibly influenced by other Broadband Forum standards that it supports.
  • A value of -1 indicates copy from the upstream packet.
  • A value of -2 indicates automatic marking of DSCP.
 - 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-181i2a8] 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):

  • MAP-E (TransportMode = Encapsulation) uses an IPv4-in-IPv6 tunnel.
  • MAP-T (TransportMode = Translation) uses stateless NAT64. Note: There is an n:1 relationship between a MAP domain and the associated WANInterface, i.e. in theory multiple MAP domains can be associated with a single WAN IP interface (each domain would have its own End-user IPv6 prefix and MAP IPv6 address). Note: The Domain table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Domain row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending Domain row.

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

 - 2.8
PSIDOffset unsignedInt(0:15) W Port-set ID (PSID) offset in bits. The number of Port-sets is 2^PSIDOffset. Corresponds to the [RFC7598] S46_PORTPARAMS (Port Parameters) option’s offset field. This parameter is DEPRECATED 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.

Changes in 2.12:

  • Added status = deprecated
 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 is DEPRECATED 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.

Changes in 2.12:

  • Added status = deprecated
 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 is DEPRECATED 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.

Changes in 2.12:

  • Added status = deprecated
 0 2.8
Device.MAP.Domain.{i}.Rule.{i}. object(0:) W

The MAP domain’s Mapping Rules [RFC7597]. The rule with the longest match between its IPv6Prefix and the end-user IPv6Prefix is the Basic Mapping Rule (BMR). Any of the rules (including the BMR) can be a Forwarding Mapping Rule.

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

Changes in 2.12:

 - 2.8
PSIDOffset unsignedInt(0:15) W Port-set ID (PSID) offset in bits. The number of Port-sets is 2^PSIDOffset. Corresponds to the [RFC7598] S46_PORTPARAMS (Port Parameters) option’s offset field. 6 2.12
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. 0 2.12
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. 0 2.12
Device.Routing. object R Routing object that contains the Router table and RIP protocol object. - 2.0
Device.Routing.Router.{i}. object(0:) W

This object allows the handling of the routing and forwarding configuration of the device.

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 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 can exist with a given value for Alias, or with the same values for all of DestIPAddress, DestSubnetMask, ForwardingPolicy, GatewayIPAddress, Interface and ForwardingMetric. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 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 can exist with a given value for Alias, or with the same values for all of DestIPPrefix, ForwardingPolicy, NextHop, Interface and ForwardingMetric. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 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 can exist with a given value for Alias, or with a given value for Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

Changes in 2.12:

  • Removed {{param: non-existent Version ::: parameter}}
 - 2.0
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.

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
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 can exist with a given value for Alias, or with a given value for Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 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 can exist with a given value for Alias, or with a given value for Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.2
ManualPrefixes string[:8]() W Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Manually-configured prefixes that will be sent in Router Advertisement messages. Each referenced prefix MUST have a IP.Interface.{i}.IPv6Prefix.{i}.StaticType of Static or Child. Router Advertisement messages MUST include Prefix Information Options [RFC4861] for all Valid (IP.Interface.{i}.IPv6Prefix.{i}.ValidLifetime is infinite or in the future) prefixes in this list. Prefixes MUST be associated with the interface instance referenced by Interface.

Changes in 2.12:

  • Added :8 list size
 <Empty> 2.2
Prefixes string[:8]() R

Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. All prefixes that will be included in Router Advertisement (RA) messages sent out this interface. This list can include:

Changes in 2.12:

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 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-181i2a2] 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) 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.

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.2
BorderRelayIPv4Addresses string(:45)[:4]() W [IPv4Address] Comma-separated list (up to 4 items) (length ) of IPv4Addresses. List items are the IPv4 addresses (possibly anycast) of the 6rd Relay(s).

Changes in 2.12:

  • Added :4 list size
 - 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-181i2a2] 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) 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.

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.2
Device.QoS. object R Queue management configuration object. - 2.0
Device.QoS.Classification.{i}. object(0:) W

Classification table. For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.QoS.App.{i}. object(0:) W

Application table.

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.QoS.Flow.{i}. object(0:) W

Flow table.

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.QoS.Policer.{i}. object(0:) W

Policer table.

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.QoS.Queue.{i}. object(0:) W

Queue table. Each entry is associated with a set of traffic classes, which are specified via the TrafficClasses parameter, and is configured with weight, precedence, drop algorithm, scheduler algorithm etc as appropriate for the traffic classes. An entry can be associated either with all egress interfaces (in which case an actual queue will be instantiated on each egress interface on which traffic of that traffic class can be generated) or else with a single specified egress interface. For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.QoS.QueueStats.{i}. object(0:) W

Queue statistics table. This table is managed by the ACS, which will create entries only for those {Queue, Interface} combinations for which statistics are to be collected. Note: The QueueStats table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated QueueStats row to then violate the table’s unique key constraint; if this occurs, the CPE MUST disable the offending QueueStats row.

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.QoS.Shaper.{i}. object(0:) W

Shaper table. Used to shape the queue(s) associated with Interface. In case of a single queue for that interface, determines the egress rate of the queue. In case of multiple queues for that interface (possibly with per queue shaping rates), determines the aggregate egress rate on that interface. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The Shaper table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Shaper row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending Shaper row.

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
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 {{param: reference to deprecated parameter Device.Hosts.Host.{i}.Alias}}, or with a given value for PhysAddress.

Changes in 2.12:

 - 2.0
Alias string(:64) W

A

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

If the CPE supports the Alias-based Addressing 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.

non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object.

This parameter is DEPRECATED because Host is a transient object.

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

Changes in 2.12:

  • Removed string(:64) syntax
  • Added Alias
 - 2.0
DHCPClient string[:2]() R Comma-separated list (up to 2 items) (length ) of strings. Each list item MUST be the Path Name of a row in the DHCPv4.Server.Pool.{i}.Client. or DHCPv6.Server.Pool.{i}.Client. tables. If the referenced object is deleted, the corresponding item MUST be removed from the list. Each list item is the DHCPv4 or DHCPv6 server’s client entry that corresponds to the host.

Changes in 2.12:

  • Added :2 list size
 - 2.2
Active boolean R Whether or not the host is currently present on the LAN. The method of presence detection is a local matter to the CPE. The ability to list inactive hosts is OPTIONAL. If the CPE includes inactive hosts in this table, Active MUST be set to false for each inactive host. The length of time an inactive host remains listed in this table is a local matter to the CPE. Entries in Device.Hosts.Host SHOULD NOT be removed when they become inactive if there are WANStats statistics collected for the entry in the past seven days. - 2.0
ActiveLastChange dateTime R The datetime when Active last changed from true to false or from false to true. The initial detection of a host SHOULD be treated as a transition from false to true, showing the datetime when the host was first detected. The ability to list inactive hosts is OPTIONAL. The length of time an inactive host remains listed in this table is a local matter to the CPE. Entries in Device.Hosts.Host SHOULD NOT be removed when they become inactive if there are WANStats statistics collected for the entry in the past seven days. - 2.10
Device.Hosts.Host.{i}.WANStats. object R These count bytes or packets at the IP layer sent to the WAN, or received from the WAN. - 2.12
BytesSent unsignedLong R [StatsCounter64] The total number of bytes transmitted to the WAN from the Host device at the IP layer. - 2.12
BytesReceived unsignedLong R [StatsCounter64] The total number of bytes received from the WAN and sent to the Host device at the IP layer. - 2.12
PacketsSent unsignedLong R [StatsCounter64] The total number of IP packets transmitted to the WAN from the Host device. - 2.12
PacketsReceived unsignedLong R [StatsCounter64] The total number of IP packets received from the WAN and sent to the Host device. - 2.12
ErrorsSent unsignedInt R [StatsCounter32] The total number of outbound IP packets to the WAN from the Host device that could not be transmitted because of errors. These may be due to the number of retransmissions exceeding the retry limit, or from other causes. - 2.12
RetransCount unsignedInt R [StatsCounter32] The total number of transmitted IP packets to the WAN from the Host device which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two. - 2.12
DiscardPacketsSent unsignedInt R

[StatsCounter32] The total number of outbound IP packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space.

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
Device.DNS. object R Properties for Domain Name Service (DNS). - 2.0
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 DHCP 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 ACS.

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.DNS.Relay. object R DNS Relay object. The DNS proxy (or relay) function allows the forwarding of local network DNS queries to local or external DNS server(s) [RFC5625]. - 2.0
Device.DNS.Relay.Forwarding.{i}. object(0:) W

DNS Server forwarding policy to be used by the DNS Relay. Entries are either automatically created as result of DHCP (v4 or v6), IPCP, or RA received DNS server information, or are statically configured by the ACS. Note: Management of re-directing queries to the device embedded DNS server is not defined in this version of the specification.

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.DNS.Diagnostics. object R The DNS Diagnostics object containing the {{object: non-existent NSLookupDiagnostics()}} test.

Changes in 2.12:

 - 2.0
NSLookupDiagnostics() command - [ASYNC] This command defines access to an IP-layer NS Lookup test for the specified IP interface. When initiated, the NS Lookup test will contact DNSServer and look up HostName NumberOfRepetitions times. There will be a Result instance for each time the device performs a DNS lookup, which is determined by the value of NumberOfRepetitions. Any previous Result instances are removed when a new test is initiated. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Interface string(:256) W The value MUST be the Path Name of a table row. This parameter specifies the IP-layer interface over which the test is to be performed (i.e. the source IP address to use when performing the test). If an empty string is specified, the CPE MUST use its routing policy (Forwarding table entries), if necessary, to determine the appropriate interface. - 2.0
⇒ HostName string(:256) W Specifies the Host Name that NS Lookup is to look for. The current domain name MUST be used unless the name is a fully qualified name. - 2.0
⇒ DNSServer string(:256) W Specifies the DNS Server name or IP address that NS Lookup is to use for the lookup. The name of this server will be resolved using the default DNS server unless an IP address is provided. If an empty string is specified, the device’s default DNS server will be used. - 2.0
⇒ Timeout unsignedInt W Timeout in milliseconds that indicates that a request has failed. - 2.0
⇒ NumberOfRepetitions unsignedInt W The number of times the device SHOULD repeat the execution of the NSLookup using the same input parameters. If the diagnostics test fails the CPE MAY terminate the test without completing the full number of repetitions. Each repetition will use a Result instance to hold the NSLookup result data. - 2.0
⇐ Output. arguments - Output arguments. -
⇐ SuccessCount unsignedInt R Number of successfully executed repetitions. - 2.0
⇐ Result.{i}. object(0:) R

Results from the most recent invocation of the test, one instance per repetition.

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

 - 2.0
⇐ Status string R

Result Parameter to represent whether the NS Lookup was successful or not.

Enumeration of:

  • Success
  • Error_DNSServerNotAvailable
  • Error_HostNameNotResolved
  • Error_Timeout
  • Error_Other
 - 2.0
⇐ AnswerType string R

Result parameter to represent whether the answer is Authoritative or not.

Enumeration of:

  • None (Indicates that the NS Lookup failed to find the host)
  • Authoritative
  • NonAuthoritative
 - 2.0
⇐ HostNameReturned string(:256) R Result parameter to represent the fully qualified name for the Host Name in the calling parameter (e.g. HostName.DomainName); if no response was provided, then this parameter is an empty string. - 2.0
⇐ IPAddresses string(:45)[:10]() R [IPAddress] Comma-separated list (up to 10 items) (length ) of IP Addresses. Indicates the IP Address results returned by the NS Lookup; if no response was provided, then this parameter is an empty string. - 2.0
⇐ DNSServerIP string(:45) R [IPAddress] Result parameter to represent the actual DNS Server IP address that the NS Lookup used. - 2.0
⇐ ResponseTime unsignedInt R Response time (for the first response packet) in milliseconds, or 0 if no response was received. - 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.12:

 - 2.6
AdvertisedInterfaces string[] W Comma-separated list of strings. Each list item MUST be the Path Name of the IP.Interface object instance from which DNS-SD services are advertised. If the referenced object is deleted, the corresponding item MUST be removed from the list. If this parameter is not supported by an implementation then DNS-SD services are advertised on all LAN interfaces. - 2.12
Device.NAT. object R Properties for Network Address Translation (NAT). The entire NAT object only applies to IPv4. - 2.0
Device.NAT.InterfaceSetting.{i}. object(0:) W

NAT settings for an associated IP Interface on which NAT is enabled. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The InterfaceSetting table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated InterfaceSetting row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending InterfaceSetting row.

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

 - 2.0
Status string R

The status of this entry. Enumeration of:

  • Disabled
  • Enabled
  • Enabled_NATForcedDisabled (NAT enabled but forced by a third party to be operationally disabled, e.g. because a MAP.Domain is enabled but there is no Basic Mapping Rule [RFC7597])
  • Enabled_PortMappingDisabled (NAT enabled but port mapping has been operationally disabled by a third party, e.g. because this is REQUIRED by the current Firewall level)
  • Error_Misconfigured
  • Error (

Changes in 2.12:

  • Removed optional = true

) The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPE to indicate a locally defined error condition.

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 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 can exist with a given value for Alias, or with the same values for all of RemoteHost, ExternalPort and Protocol. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, ExternalPort and Protocol such that the new entry does not conflict with any existing entries.

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Device.DHCPv4. object R The Dynamic Host Configuration Protocol (DHCP) IPv4 object [RFC2131]. This entire object applies to IPv4 only. It contains the Client, Server, and Relay objects. - 2.0
Device.DHCPv4.Client.{i}. object(1:) W

This object contains DHCP client settings for an associated IP Interface indicated by Interface. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The Client table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Client row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending Client row.

This table MUST contain at least 1 entry.

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

Changes in 2.12:

  • Removed {{param: non-existent Renew ::: parameter
  • Added Renew() command}}
 - 2.0
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.

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Renew() command - The DHCP client will renew its DHCP lease. - 2.12
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 can exist with a given value for Alias, or with a given value for Tag. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Tag such that the new entry does not conflict with any existing entries.

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
ReservedAddresses string(:45)[:32]() W [IPv4Address] Comma-separated list (up to 32 items) (length ) of IPv4Addresses. List items represent addresses marked reserved from the address allocation pool.

Changes in 2.12:

  • Added :32 list size
 <Empty> 2.0
DNSServers string(:45)[:4]() W [IPv4Address] Comma-separated list (up to 4 items) (length ) of IPv4Addresses. List items represent DNS servers offered to DHCP clients. Support for more than three DNS Servers is OPTIONAL. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with Client.{i}.PassthroughEnable or a PPP interface with PPP.Interface.{i}.IPCP.PassthroughEnable equal to true.

Changes in 2.12:

  • Added :4 list size
 - 2.0
IPRouters string(:45)[:4]() W [IPv4Address] Comma-separated list (up to 4 items) (length ) of IPv4Addresses. List items represent addresses of routers on this subnet. Also known as default gateway. Support for more than one Router address is OPTIONAL. The parameter value can be overwritten by dynamic values retrieved via a DHCP client with Client.{i}.PassthroughEnable or a PPP interface with PPP.Interface.{i}.IPCP.PassthroughEnable equal to true.

Changes in 2.12:

  • Added :4 list size
 - 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 can exist with a given value for Alias, or with a given value for Chaddr. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 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 can exist with a given value for Alias, or with a given value for Interface. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

Changes in 2.12:

  • Removed {{param: non-existent Renew ::: parameter
  • Added Renew() command}}
 - 2.2
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.

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.2
Renew() command - The Client will renew its DHCPv6-supplied information (i.e. the Agent will do a renew or information request as needed, updating both stateful and stateless parameter values discovered by this Client instance). - 2.12
Device.DHCPv6.Client.{i}.SentOption.{i}. object(0:) W

The top-level options and option values (including any encapsulated options) that the client will send to the server. This table is intended only for options that are not part of the basic operation of the protocol, and whose values are simple, do not often change and are not modeled elsewhere. For example, it is appropriate for OPTION_USER_CLASS (whose value is a list of user classes) but is not appropriate for OPTION_RECONF_MSG (which is part of the protocol), OPTION_IA_NA (which is modeled via RequestAddresses) or OPTION_RAPID_COMMIT (which is modeled via RapidCommit).

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.2
IANAManualPrefixes string[:8]() W Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Manually-configured prefixes from which IA_NA addresses will be assigned. Each referenced prefix MUST have a IP.Interface.{i}.IPv6Prefix.{i}.StaticType of Static or Child. All clients that request IA_NA and match filter criteria on this Interface MUST be offered IA_NA addresses from all of the Valid (IP.Interface.{i}.IPv6Prefix.{i}.ValidLifetime is infinite or in the future) /64 prefixes in this list. Prefixes MUST be associated with the interface instance referenced by Interface.

Changes in 2.12:

  • Added :8 list size
 <Empty> 2.2
IANAPrefixes string[:8]() R

Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. All prefixes from which IA_NA addresses will be assigned. This list can include:

Changes in 2.12:

  • Added :8 list size
 - 2.2
IAPDManualPrefixes string[:8]() W

Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Manually-configured prefixes from which IA_PD prefixes will be derived. This list can include:

Changes in 2.12:

  • Added :8 list size
 <Empty> 2.2
IAPDPrefixes string[:8]() R

Comma-separated list (up to 8 items) (length ) of strings. Each list item MUST be the Path Name of a row in the IP.Interface.{i}.IPv6Prefix. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. All prefixes for which IA_PD prefixes will be assigned. This list can include:

Changes in 2.12:

  • Added :8 list size
 - 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) 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. 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.

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.2
Device.DHCPv6.Server.Pool.{i}.Option.{i}. object(0:) W

This object specifies the DHCPv6 options that MUST, if enabled, be offered to clients whose DHCPv6 requests are associated with this pool. If PassthroughClient is specified, and the referenced client has a value for a given option then the PassthroughClient option value will be sent instead of Value. Otherwise, Value will be sent.

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.2
Device.IEEE8021x. object R IEEE 802.1x object [802.1x-2004], where Supplicant models authentication supplicants. - 2.0
Device.IEEE8021x.Supplicant.{i}. object(1:) W

802.1x supplicant authentication provisioning and status information associated with an interface to be authenticated (e.g. an Ethernet.Link instance). For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The Supplicant table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Supplicant row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending Supplicant row.

This table MUST contain at least 1 entry.

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

Changes in 2.12:

  • Removed {{param: non-existent Reset ::: parameter
  • Removed {{param: non-existent Disconnect parameter
  • Added Reset() command
  • Added Disconnect() command}}}}
 - 2.0
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.

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.0
Reset() command - On a reset the device MUST reset the session by performing an initial authentication attempt as defined in [Section 9.6.1.3/802.1x-2004], Initialize Port by sending out the EAP start message. The device MAY delay resetting the resource in order to avoid interruption of a user service such as an ongoing voice call. - 2.12
Disconnect() command - On a reset the device MUST disconnect (forced unauthentication) the resource. The device MAY delay re-authentication of the resource in order to avoid interruption of a user service such as an ongoing voice call. - 2.12
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.

Changes in 2.12:

  • Removed {{param: non-existent Reset ::: parameter
  • Added Reset() command}}
 - 2.0
Reset() command - Reset the SmartCard Reader and the associated SmartCard. - 2.12
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. The Firewall rules modeled by this object 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 CPE. 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-181i2a2] for an example Advanced configuration. - 2.0
Device.Firewall.Level.{i}. object(0:) W

Firewall Level table. When an Advanced configuration is selected, AdvancedLevel 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 (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.2
Device.Firewall.Chain.{i}. object(0:) W

Firewall Chain table. Each entry contains an ordered list of Rule objects which can themselves reference other Chain instances. A hierarchy of rules can therefore be created. A given Firewall Chain’s rules are all created by the same entity, as indicated by the Creator parameter.

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.2
Device.Firewall.Chain.{i}.Rule.{i}. object(0:) W

Firewall Rule table. Each entry defines a Firewall packet selection rule. The Target parameter defines the action to perform for traffic matching this rule: the packet can be dropped, accepted, rejected or passed to another Chain. This table MUST NOT contain dynamic Firewall rules associated with Stateful Firewall sessions. All entries are created by the creator of the parent Chain, as indicated by its Creator parameter. Rule entries in a Chain with a Creator of Defaults, ACS, UserInterface or (maybe) Other are referred to as Static Rules. Whether or not a Rule in a Chain with Creator Other is regarded as Static is a local matter to the CPE. Some of this object’s parameter descriptions refer to whether a Rule is Static when specifying whether or not the parameter value can be modified. For enabled table entries, if SourceInterface is not a valid reference and SourceAllInterfaces is false, or if DestInterface is not a valid reference and DestAllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

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

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

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

Value Change Notification requests for this parameter MAY be denied.

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.2
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 ACS as a comma-separated list of the most recent samples. This object provides a single set of global settings that affect the entire device unless overridden locally. - 2.0
Device.PeriodicStatistics.SampleSet.{i}. object(0:) W

Periodic statistics sample set table. Each sample set has its own sample interval etc.

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

Changes in 2.12:

  • Removed {{param: non-existent ForceSample ::: parameter
  • Added ForceSample() command}}
 - 2.0
ForceSample() command - Force statistics for the current sample to be calculated and updated in the data model. If this is the first time that this command is called during the current sample interval, this MUST cause a new value to be added to each of the periodic statistics comma-separated list parameters, and the ReportEndTime and all SampleSeconds parameters MUST be updated accordingly. If this is not the first time that this command is during the current sample interval, then the new values that were added as described in the previous paragraph, and the ReportEndTime and all SampleSeconds parameters, MUST be updated accordingly. Note that {{param: empty ref only valid in parameter descriptions}} just provides a “sneak preview” of the current sample. It does not create a new sample and it does not interfere with the sample interval schedule. At the end of each sample interval, if this command was executed during the sample interval then the new values that were added as described above, and the ReportEndTime and all SampleSeconds parameters, will be updated accordingly. In other words, the partial sample data that was created when the command was executed will be updated one last time at the end of the sample interval. - 2.12
Device.FAP. object R This object is the container for all Femto related component objects, to prevent pollution of the so-called global namespace of the BBF with FAP specific objects. - 2.4
Device.FAP.GPS. object R This object contains the parameters relating to the GPS scan.

Changes in 2.12:

  • Removed {{param: non-existent GPSReset ::: parameter
  • Added GPSReset() command}}
 - 2.4
GPSReset() command - Reset the GPS Hardware. - 2.12
Device.BulkData. object R This object provides bulk data collection capabilities and global collection settings that affect the entire device. Bulk Data utilizes various solutions (e.g., IPDR, HTTP) to collect data from devices and transfer the data to a collection server. The IPDR solution is based on a service specification described in [TR-232]. The HTTP solution is based on transfer mechanisms described in [Annex A/TR-157a10]. 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 ACS to configure multiple reports to be generated at different times for different sets of data.

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

Changes in 2.12:

 - 2.5
Controller string R The value MUST be the Path Name of the Device.LocalAgent.Controller. instance that created or last updated this Profile. If the referenced object is deleted, the parameter value MUST be set to an empty string. The value of this parameter is automatically populated by the USP Agent upon Profile creation using the reference to the USP Controller that created the instance. The value of this parameter is automatically updated by the USP Agent upon Profile alteration using the reference to the USP Controller that changed the instance. - 2.5
StreamingPort unsignedInt(0:65535) W This is the port number of the IPDR Collector to be used by the CPE to stream bulk data records if this collection profile is configured for the IPDR Streaming Protocol [IPDR-SP] (the Protocol parameter has a value of Streaming).

Changes in 2.12:

  • Removed 4737 default This is the IANA default port for [IPDR-SP] description
 4737 2.5
StreamingSessionID unsignedInt(48:57,65:90) W This is the unique identification of an IPDR Session to be used when this collection profile is configured for the IPDR Streaming Protocol [IPDR-SP] (the Protocol parameter has a value of Streaming). An ACS MUST NOT configure multiple IPDR Streaming Protocol collection profiles with the same StreamingSessionID. Doing so MUST cause the CPE to fail the SetParameterValues. Within the IPDR Streaming Protocol specification the Session ID has a type of a single ‘char’, but we are restricting the range even further (ASCII values of ‘0’ - ‘9’ and ‘A’ - ‘Z’.

Changes in 2.12:

  • Removed 48:57 range ASCII values of ‘0’ - ‘9’ description
  • Removed 65:90 range ASCII values of ‘A’ - ‘Z’ description
 - 2.5
Device.BulkData.Profile.{i}.HTTP. object R This object defines the properties to be used when transporting bulk data using the HTTP/HTTPS protocol. This object is used when the Protocol parameter has a value of HTTP. For authentication purposes the CPE MUST support HTTP Basic and Digest Access Authentication as defined in [RFC2616].

Changes in 2.12:

 - 2.10
PersistAcrossReboot boolean W Determines whether or not data transfers that have failed are required to be persisted across reboots. If PersistAcrossReboot is true, then failed data transfers MUST be persisted across reboots. If PersistAcrossReboot is false, then failed data transfers are not required to be persisted across reboots. false 2.12
Device.BulkData.Profile.{i}.HTTP.RequestURIParameter.{i}. object(0:) W This object represents an instance of a parameter to be used in the report header used as part of the HTTP Request-URI transmitted by the CPE to the collection server using the Request-URI in addition to the parameters required by [Annex A.2.1/TR-157a10]. - 2.10
Reference string(:256) W The value MUST be the path name of a parameter to be used as the Request-URI parameter. If the value of this parameter is empty, then this object is not encoded in the report header. <Empty> 2.10
Device.XMPP. object R The XMPP represents the XMPP capabilities of the device as described in [Appendix III/TR-069a5]. - 2.7
SupportedServerConnectAlgorithms string[] R

Comma-separated list of strings. The algorithms supported by the CPE for resolving XMPP server addresses and ports. Each list item is an enumeration of:

Changes in 2.12:

  • Added string WebSocket enumeration
  • Added string[] syntax [] list
 - 2.11
Device.XMPP.Connection.{i}. object(0:) W

The Connection represents a XMPP connection between the device and a server. The Username, Domain and Resource comprise the full identity (JabberID) of this Connection for this device.

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

 - 2.7
ServerConnectAlgorithm string W The value MUST be a member of the list reported by the SupportedServerConnectAlgorithms parameter. The algorithm the Connection uses when connecting with the associated lists of servers.

Changes in 2.12:

  • Removed string DNS-SRV enumeration
  • Removed string ServerTable enumeration
 DNS-SRV 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.ForwardingTable. object R This object represents the rules to forward PDUs between interfaces within the 1905 Abstraction Layer. - 2.9
Device.IEEE1905.AL.ForwardingTable.ForwardingRule.{i}. object(0:) W The 1905 fowarding rule for the ALME-SET-FWD-RULE.request and ALME-GET-FWD-RULES.response with classification criteria as defined in [Table 5-9: ClassificationSet elements/IEEE1905.1a]. - 2.9
InterfaceList string(:256)[] W The list of interfaces to which a frame satisfying the following classification criteria should be forwarded (intfAddressList parameter as defined in [Table 5-8: ALME-SET-FWD-RULE.request parameters and Table 5-12: fwdRuleList elements/IEEE1905.1a]). Comma-separated list of strings (maximum number of characters per item 256). Each list item MUST be the path name of an object, which MUST be a row of an Interface object. If the referenced item is deleted, the corresponding item MUST be removed from the list.

Changes in 2.12:

  • Removed [] list * * cdata
 <Empty> 2.9
EtherType unsignedInt W Classification criterion. Ether Type Field in a frame.

Changes in 2.12:

  • Removed unsignedInt * * cdata
 - 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
Device.IEEE1905.AL.NetworkTopology.IEEE1905Device.{i}.BridgingTuple.{i}. object(0:) R This object represents an instance of an BridgingTuple for the IEEE1905Device. These values come from the 1905 Device’s Topology response message as defined in [Table 6-11: Device bridging capability TLV/IEEE1905.1a]. - 2.9
InterfaceList string(:256)[] R Comma-separated list of strings (maximum number of characters per item 256). Each list item MUST be the Path Name of a row in the IEEE1905Device.{i}.Interface. table. If the referenced object is deleted, the corresponding item MUST be removed from the list.

Changes in 2.12:

  • Removed [] list * * cdata
 - 2.9
Device.IEEE1905.AL.Security. object R This object represents the Security configuration for the 1905 device as defined in [Section 9.2 Security Setup Methods/IEEE1905.1a]. - 2.9
Password string W

1905 network passphrase for generating security keys.

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

Changes in 2.12:

  • Removed string * * cdata
 - 2.9
Device.MQTT. object R MQTT Base object describing all MQTT related parameters and objects [MQTT31], - 2.10
Device.MQTT.Client.{i}. object(0:) W

MQTT client table. Contains a list of configured MQTT clients.

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

Changes in 2.12:

  • Removed {{param: non-existent ForceReconnect ::: parameter
  • Added ForceReconnect() command}}
 - 2.10
ForceReconnect() command - Disconnects the MQTT client from the MQTT broker and reconnects it again (toggle connection). It is only effective if the MQTT client is currently connected to the MQTT broker (Parameter Status is Connected). If the MQTT client is in a different state, the command has no effect. This command may be used to immediately apply changes in the MQTT connection settings. - 2.12
WillTopic string W The Topic sent in the Will Message (see [Section 3.1/MQTT31] and [Section 3.1.2.5/MQTT311]). This parameter is only used if WillEnable is set to true. A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. If the will handling is enabled (Paramter WillEnable is set to true) and the change needs to be applied immediately, the parameter {{param: non-existent ForceReconnect}} has to be set as well.

Changes in 2.12:

  • Removed string * * cdata
 - 2.10
WillValue string W The value sent in the Will Message (see [Section 3.1/MQTT31] and [Section 3.1.2.5/MQTT311]). This parameter is only used if WillEnable is set to true. A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. If the will handling is enabled (Paramter WillEnable is set to true) and the change needs to be applied immediately, the parameter {{param: non-existent ForceReconnect}} has to be set as well.

Changes in 2.12:

  • Removed string * * cdata
 - 2.10
Device.MQTT.Broker.{i}. object(0:) W

MQTT broker table. Contains a list of configured MQTT brokers.

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

 - 2.10
Device.MQTT.Broker.{i}.Bridge.{i}. object(0:) W

Configures MQTT bridges, which are used to communicate with other MQTT brokers.

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

Changes in 2.12:

  • Removed {{param: non-existent ForceReconnect ::: parameter
  • Added ForceReconnect() command}}
 - 2.10
ForceReconnect() command - Disconnects the MQTT bridge to the remote MQTT broker and reconnects it again (toggle connection). It is only effective if the MQTT bridge is currently connected to the remote MQTT broker (Parameter Status is Connected). If the MQTT bridge is in a different state, the command has no effect. This command may be used to immediately apply changes in the MQTT connection settings. - 2.12
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 can exist with a given value for Alias, or with the same values for both Topic and Direction. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias, Topic and Direction such that the new entry does not conflict with any existing entries.

 - 2.10
LocalPrefix string W

The local prefix is used for remapping received topics to the local topics of the MQTT broker and to select the topics to be sent over bridge to the remote MQTT broker. * In incoming direction (Direction is either in or both):

For remote topics received over the bridge the MQTT broker adds the LocalPrefix in front of the received topic, before processing it.
Example:
Topic is “/bus/+”, LocalPrefix is “/local”, Direction is “in”
MQTT broker receives message with topic “/bus/tr181” over bridge => MQTT broker uses topic “/local/bus/tr181” for internal processing

* In outgoing direction (Direction is either out or both):

For selection of the topics to be sent over the bridge the MQTT broker uses the combination of LocalPrefix and Topic to match the topics to be sent over bridge, and removes the LocalPrefix from the selected topic before sending it over the bridge.
Example:
Topic is “/bus/+”, LocalPrefix is “/local”, Direction is “out”
MQTT broker receives message with topic “/local/bus/tr181” from a MQTT client => MQTT broker sends topic “/bus/tr181” to remote MQTT broker

Changes in 2.12:

  • Removed string * * cdata
 - 2.10
RemotePrefix string W

The remote prefix is used for remapping topics to the remote MQTT broker topic lists. * In incoming direction (Direction is either in or both):

For remote topics received over the bridge the MQTT broker removes the remote prefix topic from the received topic (before handling the LocalPrefix), before processing it.
Example:
Topic is “/bus/+”, LocalPrefix is “/local”, RemotePrefix is “/remote”, Direction is “in”
MQTT broker receives message with topic “/remote/bus/tr181” over bridge => MQTT broker uses topic “/local/bus/tr181” for internal processing
During activation of the bridge, the MQTT broker prepends the Topic with RemotePrefix topic and subscribes to the remote MQTT broker with it, in order to receive all applicable remote topics.
Example:
Topic is “/bus/+”, RemotePrefix is “/remote”, Direction is “in”
MQTT broker sends a subscription to the remote MQTT broker with the topic “/remote/bus/+”.

* In outgoing direction (Direction is either out or both):

For all topics to be sent over the bridge (Direction is either out or both), the RemotePrefix will be prepended to the topic after the LocalPrefix has been processed and before sending the message over the bridge.
Example:
Topic is “/bus/+”, LocalPrefix is “/local”, RemotePrefix is “/remote” Direction is “out”
MQTT broker receives message with topic “/local/bus/tr181” from a MQTT client => MQTT broker sends topic “/remote/bus/tr181” to remote MQTT broker

Changes in 2.12:

  • Removed string * * cdata
 - 2.10
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
MeasurementEndpointNumberOfEntries unsignedInt R The number of entries in the MeasurementEndpoint table. - 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 can exist with a given value for Alias, or with a given value for MeasurementAgent. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and MeasurementAgent such that the new entry does not conflict with any existing entries.

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

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

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
Enable boolean W Enables or disables this MeasurementEndpoint instance. This parameter is based on ifAdminStatus from [RFC2863]. - 2.12
MeasurementAgent string W

The value MUST be the Path Name of a LMAP.MeasurementAgent object that is associated with this measurement endpoint.. If the referenced object is deleted, the parameter value MUST be set to an empty string.

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

 - 2.12
DeviceOwnership string W

This parameter describes the ownership of the device that hosts the measurement endpoint. Enumeration of:

  • ISP (ISP Owned Device)
  • Customer (Customer Owned Device)
 - 2.12
OperationalDomain string(:256) W This parameter describes the operational domain for this measurement endpoint - 2.12
InternetDomain string(:64) W The top level Internet domain used to identify this measurement endpoint. - 2.12
UseMeasurementEndpointInReports boolean W If the value of this parameter is false then the Measurement Endpoint MUST not be included in measurement reports. - 2.12
Device.BASAPM.MeasurementEndpoint.{i}.ISPDevice. object R This object represents the information necessary to utilize an ISP owned device within the measurement endpoint. - 2.12
ReferencePoint string W

This parameter describes the measurement reference point of the measurement endpoint. Enumeration of:

  • STP (Internet Source Test Point)
  • IDTP (Internet Drain Test Point)
  • RNTP (Regional Network Test Point)
  • IRTP (Internal Regional Test Point)
  • MTP (Metro Test Point)
  • IATP (Internal Access Test Point)
  • UNITP (User Network Interface Test Point)
  • CEDTP (Customer End Device Test Point)
 - 2.12
GeographicalLocation string W The value MUST be the Path Name of a DeviceInfo.Location object that describes the geographic location of the measurement endpoint. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.12
Device.BASAPM.MeasurementEndpoint.{i}.CustomerDevice. object R This object represents the information necessary to utilize customer owned device within the measurement endpoint. - 2.12
EquipmentIdentifier string(:64) W This parameter describes the customer equipment identifier of the measurement endpoint. - 2.12
CustomerIdentifier string(:256) W The unique customer identifier within the operational domain for this measurement endpoint. - 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.0
MeasurementAgentNumberOfEntries unsignedInt R The number of entries in the MeasurementAgent table. - 2.0
ReportNumberOfEntries unsignedInt R The number of entries in the Report table. - 2.0
EventNumberOfEntries unsignedInt R The number of entries in the Event table. - 2.0
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 can exist with a given value for Alias, or with a given value for Identifier. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Identifier such that the new entry does not conflict with any existing entries.

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

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

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
Enable boolean W Enables or disables this MeasurementAgent instance. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
Version string R Version of the measurement agent. - 2.0
LastStarted dateTime R Date and time, based on [RFC3339], in UTC that the measurement agent was successfully started. - 2.0
CapabilityTags string[] R Comma-separated list of strings. Capabilities of the measurement agent that cannot be expressed elsewhere in the data model. - 2.0
Identifier string(36) W

[UUID] Identifier of the MeasurementAgent instance.

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

 - 2.0
GroupIdentifier string(:256) W Identifier of the measurement group of interest to which the measurement agent belongs. - 2.0
MeasurementPoint string(:256) W Identifier of the measurement point indicating where the measurement agent is located on a path as defined in [bibref|RFC7398.}} - 2.0
UseAgentIdentifierInReports boolean W If the value of the Identifier parameter is not an empty string and the value of this parameter is false then the value of the Identifier parameter MUST not be included in measurement reports. true 2.0
UseGroupIdentifierInReports boolean W If the value of the GroupIdentifier parameter is not an empty string and the value of this parameter is false then the value of the GroupIdentifier parameter MUST not be included in measurement reports. false 2.0
UseMeasurementPointInReports boolean W If the value of the MeasurementPoint parameter is not an empty string and the value of this parameter is false then the value of the MeasurementPoint parameter MUST not be included in measurement reports. false 2.0
PublicCredential string W The value MUST be the Path Name of a Security.Certificate object that is used to identify this measurement agent. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.0
PrivateCredential string W The value MUST be the Path Name of a Security.Certificate object that is used to contain the private keys for this measurement agent. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.0
EventLog string R The value MUST be the Path Name of a DeviceInfo.VendorLogFile object that is used to record events for this measurement agent. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.0
TaskCapabilityNumberOfEntries unsignedInt R The number of entries in the TaskCapability table. - 2.0
ScheduleNumberOfEntries unsignedInt R The number of entries in the Schedule table. - 2.0
TaskNumberOfEntries unsignedInt R The number of entries in the Task table. - 2.0
CommunicationChannelNumberOfEntries unsignedInt R The number of entries in the CommunicationChannel table. - 2.0
InstructionNumberOfEntries unsignedInt R The number of entries in the Instruction table. - 2.0
Device.LMAP.MeasurementAgent.{i}.TaskCapability.{i}. object(0:) R

This object represents a capabilities, in the context of a task, that are supported by the measurement agent. Types of capabilities include: Report tasks, Configuration Tasks and Instruction Tasks.

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

 - 2.0
Name string(:256) R Name of the supported task. - 2.0
Version string(:256) R Version of the task. - 2.0
TaskCapabilityRegistryNumberOfEntries unsignedInt R The number of entries in the Registry table. - 2.0
Device.LMAP.MeasurementAgent.{i}.TaskCapability.{i}.Registry.{i}. object(0:) R

This object represents a registry function and an associated list of roles supported by this measurement agent

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

 - 2.0
RegistryEntry string R A URI ([RFC3986]) that is the value of the task registry entry as defined in [LMAPREG] or a value for a task that is understood by the measurement agent, measurement controller and measurement collector. - 2.0
Roles string(:256)[] R Comma-separated list of strings (maximum number of characters per item 256), representing the roles of the function. - 2.0
Device.LMAP.MeasurementAgent.{i}.Controller. object R This objects represents the measurement controller that is assigned to a measurement agent. - 2.0
ControllerTimeout int(0:) W The timer, in seconds, that is started after each successful contact with a measurement controller. When the timer reaches the timeout en event is raised indicating that connectivity to the controller has been lost. - 2.0
ControlSchedules string[] W Comma-separated list of strings. Each list item MUST be the Path Name of a Schedule object. If the referenced object is deleted, the corresponding item MUST be removed from the list. This parameter lists the available control schedules for invoking control tasks by the measurement agent. - 2.0
ControlTasks string[] W Comma-separated list of strings. Each list item MUST be the Path Name of a Task object. If the referenced object is deleted, the corresponding item MUST be removed from the list. This parameter lists the available control tasks that can be invoked by the measurement agent. - 2.0
ControlChannels string[] W Comma-separated list of strings. Each list item MUST be the Path Name of a CommunicationChannel object. If the referenced object is deleted, the corresponding item MUST be removed from the list. The measurement agent to measurement controller channel is used for conveying results of communication sessions with the configuration, instruction status and logging information elements defined in defined in [LMAPIFM]. - 2.0
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 can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.0
Enable boolean W Enables or disables this Schedule instance. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
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.

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

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
Name string(:256) W

Name of the schedule.

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

 - 2.0
State string R

The current operational state of the Schedule. Only one instance of the schedule is active. An active schedule is defined where the State parameter has a value of Running. Enumeration of:

  • Enabled
  • Suppressed
  • Disabled
  • Running
 - 2.0
Start string W The value MUST be the Path Name of a Event object that is used define the event to start an occurrence of this Schedule. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.0
End string W The value MUST be the Path Name of a Event object that is used define the event to gracefully terminate all actions associated with an occurrence of this Schedule. If the referenced object is deleted, the parameter value MUST be set to an empty string.. <Empty> 2.0
Duration unsignedInt W When the Duration value is not 0, this parameter is used define the duration, in seconds, where after this duration all actions associated with an occurrence of this Schedule are gracefully terminated. 0 2.0
Tags string[] W Comma-separated list of strings, each entry represents tags that are to be reported together with the measurement results.. - 2.0
SuppressionTags string[] W Comma-separated list of strings, representing the suppression tags to be matched. - 2.0
ExecutionMode string W

This parameter describes the execution method to apply to this schedule for the associated Actions. Enumeration of:

  • Sequential ( Actions are executed in sequence as defined by the value of the Action.{i}.Order parameter. The first Scheduled Action of the DestinationOutput is provided the input)
  • Parallel (Actions are executed in parallel. The all Scheduled Actions of the DestinationOutput are provided the input)
  • Pipelined (Actions are executed in sequence where the output of one Action is used as the input of subsequent Action. The first Scheduled Action of the DestinationOutput is provided the input)
 Pipelined 2.0
LastInvocation dateTime R Date and time, based on [RFC3339], in UTC that the Schedule was invoked by the measurement agent. - 2.0
Storage unsignedLong R

The amount of secondary storage, in bytes, allocated to an instance of this Schedule. The value of this parameter reflects the amount of allocated physical storage and not the storage used by logical data records. For example the secondary storage can be the storage allocated in a file system holding temporary data.

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
ActionNumberOfEntries unsignedInt R The number of entries in the Action table. - 2.0
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Stats. object R This object represents the statistics associated with this object. - 2.0
Invocations unsignedLong R

Number of invocations of this schedule. This counter does not include suppressed invocations or invocations that were prevented due to an overlap with a previous invocation of this schedule.

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
Suppressions unsignedLong R

Number of suppressed executions of this schedule.

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
Overlaps unsignedLong R

Number of executions prevented due to overlaps with a previous invocation of this schedule.

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
Failures unsignedLong R

Number of failed executions of this schedule. A failed execution is an execution where at least one action failed.

Value Change Notification requests for this parameter MAY be denied.

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

 - 2.0
Enable boolean W Enables or disables this Schedule.{i}.Action object. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
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.

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

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
State string R

The current operational state of the Action. Enumeration of:

  • Enabled
  • Suppressed
  • Disabled
  • Running
 - 2.0
Order unsignedInt W The order of the scheduled action. - 2.0
Task string W The value MUST be the Path Name of a Task object used in this scheduled action. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.0
OutputDestination string[] W Comma-separated list of strings. Each list item MUST be the Path Name of a Schedule object used to receive the output(s) of this scheduled action. If the referenced object is deleted, the corresponding item MUST be removed from the list. - 2.0
SuppressionTags string[] W Comma-separated list of strings, representing the suppression tags to be matched. - 2.0
Tags string[] W Comma-separated list of strings, each entry represents tags that are to be reported together with the measurement results.. - 2.0
Storage unsignedLong R

The amount of secondary storage, in bytes, allocated to an instance of this Action. The value of this parameter reflects the amount of allocated physical storage and not the storage used by logical data records. For example the secondary storage can be the storage allocated in a file system holding temporary data.

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
LastInvocation dateTime R Date and time, based on [RFC3339], in UTC that the Action was invoked by the measurement agent. - 2.0
LastSuccessfulCompletion dateTime R Date and time, based on [RFC3339], in UTC of a successful completion of the Action. - 2.0
LastSuccessfulStatusCode int R The status code returned by successful execution of the Action. A value of 0 indicates successful completion. - 2.0
LastSuccessfulMessage string R The message associated with the successful completion of the Action. - 2.0
LastFailedCompletion dateTime R Date and time, based on [RFC3339], in UTC of a failure to complete the Action. - 2.0
LastFailedStatusCode int R The status code returned by failed execution of the Action. A value of 0 indicates successful completion. - 2.0
LastFailedMessage string R The message associated with the failure to complete the task. - 2.0
OptionNumberOfEntries unsignedInt R The number of entries in the Option table. - 2.0
Device.LMAP.MeasurementAgent.{i}.Schedule.{i}.Action.{i}.Stats. object R This object represents the statistics associated with this object. - 2.0
Invocations unsignedLong R

Number of invocations of this action. This counter does not include suppressed invocations or invocations that were prevented due to an overlap with a previous invocation of this schedule.

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
Suppressions unsignedLong R

Number of suppressed executions of this action.

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
Overlaps unsignedLong R

Number of executions prevented due to overlaps with a previous invocation of this action.

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
Failures unsignedLong R

Number of failed executions of this action. A failed execution is an execution where at least one action failed.

Value Change Notification requests for this parameter MAY be denied.

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

 - 2.0
Enable boolean W Enables or disables this Option instance. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
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.

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

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
Order unsignedInt W The order of the Option. - 2.0
Name int W

The name of the option. When the value of this parameter is equal to “channel”, the option value specifies the Communication Channel used for this scheduled task.

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

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

 - 2.0
Enable boolean W Enables or disables this Task instance. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
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.

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

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
Name string(:256) W

Name of the task.

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

 - 2.0
Tags string[] W Comma-separated list of strings, each entry represents tags that are to be reported together with the measurement results.. - 2.0
OptionNumberOfEntries unsignedInt R The number of entries in the Option table. - 2.0
RegistryNumberOfEntries unsignedInt R The number of entries in the Registry table. - 2.0
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 can exist with a given value for RegistryEntry, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for RegistryEntry and Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Enable boolean W Enables or disables this Registry instance. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
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.

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

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
RegistryEntry string W

A URI ([RFC3986]) that is the value of the task registry entry as defined in [LMAPREG] or a value for a task that is understood by the measurement agent, measurement controller and measurement collector.

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

 - 2.0
Roles string(:256)[] W Comma-separated list of strings (maximum number of characters per item 256), representing the roles of the function. - 2.0
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 can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.0
Enable boolean W Enables or disables this Option instance. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
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.

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

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
Order unsignedInt W The order of the Option. - 2.0
Name int W

The name of the option. When the value of this parameter is equal to “channel”, the option value specifies the Communication Channel used for this task.

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

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

 - 2.0
Enable boolean W Enables or disables this CommunicationChannel instance. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
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.

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

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
Name string(:256) W

Name of the channel.

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

 - 2.0
UseBulkDataProfile boolean W Enables or disables the ability to use a bulk data profile for this communication channel - 2.0
BulkDataProfile string W The value MUST be the Path Name of a BulkData.Profile object that is used to represent communication channel. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.0
Target string(:256) W The URL of the LMAP component that is the target of this communication channel. - 2.0
TargetPublicCredential string W The value MUST be the Path Name of a Security.Certificate object that is used to identify the target of this channel. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.0
Interface string W The value MUST be the Path Name of an interface object used to restrict the data transmitted or received using this channel to a specific interface. If the value of this parameter is an empty string the data that is transmitted or received using this channel is able to use any available interface. - 2.0
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 can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Enable boolean W Enables or disables this Instruction instance. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
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.

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

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
LastChange dateTime R Date and time, based on [RFC3339], in UTC that the Instruction object or its sub-object’s configuration was changed by a measurement agent’s controller. - 2.0
InstructionSchedules string[] W Comma-separated list of strings. Each list item MUST be the Path Name of a Schedule object. If the referenced object is deleted, the corresponding item MUST be removed from the list. This parameter lists the available instruction schedules for invoking control tasks by the measurement agent. - 2.0
InstructionTasks string[] W Comma-separated list of strings. Each list item MUST be the Path Name of a Task object. If the referenced object is deleted, the corresponding item MUST be removed from the list. This parameter lists the available instruction tasks that can be invoked by the measurement agent. - 2.0
ReportChannels string[] W Comma-separated list of strings. Each list item MUST be the Path Name of a CommunicationChannel object. If the referenced object is deleted, the corresponding item MUST be removed from the list. This parameter defines the corresponding report channels to be used when reporting results of tasks to a measurement collector. - 2.0
MeasurementSuppressionNumberOfEntries unsignedInt R The number of entries in the MeasurementSuppression table. - 2.0
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 can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.0
Enable boolean W Enables or disables this MeasurementSuppression instance. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
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.

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

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
Name string(:256) W

Name of the suppression object.

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

 - 2.0
State string R

The current operational state of the MeasurementSuppression. Enumeration of:

  • Enabled
  • Active
  • Disabled
 - 2.0
StopRunning boolean W When true, the measurement agent is instructed to stop running schedules or actions that have been matched by this object. false 2.0
Start string W The value MUST be the Path Name of a Event object that is used define the event that to start an occurrence of this MeasurementSuppression. If the referenced object is deleted, the parameter value MUST be set to an empty string. When an empty string the default behavior is to perform the suspension event immediately. <Empty> 2.0
End string W The value MUST be the Path Name of a Event object that is used define the event to gracefully suspend all actions associated with an occurrence of this MeasurementSuppression. If the referenced object is deleted, the parameter value MUST be set to an empty string. When an empty string the default behavior is for the suspension period to be indefinite. <Empty> 2.0
SuppressionMatch string[] W Comma-separated list of strings, representing the match patterns to be used for applying suppression to Schedule.{i} (and their actions) and all Schedule.{i}.Action.{i} object instances that have a matched using their SuppressionTags parameters. The match pattern syntax is defined in [LMAPIFM]. - 2.0
Device.LMAP.Report.{i}. object(0:) R This Report object instance represents a report that is generated by a reporting task where the reporting task is defined as a MeasurementAgent.{i}.Task.{i} and executed as a scheduled action (MeasurementAgent.{i}.Schedule.{i}.Action.{i}). The Report replicates the MeasurementAgent.{i} object instance’s data at the time of the action exection. When a BulkData.Profile.{i} object instance is used to communicate a Report instance, the CPE adds a BulkData.Profile.{i}.Parameter.{i} object instance referring to this Report object instance. - 2.0
ReportDate dateTime R The report date and time, based on [RFC3339], that the report was sent to the collector. - 2.0
AgentIdentifier string(36) R [UUID] Identifier of the measurement agent at the time the measurement was run. - 2.0
GroupIdentifier string R Identifier of the measurement group of interest to which the MA belongs. - 2.0
MeasurementPoint string(:256) R Identifier of the measurement point indicating where the measurement agent is located on a path as defined in [RFC7398]. - 2.0
ResultNumberOfEntries unsignedInt R The number of entries in the Result table. - 2.0
Device.LMAP.Report.{i}.Result.{i}. object(0:) R

The Result object provides the meta-data of the result report of a single executed action that produced the result.

At most one entry in this table can exist with the same values for all of ScheduleName, ActionName and StartTime.

 - 2.0
TaskName string(:256) R Name of the task that produced the result. - 2.0
ScheduleName string(:256) R Name of the schedule that produced the result. - 2.0
ActionName string(:256) R Name of the action that produced the result. - 2.0
EventTime dateTime R The date and time, based on [RFC3339], that the event that triggered the schedule of the action that produced the reported result values in UTC. - 2.0
StartTime dateTime R The date and time, based on [RFC3339], that the action started in UTC. - 2.0
EndTime dateTime R The date and time, based on [RFC3339], that the action was completed in UTC. - 2.0
CycleNumber string R

The cycle number derived from the EventTime. The cycle number is the time, in UTC, closest to the EventTime that is a multiple of the cycle interval of the event that triggered the execution of the schedule. The value is valid if the event that triggered the execution of the schedule has a defined cycle interval. An an empty string value represent an invalid CycleNumber. Possible patterns:

  • YYYYMMDD.HHMMSS
 - 2.0
Status int R The status code returned by the execution of the action. - 2.0
Tags string[] R Comma-separated list of strings, each entry represents tags defined for the schedule, task and action objects that produced this result. - 2.0
OptionNumberOfEntries unsignedInt R The number of entries in the Option table. - 2.0
ResultConflictNumberOfEntries unsignedInt R The number of entries in the Conflict table. - 2.0
ResultReportTableNumberOfEntries unsignedInt R The number of entries in the ReportTable table. - 2.0
Device.LMAP.Report.{i}.Result.{i}.Option.{i}. object(0:) R

This object represents an option associated with the task or action object that produced the result.

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

 - 2.0
Order unsignedInt R The order of the Option. - 2.0
Name int R The name of the Option. When the value of this parameter is equal to “channel”, the option value specifies the Communication Channel used for this task. - 2.0
Value string R The value associated with the Option. - 2.0
Device.LMAP.Report.{i}.Result.{i}.Conflict.{i}. object(0:) R

This object represents actions that might have impacted the results being reported.

At most one entry in this table can exist with the same values for all of ScheduleName, ActionName and TaskName.

 - 2.0
TaskName string(:256) R Name of the task. - 2.0
ScheduleName string(:256) R Name of the schedule. - 2.0
ActionName string(:256) R Name of the action. - 2.0
Device.LMAP.Report.{i}.Result.{i}.ReportTable.{i}. object(0:) R This ReportTable object instances represents a row of results. - 2.0
ColumnLabels string[] R Comma-separated list of strings. This parameter contains the column labels used for the result. The column labels are ordered with the corresponding entries in the ResultRow table. - 2.0
ResultReportRowNumberOfEntries unsignedInt R The number of entries in the ResultRow table. - 2.0
RegistryNumberOfEntries unsignedInt R The number of entries in the Registry table. - 2.0
Device.LMAP.Report.{i}.Result.{i}.ReportTable.{i}.ResultRow.{i}. object(0:) R This ResultRow object instances represents a row of results for the report. - 2.0
Values string[] R Comma-separated list of strings. This parameter contains an ordered set of values that align to the columns defined in the ColumnLabels parameter. - 2.0
Device.LMAP.Report.{i}.Result.{i}.ReportTable.{i}.Registry.{i}. object(0:) R

This object represents a registry function and an associated list of roles for this result report.

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

 - 2.0
RegistryEntry string R A URI ([RFC3986]) that is the value of the registry entry as defined in [LMAPREG] or a value for a task that is understood by the measurement agent, measurement controller and measurement collector. - 2.0
Roles string(:256)[] R Comma-separated list of strings (maximum number of characters per item 256), representing the roles of the function. - 2.0
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 can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.0
Enable boolean W Enables or disables this Event instance. This parameter is based on ifAdminStatus from [RFC2863]. - 2.0
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.

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

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

Value Change Notification requests for this parameter MAY be denied.

 - 2.0
Name string(:256) W

Name of the Event.

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

 - 2.0
Type string W

This parameter describes the type of Event for this object instance. The timing of the event occurrence is adjusted based on the value of the RandomnessSpread parameter. Enumeration of:

  • PeriodicTiming (Periodic Timing Event. When selected one or more event occurrences are emitted based on the parameters defined in the PeriodicTimer object)
  • CalendarTiming (Calendar Timing Event. When selected one or more event occurrences are emitted based on the parameters defined in the CalendarTimer object)
  • OneOffTiming (One-off Timing Event. When selected a single event occurrence is emitted based on the parameters defined in the OneOff object)
  • Immediate (Immediate Timing Event. When selected a single event occurrence is emitted as soon as possible)
  • Startup (Startup Timing Event. When selected a single event occurrence is emitted when the corresponding measurement agent starts up)
  • ControllerLost (Controller Lost Event. When selected a single event occurrence is emitted when the connectivity to the controller is lost)
  • ControllerConnected (Controller Connected Event. When selected a single event occurrence is emitted when the connectivity to the controller is established)
 Immediate 2.0
RandomnessSpread int W The spread, in seconds, of the Uniform Discrete random distribution algorithm. A value of 0 means that the random algorithm is not applied. - 2.0
CycleInterval int W The duration of the time interval, in seconds, that used to calculate cycle numbers. - 2.0
Device.LMAP.Event.{i}.PeriodicTimer. object R This object defines a periodic timer instance. The periodic timer instance has attributes for when the timer is to begin (StartTime) and end (EndTime) as well as the interval to use. - 2.0
StartTime dateTime W Date and time, based on [RFC3339], that the PeriodicTimer instance is to begin operation. - 2.0
EndTime dateTime W Date and time, based on [RFC3339], that the PeriodicTimer instance is to end operation. - 2.0
Interval unsignedInt W The tolerable duration, in seconds, of the interval for this PeriodicTimer instance. - 2.0
Device.LMAP.Event.{i}.CalendarTimer. object R This object defines a calendar timer instance. The calendar timer instance has attributes for when the timer is to begin (StartTime) and end (EndTime) as well as the schedule of the recurrence. The algrorithm that defines how the schedule elements are evaluated is defined in [LMAPIFM]. If the value of any of the ScheduleMonths, ScheduleDaysOfMonth, ScheduleDaysOfWeek, ScheduleHoursOfDay, ScheduleMinutesOfHour or ScheduleSecondsOfMinute is an empty string then any actions that use this object will not be invoked. - 2.0
StartTime dateTime W Date and time that the CalendarTimer instance is to begin this operation. - 2.0
EndTime dateTime W Date and time that the CalendarTimer instance is to end this operation. - 2.0
ScheduleMonths string W This parameter represents either a list of the months of year that are applied to the schedule or an asterisk (*) that represents all the elements of the list. Each entry in the months of the year list can be a numeric value or the name of the month (january (1), february (2), march (3), april (4), may (5), june (6), july (7), august (8), september (9), october (10), november (11), december (12)). - 2.0
ScheduleDaysOfMonth string W This parameter represents either a list of the days of the month (1-31) that are applied to the schedule or an asterisk (*) that represents all the elements of the list. - 2.0
ScheduleDaysOfWeek string W This parameter represents either a list of the days of the week that are applied to the schedule or an asterisk (*) that represents all the elements of the list. Each entry in the days of the week list can be a numeric value or the name of the day (sunday (1), monday (2), tuesday (3), wednesday (4), thursday (5), friday (6), saturday (7)). - 2.0
ScheduleHoursOfDay string W This parameter represents either a list of the hours of the day (0-23) that are applied to the schedule or an asterisk (*) that represents all the elements of the list. - 2.0
ScheduleMinutesOfHour string W This parameter represents either a list of the minutes of the hour (0-59) that are applied to the schedule or an asterisk (*) that represents all the elements of the list. - 2.0
ScheduleSecondsOfMinute string W This parameter represents either a list of the minutes of the hour (0-59) that are applied to the schedule or an asterisk (*) that represents all the elements of the list. - 2.0
EnableScheduleTimezoneOffset boolean W When true, the value of the ScheduleTimezoneOffset parameter is applied to the schedule elements. When false, the device’s system timezone offset is applied to the schedule elements. - 2.0
ScheduleTimezoneOffset int(-23:23) W The timezone offset, in hours, to be applied to the schedule elements. - 2.0
Device.LMAP.Event.{i}.OneOff. object R This object defines a one off timer instance. - 2.0
StartTime dateTime W Date and time, based on [RFC3339], that the OneOff instance is to begin operation. - 2.0
Device.LocalAgent. object R This object contains general information about the USP Agent itself. For information related to the Device that hosts the Agent, please reference the DeviceInfo object. NOTE: The Vendor Log File table (DeviceInfo.VendorLogFile) details are located on the DeviceInfo object. - 2.12
EndpointID string R The unique USP identifier for this USP Agent. - 2.12
SoftwareVersion string(:64) R The current USP Agent software version; not the version of the overall device firmware, which is located in DeviceInfo.SoftwareVersion. 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. - 2.12
UpTime unsignedInt R

Time in seconds since the USP Agent was last restarted (either via a reset of the software or reboot of the underlying device).

Value Change Notification requests for this parameter MAY be denied.

 - 2.12
Periodic! event - Periodic event configured via the recipient Controller’s Controller.{i}.PeriodicNotifInterval and Controller.{i}.PeriodicNotifTime parameters. - 2.12
WakeUp! event - Wake-up event. - 2.12
TransferComplete! event - Indicates that a file has been transferred to or from the Device. The event is sent when the transfer has either completed successfully (in which case FaultCode will be zero), or else has failed (in which case FaultCode will be non-zero and FaultString will give further details). The file transfer can be requested via a USP operation or via some other mechanism. If it’s requested via a USP operation Command, CommandKey and Requestor give further details. - 2.12
⇒ Command string R The Path Name of the command that requested the transfer, or an empty string if the transfer was not requested via a USP operation. - 2.12
⇒ CommandKey string R

The command_key supplied when requesting the transfer, or an empty string if the transfer was not requested via a USP operation.

The default value MUST be an empty string.

 - 2.12
⇒ Requestor string R

The Endpoint ID of the Controller that requested the transfer, or an empty string if no Controller requested it.

The default value MUST be an empty string.

 - 2.12
⇒ TransferType string R

The type (direction) of the transfer.

Enumeration of:

  • Download (Downstream transfer; to the Agent)
  • Upload (Upstream transfer; from the Agent)

The default value MUST be Download.

 - 2.12
⇒ Affected string R

The Path Name of the Object or Object Instance that was affected by the transfer, or an empty string if no data model object was affected by the transfer.

The default value MUST be an empty string.

 - 2.12
⇒ TransferURL string(:1024) R

The URL from or to which this transfer was performed, or an empty string if no such URL is available.

The default value MUST be an empty string.

 - 2.12
⇒ StartTime dateTime R

The date and time in UTC at which the transfer was started. The Device SHOULD record this information and report it in this argument, but if this information is not available, the value of this argument MUST be set to the Unknown Time value.

The default value MUST be 0001-01-01T00:00:00Z.

 - 2.12
⇒ CompleteTime dateTime R

The date and time in UTC at which the transfer was fully completed. This need only be filled in if the transfer has been fully completed. The Device SHOULD record this information and report it in this argument, but if this information is not available or the transfer has not completed, the value of this argument MUST be set to the Unknown Time value.

The default value MUST be 0001-01-01T00:00:00Z.

 - 2.12
⇒ FaultCode unsignedInt R

The numerical fault code as defined in [TR-369]. A value of 0 (zero) indicates no fault.

The default value MUST be 0.

 - 2.12
⇒ FaultString string(:256) R

A human-readable text description of the fault. This field SHOULD be an empty string if the FaultCode equals 0 (zero).

The default value MUST be an empty string.

 - 2.12
AddCertificate() command - This command is issued to allow a Controller (with the proper permissions) to add a new certificate to Certificate.{i}. This does not automatically produce a trust relationship with the host identified by the Certificate. To produce a trust relationship, an entry is required to exist in Controller.{i}.Credential or ControllerTrust.Credential.{i}.Credential that references the new Certificate.{i} entry. The Agent will use the Serial Number and Issuer fields from the input Certificate to populate the Certificate.{i}.SerialNumber and Certificate.{i}.Issuer parameters. If Certificate already has an instance with the same Certificate.{i}.SerialNumber and Certificate.{i}.Issuer parameters, this command will fail. To replace an instance with the same Certificate.{i}.SerialNumber and Certificate.{i}.Issuer, the existing instance must first be deleted. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Alias string(:64) W [Alias] An optional input the Controller can use to specify the Certificate.{i}.Alias value for the added entry. If provided as an input and the value already exists in Certificate.{i}, this commmand will fail. - 2.12
⇒ Certificate string(:65535) W [MANDATORY] The X.509 certificate in Privacy-enhanced Electronic Mail (PEM) format. - 2.12
SupportedProtocols string[1:] R

Comma-separated list (at least 1 item) of strings. USP Message Transfer Protocols supported by this USP Agent. The USP Agent MUST support at least one Protocol.

Each list item is an enumeration of:

 - 2.12
SupportedFingerprintAlgorithms string[] R

Comma-separated list of strings, each entry is an algorithm for calculating firgerprints 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.12
AdvertisedDeviceSubtypes string[] W Comma-separated list of strings, each entry is a subtype component of the service type that is advertised for the device using mDNS as defined in [RFC6762]. - 2.12
MaxSubscriptionChangeAdoptionTime unsignedInt(5:) W The acceptable amount of time in seconds between the alteration of the Agent’s Subscriptions (e.g. updated subscription, new subscription, removed subscription, etc.) and the notifications related to those subscriptions being delivered. For example, if this parameter is set to 30 seconds, then once a Subscription has been updated, the Agent has 30 seconds before it needs to start delivering notifications based on the updated version of the Subscription (instead of the old version of the Subscription). - 2.12
MTPNumberOfEntries unsignedInt R The number of entries in the MTP table. - 2.12
ControllerNumberOfEntries unsignedInt R The number of entries in the Controller table. - 2.12
SubscriptionNumberOfEntries unsignedInt R The number of entries in the Subscription table. - 2.12
RequestNumberOfEntries unsignedInt R The number of entries in the Request table. - 2.12
CertificateNumberOfEntries unsignedInt R The number of entries in the Certificate table. - 2.12
Device.LocalAgent.MTP.{i}. object(0:) W

Each instance of this table represents a MTP used by the local Agent.

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

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

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

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

 - 2.12
Enable boolean W Enable/Disable this MTP instance. If this MTP instance is to be disabled and currently used for communication with the requesting controller, the agent has to send the request response first, before disabling it. false 2.12
Status string R

The current operational state of the MTP instance.

Enumeration of:

  • Up
  • Down (Value when this MTP instance cannot establish communication)
  • Error (Value when this MTP instance is misconfigured, OPTIONAL)
 - 2.12
Protocol string W The value MUST be a member of the list reported by the Device.LocalAgent.SupportedProtocols parameter. The Message Transport Protocol (MTP) to be used for communications by a USP Endpoint. CoAP 2.12
EnableMDNS boolean W This parameter, when true, enables the advertisement of DNS-SD services defined for this MTP instance using mDNS as defined in [RFC6762]. This parameter cannot be set to true if there are multiple MTP instances with the same value of the Protocol parameter. When true, the hostname advertised in the SRV record MUST be a Fully Qualified Domain Name (FQDN). The interfaces that advertise these DNS-SD services are restriced to the set of interfaces associated with this MTP instance and the interfaces defined by the DNS.SD.AdvertisedInterfaces parameter. true 2.12
Device.LocalAgent.MTP.{i}.CoAP. object R If the USP Endpoint uses the CoAP Message Transport Protocol (MTP), then this object contains CoAP specific configuration parameters. - 2.12
Interfaces string[] W Comma-separated list of strings. Each list item MUST be the Path Name of the IP.Interface object instance that this server will use as its host address to receive USP messages. If the referenced object is deleted, the corresponding item MUST be removed from the list. An empty string will bind this server to all interfaces for this device. - 2.12
Port unsignedInt(1:65535) W The port number used by the CoAP Server to receive USP messages. 5683 2.12
Path string W The path that is used by the CoAP Server in order to receive USP messages. - 2.12
IsEncrypted boolean R This parameter represents whether or not communications that utilize this CoAP object instance are encrypted. - 2.12
EnableEncryption boolean W When true, encryption is used for this MTP instance. true 2.12
Device.LocalAgent.MTP.{i}.STOMP. object R If the USP Endpoint uses the STOMP Message Transport Protocol (MTP), then this object contains STOMP Client specific configuration parameters related to how the Agent communicates with the STOMP Server. - 2.12
Reference string W The value MUST be the Path Name of a row in the STOMP.Connection. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. A reference to the STOMP Connection used by this Agent when communicating via the STOMP MTP. <Empty> 2.12
Destination string W The STOMP destination where the Agent will be listening to incoming USP messages. <Empty> 2.12
DestinationFromServer string R The STOMP destination contained in the subscribe-dest header of the CONNECTED STOMP Frame. If the Agent doesn’t receive a subscribe-dest header in the CONNECTED STOMP Frame, then the value of this Parameter is an empty string. If this parameter’s value is not empty then this is the STOMP destination address for this Agent, but if the value is empty the Destination Parameter contains the STOMP destination address for this Agent. <Empty> 2.12
Device.LocalAgent.MTP.{i}.WebSocket. object R If the USP Endpoint uses the WebSocket Message Transport Protocol (MTP) as a WebSocket server, then this object contains WebSocket specific configuration parameters. - 2.12
Interfaces string[] W Comma-separated list of strings. Each list item MUST be the Path Name of the IP.Interface object instance that this server will use as its host address to receive USP messages. If the referenced object is deleted, the corresponding item MUST be removed from the list. An empty string will bind this server to all interfaces for this device. - 2.12
Port unsignedInt(1:65535) W The port number used by the WebSocket Server to receive USP messages. 5683 2.12
Path string W The path that is used by the WebSocket Server in order to receive USP messages. - 2.12
Device.LocalAgent.Controller.{i}. object(0:) W

Each instance of this table represents a USP Controller that has access to this USP Agent.

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

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

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

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

 - 2.12
EndpointID string W The unique USP identifier for this USP Controller. <Empty> 2.12
ControllerCode string(:128) W Information about the configuration state of an Agent as it pertains to the Controller instance. This is not information related to an operator’s installation or usage of the protocol, that information is maintained in ProvisioningCode. This parameter could be used in scenarios where the Controller needs to perform some kind of initialization or periodic configuration monitoring. For example, a Controller might perform some initial configuration of an Agent on first contact (perhaps to configure the Subscriptions). The Controller could inspect this parameter to determine the current state of the Agent’s configuration, allowing the Controller to streamline the configuration process. <Empty> 2.12
ProvisioningCode string(:64) W Identifying information which MAY be used by the Controller instance to determine Controller instance specific customization and provisioning parameters. <Empty> 2.12
Enable boolean W Enable/Disable this Controller instance. When false, messages (notifications) are not sent to the remote endpoint represented by this Controller instance. false 2.12
AssignedRole string[] W Each list item MUST be the Path Name of a row in the Device.LocalAgent.ControllerTrust.Role. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Comma-separated list of strings, each entry is a Role that has been assigned to this Controller instance by means other than the LocalAgent.ControllerTrust.Credential.{i}.Role parameter. - 2.12
InheritedRole string[] R Each list item MUST be the Path Name of a row in the Device.LocalAgent.ControllerTrust.Role. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Comma-separated list of strings, each entry is a Role that has been assigned to this Controller instance from the LocalAgent.ControllerTrust.Credential.{i}.Role parameter associated with the CA credential (LocalAgent.ControllerTrust.Credential.{i}.Credential) used to validate the Controller certificate. - 2.12
Credential string W The value MUST be the Path Name of a row in the Certificate. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Comma-separated list of strings, the set of certificates from Certificate.{i} that a Controller can present for use in authenticating the identity of this Controller instance. - 2.12
PeriodicNotifInterval unsignedInt(1:) W If a Periodic Event Notification Subscription instance is associated with this USP Controller, then this is the duration in seconds of the interval for which the USP Agent MUST attempt to issue a Periodic Notification to the USP Controller. - 2.12
PeriodicNotifTime dateTime W If a Periodic Event Notification Subscription instance is associated with this USP Controller, then this is an absolute time reference in UTC to determine when the USP Agent will issue a Periodic Notification. Each Periodic Notification MUST occur at this reference time plus or minus an integer multiple of the PeriodicNotifInterval. PeriodicNotifTime is used only to set the phase of the Periodic Event Notifications. The actual value of PeriodicNotifTime can be arbitrarily far into the past or future. For example, if PeriodicNotifInterval is 86400 (a day) and if PeriodicNotifTime is set to UTC midnight on some day (in the past, present, or future) then Periodic Notifications will be sent every day at UTC midnight. These MUST begin on the very next midnight, even if PeriodicNotifTime refers to a day in the future. The Unknown Time value defined in [Section 3.2/TR-106a2] indicates that no particular time reference is specified. That is, the USP Agent MAY locally choose the time reference, and needs only to adhere to the specified PeriodicNotifInterval. If absolute time is not available to the USP Agent, its Periodic Notification behavior MUST be the same as if the PeriodicNotifTime parameter was set to the Unknown Time value. - 2.12
USPNotifRetryMinimumWaitInterval unsignedInt(1:65535) W This parameter is related to the retry mechanism for Notifications. Configures the first retry wait interval, in seconds, as specified in [Section “Responses to Notifications and Notification Retry”/TR-369]. A value of 5 corresponds to the default behavior. The USP Agent MUST use a random value between USPNotifRetryMinimumWaitInterval and (USPNotifRetryMinimumWaitInterval * USPNotifRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. 5 2.12
USPNotifRetryIntervalMultiplier unsignedInt(1000:65535) W This parameter is related to the retry mechanism for Notifications. Configures the retry interval multiplier as specified in [Section “Responses to Notifications and Notification Retry”/TR-369]. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. A value of 2000 corresponds to the default behavior. The USP Agent MUST use a random value between USPNotifRetryMinimumWaitInterval and (USPNotifRetryMinimumWaitInterval * USPNotifRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. 2000 2.12
ScheduleTimer() command - Schedule a Timer! event on the associated Controller. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ DelaySeconds unsignedInt(1:) W

[MANDATORY] The number of seconds from the time this command is invoked until the Agent initiates a Timer! Event notification (based on the associated subscriptions).

The default value MUST be 0.

 - 2.12
Timer! event - Timer event requested via a ScheduleTimer() command invoked on the same Controller instance via an Operate USP message. - 2.12
⇒ CommandKey string R The command_key supplied when requesting the timer event. - 2.12
AddMyCertificate() command - This command is issued to allow a Controller to add a new certificate for itself. This can be useful when the current certificate is expiring or has become compromised. This command creates a new entry in Certificate and adds a reference to the new entry to the Controller’s Controller.{i}.Credential. The Agent will use the Serial Number and Issuer fields from the input Certificate to populate the Certificate.{i}.SerialNumber and Certificate.{i}.Issuer parameters. If Certificate already has an instance with the same Certificate.{i}.SerialNumber and Certificate.{i}.Issuer parameters, this command will fail. To replace an instance with the same Certificate.{i}.SerialNumber and Certificate.{i}.Issuer, the existing instance must first be deleted. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ Alias string(:64) W [Alias] An optional input the Controller can use to specify the Certificate.{i}.Alias value for the added entry. If provided as an input and the value already exists in Certificate.{i}, this commmand will fail. - 2.12
⇒ Certificate string(:65535) W [MANDATORY] The X.509 certificate in Privacy-enhanced Electronic Mail (PEM) format. - 2.12
SendOnBoardRequest() command - Requests the Agent to send an OnBoardRequest notification to this Controller. - 2.12
BootParameterNumberOfEntries unsignedInt R The number of entries in the BootParameter table. - 2.12
MTPNumberOfEntries unsignedInt R The number of entries in the MTP table. - 2.12
Device.LocalAgent.Controller.{i}.MTP.{i}. object(0:) W

Each instance of this table represents a MTP used by this Controller.

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

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

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

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

 - 2.12
Enable boolean W Enable/Disable this MTP instance. If this MTP instance is to be disabled and currently used for communication with the requesting controller, the agent has to send the request response first, before disabling it. false 2.12
Protocol string W The value MUST be a member of the list reported by the Device.LocalAgent.SupportedProtocols parameter. The Message Transport Protocol (MTP) to be used for communications by a USP Endpoint. CoAP 2.12
Device.LocalAgent.Controller.{i}.MTP.{i}.CoAP. object R If the USP Endpoint uses the CoAP Message Transport Protocol (MTP), then this object contains CoAP specific configuration parameters. - 2.12
Host string(:256) W The hostname or IP Address of the Controller’s CoAP server. - 2.12
Port unsignedInt(1:65535) W The port number used by the Controller’s CoAP Server to receive USP messages. - 2.12
Path string W The path that is used by the Controller’s CoAP Server in order to receive USP messages. - 2.12
EnableEncryption boolean W When true, encryption is used as specified in [Section “MTP Message Encryption”/TR-369]. true 2.12
Device.LocalAgent.Controller.{i}.MTP.{i}.STOMP. object R If the USP Endpoint uses the STOMP Message Transport Protocol (MTP), then this object contains STOMP Client specific configuration parameters related to how this Controller communicates with the STOMP Server. - 2.12
Reference string W The value MUST be the Path Name of a row in the STOMP.Connection. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. A reference to the STOMP Connection used by this Controller when communicating via the STOMP MTP. <Empty> 2.12
Destination string W The STOMP destination where the Controller will be listening to incoming USP messages. <Empty> 2.12
Device.LocalAgent.Controller.{i}.MTP.{i}.WebSocket. object R If the USP Endpoint uses the WebSocket Message Transport Protocol (MTP) as a WebSocket client, then this object contains WebSocket specific configuration parameters. - 2.12
Host string(:256) W The hostname or IP Address of the Controller’s WebSocket server. - 2.12
Port unsignedInt(1:65535) W The port number used by the Controller’s WebSocket server to receive USP messages. - 2.12
Path string W The path that is used by the Controller’s WebSocket server in order to receive USP messages. - 2.12
IsEncrypted boolean R This parameter represents whether or not communications that utilize this WebSocket object instance are encrypted. - 2.12
KeepAliveInterval unsignedInt(1:) W The the duration in seconds between when WebSocket ping control frames are transmitted by the Agent to the WebSocket server for the USP Controller. - 2.12
CurrentRetryCount unsignedInt R The current retry count of the session. When zero (0), the session is not in a retry state. - 2.12
SessionRetryMinimumWaitInterval unsignedInt(1:65535) W Configures the first retry wait interval, in seconds, as specified in [Section “WebSocket Session Retry”/TR-369]. The USP Agent MUST use a random value between SessionRetryMinimumWaitInterval and (SessionRetryMinimumWaitInterval * SessionRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. 5 2.12
SessionRetryIntervalMultiplier unsignedInt(1000:65535) W Configures the retry interval multiplier as specified in [Section “WebSocket Session Retry”/TR-369]. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. The USP Agent MUST use a random value between SessionRetryMinimumWaitInterval and (SessionRetryMinimumWaitInterval * SessionRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. 2000 2.12
Reset() command - [ASYNC] If enabled, this command will either request to start or restart an WebSocket session with the Controller. - 2.12
Device.LocalAgent.Controller.{i}.TransferCompletePolicy. object R The policy defined in this object determines the conditions under which the USP Agent notifies a USP Controller, that has an appropriate Subscription, of the completion of file transfers. - 2.12
ResultTypeFilter string W

Indicates the transfer results that MUST be included when the USP Agent notifies a USP Controller of file transfers. Transfer results omitted from this list MUST NOT be included when the USP Agent notifies a USP Controller.

Enumeration of:

 - 2.12
Device.LocalAgent.Controller.{i}.BootParameter.{i}. object(0:) W

This table provides the Controller with the ability to dictate the Parameters that are delivered via Boot! events. Any Parameter (identified by ParameterName) contained in this table MUST be included within the param_map element of the Boot! event.

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

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

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

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

 - 2.12
Enable boolean W Enables or disables this BootParameter. false 2.12
ParameterName string(:256) W A pattern that describes the Parameter(s) to be included in the param_map element of a Boot! event. Specifically, patterns with wildcards (an “*” character) in place of Instance Identifiers are allowed. If the pattern does not match any existing Parameters at the time that the Agent is creating the Boot! event, then this BootParameter instance is not included in the param_map of the Boot! event. <Empty> 2.12
Device.LocalAgent.Controller.{i}.E2ESession. object R The E2ESession object represents the End to End (E2E) Session Context functionality for this Controller.{i} object instance. - 2.12
Enable boolean W Enable/Disable this E2ESession instance. When true, Session Context is used when exchanging USP Records with the remote endpoint represented by this Controller.{i} object instance. When false, Session Context is not used when exchanging USP Records with the remote endpoint represented by this Controller.{i} object instance. false 2.12
Status string R

The current status of the Session Context.

Enumeration of:

  • Up
  • Negotiating (A new Session Context is being negotiated (i.e., a USP Record with sequence_id of 0 and session_id not previously used with this remote endpoint was sent and response has not yet been received), OPTIONAL)
  • Down
 - 2.12
SessionExpiration unsignedInt(0:) W The duration in seconds in which the current Session Context will expire since the last session-related activity (e.g., Message sent or received, Session Context start or restart). A value of 0 means session expiration is disabled. 0 2.12
SessionRetryMinimumWaitInterval unsignedInt(1:65535) W Configures the first retry wait interval, in seconds, as specified in [Section “Failure Handling in the Session Context”/TR-369]. A value of 5 corresponds to the default behavior that is described in [TR-369]. The USP Agent MUST use a random value between SessionRetryMinimumWaitInterval and (SessionRetryMinimumWaitInterval * SessionRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. 5 2.12
SessionRetryIntervalMultiplier unsignedInt(1000:65535) W Configures the retry interval multiplier as specified in [Section “Failure Handling in the Session Context”/TR-369]. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. A value of 2000 corresponds to the default behavior that is described in [TR-369]. The USP Agent MUST use a random value between SessionRetryMinimumWaitInterval and (SessionRetryMinimumWaitInterval * SessionRetryIntervalMultiplier / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. 2000 2.12
CurrentRetryCount unsignedInt R The current retry count of the Session Context. When zero (0), the Session Context is not in a retry state. - 2.12
SegmentedPayloadChunkSize unsignedInt(0,512:) W The maximum size, in bytes, of the Record (payload(s) and headers) that can be transmitted to the remote endpoint. The smallest size, which can be configured is 512 bytes. A value of 0 means that the segmentation function is effectively disabled. 0 2.12
MaxRetransmitTries int(-1:10) W The maximum times that a USP Endpoint attempts to retransmit the requested USP Record to the remote endpoint. If the maximum tries is met for any requested USP Record, the USP Endpoint will restart the E2E Session. A value of -1 means that the USP Endpoint will always attempt to retransmit the requested USP Record. A value of 0 means that the USP Endpoint will not attempt to retransmit the requested USP Record and will restart the E2E Session. 0 2.12
PayloadSecurity string W

The security mechanism to use when exchanging the payload of the Record with the remote endpoint.

Enumeration of:

  • Plaintext
  • TLS (The payload is encrypted at the originating endpoint and decrypted at the receiving endpoint using TLS. The procedures for using TLS in a Session Context is defined in [TR-369])
 TLS 2.12
Reset() command - [ASYNC] If the E2ESession is enabled then this command will either request to start or restart a Session Context with the remote endpoint. If the E2ESession is not enabled and there is an active Session Context then this command will terminate that Session Context with the remote endpoint. If the E2ESession is not enabled and there is no active Session Context then this command does nothing. - 2.12
Device.LocalAgent.Subscription.{i}. object(0:) W

A Subscription dictates how a USP Agent issues USP Notification Messages to a USP Controller.

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

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

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

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

 - 2.12
Enable boolean W Enables/disables this Subscription. A disabled entry MUST NOT be processed by the USP Agent. false 2.12
Recipient string R

The value MUST be the Path Name of the Controller instance that will receive the Notification associated with this Subscription. If the referenced object is deleted, this instance MUST also be deleted (so the parameter value will never be an empty string). The value of this parameter is automatically populated by the USP Agent upon Subscription creation using the reference to the USP Controller that created the instance.

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

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

 - 2.12
ID string(:64) W

Unique identifier of the Subscription itself, which is specific to the USP Controller that creates the instance of the Subscription. This value is also populated in the subscription_id element of every Notification message sent from a USP Agent to a USP Controller.

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

 <Empty> 2.12
CreationDate dateTime R The date and time when this instance of Subscription was created. This is internally used by the TimeToLive parameter to determine the expiration of this Subscription instance. The value of this parameter is automatically populated by the USP Agent upon Subscription creation. - 2.12
NotifType string W

Type of Notification message that will be sent to the USP Controller specified by Recipient when this Subscription is triggered.

Enumeration of:

  • ValueChange
  • ObjectCreation
  • ObjectDeletion
  • OperationComplete
  • Event
 - 2.12
ReferenceList string(:256)[] W Comma-separated list of strings (maximum number of characters per item 256). Each entry in the list is a parameter path that determines the element of the data model that the Subscription is applicable to. Different values of the NotifType parameter will cause the Subscription to interact with ReferenceList differently. For example, an instance of Subscription with ValueChange will utilize the value of this parameter differently than an instance with Event. Expressions are allowed in the list items, but in some cases could cause a dynamic set of instances to be monitored in order to fulfill the Subscription’s requirements. Once the value of the ReferenceList is written, the value cannot be changed as the Subscription instance is considered to be immutable. If the value of a non-empty ReferenceList parameter needs to change, the Subscription instance MUST be deleted and a new Subscription instance created. - 2.12
Persistent boolean W Determines whether or not this Subscription remains after the USP Agent is restarted (either via a reset of the software or reboot of the underlying device). If true, this Subscription stays in existence until either a Delete message removes it or the TimeToLive parameter expires. If false, this Subscription is automatically removed by the USP Agent whenever it is restarted. false 2.12
TimeToLive unsignedInt W Specifies the duration of time (in seconds) that this Subscription remains in existence. After TimeToLive has expired, this Subscription instance is automatically removed by the USP Agent. If the value of TimeToLive is 0, then this parameter is ignored and this Subscription stays in existence until either a Delete message removes it or the Persistent parameter determines that it needs to be removed. If the value of TimeToLive is greater than 0, then this parameter determines the length of time (from Subscription creation) until it will be automatically removed by the USP Agent (unless the Persistent parameter is false and the USP Agent is restarted, in which case it will be removed before the TimeToLive expiration). NOTE: This paramater does not count down as time moves forward; it will always read back with the same value that it was last set to. If the USP Agent is incapable of maintaining absolute time then TimeToLive will automatically expire if the USP Agent is restarted (either via a reset of the software or reboot of the underlying device) before TimeToLive expiration. 0 2.12
NotifRetry boolean W Specifies whether or not the USP Agent attempts to re-deliver the Notification in the event that it could not be delivered to the USP Controller. When NotifRetry is true, the USP Agent MUST retry the delivery of the Notification. This implies that the Notification MUST be generated with the “send_resp” flag set to true such that the USP Agent knows when the Notification has been successfully delivered. The retry attempt(s) are performed using the retry algorithm defined in [Section “Responses to Notifications and Notification Retry”/TR-369]. When NotifRetry is false, the USP Agent MUST NOT retry the delivery of the Notification, and SHOULD generate the notification with “send_resp” flag set to false. false 2.12
NotifExpiration unsignedInt W Specifies the duration of time (in seconds) that the Notification associated with this Subscription will continue to be retried. After NotifExpiration has expired, if the Notification has still not been successfully delivered then the USP Agent MUST stop attempting to re-deliver the Notification. If NotifRetry is set to false then this parameter is ignored. If NotifRetry is set to true and the value of NotifExpiration is 0, then the USP Agent will attempt to re-deliver the Notification until it has been successfully delivered or until the USP Agent is restarted (either via a reset of the software or reboot of the underlying device). If NotifRetry is set to true and the value of NotifExpiration is greater than 0, then the USP Agent will attempt to re-deliver the Notification until either it has been successfully delivered, until the length of time (from the time tha the Notification was initially attempted to be delivered) specified in this parameter expires, or until the USP Agent is restarted (either via a reset of the software or reboot of the underlying device). NOTE: This paramater does not count down as time moves forward; it will always read back with the same value that it was last set to. 0 2.12
Device.LocalAgent.Request.{i}. object(0:) R

Request instances are created using USP Operate messages. Only Operate messages with async=true will create a Request instance in the data model. When the command of the Operate completes, then this Request instance is removed from this table.

At most one entry in this table can exist with the same values for all of Originator, Command and CommandKey, or with a given value for Alias.

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

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

 - 2.12
Originator string R The USP Endpoint Identifier that originated the command. - 2.12
Command string R The command to be executed. This parameter is a Path Name that addresses a Command in an Object or Object Instance. The command is a result of the evaluation of the command argument of an Operate message. - 2.12
CommandKey string R The command_key from the USP Operate message. - 2.12
Status string R

The operational status of the request to execute the command.

Enumeration of:

  • Requested (The command has been requested but is currently not executing)
  • Active (The command is currently executing)
  • Canceling (The command has been requested to be canceled)
  • Canceled (The command has successfully been canceled)
  • Success (The command has successfully been completed its execution)
  • Error (The command has unsuccessfully completed its execution or has unsuccessfully been canceled)
 - 2.12
Cancel() command - Request cancelation of this Request’s command. This command completes immediately. If successful, Status will immediately change to Canceling and will change to Canceled when the cancelation is complete. - 2.12
Device.LocalAgent.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 LocalAgent.Controller.{i}.Credential and LocalAgent.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.12
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.

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

 - 2.12
Enable boolean W Enable/Disable this Certificate instance. - 2.12
SerialNumber string(:64) R The Serial Number field in an X.509 certificate, see [RFC5280]. - 2.12
Issuer string(:256) R The Issuer field in an X.509 certificate, see [RFC5280]; i.e. the Distinguished Name (DN) of the entity who has signed the certificate. - 2.12
Delete() command - This command is issued to allow a Controller (with the proper permissions) to delete an entry from the Certificate.{i}. It also removes references to the Certificate in LocalAgent.Controller.{i}.Credential or LocalAgent.ControllerTrust.Credential.{i}.Credential and removes any X.509 certificate data the Agent had stored related to the entry. - 2.12
GetFingerprint() command - This command is issued to allow a Controller to request the value of a fingerprint calculated for the specified table entry using the input FingerprintAlgorithm. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ FingerprintAlgorithm string W

[MANDATORY] The algorithm to be used to calculate the requested fingerprint. The value MUST be one the Agent supports, as noted in SupportedFingerprintAlgorithms.

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.12
⇐ Output. arguments - Output arguments. -
⇐ Fingerprint hexBinary(:128) R The value of the fingerprint. - 2.12
Device.LocalAgent.ControllerTrust. object R This object contains information that an Agent applies when establishing a trust relationship with a Controller. - 2.12
UntrustedRole string[:1] W Each list item MUST be the Path Name of a row in the Role. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Comma-separated list (up to 1 item) of strings, each entry is a Role that is associated with Controllers whose identity cannot be authenticated. The value of the UntrustedRole parameter is appended to the LocalAgent.Controller.{i}.AssignedRole parameter. In some instances, this policy is set by the Agent and cannot be modified by Controllers. If the Agent does not allow modification of this parameter, the Agent MUST respond with an error to the request to set this parameter. - 2.12
BannedRole string W The value MUST be the Path Name of a row in the Role. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The Role that is associated with Controllers indicate banned access. When assigned to a Controller or associated with an entry in the Credential table, this MUST be the only value of the BannedRole parameter of the LocalAgent.Controller.{i}.AssignedRole parameter. The Agent SHOULD refuse to accept USP messages from, or send USP messages to, any Controller that has this Role. - 2.12
TOFUAllowed boolean W When true, Agent has active policy that allows for self-signed certificates and certificates from unknown Certificate Authorities (CAs) to be trusted on first use (TOFU). - 2.12
TOFUInactivityTimer unsignedInt W Inactivity timer in seconds. This timer is started when trust on first use (TOFU) policy is used to accept a Controller certificate. If no USP Message is received before this timer elapses, the Agent MUST tear down the MTP connection and underlying (D)TLS session. A value of 0 means that the TOFU inactivity timer is effectively disabled. - 2.12
RequestChallenge() command - This command is issued to retrieve the instruction for the referenced challenge. There is at most one (1) outstanding RequestChallenge for a requesting Controller. As such, any new challenges with a different value of the ChallengeRef parameter are denied until a successful response to the outstanding challenge is received by the Agent or the current RequestChallenge expires. When the value of the ChallengeRef parameter defined in the RequestChallenge does not exist, the Agent returns an “Invalid Value” error. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ ChallengeRef string W [MANDATORY] The value MUST be the Path Name of the Challenge object instance for this request. - 2.12
⇒ RequestExpiration int(0:) W The expiration period, in seconds, where the Controller request that this challenge request expire (times-out). A value of zero indicates that the challenge request will never expire. The default is 900 seconds. - 2.12
⇐ Output. arguments - Output arguments. -
⇐ Instruction base64 R The value of the Challenge.{i}.Instruction parameter associated with the requested challenge in the Input.ChallengeRef parameter. - 2.12
⇐ InstructionType string R The media type with a format as defined by [RFC6838] of the content of the Instruction parameter. The allowable values of the media type are defined by the Challenge.{i}.InstructionType parameter. - 2.12
⇐ ValueType string R The media type with a format as defined by [RFC6838] of the content of the Challenge.{i}.Value parameter. The allowable values of the media type are defined by the Challenge.{i}.ValueType parameter. - 2.12
⇐ ChallengeID string R The challenge identifier the Controller uses in the ChallengeResponse command to correlate this request with a response. - 2.12
ChallengeResponse() command - This command is issued to return the response of challenge. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ ChallengeID string W [MANDATORY] The challenge identifier the Controller uses to correlate the challenge request with a response. - 2.12
⇒ Value base64 W [MANDATORY] The value of the challenge that is specific to the type of challenge. The challenge value is provided by the external party to the Controller. - 2.12
RoleNumberOfEntries unsignedInt R The number of entries in the Role table. - 2.12
CredentialNumberOfEntries unsignedInt R The number of entries in the Credential table. - 2.12
ChallengeNumberOfEntries unsignedInt R The number of entries in the Challenge table. - 2.12
Device.LocalAgent.ControllerTrust.Role.{i}. object(0:) W

Each instance of this table represents a Role that can be assigned to or inherited by a Controller via the Controller Trust mechanism. The Role contains a set of permissions that determine how the Controller can interact with the data model. If multiple permission entries associated with this table contain a Target that evaluates to the same instantiated Object/Parameter for multiple Roles, then the permissions to be used are a union of the identified permissions.

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

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

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

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

 - 2.12
Enable boolean W Enable/Disable this Role instance. false 2.12
Name string W

The Role assigned to this Role instance.

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

 - 2.12
PermissionNumberOfEntries unsignedInt R The number of entries in the Permission table. - 2.12
Device.LocalAgent.ControllerTrust.Role.{i}.Permission.{i}. object(0:) W

Each instance of this table represents the permissions that are extended to a set of Targets for a specified Role. If there are multiple entries in this table for a specific Role where the Targets overlap, the permissions for the entry with the highest value takes priority over all others.

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

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

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

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

 - 2.12
Enable boolean W Enable/Disable this Permission instance. false 2.12
Order unsignedInt W The order (relative priority) to use when determining the permissions for overlapping Targets that are contained within the same Role. The larger value of this parameter takes priority over a permission with a smaller value (i.e., 0 has the lowest priority). 0 2.12
Targets string[] W Comma-separated list of strings, each entry is a target to which the value of the permissions parameters are assigned. When an entry is a value of a Partial Path, the permissions are associated to that Object and any child Object/Parameter. When the value of an entry is an Object instance then the permissions are associated to all Parameters of the Object instance. When an entry is a value of a Search Path as defined in [TR-369] that resolves to zero or more Parameter Paths, then all Parameter Paths that result from the evaluation of the Search Path are subject to the permissions assigned by this Permission instance. <Empty> 2.12
Param string(4) W The permissions of a Role for the specified Targets. A string of 4 characters where each character represents a permission (“r” for Read, “w” for Write, “x” for Execute“, and “n” for Notify). The string is always in the same order (rwxn) and the lack of a permission is signified by a “-” character (e.g., r–n). The following describes the meaning of the permissions for Parameter type of Targets:
  1. Read: Grants the capability to read the value of the Parameter via Get and read the meta-information of the Parameter via GetSupportedDM.
  2. Write: Grants the capability to update the value of the Parameter via Add or Set.
  3. Execute: Grants no capabilities; Parameters can not be executed.
  4. Notify: Grants the capability to use this Parameter in the ReferenceList of a ValueChange Subscription.
 ---- 2.12
Obj string(4) W The permissions of a Role for the specified Targets. A string of 4 characters where each character represents a permission (“r” for Read, “w” for Write, “x” for Execute“, and “n” for Notify). The string is always in the same order (rwxn) and the lack of a permission is signified by a “-” character (e.g., r–n). The following describes the meaning of the permissions for Object type of Targets:
  1. Read: Grants the capability to read the meta-information of the Object via GetSupportedDM.
  2. Write: Grants no capabilities for Static Objects. Grants the capability to create a new instance of a Multi-Instanced Object via Add (e.g. Device.LocalAgent.Controller.).
  3. Execute: Grants no capabilities; Objects are not executable and Commands are controlled by the CommandEventPermissions.
  4. Notify: Grants the capability to use this Object in the ReferenceList of an ObjectCreation (for multi-instance objects only) Subscription.
 ---- 2.12
InstantiatedObj string(4) W The permissions of a Role for the specified Targets. A string of 4 characters where each character represents a permission (“r” for Read, “w” for Write, “x” for Execute“, and “n” for Notify). The string is always in the same order (rwxn) and the lack of a permission is signified by a “-” character (e.g., r–n). The following describes the meaning of the permissions for Instantiated Object type of Targets:
  1. Read: Grants the capability to read the instance numbers and unique keys of the Instantiated Object via GetInstances.
  2. Write: Grants the capability to remove an existing instance of an Instantiated Object via Delete (e.g. Device.LocalAgent.Controller.1.).
  3. Execute: Grants no capabilities; Object Instances are not executable and Commands are controlled by the CommandEventPermissions.
  4. Notify: Grants the capability to use this Instantiated Object in the ReferenceList of an ObjectDeletion Subscription.
 ---- 2.12
CommandEvent string(4) W The permissions of a Role for the specified Targets. A string of 4 characters where each character represents a permission (“r” for Read, “w” for Write, “x” for Execute“, and “n” for Notify). The string is always in the same order (rwxn) and the lack of a permission is signified by a “-” character (e.g., r–n). The following describes the meaning of the permissions for Command and Event type of Targets:
  1. Read: Grants the capability to read the meta-information of the Command (including input and output arguments) and Event (including arguments) via GetSupportedDM.
  2. Write: Grants no capabilities; Commands are executed instead of written to and Events are read only.
  3. Execute: Grants the capability to execute the Command via Operate, but grants no capabilities to an Event.
  4. Notify: Grants the capability to use this Event or Command in the ReferenceList of an Event or OperationComplete Subscription.
 ---- 2.12
Device.LocalAgent.ControllerTrust.Credential.{i}. object(0:) W

Each instance of this table represents a trusted credential. The credential can be that of a certificate authority (CA) for a Controller whose EndpointID is unknown. When a credential is supplied to the Agent by a Controller during authentication, the credentials in this table are used to determine if any of the supplied certificates (including those in the chain of trust) are considered “trusted”. If the Controller authenticated via an entry in this table is not previously known to the Agent, the associated Role entry is automatically applied to the Controller.

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

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

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

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

 - 2.12
Enable boolean W Enable/Disable this Credential instance. false 2.12
Role string[] W Each list item MUST be the Path Name of a row in the Role. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Comma-separated list of strings, the (set of) Role(s) applied to a Controller authenticated through this Credential instance. The roles are added to the Controller’s current list of Roles by replacing the value of the LocalAgent.Controller.{i}.InheritedRole parameter. If the Controller is already known to the Agent, with an associated Role, this parameter has no impact. - 2.12
Credential string W

The value MUST be the Path Name of a row in the Certificate. table. If the referenced object is deleted, the parameter value MUST be set to an empty string. A reference to the Certificate.{i} instance for use in the authentication of certificates provided by a Controller and authorization of Controllers, and for authentication of certificates used for MTP encryption.

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

 - 2.12
AllowedUses string W

Identifies what usages the Certificate Authority (CA) authenticated by the associated credential is trusted to authorize.

Enumeration of:

  • MTP-only (The CA can only authorize MTP (domain) connectivity, and cannot authenticate Controllers)
  • MTP-and-USP (The CA can authorize MTP (domain) connectivity and authenticate Controllers)
  • MTP-and-broker (The CA can authorize MTP (domain) connectivity and the presenter of this certificate is trusted to have authenticated the identity of Endpoints whose Records it transmits such that the from_id can be trusted without additional authentication. See [“Authentication and Authorization”/TR-369] for additional description of the Trusted Broker function)
 - 2.12
Device.LocalAgent.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 LocalAgent.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 can exist with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose an initial value for Alias such that the new entry does not conflict with any existing entries.

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

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

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

 - 2.12
Description string W The description of this Challenge instance. - 2.12
Role string[] W Each list item MUST be the Path Name of a row in the Role. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Comma-separated list of strings, the (set of) role(s) appended (non-duplicate values only) to the value of the LocalAgent.Controller.{i}.AssignedRole parameter. - 2.12
Enable boolean W Enable/Disable this Challenge instance. false 2.12
Type string W

The type of challenge that will be verified from the challenge response provided by the third-party through the Controller.

Enumeration of:

  • Passphrase (The challenge uses a passphrase the third-party is expected to match)
 - 2.12
Value base64 W

The value of the challenge that is specific to the type of challenge.

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

 - 2.12
ValueType string W

The media type with a format as defined by [RFC6838] of the content of the Value parameter.

Enumeration of:

  • text/plain
  • image/jpeg
 - 2.12
Instruction base64 W The instruction that is provided to the external party by the Controller requesting the challenge. - 2.12
InstructionType string W

The media type with a format as defined by [RFC6838] of the content of the Instruction parameter.

Enumeration of:

  • text/plain
  • image/jpeg
  • text/html
 - 2.12
Retries unsignedInt W The number of times a challenge is retried before the challenge procedure is terminated. - 2.12
LockoutPeriod int(0:) W The time, in seconds that a Controller that has failed the challenge is locked out (based on the value of the Retries parameter) prior to being provided the challenge again. A value of zero means that a LockoutPeriod doesn’t apply and the challenge can be provided indefinitely. 30 2.12
Device.STOMP. object R The STOMP represents the STOMP capabilities of the device as described in [TR-369]. - 2.12
ConnectionNumberOfEntries unsignedInt R The number of entries in the Connection table. - 2.12
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 can exist with the same values for all of Host, Username and VirtualHost, or with a given value for Alias. On creation of a new table entry, the Agent MUST (if not supplied by the Controller on creation) choose initial values for Host, Username and Alias such that the new entry does not conflict with any existing entries.

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

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

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

 - 2.12
Enable boolean W Enables or disables this Connection. This parameter is based on ifAdminStatus from [RFC2863]. false 2.12
Status string R

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

  • Enabled
  • Disabled
  • Unknown
  • Connecting
  • ServerNotPresent
  • Error_Misconfigured
  • Error_AuthenticationFailure
  • Error (OPTIONAL) When Enable is false then Status SHOULD normally be Disabled or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Enabled if and only if the interface is able to transmit and receive PDUs; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.
 - 2.12
LastChangeDate dateTime R The date and time at which this Connection entered into its current operational state. - 2.12
Host string(:256) W

The hostname or IP Address of the STOMP Server.

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

 - 2.12
Port unsignedInt(1:65535) W The port number of the STOMP Server. 61613 2.12
Username string(:256) W

The username part of the credentials to be used when authenticating this Connection during connection establishment with the STOMP Server.

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

 - 2.12
Password string(:256) W

The password part of the credentials to be used when authenticating this Connection during connection establishment with the STOMP Server.

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

 - 2.12
VirtualHost string(:256) W The Virtual Host to use when establishing the connection. Some STOMP Server implementations utilize virtual hosts to place a context around credentials, permissions, and internal resources. <Empty> 2.12
EnableHeartbeats boolean W Enable or disable the STOMP Heart-beating mechanism as described in STOMP (for this Connection). When the STOMP Heart-beat mechanism is enabled, OutgoingHeartbeat and IncomingHeartbeat determine how the heart-beat header within the CONNECT frame is formatted. When the STOMP Heart-beat mechanism is disabled, OutgoingHeartbeat and IncomingHeartbeat are ignored and the CONNECT frame MUST NOT contain a heart-beat header element. Any changes to this parameter will not take effect until the next connection. false 2.12
OutgoingHeartbeat unsignedInt W Represents the Outgoing heart-beat timing of the STOMP Heart-beating mechanism as described in STOMP (for this Connection). The Outgoing heart-beat represents what the sender of the frame can do. A value of 0 means that it cannot send heart-beats. Any changes to this parameter will not take effect until the next connection. 0 2.12
IncomingHeartbeat unsignedInt W Represents the Incoming heart-beat timing of the STOMP Heart-beating mechanism as described in STOMP (for this Connection). The Incoming heart-beat represents what the sender of the frame would like to get. A value of 0 means that it does not want to receive heart-beats. Any changes to this parameter will not take effect until the next connection. 0 2.12
ServerRetryInitialInterval unsignedInt(1:65535) W The maximum first reconnection wait interval, in seconds, as specified in [TR-369]. The Device MUST use a random value between 0 and ServerRetryInitialInterval as the first reconnection wait interval. 60 2.12
ServerRetryIntervalMultiplier unsignedInt(1000:65535) W The reconnection interval multiplier as specified in [TR-369]. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. For the nth reconnection wait interval, the Device MUST use a random value, in seconds, between 0 and ServerRetryInitialInterval * (ServerRetryIntervalMultiplier / 1000) ** (n - 1). 2000 2.12
ServerRetryMaxInterval unsignedInt(1:) W The maximum reconnection wait interval, in seconds. If the nth reconnection wait interval calculated from ServerRetryInitialInterval and ServerRetryIntervalMultiplier exceeds the value of this parameter, then the Agent MUST use the value of this parameter as the next reconnection wait interval. 30720 2.12
IsEncrypted boolean R This parameter represents whether or not communications that utilize this Connection object instance are encrypted. - 2.12
Device.Standby. object R Capabilities of a Device as it pertains to entering a standby state. - 2.12
NetworkAware boolean R Indicates that the device is capable of maintaining a network connection and responding to communications via the network connection while in a standby state. - 2.12
TimerAware boolean R Indicates that the device is capable of maintaining and responding to timers while in a standby state. - 2.12
Device.SoftwareModules. object R Top level object for dynamically managed software applications.

Changes in 2.12:

 - 2.12
InstallDU() command - [ASYNC] Install one or more Deployment Units (DUs) to the associated SoftwareModules. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ URL string(:256) W [MANDATORY] The URL, as defined in [RFC3986], that specifies the location of the DU to be installed. The URL MUST NOT include the “userinfo” component, as defined in [RFC3986]. HTTP and HTTPS transports MUST be supported. Other optional transports MAY be supported. - 2.12
⇒ UUID string(36) W [UUID] The UUID (see [RFC4122]) of the DU to be installed. If this parameter is an empty string the device MUST generate the UUID based on the rules defined in [RFC4122] and [Annex H/TR-069]. - 2.12
⇒ Username string(:256) W

Username to be used by the device to authenticate with the file server, if authentication is required.

The default value MUST be an empty string.

 - 2.12
⇒ Password string(:256) W

Password to be used by the device to authenticate with the file server, if authentication is required.

The default value MUST be an empty string.

 - 2.12
⇒ ExecutionEnvRef string(:256) W The value MUST be the Path Name of a row in the SoftwareModules.ExecutionUnit. table. A reference to the Execution Environment upon which the DU to be installed. If an empty string the device MUST choose the Execution Environment to use. - 2.12
DUStateChange! event - This event informs a Controller of the completion (successful or unsuccessful) of a DU state change. When used, this event MUST be issued after the device has completed any file transfers and carried out all operations related to the DU State Change. This event MAY contain the results from multiple DU state changes; it is implementation specific how the device chooses to aggregate the DU state changes, although the device MUST notify the Controller of any DU state changes within 24 hours of the time the operations were completed by the device. The device SHOULD make every attempt to aggregate, as much as possible, the DU State Change notifications to the Controller in the interest of scalability. - 2.12
⇒ UUID string(36) R [UUID] The UUID as defined in [RFC4122] of the DU that affected by the state change. - 2.12
⇒ DeploymentUnitRef string R The value MUST be the Path Name of a row in the SoftwareModules.DeploymentUnit. table. A reference to the DU that was affected by the state change. - 2.12
⇒ Version string(:32) R In the case of an Install, this will be the version of the DU created. In the case of an Update, it will be the updated version of the DU. In the case of an Uninstall, it will be the version of the uninstalled DU. This MUST match the SoftwareModules.DeploymentUnit.{i}.Version Parameter contained within the instance of the DeploymentUnit that is contained within the DeploymentUnitRef argument. - 2.12
⇒ CurrentState string R

The current state of the created DU.

Enumeration of:

  • Installed (The DU is in an Installed state due to one of the following: successful Install, successful Update, failed Update, or failed Uninstall. In the case of a failed Update or failed Uninstall the Fault argument will contain an explanation of the failure)
  • UnInstalled (The DU was successfully uninstalled from the device)
  • Failed (The DU could not be installed in which case a DU instance MUST NOT be created in the Data Model)
 - 2.12
⇒ Resolved boolean R Whether or not the DU operation resolved all of its dependencies. In the case of a successful Uninstall, this value is meaningless and should be true. - 2.12
⇒ ExecutionUnitRefList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the SoftwareModules.ExecutionUnit. table. The Execution Units affected by this operation. In the case of an Install, this will be the list of EUs that were created as a result of the DU’s installation. In the case an Update, this will be the list of all EUs currently associated with the updated DU, including those that were created through the initial DU installation and any updates that had already occurred but not including any EUs that no longer exist on the device because of this or previous updates. In the case of an Uninstall, this will be the list of the EUs removed from the device due to the DU being removed. - 2.12
⇒ StartTime dateTime R The date and time transfer was started in UTC. The device SHOULD record this information and report it in this argument, but if this information is not available, the value of this argument MUST be set to the Unknown Time value. - 2.12
⇒ CompleteTime dateTime R The date and time the transfer was fully completed and applied in UTC. This need only be filled in if the transfer has been fully completed and applied. The device SHOULD record this information and report it in this argument, but if this information is not available or the transfer has not completed, the value of this argument MUST be set to the Unknown Time value. - 2.12
⇒ OperationPerformed string R

The operation that was performed against the DU causing the DU state change.

Enumeration of:

  • Install (The operation attempted was the Installation of a DU)
  • Update (The operation attempted was the Update of an existing DU)
  • Uninstall (The operation attempted was the Un-Installation of an existing DU)
 - 2.12
⇒ Fault. object R Fault Structure. If the operation was successful, the FaultCode MUST be zero. Otherwise a non-zero FaultCode is specified along with a FaultString indicating the failure reason. - 2.12
⇒ FaultCode unsignedInt R The numerical fault code. Valid values are: *If the operation was successful, the fault code is 0. *If the device cannot complete the operation for some unknown reason, it SHOULD reject the operation with a 9001 (Request Denied) fault code. *If the device detects the presence of the “userinfo” component in the file source URL, it SHOULD reject the operation with a 9003 (Invalid Arguments) fault code. *If the device cannot find the Execution Environment specified in the Install or Update command, it SHOULD reject the operation with a 9023 (Unknown Execution Environment) fault code. *If the device determines that the Deployment Unit being installed does not match either the Execution Environment specified or any Execution Environment on the device, it SHOULD reject the operation with a 9025 (Deployment Unit to Execution Environment Mismatch) fault code *If the device detects that the Deployment Unit being installed already has the same version as one already installed on the same Execution Environment, it SHOULD reject the operation with a 9026 (Duplicate Deployment Unit) fault code. *If the device detects that that there are no more system resources (disk space, memory, etc.) to perform the Install or Update of a Deployment Unit, it SHOULD reject the operation with a 9027 (System Resources Exceeded) fault code. *If a requested operation attempts to alter the State of a Deployment Unit in a manner that conflicts with the Deployment Unit State Machine Diagram [Appendix I “Software Module Management”/TR-369], it SHOULD reject the operation with a 9029 (Invalid Deployment Unit State) fault code. *If a requested operation attempts to Uninstall a DU that caused an EE to come into existence, where that EE has at least 1 installed DU or at least 1 child EE, then the device SHOULD reject the operation with a 9029 (Invalid Deployment Unit State) fault code. - 2.12
⇒ FaultString string(:256) R A human-readable text description of the fault. This field SHOULD be empty if the FaultCode equals 0 (zero). - 2.12
Device.SoftwareModules.ExecEnv.{i}. object(0:) R

The Execution Environments that are available on the device, along with their properties and configurable settings.

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

Changes in 2.12:

  • Removed {{param: non-existent Reset ::: parameter
  • Removed {{param: non-existent RequestedRunLevel parameter
  • Added SetRunLevel() command
  • Added Reset() command}}}}
 - 2.12
Enable boolean W Indicates whether or not this ExecEnv is enabled. Disabling an enabled Execution Environment stops it, while enabling a disabled Execution Environment starts it. When an Execution Environment is disabled, Deployment Units installed to that Execution Environment will be unaffected, but any Execution Units currently running on that Execution Environment will automatically transition to Idle. If a ChangeDUStatean Update or Uninstall operation is attempted on a DeploymentUnit that is to be applied against a disabled ExecEnv, that ChangeDUState operation fails and the associated DUStateChangeComplete RPCevent will contain a FaultStruct for that operation. If a SetParameterValues is attempted against the {{param: non-existent #.ExecutionUnit.{i}.RequestedState}} for an ExecutionUnit that is associated with aDisabling an Execution Environment could place the device in a non-manageable state. For example, if the operating system itself was modeled as an ExecEnv and a Controller disabled ExecEnv a CWMP Fault will be issued in response. Disabling an Execution Environment could place the device in a non-manageable state. For example, if the operating system itself was modeled as an ExecEnv and the ACS disabled it, the CWMP management agentAgent might be terminated leaving the device unmanageable. - 2.12
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.

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

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.12
Name string(:32) R

A Name provided by the CPEdevice that adequately distinguishes this ExecEnv from all other ExecEnv instances.

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

 - 2.12
InitialRunLevel unsignedInt(:65535) W The run level that this ExecEnv will be in upon startup (whether that is caused by a CPEdevice Boot or the Execution Environment starting). Run levels dictate which Execution Units will be started. Execution Units will be started if CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true. If the value of CurrentRunLevel is -1, then the value of this parameter is irrelevant when read and setting its value has no impact on the Run Level of this ExecEnv. - 2.12
CurrentRunLevel int(-1:65535) R The run level that this ExecEnv is currently operating in. This value is altered by changing the {{param: non-existent RequestedRunLevel}} parameter.executing the SetRunLevel() command. Upon startup (whether that is caused by a CPEdevice Boot or the Execution Environment starting) CurrentRunLevel will be equal to InitialRunLevel, unless Run Levels are not supported by this ExecEnv in which case CurrentRunLevel will be -1. Run levels dictate which Execution Units will be started. Execution Units will be started if CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true. If CurrentRunLevel is -1 then Run Levels are not supported by this ExecEnv and setting InitialRunLevel or {{param: non-existent RequestedRunLevel}}executing the command SetRunLevel() will not impact the Run Level of this ExecEnv. - 2.12
SetRunLevel() command - Provides a mechanism to remotely manipulate the run level of this ExecEnv, meaning that altering this comand will change the value of the CurrentRunLevel. Run levels dictate which Execution Units will be started. Execution Units will be started if CurrentRunLevel is greater than or equal to ExecutionUnit.{i}.RunLevel and ExecutionUnit.{i}.AutoStart is true. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ RequestedRunLevel int(-1:65535) W This parameter will request to change the value of the CurrentRunLevel to the value of this parameter. Setting this value when CurrentRunLevel is -1 has no impact to the Run Level of this instance of the SoftwareModules object. - 2.12
Reset() command - This command causes this ExecEnv to revert back to the state it was in when the device last issued a Boot event with a cause of a local or remote factory reset. The following requirements dictate what MUST happen for the reset to be complete:
  1. All Deployment Units that were installed after the last Boot (with cause of a factory reset) event MUST be removed
  2. All persistent storage, configuration files, and log files that were associated with the removed Deployment Units MUST be removed
  3. Any Deployment Unit that is still installed against the Execution Environment MUST be restored to the version present when the last Boot (with cause of a factory reset) event event was issued
  4. Any Deployment Unit that was present when the last Boot (with cause of a factory reset) eventevent was issued, but was subsequently uninstalled and is now not present, MUST be installed with the version that was present when the last “0 BOOTSTRAP” Inform event was issued
  5. The Execution Environment MUST be restored to the version and configuration present when the last Boot (with cause of a factory reset) eventevent was issued
  6. The Execution Environment MUST be restarted after all other restoration requirements have been met
 - 2.12
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.

Changes in 2.12:

 - 2.12
UUID string(:36) R A Universally Unique Identifier either provided by the ACS,Controller, or generated by the CPE,device, at the time of Deployment Unit Installation. The format of this value is defined by [RFC4122] Version 35 (Name-Based) and {{bibref: non-existent TR-181i2a12}}. This value MUST NOT be altered when the DeploymentUnit is updated. - 2.12
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.

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

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.12
Name string(:64) R Indicates the Name of this DeploymentUnit, which is chosen by the author of the Deployment Unit. The value of this parameter is used in the generation of the UUID based on the rules defined in {{bibref: non-existent TR-069}}. - 2.12
VendorLogList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorLogFile. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor log files that have come into existence because of this DeploymentUnit. This does not include any vendor log files that have come into existence because of ExecutionUnit instances that are contained within this DeploymentUnit. When this DeploymentUnit is uninstalled the vendor log files referenced here SHOULD be removed from the CPE.device. Not all DeploymentUnit instances will actually have a corresponding vendor log file, in which case the value of this parameter will be an empty string. - 2.12
VendorConfigList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorConfigFile. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor config files that have come into existence because of this DeploymentUnit. This does not include any vendor config files that have come into existence because of ExecutionUnit instances that are contained within this DeploymentUnit. When this DeploymentUnit is uninstalled the vendor config files referenced here SHOULD be removed from the CPE.device. Not all DeploymentUnit instances will actually have a corresponding vendor config file, in which case the value of this parameter will be an empty string. - 2.12
Update() command - [ASYNC] Update the associated DeploymentUnit. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ URL string(:256) W The URL, as defined in [RFC3986], that specifies the location of the DU to be installed. The URL MUST NOT include the “userinfo” component, as defined in [RFC3986]. HTTP and HTTPS transports MUST be supported. Other optional transports MAY be supported. If the device receives an Update command with the same source URL as a previous Update or Install comamnd, the device MUST perform each Update as requested, and MUST NOT assume that the content of the file to be downloaded is the same each time. - 2.12
⇒ Username string(:256) W

Username to be used by the device to authenticate with the file server, if authentication is required.

The default value MUST be an empty string.

 - 2.12
⇒ Password string(:256) W

Password to be used by the device to authenticate with the file server, if authentication is required.

The default value MUST be an empty string.

 - 2.12
Uninstall() command - [ASYNC] Uninstall the associated DeploymentUnit. - 2.12
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.12:

  • Removed {{param: non-existent RequestedState ::: parameter
  • Removed {{param: non-existent SupportedDataModelList parameter
  • Added SetRequestedState() command}}}}
 - 2.12
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.

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

Changes in 2.12:

  • Removed string(:64) syntax
 - 2.12
ExecutionFaultMessage string(:256) R If while running or transitioning between states this ExecutionUnit identifies a fault this parameter provides a more detailed explanation of the problem. If ExecutionFaultCode has the value of NoFault then the value of this parameter MUST an empty string and ignored by the ACS.Controller. - 2.12
AutoStart boolean W If true and the RunLevel verification is also met, then this ExecutionUnit will be automatically started by the device after its ExecEnv is either rebooted or restarted. If false this ExecutionUnit will not be started after its ExecEnv is either rebooted or restarted until it is explicitly commanded to do so by either the ACSController or another Execution Unit. - 2.12
References string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a table row, or an empty string. Represents the instances of multi-instanced objects that are directly controlled by, and have come into existence because of, this ExecutionUnit. See [Appendix II.3.2/TR-157a3] for more description and some examples. NOTE: All other objects and parameters (i.e. not multi-instanced objects) that this ExecutionUnit has caused to come into existence can be discovered via the {{object: non-existent .DeviceInfo.SupportedDataModel.{i}.}}GetSupportedDM table.and GetInstances USP messages. - 2.12
VendorLogList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorLogFile. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor log files that have come into existence because of this ExecutionUnit. When the DeploymentUnit (that caused this ExecutionUnit to come into existence) is uninstalled the vendor log files referenced here SHOULD be removed from the CPE.device. Not all ExecutionUnit instances will actually have a corresponding vendor log file, in which case the value of this parameter will be an empty string. - 2.12
VendorConfigList string[] R Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.VendorConfigFile. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the vendor config files that have come into existence because of this ExecutionUnit. When the DeploymentUnit (that caused this ExecutionUnit to come into existence) is uninstalled the vendor config files referenced here SHOULD be removed from the CPE.device. Not all ExecutionUnit instances will actually have a corresponding vendor config file, in which case the value of this parameter will be an empty string. - 2.12
SetRequestedState() command - Set the state transition that the Controller is requesting for this instance of the ExecutionUnit object. {{enum: empty param arg only valid in parameter descriptions}} If this instance of the ExecutionUnit object is associated with an Execution Environment that is disabled and an attempt is made to alter this value, then a error message MUST be generated. - 2.12
⇒ Input. arguments - Input arguments. -
⇒ RequestedState string W

Indicates the requested state to transition this instance of the SoftwareModules object. Enumeration of:

  • Idle (If this SoftwareModules is currently in Starting or Active the device will attempt to Stop the Execution Unit; otherwise this requested state is ignored)
  • Active (If this SoftwareModules is currently in Idle the device will attempt to Start the Execution Unit. If this SoftwareModules is in Stopping the request is rejected and a fault raised. Otherwise this requested state is ignored)
 - 2.12
Device.SoftwareModules.ExecutionUnit.{i}.Extensions. object R This object proposes a general location for vendor extensions specific to this Execution Unit, which allows multiple Execution Units to expose parameters without the concern of conflicting parameter names. These vendor extensions are related to displaying status and maintaining configuration for this Execution Unit. It is also possible for the Execution Unit to expose status and configuration parameters within Service objects or as embedded objects and parameters directly within the root data model, in which case the combination of References and {{param: non-existent #.SupportedDataModelList}}use of GetSupportDM and GetInstances USP messages will be used to determine their locations. See [Appendix II.3.2/TR-157a3] for more description and some examples. - 2.12
Device.ProxiedDevice.{i}. object(0:) R

Each entry in the table is a ProxiedDevice object that is a mount point. Each ProxiedDevice represents distinct hardware Devices. ProxiedDevice objects are virtual and abstracted representation of functionality, that exists on hardware other than that which the Agent is running.

This object is a mount point, under which mountable objects can be mounted.

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

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

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

 - 2.12

Generated by Broadband Forum bbfreport v2.2.0 (2024-07-23 version) on 2024-09-04 at 09:57:39 UTC.
report.py –include ../../install/cwmp –output –transform diff –format markdown tr-181-2-11-0.xml tr-181-2-12-0-usp.xml

Table of Contents