Broadband Forum

    DATA MODEL DEFINITION


TR-069 Device:2.7 Root Object definition
tr-181-2-7-0.xml (changes)

License

Copyright (c) 2010-2017, Broadband Forum

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

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

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

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

Summary

TR-069 Device:2.7 Root Object definition

November 2013

Added ZigBee data model, Provider Bridge data model, and various other items

Table of Contents

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

Data Type Base Type Description
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-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
IEEE_EUI64 string(23)

The IEEE EUI 64-bit identifier as defined in [EUI64]. The IEEE defined 64-bit extended unique identifier (EUI-64) is a concatenation of:

  • The 24-bit (OUI-24) or 36-bit (OUI-36) company_id value assigned by the IEEE Registration Authority (IEEE-RA), and
  • The extension identifier (40 bits for OUI-24 or 28 bits for OUI-36) assigned by the organization with that company_id assignment.

Possible patterns:

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

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

  • <Empty> (an empty string)
  • ([0-9A-Fa-f][0-9A-Fa-f]:){5}([0-9A-Fa-f][0-9A-Fa-f])
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.

ZigBeeNetworkAddress string(4)

The ZigBee 16-bit network address (NWK) as defined in [ZigBee2007]. The address is assigned to a device by the network layer and used by the network layer for routing messages between devices. Possible patterns:

  • <Empty> (an empty string)
  • ([0-9A-Fa-f]){4}
base64 -

Base64 encoded binary (no line-length limitation).

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

boolean - Boolean, where the allowed values are 0 or 1 (or equivalently, true or false).
dateTime - The subset of the ISO 8601 date-time format defined by the SOAP dateTime type.
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.

long -

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

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

object - A container for parameters and/or other objects. The full Path Name of a parameter is given by the parameter name appended to the full Path Name of the object it is contained within.
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.

References

[802.11-2012] IEEE Std 802.11-2012, Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications, IEEE, March 2012.
[802.11a-1999] IEEE Std 802.11a-1999, High-speed Physical Layer in the 5 GHz band, IEEE, 1999.
[802.11ac-2013] IEEE Std 802.11ac-2013, IEEE.
[802.11b-1999] IEEE Std 802.11b-1999, Higher Speed Physical Layer Extension in the 2.4 GHz band, IEEE, 1999.
[802.11g-2003] IEEE Std 802.11g-2003, Further Higher Data Rate Extension in the 2.4 GHz Band, IEEE, 2003.
[802.11n-2009] IEEE Std 802.11n-2009, Amendment 5: Enhancements for Higher Throughput, IEEE, 2009.
[802.1ad-2005] IEEE Std 802.1ad-2005, Virtual Bridged Local Area Networks Amendment 4: Provider Bridges, IEEE, May 2005.
[802.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.
[ISO639-1] ISO 639-1, Codes for the representation of names of Languages - Part 1: Alpha-2 code, ISO, 2002.
[ISO646-1991] ISO/IEC 646-1991, Information Technology - ISO 7-bit coded character set for information interchange, ISO, 1991.
[RFC2132] RFC 2132, DHCP Options and BOOTP Vendor Extensions, IETF.
[RFC2863] RFC 2863, The Interfaces Group MIB, IETF, 2000.
[RFC3004] RFC 3004, The User Class Option for DHCP, IETF.
[RFC3315] RFC 3315, Dynamic Host Configuration Protocol for IPv6 (DHCPv6), IETF, 2003.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-181i2] TR-181 Issue 2, Device Data Model for TR-069, Broadband Forum, 2010.
[TR-181i2a5] TR-181 Issue 2 Amendment 5, Device Data Model for TR-069, Broadband Forum, 2012.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

Device:2.7 Data Model (changes)

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 2.7, then it will indicate support for version 2.7. The version number associated with each object and parameter is shown in the Version column.

Name Type Write Description Object Default Version
Device. object - The top-level object for a Device. - 2.0
Device.DeviceInfo. object - This object contains general device information. - 2.0
Device.DeviceInfo.VendorConfigFile.{i}. object -

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
UseForBackupRestore boolean -

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

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

- 2.7
Device.ManagementServer. object - This object contains parameters relating to the CPE's association with an ACS. - 2.0
ManageableDeviceNotificationLimit unsignedInt W The minimum time, in seconds, between Active Notifications resulting from changes to the ManageableDeviceNumberOfEntries (if Active Notification is enabled). - 2.7
SupportedConnReqMethods string -

Comma-separated list of strings. The connection request methods supported by this ManagementServer. Each list item is an enumeration of:

  • HTTP (The connection request method as specified in [Section 3.2.2 ACS Connection Initiation/TR-069], REQUIRED)
  • STUN (The connection request method as specified in [Annex G Connection Request via NAT Gateway/TR-069], OPTIONAL)
  • XMPP (The connection request method as specified in [Annex K XMPP Connection Request/TR-069a5], OPTIONAL)
- 2.7
ConnReqXMPPConnection string W The value MUST be the Path Name of the XMPP.Connection instance that is used for connection requests to this ManagementServer. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.7
ConnReqAllowedJabberIDs string 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) of strings (maximum item length 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:

  • "ACS1@tr069.example.com/resource1"
  • "ACS1@tr069.example.com/resource2"
  • "ACS2@tr069.example.com/resource1"

And the following incoming "from" addresses would not be allowed:

  • "ACS2@tr069.example.com/resource2"
  • "ACS@tr069.example.com/resource"

If this Parameter is an empty string then all Jabber IDs are allowed and an XMPP Connection Request can not be deemed invalid due to the "from" address.

- 2.7
ConnReqJabberID string -

The value MUST be the value of the XMPP.Connection.{i}.JabberID contained in the XMPP.Connection instance referenced by the ConnReqXMPPConnection parameter.

If the ConnReqXMPPConnection parameter is empty or the XMPP.Connection instance being reference is disabled, then this value will be empty.

If the XMPP.Connection instance being referenced by the ConnReqXMPPConnection parameter is lost (XMPP.Connection.{i}.Status parameter changes from Enabled to some other value), then the value of this parameter MUST remain unchanged until the connection can be reestablished and a new XMPP.Connection.{i}.JabberID can be established. If the new XMPP.Connection.{i}.JabberID is identical to the existing value, then the value of this parameter MUST NOT be altered and a VALUE CHANGE event MUST NOT be generated.

- 2.7
HTTPCompressionSupported string -

Comma-separated list of strings. Indicates the HTTP Compression mechanism(s) supported by this CPE. Requirements for the use of HTTP Compression for CWMP can be found in [Section 3.4.7/TR-069a5]. Each list item is an enumeration of:

Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a7] MUST be adhered to.

- 2.7
HTTPCompression string W

The value MUST be a member of the list reported by the HTTPCompressionSupported parameter, or else be Disabled. The value of this parameter represents the HTTP Compression mechanism to be used by the CPE when communicating with the ACS.

The factory default value MUST be Disabled.

- 2.7
LightweightNotificationProtocolsSupported string -

Comma-separated list of strings. Indicates the Lightweight Notification Protocol(s) supported by this CPE. Each list item is an enumeration of:

Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in [Section 3.3/TR-106a7] MUST be adhered to.

- 2.7
LightweightNotificationProtocolsUsed string W

Comma-separated list of strings. Each list item MUST be a member of the list reported by the LightweightNotificationProtocolsSupported parameter, or else be an empty string. The value of this parameter represents the protocol(s) that will be used by the CPE when sending Lightweight Notifications.

