Broadband Forum

    DATA MODEL DEFINITION


TR-069 Device:2.3 Root Object definition
TR-181 Issue 2 Amendment 3 (changes)

Notice

The Broadband Forum is a non-profit corporation organized to create guidelines for broadband network system development and deployment. This Broadband Forum Document has been approved by members of the Forum. This Broadband Forum Document is not binding on the Broadband Forum, any of its members, or any developer or service provider. This Broadband Forum Document is subject to change, but only with approval of members of the Forum. This Document is copyrighted by the Broadband Forum, and all rights are reserved. Portions of this Document may be copyrighted by Broadband Forum members.

This Broadband Forum Document is provided AS IS, WITH ALL FAULTS. ANY PERSON HOLDING A COPYRIGHT IN THIS BROADBAND FORUM DOCUMENT, OR ANY PORTION THEREOF, DISCLAIMS TO THE FULLEST EXTENT PERMITTED BY LAW ANY REPRESENTATION OR WARRANTY, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY:

By using this Broadband Forum Document, users acknowledge that implementation may require licenses to patents. The Broadband Forum encourages but does not require its members to identify such patents. For a list of declarations made by Broadband Forum member companies, please see http://www.broadband-forum.org. No assurance is given that licenses to patents necessary to implement this Document will be available for license at all or on reasonable and non-discriminatory terms.

ANY PERSON HOLDING A COPYRIGHT IN THIS BROADBAND FORUM DOCUMENT, OR ANY PORTION THEREOF, DISCLAIMS TO THE FULLEST EXTENT PERMITTED BY LAW (A) ANY LIABILITY (INCLUDING DIRECT, INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES UNDER ANY LEGAL THEORY) ARISING FROM OR RELATED TO THE USE OF OR RELIANCE UPON THIS DOCUMENT; AND (B) ANY OBLIGATION TO UPDATE OR CORRECT THIS DOCUMENT.

Broadband Forum Documents may be copied, downloaded, stored on a server or otherwise re-distributed in their entirety only, and may not be modified without the advance written permission of the Broadband Forum.

The text of this notice must be included in all copies of this Broadband Forum Document.

Summary

Device:2.3 data model

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]. The complete set of data types, along with the notation used to represent these types, is listed in [Appendix I.4/TR-106a6]. The following named data types are used by this specification.

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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.

References

[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-069a4] TR-069 Amendment 4, CPE WAN Management Protocol, Broadband Forum, 2011.
[TR-106a6] TR-106 Amendment 6, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2011.

Device:2.3 Data Model (changes)

For a given implementation of this data model, the CPE MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the CPE supports only a single parameter that was introduced in version 2.3, then it will indicate support for version 2.3. 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
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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.DeviceInfo.SupportedDataModel.{i}. object - This table contains details of the device's Current Supported Data Model.

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

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

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

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

 - 2.0
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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.3
Device.DeviceInfo.TemperatureStatus. object - Status of the temperature of the device. - 2.0
Device.DeviceInfo.TemperatureStatus.TemperatureSensor.{i}. object - This object represents information that the device has obtained via sampling an internal temperature sensor.

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

 - 2.0
Alias string­(64) 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.3
Device.DeviceInfo.Processor.{i}. object - Each table entry represents a hardware or virtual processor that resides on this device.

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

 - 2.1
Alias string­(64) 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.3
Device.DeviceInfo.VendorLogFile.{i}. object - Each table entry represents a Vendor Log File.

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

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

 - 2.1
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.1
Device.DeviceInfo.ProxierInfo. object - Represents the associated CPE Proxier for a Proxied Device that utilizes the Virtual CWMP Device Mechanism [Annex J.1.1/TR-069a4]. - 2.3
ManufacturerOUI string­(6:6) - Organizationally unique identifier of the associated CPE Proxier. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. Possible patterns:

The value MUST be a valid OUI as defined in [OUI].

 - 2.3
ProductClass string­(64) - Identifier of the class of product of the associated CPE Proxier for which the serial number applies.

An empty string indicates either that the CPE Proxier does not use a product class to differentiate its serial number.

 - 2.3
SerialNumber string­(64) - Serial number of the associated CPE Proxier. - 2.3
ProxyProtocol string­(64) - The protocol being used to communicate between the CPE Proxier and this Proxied Device. Enumeration of:

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

 - 2.3
Device.ManagementServer. object - This object contains parameters relating to the CPE's association with an ACS. - 2.0
AliasBasedAddressing boolean - Indicates whether or not the Alias-Based Addressing Mechanism is supported.

A true value indicates that the CPE supports the Alias-Based Addressing Mechanism, as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4].

 - 2.3
InstanceMode string W Instance identification mode as defined in [Section 3.6.1/TR-069a4]. When AliasBasedAddressing is true, InstanceMode is used by the ACS to control whether the CPE will use Instance Numbers or Instance Aliases in returned Path Names. Enumeration of:

This parameter is REQUIRED for any CPE supporting Alias-Based Addressing.

The factory default value MUST be InstanceNumber.

 - 2.3
AutoCreateInstances boolean W Enable or disable the Auto-Create Instance Mechanism. When AliasBasedAddressing is true, AutoCreateInstances indicates whether or not the CPE will automatically create instances while processing a SetParameterValues RPC (as defined in [A.3.2.1/TR-069a4]).

  • A true value indicates that the CPE will perform auto-creation of instances when the Alias-Based Addressing Mechanism is used in SetParameterValues RPC.
  • A false value indicates that the CPE will not create new object instances. Instead, it will reject the setting of parameters in unrecognized instances and respond with a fault code.

This parameter is REQUIRED for any CPE supporting Alias-Based Addressing.

The factory default value MUST be false.

 - 2.3
