Broadband Forum

Component Objects for CWMP
tr-157-1-7-0.xml

DATA MODEL DEFINITION

License

Copyright (c) 2009-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

Component Objects for CWMP

November 2012

TR-157 Amendment 7

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

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

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

string - For strings, a minimum and maximum allowed length can be indicated using the form string(Min:Max), where Min and Max are the minimum and maximum string length in characters. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in string(Max). Multiple comma-separated ranges can be specified, in which case the string length will be in one of the ranges.
unsignedInt -

Unsigned integer in the range 0 to 4294967295, inclusive.

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

Alias string(64)

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

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

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

Universally Unique Identifier. See [RFC4122]. Possible patterns:

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

References

[DNS-SD] RFC 6763, DNS-Based Service Discovery, IETF, 2013.
[ETSIM2MFA] ETSI TS 102 690 v1.1.6, Machine-to-Machine Communications (M2M Functional Architecture), ETSI, June 2012.
[IPDR-FTP] IPDR File Transfer Protocol, IPDR/File Transfer Protocol, TM Forum.
[IPDR-SP] IPDR Streaming Protocol, IPDR Streaming Protocol (IPDR/SP) Specification, TM Forum.
[IPDR-XDR] IPDR XDR Encoding Format, IPDR/XDR Encoding Format, TM Forum.
[IPDR-XML] IPDR XML File Encoding Format, IPDR/XML File Encoding Format, TM Forum.
[OUI] Organizationally Unique Identifiers (OUIs).
[RFC1035] RFC 1035, Domain Names - Implementation and Specification, IETF, 1987.
[RFC2616] RFC 2616, Hypertext Transfer Protocol -- HTTP/1.1, IETF, 1999.
[RFC2782] RFC 2782, A DNS RR for specifying the location of services (DNS SRV), IETF, 2000.
[RFC2818] RFC 2818, HTTP Over TLS, IETF, May 2000.
[RFC3986] RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF.
[RFC4122] RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-069] TR-069 Amendment 6, CPE WAN Management Protocol, Broadband Forum, April 2018.
[TR-069a2] TR-069 Amendment 2, CPE WAN Management Protocol, Broadband Forum, December 2007.
[TR-069a4] TR-069 Amendment 4, CPE WAN Management Protocol, Broadband Forum, July 2011.
[TR-106a2] TR-106 Amendment 2, Data Model Template for TR-069-Enabled Devices, Broadband Forum, November 2008.
[TR-106a3] TR-106 Amendment 3, Data Model Template for TR-069-Enabled Devices, Broadband Forum, September 2009.
[TR-106a6] TR-106 Amendment 6, Data Model Template for TR-069-Enabled Devices, Broadband Forum, July 2011.
[TR-232] TR-232, Bulk Data Collection, Broadband Forum, May 2012.
[UPnP-DAv1] UPnP Device Architecture, UPnP Device Architecture 1.0, UPnP Forum, April 2008.
[UPnP-DAv11] UPnP Device Architecture 1.1, UPnP Device Architecture 1.1, UPnP Forum, October, 2008.
[UPnP-DM:1] UPnP Device Management:1, UPnP Device Management v1.
[Z-Wave] Z-Wave, Z-Wave website.
[ZigBee] ZigBee, ZigBee Alliance website.

Legend

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

TR-157:1.7 Data Model

For a given implementation of this data model, the Agent MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the Agent supports only a single parameter that was introduced in version 1.7, then it will indicate support for version 1.7. The version number associated with each object and parameter is shown in the Version column.

Name Type Syntax Write Description Object Default Version Spec
PeriodicStatistics. object object​[1:1] -

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.

- 1.0 TR-157
MinSampleInterval unsignedInt unsignedInt -

Minimum sample interval in seconds that the CPE is able to support.

A value of 0 indicates no specific minimum sample interval.

- 1.0 TR-157
MaxReportSamples unsignedInt unsignedInt -

Maximum number of samples of each statistic that the CPE is able to store and report.

A value of 0 indicates no specific maximum number of samples.

- 1.0 TR-157
SampleSetNumberOfEntries unsignedInt unsignedInt - The number of entries in the SampleSet table. - 1.0 TR-157
TR-157a2
PeriodicStatistics.​SampleSet.​{i}. object​[0:] object​[0:∞] W

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

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias.

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

- 1.0 TR-157
Alias string​(64) Alias W

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

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

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

The Agent MUST choose an initial value that doesn't conflict with any existing entries.

- 1.0 TR-157a4
Enable boolean boolean W

Enables or disables collection of periodic statistics for this sample set.

When collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately.

false 1.0 TR-157
Status string string -

Indicates availability of Sample statistics. Enumeration of:

  • Disabled (Collection is disabled)
  • Enabled (Collection is enabled)
  • Trigger (Collection is enabled and the ACS SHOULD now fetch the collected data)

The Trigger value is only used for triggering the ACS to fetch the collected data and can only be used when FetchSamples is in the range [1:ReportSamples].

The transition from Enabled to Trigger to Enabled MUST be instantaneous and so will result in only a single value change for notification purposes.

"Disabled" 1.0 TR-157
Name string​(128) string​(128) W The name of this sample set, which uniquely distinguishes each sample set. <Empty> 1.0 TR-157
SampleInterval unsignedInt​(1:) unsignedInt​(1:) W

The sample interval in seconds. Each statistic is measured over this sample interval.

The CPE MAY reject a request to set SampleInterval to less than PeriodicStatistics.MinSampleInterval?.

Sample intervals MUST begin every SampleInterval seconds, with no delay between samples.

If SampleInterval is changed while collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately.

For example, if ReportSamples is 24 and SampleInterval is 3600 (an hour), the CPE can store up to a day's worth of samples for each statistic.

3600 1.0 TR-157
ReportSamples unsignedInt​(1:) unsignedInt​(1:) W

The number of samples that the CPE will store and report for each statistic.

The CPE MUST permit ReportSamples to be set to at least PeriodicStatistics.MaxReportSamples?.

If ReportSamples is changed while collection of periodic statistics is enabled, the CPE will truncate or extend its statistics buffers as appropriate, but statistics collection MUST NOT otherwise be affected.

For example, if ReportSamples is 24 and SampleInterval is 3600 (an hour), the CPE can store up to a day's worth of samples for each statistic.

24 1.0 TR-157
TimeReference dateTime dateTime W

An absolute time reference in UTC to determine when sample intervals will complete. Each sample interval MUST complete at this reference time plus or minus an integer multiple of SampleInterval.

TimeReference is used only to set the "phase" of the sample and fetch intervals. The actual value of TimeReference can be arbitrarily far into the past or future.

This time reference also determines when the Status Enabled to Trigger to Enabled transitions that are controlled by FetchSamples will occur. If collection of periodic statistics is enabled and FetchSamples is in the range [1:ReportSamples] then each such Status transition MUST occur at this reference time plus or minus an integer multiple of FetchSamples * SampleInterval (the fetch interval).

If TimeReference is changed while collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately.

