Broadband Forum

    DATA MODEL DEFINITION


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

License

Copyright (c) 2010-2017, Broadband Forum

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

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

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

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

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

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

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

Summary

TR-069 Device:2.6 Root Object definition

November 2012

TR-181 Issue 2 Amendment 6

Table of Contents

Data Types

The Parameters defined in this specification make use of a limited subset of the default SOAP data types [SOAP1.1]. These data types and the named data types used by this specification are described below.

Note: A Parameter that is defined to be one of the named data types is reported as such at the beginning of the Parameter's description via a reference back to the associated data type definition (e.g. [MacAddress]). However, such parameters still indicate their SOAP data type.

Data Type Base Type Description
Alias string(64)

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

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

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

IP address, i.e. IPv4 address (or IPv4 subnet mask) or IPv6 address.

All IPv4 addresses and subnet masks MUST be represented as strings in IPv4 dotted-decimal notation. Here are some examples of valid IPv4 address textual representations:

  • 216.52.29.100
  • 192.168.1.254

All IPv6 addresses MUST be represented using any of the 3 standard textual representations defined in [RFC4291] Sections 2.2.1, 2.2.2 and 2.2.3. Both lower-case and upper-case letters can be used, but use of lower-case letters is RECOMMENDED. Here are some examples of valid IPv6 address textual representations:

  • 1080:0:0:800:ba98:3210:11aa:12dd
  • 1080::800:ba98:3210:11aa:12dd
  • 0:0:0:0:0:0:13.1.68.3

IPv6 addresses MUST NOT include zone identifiers. Zone identifiers are discussed in [Section 6/RFC4007].

Unspecified or inapplicable addresses (or IPv4 subnet masks) MUST be represented as empty strings unless otherwise specified by the parameter definition.

IPPrefix string(49)

IPv4 or IPv6 routing prefix in Classless Inter-Domain Routing (CIDR) notation [RFC4632]. This is specified as an IP address followed by an appended "/n" suffix, where n (the prefix size) is an integer in the range 0-32 (for IPv4) or 0-128 (for IPv6) that indicates the number of (leftmost) '1' bits of the routing prefix.

  • IPv4 example: 192.168.1.0/24
  • IPv6 example: 2001:edff:fe6a:f76::/64

If the IP address part is unspecified or inapplicable, it MUST be an empty string unless otherwise specified by the parameter definition. In this case the IP prefix will be of the form "/n".

If the entire IP prefix is unspecified or inapplicable, it MUST be an empty string unless otherwise specified by the parameter definition.

base64 -

Base64 encoded binary (no line-length limitation).

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

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

Hex encoded binary.

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

int -

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

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

long -

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

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

object - A container for parameters and/or other objects. The full Path Name of a parameter is given by the parameter name appended to the full Path Name of the object it is contained within.
string - For strings, a minimum and maximum allowed length can be indicated using the form string(Min:Max), where Min and Max are the minimum and maximum string length in characters. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in string(Max). Multiple comma-separated ranges can be specified, in which case the string length will be in one of the ranges.
unsignedInt -

Unsigned integer in the range 0 to 4294967295, inclusive.

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

unsignedLong -

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

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

References

[ETSIM2MFA] ETSI TS 102 690 v1.1.6, Machine-to-Machine Communications (M2M Functional Architecture), ETSI, June 2012.
[ETSIM2MInterfaces] ETSI TS 102 921 v1.1.6, M2M mIa, dIa and mId Interfaces, ETSI, August 2012.
[POSIXBase] ISO/IEC/IEEE 9945, Information technology - Portable Operating System Interface (POSIX) Base Specifications, Issue 7, ISO/IEC/IEEE, September 2009.
[RFC3986] RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-106a5] TR-106 Amendment 5, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2010.

Device:2.6 Data Model (changes)

For a given implementation of this data model, the Agent MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the Agent supports only a single parameter that was introduced in version 2.6, then it will indicate support for version 2.6. 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.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, or with a given value for UUID.

- 2.0
UUID string­(36:36) - [UUID] UUID ([RFC4122]) that is the value of the uuid attribute in the DT Instance referenced by URL. - 2.6
Device.ManagementServer. object - This object contains parameters relating to the CPE's association with an ACS. - 2.0
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
ProxyProtocolReference string - The value MUST be the Path Name of a protocol object that uses the ProxyProtocol. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.6
DiscoveryProtocol string -

Comma-separated list of strings, that represents the discovery protocol(s) for this proxied device.

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

- 2.6
DiscoveryProtocolReference string -

Comma-separated list of strings. Each list item MUST be the Path Name of an object discovered using one or more protocols listed in DiscoveryProtocol. If the referenced object is deleted, the corresponding item MUST be removed from the list.

For objects discovered by the UPnP discovery protocol, the DiscoveryProtocolReference would contain items that are references to instances of the following:

For objects discovered by the ETSI-M2M discovery protocol, the DiscoveryProtocolReference would contain items that are references to instances of ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance.