EmbeddedDeviceNumberOfEntries unsignedInt - The number of entries in the EmbeddedDevice table. - 2.3
VirtualDeviceNumberOfEntries unsignedInt - The number of entries in the VirtualDevice table. - 2.3
Device.ManagementServer.ManageableDevice.{i}. object - Each entry in this table corresponds to a distinct LAN Device that supports Device-Gateway Association according to [Annex F/TR-069a2] as indicated by the presence of the DHCP option specified in that Annex.

At most one entry in this table can exist with a given value for Alias, or with all the same values for ManufacturerOUI, SerialNumber and ProductClass.

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

This parameter is DEPRECATED because ManageableDevice is a transient object.

 - 2.0
Device.ManagementServer.DownloadAvailability. object - This object contains multicast announcement and query parameters used for the purpose of downloading files. - 2.0
Device.ManagementServer.DownloadAvailability.Announcement. object - This object contains multicast announcement parameters used to download files. - 2.0
Device.ManagementServer.DownloadAvailability.Announcement.Group.{i}. object W Multicast groups to which the CPE SHOULD listen for announcements.

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

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

 - 2.0
Alias string­(64) 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.3
Device.ManagementServer.EmbeddedDevice.{i}. object - Each entry in this table represents a distinct Proxied Device that utilizes the Embedded Object Mechanism [Annex J.1.2/TR-069a4] for proxying devices.

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

 - 2.3
ControllerID string­(256) - Identifier of the controller that is responsible for a sub-network of Proxied Devices within the LAN.

An empty string indicates that this Proxied Device either:

  • Isn't part of a sub-network, within the LAN, with a controller entity.
  • Doesn't need a ControllerID to ensure its ProxiedDeviceID is unique throughout the LAN.
- 2.3
ProxiedDeviceID string­(256) - Idenitfier of the Proxied Device.

This is an opaque string that is unique to the Proxied Device within a specific sub-network within the LAN (identified by the ControllerID). If the ControllerID is an empty string this ProxiedDeviceID is unique across the LAN.

 - 2.3
Reference string - The value MUST be the path name of a table row. If the referenced object is deleted, this EmbeddedDevice instance MUST also be removed. Represents the instance of a multi-instanced object that is directly controlled by, and has come into existence because of, this Proxied Device that utilizes the Embedded Object Mechanism [Annex J.1.2/TR-069a4]. - 2.3
SupportedDataModel string - Comma-separated list of strings. Each list item MUST be the path name of a row in the DeviceInfo.SupportedDataModel table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents the CWMP-DT schema instance(s) that this Proxied Device is utilizing. The CWMP-DT schema instance is also the one being utilized by the object referenced within Reference. - 2.3
Host string - Comma-separated list (up to 32 items) of strings. Each list item MUST be the path name of a row in the Hosts.Host table. If the referenced object is deleted, the corresponding item MUST be removed from the list. References the Hosts.Host table entry(s), whether active or inactive, that corresponds to this proxied LAN device. - 2.3
ProxyProtocol string­(64) - The protocol being used to communicate between the CPE Proxier and this Proxied Device. Enumeration of:

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

 - 2.3
CommandProcessed string - Whether or not the CPE Proxier has successfully communicated all pending configuration commands down to the Proxied Device. Enumeration of:

 - 2.3
CommandProcessingErrMsg string­(1024) - Detailed CommandProcessed error description (vendor specific). - 2.3
LastSyncTime dateTime - The last time that the CPE Proxier synchronized the state of the Proxied Device. This parameter MUST be updated when a proxy command is executed successfully on the Proxied Device.

The Unknown Time value, as defined in [TR-106a6], indicates that the Proxied Device's state has not been synchronized since the CPE Proxier was last rebooted.

 - 2.3
Device.ManagementServer.VirtualDevice.{i}. object - Each entry in this table represents a distinct Proxied Device that utilizes the Virtual CWMP Device Mechanism [Annex I.1.1/TR-069a4] for proxying devices.

At most one entry in this table can exist with all the same values for ManufacturerOUI, ProductClass and SerialNumber.

 - 2.3
ManufacturerOUI string­(6:6) - Organizationally unique identifier of the associated Proxied Device. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. Possible patterns:

The value MUST be a valid OUI as defined in [OUI].

 - 2.3
ProductClass string­(64) - Identifier of the class of product of the associated Proxied Device for which the serial number applies. - 2.3
SerialNumber string­(64) - Serial number of the associated Proxied Device. - 2.3
Host string - Comma-separated list (up to 32 items) of strings. Each list item MUST be the path name of a row in the Hosts.Host table. If the referenced object is deleted, the corresponding item MUST be removed from the list. References all the Hosts.Host table entries, whether active or inactive, that correspond to this proxied LAN device. There can be multiple such entries if the Proxied Device has more than one network interface. - 2.3
ProxyProtocol string­(64) - The protocol being used to communicate between the CPE Proxier and this Proxied Device. Enumeration of:

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

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

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

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

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

 - 2.0
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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.3
Device.DSL. object - This object models DSL lines, DSL channels, DSL bonding, and DSL diagnostics. The specific interface objects defined here are Line, Channel, and BondingGroup. Each Line models a layer 1 DSL Line interface, and each Channel models a layer 1 DSL Channel interface where multiple channels can run over a DSL line. In the case where bonding is configured, it is expected that BondingGroup is stacked above the Channel instances within its group. - 2.0
Device.DSL.Line.{i}. object - DSL Line table (a stackable interface object as described in [Section 4.2/TR-181i2]).

This table models physical DSL lines.

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.DSL.Channel.{i}. object - DSL Channel table (a stackable interface object as described in [Section 4.2/TR-181i2]).

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.DSL.BondingGroup.{i}. object - DSL bonding group table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each instance is a bonding group, and is expected to be stacked above a Channel instance for each bonded channel in the group.