The Unknown Time value defined in [TR-106a2] indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and is required only to adhere to the specified sample and fetch intervals.

If absolute time is not available to the CPE, its sample and fetch interval behavior MUST be the same as if the TimeReference parameter was set to the Unknown Time value.

For example, if SampleInterval is 3600 (an hour) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then sample intervals will complete on each UTC hour (00:00, 01:00, 02:00 etc).

If, in addition, FetchSamples is 24, then the fetch interval is 86400 (a day) and Status Enabled to Trigger to Enabled transitions will occur every day at UTC midnight.

Note that, if TimeReference is set to a time other than the Unknown Time, the first sample interval (which has to begin immediately) will almost certainly be shorter than SampleInterval). This is why TimeReference is defined in terms of when sample intervals complete rather than start.

0001-01-01T00:00:00Z 1.0 TR-157
FetchSamples unsignedInt unsignedInt W

The number of sample intervals to be collected before transitioning Status from Enabled to Trigger to Enabled.

If this SampleSet is enabled and FetchSamples is in the range [1:ReportSamples] then Status MUST transition from Enabled to Trigger to Enabled on completion of every FetchSamples sample intervals. Otherwise, the transition MUST NOT occur.

For example, if ReportSamples is 25 and FetchSamples is 24, then the CPE will store 25 values for each monitored parameter and the above Status transition will occur as the CPE stores each 24th of 25 sample intervals, which means that the ACS could delay for up to two sample intervals before reading the stored values and would still not miss any samples (see also ForceSample).

To disable this trigger mechanism and still collect sampled statistics, FetchSamples can be set to either 0 or a value greater than ReportSamples.

0 1.0 TR-157
ForceSample boolean boolean W

When set to true, forces statistics for the current sample to be calculated and updated in the data model. Setting it to false has no effect. When read, this parameter returns false, regardless of the actual value.

If this is the first time that ForceSample has been set to true during the current sample interval, this MUST cause a new value to be added to each of the periodic statistics comma-separated list parameters, and the ReportEndTime and all SampleSeconds parameters MUST be updated accordingly.

If this is not the first time that ForceSample has been set to true during the current sample interval, then the new values that were added as described in the previous paragraph, and the ReportEndTime and all SampleSeconds parameters, MUST be updated accordingly.

Note that ForceSample just provides a "sneak preview" of the current sample. It does not create a new sample and it does not interfere with the sample interval schedule.

At the end of each sample interval, if ForceSample was set to true during the sample interval then the new values that were added as described above, and the ReportEndTime and all SampleSeconds parameters, will be updated accordingly. In other words, the partial sample data that was created when ForceSample was set to true will be updated one last time at the end of the sample interval.

false 1.0 TR-157
ReportStartTime dateTime dateTime - The absolute time at which the sample interval for the first stored sample (for each statistic) started. <Empty> 1.0 TR-157
ReportEndTime dateTime dateTime -

The absolute time at which the sample interval for the last stored sample (for each statistic) ended.

If ForceSample has been used to force statistics for the current sample to be calculated and updated in the data model, then ReportEndTime MUST be updated to reflect the actual time over which stored data was collected.

<Empty> 1.0 TR-157
SampleSeconds unsignedInt​[] list of unsignedInt -

Comma-separated list of unsigned integers. Each entry indicates the number of seconds during which data was collected during the sample interval.

Individual SampleSeconds values can be less than SampleInterval, for several reasons, including:

TimeReference has been set to a time other than the Unknown Time and the current sample interval started part of the way through a scheduled sample interval.
ForceSample has been used to force statistics for the current sample to be calculated and updated in the data model.
<Empty> 1.0 TR-157
ParameterNumberOfEntries unsignedInt unsignedInt - The number of entries in the Parameter table. 0 1.0 TR-157
TR-157a2
PeriodicStatistics.​SampleSet.​{i}.​Parameter.​{i}. object​[0:] object​[0:∞] 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.

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

- 1.0 TR-157
Alias string​(64) Alias W

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

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

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

The Agent MUST choose an initial value that doesn't conflict with any existing entries.

- 1.0 TR-157a4
Enable boolean boolean W Enables or disables this object instance. false 1.0 TR-157
Reference string​(256) string​(256) W The value MUST be the Path Name of a parameter. This is the parameter being monitored by the Periodic Statistics mechanism. <Empty> 1.0 TR-157
SampleMode string string W

Controls how this parameter's value is sampled. Enumeration of:

  • Current (Sampled value is current value)
  • Change (Sampled value is change in value since start of sample interval)

Parameters of non-numeric types can only support Current. The value of the SampleMode MUST be ignored for such parameters.

"Current" 1.0 TR-157
CalculationMode string string W

Controls how this parameter's statistic is calculated from the sampled value(s). Enumeration of:

  • Latest (Statistic is sampled value at end of sample interval)
  • Minimum (Statistic is minimum sampled value during sample interval)
  • Maximum (Statistic is maximum sampled value during sample interval)
  • Average (Statistic is average (mean) sampled value during sample interval)

Parameters of non-numeric types can only support Latest. The value of the CalculationMode MUST be ignored for such parameters.

SampleMode MUST be applied before CalculationMode, i.e. the inputs to the calculation will have already accounted for SampleMode.

"Latest" 1.0 TR-157
LowThreshold int int W

The low threshold value that controls the calculation of Failures.

A value equal to HighThreshold disables the threshold/failure mechanism.

Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters.

0 1.0 TR-157
HighThreshold int int W

The high threshold value that controls the calculation of Failures.

A value equal to LowThreshold disables the threshold/failure mechanism.

Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters.

0 1.0 TR-157
SampleSeconds unsignedInt​[] list of unsignedInt -

Comma-separated list of unsigned integers. Each entry indicates the number of seconds during which data was collected for this parameter during the sample interval.

Individual SampleSeconds values can be less than PeriodicStatistics.SampleSet.{i}.SampleInterval?, for several reasons, including:

Any of the reasons for which PeriodicStatistics.SampleSet.{i}.SampleSeconds? values might be less than PeriodicStatistics.SampleSet.{i}.SampleInterval?.
The parameter doesn't exist, or was created or deleted during a sample interval.
<Empty> 1.0 TR-157
SuspectData unsignedInt​[]​(:1) list of unsignedInt​(:1) -

Comma-separated list of unsigned integers (value 0 to 1). Each entry is 0 if the sampled value is believed to be valid, or 1 if an event that might affect the validity of the sampled value occurred during the sample interval.

For example, if the parameter value were to be reset during the sample interval then it would be appropriate to set SuspectData to 1.

<Empty> 1.0 TR-157
Values string​[] list of string -

Comma-separated list of strings. Each entry indicates the value of the referenced parameter, as determined by SampleMode, during the sample interval.

The statistics values in this comma-separated lists MUST be in time order, with the oldest one first and the most recent one last.

If the SampleMode parameter is not present, or is inappropriate for the referenced parameter, the statistics values MUST be collected in Current mode.

<Empty> 1.0 TR-157
Failures unsignedInt unsignedInt -