- 2.6
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
ProxyProtocolReference string - The value MUST be the Path Name of a protocol object that uses the ProxyProtocol. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.6
DiscoveryProtocol string -

Comma-separated list of strings, that represents the discovery protocol(s) for this proxied device.

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

- 2.6
DiscoveryProtocolReference string -

Comma-separated list of strings. Each list item MUST be the Path Name of an object discovered using one or more protocols listed in DiscoveryProtocol. If the referenced object is deleted, the corresponding item MUST be removed from the list.

For objects discovered by the UPnP discovery protocol, the DiscoveryProtocolReference would contain items that are references to instances of the following:

For objects discovered by the ETSI-M2M discovery protocol, the DiscoveryProtocolReference would contain items that are references to instances of ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance.

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

- 2.0
DestIP string­(45) W

[IPAddress] Classification criterion.

Destination IP address. An empty string indicates this criterion is not used for classification.

<Empty> 2.6
DestMask string­(49) W [IPPrefix] Destination IP address mask, represented as an IP routing prefix using CIDR notation [RFC4632]. The IP address part MUST be an empty string (and, if specified, MUST be ignored). <Empty> 2.6
DestIPExclude boolean W

If false, the class includes only those packets that match the (masked) DestIP entry, if specified.

If true, the class includes all packets except those that match the (masked) DestIP entry, if specified.

false 2.6
SourceIP string­(45) W

[IPAddress] Classification criterion.

Source IP address. An empty string indicates this criterion is not used for classification.

<Empty> 2.6
SourceMask string­(49) W [IPPrefix] Source IP address mask, represented as an IP routing prefix using CIDR notation [RFC4632]. The IP address part MUST be an empty string (and, if specified, MUST be ignored). <Empty> 2.6
SourceIPExclude boolean W

If false, the class includes only those packets that match the (masked) SourceIP entry, if specified.

If true, the class includes all packets except those that match the (masked) SourceIP entry, if specified.

false 2.6
Protocol int­[-1:255] W

Classification criterion.

Protocol number. A value of -1 indicates this criterion is not used for classification.

-1 2.6
ProtocolExclude boolean W

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

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

false 2.6
DestPort int­[-1:65535] W

Classification criterion.

Destination port number. A value of -1 indicates this criterion is not used for classification.

-1 2.6
DestPortRangeMax int­[-1:65535] W

Classification criterion.

If specified, indicates the classification criterion is to include the port range from DestPort through DestPortRangeMax (inclusive). If specified, DestPortRangeMax MUST be greater than or equal to DestPort.

A value of -1 indicates that no port range is specified.

-1 2.6
DestPortExclude boolean W

If false, the class includes only those packets that match the DestPort entry (or port range), if specified.

If true, the class includes all packets except those that match the DestPort entry (or port range), if specified.

false 2.6
SourcePort int­[-1:65535] W

Classification criterion.

Source port number. A value of -1 indicates this criterion is not used for classification.

-1 2.6
SourcePortRangeMax int­[-1:65535] W

Classification criterion.

If specified, indicates the classification criterion is to include the port range from SourcePort through SourcePortRangeMax (inclusive). If specified, SourcePortRangeMax MUST be greater than or equal to SourcePort.

A value of -1 indicates that no port range is specified.

-1 2.6
SourcePortExclude boolean W

If false, the class includes only those packets that match the SourcePort entry (or port range), if specified.

If true, the class includes all packets except those that match the SourcePort entry (or port range), if specified.

false 2.6
Device.UPnP. object - This object contains all UPnP related objects and parameters including Device and Discovery related objects and parameters. - 2.0
Device.UPnP.Discovery. object -

UPnP [UPnP-DAv1] SSDP discovered root devices, embedded devices and embedded services.

The CPE MAY, but need not, retain some or all of the information in this object across reboots.

- 2.0
Device.UPnP.Discovery.RootDevice.{i}. object -

UPnP root device table. This table contains an entry for each UPnP root device that has been discovered via SSDP.

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

- 2.0
LastUpdate dateTime - The date and time at which the last advertisement from this RootDevice was received. - 2.6
Device.UPnP.Discovery.Device.{i}. object -

UPnP embedded device table. This table contains an entry for each UPnP embedded device that has been discovered via SSDP.

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

- 2.0
LastUpdate dateTime - The date and time at which the last advertisement from this Device was received. - 2.6
Device.UPnP.Discovery.Service.{i}. object -

UPnP embedded service table. This table contains an entry for each UPnP embedded service that has been discovered via SSDP.

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

- 2.0
LastUpdate dateTime - The date and time at which the last advertisement from this Service was received. - 2.6
ParentDevice string­(256) - The value MUST be the Path Name of the RootDevice or Device table entries that embeds this Service. If the referenced object is deleted, the parameter value MUST be set to an empty string. This parameter is populated by extracting the "device-UUID" from the service's USN and matching the value against the root device or embedded device UUID value. - 2.6
Device.UPnP.Description. object - This object contains information from the Description Document discovered from the UPnP Devices and Services. - 2.6
DeviceDescriptionNumberOfEntries unsignedInt - The number of entries in the DeviceDescription table. - 2.6
DeviceInstanceNumberOfEntries unsignedInt - The number of entries in the DeviceInstance table. - 2.6
ServiceInstanceNumberOfEntries unsignedInt - The number of entries in the ServiceInstance table. - 2.6
Device.UPnP.Description.DeviceDescription.{i}. object -