Many of the parameters within this object, including LowerLayers, are read-only because bonding is not expected to be configured via [TR-069].

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.DSL.BondingGroup.{i}.BondedChannel.{i}. object - DSL bonded channel table. Each table entry represents a bonded channel within the bonding group, and is associated with exactly one Channel instance. There MUST be an instance of BondedChannel for each DSL channel that is bonded.

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.ATM. object - Asynchronous Transfer Mode (ATM) object that contains the Link interface and Diagnostics.F5Loopback diagnostics. - 2.0
Device.ATM.Link.{i}. object W ATM link-layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Models an ATM PVC virtual circuit and the ATM Adaption Layer (AAL). An ATM Link entry is typically stacked on top of either a DSL.Channel. or a DSL.BondingGroup. object.

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.PTM. object - Packet Transfer Mode ([Annex H/G.993.1]). This object contains the Link interface. - 2.0
Device.PTM.Link.{i}. object W PTM link-layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Models a layer 2 variable-sized packet interface. A PTM Link entry is typically stacked on top of either a DSL.Channel. or a DSL.BondingGroup. object.

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
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. A 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
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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.Ethernet.Link.{i}. object W Ethernet link layer table (a stackable interface object as described in [Section 4.2/TR-181i2]). Table entries model the Logical Link Control (LLC) layer. It is expected that an Ethernet Link interface can be stacked above any lower-layer interface object capable of carrying Ethernet frames.

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
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 CPE MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.USB. object - Universal Serial Bus ([USB1.0], [USB2.0], [USB3.0]). This object contains the Interface, Port, and USBHosts objects. - 2.0
Device.USB.Interface.{i}. object - USB interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models master and slave USB physical interfaces that support carrying Ethernet frames, e.g. via the USB Communication Device Class.

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.USB.Port.{i}. object - USB Port table. This table models master and slave USB physical ports on the device.

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.USB.USBHosts. object - This object models the CPE's USB Host controllers.

See [Appendix I/TR-157] for Theory of Operation.

 - 2.0
Device.USB.USBHosts.Host.{i}. object - Table of CPE USB Host controllers.

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

 - 2.0
Alias string­(64) 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.3
Device.HPNA. object - HPNA object that contains the Interface and Diagnostics objects. The HPNA (also known as HomePNA) industry standard [G.9954] defines peer to peer communication for home networking over existing coax cables and telephone wiring within the home. - 2.0
Device.HPNA.Interface.{i}. object - HPNA interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of an HPNA interface [G.9954].

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.HPNA.Interface.{i}.QoS. object - QoS configuration object. - 2.0
Device.HPNA.Interface.{i}.QoS.FlowSpec.{i}. object W Flow specification table.

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

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.MoCA. object - MoCA object that contains the Interface table [MoCAv1.0] [MoCAv1.1]. - 2.0
Device.MoCA.Interface.{i}. object - MoCA interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of a MoCA interface [MoCAv1.0] [MoCAv1.1].

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.HomePlug. object - HomePlug object that contains the Interface table. The HomePlug industry standard [HPAV1.1] defines peer to peer communication over powerline medium. - 2.0
Device.HomePlug.Interface.{i}. object - HomePlug interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of a HomePlug interface [HPAV1.1].

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.UPA. object - Universal Powerline Association [UPA-PLC]. This object contains the Interface and Diagnostics objects. - 2.0
Device.UPA.Interface.{i}. object - UPA interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). Each table entry models the PHY and MAC levels of a UPA interface [UPA-PLC].

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.UPA.Interface.{i}.ActiveNotch.{i}. object W This object contains the list of active notches of the UPA interface.

A UPA device can have notches in its spectrum, where no power is transmitted in a given part of the spectrum. These notches are typically located in amateur radio bands, to avoid interference.

Note: All ActiveNotch entries can be enabled/disabled as a group using the ActiveNotchEnable parameter.

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.UPA.Interface.{i}.BridgeFor.{i}. object - This object represents the bridge table of the UPA interface. Each instance is a bridge table entry.

It shows the MAC addresses of the remote UPA devices with their associated port number, and the MAC addresses of the end-devices (PCs, STBs, routers, etc) connected to Ethernet port of the powerline adapters with their associated logical port. In this way the system identifies to which UPA device an external device is connected to.

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
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
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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
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 CPE 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 SSID, or with a given value for BSSID.

 - 2.0
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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.WiFi.AccessPoint.{i}. object W This object models an 802.11 connection from the perspective of a wireless access point. Each AccessPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter.

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

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

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.WiFi.EndPoint.{i}. object W This object models an 802.11 connection from the perspective of a wireless end point. Each EndPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter, and an associated active Profile instance via the ProfileReference parameter. The active profile is responsible for specifying the actual SSID and security settings used by the end point.

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

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

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.WiFi.EndPoint.{i}.Profile.{i}. object W EndPoint Profile table.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE 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 SSID, Location and Priority.

 - 2.0
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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
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-2005] 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.

 - 2.0
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 CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 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 automatcially 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 CPE MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.Bridging.Bridge.{i}.VLAN.{i}. object W Bridge VLAN table. If this table is supported, if MUST contain an entry for each VLAN known to the Bridge.

This table only applies to an 802.1Q [802.1Q-2005] Bridge.

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.Bridging.Bridge.{i}.VLANPort.{i}. object W Bridge VLAN egress port and untagged port membership table.

