TR-069 Device:2.12 Root Object definition [CWMP] (changes)tr-181-2-12-0-cwmp.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:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The above license is used as a license under copyright only. Please reference the Forum IPR Policy for patent licensing terms https://www.broadband-forum.org/ipr-policy.
Any moral rights which are necessary to exercise under the above license grant are also deemed granted under this license.
Data Types
The Parameters defined in this specification make use of a limited subset of the default SOAP data types [SOAP1.1]. These data types and the named data types used by this specification are described below.
Note: A Parameter that is defined to be one of the named data types is reported as such at the beginning of the Parameter’s description via a reference back to the associated data type definition (e.g. [MACAddress]). However, such parameters still indicate their SOAP data types.
Data Type | Base Type | Description |
---|---|---|
boolean | - | Boolean, where the allowed values are 0 or 1 (or equivalently, true or false). |
dateTime | - | The subset of the ISO 8601 date-time format defined by the SOAP dateTime type [SOAP1.1]. |
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:
|
DiagnosticsState | string | Indicates the availability of diagnostics data. Enumeration of: Enumeration of:
If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with “Invalid Parameter value” (9007) to the ACS instead. |
IPAddress | string(:45) | IP address, i.e. IPv4 address (or IPv4 subnet mask) or IPv6 address. All IPv4 addresses and subnet masks MUST be represented as strings in IPv4 dotted-decimal notation. Here are some examples of valid IPv4 address textual representations:
All IPv6 addresses MUST be represented using any of the 3 standard textual representations defined in [RFC4291] Sections 2.2.1, 2.2.2 and 2.2.3. Both lower-case and upper-case letters can be used, but use of lower-case letters is RECOMMENDED. Here are some examples of valid IPv6 address textual representations:
IPv6 addresses MUST NOT include zone identifiers. Zone identifiers are discussed in [Section 6/RFC4007]. Unspecified or inapplicable addresses (or IPv4 subnet masks) MUST be represented as empty strings unless otherwise specified by the parameter definition. |
IPv4Address | IPAddress(:45) | IPv4 address (or subnet mask). Can be any IPv4 address that is permitted by the IPAddress data type. Possible patterns:
|
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:
|
PSMBreakPointIndexAndLevel | unsignedInt[2:2] |
|
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:
|
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.11ac-2013] | IEEE Std 802.11ac-2013, Enhancements for Very High Throughput for Operation in Bands below 6 GHz, IEEE, December 2013. |
[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. |
[ETSIM2MFA] | ETSI TS 102 690 v1.1.6, Machine-to-Machine Communications (M2M Functional Architecture), ETSI, June 2012. |
[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. |
[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. |
[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. |
[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. |
[SOAP1.1] | Simple Object Access Protocol (SOAP) 1.1, W3C. |
[TR-069] | TR-069 Amendment 6, CPE WAN Management Protocol, Broadband Forum, April 2018. |
[TR-069a4] | TR-069 Amendment 4, CPE WAN Management Protocol, Broadband Forum, July 2011. |
[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-106a6] | TR-106 Amendment 6, Data Model Template for TR-069-Enabled Devices, Broadband Forum, July 2011. |
[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-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. |
Parameter 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:
- Changed name = Device:2.11 ⇒ Device:2.12
Name | Type | Write | Description | Object Default | Version |
---|---|---|---|---|---|
Device. | object | R | The top-level object for a Device. | - | 2.0 |
Device.DeviceInfo. | object | R | This object contains general device information.
Changes in 2.12:
|
- | 2.0 |
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. This parameter MUST always be included in Inform messages. Active Notification MUST always be enabled for this parameter. |
- | 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 |
Device.ManagementServer. | object | R | This object contains parameters relating to the CPE’s association with an ACS.
Changes in 2.12:
|
- | 2.0 |
SupportedConnReqMethods | string[] | R | Comma-separated list of strings. The connection request methods supported by this ManagementServer. Each list item is an enumeration of:
The connection request method as specified in [Section 3.2.2 ACS Connection Initiation/TR-069], REQUIRED Changes in 2.12:
)
|
- | 2.7 |
ConnReqAllowedJabberIDs | string(:256)[:32]() | W | When an XMPP Connection Request is sent to a CPE the XMPP IQ Stanza will contian a “from” address that contains the Jabber ID of the initiating entity. This parameter is a Comma-separated list (up to 32 items) (length ) of strings (maximum number of characters per item 256). Each entry represents a Jabber ID, or address, that is allowed to initiate an XMPP Connection Request. Each Jabber ID is allowed to be either a “Full JID” (containing a local-part, domain-part, and resource-part in the following format: “local-part@domain-part/resource-part”) or a “Bare JID” (containing a local-part and a domain-part in the following format: “local-part@domain-part”). “Full JID” entries require an exact match whereas “Bare JID” entries are a wildcard match and will match any Jabber ID with the same local-part and domain-part independent of the resource-part. For example, if ConnReqAllowedJabberIDs contained “ACS1@tr069.example.com, ACS2@tr-069.example.com/resource1” then the following incoming “from” addresses would be allowed:
Changes in 2.12:
|
- | 2.7 |
LightweightNotificationTriggerInterval | unsignedInt(0:) | W | The duration in seconds of the interval for which the CPE MUST attempt to deliver any pending Passive Lightweight Notifications. A value of 0 means that the trigger interval is effectively disabled. In this case pending Passive Lightweight Notifications are only sent when triggered by an Active Lightweight Notification. | - | 2.12 |
LightweightNotificationTriggerTime | dateTime | W | An absolute time reference in UTC to determine when the CPE will initiate the Lightweight Notification (in the case that there are pending Passive Lightweight Notifications that need to be delivered). Each Passive Lightweight Notification (that is waiting for the Lightweight Notification Trigger mechanism for delivery) MUST occur at this reference time plus or minus an integer multiple of the LightweightNotificationTriggerInterval. LightweightNotificationTriggerTime is used only to set the phase of the Passive Lightweight Notification. The actual value of LightweightNotificationTriggerTime can be arbitrarily far into the past or future. For example, if LightweightNotificationTriggerInterval is 86400 (a day) and if LightweightNotificationTriggerTime is set to UTC midnight on some day (in the past, present, or future) then Lightweight Notifications for pending Passive Lightweight Notifications will occur every day at UTC midnight. These MUST begin on the very next midnight, even if LightweightNotificationTriggerTime 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 CPE MAY locally choose the time reference, and needs only to adhere to the specified LightweightNotificationTriggerInterval. If absolute time is not available to the CPE, its Lightweight Notifications behavior MUST be the same as if the LightweightNotificationTriggerTime parameter was set to the Unknown Time value. | - | 2.12 |
InstanceWildcardsSupported | boolean | R | Indicates whether or not instance wildcards are supported. A true value indicates that the CPE supports instance wildcards for GPV, GPN and GPA RPC calls, as defined in [TR-069a6]. | - | 2.12 |
Device.ManagementServer.EmbeddedDevice.{i}. | object(0:) | R | Each entry in this table represents a distinct Proxied Device that utilizes the Embedded Object Mechanism [Annex J.1.2/TR-069a4] for proxying devices. At most one entry in this table can exist with the same values for both ControllerID and ProxiedDeviceID. |
- | 2.3 |
Host | string[:32]() | R | Comma-separated list (up to 32 items) (length ) of strings. Each list item MUST be the Path Name of a row in the Hosts.Host. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. References the Hosts.Host table entry(s), whether active or inactive, that corresponds to this proxied LAN device.
Changes in 2.12:
|
- | 2.3 |
ProxyProtocol | string | R | The protocol being used to communicate between the CPE Proxier and this Proxied Device. Enumeration of:
Changes in 2.12:
|
- | 2.3 |
Device.ManagementServer.VirtualDevice.{i}. | object(0:) | R | Each entry in this table represents a distinct Proxied Device that utilizes the Virtual CWMP Device Mechanism [Annex I.1.1/TR-069a4] for proxying devices. At most one entry in this table can exist with the same values for all of ManufacturerOUI, ProductClass and SerialNumber. |
- | 2.3 |
Host | string[:32]() | R | Comma-separated list (up to 32 items) (length ) of strings. Each list item MUST be the Path Name of a row in the Hosts.Host. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. References all the Hosts.Host table entries, whether active or inactive, that correspond to this proxied LAN device. There can be multiple such entries if the Proxied Device has more than one network interface.
Changes in 2.12:
|
- | 2.3 |
ProxyProtocol | string | R | The protocol being used to communicate between the CPE Proxier and this Proxied Device. Enumeration of:
Changes in 2.12:
|
- | 2.3 |
Device.ManagementServer.HeartbeatPolicy. | object | R | Parameters related to CPE behavior in order to issue a Heartbeat event to the ACS using the Inform method call. If this object is supported then the CPE MUST support the requirements of [Annex O/TR-069]. | - | 2.12 |
Enable | boolean | W | When true, Heartbeat events are enabled to be sent to the ACS based on the values of the ReportingInterval and InitiationTime parameters. | - | 2.12 |
ReportingInterval | unsignedInt(30:) | W | The duration in seconds of the interval for which the CPE MUST attempt to connect with the ACS and call the Inform method if Enable is true. | - | 2.12 |
InitiationTime | dateTime | W | An absolute time reference in UTC to determine when the CPE will initiate the Heartbeat event Inform method calls. Each Inform call MUST occur at this reference time plus or minus an integer multiple of the ReportingInterval. InitiationTime is used only to set the phase of the Heartbeat event Informs. The actual value of InitiationTime can be arbitrarily far into the past or future. For example, if ReportingInterval is 60 (one minute) and if InitiationTime is set to UTC midnight on some day (in the past, present, or future) then Heartbeat Informs will occur every minute at the next UTC midnight. These MUST begin on the very next midnight, even if InitiationTime 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. The CPE MUST locally choose a random time reference. If absolute time is not available to the CPE, its Heartbeat Inform behavior MUST be the same as if the InitiationTime parameter was set to the Unknown Time value. | - | 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. |
- | 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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.DeviceInfo.TemperatureStatus. | object | R | Status of the temperature of the device. | - | 2.0 |
Device.DeviceInfo.TemperatureStatus.TemperatureSensor.{i}. | object(0:) | R | This object represents information that the device has obtained via sampling an internal temperature sensor. At most one entry in this table can exist with a given value for Name, or with a given value for Alias. |
- | 2.0 |
Reset | boolean | W | When set to true, resets the temperature sensor.
Changes in 2.12:
|
- | 2.0 |
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. |
- | 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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.1 |
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:
|
- | 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:
|
- | 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 |
Device.DeviceInfo.ProxierInfo. | object | R | Represents the associated CPE Proxier for a Proxied Device that utilizes the Virtual CWMP Device Mechanism [Annex J.1.1/TR-069a4]. | - | 2.3 |
ProxyProtocol | string | R | The protocol being used to communicate between the CPE Proxier and this Proxied Device. Enumeration of:
Changes in 2.12:
|
- | 2.3 |
Device.UserInterface. | object | R | This object contains parameters relating to the user interface of the CPE. | - | 2.0 |
PasswordReset | boolean | W | Present only if the CPE provides a password-protected LAN-side user interface and supports LAN-side Auto-Configuration.
When set to true, resets LANConfigSecurity.ConfigPassword to its factory value.
Changes in 2.12:
|
- | 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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
Changes in 2.12:
, DELETED)
Changes in 2.12:
|
- | 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. Active 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. Active 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. Active 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. Active 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. Active 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]. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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]. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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]. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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]. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.DSL.Diagnostics. | object | R | The DSL Diagnostics object. | - | 2.0 |
Device.DSL.Diagnostics.ADSLLineTest. | object | R | This object is to provide diagnostic information for a CPE with an ADSL2 or ADSL2+ modem WAN interface, but MAY also be used for ADSL. | - | 2.0 |
DiagnosticsState | string | W | [DiagnosticsState] Indicates the availability of diagnostics data. Enumeration of: Enumeration of:
If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with “Invalid Parameter value” (9007) to the ACS instead. Enumeration of:
Changes in 2.12:
|
- | 2.0 |
Device.ATM. | object | R | Asynchronous Transfer Mode (ATM) object that contains the Link interface and Diagnostics.F5Loopback diagnostics. | - | 2.0 |
Device.ATM.Link.{i}. | object(0:) | W | ATM link-layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Models an ATM PVC virtual circuit and the ATM Adaption Layer (AAL). An ATM Link entry is typically stacked on top of either a DSL.Channel. or a DSL.BondingGroup. object. When an ATM Link interface is used, a lower-layer DSL.Channel interface MUST be configured with ATM encapsulation (see DSL.Channel.{i}.LinkEncapsulationUsed). At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.ATM.Diagnostics. | object | R | The ATM Diagnostics object. | - | 2.0 |
Device.ATM.Diagnostics.F5Loopback. | object | R | This object provides access to an ATM-layer F5 OAM loopback test. | - | 2.0 |
DiagnosticsState | string | W | [DiagnosticsState] Indicates the availability of diagnostics data. Enumeration of: Enumeration of:
If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with “Invalid Parameter value” (9007) to the ACS instead. Enumeration of:
Changes in 2.12:
|
- | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.Ethernet.Link.{i}. | object(0:) | W | Ethernet link layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Table entries model the Logical Link Control (LLC) layer. It is expected that an Ethernet Link interface can be stacked above any lower-layer interface object capable of carrying Ethernet frames. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for MACAddress. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.Ethernet.VLANTermination.{i}. | object(0:) | W | VLAN Termination table (a stackable interface object as described in [Section 4.2/TR-181i2]). A VLAN Termination entry is typically stacked on top of a Link object to receive and send frames with the configured VLANID. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for MACAddress. |
- | 2.12 |
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:
|
- | 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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. |
- | 2.12 |
Name | string(:64) | R | The textual name of the LAG interface as assigned by the CPE. The Agent MUST choose an initial value that doesn’t conflict with any existing entries. |
- | 2.12 |
LastChange | unsignedInt | R | The accumulated time in seconds since the interface entered its current operational state. Active Notification requests for this parameter MAY be denied. |
- | 2.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. | - | 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. Active 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. Active Notification requests for this parameter MAY be denied. |
- | 2.12 |
PacketsSent | unsignedLong | R | [StatsCounter64] The total number of packets transmitted out of the interface. Active Notification requests for this parameter MAY be denied. |
- | 2.12 |
PacketsReceived | unsignedLong | R | [StatsCounter64] The total number of packets received on the interface. Active 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. Active 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. Active Notification requests for this parameter MAY be denied. |
- | 2.12 |
UnicastPacketsSent | unsignedLong | R | [StatsCounter64] The total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. Active Notification requests for this parameter MAY be denied. |
- | 2.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. Active 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. Active 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. Active 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. Active 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. Active 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. Active 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. Active 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. Active 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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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. |
- | 2.0 |
Reset | boolean | W | When set to true, 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.
The value is not saved in the device’s state and setting it to false has no effect.
Changes in 2.12:
|
- | 2.0 |
Device.HPNA. | object | R | HPNA object that contains the Interface and Diagnostics objects. The HPNA (also known as HomePNA) industry standard [G.9954] defines peer to peer communication for home networking over existing coax cables and telephone wiring within the home. | - | 2.0 |
Device.HPNA.Interface.{i}. | object(0:) | R | HPNA interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of an HPNA interface [G.9954]. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- | 2.0 |
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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.HPNA.Interface.{i}.QoS. | object | R | QoS configuration object. | - | 2.0 |
Device.HPNA.Interface.{i}.QoS.FlowSpec.{i}. | object(0:) | W | Flow specification table. The QoS.Classification table is used to classify ingress traffic, where QoS.Classification.{i}.TrafficClass is one of the classification result outputs. This TrafficClass value can be used to look up the appropriate FlowSpec entry (i.e. the FlowSpec entry whose TrafficClasses list contains a matching traffic class). For enabled table entries, if TrafficClasses is an empty string then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.HPNA.Diagnostics. | object | R | The HPNA Diagnostics object. | - | 2.0 |
Device.HPNA.Diagnostics.PHYThroughput. | object | R | 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.0 |
DiagnosticsState | string | W | [DiagnosticsState] Indicates the availability of diagnostics data. Enumeration of: Enumeration of:
If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with “Invalid Parameter value” (9007) to the ACS instead. Enumeration of:
Changes in 2.12:
|
- | 2.0 |
Device.HPNA.Diagnostics.PerformanceMonitoring. | object | R | 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.0 |
DiagnosticsState | string | W | [DiagnosticsState] Indicates the availability of diagnostics data. Enumeration of: Enumeration of:
If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with “Invalid Parameter value” (9007) to the ACS instead. Enumeration of:
Changes in 2.12:
|
- | 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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
|
- | 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
|
- | 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. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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). Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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). Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.4 |
Device.Ghn.Diagnostics. | object | R | The G.hn Diagnostics object. | - | 2.8 |
Device.Ghn.Diagnostics.PHYThroughput. | object | R | 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.8 |
DiagnosticsState | string | W | [DiagnosticsState] Indicates the availability of diagnostics data. Enumeration of: Enumeration of:
If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with “Invalid Parameter value” (9007) to the ACS instead. Enumeration of:
Changes in 2.12:
|
- | 2.8 |
Device.Ghn.Diagnostics.PerformanceMonitoring. | object | R | 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.8 |
DiagnosticsState | string | W | [DiagnosticsState] Indicates the availability of diagnostics data. Enumeration of: Enumeration of:
If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with “Invalid Parameter value” (9007) to the ACS instead. Enumeration of:
Changes in 2.12:
|
- | 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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
|
- | 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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.UPA.Interface.{i}.ActiveNotch.{i}. | object(0:) | W | This object contains the list of active notches of the UPA interface. A UPA device can have notches in its spectrum, where no power is transmitted in a given part of the spectrum. These notches are typically located in amateur radio bands, to avoid interference. Note: All ActiveNotch entries can be enabled/disabled as a group using the ActiveNotchEnable parameter. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.UPA.Diagnostics. | object | R | The UPA Diagnostics object. | - | 2.0 |
Device.UPA.Diagnostics.InterfaceMeasurement. | object | R | This object 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.0 |
DiagnosticsState | string | W | [DiagnosticsState] Indicates the availability of diagnostics data. Enumeration of: Enumeration of:
If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with “Invalid Parameter value” (9007) to the ACS instead. Enumeration of:
Changes in 2.12:
|
- | 2.0 |
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).
Changes in 2.12:
|
- | 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.0 |
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 |
Reset | boolean | W | 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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
|
- | 2.0 |
ChannelLastChange | unsignedInt | R | The accumulated time in seconds since the current Channel came into use. Active Notification requests for this parameter MAY be denied. |
- | 2.12 |
ChannelLastSelectionReason | string | R | The cause of the last channel selection. Enumeration of:
|
- | 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:
|
- | 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:
|
- | 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:
|
- | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for BSSID. Changes in 2.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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Upstream | boolean | R | Indicates whether the interface points towards the Internet (true) or towards End Devices (false).
For example:
|
- | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for SSIDReference. Changes 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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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]. | - | 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:
|
- | 2.0 |
Device.WiFi.AccessPoint.{i}.AssociatedDevice.{i}. | object(0:) | R | A table of the devices currently associated with the access point. At most one entry in this table can exist with a given value for MACAddress. Changes in 2.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. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for SSIDReference. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.WiFi.EndPoint.{i}.Profile.{i}. | object(0:) | W | EndPoint Profile table. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of SSID, Location and Priority. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
|
- | 2.0 |
Device.WiFi.NeighboringWiFiDiagnostic. | object | R | This object defines access to other WiFi SSIDs that this device is able to receive. | - | 2.7 |
DiagnosticsState | string | W | [DiagnosticsState] Indicates the availability of diagnostics data. Enumeration of: Enumeration of:
If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with “Invalid Parameter value” (9007) to the ACS instead. Enumeration of:
Changes in 2.12:
|
- | 2.7 |
Device.Bridging. | object | R | Layer 2 bridging configuration. Specifies bridges between different layer 2 interfaces. Bridges can be defined to include layer 2 filter criteria to selectively bridge traffic between interfaces. This object can be used to configure both 802.1D [802.1D-2004] and 802.1Q [802.1Q-2011] bridges. Not all 802.1D and 802.1Q features are modeled, and some additional features not present in either 802.1D or 802.1Q are modeled. 802.1Q [802.1Q-2011] bridges incorporate 802.1Q [802.1Q-2005] customer and 802.1ad [802.1ad-2005] provider bridges. | - | 2.0 |
Device.Bridging.Bridge.{i}. | object(0:) | W | Bridge table. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.Bridging.Bridge.{i}.Port.{i}. | object(0:) | W | Bridge Port table, which MUST contain an entry for each bridge port (a stackable interface object as described in [Section 4.2/TR-181i2]). There are two types of bridge ports: management (upward facing) and non-management (downward facing). This is determined by configuring the Boolean ManagementPort parameter. The CPE will automatically configure each management bridge port to appear in the interface stack above all non-management bridge ports that share the same Bridge instance. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
|
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:
|
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:
[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:
|
- | 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:
[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:
|
- | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for VLANID. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.Bridging.Bridge.{i}.VLANPort.{i}. | object(0:) | W | Bridge VLAN egress port and untagged port membership table. This table only applies to an 802.1Q [802.1Q-2011] Bridge. Note: The VLANPort table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated VLANPort row to then violate the table’s unique key constraint; if this occurs, the CPE MUST disable the offending VLANPort row. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both VLAN and Port. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.Bridging.Filter.{i}. | object(0:) | W | Filter table containing classification filter entries, each of which expresses a set of classification criterion to classify ingress frames as member of a Bridge instance or a Bridge.{i}.VLAN instance. Bridge VLAN classification only applies for 802.1Q [802.1Q-2011] Bridges. For enabled table entries, if Bridge or Interface is an empty string then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Several of this object’s parameters specify DHCP option values. Some cases are version neutral (the parameter can apply to both DHCPv4 and DHCPv6), but in other cases the representation of the option is different for DHCPv4 and DHCPv6, so it is necessary to define separate DHCPv4-specific and DHCPv6-specific parameters. Therefore, an instance of this object that uses DHCP option values as filter criteria will be associated with either DHCPv4 or DHCPv6, as indicated by the DHCPType parameter. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.Bridging.ProviderBridge.{i}. | object(0:) | W | Provider Bridge table. A Provider Bridge is described in [Section 5.10 Provider Bridge conformance/802.1Q-2011] as an entity that is comprised of one S-VLAN component and zero or more C-VLAN components. S-VLAN and C-VLAN components are modelled as instances of Bridge objects. When Type is configured with value of PE VLAN tags from the S-VLAN component (outer of 2 VLAN tags) are stacked on top of the VLAN tag from the C-VLAN component (inner of 2 VLAN tags). When Type is configured with value of S-VLAN only VLAN tags from the S-VLAN component are utilized. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. Changes in 2.12:
|
- | 2.7 |
Status | string | R | The status of this ProviderBridge. Enumeration of:
|
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 (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Reset | boolean | W | When set to true, the device MUST tear down the existing PPP connection represented by this object and establish a new one.
The device MUST initiate the reset after completion of the current CWMP session. 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).
Changes in 2.12:
|
false | 2.0 |
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:
|
<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 (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. Changes 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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Reset | boolean | W | When set to true, the device MUST tear down the existing IP connection represented by this object and establish a new one.
The device MUST initiate the reset after completion of the current CWMP session. 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).
Changes in 2.12:
|
false | 2.0 |
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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both IPAddress and SubnetMask. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.IP.Interface.{i}.TWAMPReflector.{i}. | object(0:) | W | This object contains parameters associated with the configuration that permits this interface to be used as Two-Way Active Measurement Protocol (TWAMP) reflector as defined in [TR-390]. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Port. |
- | 2.12 |
Enable | boolean | W | Enables or disables the TWAMP reflector. | - | 2.12 |
Status | string | R | The current operational state of the TWAMP reflector. Enumeration of:
|
- | 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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active 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:
|
- | 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:
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for IPAddress. |
- | 2.2 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Prefix. |
- | 2.2 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.2 |
Device.IP.Diagnostics. | object | R | The IP Diagnostics object. | - | 2.0 |
Device.IP.Diagnostics.IPPing. | object | R | This object provides access to an IP-layer ping test. | - | 2.0 |
DiagnosticsState | string | W | [DiagnosticsState] Indicates the availability of diagnostics data. Enumeration of: Enumeration of:
The CPE can not reach the requested Ping host address Changes in 2.12:
, READONLY)
If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with “Invalid Parameter value” (9007) to the ACS instead. Enumeration of:
The CPE can not reach the requested Ping host address Changes in 2.12:
, READONLY)
Changes in 2.12:
|
- | 2.0 |
Device.IP.Diagnostics.TraceRoute. | object | R | This object defines access to an IP-layer trace-route test for the specified IP interface. | - | 2.0 |
DiagnosticsState | string | W | [DiagnosticsState] Indicates the availability of diagnostics data. Enumeration of: Enumeration of:
The CPE can not reach the requested TraceRoute host address Changes in 2.12:
, READONLY)
If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are Requested and Canceled. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test. When the test is completed, the value of this parameter MUST be either Complete (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Complete, the values of the results parameters for this test are indeterminate. When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code 8 DIAGNOSTICS COMPLETE in the Inform message. After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to None. Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to None. While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to None. While the test is in progress, setting this parameter to Requested (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. While the test is in progress, setting this parameter to Canceled MUST result in the test being canceled and the value of this parameter being set to None. If the CPE does not support the Canceled value, it MUST return a SPV error with “Invalid Parameter value” (9007) to the ACS instead. Enumeration of:
The CPE can not reach the requested TraceRoute host address Changes in 2.12:
, READONLY)
Changes in 2.12:
|
- | 2.0 |
Device.IP.Diagnostics.TraceRoute.RouteHops.{i}. | object(0:) | R | Contains the array of hop results returned. If a route could not be determined, this array will be empty | - | 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 {{param: non-existent #.NumberOfTries}} parameter.. Changes in 2.12:
|
- | 2.0 |
Device.IP.Diagnostics.ServerSelectionDiagnostics. | object | R | This object provides access to a diagnostics test that performs either an ICMP Ping or UDP Echo ping against multiple hosts determining which one has the smallest average response time. There MUST be a ping response to the transmitted ping, or timeout, before the next ping is sent out. | - | 2.9 |
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.
Changes in 2.12:
|
- | 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:
|
- | 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:
|
- | 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 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:
|
- | 2.5 |
Device.GRE. | object | R | This object contains parameters associated with the Generic Routing Encapsulation (GRE) Tunnel ([RFC2784]) with Key and Sequence Number extensions ([RFC2890]). This object also provides a means to treat packets that are encapsulated within a GRE Tunnel by using a set of Filter objects to determine the treatment of the packet. | - | 2.8 |
Device.GRE.Tunnel.{i}. | object(0:) | W | GRE Tunnel table, models the GRE Tunnel instance and represents the entry point and exit point of the tunnel in relation to the WAN interface. A Tunnel object has one or more Interface objects that further define the sessions or flows within the tunnel. At most one entry in this table can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.8 |
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:
|
- | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.8 |
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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Changes in 2.12:
|
- | 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 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:
|
- | 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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active 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:
|
- | 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 | 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 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:
|
- | 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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active 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. The Agent MUST choose an initial value that doesn’t conflict with any existing entries. |
- | 2.12 |
LastChange | unsignedInt | R | The accumulated time in seconds since the interface entered its current operational state. Active Notification requests for this parameter MAY be denied. |
- | 2.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:
|
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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.12 |
Enable | boolean | W | Enables or disables this filter. | false | 2.12 |
Status | string | R | The status of this filter. Enumeration of:
|
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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. |
- | 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.
|
- | 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 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:
|
- | 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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active 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:
|
- | 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 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:
|
- | 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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active 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. The Agent MUST choose an initial value that doesn’t conflict with any existing entries. |
- | 2.12 |
LastChange | unsignedInt | R | The accumulated time in seconds since the interface entered its current operational state. Active Notification requests for this parameter MAY be denied. |
- | 2.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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.12 |
Enable | boolean | W | Enables or disables this filter. | false | 2.12 |
Status | string | R | The status of this filter. Enumeration of:
|
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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. |
- | 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.
|
- | 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):
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both WANInterface and IPv6Prefix. |
- | 2.8 |
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:
|
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:
|
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:
|
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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for IPv6Prefix, or with a given value for IPv4Prefix. 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of DestIPAddress, DestSubnetMask, ForwardingPolicy, GatewayIPAddress, Interface and ForwardingMetric. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of DestIPPrefix, ForwardingPolicy, NextHop, Interface and ForwardingMetric. |
- | 2.2 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.2 |
Device.Routing.RIP. | object | R | Routing Information Protocol (RIP) object. | - | 2.0 |
Device.Routing.RIP.InterfaceSetting.{i}. | object(0:) | W | IP Interface RIP configuration table. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The InterfaceSetting table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated InterfaceSetting row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending InterfaceSetting row. Note: This object only applies to RIP2; i.e. version 2 of the RIP protocol is used to accept or send over the specified Interface. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface. 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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface. |
- | 2.2 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.2 |
Device.RouterAdvertisement. | object | R | The Router Advertisement (RA) object [RFC4861]. This object applies only to IPv6. It contains an InterfaceSetting table that defines the RA configuration for individual IP interfaces. Information received via router advertisement messages is automatically propagated to the relevant IP.Interface sub-objects, e.g. to the IP.Interface.{i}.IPv6Address and IP.Interface.{i}.IPv6Prefix tables. | - | 2.2 |
Device.RouterAdvertisement.InterfaceSetting.{i}. | object(0:) | W | Per-interface Router Advertisement (RA) configuration [RFC4861]. Table entries are created for use in sending Router Advertisements. For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The InterfaceSetting table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated InterfaceSetting row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending InterfaceSetting row. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface. |
- | 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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
|
<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:
|
- | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Tag. |
- | 2.2 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
|
- | 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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.2 |
Device.QoS. | object | R | Queue management configuration object. | - | 2.0 |
Device.QoS.Classification.{i}. | object(0:) | W | Classification table. For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Several of this object’s parameters specify DHCP option values. Some cases are version neutral (the parameter can apply to both DHCPv4 and DHCPv6), but in other cases the representation of the option is different for DHCPv4 and DHCPv6, so it is necessary to define separate DHCPv4-specific and DHCPv6-specific parameters. Therefore, an instance of this object that uses DHCP option values as classification criteria will be associated with either DHCPv4 or DHCPv6, as indicated by the DHCPType parameter. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.QoS.App.{i}. | object(0:) | W | Application table. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.QoS.Flow.{i}. | object(0:) | W | Flow table. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.QoS.Policer.{i}. | object(0:) | W | Policer table. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.QoS.Queue.{i}. | object(0:) | W | Queue table. Each entry is associated with a set of traffic classes, which are specified via the TrafficClasses parameter, and is configured with weight, precedence, drop algorithm, scheduler algorithm etc as appropriate for the traffic classes. An entry can be associated either with all egress interfaces (in which case an actual queue will be instantiated on each egress interface on which traffic of that traffic class can be generated) or else with a single specified egress interface. For enabled table entries, if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both Queue and Interface. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.QoS.Shaper.{i}. | object(0:) | W | Shaper table. Used to shape the queue(s) associated with Interface. In case of a single queue for that interface, determines the egress rate of the queue. In case of multiple queues for that interface (possibly with per queue shaping rates), determines the aggregate egress rate on that interface. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The Shaper table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Shaper row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending Shaper row. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
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. Changes in 2.12:
|
- | 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:
|
- | 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. Active 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for DNSServer. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for DNSServer. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.DNS.Diagnostics. | object | R | The DNS Diagnostics object containing the NSLookupDiagnostics test. | - | 2.0 |
Device.DNS.Diagnostics.NSLookupDiagnostics. | object | R | This object 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.0 |
Device.DNS.Diagnostics.NSLookupDiagnostics.Result.{i}. | object(0:) | R | Results from the most recent invocation of the test, one instance per repetition. | - | 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. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface. |
- | 2.0 |
Status | string | R | The status of this entry. Enumeration of:
Changes in 2.12:
) 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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.NAT.PortMapping.{i}. | object(0:) | W | Port mapping table. This table MUST contain all NAT port mappings associated with this connection, including static and dynamic port mappings programmatically created via local control protocol, such as UPnP. This table MUST NOT contain dynamic NAT binding entries associated with the normal operation of NAT. If the CPE hosts a firewall, it is assumed that it will appropriately configure the firewall for the port mapping. For enabled table entries, if InternalClient is an empty string, or if Interface is not a valid reference and AllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of RemoteHost, ExternalPort and Protocol. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Renew | boolean | W | When set to true, the DHCP client will renew its DHCP lease.
Changes in 2.12:
|
false | 2.0 |
Device.DHCPv4.Client.{i}.SentOption.{i}. | object(0:) | W | Each instance of this object represents a DHCP option that MUST, if enabled, be sent in DHCP client requests. All sent DHCP options MUST be listed. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Tag. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.DHCPv4.Client.{i}.ReqOption.{i}. | object(0:) | W | Each instance of this object represents a DHCP option that MUST, if enabled, be requested in DHCP client requests. All requested DHCP options MUST be listed. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Tag. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.DHCPv4.Server. | object | R | DHCP server configuration. | - | 2.0 |
Device.DHCPv4.Server.Pool.{i}. | object(0:) | W | DHCP conditional serving pool table. Each instance of this object defines a DHCP conditional serving pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCP options, and MAC address. Overlapping pool ranges MUST be supported. For enabled table entries, if Interface is not a valid reference, or MinAddress, MaxAddress, or SubnetMask is not a valid value, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
|
<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:
|
- | 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:
|
- | 2.0 |
Device.DHCPv4.Server.Pool.{i}.StaticAddress.{i}. | object(0:) | W | DHCP static address table. Entries in this table correspond to what [RFC2131] calls “manual allocation”, where a client’s IP address is assigned by the network administrator, and DHCP is used simply to convey the assigned address to the client. Each instance of this object specifies a hardware address (MAC address) and an IP address within the pool. When serving from this pool, this IP address MUST, if available, be assigned to the DHCP client with this hardware address, and MUST NOT be assigned to any other client. Note that it is possible that an IP address in this table is present in one or more of the other conditional serving pools, in which case it is possible that such an address will be assigned to a different client. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Chaddr. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.DHCPv4.Server.Pool.{i}.Option.{i}. | object(0:) | W | This object specifies the DHCP options that MUST, if enabled, be returned to clients whose DHCP requests are associated with this pool. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Tag. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.2 |
Device.DHCPv4.Relay. | object | R | DHCP Relay Agent (conditional relaying). | - | 2.0 |
Device.DHCPv4.Relay.Forwarding.{i}. | object(0:) | W | DHCP Relay Agent Forwarding table. For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Device.DHCPv6. | object | R | The Dynamic Host Configuration Protocol (DHCP) IPv6 object [RFC3315]. This entire object applies to IPv6 only. It contains the Client and Server objects. | - | 2.2 |
Device.DHCPv6.Client.{i}. | object(1:) | W | This object contains DHCPv6 client settings for an associated IP Interface indicated by Interface. For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The Client table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Client row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending Client row. This table MUST contain at least 1 entry. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface. |
- | 2.2 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.2 |
Device.DHCPv6.Client.{i}.SentOption.{i}. | object(0:) | W | The top-level options and option values (including any encapsulated options) that the client will send to the server. This table is intended only for options that are not part of the basic operation of the protocol, and whose values are simple, do not often change and are not modeled elsewhere. For example, it is appropriate for OPTION_USER_CLASS (whose value is a list of user classes) but is not appropriate for OPTION_RECONF_MSG (which is part of the protocol), OPTION_IA_NA (which is modeled via RequestAddresses) or OPTION_RAPID_COMMIT (which is modeled via RapidCommit). At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Tag. |
- | 2.2 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.2 |
Device.DHCPv6.Server. | object | R | DHCPv6 server configuration. | - | 2.2 |
Device.DHCPv6.Server.Pool.{i}. | object(0:) | W | DHCPv6 server pool table. Each instance of this object defines a DHCPv6 server pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCPv6 options, and source address. Overlapping pool ranges MUST be supported. For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack) then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Order. |
- | 2.2 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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:
|
<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:
|
- | 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:
|
<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:
|
- | 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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.2 |
Device.DHCPv6.Server.Pool.{i}.Option.{i}. | object(0:) | W | This object specifies the DHCPv6 options that MUST, if enabled, be offered to clients whose DHCPv6 requests are associated with this pool. If PassthroughClient is specified, and the referenced client has a value for a given option then the PassthroughClient option value will be sent instead of Value. Otherwise, Value will be sent. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Tag. |
- | 2.2 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.2 |
Device.IEEE8021x. | object | R | IEEE 802.1x object [802.1x-2004], where Supplicant models authentication supplicants. | - | 2.0 |
Device.IEEE8021x.Supplicant.{i}. | object(1:) | W | 802.1x supplicant authentication provisioning and status information associated with an interface to be authenticated (e.g. an Ethernet.Link instance). For enabled table entries, if Interface is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. Note: The Supplicant table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated Supplicant row to then violate the table’s unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending Supplicant row. This table MUST contain at least 1 entry. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Interface. |
- | 2.0 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.0 |
Reset | boolean | W | When set to true, 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 MUST initiate the reset after completion of the current CWMP session. The device MAY delay resetting the resource in order to avoid interruption of a user service such as an ongoing voice call.
Changes in 2.12:
|
- | 2.0 |
Disconnect | boolean | W | When set to true, the device MUST disconnect (forced unauthentication) the resource.
The device MUST initiate the disconnect after completion of the current CWMP session. The device MAY delay re-authentication of the resource in order to avoid interruption of a user service such as an ongoing voice call.
Changes in 2.12:
|
- | 2.0 |
Device.SmartCardReaders. | object | R | SmartCardReaders object that contains the SmartCardReader table. | - | 2.0 |
Device.SmartCardReaders.SmartCardReader.{i}. | object(0:) | R | This object describes the characteristics of the smart card reader. At most one entry in this table can exist with a given value for Name, or with a given value for Alias. |
- | 2.0 |
Reset | boolean | W | When set to true, resets the SmartCard Reader and the associated SmartCard.
Changes in 2.12:
|
- | 2.0 |
Device.Firewall. | object | R | Firewall configuration object. The Config parameter enables and disables the Firewall, and can select either a predefined configuration (High or Low) or an explicitly-defined Advanced configuration. For an Advanced configuration, AdvancedLevel controls the currently active Firewall Level, and the Firewall Levels are defined in the Level, Chain and Chain.{i}.Rule tables. 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 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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- | 2.2 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.2 |
Device.Firewall.Chain.{i}.Rule.{i}. | object(0:) | W | Firewall Rule table. Each entry defines a Firewall packet selection rule. The Target parameter defines the action to perform for traffic matching this rule: the packet can be dropped, accepted, rejected or passed to another Chain. This table MUST NOT contain dynamic Firewall rules associated with Stateful Firewall sessions. All entries are created by the creator of the parent Chain, as indicated by its Creator parameter. Rule entries in a Chain with a Creator of Defaults, ACS, UserInterface or (maybe) Other are referred to as Static Rules. Whether or not a Rule in a Chain with Creator Other is regarded as Static is a local matter to the CPE. Some of this object’s parameter descriptions refer to whether a Rule is Static when specifying whether or not the parameter value can be modified. For enabled table entries, if SourceInterface is not a valid reference and SourceAllInterfaces is false, or if DestInterface is not a valid reference and DestAllInterfaces is false, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.2 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 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 |
- | 2.0 |
Device.PeriodicStatistics.SampleSet.{i}. | object(0:) | W | Periodic statistics sample set table. Each sample set has its own sample interval etc. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name. |
- | 2.0 |
ForceSample | boolean | W | When set to true, forces statistics for the current sample to be calculated and updated in the data model. Setting it to false has no effect. When read, this parameter returns false, regardless of the actual value.
If this is the first time that ForceSample has been set to true 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 ForceSample has been set to true 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 ForceSample 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 ForceSample was set to true 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 ForceSample was set to true will be updated one last time at the end of the sample interval.
Changes in 2.12:
|
false | 2.0 |
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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.5 |
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:
|
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:
|
- | 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:
|
- | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for all of Username, Domain and Resource. |
- | 2.7 |
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:
|
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:
|
<Empty> | 2.9 |
EtherType | unsignedInt | W | Classification criterion.
Ether Type Field in a frame.
Changes in 2.12:
|
- | 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:
|
- | 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:
|
- | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- | 2.10 |
ForceReconnect | boolean | W | 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 parameter has no effect.
This action parameter may be used to immediately apply changes in the MQTT connection settings.
Changes in 2.12:
|
- | 2.10 |
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 ForceReconnect has to be set as well.
Changes in 2.12:
|
- | 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 ForceReconnect has to be set as well.
Changes in 2.12:
|
- | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- | 2.10 |
Device.MQTT.Broker.{i}.Bridge.{i}. | object(0:) | W | Configures MQTT bridges, which are used to communicate with other MQTT brokers. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias, or with a given value for Name. On creation of a new table entry, the Agent MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries. |
- | 2.10 |
ForceReconnect | boolean | W | 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 parameter has no effect.
This action parameter may be used to immediately apply changes in the MQTT connection settings.
Changes in 2.12:
|
- | 2.10 |
Device.MQTT.Broker.{i}.Bridge.{i}.Subscription.{i}. | object(0:) | W | List of MQTT subscriptions handled over the bridge. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with the same values for both Topic and Direction. |
- | 2.10 |
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:
|
- | 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:
|
- | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for MeasurementAgent. |
- | 2.12 |
Alias | string(:64) | W | [Alias] A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069] and described in [Appendix II/TR-069], the following mandatory constraints MUST be enforced:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active 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. | - | 2.12 |
DeviceOwnership | string | W | This parameter describes the ownership of the device that hosts the measurement endpoint. Enumeration of:
|
- | 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:
|
- | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Identifier. |
- | 2.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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active 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. | - | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name. |
- | 2.0 |
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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. |
- | 2.0 |
Name | string(:256) | W | Name of the schedule. | - | 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:
|
- | 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:
|
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. Active 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. Active Notification requests for this parameter MAY be denied. |
- | 2.0 |
Suppressions | unsignedLong | R | Number of suppressed executions of this schedule. Active 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. Active 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. Active 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.0 |
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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. |
- | 2.0 |
State | string | R | The current operational state of the Action. Enumeration of:
|
- | 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. Active 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. Active Notification requests for this parameter MAY be denied. |
- | 2.0 |
Suppressions | unsignedLong | R | Number of suppressed executions of this action. Active 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. Active 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. Active 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name. |
- | 2.0 |
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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active 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. | - | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name. |
- | 2.0 |
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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. |
- | 2.0 |
Name | string(:256) | W | Name of the task. | - | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for RegistryEntry. |
- | 2.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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active 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. | - | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name. |
- | 2.0 |
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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active 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. | - | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name. |
- | 2.0 |
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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. |
- | 2.0 |
Name | string(:256) | W | Name of the channel. | - | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. |
- | 2.0 |
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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name. |
- | 2.0 |
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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. |
- | 2.0 |
Name | string(:256) | W | Name of the suppression object. | - | 2.0 |
State | string | R | The current operational state of the MeasurementSuppression. Enumeration of:
|
- | 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:
|
- | 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 (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. At most one enabled entry in this table can exist with a given value for Name. |
- | 2.0 |
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:
The Agent MUST choose an initial value that doesn’t conflict with any existing entries. Active Notification requests for this parameter MAY be denied. |
- | 2.0 |
Name | string(:256) | W | Name of the Event. | - | 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:
|
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.SoftwareModules. | object | R | Top level object for dynamically managed software applications. | - | 2.1 |
Device.SoftwareModules.ExecEnv.{i}. | object(0:) | R | The Execution Environments that are available on the device, along with their properties and configurable settings. At most one entry in this table can exist with a given value for Alias, or with a given value for Name. |
- | 2.1 |
Alias | string(:64) | 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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.1 |
Device.SoftwareModules.DeploymentUnit.{i}. | object(0:) | R | This table serves as the Deployment Unit inventory and contains status information about each Deployment Unit. A new instance of this table gets created during the installation of a Software Module. At most one entry in this table can exist with the same values for all of UUID, Version and ExecutionEnvRef, or with a given value for Alias. |
- | 2.1 |
Alias | string(:64) | 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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.1 |
Device.SoftwareModules.ExecutionUnit.{i}. | object(0:) | R | This table serves as the Execution Unit inventory and contains both status information about each Execution Unit as well as configurable parameters for each Execution Unit. Each DeploymentUnit that is installed can have zero or more Execution Units. Once a Deployment Unit is installed it populates this table with its contained Execution Units. When the Deployment Unit (that caused this ExecutionUnit to come into existence) is updated, this instance MAY be removed and new instances MAY come into existence. While the Deployment Unit (that caused this ExecutionUnit to come into existence) is being updated, all ExecutionUnit instances associated with the Deployment Unit will be stopped until the update is complete at which time they will be restored to the state that they were in before the update started. When the Deployment Unit (that caused this ExecutionUnit to come into existence) is uninstalled, this instance is removed. Each ExecutionUnit MAY also contain a set of vendor specific parameters displaying status and maintaining configuration that reside under the Extensions object. At most one entry in this table can exist with a given value for EUID, or with a given value for Alias. |
- | 2.1 |
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:
Active Notification requests for this parameter MAY be denied. Changes in 2.12:
|
- | 2.1 |
Device.ETSIM2M. | object | R | The ETSIM2M object represents the management object for the Remote Entity Functions (REM) functions defined in the M2M Functional Architecture [ETSIM2MFA]. | - | 2.6 |
Device.ETSIM2M.SCL.{i}. | object(0:) | W | This object represents an instance of a Service Capability Layer (SCL) for a M2M device or gateway. The SCL MAY be maintained by the ACS or by the CPE. When the SCL provides the administration of an SCL that is represented as a SoftwareModules.ExecutionUnit the SCL is maintained in the SoftwareModules.ExecutionUnit.{i}.References parameter. Section 5.1.2 of the M2M Functional Architecture [ETSIM2MFA] describes the high level event flows for SCL registration. Section 9.3.2.6.2 of the M2M Functional Architecture [ETSIM2MFA] describes the creation/registration of SCLs. Section 9.3.2.6.4 of the M2M Functional Architecture [ETSIM2MFA] describes the update/re-registration of SCLs. Section 9.3.2.6.5 of the M2M Functional Architecture [ETSIM2MFA] describes the deletion/deregistration of SCLs. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries. | - | 2.6 |
Device.ETSIM2M.SCL.{i}.Reregistration. | object | R | This object represents the properties and status necessary for a SCL to reregister with one or more NSCLs. | - | 2.6 |
RegTargetNSCLList | string[] | W | Comma-separated list of strings. The list represents a priority ordered set of URIs [RFC3986]. The item that is first in the list has the highest priority.
A list item is a URI [RFC3986] string that represents a NSCL that this SCL instance can use in order to attempt registration.
When modified the contents of this parameter replace the RegTargetNSCLList received during the bootstrap procedure.
Changes in 2.12:
|
- | 2.6 |
Generated by Broadband Forum bbfreport v2.2.0 (2024-07-23 version) on 2024-09-04 at 10:52:06 UTC.
report.py –include ../../install/cwmp –output