This table contains information read from the Device Description Document of discovered root devices.

The CPE MAY, but need not, retain some or all of the information in this table after the associated SSDP advertisement (objects in the UPnP.Discovery. object tables) expires.

In case the SSDP advertisement expires and the CPE deletes the related instances from the tables in UPnP.Discovery., the reference to such instances MUST be set to the empty string.

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

- 2.6
URLBase string­(256) -

The value extracted from the URLBase element in the Device Description Document of the discovered root device. If the URLBase element in the root device's Device Description Document is empty or absent, the URL from which the device description was retrieved (e.g. the LOCATION from the SSDP message) is utilized as the URLBase.

Note: the URLBase element is not recommended by [UPnP-DAv1] and is not permitted by [UPnP-DAv11], so the value of URLBase will usually be the URL from which the device description was retrieved.

- 2.6
SpecVersion string­(256) -

The UPnP Device Architecture version extracted from the specVersion element in the Device Description Document of the discovered root device. The SpecVersion is encoded as "major revison.minor revision". Possible patterns:

- 2.6
Host string­(1024) - Comma-separated list (maximum list length 1024) of strings (maximum item length 256). Each list item MUST be the Path Name of the Host table entries associated with the root device from which the device description was retrieved. If the referenced object is deleted, the corresponding item MUST be removed from the list. - 2.6
Device.UPnP.Description.DeviceInstance.{i}. object -

This table contains the information from Device Description Document retrieved for a discovered UPnP root or embedded device.

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

- 2.6
UDN string­(36:36) -

[UUID] Unique Device Name of this device represented as a UUID for the device.

This value is extracted from the UDN element in the Device Description Document with the leading uuid: removed.

- 2.6
ParentDevice string­(256) - The value MUST be the Path Name of a DeviceInstance table entry (if this is an embedded device) or an empty string (if this is a root device). If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.6
DiscoveryDevice string­(256) -

The value MUST be the Path Name of a Discovery.RootDevice table entry (if this is a root device) or a Discovery.Device table entry (if this is an embedded device). If the referenced object is deleted, the parameter value MUST be set to an empty string.

This DiscoveryDevice value can be an empty string because the referenced object has been deleted or the CPE was unable to retrieve the Description Document due to some out-of-band error. The determination to delete this DeviceInstance or use an empty string is implementation specific.

- 2.6
DeviceType string­(256) - The value of the UPnP deviceType element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 2.6
FriendlyName string­(128) - The value of the UPnP friendlyName element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 2.6
Manufacturer string­(128) - The value of the UPnP manufacturer element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 2.6
ManufacturerURL string­(256) - The value of the UPnP manufacturerURL element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 2.6
ModelDescription string­(256) - The value of the UPnP modelDescription element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 2.6
ModelName string­(64) - The value of the UPnP modelName element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 2.6
ModelNumber string­(64) - The value of the UPnP modelNumber element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 2.6
ModelURL string­(256) - The value of the UPnP modelURL element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 2.6
SerialNumber string­(128) - The value of the UPnP serialNumber element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 2.6
UPC string­(12) - The value of the UPnP UPC element in the Device Description Document for this DeviceInstance, or an empty string if this value is not provided by the device. - 2.6
PresentationURL string­(256) -

The value of the UPnP presentationURL element in the Device Description Document for this DeviceInstance and MUST be an absolute URL.

The way to obtain an absolute URL from the presentationURL element is specified in [UPnP-DAv1] and [UPnP-DAv11].

If the presentationURL is not provided by the device then this value MUST be an empty string.

- 2.6
Device.UPnP.Description.ServiceInstance.{i}. object -

This table contains the information from Device Description Document retrieved for a discovered UPnP service.

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

- 2.6
ParentDevice string­(256) - The value MUST be the Path Name of a DeviceInstance table entry. If the referenced object is deleted, the parameter value MUST be set to an empty string. - 2.6
ServiceId string­(256) -

The value of the UPnP serviceId element in the Device Description Document for this ServiceInstance, or an empty string if this value is not provided by the service.

If the UPnP serviceId is not provided by the UPnP service, this ServiceInstance MUST be deleted.

- 2.6
ServiceDiscovery string­(256) -

The value MUST be the Path Name of a Discovery.Service table entry. If the referenced object is deleted, the parameter value MUST be set to an empty string.

This ServiceDiscovery value can be an empty string because the referenced object has been deleted or the CPE was unable to retrieve the Description Document due to some out-of-band error. The determination to delete this ServiceInstance or use an empty string is implementation specific.