This table only applies to an 802.1Q [802.1Q-2005] Bridge.

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

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE 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 VLAN and Port.

 - 2.0
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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.Bridging.Filter.{i}. object W Filter table containing classification filter entries, each of which expresses a set of classification criterion to classify ingress frames as member of a Bridge instance or a Bridge.{i}.VLAN instance.

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

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

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.PPP. object - Point-to-Point Protocol [RFC1661]. This object contains the Interface table. - 2.0
Device.PPP.Interface.{i}. object W PPP interface table (a stackable interface object as described in [Section 4.2/TR-181i2]).

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.IP. object - IP object that contains the Interface, ActivePort, and Diagnostics objects. - 2.0
Device.IP.Interface.{i}. object W IP interface table (a stackable interface object as described in [Section 4.2/TR-181i2]). This table models the layer 3 IP interface.

Each IP interface can be attached to the IPv4 and/or IPv6 stack. The interface's IP addresses and prefixes are listed in the IPv4Address, IPv6Address and IPv6Prefix tables.

Note that support for manipulating Loopback interfaces is OPTIONAL, so the implementation MAY choose not to create (or allow the ACS to create) Interface instances of type Loopback.

When the ACS administratively disables the interface, i.e. sets Enable to false, the interface's automatically-assigned IP addresses and prefixes MAY be retained. When the ACS administratively enables the interface, i.e. sets Enable to true, these IP addresses and prefixes MUST be refreshed. It's up to the implementation to decide exactly what this means: it SHOULD take all reasonable steps to refresh everything but if it is unable, for example, to refresh a prefix that still has a significant lifetime, it might well choose to retain rather than discard it.

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 CPE MUST choose initial values for Alias and Name such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.IP.Interface.{i}.IPv4Address.{i}. object W IPv4 address table. Entries are auto-created and auto-deleted as IP addresses are added and deleted via DHCP, auto-IP, or IPCP. Static entries are created and configured by the ACS.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE 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 IPAddress and SubnetMask.

 - 2.0
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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.

This parameter can only be modified if AddressingType is Static.

 - 2.0
Device.IP.Interface.{i}.IPv6Address.{i}. object W This table contains the IP interface's IPv6 unicast addresses. There MUST be an entry for each such address, including anycast addresses.

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

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

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

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

This object is based on ipAddressTable from [RFC4293].

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

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

 - 2.2
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.

This parameter can only be modified if Origin is Static.

 - 2.2
Device.IP.Interface.{i}.IPv6Prefix.{i}. object W This table contains the interface's IPv6 prefixes. There MUST be an entry for each such prefix, not only for prefixes learned from router advertisements.

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

  • Automatically via [RFC4861] Router Advertisements. See also RouterAdvertisement.
  • Automatically via DHCPv6 [RFC3315] prefix delegation [RFC3633]. See also DHCPv6.Client.
  • Automatically via internal CPE logic, e.g. creation of child prefixes derived from a parent prefix.
  • Manually via a GUI or some other local management interface.
  • Manually via factory default configuration.
  • By the ACS.

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

This object is based on ipAddressPrefixTable from [RFC4293].

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

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

 - 2.2
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.

This parameter can only be modified if Origin is Static.

 - 2.2
Device.Routing. object - Routing object that contains the Router table and RIP protocol object. - 2.0
Device.Routing.Router.{i}. object W This object allows the handling of the routing and forwarding configuration of the device.

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.Routing.Router.{i}.IPv4Forwarding.{i}. object W Layer 3 IPv4 forwarding table.

In addition to statically configured routes, this table MUST include dynamic routes learned through layer 3 routing protocols, including RIP (i.e. RIP version 2), OSPF, DHCPv4, and IPCP. The CPE MAY reject attempts to delete or modify a dynamic route entry.

For each incoming packet, the layer 3 forwarding decision is conceptually made as follows:

  • Only enabled table entries with a matching ForwardingPolicy are considered, i.e. those that either do not specify a ForwardingPolicy, or else specify a ForwardingPolicy that matches that of the incoming packet.
  • Next, table entries that also have a matching destination address/mask are considered, and the matching entry with the longest prefix is applied to the packet (i.e. the entry with the most specific network). An unspecified destination address is a wild-card and always matches, but with a prefix length of zero.