An empty string means that Lightweight Notifications are disabled, despite any SetParameterAttributes that have been configured on various parameters.

- 2.7
UDPLightweightNotificationHost string­(256) W

Host name or address to be used when sending the UDP Lightweight Notifications.

UDPLightweightNotificationHost is only applicable when LightweightNotificationProtocolsUsed contains the UDP enumeration.

If UDPLightweightNotificationHost is not implemented or is an empty string, and UDP Lightweight Notifications are supported, the destination host MUST be the same as the ACS (as contained in the host portion of the URL).

- 2.7
UDPLightweightNotificationPort unsignedInt W

The port number to be used when sending UDP Lightweight Notifications.

UDPLightweightNotificationPort is only applicable when LightweightNotificationProtocolsUsed contains the UDP enumeration.

If UDPLightweightNotificationPort is not implemented and UDP Lightweight Notifications are supported, the destination port MUST be 7547.

- 2.7
Device.ManagementServer.StandbyPolicy. object -

Parameters related to CPE behavior when waking up from standby. If this object is supported then the CPE MUST support the requirements of [Annex L/TR-069a5].

NOTE: "CR", as used in the names and descriptions of the parameters defined in this object, refers to the Connection Request concept defined in TR-069.

- 2.7
CRUnawarenessMaxDuration int­[-1:] W

When waking up from a non CR-Aware Standby that lasted more than this parameter's value (in seconds), the CPE MUST issue a WAKEUP Event.

If the value is -1, the CPE MUST NOT ever issue WAKEUP Events for having been non CR-aware.

The factory default value MUST be -1.

- 2.7
MaxMissedPeriodic int­[-1:] W

When waking up from a non fully Timer-Aware Standby that made it miss more than this parameter's value Periodic Contacts, the CPE MUST issue a WAKEUP Event.

If the value is -1, the CPE MUST NOT ever issue WAKEUP Events for exceeding that limit.

The factory default value MUST be -1.

- 2.7
NotifyMissedScheduled boolean W

When waking up from a non fully Timer-Aware Standby that made it miss at least one Scheduled Contact, the CPE MUST issue a WAKEUP Event if this parameter is true.

The factory default value MUST be false.

- 2.7
NetworkAwarenessCapable boolean - Indicates that the CPE is capable of CR-Aware Standby. - 2.7
SelfTimerCapable boolean - Indicates that the CPE is capable of Timer-Aware Standby. - 2.7
CRAwarenessRequested boolean W

If NetworkAwarenessCapable and this parameter are both true, the CPE MUST NOT go into a non CR-Aware Standby state.

The factory default value MUST be false.

- 2.7
PeriodicAwarenessRequested boolean W

If SelfTimerCapable and this parameter are both true, the CPE MUST NOT go into a standby state that prevents it from honoring Periodic Contacts.

The factory default value MUST be false.

- 2.7
ScheduledAwarenessRequested boolean W

If this parameter is true, the CPE MUST NOT go into a standby state that prevents it from honoring Scheduled Contacts. This means that, whenever the ACS has requested a Scheduled Contact:

  • if SelfTimerCapable is true and the CPE chooses to go into Standby before the Scheduled Contact has been honored, it MUST use a Timer-Aware Standby;
  • if SelfTimerCapable is false, the CPE MUST NOT go into Standby before the Scheduled Contact has been honored.
- 2.7
Device.Ethernet. object - 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. - 2.0
Device.Ethernet.Interface.{i}. object -

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
CurrentBitRate unsignedInt -

The current upstream and downstream PHY bit rate on this interface (expressed in Mbps).

A value of 0 indicates that the current bit rate is unknown.

- 2.7
Device.Ethernet.VLANTermination.{i}. object 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
TPID unsignedInt W

The Tag Protocol Identifier (TPID) assigned to this VLANTermination. The TPID is an EtherType value used to identify the frame as a tagged frame.

Standard [Table 9.1/802.1Q-2011] TPID values are:

  • S-TAG 0x88A8 = 34984
  • C-TAG 0x8100 = 33024

Non-Standard TPID values are:

  • S-TAG 0x9100 = 37120
33024 2.7
Device.WiFi. object - 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). - 2.0
Device.WiFi.Radio.{i}. object -

This object models an 802.11 wireless radio on a device (a stackable interface object as described in [Section 4.2/TR-181i2]).

If the device can establish more than one connection simultaneously (e.g. a dual radio device), a separate Radio instance MUST be used for each physical radio of the device. See [Appendix III.1/TR-181i2] for additional information.

Note: A dual-band single-radio device (e.g. an 802.11a/b/g radio) can be configured to operate at 2.4 or 5 GHz frequency bands, but only a single frequency band is used to transmit/receive at a given time. Therefore, a single Radio instance is used even for a dual-band radio.

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

- 2.0
Device.WiFi.Radio.{i}.Stats. object - 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]. - 2.0
PLCPErrorCount unsignedInt - The number of packets that were received with a detected Physical Layer Convergence Protocol (PLCP) header error. - 2.7
FCSErrorCount unsignedInt - The number of packets that were received with a detected FCS error. This parameter is based on dot11FCSErrorCount from [Annex C/802.11-2012]. - 2.7
InvalidMACCount unsignedInt - The number of packets that were received with a detected invalid MAC header error. - 2.7
PacketsOtherReceived unsignedInt - The number of packets that were received, but which were destined for a MAC address that is not associated with this interface. - 2.7
Device.WiFi.NeighboringWiFiDiagnostic. object - This object defines access to other WiFi SSIDs that this device is able to receive. - 2.7
DiagnosticsState string W

Indicates availability of WiFi SSID data. Enumeration of:

If the ACS sets the value of this parameter to Requested, the CPE MUST initiate the WiFi scan.

When writing, the only allowed value is Requested. When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic.

When the test is completed, the value of this parameter MUST be either Completed (if the test completed successfully), or one of the Error values listed above. If the value of this parameter is anything other than Completed, the values of the results parameters for this test are indeterminate.

When the diagnostic initiated by the ACS is completed (successfully or not), 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.

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.

- 2.7
ResultNumberOfEntries unsignedInt - The number of entries in the Result table. - 2.7
Device.WiFi.NeighboringWiFiDiagnostic.Result.{i}. object -

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

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

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

The mode the neighboring WiFi radio is operating in. Enumeration of:

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

The type of encryption the neighboring WiFi SSID advertises. Enumeration of:

- 2.7
EncryptionMode string -

Comma-separated list of strings. The type of encryption the neighboring WiFi SSID advertises. Each list item is an enumeration of:

- 2.7
OperatingFrequencyBand string -

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

- 2.7
SupportedStandards string -

Comma-separated list of strings. List items indicate which IEEE 802.11 standards this Result instance can support simultaneously, in the frequency band specified by OperatingFrequencyBand. Each list item is an enumeration of:

Each value indicates support for the indicated standard.

If OperatingFrequencyBand is set to 2.4GHz, only values b, g, n are allowed.

If OperatingFrequencyBand is set to 5GHz, only values a, n, ac are allowed.

- 2.7
OperatingStandards string -

Comma-separated list of strings. Each list item MUST be a member of the list reported by the SupportedStandards parameter. List items indicate which IEEE 802.11 standard that is detected for this Result.

Each value indicates support for the indicated standard.

If OperatingFrequencyBand is set to 2.4GHz, only values b, g, n are allowed.

If OperatingFrequencyBand is set to 5GHz, only values a, n, ac are allowed.