- 2.6
ServiceType string­(256) - The value of the UPnP serviceType element in the Device Description Document for this ServiceInstance, or an empty string if this value is not provided by the service. - 2.6
SCPDURL string -

The value of the UPnP SCPDURL element in the Device Description Document for this ServiceInstance and MUST be an absolute URL.

The way to obtain an absolute URL from the SCPDURL element is specified in [UPnP-DAv1] and [UPnP-DAv11].

If the SCPDURL is not provided by the device then this value MUST be an empty string.

- 2.6
ControlURL string -

The value of the UPnP controlURL element in the Device Description Document for this ServiceInstance and MUST be an absolute URL.

The way to obtain an absolute URL from the controlURL element is specified in [UPnP-DAv1] and [UPnP-DAv11].

If the controlURL is not provided by the device then this value MUST be an empty string

- 2.6
EventSubURL string -

The value of the UPnP eventSubURL element in the Device Description Document for this ServiceInstance and MUST be an absolute URL.

The way to obtain an absolute URL from the eventSubURLL element is specified in [UPnP-DAv1] and [UPnP-DAv11].

If the eventSubURL is not provided by the device then this value MUST be an empty string

- 2.6
Device.ETSIM2M. object - The ETSIM2M object represents the management object for the Remote Entity Functions (REM) functions defined in the M2M Functional Architecture [ETSIM2MFA]. - 2.6
SCLNumberOfEntries unsignedInt - The number of entries in the SCL table. - 2.6
Device.ETSIM2M.SCL.{i}. object W

This object represents an instance of a Service Capability Layer (SCL) for a M2M device or gateway.

The SCL MAY be maintained by the ACS or by the CPE.

When the SCL provides the administration of an SCL that is represented as a SoftwareModules.ExecutionUnit the SCL is maintained in the SoftwareModules.ExecutionUnit.{i}.References parameter.

Section 5.1.2 of the M2M Functional Architecture [ETSIM2MFA] describes the high level event flows for SCL registration.

Section 9.3.2.6.2 of the M2M Functional Architecture [ETSIM2MFA] describes the creation/registration of SCLs.

Section 9.3.2.6.4 of the M2M Functional Architecture [ETSIM2MFA] describes the update/re-registration of SCLs.

Section 9.3.2.6.5 of the M2M Functional Architecture [ETSIM2MFA] describes the deletion/deregistration of SCLs.

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

- 2.6
Enable boolean W Administratively enables or disables this instance. false 2.6
Alias string­(64) W

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

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

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

Comma-separated list of strings. The list represents an unordered set of URIs [RFC3986].

A list item is a URI string that represents a SCL to which the this SCL will announce original (local) resources.

The AnnouncedToSCL has an interest in the discovery of the local resource. Section 9.2.1.14 Announced Resource of the M2M Functional Architecture [ETSIM2MFA] provides a description of this behavior of an Announced Resource.

Section 9.3.2.28 of the M2M Functional Architecture [ETSIM2MFA] and Section 10.3.2.7 of the M2M mIa, dIa and mId Interfaces [ETSIM2MInterfaces] describes the process of announcing and deannouncing of resources within a SCL.

- 2.6
SAFPolicySetNumberOfEntries unsignedInt - The number of entries in the SAFPolicySet table. - 2.6
AreaNwkInstanceNumberOfEntries unsignedInt - The number of entries in the AreaNwkInstance table. - 2.6
AreaNwkDeviceInfoInstanceNumberOfEntries unsignedInt - The number of entries in the AreaNwkDeviceInfoInstance table. - 2.6
Device.ETSIM2M.SCL.{i}.Discovery. object -

This object is represents the administration properties used when a NSCL requests discovery of resources within this SCL instance.

Section 9.3.2.27 of the M2M Functional Architecture [ETSIM2MFA] describes the process of discovery of resources within a SCL.

- 2.6
MaxNumberOfDiscovRecords unsignedInt W

The maximum number of URIs [RFC3986] for discovered resources contained in a discovery result.

This parameter and the MaxSizeOfDiscovAnswer parameter are mutually exclusive in that a result can be limited due to the bounds of either parameter.

A value of 0 indicates that the SCL does not have a limit for this parameter.

- 2.6
MaxSizeOfDiscovAnswer unsignedInt W

The maximum size in bytes of the Discovery Answer.

This parameter and the MaxNumberOfDiscovRecords parameter are mutually exclusive in that a result can be limited due to the bounds of either parameter.

A value of 0 indicates that the SCL does not have a limit for this parameter.

- 2.6
Device.ETSIM2M.SCL.{i}.Reregistration. object - This object represents the properties and status necessary for a SCL to reregister with one or more NSCLs. - 2.6
RegTargetNSCLList string W

Comma-separated list of strings. The list represents a priority ordered set of URIs [RFC3986]. The item that is first in the list has the highest priority.

A list item is a URI [RFC3986] string that represents a NSCL that this SCL instance can use in order to attempt registration.

When modified the contents of this parameter replace the RegTargetNSCLList received during the bootstrap procedure.

- 2.6
RegSearchStrings string W