For enabled table entries, if Interface is not a valid reference to an IPv4-capable interface (that is attached to the IPv4 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE 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 DestIPAddress, DestSubnetMask, ForwardingPolicy, GatewayIPAddress, Interface and ForwardingMetric.

 - 2.0
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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.Routing.Router.{i}.IPv6Forwarding.{i}. object W Layer 3 IPv6 forwarding table.

In addition to statically configured routes, this table MUST include dynamic routes learned through layer 3 routing protocols, including RIPng, OSPF, DHCPv6, and RA. The CPE MAY reject attempts to delete or modify a dynamic route entry.

For each incoming packet, the layer 3 forwarding decision is conceptually made as follows:

  • Only enabled table entries with a matching ForwardingPolicy are considered, i.e. those that either do not specify a ForwardingPolicy, or else specify a ForwardingPolicy that matches that of the incoming packet.
  • Next, table entries that also have a matching destination prefix are considered, and the matching entry with the longest prefix length is applied to the packet (i.e. the entry with the most specific network). An unspecified destination address is a wild-card and always matches, but with a prefix length of zero.

For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

This object is based on inetCidrRouteTable from [RFC4292].

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE 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 DestIPPrefix, ForwardingPolicy, NextHop, Interface and ForwardingMetric.

 - 2.2
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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.2
Device.Routing.RIP. object - Routing Information Protocol (RIP) object. - 2.0
Device.Routing.RIP.InterfaceSetting.{i}. object W IP Interface RIP configuration table.

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

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

Note: This object only applies to RIP2; i.e. version 2 of the RIP protocol is used to accept or send over the specified Interface.

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.NeighborDiscovery. object - The Neighbor Discovery Protocol (NDP) object [RFC4861]. This object applies only to IPv6. It contains an InterfaceSetting table that defines the NDP configuration for individual IP interfaces. - 2.2
Device.NeighborDiscovery.InterfaceSetting.{i}. object W Per-interface Neighbor Discovery Protocol (NDP) configuration [RFC4861].

For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

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

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

 - 2.2
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.2
Device.RouterAdvertisement. object - The Router Advertisement (RA) object [RFC4861]. This object applies only to IPv6. It contains an InterfaceSetting table that defines the RA configuration for individual IP interfaces.

Information received via router advertisement messages is automatically propagated to the relevant IP.Interface sub-objects, e.g. to the IP.Interface.{i}.IPv6Address and IP.Interface.{i}.IPv6Prefix tables.

 - 2.2
Device.RouterAdvertisement.InterfaceSetting.{i}. object W Per-interface Router Advertisement (RA) configuration [RFC4861]. Table entries are created for use in sending Router Advertisements.

For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

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

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

 - 2.2
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.2
Device.RouterAdvertisement.InterfaceSetting.{i}.Option.{i}. object W This object specifies the options in a Router Advertisement (RA) message [Section 4.6/RFC4861]. Option entries are created for use in sending Router Advertisements (enabled options MUST be included in RA messages sent). This includes support for sending DNS information in the RA message as described in [RFC6106].

This table is intended only for options that are not modeled elsewhere. For example, it is not appropriate for the MTU option (which is modeled via AdvLinkMTU).

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

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

 - 2.2
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.2
Device.IPv6rd. object - Settings allowing a CPE to derive and route IPv6 Rapid Deployment (6rd) delegated prefixes as specified in [RFC5969]. The 6rd mechanism is intended to be implemented only on what [RFC5969] refers to as Customer Edge Routers, i.e. on gateway devices, that support IPv6 on the LAN side and only have IPv4 connectivity on the WAN side.

See the 6rd Theory of Operation [Appendix VI/TR-181i2a2] for a description of the working of this 6rd data model.

 - 2.2
Device.IPv6rd.InterfaceSetting.{i}. object - 6rd [RFC5969] settings.

A 6rd delegated prefix is expected to be of maximum length 64 bits, and is the concatenation of the following two items:

  • Service provider IPv6 prefix: specified via the SPIPv6Prefix parameter
  • IPv4 address suffix: the IPv4 address with the first IPv4MaskLength bits removed

This object definition is derived from [RFC5969] with some minor nomenclature changes.

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

 - 2.2
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.2
Device.DSLite. object - Settings allowing a CPE to configure and route IPv6 Dual-Stack Lite (DSLite) as specified in [DSLite]. The DS-Lite mechanism is intended to be implemented only on gateway devices that support IPv4 on the LAN side and only have IPv6 connectivity on the WAN side.

See the Dual-Stack Lite Theory of Operation [Appendix VII/TR-181i2a2] for a description of the working of this DS-Lite data model.

 - 2.2
Device.DSLite.InterfaceSetting.{i}. object - DSLite [DSLite] settings.

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

 - 2.2
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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.2
Device.QoS. object - Queue management configuration object. - 2.0
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 CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
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 CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
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 CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.QoS.Policer.{i}. object W Policer table.

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.QoS.Queue.{i}. object W Queue table. Each entry is associated with a set of traffic classes, which are specified via the TrafficClasses parameter, and is configured with weight, precedence, drop algorithm, scheduler algorithm etc as appropriate for the traffic classes. An entry can be associated either with all egress interfaces (in which case an actual queue will be instantiated on each egress interface on which traffic of that traffic class can be generated) or else with a single specified egress interface.

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.QoS.QueueStats.{i}. object W Queue statistics table. This table is managed by the ACS, which will create entries only for those {Queue, Interface} combinations for which statistics are to be collected.

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

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE 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 Queue and Interface.

 - 2.0
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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.QoS.Shaper.{i}. object W Shaper table. Used to shape the queue(s) associated with Interface. In case of a single queue for that interface, determines the egress rate of the queue. In case of multiple queues for that interface (possibly with per queue shaping rates), determines the aggregate egress rate on that interface.

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

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

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.Hosts. object - This object provides information about each of the hosts on the LAN, including those whose IP address was allocated by the CPE using DHCP as well as hosts with statically allocated IP addresses. It can also include non-IP hosts. - 2.0
Device.Hosts.Host.{i}. object - Host table.

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

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

This parameter is DEPRECATED because Host is a transient object.

 - 2.0
Device.DNS. object - Properties for Domain Name Service (DNS). It contains the Client, Relay, and Diagnostics objects. - 2.0
Device.DNS.Client. object - Client properties for Domain Name Service (DNS). The DNS client resolves FQDN on behalf of device internal (client) applications. - 2.0
Device.DNS.Client.Server.{i}. object W This table contains the DNS Server IP address to be used by the DHCP Client (it does not model a DNS Server). Entries are either automatically created as result of DHCP (v4 or v6), IPCP, or RA received DNS server information, or are statically configured by the ACS.

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.DNS.Relay. object - DNS Relay object. The DNS proxy (or relay) function allows the forwarding of local network DNS queries to local or external DNS server(s) [RFC5625]. - 2.0
Device.DNS.Relay.Forwarding.{i}. object W DNS Server forwarding policy to be used by the DNS Relay. Entries are either automatically created as result of DHCP (v4 or v6), IPCP, or RA received DNS server information, or are statically configured by the ACS.

Note: Management of re-directing queries to the device embedded DNS server is not defined in this version of the specification.

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.NAT. object - Properties for Network Address Translation (NAT).

The entire NAT object only applies to IPv4.

 - 2.0
Device.NAT.InterfaceSetting.{i}. object W NAT settings for an associated IP Interface on which NAT is enabled.

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

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

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.NAT.PortMapping.{i}. object W Port mapping table.

This table MUST contain all NAT port mappings associated with this connection, including static and dynamic port mappings programmatically created via local control protocol, such as UPnP.

This table MUST NOT contain dynamic NAT binding entries associated with the normal operation of NAT.

If the CPE hosts a firewall, it is assumed that it will appropriately configure the firewall for the port mapping.

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

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE 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 RemoteHost, ExternalPort and Protocol.

 - 2.0
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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.

Note: There is no guarantee that the Alias value on automatically-created PortMapping instances will be retained. This is because automatically-created PortMapping instances can be transitory.

 - 2.0
Device.DHCPv4. object - The Dynamic Host Configuration Protocol (DHCP) IPv4 object [RFC2131]. This entire object applies to IPv4 only. It contains the Client, Server, and Relay objects. - 2.0
Device.DHCPv4.Client.{i}. object W This object contains DHCP client settings for an associated IP Interface indicated by Interface.

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

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

This table MUST contain at least 1 entry.

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.DHCPv4.Client.{i}.SentOption.{i}. object W Each instance of this object represents a DHCP option that MUST, if enabled, be sent in DHCP client requests. All sent DHCP options MUST be listed.

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.DHCPv4.Client.{i}.ReqOption.{i}. object W Each instance of this object represents a DHCP option that MUST, if enabled, be requested in DHCP client requests. All requested DHCP options MUST be listed.

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.DHCPv4.Server. object - DHCP server configuration. - 2.0
Device.DHCPv4.Server.Pool.{i}. object W DHCP conditional serving pool table.

Each instance of this object defines a DHCP conditional serving pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCP options, and MAC address.

Overlapping pool ranges MUST be supported.

For enabled table entries, if Interface is not a valid reference, or MinAddress, MaxAddress, or SubnetMask is not a valid value, then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.DHCPv4.Server.Pool.{i}.StaticAddress.{i}. object W DHCP static address table.

Entries in this table correspond to what [RFC2131] calls "manual allocation", where a client's IP address is assigned by the network administrator, and DHCP is used simply to convey the assigned address to the client.

Each instance of this object specifies a hardware address (MAC address) and an IP address within the pool. When serving from this pool, this IP address MUST, if available, be assigned to the DHCP client with this hardware address, and MUST NOT be assigned to any other client.

Note that it is possible that an IP address in this table is present in one or more of the other conditional serving pools, in which case it is possible that such an address will be assigned to a different client.

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.DHCPv4.Server.Pool.{i}.Option.{i}. object W This object specifies the DHCP options that MUST, if enabled, be returned to clients whose DHCP requests are associated with this pool.

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.DHCPv4.Server.Pool.{i}.Client.{i}. object - DHCPv4 client table.

This table lists details of DHCPv4 clients that matched the filter criteria of this Pool entry.

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

 - 2.2
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.

Note: There is no guarantee that the Alias value on automatically-created Client instances will be retained. This is because automatically-created Client instances can be transitory.

 - 2.2
Device.DHCPv4.Relay. object - DHCP Relay Agent (conditional relaying). - 2.0
Device.DHCPv4.Relay.Forwarding.{i}. object W DHCP Relay Agent Forwarding table.

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.DHCPv6. object - The Dynamic Host Configuration Protocol (DHCP) IPv6 object [RFC3315]. This entire object applies to IPv6 only. It contains the Client and Server objects. - 2.2
Device.DHCPv6.Client.{i}. object W This object contains DHCPv6 client settings for an associated IP Interface indicated by Interface.

For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack), then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