Counts the number of times (since this object instance was last enabled) that a newly-calculated sample value (accounting for SampleMode) transitioned from the "in range" state to the "out of range" state, or between the "out of range (low)" and "out of range (high)" states. The states are defined as follows:

Note that, if LowThreshold and HighThreshold are both the same, the threshold/failure mechanism is disabled, so the value of this parameter will not increment.

This parameter can be incremented at any time during a sample interval, and might be incremented more than once during a single sample interval. For this reason, the CPE SHOULD place a locally specified limit on the frequency at which it will notify the ACS of such changes, as described in [Section 3.2.1/TR-069a2].

Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters.

0 1.0 TR-157
TR-157a5
TR-157a7
DeviceInfo. object object​[1:1] -   - 1.0 TR-157a3
VendorLogFileNumberOfEntries unsignedInt unsignedInt - The number of entries in the VendorLogFile table. - 1.0 TR-157a3
SupportedDataModelNumberOfEntries unsignedInt unsignedInt - The number of entries in the SupportedDataModel table. - 1.0 TR-157a1
TR-157a2
DeviceInfo.​VendorLogFile.​{i}. object​[0:] object​[0:∞] -

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.

- 1.0 TR-157a3
Alias string​(64) Alias W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.0 TR-157a3
TR-157a4
Name string​(64) string​(64) -

Name of the log file.

Typically this will be the full file system path, but provided that it is guaranteed to be unique across current and future log files, it MAY be a shorter name derived from the file system path, or be derived via another mechanism.

- 1.0 TR-157a3
MaximumSize unsignedInt unsignedInt - The maximum size of the log file in bytes. If the device doesn't know the maximum file size then MaximumSize will be 0. - 1.0 TR-157a3
TR-157a5
Persistent boolean boolean -

When true, the log file contents are preserved across a device reboot.

When false, the log file contents will be purged when the device is rebooted.

- 1.0 TR-157a3
DeviceInfo.​SupportedDataModel.​{i}. object​[0:] object​[0:∞] -

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.

- 1.0 TR-157a1
Alias string​(64) Alias W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.0 TR-157a4
URL string​(256) string​(256) -

URL ([RFC3986]) that describes some or all of the device's Current Supported Data Model.

The URL MUST reference an XML file which describes the appropriate part of the Supported Data Model.

The referenced XML file MUST be compliant with the DT (Device Type) Schema that is described in [Annex B/TR-106a3], including any additional normative requirements referenced within the Schema.

The XML file referenced by this URL MUST NOT change while the CPE is running, and SHOULD NOT change across a CPE reboot. Note that UUID is a unique key, so the XML file referenced by this URL will never change.

The XML file MAY be located within the CPE. In this scenario the CPE MAY use the value of "localhost" as URL host portion, When the "localhost" value is used, the ACS has the responsibility to substitute the "localhost" value with the host portion of the connection request URL.

Behavior in the event of an invalid URL, failure to access the referenced XML file, or an invalid XML file, is implementation-dependent.

- 1.0 TR-157a1
TR-157a7
UUID string​(36:36) UUID - [UUID] UUID ([RFC4122]) that is the value of the uuid attribute in the DT Instance referenced by URL. - 1.0 TR-157a7
URN string​(256) string​(256) -

URN ([RFC3986]) that is the value of the spec attribute in the DM (data model) Instance that defines the Root Object or Service Object referenced by this table entry.

For example, if this table entry references a DT Instance that refers to the Device:1.3 Root Object, the value of this parameter would be urn:broadband-forum-org:tr-157-1-0-0, because TR-157 defines Device:1.3. If the DT Instance instead referred to a vendor-specific Root Object, e.g. X_EXAMPLE_Device:1.0 (derived from Device:1.3), the value of this parameter would be something like urn:example-com:device-1-0-0.

- 1.0 TR-157a1
Features string​[] list of string -

Comma-separated list of strings. This parameter MUST list exactly the features that are defined using the top-level feature element in the DT Instance referenced by URL.

For example, if the DT instance specified the following:

<feature name="DNSServer"/>
<feature name="Router"/>
<feature name="X_MyDeviceFeature"/>

then the value of this parameter might be DNSServer,Router,X_MyDeviceFeature. The order in which the features are listed is not significant.

- 1.0 TR-157a1
DeviceInfo.​ProxierInfo. object object​[1:1] - Represents the associated CPE Proxier for a Proxied Device that utilizes the Virtual CWMP Device Mechanism [Annex J.1.1/TR-069a4]. - 1.0 TR-157a4
ManufacturerOUI string​(6:6) 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].

- 1.0 TR-157a4
ProductClass string​(64) 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.

- 1.0 TR-157a4
SerialNumber string​(64) string​(64) - Serial number of the associated CPE Proxier. - 1.0 TR-157a4
ProxyProtocol string string -

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.

- 1.0 TR-157a4
TR-157a7
UserInterface. object object​[1:1] -   - 1.0 TR-157
UserInterface.​RemoteAccess. object object​[1:1] -

This object contains parameters relating to remotely accessing the CPE's user interface.

Remote access is defined as any entity not of a local subnet attempting to connect to the CPE.

Remote access requires user authentication. To provide remote access authentication the CPE MUST support a "User" table with at least one instance that has "RemoteAccessCapable" set to true.

- 1.0 TR-157
TR-157a2
Enable boolean boolean W Enables/Disables remotely accessing the CPE's user interface. - 1.0 TR-157
TR-157a5
TR-157a7
Port unsignedInt​(:65535) unsignedInt​(:65535) W Destination TCP port required for remote access connection. - 1.0 TR-157
SupportedProtocols string​[] list of string -

Comma-separated list of strings. Indicates the protocols that are supported by the CPE for the purpose of remotely accessing the user interface. Each list item is an enumeration of:

- 1.0 TR-157
Protocol string string W The value MUST be a member of the list reported by the SupportedProtocols parameter. This is the protocol currently being used for remote access. - 1.0 TR-157
BulkData. object object​[1:1] -

Bulk Data collection utilizes the IPDR solution to collect data from devices based on a service specification described in [TR-232].

Bulk Data Collection Profiles are measured over a reporting interval (which can be aligned with absolute time) and are made available to the collection server.

This object provides bulk data collection capabilities and global collection settings that affect the entire device.

- 1.0 TR-157a6
Enable boolean boolean W

Enables or disables all collection profiles.

If false, bulk data will not be collected or reported.

- 1.0 TR-157a6
Status string string -

Indicates the status of the Bulk Data Collection mechanism. Enumeration of:

  • Enabled (Bulk Data Collection is enabled and working as intended)
  • Disabled (Bulk Data Collection is disabled)
  • Error (Bulk Data Collection is enabled, but there is an error condition preventing the successful collection of bulk data, OPTIONAL)
- 1.0 TR-157a6
MinReportingInterval unsignedInt unsignedInt -

Minimum reporting interval in seconds that the CPE is capable of supporting.

A value of 0 indicates no minimum reporting interval.