Comma-separated list of strings. The list represents the string tokens used as keys when searching for this SCL instance.

Sections 9.2.3.6.2 and 9.2.3.6.4 of the M2M Functional Architecture [ETSIM2MFA] describe the usage for this parameter.

- 2.6
RegAccessRightID string W URI [RFC3986] that represents the identifier of the access right resource. The value of this parameter is maintained by the NSCL and used by the SCL as a default access right identifier for re-registration to NSCLs. - 2.6
RegExpirationDuration int W The duration, in seconds, that the SCL will use in its next re-registration attempt. Any negative value represents an infinite duration. -1 2.6
Reregistration boolean W The value of this parameter is not part of the device configuration and is always false when read. When set to true, triggers an immediate re-registration action where the SCL re-registers with the SCLs in the RegTargetNSCLList . - 2.6
Device.ETSIM2M.SCL.{i}.Reregistration.ActionStatus. object - This object represents the status of the Reregistration action. - 2.6
Progress unsignedInt­[0:100] - The progress, in percent, of the Reregistration action. The progress is measured from 0-100%. A value of 0 indicates that the action has not started. A value of 100 indicates that the action has completed. - 2.6
FinalStatus string -

The completion status of the Reregistration operation. Enumeration of:

- 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}. object W

This object describes the parameters necessary to administer the store-and-forward (SAF) handling policies applied to requests to access remotely hosted resources.

Policies are described by instances of SAFPolicySet. Which instances of SAFPolicySet are used by the SCL is determined by the PolicyScope parameter.

Section 9.3.1.5 of the M2M Functional Architecture [ETSIM2MFA] and Section 10.3.1.2.2 of the M2M mIa, dIa and mId Interfaces [ETSIM2MInterfaces] describe the behavior for SAF processing.

There is at most one SAFPolicySet instance with the PolicyScope containing a specific application id (APP-ID) URI value within the list.

There is exactly one SAFPolicySet instance with a PolicyScope value of "default".

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

- 2.6
Enable boolean W Administratively enables or disables this instance. false 2.6
Alias string­(64) W

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

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

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

Comma-separated list of strings. The parameter defines the scope of the policies contained in this instance of a SAFPolicySet.

The parameter value is:

  • a list of unordered set of URIs [RFC3986] that represents an M2M application id (APP-ID)
  • the value of "default"
  • an empty string

When this parameter is set to a list of application id (APP-ID) URIs [RFC3986], the scope indicates that the policies are applicable to requests coming from any specific application on that list.

When this parameter is set to a string with the value "default", the scope indicates that the policies are the default policies for this SCL instance.

When this parameter is set to an empty string, the value represents an unknown SAFPolicySet and the SAFPolicySet is not to be used.

<Empty> 2.6
ANPPolicyNumberOfEntries unsignedInt - The number of entries in the ANPPolicy table. - 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.ANPPolicy.{i}. object W

This table contains the SAF-handling policies which are controlled by the Access Network Provider(s).

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

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

- 2.6
Enable boolean W Administratively enables or disables this instance. false 2.6
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.6
ANName string W This parameter is the name of the access network provider and used to determine for which access network the policies defined in the ANPPolicy table will apply. <Empty> 2.6
BlockPeriodNumberOfEntries unsignedInt - The number of entries in the BlockPeriod table. - 2.6
RequestCategoryNumberOfEntries unsignedInt - The number of entries in the RequestCategory table. - 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.ANPPolicy.{i}.BlockPeriod.{i}. object W

This table contains a list of block periods for a ANPPolicy.

A block period defines how long the device will wait before re-trying to establish connectivity via the access network after the previous attempt has failed.

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

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

- 2.6
Enable boolean W Administratively enables or disables this instance. false 2.6
Alias string­(64) W

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

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

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

Number of consecutively failed access attempts for which the BlockDuration will be used to block the next access attempt.

The SCL will apply the BlockPeriod entry with the largest number of consecutive failed attempts that is smaller or equal to the actual number of consecutive failed attempts.

0 2.6
BlockDuration int W The duration, in seconds, to which to block further access attempts. 0 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.ANPPolicy.{i}.RequestCategory.{i}. object W

This table contains the Request Category (RCAT) policy items for defining when it is appropriate to use the access network for processing requests.

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

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

- 2.6
Enable boolean W Administratively enables or disables this instance. false 2.6
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.6
RCAT string W An RCAT is a string that represents a request category used for policy enforcement. - 2.6
ScheduleNumberOfEntries unsignedInt - The number of entries in the Schedule table. - 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.ANPPolicy.{i}.RequestCategory.{i}.Schedule.{i}. object W

This table contains the schedules that define when it is appropriate to use the access network for processing requests for the specified value of the RCAT.

The combination of all instances of the AbsTimeSpan along with the Schedules parameter makes up the complete schedule for this instance of a Schedule.

The Schedules parameter defines a recurrence of the schedule. If instances of AbsTimeSpan exist, these instances places constraints on the schedule recurrence.