For example, a value of "g,b" (or "b,g" - order is not important) means that the 802.11g standard [802.11g-2003] is used with a backwards-compatible mode for 802.11b [802.11b-1999]. A value of "g" means that only the 802.11g standard can be used.

- 2.7
OperatingChannelBandwidth string -

Indicates the bandwidth at which the channel is operating. Enumeration of:

- 2.7
BeaconPeriod unsignedInt - Time interval (in ms) between transmitting beacons. - 2.7
Noise int­[-200:0] - Indicator of average noise strength (in dBm) received from the neighboring WiFi radio. - 2.7
BasicDataTransferRates string­(256) - Comma-separated list (maximum list length 256) of strings. Basic data transmit rates (in Mbps) for the SSID. For example, if BasicDataTransferRates is "1,2", this indicates that the SSID is operating with basic rates of 1 Mbps and 2 Mbps. - 2.7
SupportedDataTransferRates string­(256) - Comma-separated list (maximum list length 256) of strings. Data transmit rates (in Mbps) for unicast frames at which the SSID will permit a station to connect. For example, if SupportedDataTransferRates is "1,2,5.5", this indicates that the SSID will only permit connections at 1 Mbps, 2 Mbps and 5.5 Mbps. - 2.7
DTIMPeriod unsignedInt - The number of beacon intervals that elapse between transmission of Beacon frames containing a TIM element whose DTIM count field is 0. This value is transmitted in the DTIM Period field of beacon frames. [802.11-2012] - 2.7
Device.WiFi.SSID.{i}. object W

WiFi SSID table (a stackable interface object as described in [Section 4.2/TR-181i2]), where table entries model the MAC layer. A WiFi SSID entry is typically stacked on top of a Radio object.

WiFi SSID is also a multiplexing layer, i.e. more than one SSID can be stacked above a single Radio.

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

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

- 2.0
Device.WiFi.SSID.{i}.Stats. object - 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]. - 2.0
RetransCount unsignedInt - The total number of transmitted packets which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two. - 2.7
FailedRetransCount unsignedInt - The number of packets that were not transmitted successfully due to the number of retransmission attempts exceeding an 802.11 retry limit. This parameter is based on dot11FailedCount from [802.11-2012]. - 2.7
RetryCount unsignedInt - The number of packets that were successfully transmitted after one or more retransmissions. This parameter is based on dot11RetryCount from [802.11-2012]. - 2.7
MultipleRetryCount unsignedInt - The number of packets that were successfully transmitted after more than one retransmission. This parameter is based on dot11MultipleRetryCount from [802.11-2012]. - 2.7
ACKFailureCount unsignedInt - The number of expected ACKs that were never received. This parameter is based on dot11ACKFailureCount from [802.11-2012]. - 2.7
AggregatedPacketCount unsignedInt - The number of aggregated packets that were transmitted. This applies only to 802.11n and 802.11ac. - 2.7
Device.ZigBee. object - Top level object for ZigBee capabilities based on the [ZigBee2007] specification. - 2.7
InterfaceNumberOfEntries unsignedInt - The number of entries in the Interface table. - 2.7
ZDONumberOfEntries unsignedInt - The number of entries in the ZDO table. - 2.7
Device.ZigBee.Interface.{i}. object -

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

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

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

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

When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

This parameter is based on ifOperStatus from [RFC2863].

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.7
Name string­(64) - The textual name of the interface as assigned by the CPE. - 2.7
LastChange unsignedInt - The accumulated time in seconds since the interface entered its current operational state. - 2.7
LowerLayers string­(1024) W Comma-separated list (maximum list length 1024) of strings. Each list item MUST be the Path Name of an interface object that is stacked immediately below this interface object. If the referenced object is deleted, the corresponding item MUST be removed from the list. See [Section 4.2.1/TR-181i2]. - 2.7
IEEEAddress string­(23) - [IEEE_EUI64] The IEEE address assigned to this interface. A value of "FF:FF:FF:FF:FF:FF:FF:FF" indicates that this address is unknown. This parameter has the same value as the ZigBee.ZDO.{i}.IEEEAddress parameter of the ZDO instance ZDOReference is pointing to. - 2.7
NetworkAddress string­(4) - [ZigBeeNetworkAddress] The ZigBee network address assigned to this interface. This parameter has the same value as the ZigBee.ZDO.{i}.NetworkAddress parameter of the ZDO instance ZDOReference is pointing to. - 2.7
ZDOReference string­(256) - The value MUST be the Path Name of a row in the ZigBee.ZDO table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The ZigBee Device Object assigned to this interface. - 2.7
AssociatedDeviceNumberOfEntries unsignedInt - The number of entries in the AssociatedDevice table. - 2.7
Device.ZigBee.Interface.{i}.Stats. object -

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.7
BytesSent unsignedLong - [StatsCounter64] The total number of bytes transmitted out of the interface, including framing characters. - 2.7
BytesReceived unsignedLong - [StatsCounter64] The total number of bytes received on the interface, including framing characters. - 2.7
PacketsSent unsignedLong - [StatsCounter64] The total number of ZigBee packets sent transmitted out of the interface. - 2.7
PacketsReceived unsignedLong - [StatsCounter64] The total number of ZigBee packets received by the interface. - 2.7
ErrorsSent unsignedInt - [StatsCounter32] The total number of ZigBee packets discarded by interface due to any error. - 2.7
ErrorsReceived unsignedInt - [StatsCounter32] The total number of ZigBee packets received that contained errors preventing them from being delivered to a higher-layer protocol. - 2.7
UnicastPacketsSent unsignedInt - [StatsCounter32] The total number of ZigBee 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. - 2.7
UnicastPacketsReceived unsignedInt - [StatsCounter32] The total number of ZigBee packets received which were not addressed to a multicast or broadcast address at this layer. - 2.7
DiscardPacketsSent unsignedInt - [StatsCounter32] The total number of ZigBee packets requested for transmission which were chosen to be discarded even though no errors had been detected to prevent the ZigBee packets being transmitted. - 2.7
DiscardPacketsReceived unsignedInt - [StatsCounter32] The total number of ZigBee packets received which were chosen to be discarded even though no errors had been detected to prevent their being delivered. - 2.7
MulticastPacketsSent unsignedInt - [StatsCounter32] The total number of ZigBee packets requested for transmission which were addressed to a multicast address at this layer, including those that were discarded or not sent. - 2.7
MulticastPacketsReceived unsignedInt - [StatsCounter32] The total number of ZigBee packets received which were addressed to a multicast address at this layer and delivered by this layer to a higher layer. - 2.7
BroadcastPacketsSent unsignedInt - [StatsCounter32] The total number of ZigBee packets requested for transmission which were addressed to a broadcast address at this layer, including those that were discarded or not sent. - 2.7
BroadcastPacketsReceived unsignedInt - [StatsCounter32] The total number of ZigBee packets received which were addressed to a broadcast address at this layer and delivered by this layer to a higher layer. - 2.7
UnknownPacketsReceived unsignedInt - [StatsCounter32] The total number of ZigBee packets received which were discarded because of an unknown or unsupported protocol. - 2.7
Device.ZigBee.Interface.{i}.AssociatedDevice.{i}. object -

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

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

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

- 2.7
IEEEAddress string­(23) - [IEEE_EUI64] The IEEE address assigned to this device. A value of "FF:FF:FF:FF:FF:FF:FF:FF" indicates that this address is unknown. - 2.7
NetworkAddress string­(4) - [ZigBeeNetworkAddress] The ZigBee network address assigned to this device. - 2.7
Active boolean -