- 1.0 TR-157a6
Protocols string​[] list of string -

Comma-separated list of strings. Represents the IPDR Protocols that this device is capable of supporting. Each list item is an enumeration of:

- 1.0 TR-157a6
EncodingTypes string​[] list of string -

Comma-separated list of strings. Represents the IPDR Encoding Types that this device is capable of supporting. Each list item is an enumeration of:

- 1.0 TR-157a6
MaxNumberOfProfiles int​(-1:) int​(-1:) -

The maximum number of profiles that can exist at any given time. Specifically, the maximum number of Profile.{i}. instances that the ACS can create.

If the value of this parameter is -1, then it means that the CPE doesn't have a limit to the number of profiles that can exist.

- 1.0 TR-157a6
MaxNumberOfParameterReferences int​(-1:) int​(-1:) -

The maximum number of parameters that can be referenced via the bulk data collection mechanism. Specifically, the maximum number of parameters that can be referenced via Profile.{i}.Parameter.{i}.Reference across all Profile and Parameter instances (including the expansion of partial paths within the Reference parameter).

If the value of this parameter is -1, then it means that the CPE doesn't have a limit to the number of parameter that can be referenced via the bulk data collection mechanism.

- 1.0 TR-157a6
ProfileNumberOfEntries unsignedInt unsignedInt - The number of entries in the Profile table. - 1.0 TR-157a6
BulkData.​Profile.​{i}. object​[0:] object​[0:∞] W

A set of Bulk Data Collection profiles.

Each profile represents a bulk data report, including its own timing configuration, communications configuration, and set of parameters. This allows the ACS to configure multiple reports to be generated at different times for different sets of data.

At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias.

- 1.0 TR-157a6
Enable boolean boolean W

Enables or disables this specific bulk data profile.

If false, this profile will not be collected or reported.

false 1.0 TR-157a6
Alias string​(64) Alias W

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

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

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

The Agent MUST choose an initial value that doesn't conflict with any existing entries.

- 1.0 TR-157a6
Protocol string string W The value MUST be a member of the list reported by the Protocols parameter. The IPDR Protocol being used for this collection profile. - 1.0 TR-157a6
EncodingType string string W The value MUST be a member of the list reported by the EncodingTypes parameter. The IPDR Encoding Type being used for this collection profile. - 1.0 TR-157a6
ReportingInterval unsignedInt​(1:) unsignedInt​(1:) W

The reporting interval in seconds. Each report is generated based on this interval and TimeReference.

The CPE MAY reject a request to set ReportingInterval to less than MinReportingInterval.

Reporting intervals MUST begin every ReportingInterval seconds.

If ReportingInterval is changed while collection is enabled, the first reporting interval begins immediately.

For example, if ReportingInterval is 86400 (a day) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then the CPE will generate (and transmit, if the Protocol parameter is set to Streaming) its report at midnight every 24 hours.

86400 1.0 TR-157a6
TimeReference dateTime dateTime W

An absolute time reference in UTC to determine when will be transmitted. Each reporting interval MUST complete at this reference time plus or minus an integer multiple of ReportingInterval, unless unable to due to higher prioritized operations.

TimeReference is used only to set the "phase" of the reporting intervals. The actual value of TimeReference can be arbitrarily far into the past or future.

If TimeReference is changed while collection of bulk data is enabled, the first reporting interval begins immediately.

The Unknown Time value as defined in [TR-106a2] indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and is required only to adhere to the specified reporting intervals.

If absolute time is not available to the CPE, its reporting interval behavior MUST be the same as if the TimeReference parameter was set to the Unknown Time value.

For example, if ReportingInterval is 86400 (a day) and if TimeReference is set to UTC midnight on some day (in the past, present, or future) then the CPE will generate (and transmit, if in a "ITPush" mode) its report at midnight every 24 hours.

Note that, if TimeReference is set to a time other than the Unknown Time, the first reporting interval (which has to begin immediately) will almost certainly be shorter than ReportingInterval). This is why TimeReference is defined in terms of when reporting intervals complete rather than start.

0001-01-01T00:00:00Z 1.0 TR-157a6
StreamingHost string​(256) string​(256) W This is the host name or IP Address of the IPDR Collector to be used by the CPE to stream bulk data records if this collection profile is configured for the IPDR Streaming Protocol [IPDR-SP] (the Protocol parameter has a value of Streaming). - 1.0 TR-157a6
StreamingPort unsignedInt​(0:65535) unsignedInt​(0:65535) W This is the port number of the IPDR Collector to be used by the CPE to stream bulk data records if this collection profile is configured for the IPDR Streaming Protocol [IPDR-SP] (the Protocol parameter has a value of Streaming). 4737 1.0 TR-157a6
StreamingSessionID unsignedInt​(48:57,65:90) unsignedInt​(48:57,65:90) W

This is the unique identification of an IPDR Session to be used when this collection profile is configured for the IPDR Streaming Protocol [IPDR-SP] (the Protocol parameter has a value of Streaming).

An ACS MUST NOT configure multiple IPDR Streaming Protocol collection profiles with the same StreamingSessionID. Doing so MUST cause the CPE to fail the SetParameterValues.

Within the IPDR Streaming Protocol specification the Session ID has a type of a single 'char', but we are restricting the range even further (ASCII values of '0' - '9' and 'A' - 'Z'.

- 1.0 TR-157a6
FileTransferURL string​(256) string​(256) W This is the URL within the CPE that is used by an IPDR Collector to retrieve the IPDRDocs when this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File). - 1.0 TR-157a6
FileTransferUsername string​(64) string​(64) W

Username used for authentication of the FileTransferURL.

This is the FileTransferUsername that the IPDR Collector uses to access the CPE when this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File).

- 1.0 TR-157a6
FileTransferPassword string​(64) string​(64) W

Password used for authentication of the FileTransferURL.

This is the FileTransferPassword that the IPDR Collector uses to access the CPE when this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File).

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

- 1.0 TR-157a6
ControlFileFormat string​(128) string​(128) W

If this collection profile is configured for the IPDR File Transfer Protocol [IPDR-FTP] (the Protocol parameter has a value of File) then the control file names will be of the following format:

<ControlFilePrefix>_<ControlFilePolicy>.<ControlFileSuffix>

Where the following rules apply:

  • ControlFilePrefix MUST NOT contain an underscore '_' or any other character not suitable for a file name.
  • ControlFilePolicy MUST contain one or more 'N' characters, where the number of 'N' characters denotes the number of digits in the sequence number, including leading zeros as necessary to match the number of 'N' characters.
  • ControlFileSuffix is a file extension.

For example, BulkData_NNNN.log where "BulkData" would be the prefix, "NNNN" would be the policy, and "log" would be the suffix. Files adhering to this file format would look like: BulkData_0000.log, BulkData_0001.log, etc.

- 1.0 TR-157a6
TR-157a7
ParameterNumberOfEntries unsignedInt unsignedInt - The number of entries in the Parameter table. - 1.0 TR-157a6
BulkData.​Profile.​{i}.​Parameter.​{i}. object​[0:] object​[0:∞] W