If the value of the Schedules parameter is an empty string, at least one enabled instance of AbsTimeSpan MUST exist.

Processing behavior for the use of RCAT Schedules is defined in section 10.3.1.2.2 of the M2M mIa, dIa and mId Interfaces [ETSIM2MInterfaces] document.

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

- 2.6
Enable boolean W Administratively enables or disables this instance. false 2.6
Alias string­(64) W

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

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

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

Comma-separated list of strings. The list is a set of schedule strings.

A schedule string is formatted according to the date and time fields defined CRONTAB input file definition in [POSIXBase].

The Schedules parameter is used to set the recurrence of the schedule.

The timezone used for this parameter is dependent upon the existence of instances of AbsTimeSpan for this Schedule. If instances of AbsTimeSpan exist, then the timezone of the AbsTimeSpan is used otherwise the UTC timezone is used for this Schedules parameter.

Note the command field is not used in this definition and any whitespace or comma characters within a Schedule string MUST be escaped using percent as defined in [Section 3.2.3/TR-106a5]

Example of CRONTAB string:

  • "* 0-6 * * 1-5" would mean every minute for the period from 0:00h to 6:00h (inclusive) on any week day (Monday through Friday) and would be represented as "*%200-6%20*%20*%201-5"
  • "*/15 22-23,0-4 * * 1-5" would mean every 15 minutes for the period from 22:00h to 04:00h on any week day (Monday through Friday) and would be represented as "*/15%2022-23%2C0-4%20*%20*%201-5"
<Empty> 2.6
AbsTimeSpanNumberOfEntries unsignedInt - The number of entries in the AbsTimeSpan table. - 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.ANPPolicy.{i}.RequestCategory.{i}.Schedule.{i}.AbsTimeSpan.{i}. object W

This object defines an instance of a time span used for determining an RCAT schedule.

An instance of the AbsTimeSpan represents the time span in which the schedule recurrence defined in Schedules is constrained.

AbsTimeSpan instances with unknown values for the StartTime or EndTime are ignored.

All instances of the AbsTimeSpan within this Schedule MUST utilize the same time zone.

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

- 2.6
Enable boolean W Administratively enables or disables this instance. false 2.6
Alias string­(64) W

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

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

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

Date and time that represents the start of the time span.

The value 0001-01-01T00:00:00Z represents an unknown value.

The device MUST reject requests to set the StartTime value greater than the EndTime value.

0001-01-01T00:00:00Z 2.6
EndTime dateTime W

Date and time that represents the end of the time span.

The value 9999-12-31T23:59:59Z represents an infinite time span from the start time.

The value 0001-01-01T00:00:00Z represents an unknown value.

The device MUST reject requests to set the EndTime value less than or equal the StartTime value.

0001-01-01T00:00:00Z 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.M2MSPPolicy. object - This object maintains the SAF handling policies' properties that are controlled by the M2M service provider for a request. - 2.6
DefaultRCATValue string W The default RCAT value to use for requests to remotely hosted resources during SAF-handling when no RCAT value was specified in the request. <Empty> 2.6
RequestCategoryNumberOfEntries unsignedInt - The number of entries in the RequestCategory table. - 2.6
Device.ETSIM2M.SCL.{i}.SAFPolicySet.{i}.M2MSPPolicy.RequestCategory.{i}. object W

This object maintains a list of properties to be used for forwarding requests with a specified RCAT.

Processing behavior for the use of M2M Service Provider policies is defined in section 10.3.1.2.2.1 of the M2M mIa, dIa and mId Interfaces [ETSIM2MInterfaces] document.

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

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

- 2.6
Enable boolean W Administratively enables or disables this instance. false 2.6
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 2.6
RCAT string W An RCAT is a string that represents a request category used for policy enforcement. - 2.6
TolerableDelay int­[-1:] W

The tolerable duration, in seconds, that a request of the given RCAT category can be pending in SAF handling when a request from an M2M Application does not specify a tolerable delay.

A value of -1 represents an infinite duration.

0 2.6
Thresh unsignedInt W

The threshold of maximum number of pending requests permitted to be held for a specified RCAT.

A value of 0 indicates that the request should be transmitted immediately.

0 2.6
Mem string W

This parameter defines the maximum size of the request queue for pending requests permitted to be held for a specified RCAT.

The format of the string is an integer with an appended memory unit (B - Bytes, K - 1024 Bytes, M - 1048576 Bytes, G -1073741824, T - 1099511627776 Bytes).

When the value is an empty string the memory threshold criteria for the associated RCATList will be ignored in SAF handling.

- 2.6
RankedANList string W Comma-separated list of strings. Each list item MUST be the Path Name of a row in the ANPPolicy table. If the referenced object is deleted, the corresponding item MUST be removed from the list. The list is a prioritized set of Access Networks where the preference of using an Access Network is based on order of the list items with the lowest order list item as the most preferred Access Network. <Empty> 2.6
Device.ETSIM2M.SCL.{i}.AreaNwkInstance.{i}. object -