Whether or not this device is currently present in the ZigBee network as defined in [Section 2.4.4.1/ZigBee2007].

The ability to list inactive devices is OPTIONAL. If the CPE includes inactive devices in this table, Active MUST be set to false for each inactive device. The length of time an inactive device remains listed in this table is a local matter to the CPE.

- 2.7
ZDOReference string­(256) - The value MUST be the Path Name of a row in the ZigBee.ZDO table. If the referenced object is deleted, the parameter value MUST be set to an empty string. The ZigBee Device Object assigned to this interface. - 2.7
Device.ZigBee.ZDO.{i}. object -

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

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

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

- 2.7
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.7
IEEEAddress string­(23) - [IEEE_EUI64] The IEEE address assigned to this device. A value of "FF:FF:FF:FF:FF:FF:FF:FF" indicates that this address is unknown. - 2.7
NetworkAddress string­(4) - [ZigBeeNetworkAddress] The ZigBee network address assigned to this device. - 2.7
BindingTableNumberOfEntries unsignedInt - The number of entries in the Binding table. - 2.7
GroupNumberOfEntries unsignedInt - The number of entries in the Group table. - 2.7
ApplicationEndpointNumberOfEntries unsignedInt - The number of entries in the ApplicationEndpoint table. - 2.7
Device.ZigBee.ZDO.{i}.NodeDescriptor. object - The NodeDescriptor object describes the node capabilities of the ZigBee device as defined in [Section 2.3.2.3 Node Descriptor/ZigBee2007]. - 2.7
LogicalType string -

The type of ZigBee device that is extracted from the Logical Type Field as defined in [Table 2.29/ZigBee2007].

  • ZC (ZigBee Coordinator)
  • ZR (ZigBee Router)
  • ZED (ZigBee End Device)
- 2.7
ComplexDescriptorSupported boolean - When true, specifies that the ComplexDescriptor object is supported for this ZigBee device. - 2.7
UserDescriptorSupported boolean - When true, specifies that the UserDescriptor object is supported for this ZigBee device. - 2.7
FrequencyBand string -

Specifies the frequency bands that are supported by the underlying IEEE 802.15.4 radio utilized by the ZigBee device.

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

- 2.7
MACCapability string -

Specifies the IEEE 802.15.4-2003 MAC sub-layer capabilities for this ZigBee device.

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

- 2.7
ManufactureCode unsignedInt­[:65535] - Specifies a manufacturer code that is allocated by the ZigBee Alliance, relating the manufacturer to the device. - 2.7
MaximumBufferSize unsignedInt­[:128] - Specifies the maximum buffer size, in octets, of the network sub-layer data unit (NSDU) for this ZigBee device. - 2.7
MaximumIncomingTransferSize unsignedInt­[:32768] - Specifies the maximum size, in octets, of the application sub-layer data unit (ASDU) that can be transferred to this ZigBee device in one single message transfer. - 2.7
MaximumOutgoingTransferSize unsignedInt­[:32768] - Specifies the maximum size, in octets, of the application sub-layer data unit (ASDU) that can be transferred from this ZigBee device in one single message transfer. - 2.7
ServerMask string -

Specifies the system server capabilities of this ZigBee device.

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

- 2.7
DescriptorCapability string -

Specifies the descriptor capabilities of this ZigBee device.

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

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

Specifies the current sleep/power-saving mode of the ZigBee device.

- 2.7
AvailablePowerSource string -

Specifies the power sources available on this ZigBee device.

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

- 2.7
CurrentPowerSource string -

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

- 2.7
CurrentPowerSourceLevel string -

Specifies the level of charge of the current power source.

  • Critical (Critical battery state)
  • 33 (Battery state is 33 percent)
  • 66 (Battery state is 66 percent)
  • 100 (Battery state is 100 percent)
- 2.7
Device.ZigBee.ZDO.{i}.UserDescriptor. object - The UserDescriptor object is an optional descriptor that describes user defined capabilities of the ZigBee device as defined in [Section 2.3.2.7 User Descriptor/ZigBee2007]. The UserDescriptor object contains information that allows the user to identify the device using a user-friendly character string, such as "Bedroom TV" or "Stairs Light". - 2.7
DescriptorAvailable boolean - When true, the User Descriptor recorded has been received from the target device. - 2.7
Description string­(16) - Specifies the information that allows the user to identify the ZigBee device using a user-friendly character string, such as "Bedroom TV" or "Stairs light". - 2.7
Device.ZigBee.ZDO.{i}.ComplexDescriptor. object - The ComplexDescriptor object is an optional descriptor that describes extended capabilities of the ZigBee device as defined in [Section 2.3.2.6 Complex Descriptor/ZigBee2007]. - 2.7
DescriptorAvailable boolean - When true, the Complex Descriptor recorded has been received from the target device. - 2.7
Language string - Specifies the ISO 639-1 language code as defined in [ISO639-1]. - 2.7
CharacterSet string - Specifies the ISO 646 character set as defined in [ISO646-1991]. - 2.7
ManufacturerName string - Specifies the name of the manufacturer of the ZigBee device. - 2.7
ModelName string - Specifies the name of the manufacturer's model of the ZigBee device. - 2.7
SerialNumber string - Specifies the manufacturer's serial number of the ZigBee device. - 2.7
DeviceURL string - Specifies the URL through which more information relating to the ZigBee device can be obtained. - 2.7
Icon hexBinary­(65535) - The icon field contains an octet string which carries the data for an icon that can represent the ZigBee device. The format of the icon MUST be a 32-by-32-pixel PNG image. - 2.7
IconURL string - Specifies the URL through which the icon for the ZigBee device can be obtained. - 2.7
Device.ZigBee.ZDO.{i}.Security. object - The Security object provides the configuration capabilities needed to perform the Security Management functionality defined in [Section 4 Security Management/ZigBee2007]. - 2.7
TrustCenterAddress string­(23) - [IEEE_EUI64] Specifies the IEEE address of a special device trusted by devices within a ZigBee network to distribute keys for the purpose of network and end-to-end application configuration management. - 2.7
SecurityLevel string -

Specifies how an outgoing frame is to be secured, how an incoming frame purportedly has been secured; it also indicates whether or not the payload is encrypted and to what extent data authenticity over the frame is provided, as reflected by the length of the message integrity code (MIC).

- 2.7
TimeOutPeriod unsignedInt­[:65535] - The period of time, in milliseconds, that this ZigBee device will wait for an expected security protocol frame. - 2.7
Device.ZigBee.ZDO.{i}.Network. object - The Network object provides the configuration capabilities needed to by a ZigBee Device to operate within a ZigBee Area Network as defined in [Section 2.5.2.4 Network Manager/ZigBee2007]. - 2.7
NeighborNumberOfEntries unsignedInt - The number of entries in the Neighbor table. - 2.7
Device.ZigBee.ZDO.{i}.Network.Neighbor.{i}. object -

The Neighbor object provides the configuration capabilities needed to by a ZigBee Device to operate within a ZigBee Area Network as defined in [Section 2.5.2.4 Network Manager/ZigBee2007].

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