Bulk data parameter table.

Each entry in this table represents a parameter (or set of parameters if a partial path is provided) to be collected and reported.

- 1.0 TR-157a6
Reference string​(256) string​(256) W

The value MUST be the Path Name of a parameter or object. Represents the parameter(s) that are part of this Bulk Data collection profile.

In the case where a partial parameter path is specified all sub-objects and contained parameters will be part of the bulk data collected and reported. If the path name refers to an object then it MUST end with a '.'.

<Empty> 1.0 TR-157a6
UPnP. object object​[1:1] - This object contains all UPnP related objects and parameters including Device and Discovery related objects and parameters. - 1.0 TR-157
UPnP.​Device. object object​[1:1] - This object defines the UPnP devices and UPnP services that are implemented by the CPE. - 1.0 TR-157
TR-157a2
Enable boolean boolean W Enables/Disables UPnP support. - 1.0 TR-157
UPnPMediaServer boolean boolean W Enables/Disables UPnP Media Server. - 1.0 TR-157
UPnPMediaRenderer boolean boolean W Enables/Disables UPnP Media Renderer. - 1.0 TR-157
UPnPWLANAccessPoint boolean boolean W Enables/Disables UPnP Wireless Access Point. - 1.0 TR-157
UPnPQoSDevice boolean boolean W Enables/Disables UPnP QoS Device. - 1.0 TR-157
UPnPQoSPolicyHolder boolean boolean W Enables/Disables UPnP QoS Policy Holder. - 1.0 TR-157
UPnPIGD boolean boolean W Enables/Disables UPnP IGD. - 1.0 TR-157
UPnPDMBasicMgmt boolean boolean W Enables/Disables UPnP-DM Basic Management. - 1.0 TR-157a2
UPnPDMConfigurationMgmt boolean boolean W Enables/Disables UPnP-DM Configuration Management. - 1.0 TR-157a2
UPnPDMSoftwareMgmt boolean boolean W Enables/Disables UPnP-DM Software Management. - 1.0 TR-157a2
UPnP.​Device.​Capabilities. object object​[1:1] - This object defines what UPnP capabilities this device has. - 1.0 TR-157
UPnPArchitecture unsignedInt unsignedInt -

Numeric value indicating the major version of the supported UPnP architecture.

If UPnP 1.1 is supported the value is 1. If UPnP 2.0 is supported the value is 2.

A value of 0 indicates no UPnP support.

- 1.0 TR-157
TR-157a2
UPnPArchitectureMinorVer unsignedInt unsignedInt -

Numeric value indicating the minor version of the supported UPnP architecture.

If UPnP 1.1 is supported the value is 1. If UPnP 2.0 is supported the value is 0.

If UPnPArchitecture is 0 then this parameter SHOULD be ignored.

- 1.0 TR-157a2
UPnPMediaServer unsignedInt unsignedInt -

Numeric value indicating the supported revision for UPnP Media Server.

A value of 0 indicates no support.

- 1.0 TR-157
UPnPMediaRenderer unsignedInt unsignedInt -

Numeric value indicating the supported revision for UPnP Media Renderer.

A value of 0 indicates no support.

- 1.0 TR-157
UPnPWLANAccessPoint unsignedInt unsignedInt -

Numeric value indicating the supported revision for UPnP Wireless Access Point.

A value of 0 indicates no support.

- 1.0 TR-157
UPnPBasicDevice unsignedInt unsignedInt -

Numeric value indicating the supported revision for UPnP Basic Device.

A value of 0 indicates no support.

- 1.0 TR-157
UPnPQoSDevice unsignedInt unsignedInt -

Numeric value indicating the supported revision for UPnP Qos Device.

A value of 0 indicates no support.

- 1.0 TR-157
UPnPQoSPolicyHolder unsignedInt unsignedInt -

Numeric value indicating the supported revision for UPnP Qos Policy Holder.

A value of 0 indicates no support.

- 1.0 TR-157
UPnPIGD unsignedInt unsignedInt -

Numeric value indicating the supported revision for UPnP IGD.

A value of 0 indicates no support.

- 1.0 TR-157
UPnPDMBasicMgmt unsignedInt unsignedInt -

Numeric value indicating the supported revision for UPnP-DM Basic Management.

A value of 0 indicates no support.

- 1.0 TR-157a2
UPnPDMConfigurationMgmt unsignedInt unsignedInt -

Numeric value indicating the supported revision for UPnP-DM Configuration Management.

A value of 0 indicates no support.

- 1.0 TR-157a2
UPnPDMSoftwareMgmt unsignedInt unsignedInt -

Numeric value indicating the supported revision for UPnP-DM Software Management.

A value of 0 indicates no support.

- 1.0 TR-157a2
UPnP.​Discovery. object object​[1:1] -

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.

- 1.0 TR-157
RootDeviceNumberOfEntries unsignedInt unsignedInt - The number of entries in the RootDevice table. - 1.0 TR-157
TR-157a2
DeviceNumberOfEntries unsignedInt unsignedInt - The number of entries in the Device table. - 1.0 TR-157
TR-157a2
ServiceNumberOfEntries unsignedInt unsignedInt - The number of entries in the Service table. - 1.0 TR-157
TR-157a2
UPnP.​Discovery.​RootDevice.​{i}. object​[0:] object​[0:∞] -

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.

- 1.0 TR-157
Status string string -

The status of the UPnP root device. Enumeration of:

  • LeaseActive (Device is active and UPnP lease has not expired)
  • LeaseExpired (Device is inactive because UPnP lease has expired)
  • ByebyeReceived (Device is inactive because byebye message was received)

The ability to list inactive UPnP root devices is OPTIONAL. The length of time an inactive device remains listed in this table is a local matter to the CPE.

- 1.0 TR-157
UUID string​(36) string​(36) -

This UPnP root device's UUID (Universally Unique IDentifier) [RFC4122], extracted from any of its USN (Unique Service Name) headers. This is a 36-byte string that uniquely identifies the device, the following is an example:

02c29d2a-dbfd-2d91-99c9-306d537e9856

- 1.0 TR-157
USN string​(256) string​(256) -

The value of the USN (Unique Service Name) header for this UPnP root device. Three discovery messages are sent for root devices, and this SHOULD be the value of the USN header of the following form:

uuid:device-UUID::urn:domain-name:device:deviceType:v

SSDP is an unreliable protocol and it is possible that no discovery message containing the USN header of the above form was ever received. If so, one of the other two forms MAY be used:

uuid:device-UUID::upnp:rootdevice
uuid:device-UUID (for root device UUID)
- 1.0 TR-157
LeaseTime unsignedInt unsignedInt - The UPnP root device lease time in seconds, extracted from the CACHE-CONTROL header. - 1.0 TR-157
Location string​(256) string​(256) - The value of the LOCATION header for this UPnP root device, which is the URL of the root device's DDD (Device Description Document). - 1.0 TR-157
Server string​(256) string​(256) -

The value of the SERVER header for this UPnP root device, which is a string of the following form:

OS/version UPnP/udaversion product/version

where UPnP is a literal string, udaversion is the version of the UPnP Device Architecture.

- 1.0 TR-157
Host string​(1024)​[]​(256) list​(1024) of string​(256) -

Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters 256). Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this UPnP root device.

As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly.

- 1.0 TR-157
LastUpdate dateTime dateTime - The date and time at which the last advertisement from this RootDevice was received. - 1.0 TR-157a7
UPnP.​Discovery.​Device.​{i}. object​[0:] object​[0:∞] -

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.

- 1.0 TR-157
Status string string -

The status of the UPnP embedded device. Enumeration of:

  • LeaseActive (Device is active and UPnP lease has not expired)
  • LeaseExpired (Device is inactive because UPnP lease has expired)
  • ByebyeReceived (Device is inactive because byebye message was received)

The ability to list inactive UPnP embedded devices is OPTIONAL. The length of time an inactive device remains listed in this table is a local matter to the CPE.

- 1.0 TR-157
UUID string​(36) string​(36) -

This UPnP embedded device's UUID (Universally Unique IDentifier) [RFC4122], extracted from any of its USN (Unique Service Name) headers. This is a 36-byte string that uniquely identifies the device, the following is an example:

02c29d2a-dbfd-2d91-99c9-306d537e9856

- 1.0 TR-157
USN string​(256) string​(256) -

The value of the USN (Unique Service Name) header for this UPnP embedded device. Two discovery messages are sent for embedded devices, and this SHOULD be the value of the USN header of the following form:

uuid:device-UUID::urn:domain-name:device:deviceType:v

SSDP is an unreliable protocol and it is possible that no discovery message containing the USN header of the above form was ever received. If so, the other form MAY be used:

uuid:device-UUID
- 1.0 TR-157
LeaseTime unsignedInt unsignedInt - The UPnP embedded device lease time in seconds, extracted from the CACHE-CONTROL header. - 1.0 TR-157
Location string​(256) string​(256) - The value of the LOCATION header for this UPnP embedded device, which is the URL of the root device's DDD (Device Description Document). - 1.0 TR-157
Server string​(256) string​(256) -

The value of the SERVER header for this UPnP embedded device, which is a string of the following form:

OS/version UPnP/udaversion product/version

where UPnP is a literal string, udaversion is the version of the UPnP Device Architecture.

- 1.0 TR-157
Host string​(1024)​[]​(256) list​(1024) of string​(256) -

Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters 256). Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this UPnP embedded device.

As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly.

- 1.0 TR-157
LastUpdate dateTime dateTime - The date and time at which the last advertisement from this Device was received. - 1.0 TR-157a7
UPnP.​Discovery.​Service.​{i}. object​[0:] object​[0:∞] -

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.

- 1.0 TR-157
Status string string -

The status of the UPnP embedded service. Enumeration of:

  • LeaseActive (Service is active and UPnP lease has not expired)
  • LeaseExpired (Service is inactive because UPnP lease has expired)
  • ByebyeReceived (Service is inactive because byebye message was received)

The ability to list inactive UPnP embedded services is OPTIONAL. The length of time an inactive service remains listed in this table is a local matter to the CPE.

- 1.0 TR-157
USN string​(256) string​(256) -

The value of the USN (Unique Service Name) header for this UPnP embedded service. This is of the following form:

uuid:device-UUID::urn:domain-name:service:serviceType:v
- 1.0 TR-157
LeaseTime unsignedInt unsignedInt - The UPnP embedded service lease time in seconds, extracted from the CACHE-CONTROL header. - 1.0 TR-157
Location string​(256) string​(256) - The value of the LOCATION header for this UPnP embedded service, which is the URL of the root device's DDD (Device Description Document). - 1.0 TR-157
Server string​(256) string​(256) -

The value of the SERVER header for this UPnP embedded service, which is a string of the following form:

OS/version UPnP/udaversion product/version

where UPnP is a literal string, udaversion is the version of the UPnP Device Architecture.

- 1.0 TR-157
Host string​(1024)​[]​(256) list​(1024) of string​(256) -

Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters 256). Indicates the full path names of all Host table entries, whether active or inactive, that correspond to this UPnP embedded service.

As such entries are added to or removed from the Host tables, the value of this parameter MUST be updated accordingly.

- 1.0 TR-157
LastUpdate dateTime dateTime - The date and time at which the last advertisement from this Service was received. - 1.0 TR-157a7
ParentDevice string​(256) 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. - 1.0 TR-157a7
UPnP.​Description. object object​[1:1] - This object contains information from the Description Document discovered from the UPnP Devices and Services. - 1.0 TR-157a7
DeviceDescriptionNumberOfEntries unsignedInt unsignedInt - The number of entries in the DeviceDescription table. - 1.0 TR-157a7
DeviceInstanceNumberOfEntries unsignedInt unsignedInt - The number of entries in the DeviceInstance table. - 1.0 TR-157a7
ServiceInstanceNumberOfEntries unsignedInt unsignedInt - The number of entries in the ServiceInstance table. - 1.0 TR-157a7
UPnP.​Description.​DeviceDescription.​{i}. object​[0:] object​[0:∞] -

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.

- 1.0 TR-157a7
URLBase string​(256) 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.

- 1.0 TR-157a7
SpecVersion string​(256) 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:

- 1.0 TR-157a7
Host string​(1024)​[]​(256) list​(1024) of string​(256) - Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters 256). None of the possible target objects exist in this data model, so the parameter value MUST be an empty string. - 1.0 TR-157a7
UPnP.​Description.​DeviceInstance.​{i}. object​[0:] object​[0:∞] -

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.

- 1.0 TR-157a7
UDN string​(36:36) UUID -

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

- 1.0 TR-157a7
ParentDevice string​(256) 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. - 1.0 TR-157a7
DiscoveryDevice string​(256) 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.

- 1.0 TR-157a7
DeviceType string​(256) 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. - 1.0 TR-157a7
FriendlyName string​(128) 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. - 1.0 TR-157a7
Manufacturer string​(128) 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. - 1.0 TR-157a7
ManufacturerURL string​(256) 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. - 1.0 TR-157a7
ModelDescription string​(256) 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. - 1.0 TR-157a7
ModelName string​(64) 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. - 1.0 TR-157a7
ModelNumber string​(64) 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. - 1.0 TR-157a7
ModelURL string​(256) 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. - 1.0 TR-157a7
SerialNumber string​(128) 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. - 1.0 TR-157a7
UPC string​(12) 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. - 1.0 TR-157a7
PresentationURL string​(256) 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.

- 1.0 TR-157a7
UPnP.​Description.​ServiceInstance.​{i}. object​[0:] object​[0:∞] -

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 both ParentDevice and ServiceId.

- 1.0 TR-157a7
ParentDevice string​(256) 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. - 1.0 TR-157a7
ServiceId string​(256) 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.

- 1.0 TR-157a7
ServiceDiscovery string​(256) 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.

