Broadband Forum

    DATA MODEL DEFINITION


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

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

Table of Contents

Data Types

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

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

Data Type Base Type Description
Alias string(64)

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
Dbm1000 int The value is measured in dBm/1000, i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm.
IEEE_EUI64 string(23)

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

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

Possible patterns:

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

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

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

  • 216.52.29.100
  • 192.168.1.254

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

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

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

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

IPPrefix string(49)

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

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

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

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

IPv4Address IPAddress(15)

IPv4 address (or subnet mask).

Can be any IPv4 address that is permitted by the IPAddress data type.

IPv4Prefix IPPrefix(18)

IPv4 address prefix.

Can be any IPv4 prefix that is permitted by the IPPrefix data type.

IPv6Address IPAddress(45)

IPv6 address.

Can be any IPv6 address that is permitted by the IPAddress data type.

IPv6Prefix IPPrefix(49)

IPv6 address prefix.

Can be any IPv6 prefix that is permitted by the IPPrefix data type.

MACAddress string(17)

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

  • <Empty> (an empty string)
  • ([0-9A-Fa-f][0-9A-Fa-f]:){5}([0-9A-Fa-f][0-9A-Fa-f])
StatsCounter32 unsignedInt

A 32-bit statistics parameter, e.g. a byte counter.

This data type SHOULD NOT be used for statistics parameters whose values might become greater than the maximum value that can be represented as an unsignedInt (i.e. 0xffffffff, referred to below as maxval). StatsCounter64 SHOULD be used for such parameters.

The value maxval indicates that no data is available for this parameter. In the unlikely event that the actual value of the statistic is maxval, the CPE SHOULD return maxval - 1.

The actual value of the statistic might be greater than maxval. Such values SHOULD wrap around through zero.

The term packet is to be interpreted as the transmission unit appropriate to the protocol layer in question, e.g. an IP packet or an Ethernet frame.

StatsCounter64 unsignedLong

A 64-bit statistics parameter, e.g. a byte counter.

This data type SHOULD be used for all statistics parameters whose values might become greater than the maximum value that can be represented as an unsignedInt.

The maximum value that can be represented as an unsignedLong (i.e. 0xffffffffffffffff) indicates that no data is available for this parameter.

The term packet is to be interpreted as the transmission unit appropriate to the protocol layer in question, e.g. an IP packet or an Ethernet frame.

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}
ZigBeeNetworkAddress string(4)

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

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

Base64 encoded binary (no line-length limitation).

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

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

Hex encoded binary.

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

int -

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

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

long -

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

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

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

Unsigned integer in the range 0 to 4294967295, inclusive.

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

unsignedLong -

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

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

References