This table MUST contain at least 1 entry.

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

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

 - 2.2
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.2
Device.DHCPv6.Client.{i}.SentOption.{i}. object W The top-level options and option values (including any encapsulated options) that the client will send to the server.

This table is intended only for options that are not part of the basic operation of the protocol, and whose values are simple, do not often change and are not modeled elsewhere. For example, it is appropriate for OPTION_USER_CLASS (whose value is a list of user classes) but is not appropriate for OPTION_RECONF_MSG (which is part of the protocol), OPTION_IA_NA (which is modeled via RequestAddresses) or OPTION_RAPID_COMMIT (which is modeled via RapidCommit).

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

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

 - 2.2
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.2
Device.DHCPv6.Server. object - DHCPv6 server configuration. - 2.2
Device.DHCPv6.Server.Pool.{i}. object W DHCPv6 server pool table.

Each instance of this object defines a DHCPv6 server pool. Client requests are associated with pools based on criteria such as source interface, supplied DHCPv6 options, and source address.

Overlapping pool ranges MUST be supported.

For enabled table entries, if Interface is not a valid reference to an IPv6-capable interface (that is attached to the IPv6 stack) then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

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

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

 - 2.2
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.2
Device.DHCPv6.Server.Pool.{i}.Client.{i}. object - DHCPv6 client table.

This table lists details of DHCPv6 clients that matched the filter criteria of this Pool entry.

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

 - 2.2
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.

Note: There is no guarantee that the Alias value on automatically-created Client instances will be retained. This is because automatically-created Client instances can be transitory.

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

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

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

 - 2.2
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.2
Device.IEEE8021x. object - IEEE 802.1x object [802.1x-2004], where Supplicant models authentication supplicants. - 2.0
Device.IEEE8021x.Supplicant.{i}. object W 802.1x supplicant authentication provisioning and status information associated with an interface to be authenticated (e.g. an Ethernet.Link instance).

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

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