- 2.7
Neighbor string - The value MUST be the Path Name of a row in the ZigBee.ZDO table. If the referenced object is deleted, the parameter value MUST be set to an empty string. Neighbor of this ZigBee device. The value MUST be the path name of a row in the ZigBee.ZDO table. If the referenced row is deleted then this entry MUST be deleted. - 2.7
LQI unsignedInt­[:255] - The LQI field specified link quality identification (LQI) for neighbor ZigBee device. - 2.7
Relationship string -

The relationship between the neighbor and this device.Enumeration of:

- 2.7
PermitJoin string -

An indication of whether the neighbor device is accepting join requests.Enumeration of:

- 2.7
Depth unsignedInt - The tree depth of the neighbor device. A value of 0x00 indicates that the device is the ZigBee coordinator for the network. - 2.7
Device.ZigBee.ZDO.{i}.NodeManager. object - The NodeManager object describes the configuration capabilities related for remote management of the ZigBee Area Network as defined in [Section 2.5.2.6 Node Manager/ZigBee2007]. - 2.7
RoutingTableNumberOfEntries unsignedInt - The number of entries in the RoutingTable table. - 2.7
Device.ZigBee.ZDO.{i}.NodeManager.RoutingTable.{i}. object -

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

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

- 2.7
DestinationAddress string­(4) -

The ZigBee network address of this route. Possible patterns:

- 2.7
NextHopAddress string­(4) - [ZigBeeNetworkAddress] Specifies the network address of the next hop ZigBee device on the way to the destination ZigBee device. - 2.7
Status string -

The status of the route entry. Enumeration of:

- 2.7
MemoryConstrained boolean - A flag indicating whether the device is a memory constrained concentrator. - 2.7
ManyToOne boolean - A flag indicating that the destination is a concentrator that issued a many to-one request. - 2.7
RouteRecordRequired boolean - A flag indicating that a route record command frame should be sent to the destination prior to the next data packet. - 2.7
Device.ZigBee.ZDO.{i}.Binding.{i}. object W

The Binding object describes the configuration capabilities related to maintaining a ZigBee Device's Binding Table as defined in [Section 2.2.8.2 Binding/ZigBee2007].

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

- 2.7
Enable boolean W Enables or disables the use of this binding on the device. - 2.7
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.

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.7
SourceEndpoint unsignedInt­[:240] W Specifies the source endpoint used in this binding entry. - 2.7
SourceAddress string­(23) W [IEEE_EUI64] Specifies the source address used in this binding entry. - 2.7
ClusterId unsignedInt­[:65535] W Specifies the cluster identifier used in this binding entry. - 2.7
DestinationAddressMode string W

Specifies the type of destination address used for this binding entry. Enumeration of:

- 2.7
DestinationEndpoint unsignedInt­[:240] W Specifies the destination endpoint for the binding entry. The value of this field is valid when the value of the DestinationAddressMode is Endpoint. - 2.7
IEEEDestinationAddress string­(23) W [IEEE_EUI64] Specifies the IEEE destination address for this binding entry. The value of this field is valid when the value of the DestinationAddressMode is Endpoint. - 2.7
GroupDestinationAddress string­(4) W [ZigBeeNetworkAddress] Specifies the group destination address for this binding entry. The value of this field is valid when the value of the DestinationAddressMode is Group. - 2.7
Device.ZigBee.ZDO.{i}.Group.{i}. object W

The Group object describes the configuration capabilities related to maintaining a ZigBee Device's Group Table as defined in [Section 2.5.2.7 Group Manager/ZigBee2007].

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

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

- 2.7
Enable boolean W Enables or disables the use of this group on the device. - 2.7
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.

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.7
GroupId string­(4) W [ZigBeeNetworkAddress] The Group Identifier for this object as defined in [Table 2.25 Group Table Entry Format/ZigBee2007]. - 2.7
EndpointList string W Comma-separated list of strings (maximum item length 256). Each list item MUST be the Path Name of a row in the ZigBee.ZDO.{i}.ApplicationEndpoint table. If the referenced object is deleted, the corresponding item MUST be removed from the list. The list of application endpoints assigned as a member of this Group object. - 2.7
Device.ZigBee.ZDO.{i}.ApplicationEndpoint.{i}. object W

The ApplicationEndpoint object describes the application endpoint as defined in [Section 2.1.2 Application Framework/ZigBee2007].

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

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

- 2.7
Enable boolean W Enables or disables the use of this application endpoint on the device. - 2.7
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.

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.7
EndpointId unsignedInt­[:240] W

The Endpoint Identifier for this object as defined in [Section 2.1.2 Application Framework/ZigBee2007].

An ApplicationEndpoint with an EndpointId value of 0 is designated as the device application: This is a special application that is responsible for device operation and contains logic to manage the device's networking and general maintenance features.

- 2.7
Device.ZigBee.ZDO.{i}.ApplicationEndpoint.{i}.SimpleDescriptor. object - The SimpleDescriptor object contains the attributes of the Simple Descriptor of an application endpoint, as defined in [Section 2.3.2.5 Simple Descriptor/ZigBee2007]. - 2.7
ProfileId unsignedInt­[:65535] W Specifies the application profile that is supported on this endpoint. Application profiles are agreements for messages, message formats, andprocessing actions that enable developers to create an interoperable, distributed application employing application entities that reside on separate ZigBee devices. These application profiles enable applications to send commands, request data, and process commands and requests as defined in [Section 2.1.2.1 Application Profiles/ZigBee2007]. - 2.7
DeviceId unsignedInt­[:65535] - Application device identifier, as defined in [Section 2.3.2.5.3 Application Device Identifier Field/ZigBee2007]. - 2.7
DeviceVersion unsignedInt­[:15] - Application device version, as defined in [Section 2.3.2.5.4 Application Device Version Field/ZigBee2007]. - 2.7
InputClusterList string W Comma-separated list of unsigned integers (value 0 to 65535). Specifies the input cluster identifiers to be matched by the ZigBee coordinator by remote Zigbee device's output cluster list for this SimpleDescriptor object. - 2.7
OutputClusterList string W Comma-separated list of unsigned integers (value 0 to 65535). Specifies the output cluster identifiers to be matched by the ZigBee coordinator by remote Zigbee device's input cluster list for this SimpleDescriptor object. - 2.7
Device.ZigBee.Discovery. object - This object is used for managing the discovery of ZigBee devices within a ZigBee Area Network. ZigBee Devices are discovered via the ZDO instance associated with the ZigBee Coordinator of an Area Network. - 2.7
AreaNetworkNumberOfEntries unsignedInt - The number of entries in the AreaNetwork table. - 2.7
Device.ZigBee.Discovery.AreaNetwork.{i}. object W

This object specifies the ZigBee devices that are discovered by the Coordinator.

As the ZigBee specification does not provide a discovery protocol between the CWMP proxy and the ZigBee coordinator, the AreaNetwork object is provisioned and not discovered.

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

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

- 2.7
Enable boolean W Enables or disables discovery of the ZigBee devices in this AreaNetwork. - 2.7
LastUpdate dateTime - The date and time when this AreaNetwork or its member devices (i.e., the devices with ZDOs listed in ZDOList) were updated due to a discovery operation. - 2.7
Status string -

The status of the current discovery operation.

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.7
Coordinator string­(256) W The Fully Qualified Domain Name (FQDN) or IP address of the ZigBee Coordinator. The coordinator MAY be located within the CPE. In this scenario the ACS or CPE MAY use the value of "localhost". - 2.7
ZDOReference string­(256) -

The ZDO object for this device that is used to discover the ZigBee capabilities of attached devices.

