Broadband Forum

Component Objects for CWMP
tr-157-1-9-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

Added Inform Parameters table to ManagementServer

Added HTIP Component to DeviceInfo containing HTIP related parameters

Updated the UPnP component for HTIP parameters

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

[G.9973] G.9973, Protocol for identifying home network topology, ITU-T, 2011.
[JJ-300.00] JJ-300.00, Home-network Topology Identifying Protocol, TTC, 2011.
[JJ-300.01] JJ-300.01, The List of Device Categories, TTC, 2011.
[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.
[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.

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

Name Type Syntax Write Description Object Default Version Spec
DeviceInfo. object object​[1:1] -   - 1.0 TR-157a9
DeviceCategory string​[] list of string -

Comma-separated list of strings. Each list item is a device category (e.g. "AV_TV" and "AV_Recorder"), or the value is an empty string if no such element is provided by the device.

Note: It is assumed that this list might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. Standard HTIP device categories are defined in [JJ-300.01]. In this case, the maximum length of the list is 127 and of each item is 31, and any non-HTIP device categories SHOULD NOT conflict with standard HTIP device categories.

- 1.0 TR-157a9
ModelNumber string​(64) string​(64) -

The model number of the device (human readable string), or an empty string if no model number is provided by the device.

Note: It is assumed that this string might be used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. In this case, the maximum length of the string is 31.

- 1.0 TR-157a9
ManagementServer. object object​[1:1] -   - 1.0 TR-157a9
InformParameterNumberOfEntries unsignedInt unsignedInt - The number of entries in the InformParameter table. - 1.0 TR-157a9
ManagementServer.​InformParameter.​{i}. object​[0:] object​[0:∞] W

This table provides the ACS with the ability to control the Parameters that are delivered by the Inform RPC.

Any Parameter (identified by ParameterName) contained in this table MUST be included within the ParameterList argument of the Inform RPC whenever any Event within the EventList is being delivered.

This table does not include Forced Inform Parameters, and Forced Inform Parameters are not allowed to be inserted into this table. Any attempt by an ACS to configure this table to contain a Forced Inform Parameter MUST result in the failure of the SetParameterValues RPC with error code 9007.

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

- 1.0 TR-157a9
Enable boolean boolean W Enables or disables this InformParameter. false 1.0 TR-157a9
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-157a9
ParameterName string​(256) string​(256) W

A pattern that describes the Parameter(s) to be included in the Inform’s ParameterList argument. Specifically, patterns with wildcards (an "*" character) in place of Instance Identifiers are allowed; any attempt to set the value otherwise MUST be rejected by the CPE.

If the pattern does not match any existing Parameters at the time that the CPE is creating the Inform RPC, then this InformParameter instance is not included in the Inform’s ParameterList argument.

<Empty> 1.0 TR-157a9
EventList string​[] list of string W

Comma-separated list of strings. Each entry in this list represents an Event for which this Parameter MUST be included within the ParameterList argument of the Inform RPC.

All Inform Events (see [Section 3.7.1.5/TR-069]), except for "4 VALUE CHANGE", are allowed as entries in this list. "4 VALUE CHANGE" is not allowed as that would violate requirements contained in [Section A.3.3.1/TR-069].

An empty string means all events except "4 VALUE CHANGE".

<Empty> 1.0 TR-157a9
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
DeviceCategory string​[] list of string -

Comma-separated list of strings. Each list item is the value of an element in the Device Description Document for this DeviceInstance that indicates a device category (e.g. "AV_TV" and "AV_Recorder"), or the value is an empty string if no such element is provided by the device.

Note: It is assumed that the htip:X_DeviceCategory Device Description Document element is used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973]. Standard HTIP device categories are defined in [JJ-300.01]. In this case, the maximum length of the list is 127 and of each item is 31, and any non-HTIP device categories SHOULD NOT conflict with standard HTIP device categories.

Note: DeviceCategory is different from DeviceType and is included here for the purpose of HTIP usage.

- 1.0 TR-157a9
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
ManufacturerOUI string​(0:6) string​(0:6) -

The value of an element in the Device Description Document for this DeviceInstance that indicates the manufacturer OUI if this value is provided by the device; or an empty string if this value is not provided by the device.

Note: It is assumed that the htip:X_ManufacturerOUI element is used for HTIP (Home-network Topology Identifying Protocol) [JJ-300.00] and [G.9973].

- 1.0 TR-157a9
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

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

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.

InformParameters:1 Profile

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

Name Requirement
ManagementServer. P
InformParameterNumberOfEntries R
ManagementServer.​InformParameter.​{i}. C
Enable W
ParameterName W
EventList W

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

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

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

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

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


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