- 1.0 TR-157a7
ServiceType string​(256) 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. - 1.0 TR-157a7
SCPDURL string 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.

- 1.0 TR-157a7
ControlURL string 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

- 1.0 TR-157a7
EventSubURL string 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

- 1.0 TR-157a7
ManagementServer. object object​[1:1] -   - 1.0 TR-157a4
EmbeddedDeviceNumberOfEntries unsignedInt unsignedInt - The number of entries in the EmbeddedDevice table. - 1.0 TR-157a4
VirtualDeviceNumberOfEntries unsignedInt unsignedInt - The number of entries in the VirtualDevice table. - 1.0 TR-157a4
ManagementServer.​EmbeddedDevice.​{i}. object​[0:] object​[0:∞] -

Each entry in this table represents a distinct Proxied Device that utilizes the Embedded Object Mechanism [Annex J.1.2/TR-069a4] for proxying devices.

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

- 1.0 TR-157a4
ControllerID string​(256) 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.
- 1.0 TR-157a4
ProxiedDeviceID string​(256) 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.

- 1.0 TR-157a4
Reference string 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]. - 1.0 TR-157a4
SupportedDataModel string​[] list of string - Comma-separated list of strings. Each list item MUST be the Path Name of a row in the DeviceInfo.SupportedDataModel? table, or an empty string. 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. - 1.0 TR-157a4
Host string​[:32] list​[:32] of string - Comma-separated list (up to 32 items) of strings. Each list item MUST be the Path Name of a row in the LANDevice.{i}.Hosts.Host? table, or an empty string. References the LANDevice.{i}.Hosts.Host? table entry(s), whether active or inactive, that corresponds to this proxied LAN device. - 1.0 TR-157a4
ProxyProtocol string string -

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.

- 1.0 TR-157a4
TR-157a7
ProxyProtocolReference string 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. - 1.0 TR-157a7
DiscoveryProtocol string​[] list of 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.

- 1.0 TR-157a7
DiscoveryProtocolReference string​[] list of 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.

- 1.0 TR-157a7
CommandProcessed string string -

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

- 1.0 TR-157a4
CommandProcessingErrMsg string​(1024) string​(1024) - Detailed CommandProcessed error description (vendor specific). - 1.0 TR-157a4
LastSyncTime dateTime 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.

- 1.0 TR-157a4
ManagementServer.​VirtualDevice.​{i}. object​[0:] object​[0:∞] -

Each entry in this table represents a distinct Proxied Device that utilizes the Virtual CWMP Device Mechanism [Annex J.1.1/TR-069a4] for proxying devices.

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

- 1.0 TR-157a4
ManufacturerOUI string​(6:6) 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].

- 1.0 TR-157a4
ProductClass string​(64) string​(64) - Identifier of the class of product of the associated Proxied Device for which the serial number applies. - 1.0 TR-157a4
SerialNumber string​(64) string​(64) - Serial number of the associated Proxied Device. - 1.0 TR-157a4
Host string​[:32] list​[:32] of string - Comma-separated list (up to 32 items) of strings. Each list item MUST be the Path Name of a row in the LANDevice.{i}.Hosts.Host? table, or an empty string. References all the LANDevice.{i}.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. - 1.0 TR-157a4
ProxyProtocol string string -

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.

- 1.0 TR-157a4
TR-157a7
ProxyProtocolReference string 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. - 1.0 TR-157a7
DiscoveryProtocol string​[] list of 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.

- 1.0 TR-157a7
DiscoveryProtocolReference string​[] list of 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.

- 1.0 TR-157a7
DNS. object object -   - <Empty> TR-157a7
DNS.​SD. object object​[1:1] -

This object contains the DNS Service Discovery [DNS-SD] object and parameters necessary to discover services and their associated devices.

Upon reboot the the contents of the service table are repopulated. When the DNS.SD service is disabled, the contents of the service table is implementation specific.

- 1.0 TR-157a7
Enable boolean boolean W The parameter, when true, enables the discovery of DNS-SD services hosted by other devices. - 1.0 TR-157a7
ServiceNumberOfEntries unsignedInt unsignedInt - The number of entries in the Service table. - 1.0 TR-157a7
DNS.​SD.​Service.​{i}. object​[0:] object​[0:∞] -

The Service table contains discovered DNS-SD services. DNS.SD service information is provided in DNS RR SRV records [RFC2782]. The Service Instance Name [Section 4.1 Structured Instance Names/DNS-SD] further specifies information about the service name (RFC2782 Service field) and domain name (RFC2782 Name field) in the form:

Service Instance Name = <InstanceName> . <Service> . <Domain>

<Service> = _<ApplicationProtocol> . _<TransportProtocol>

RFC2782 Service field will always be equal to <InstanceName>. <Service>

RFC2782 Name field will always be equal to <Domain>

For example, an SSH service might have:

At most one entry in this table can exist with the same values for all of InstanceName, ApplicationProtocol, TransportProtocol and Domain.