The M2M Area Network information provides administration capabilities for remote management (REM) of M2M Devices (D', d) that are attached to this SCL instance.

This object provides the administration of the properties needed by the SCL to remotely manage M2M Devices within a specific type of M2M Area network as defined by AreaNwkType.

Multiple instances of AreaNwkInstance with the same AreaNwkType is permitted.

Section 5.3.5 of the M2M Functional Architecture [ETSIM2MFA] describes the REM functionality expected of a SCL for an M2M Device.

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

- 2.6
ID string - URI [RFC3986] that represents the identifier of the instance. - 2.6
AreaNwkType string - Devices (D' and d) that connect to an SCL are said to be "attached devices" and are organized by M2M Area Networks within the SCL instance. The AreaNwkType is an implementation-chosen string that indicates the type of M2M Area Network. - 2.6
ListOfDevices string -

Comma-separated list of strings. Each list item MUST be the Path Name of a row in the AreaNwkDeviceInfoInstance table, or an empty string.

The list represents the M2M Devices (D', d) that are attached to this SCL instance that are within this AreaNwkInstance instance. The list does not contain an instance for this CPE.

- 2.6
PropertyNumberOfEntries unsignedInt - The number of entries in the Property table. - 2.6
Device.ETSIM2M.SCL.{i}.AreaNwkInstance.{i}.Property.{i}. object -

This object contains an instance of a property extension (name value pair) for this AreaNwkInstance instance.

For example, if the AreaNwkType is ZigBee the AreaNwkInstance will contain ZigBee specific parameters that have not been modeled for the M2M Area network.

At a minimum, a property instance MUST exist that defines an attribute that describes the IP layer address type (e.g., IPv4, IPv6, non-IP) of this M2M Area Network.

- 2.6
Name string - The name of the property - 2.6
Value string - The value of the property. - 2.6
Device.ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance.{i}. object -

The M2M Area Network Device Information provides the administration capability to the SCL for maintenance of M2M Devices (D', d) that are attached to this SCL instance.

While discovery and identification of devices by the M2M Gateway or Device (CPE) is implementation specific, each device is represented by an instance of the Hosts.Host table.

When the M2M Device is managed by the CWMP endpoint of the CPE, the AreaNwkDeviceInfoInstance is expected to be referenced by an instance of one of the following tables:

Section 5.3.5 of the M2M Functional Architecture [ETSIM2MFA] describes the REM functionality expected of a SCL to a M2M Device.

This object instance provides the administration properties required by a SCL to remotely manage an instance of a M2M Device within a M2M area network.

A M2M Device is associated with an instance of a AreaNwkInstance.

This table contains parameters and information of the M2M Device related to each AreaNwkInstance instance.

Instances of this table are created and deleted by the CPE. The ACS MAY modify the writeable parameters of this object instance but it is possible that the value set by the ACS is not retained between reboots of the M2M Device.

- 2.6
AreaNwkInstance string - The value MUST be the Path Name of a row in the AreaNwkInstance table. - 2.6
Host string - Comma-separated list of strings. Each list item MUST be the Path Name of the Hosts.Host table entry that represents an active or inactive M2M Device. If the referenced object is deleted, the corresponding item MUST be removed from the list. - 2.6
ListOfDeviceNeighbors string - Comma-separated list 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 represent the reachable neighbors of this M2M Device (D' or d). - 2.6
ListOfDeviceApplications string -

Comma-separated list of strings. The list is an unordered set of URIs [RFC3986].

A list item is an URI string that represents an application id (APP-ID) for the M2M D'A applications residing on the M2M Device for the associated AreaNwkInstance.

Table B.58 of the M2M Functional Architecture [ETSIM2MFA] describes this parameter.

- 2.6
SleepInterval unsignedInt W

The interval, in seconds, between sleep periods for the device.

A value of 0 represents a device that does not sleep.

Note: When this value is modified, the CPE could modify the SleepInterval for this M2M Device in other Area Networks.

- 2.6
SleepDuration unsignedInt W

The duration, in seconds, of a sleep period.

The value 0 represents an unknown value.

Note: When this value is modified, the CPE could modify the SleepDuration for this M2M Device in other Area Networks.

- 2.6
Status string -

The sleep status of the device.

Enumeration of:

- 2.6
Active boolean -

Whether or not this M2M Device is currently attached to this SCL instance.

The ability to list inactive M2M Devices is OPTIONAL. If the CPE includes inactive M2MDevices in this table, Active is set to false for each inactive M2M Device. The length of time an inactive M2M Device remains listed in this table is a local matter to the CPE.

- 2.6
PropertyNumberOfEntries unsignedInt - The number of entries in the Property table. - 2.6
Device.ETSIM2M.SCL.{i}.AreaNwkDeviceInfoInstance.{i}.Property.{i}. object -

This object contains an instance of a property extension (name value pair) for this AreaNwkDeviceInfoInstance instance.

For example, if the AreaNwkInstance.{i}.AreaNwkType value is ZigBee, this AreaNwkDeviceInfoInstance contains ZigBee-specific parameters that are not formally modeled for this AreaNwkDeviceInfoInstance instance.

- 2.6
Name string - The name of the property - 2.6
Value string - The value of the property. - 2.6

Inform and Notification Requirements

Forced Inform Parameters

Parameter

Forced Active Notification Parameters

Parameter

Default Active Notification Parameters

Parameter

Parameters for which Active Notification MAY be Denied

Parameter
Device.ETSIM2M.SCL.{i}.Reregistration.ActionStatus.
Progress

Profile Definitions

Notation

The following abbreviations are used to specify profile requirements:

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

SupportedDataModel:2 Profile

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

Name Requirement
Device.­DeviceInfo.­SupportedDataModel.­{i}. P
UUID R

UPnPDiscAdv:2 Profile

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

Name Requirement
Device.­UPnP.­Discovery.­Device.­{i}. P
LastUpdate R
Host R
Device.­UPnP.­Discovery.­Service.­{i}. P
LastUpdate R
Host R
ParentDevice R

DNS_SD:1 Profile

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

Name Requirement
Device.­DNS.­SD. P
Enable W
ServiceNumberOfEntries R
Device.­DNS.­SD.­Service.­{i}. P
InstanceName R
ApplicationProtocol R
TransportProtocol R
Domain R
Port R
Target R
Priority R
Weight R
TimeToLive R
Status R
LastUpdate R
Host R
TextRecordNumberOfEntries R
Device.­DNS.­SD.­Service.­{i}.­TextRecord.­{i}. P
Key R
Value R

ETSIM2MSCLBaseline:1 Profile

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

Name Requirement
Device.­ETSIM2M.­SCL.­{i}. C
Enable W
AnnouncedToSCLList W
SAFPolicySetNumberOfEntries R
AreaNwkInstanceNumberOfEntries R
AreaNwkDeviceInfoInstanceNumberOfEntries R
Device.­ETSIM2M.­SCL.­{i}.­Discovery. P
MaxNumberOfDiscovRecords W
MaxSizeOfDiscovAnswer W
Device.­ETSIM2M.­SCL.­{i}.­Reregistration. P
RegTargetNSCLList W
RegSearchStrings W
RegAccessRightID W
RegExpirationDuration W
Device.­ETSIM2M.­SCL.­{i}.­Reregistration.­ActionStatus. P
Progress R
FinalStatus R
Device.­ETSIM2M.­SCL.­{i}.­SAFPolicySet.­{i}. C
Enable W
PolicyScope W
ANPPolicyNumberOfEntries R
Device.­ETSIM2M.­SCL.­{i}.­SAFPolicySet.­{i}.­ANPPolicy.­{i}. C
Enable W
ANName W
BlockPeriodNumberOfEntries R
RequestCategoryNumberOfEntries R
Device.­ETSIM2M.­SCL.­{i}.­SAFPolicySet.­{i}.­ANPPolicy.­{i}.­BlockPeriod.­{i}. C
Enable W
FailedAttempts W
BlockDuration W
Device.­ETSIM2M.­SCL.­{i}.­SAFPolicySet.­{i}.­ANPPolicy.­{i}.­RequestCategory.­{i}. C
Enable W
RCAT W
ScheduleNumberOfEntries R
Device.­ETSIM2M.­SCL.­{i}.­SAFPolicySet.­{i}.­ANPPolicy.­{i}.­RequestCategory.­{i}.­Schedule.­{i}. C
Enable W
Schedules W
AbsTimeSpanNumberOfEntries R
Device.­ETSIM2M.­SCL.­{i}.­SAFPolicySet.­{i}.­ANPPolicy.­{i}.­RequestCategory.­{i}.­Schedule.­{i}.­AbsTimeSpan.­{i}. C
Enable W
StartTime W
EndTime W
Device.­ETSIM2M.­SCL.­{i}.­SAFPolicySet.­{i}.­M2MSPPolicy. P
DefaultRCATValue W
RequestCategoryNumberOfEntries R
Device.­ETSIM2M.­SCL.­{i}.­SAFPolicySet.­{i}.­M2MSPPolicy.­RequestCategory.­{i}. C
Enable W
RCAT W
TolerableDelay W
Thresh W
Mem W
RankedANList W
Device.­ETSIM2M.­SCL.­{i}.­AreaNwkInstance.­{i}. P
ID R
AreaNwkType R
ListOfDevices R
Device.­ETSIM2M.­SCL.­{i}.­AreaNwkDeviceInfoInstance.­{i}. P
AreaNwkInstance R
Host R
ListOfDeviceNeighbors R
ListOfDeviceApplications R
SleepInterval W
SleepDuration W
Status R
Active R

BridgeL3L4Filter:1 Profile

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

Name Requirement
Device.­Bridging.­Filter.­{i}. C
DestIP W
DestMask W
DestIPExclude W
SourcePort W
SourcePortRangeMax W
SourceIP W
SourceMask W
SourceIPExclude W
SourcePortExclude W
Protocol W
ProtocolExclude W
DestPort W
DestPortExclude W


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