[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.
[RFC4291] RFC 4291, IP Version 6 Addressing Architecture, IETF, 2006.
[RFC4632] RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan, IETF, 2006.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-069] TR-069, CPE WAN Management Protocol, Broadband Forum, 2004.
[TR-069a4] TR-069 Amendment 4, CPE WAN Management Protocol, Broadband Forum, 2011.
[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.
[ZigBee2007] ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007.

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 Write Description Object Default Version
DeviceInfo. object -   - 1.9
DeviceCategory 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.9
ModelNumber 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.9
ManagementServer. object -   - 1.9
InformParameterNumberOfEntries unsignedInt - The number of entries in the InformParameter table. - 1.9
ManagementServer.InformParameter.{i}. object 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. On creation of a new table entry, the Agent MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

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

- 1.9
Enable boolean W Enables or disables this InformParameter. false 1.9
Alias string­(64) W

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

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

  • Its value MUST NOT be empty.
  • Its value MUST start with a letter.
  • If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
  • The CPE MUST NOT change the parameter value.
- 1.9
ParameterName 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.9
EventList 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.9
UPnP. object - This object contains all UPnP related objects and parameters including Device and Discovery related objects and parameters. - 1.9
UPnP.Device. object - This object defines the UPnP devices and UPnP services that are implemented by the CPE. - 1.9
Enable boolean W Enables/Disables UPnP support. - 1.9
UPnPMediaServer boolean W Enables/Disables UPnP Media Server. - 1.9
UPnPMediaRenderer boolean W Enables/Disables UPnP Media Renderer. - 1.9
UPnPWLANAccessPoint boolean W Enables/Disables UPnP Wireless Access Point. - 1.9
UPnPQoSDevice boolean W Enables/Disables UPnP QoS Device. - 1.9
UPnPQoSPolicyHolder boolean W Enables/Disables UPnP QoS Policy Holder. - 1.9
UPnPIGD boolean W Enables/Disables UPnP IGD. - 1.9
UPnPDMBasicMgmt boolean W Enables/Disables UPnP-DM Basic Management. - 1.9
UPnPDMConfigurationMgmt boolean W Enables/Disables UPnP-DM Configuration Management. - 1.9
UPnPDMSoftwareMgmt boolean W Enables/Disables UPnP-DM Software Management. - 1.9
UPnP.Device.Capabilities. object - This object defines what UPnP capabilities this device has. - 1.9
UPnPArchitecture 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.9
UPnPArchitectureMinorVer 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.9
UPnPMediaServer unsignedInt -

Numeric value indicating the supported revision for UPnP Media Server.

A value of 0 indicates no support.

- 1.9
UPnPMediaRenderer unsignedInt -

Numeric value indicating the supported revision for UPnP Media Renderer.

A value of 0 indicates no support.

- 1.9
UPnPWLANAccessPoint unsignedInt -

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

A value of 0 indicates no support.

- 1.9
UPnPBasicDevice unsignedInt -

Numeric value indicating the supported revision for UPnP Basic Device.

A value of 0 indicates no support.

- 1.9
UPnPQoSDevice unsignedInt -

Numeric value indicating the supported revision for UPnP Qos Device.

A value of 0 indicates no support.

- 1.9
UPnPQoSPolicyHolder unsignedInt -

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

A value of 0 indicates no support.

- 1.9
UPnPIGD unsignedInt -

Numeric value indicating the supported revision for UPnP IGD.

A value of 0 indicates no support.

- 1.9
UPnPDMBasicMgmt unsignedInt -

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

A value of 0 indicates no support.

- 1.9
UPnPDMConfigurationMgmt unsignedInt -

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

A value of 0 indicates no support.

- 1.9
UPnPDMSoftwareMgmt unsignedInt -

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

A value of 0 indicates no support.

- 1.9
UPnP.Discovery. object -

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

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

- 1.9
RootDeviceNumberOfEntries unsignedInt - The number of entries in the RootDevice table. - 1.9
DeviceNumberOfEntries unsignedInt - The number of entries in the Device table. - 1.9
ServiceNumberOfEntries unsignedInt - The number of entries in the Service table. - 1.9
UPnP.Discovery.RootDevice.{i}. object -

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

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

- 1.9
Status 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.9
UUID 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.9
USN 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.9
LeaseTime unsignedInt - The UPnP root device lease time in seconds, extracted from the CACHE-CONTROL header. - 1.9
Location 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.9
Server 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.9
Host string­(1024) -

Comma-separated list (maximum list length 1024) of strings (maximum item length 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.9
LastUpdate dateTime - The date and time at which the last advertisement from this RootDevice was received. - 1.9
UPnP.Discovery.Device.{i}. object -

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

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

- 1.9
Status 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.9
UUID 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.9
USN 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.9
LeaseTime unsignedInt - The UPnP embedded device lease time in seconds, extracted from the CACHE-CONTROL header. - 1.9
Location 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.9
Server 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.9
Host string­(1024) -

Comma-separated list (maximum list length 1024) of strings (maximum item length 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.9
LastUpdate dateTime - The date and time at which the last advertisement from this Device was received. - 1.9
UPnP.Discovery.Service.{i}. object -

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

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

- 1.9
Status 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.9
USN 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.9
LeaseTime unsignedInt - The UPnP embedded service lease time in seconds, extracted from the CACHE-CONTROL header. - 1.9
Location 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.9
Server 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.9
Host string­(1024) -

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

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

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

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

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

- 1.9
URLBase string­(256) -

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

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

- 1.9
SpecVersion string­(256) -

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

- 1.9
Host string­(1024) - Comma-separated list (maximum list length 1024) of strings (maximum item length 256). None of the possible target objects exist in this data model, so the parameter value MUST be an empty string. - 1.9
UPnP.Description.DeviceInstance.{i}. object -

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

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

- 1.9
UDN string­(36:36) -

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

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

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

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

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

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

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

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

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

- 1.9
UPnP.Description.ServiceInstance.{i}. object -

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

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

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

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

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

- 1.9
ServiceDiscovery string­(256) -

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

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

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

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

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

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

- 1.9
ControlURL string -

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

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

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

- 1.9
EventSubURL string -

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

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

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

- 1.9

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

The UPnPDiscAdv:2 profile for the TR-157:1 data model is defined as the union of the UPnPDiscAdv:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is 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#422 (2018/03/28 version) on 2018/04/02 at 12:38:18.
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