This table MUST contain at least 1 entry.

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

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

 - 2.0
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.0
Device.Users. object - Users object that contains the User table. - 2.0
Device.Users.User.{i}. object W This object contains parameters relating to the user characteristics.

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

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

 - 2.0
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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.3
Device.SmartCardReaders. object - SmartCardReaders object that contains the SmartCardReader table. - 2.0
Device.SmartCardReaders.SmartCardReader.{i}. object - This object describes the characteristics of the smart card reader.

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

 - 2.0
Alias string­(64) 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.3
Device.Firewall. object - Firewall configuration object. The Config parameter enables and disables the Firewall, and can select either a predefined configuration (High or Low) or an explicitly-defined Advanced configuration.

For an Advanced configuration, AdvancedLevel controls the currently active Firewall Level, and the Firewall Levels are defined in the Level, Chain and Chain.{i}.Rule tables.

The Firewall rules modeled by this object operate only on the forwarding path. This means that they affect only routed traffic, and do not affect traffic that is destined for or generated by the CPE. Note that any NAT processing on the ingress packet occurs before Firewall rules are applied so, for example, the Firewall rules will see the translated destination IP address and port in a downstream packet that has passed through the NAT.

See [Appendix VIII/TR-181i2a2] for an example Advanced configuration.

 - 2.0
Device.Firewall.Level.{i}. object W Firewall Level table. When an Advanced configuration is selected, AdvancedLevel selects the currently active entry in this table. Each Level table entry references the Chain that contains the rules for this level.

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

 - 2.2
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.2
Device.Firewall.Chain.{i}. object W Firewall Chain table. Each entry contains an ordered list of Rule objects which can themselves reference other Chain instances. A hierarchy of rules can therefore be created.

A given Firewall Chain's rules are all created by the same entity, as indicated by the Creator parameter.

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

 - 2.2
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.2
Device.Firewall.Chain.{i}.Rule.{i}. object W Firewall Rule table. Each entry defines a Firewall packet selection rule. The Target parameter defines the action to perform for traffic matching this rule: the packet can be dropped, accepted, rejected or passed to another Chain.

This table MUST NOT contain dynamic Firewall rules associated with Stateful Firewall sessions.

All entries are created by the creator of the parent Chain, as indicated by its Creator parameter. Rule entries in a Chain with a Creator of Defaults, ACS, UserInterface or (maybe) Other are referred to as Static Rules. Whether or not a Rule in a Chain with Creator Other is regarded as Static is a local matter to the CPE. Some of this object's parameter descriptions refer to whether a Rule is Static when specifying whether or not the parameter value can be modified.

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

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

 - 2.2
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.2
Device.PeriodicStatistics. object - This object configures collection of periodic statistics for the device.

Periodic statistics are measured over a sample interval (which can be aligned with absolute time) and are made available to the ACS as a comma-separated list of the most recent <n> samples.

This object provides a single set of global settings that affect the entire device unless overridden locally.

 - 2.0
Device.PeriodicStatistics.SampleSet.{i}. object W Periodic statistics sample set table. Each sample set has its own sample interval etc.

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

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

 - 2.0
Alias string­(64) 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.3
Device.PeriodicStatistics.SampleSet.{i}.Parameter.{i}. object W Periodic statistics parameter table for this sample set. This table contains entries for parameters whose values are to be sampled.

Note that the comma-separated lists in this object (SampleSeconds, SuspectData and Values) only ever change (a) when first enabled, (b) when ForceSample is set to true (a "sneak preview" of the current sample), or (c) at the end of the sample interval.

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

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

 - 2.0
Alias string­(64) 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.3
Device.SoftwareModules. object - Top level object for dynamically managed software applications. - 2.1
Device.SoftwareModules.ExecEnv.{i}. object - The Execution Environments that are available on the device, along with their properties and configurable settings.

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

 - 2.1
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.1
Device.SoftwareModules.DeploymentUnit.{i}. object - This table serves as the Deployment Unit inventory and contains status information about each Deployment Unit.

A new instance of this table gets created during the installation of a Software Module.

At most one entry in this table can exist with all the same values for UUID, Version and ExecutionEnvRef, or with a given value for Alias.

 - 2.1
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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.1
Device.SoftwareModules.ExecutionUnit.{i}. object - This table serves as the Execution Unit inventory and contains both status information about each Execution Unit as well as configurable parameters for each Execution Unit.

Each DeploymentUnit that is installed can have zero or more Execution Units.

Once a Deployment Unit is installed it populates this table with its contained Execution Units.

When the Deployment Unit (that caused this ExecutionUnit to come into existence) is updated, this instance MAY be removed and new instances MAY come into existence. While the Deployment Unit (that caused this ExecutionUnit to come into existence) is being updated, all ExecutionUnit instances associated with the Deployment Unit will be stopped until the update is complete at which time they will be restored to the state that they were in before the update started.

When the Deployment Unit (that caused this ExecutionUnit to come into existence) is uninstalled, this instance is removed.

Each ExecutionUnit MAY also contain a set of vendor specific parameters displaying status and maintaining configuration that reside under the Extensions object.

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

 - 2.1
Alias string­(64) W A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS 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 instance object is created by the CPE, the initial value MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.1

Inform and Notification Requirements

Forced Inform Parameters

Parameter
Device.ManagementServer.AliasBasedAddressing

Forced Active Notification Parameters

Parameter

Default Active Notification Parameters

Parameter

Parameters for which Active Notification MAY be Denied