The value MUST be the Path Name of a row in the ZigBee.ZDO table. If the referenced object is deleted, the parameter value MUST be set to an empty string.

- 2.7
ZDOList string -

Comma-separated list of strings (maximum item length 256). The list of ZDO objects discovered in this Area Network by the ZigBee Coordinator.

Each list item MUST be the Path Name of a row in the ZigBee.ZDO table. If the referenced object is deleted, the corresponding item MUST be removed from the list.

- 2.7
Device.Bridging. object -

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
MaxProviderBridgeEntries unsignedInt - The maximum number of entries available in the Bridging.ProviderBridge table. A non-zero value for this parameter implies support for 802.1Q Provider Bridges. - 2.7
ProviderBridgeNumberOfEntries unsignedInt - The number of entries in the ProviderBridge table. - 2.7
Device.Bridging.Bridge.{i}. object W

Bridge table.

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

- 2.0
Device.Bridging.Bridge.{i}.Port.{i}. object 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
Type string W

The type of bridge port as defined in 802.1Q [Section 17 IEEE8021BridgePortType/802.1Q-2011].

Enumeration of:

- 2.7
TPID unsignedInt W

The Tag Protocol Identifier (TPID) assigned to this Port. The TPID is an EtherType value used to identify the frame as a tagged frame.

Standard [Table 9.1/802.1Q-2011] TPID values are:

  • S-TAG 0x88A8 = 34984
  • C-TAG 0x8100 = 33024

Non-Standard TPID values are:

  • S-TAG 0x9100 = 37120
33024 2.7
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 Bridging.ProviderBridge.{i}.SVLANComponent.

false 2.7
ServiceAccessPriorityTranslation string W

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

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

"0,1,2,3,4,5,6,7" 2.7
Device.Bridging.Bridge.{i}.Port.{i}.PriorityCodePoint. object -

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

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

- 2.7
PCPSelection unsignedInt­[1:4] W This parameter identifies the row in the PCPEncoding and PCPDecoding parameter lists. The value of 1 points to the 8P0D row in the corresponding parameter lists. 1 2.7
UseDEI boolean W This parameter controls the processing of the drop_eligible field and is described in [Section 6.9.3/802.1Q-2011]. false 2.7
RequireDropEncoding boolean W This parameter controls the processing of the encoding or decoding of the drop_eligible component in the PCP field and is described in [Section 8.6.7/802.1Q-2011]. false 2.7
PCPEncoding string W