- 1.0 TR-157a7
InstanceName string​(63) string​(63) - Human-readable instance name [Section 4.1.1 Instance Names/DNS-SD] (i.e. The "<InstanceName>" portion of the '"Service Instance Name'"). - 1.0 TR-157a7
ApplicationProtocol string​(15) string​(15) - The Application Protocol, without the leading underscore, associated with the service (e.g., daap) as defined by the DNS-SD service [Section 7 Application Protocol Names/DNS-SD]. - 1.0 TR-157a7
TransportProtocol string string -

The Transport Protocol associated with the service as defined by the DNS-SD service [Section 4.1.2 Service Names/DNS-SD]. Enumeration of:

- 1.0 TR-157a7
Domain string​(256) string​(256) - The value extracted from the Name field of the DNS SRV record [RFC2782] which represents the fully qualified domain name (FQDN) associated with the service as defined by the DNS-SD service [Section 4.1.3 Domain Names/DNS-SD]. - 1.0 TR-157a7
Port unsignedInt​(:65535) unsignedInt​(:65535) - The value extracted from the Port field of the DNS SRV record [RFC2782] that is used to contact the service. - 1.0 TR-157a7
Target string​(256) string​(256) - The fully qualified domain name (FQDN) with the trailing dot "." of the target host implementing the service as in the DNS SRV record [RFC2782]. - 1.0 TR-157a7
Status string string -

The status of the discovered Service at LastUpdate time. Enumeration of:

The ability to instantiate an inactive Service is OPTIONAL.

The time an inactive Service remains listed in this table is a local matter to the device.

- 1.0 TR-157a7
LastUpdate dateTime dateTime - The date and time at which the last advertisement for this Service was received. - 1.0 TR-157a7
Host string​(1024)​[]​(256) list​(1024) of string​(256) - Comma-separated list (maximum number of characters 1024) of strings (maximum number of characters 256). None of the possible target objects exist in this data model, so the parameter value MUST be an empty string. - 1.0 TR-157a7
TimeToLive unsignedInt​(:2147483647) unsignedInt​(:2147483647) - The value extracted from the TTL field of the DNS SRV record [RFC2782]. - 1.0 TR-157a7
Priority unsignedInt​(:65535) unsignedInt​(:65535) - The value extracted from the Priority field of the DNS SRV record [RFC2782]. - 1.0 TR-157a7
Weight unsignedInt​(:65535) unsignedInt​(:65535) - A server selection mechanism. The value extracted from the Weight field of the DNS SRV record [RFC2782] that specifies the relative weight for entries with the same Priority. - 1.0 TR-157a7
TextRecordNumberOfEntries unsignedInt unsignedInt - The number of entries in the TextRecord table. - 1.0 TR-157a7
DNS.​SD.​Service.​{i}.​TextRecord.​{i}. object​[0:] object​[0:∞] -

This object maintains an instance of a (key/value pairs) of the service. The information is extracted from DNS TXT records [RFC1035] of the discovered service.

When multiple instances of the TextRecord table have the same value for the Key parameter, the implementation is CPE specific.

- 1.0 TR-157a7
Key string​(255) string​(255) - The key that identifies the text record - 1.0 TR-157a7
Value string​(255) string​(255) - The value of the text record. - 1.0 TR-157a7

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
PeriodicStatistics.SampleSet.{i}.
Alias
PeriodicStatistics.SampleSet.{i}.
SampleSeconds
PeriodicStatistics.SampleSet.{i}.Parameter.{i}.
Alias
PeriodicStatistics.SampleSet.{i}.Parameter.{i}.
SampleSeconds
PeriodicStatistics.SampleSet.{i}.Parameter.{i}.
SuspectData
PeriodicStatistics.SampleSet.{i}.Parameter.{i}.
Values
DeviceInfo.VendorLogFile.{i}.
Alias
DeviceInfo.SupportedDataModel.{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 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.

PeriodicStatsBase:1 Profile

This table defines the PeriodicStatsBase:1 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.7.

Name Requirement
PeriodicStatistics. P
MinSampleInterval R
MaxReportSamples R
SampleSetNumberOfEntries R
PeriodicStatistics.​SampleSet.​{i}. C
Name W
SampleInterval W
ReportSamples W
ReportStartTime R
ReportEndTime R
SampleSeconds R
ParameterNumberOfEntries R
PeriodicStatistics.​SampleSet.​{i}.​Parameter.​{i}. C
Reference W
SampleSeconds R
SuspectData R
Values R

PeriodicStatsAdv:1 Profile

The PeriodicStatsAdv:1 profile for the TR-157:1 data model is defined as the union of the PeriodicStatsBase:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is TR-157:1.7.

Name Requirement
PeriodicStatistics.​SampleSet.​{i}. C
Enable W
Status R
TimeReference W
FetchSamples W
ForceSample W
PeriodicStatistics.​SampleSet.​{i}.​Parameter.​{i}. C
Enable W
SampleMode W
CalculationMode W
LowThreshold W
HighThreshold W
Failures R

VendorLogFiles:1 Profile

This table defines the VendorLogFiles:1 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.7.

Name Requirement
DeviceInfo.​VendorLogFile.​{i}. P
Name R
MaximumSize R
Persistent R

BulkDataColl:1 Profile

This table defines the BulkDataColl:1 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.7.

Name Requirement
BulkData. P
Enable W
Status R
MinReportingInterval R
Protocols R
EncodingTypes R
ProfileNumberOfEntries R
BulkData.​Profile.​{i}. C
Enable W
Alias W
Protocol W
EncodingType W
ReportingInterval W
TimeReference W
ParameterNumberOfEntries R
BulkData.​Profile.​{i}.​Parameter.​{i}. C
Reference W

BulkDataStreaming:1 Profile

The BulkDataStreaming:1 profile for the TR-157:1 data model is defined as the union of the BulkDataColl:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is TR-157:1.7.

Name Requirement
BulkData.​Profile.​{i}. C
StreamingHost W
StreamingPort W
StreamingSessionID W

BulkDataFileTransfer:1 Profile

The BulkDataFileTransfer:1 profile for the TR-157:1 data model is defined as the union of the BulkDataColl:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is TR-157:1.7.

Name Requirement
BulkData.​Profile.​{i}. C
FileTransferURL W
FileTransferUsername W
FileTransferPassword W
ControlFileFormat W

SupportedDataModel:1 Profile

This table defines the SupportedDataModel:1 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.7.

Name Requirement
DeviceInfo. P
SupportedDataModelNumberOfEntries R
DeviceInfo.​SupportedDataModel.​{i}. P
URL R
URN R
Features R

SupportedDataModel:2 Profile

This table defines the SupportedDataModel:2 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.7.

Name Requirement
DeviceInfo.​SupportedDataModel.​{i}. P
UUID R

UPnPDev:1 Profile

This table defines the UPnPDev:1 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.7.

Name Requirement
UPnP. P
UPnP.​Device. P
Enable W
UPnPMediaServer W
UPnPMediaRenderer W
UPnPWLANAccessPoint W
UPnPQoSDevice W
UPnPQoSPolicyHolder W
UPnPIGD W
UPnP.​Device.​Capabilities. P
UPnPArchitecture R
UPnPMediaServer R
UPnPMediaRenderer R
UPnPWLANAccessPoint R
UPnPBasicDevice R
UPnPQoSDevice R
UPnPQoSPolicyHolder R
UPnPIGD R

UPnPDiscBasic:1 Profile

This table defines the UPnPDiscBasic:1 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.7.

Name Requirement
UPnP. P
UPnP.​Discovery. P
RootDeviceNumberOfEntries R
UPnP.​Discovery.​RootDevice.​{i}. P
Status R
UUID R
USN R
LeaseTime R
Location R
Server R

UPnPDiscAdv:1 Profile

The UPnPDiscAdv:1 profile for the TR-157:1 data model is defined as the union of the UPnPDiscBasic:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is TR-157:1.7.

Name Requirement
UPnP.​Discovery. P
DeviceNumberOfEntries R
ServiceNumberOfEntries R
UPnP.​Discovery.​Device.​{i}. P
Status R
UUID R
USN R
LeaseTime R
Location R
Server R
UPnP.​Discovery.​Service.​{i}. P
Status R
USN R
LeaseTime R
Location R
Server R

UPnPDiscAdv:2 Profile

This table defines the UPnPDiscAdv:2 profile for the TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.7.

Name Requirement
UPnP.​Discovery.​Device.​{i}. P
LastUpdate R
Host R
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 TR-157:1 data model. The minimum REQUIRED version for this profile is TR-157:1.7.

Name Requirement
DNS.​SD. P
Enable W
ServiceNumberOfEntries R
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
DNS.​SD.​Service.​{i}.​TextRecord.​{i}. P
Key R
Value R


Generated by Broadband Forum report.pl#428+ (2022-01-07 version) on 2022/07/19 at 17:14:49 (INTERIM VERSION).
report.pl --exitcode=fatals --cwmpindex=.. --nofontstyles --nowarnreport --quiet --nomodels --automodel --report=html --outfile=tr-157-1-7-0.html tr-157-1-7-0.xml