Parameter
Device.DeviceInfo.VendorConfigFile.{i}.
Alias
Device.DeviceInfo.SupportedDataModel.{i}.
Alias
Device.DeviceInfo.TemperatureStatus.TemperatureSensor.{i}.
Alias
Device.DeviceInfo.Processor.{i}.
Alias
Device.DeviceInfo.VendorLogFile.{i}.
Alias
Device.ManagementServer.DownloadAvailability.Announcement.Group.{i}.
Alias
Device.InterfaceStack.{i}.
Alias
Device.DSL.Line.{i}.
Alias
Device.DSL.Channel.{i}.
Alias
Device.DSL.BondingGroup.{i}.
Alias
Device.DSL.BondingGroup.{i}.BondedChannel.{i}.
Alias
Device.ATM.Link.{i}.
Alias
Device.PTM.Link.{i}.
Alias
Device.Ethernet.Interface.{i}.
Alias
Device.Ethernet.Link.{i}.
Alias
Device.Ethernet.VLANTermination.{i}.
Alias
Device.USB.Interface.{i}.
Alias
Device.USB.Port.{i}.
Alias
Device.USB.USBHosts.Host.{i}.
Alias
Device.HPNA.Interface.{i}.
Alias
Device.HPNA.Interface.{i}.QoS.FlowSpec.{i}.
Alias
Device.MoCA.Interface.{i}.
Alias
Device.HomePlug.Interface.{i}.
Alias
Device.UPA.Interface.{i}.
Alias
Device.UPA.Interface.{i}.ActiveNotch.{i}.
Alias
Device.UPA.Interface.{i}.BridgeFor.{i}.
Alias
Device.WiFi.Radio.{i}.
Alias
Device.WiFi.SSID.{i}.
Alias
Device.WiFi.AccessPoint.{i}.
Alias
Device.WiFi.EndPoint.{i}.
Alias
Device.WiFi.EndPoint.{i}.Profile.{i}.
Alias
Device.Bridging.Bridge.{i}.
Alias
Device.Bridging.Bridge.{i}.Port.{i}.
Alias
Device.Bridging.Bridge.{i}.VLAN.{i}.
Alias
Device.Bridging.Bridge.{i}.VLANPort.{i}.
Alias
Device.Bridging.Filter.{i}.
Alias
Device.PPP.Interface.{i}.
Alias
Device.IP.Interface.{i}.
Alias
Device.IP.Interface.{i}.IPv4Address.{i}.
Alias
Device.IP.Interface.{i}.IPv6Address.{i}.
Alias
Device.IP.Interface.{i}.IPv6Prefix.{i}.
Alias
Device.Routing.Router.{i}.
Alias
Device.Routing.Router.{i}.IPv4Forwarding.{i}.
Alias
Device.Routing.Router.{i}.IPv6Forwarding.{i}.
Alias
Device.Routing.RIP.InterfaceSetting.{i}.
Alias
Device.NeighborDiscovery.InterfaceSetting.{i}.
Alias
Device.RouterAdvertisement.InterfaceSetting.{i}.
Alias
Device.RouterAdvertisement.InterfaceSetting.{i}.Option.{i}.
Alias
Device.IPv6rd.InterfaceSetting.{i}.
Alias
Device.DSLite.InterfaceSetting.{i}.
Alias
Device.QoS.Classification.{i}.
Alias
Device.QoS.App.{i}.
Alias
Device.QoS.Flow.{i}.
Alias
Device.QoS.Policer.{i}.
Alias
Device.QoS.Queue.{i}.
Alias
Device.QoS.QueueStats.{i}.
Alias
Device.QoS.Shaper.{i}.
Alias
Device.DNS.Client.Server.{i}.
Alias
Device.DNS.Relay.Forwarding.{i}.
Alias
Device.NAT.InterfaceSetting.{i}.
Alias
Device.NAT.PortMapping.{i}.
Alias
Device.DHCPv4.Client.{i}.
Alias
Device.DHCPv4.Client.{i}.SentOption.{i}.
Alias
Device.DHCPv4.Client.{i}.ReqOption.{i}.
Alias
Device.DHCPv4.Server.Pool.{i}.
Alias
Device.DHCPv4.Server.Pool.{i}.StaticAddress.{i}.
Alias
Device.DHCPv4.Server.Pool.{i}.Option.{i}.
Alias
Device.DHCPv4.Server.Pool.{i}.Client.{i}.
Alias
Device.DHCPv4.Relay.Forwarding.{i}.
Alias
Device.DHCPv6.Client.{i}.
Alias
Device.DHCPv6.Client.{i}.SentOption.{i}.
Alias
Device.DHCPv6.Server.Pool.{i}.
Alias
Device.DHCPv6.Server.Pool.{i}.Client.{i}.
Alias
Device.DHCPv6.Server.Pool.{i}.Option.{i}.
Alias
Device.IEEE8021x.Supplicant.{i}.
Alias
Device.Users.User.{i}.
Alias
Device.SmartCardReaders.SmartCardReader.{i}.
Alias
Device.Firewall.Level.{i}.
Alias
Device.Firewall.Chain.{i}.
Alias
Device.Firewall.Chain.{i}.Rule.{i}.
Alias
Device.PeriodicStatistics.SampleSet.{i}.
Alias
Device.PeriodicStatistics.SampleSet.{i}.Parameter.{i}.
Alias
Device.SoftwareModules.ExecEnv.{i}.
Alias
Device.SoftwareModules.DeploymentUnit.{i}.
Alias
Device.SoftwareModules.ExecutionUnit.{i}.
Alias

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 via AddObject and DeleteObject is REQUIRED.
A Creation of instances of the object via AddObject is REQUIRED, but deletion is not REQUIRED.
D Deletion of instances of the object via DeleteObject is REQUIRED, but creation is not REQUIRED.

Generated by Broadband Forum report.pl#186 (2011/08/03 version) on 2011/09/28 at 17:03:20 (TOOL CURRENTLY CHECKED OUT).
report.pl --report=html --pedantic --lastonly tr-181-2-3-0.xml ...