Comma-separated list (4 items) of strings (item 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:

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

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

[7,7,6,6,5,5,4,4,3,3,2,2,1,1,0,0],[7,7,6,6,5,4,5,4,3,3,2,2,1,1,0,0],[7,7,6,6,5,4,5,4,3,2,3,2,1,1,0,0],[7,7,6,6,5,4,5,4,3,2,3,2,1,0,1,0]
- 2.7
PCPDecoding string W

Comma-separated list (4 items) of strings (item 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:

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

[7,0,6,0,5,0,4,0,3,0,2,0,1,0,0,0],[7,0,6,0,4,0,4,1,3,0,2,0,1,0,0,0],[7,0,6,0,4,0,4,1,2,0,2,1,1,0,0,0],[7,0,6,0,4,0,4,1,2,0,2,1,0,0,0,1]
- 2.7
Device.Bridging.ProviderBridge.{i}. object W

Provider Bridge table.

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

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

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

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

- 2.7
Enable boolean W Enables or disables this ProviderBridge. false 2.7
Status string -

The status of this ProviderBridge. Enumeration of:

The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. For example when the Type is configured with value of PE but CVLANComponents is an empty string.

The Error value MAY be used by the CPE to indicate a locally defined error condition.

"Disabled" 2.7
Alias string­(64) W A non-volatile handle used to reference this instance. This parameter 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. - 2.7
Type string W

Selects the standard supported by this ProviderBridge table entry. Enumeration of:

  • S-VLAN (Provider Bridge conforming to [Section 5.10.1 S-VLAN Bridge conformance/802.1Q-2011])
  • PE (Provider Bridge conforming to [Section 5.10.2 Provider Edge Bridge conformance/802.1Q-2011])
- 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 W Comma-separated list of strings (maximum item length 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.IP. object - IP object that contains the Interface, ActivePort, and Diagnostics objects. - 2.0
Device.IP.Diagnostics. object - The IP Diagnostics object. - 2.0
Device.IP.Diagnostics.IPPing. object - This object provides access to an IP-layer ping test. - 2.0
AverageResponseTimeDetailed unsignedInt - Result parameter indicating the average response time in microseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 2.7
MinimumResponseTimeDetailed unsignedInt - Result parameter indicating the minimum response time in microseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 2.7
MaximumResponseTimeDetailed unsignedInt - Result parameter indicating the maximum response time in microseconds over all repetitions with successful responses of the most recent ping test. If there were no successful responses, this value MUST be zero. - 2.7
Device.QoS. object - Queue management configuration object. - 2.0
DefaultInnerEthernetPriorityMark int­[-2:] W

Ethernet priority code (as defined in [802.1Q-2011]) to mark traffic of the inner VLAN Tag as defined in 802.1Q, when the PDU is not associated with any specified classifier. This parameter is only applicable when the PDU has 2 VLAN Tags.

A value of -1 indicates no change from the incoming packet.

A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in [Annex A/TR-181i2].

- 2.7
Device.QoS.Classification.{i}. object 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
InnerEthernetPriorityCheck int­[-1:] W

Classification criterion.

Current Ethernet priority of the inner VLAN Tag as defined in 802.1Q. This parameter is only applicable when the PDU has 2 VLAN Tags. A value of -1 indicates this criterion is not used for classification.

-1 2.7
InnerEthernetPriorityExclude boolean W

If false, the class includes only those packets that match the InnerEthernetPriorityCheck entry, if specified.

If true, the class includes all packets except those that match the InnerEthernetPriorityCheck entry, if specified.

false 2.7
InnerEthernetPriorityMark int­[-2:] W

Classification result.

Ethernet priority code to mark traffic with that falls into this classification entry associated with the InnerEthernetPriorityCheck.

A value of -1 indicates no change from the incoming packet.

A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in [Annex A/TR-181i2].

-1 2.7
EthernetDEICheck int­[-1:] W

Classification criterion.

Current Ethernet Drop eligible Indication (DEI) of the VLAN tag as defined in 802.1Q. If 2 VLAN Tags are present, then this parameter represents the outer VLAN tag. A value of -1 indicates this criterion is not used for classification.

-1 2.7
EthernetDEIExclude boolean W

If false, the class includes only those packets that match the EthernetDEICheck entry, if specified.

If true, the class includes all packets except those that match the EthernetDEICheck entry, if specified.

false 2.7
Device.QoS.App.{i}. object 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
DefaultInnerEthernetPriorityMark int­[-2:] W

Ethernet priority code (as defined in [802.1Q-2011]) to mark the inner VLAN Tags as defined in 802.1Q with this App table entry where the packet is not associated with any specified flow. This parameter is only applicable when the PDU has 2 VLAN Tags.

A value of -1 indicates no change from the incoming packet.

A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in [Annex A/TR-181i2].

- 2.7
Device.QoS.Flow.{i}. object 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
InnerEthernetPriorityMark int­[-2:] W

Ethernet priority code (as defined in [802.1Q-2011]) to mark the inner VLAN Tags with for traffic that falls into this flow.

A value of -1 indicates no change from the incoming packet.

A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in [Annex A/TR-181i2].

-1 2.7
Device.XMPP. object - The XMPP represents the XMPP capabilities of the device as described in [Appendix III/TR-069a5]. - 2.7
ConnectionNumberOfEntries unsignedInt - The number of entries in the Connection table. - 2.7
Device.XMPP.Connection.{i}. object 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 all the same values for Username, Domain and Resource.

- 2.7
Enable boolean W

Enables or disables this Connection.

This parameter is based on ifAdminStatus from [RFC2863].

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.7
Username string­(256) W The proposed local-part of the Jabber ID of this Connection, and the value to be used to authenticate this Connection when making a connection to the Server using the procedure outlined in [Section 6/RFC6120]. - 2.7
Password string­(256) W

Password used to authenticate this Connection when making a connection to the Server using the procedure outlined in [Section 6/RFC6120].

Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If an ACS modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset.

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

- 2.7
Domain string­(64) W The proposed domain-part of the Jabber ID of this Connection. - 2.7
Resource string­(64) W The proposed resource-part of the Jabber ID of this Connection. - 2.7
JabberID string - The complete Jabber ID as determined by the first-hop XMPP server at time of connection establishment. This Jabber ID will usually be the standard concatentation of the local-part (Username), domain-part (Domain), and resource-part (Resource) as defined in [Section 2.1/RFC6120] (local-part@domain-part/resource-part), but since the Jabber ID is owned by the first-hop XMPP Server there are cases where the value will be different. - 2.7
Status string -

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

When Enable is false then Status SHOULD normally be Disabled or Error if there is a fault condition on the interface).

When Enable is changed to true then Status SHOULD change to Enabled if and only if the interface is able to transmit and receive PDUs; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Enabled if still operable when the expected actions have completed); it SHOULD change to Unknown if the state of the interface can not be determined for some reason.

- 2.7
LastChangeDate dateTime - The date and time at which this Connection entered into its current operational state. - 2.7
ServerConnectAlgorithm string W

The algorithm the Connection uses when connecting with the associated lists of servers. Enumeration of:

  • DNS-SRV (Use the connection algorithm as specified in [Section 3.2/RFC6120] where the value of the Domain parameter is used to look up the server address and port to use)
  • ServerTable (Use the instances of the Server table based on the values of the Server.{i}.Priority and Server.{i}.Weight parameters as the basis for reconnect. Instances must be reachable and reachable instances with the lowest value MUST be preferred)
"DNS-SRV" 2.7
KeepAliveInterval long­[-1:] W

The number of seconds that keep alive events as specified in [Section 4.6.1/RFC6120] are sent by this Connection.

A value of 0 disables the keep alive functionality. A value of -1 indicates that the keep alive interval is a vendor specific implementation.

[Section 4.6.4/RFC6120] recommends not checking more frequently than every 5 minutes (or 300 seconds).

-1 2.7
ServerConnectAttempts unsignedInt W

The number of times that this Connection attempts to connect to a given IP address before moving on to the current server's next IP address, or to the next server if the current server has no more IP addresses.

If ServerConnectAttempts, ServerRetryInitialInterval, ServerRetryIntervalMultiplier and ServerRetryMaxInterval all have their default values, the maximum reconnection wait intervals, in minutes, will be {1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 512, 512, 512, 512, 512}. After the initial attempt there are 15 further attempts, making a total of 16. The maximum reconnection wait interval is reached on the 10th retry, i.e. the 11th attempt.

NOTE: If this Connection fails to connect to any of the servers' IP addresses, fallback behavior SHOULD be as specified in [Section 3.2/RFC6120].

NOTE: If the value of this parameter is 0, server connection and reconnection behavior is implementation-dependent.

16 2.7
ServerRetryInitialInterval unsignedInt­[1:65535] W

The maximum first reconnection wait interval, in seconds, as specified in [Annex K XMPP Connection Request/TR-069a5].

The Device MUST use a random value between 0 and ServerRetryInitialInterval as the first reconnection wait interval.

NOTE: If the value of the ServerConnectAttempts parameter is 0, the value of this parameter is ignored.

60 2.7
ServerRetryIntervalMultiplier unsignedInt­[1000:65535] W

The reconnection interval multiplier as specified in [Annex K XMPP Connection Request/TR-069a5]. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535.

For the nth reconnection wait interval, the Device MUST use a random value, in seconds, between 0 and ServerRetryInitialInterval * (ServerRetryIntervalMultiplier / 1000) ** (n - 1).

NOTE: If the value of the ServerConnectAttempts parameter is 0, the value of this parameter is ignored.

2000 2.7
ServerRetryMaxInterval unsignedInt­[1:] W

The maximum reconnection wait interval, in seconds.

If the nth reconnection wait interval calculated from ServerRetryInitialInterval and ServerRetryIntervalMultiplier exceeds the value of this parameter, then the Device MUST use the value of this parameter as the next reconnection wait interval.

NOTE: If the value of the ServerConnectAttempts parameter is 0, the value of this parameter is ignored.

30720 2.7
UseTLS boolean W

This parameter allows an ACS to configure whether or not this XMPP Connection is required to use TLS independent of whether or not the XMPP Server that is being connected to is configured for TLS "mandatory-to-negotiate".

If the value of UseTLS is true then the CPE will initiate TLS negotiation if not required to by the XMPP Server.

If the value of UseTLS is false then the CPE will not initiate TLS negotiation if not required to by the XMPP Server.

false 2.7
TLSEstablished boolean -

This parameter represents the TLS state of this XMPP Connection.

If this XMPP Connection is established and is secured by TLS then the value of this parameter is true.

If this XMPP Connection is either not established or established but not secured by TLS then the value of this parameter is false.

- 2.7
ServerNumberOfEntries unsignedInt - The number of entries in the Server table. - 2.7
Device.XMPP.Connection.{i}.Server.{i}. object W

The Server represents an XMPP server to be used for a Connection.

This table is only relevant when Connection.{i}.ServerConnectAlgorithm is set to ServerTable. If Connection.{i}.ServerConnectAlgorithm is set to DNS-SRV then any instances of this table are ignored by this Connection.

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

At most one enabled entry in this table can exist with the same values for ServerAddress and Port.

- 2.7
Enable boolean W

Enables or disables this Server.

This parameter is based on ifAdminStatus from [RFC2863].

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.7
Priority unsignedInt­[0:65535] W The priority of this Server that is used by the Connection when determining the Server to connect. The Connection MUST contact the Server with the lowest-numbered priority that the Connection can reach as defined in [RFC2782]. The selection of Servers with the same Priority value utilizes the Weight parameter to determine which Server is selected by the Connection. - 2.7
Weight long­[-1:65535] W This parameter specifies a relative weight for entries with the same Priority. The mechanism is defined in [RFC2782]. A value of -1 indicates that the implementation of this parameter is specific to the Vendor. - 2.7
ServerAddress string­(256) W

Fully Qualified Domain Name (FQDN) or IP address of the XMPP server for this Connection.

If the value of this Parameter is a FQDN that resolves to multiple addresses then each address SHOULD be attemtped (in an implemnetation-specific order) until a connection can be made or all addresses are exhausted, in which case the next Server instance (based on Priority and Weight) SHOULD be used.

- 2.7
Port unsignedInt­[0:65535] W Port number of the XMPP server for this Connection. 5222 2.7
Device.XMPP.Connection.{i}.Stats. object - XMPP Connection statistics information for this resource. - 2.7
ReceivedMessages unsignedInt - The number of XMPP stanzas (iq, presence, or message) that have been received on this Connection. 0 2.7
TransmittedMessages unsignedInt - The number of XMPP stanzas (iq, presence, or message) that have been transmitted by this Connection. 0 2.7
ReceivedErrorMessages unsignedInt - The number of XMPP stanzas (iq, presence, or message) that have been received on this Connection where the type attribute had a value of "error". 0 2.7
TransmittedErrorMessages unsignedInt - The number of XMPP stanzas (iq, presence, or message) that have been transmitted by this Connection where the type attribute had a value of "error". 0 2.7

Inform and Notification Requirements

Forced Inform Parameters

Parameter

Forced Active Notification Parameters

Parameter

Default Active Notification Parameters

Parameter
Device.ManagementServer.ConnReqJabberID
Device.ZigBee.Interface.{i}.IEEEAddress

Parameters for which Active Notification MAY be Denied

Parameter
Device.Ethernet.Interface.{i}.
CurrentBitRate
Device.WiFi.NeighboringWiFiDiagnostic.
DiagnosticsState
Device.ZigBee.Interface.{i}.
Alias
LastChange
Device.ZigBee.Interface.{i}.Stats.
BytesSent
BytesReceived
PacketsSent
PacketsReceived
ErrorsSent
ErrorsReceived
UnicastPacketsSent
UnicastPacketsReceived
DiscardPacketsSent
DiscardPacketsReceived
MulticastPacketsSent
MulticastPacketsReceived
BroadcastPacketsSent
BroadcastPacketsReceived
UnknownPacketsReceived
Device.ZigBee.ZDO.{i}.
Alias
Device.ZigBee.ZDO.{i}.Network.Neighbor.{i}.
LQI
Device.ZigBee.ZDO.{i}.NodeManager.RoutingTable.{i}.
NextHopAddress
Status
Device.ZigBee.ZDO.{i}.Binding.{i}.
Alias
Device.ZigBee.ZDO.{i}.Group.{i}.
Alias
Device.ZigBee.ZDO.{i}.ApplicationEndpoint.{i}.
Alias
Device.ZigBee.Discovery.AreaNetwork.{i}.
Alias
Device.IP.Diagnostics.IPPing.
AverageResponseTimeDetailed
MinimumResponseTimeDetailed
MaximumResponseTimeDetailed

Profile Definitions

Notation

The following abbreviations are used to specify profile requirements:

Abbreviation Description
R Read support is REQUIRED.
W Both Read and Write support is REQUIRED. This MUST NOT be specified for a parameter that is defined as read-only.
P The object is REQUIRED to be present.
C Creation and deletion of instances of the object is REQUIRED.
A Creation of instances of the object is REQUIRED, but deletion is not REQUIRED.
D Deletion of instances of the object is REQUIRED, but creation is not REQUIRED.

StandbyPolicy:1 Profile

This table defines the StandbyPolicy:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.7. Note that support for this profile implies support for the requirements of [Annex L/TR-069a5].

Name Requirement
Device.­ManagementServer.­StandbyPolicy. P
CRUnawarenessMaxDuration W
MaxMissedPeriodic W
NotifyMissedScheduled W
NetworkAwarenessCapable R
SelfTimerCapable R
CRAwarenessRequested W
PeriodicAwarenessRequested W
ScheduledAwarenessRequested W

XMPPBasic:1 Profile

This table defines the XMPPBasic:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.7.

Name Requirement
Device.­XMPP. P
ConnectionNumberOfEntries R
Device.­XMPP.­Connection.­{i}. C
Enable W
Username W
Password W
Domain W
Resource W
JabberID R
Status R
LastChangeDate R

XMPPAdvanced:1 Profile

The XMPPAdvanced:1 profile for the Device:2 data model is defined as the union of the XMPPBasic:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.7.

Name Requirement
Device.­XMPP.­Connection.­{i}. C
ServerConnectAlgorithm W
KeepAliveInterval W
ServerNumberOfEntries R
UseTLS W
TLSEstablished R
Device.­XMPP.­Connection.­{i}.­Server.­{i}. C
Enable W
Priority W
Weight W
ServerAddress W
Port W
Device.­XMPP.­Connection.­{i}.­Stats. P
ReceivedMessages R
TransmittedMessages R
ReceivedErrorMessages R
TransmittedErrorMessages R

XMPPReconnect:1 Profile

This table defines the XMPPReconnect:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.7.

Name Requirement
Device.­XMPP.­Connection.­{i}. C
ServerConnectAttempts W
ServerRetryInitialInterval W
ServerRetryIntervalMultiplier W
ServerRetryMaxInterval W

XMPPConnReq:1 Profile

The XMPPConnReq:1 profile for the Device:2 data model is defined as the union of the XMPPBasic:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.7.

Name Requirement
Device.­ManagementServer. P
SupportedConnReqMethods R
ConnReqXMPPConnection W
ConnReqAllowedJabberIDs W
ConnReqJabberID R

EthernetInterface:2 Profile

The EthernetInterface:2 profile for the Device:2 data model is defined as the union of the EthernetInterface:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.7.

Name Requirement
Device.­Ethernet.­Interface.­{i}. P
CurrentBitRate R

ProviderBridge:1 Profile

This table defines the ProviderBridge:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.7.

Name Requirement
Device.­Bridging. P
MaxProviderBridgeEntries R
ProviderBridgeNumberOfEntries R
Device.­Bridging.­Bridge.­{i}.­Port.­{i}. C
ServiceAccessPrioritySelection W
ServiceAccessPriorityTranslation W
Type W
TPID W
Device.­Bridging.­Bridge.­{i}.­Port.­{i}.­PriorityCodePoint. P
PCPSelection W
UseDEI W
RequireDropEncoding W
PCPEncoding W
PCPDecoding W
Device.­Bridging.­ProviderBridge.­{i}. C
Enable W
Status R
Type W
SVLANComponent W
CVLANComponents W
Device.­Ethernet.­VLANTermination.­{i}. C
TPID W

ProviderBridgeQoS:1 Profile

This table defines the ProviderBridgeQoS:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.7.

Name Requirement
Device.­QoS. P
DefaultInnerEthernetPriorityMark W
Device.­QoS.­Classification.­{i}. C
InnerEthernetPriorityCheck W
InnerEthernetPriorityExclude W
InnerEthernetPriorityMark W
EthernetDEICheck W
EthernetDEIExclude W

IEEE8021xAuthentication:2 Profile

The IEEE8021xAuthentication:2 profile for the Device:2 data model is defined as the union of the IEEE8021xAuthentication:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is Device:2.7.

Name Requirement
Device.­IEEE8021x.­Supplicant.­{i}. P
Interface W

IPPingDetailed:1 Profile

This table defines the IPPingDetailed:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.7.

Name Requirement
Device.­IP.­Diagnostics.­IPPing. P
DiagnosticsState W
Interface W
Host W
NumberOfRepetitions W
Timeout W
DataBlockSize W
DSCP W
SuccessCount R
FailureCount R
AverageResponseTimeDetailed R
MinimumResponseTimeDetailed R
MaximumResponseTimeDetailed R


Generated by Broadband Forum report.pl#422 (2018/03/28 version) on 2018/04/02 at 12:23:22.
report.pl --exitcode=fatals --cwmpindex=.. --nofontstyles --nowarnreport --quiet --lastonly --report=html --outfile=tr-181-2-7-0-diffs.html tr-181-2-7-0.xml