Broadband Forum

    DATA MODEL DEFINITION


STBService:1.4 Service Object definition
tr-135-1-4-0.xml (changes)

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 objects for Service Monitoring of Events

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

[RFC4122] RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, IETF, 2005.
[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-135] TR-135, Data Model for a TR-069 Enabled STB, Broadband Forum.

STBService:1.4 Data Model (changes)

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

Name Type Write Description Object Default Version
STBService.{i}. object -

The top-level object for an STB CPE.

At most one entry in this table can exist with a given value for Alias. The non-functional key parameter Alias is immutable and therefore MUST NOT change once it's been assigned.

- 1.0
STBService.{i}.Capabilities. object - The overall capabilities of the STB CPE. This is a constant read-only object, meaning that only a firmware update will cause these values to be altered. - 1.0
STBService.{i}.Capabilities.ServiceMonitoring. object - This object describes the capabilities of the ServiceMonitoring object. - 1.0
MaxMainStreamEventLogEntries unsignedInt - Maximum number of event log entries that the STB is able to record for a MainStream object instance. - 1.4
STBService.{i}.ServiceMonitoring. object -

Records events and collects QoS / QoE related statistics for Main AV streams.

These statistics are broken down into categories, e.g. de-jittering and RTP, and for each category there are two types of statistics:

  • Total statistics, which count the number of occurrences of something.
  • Sample statistics, which are measured over a sample interval, and are made available to the ACS as a list of the most recent n samples.

Total statistics are always collected (collection cannot be disabled, but the values can be reset).

For Sample statistics, an STB uses a single sample interval and number of samples (n) for all MainStream instances. The sample interval can be aligned with absolute time.

When Sample statistics collection is enabled, statistics collection MUST proceed regardless of whether there are any active Main AV streams. For example, even when the STB is not receiving any data, sample intervals will continue to be timed as normal.

Refer to [I.3/TR-135] for non-normative explanation of the operation of the ServiceMonitoring object.

- 1.0
EventCollectionEnable boolean W

Enables or disables the collection of the events for all main streams.

When the collection of events is enabled, any previously collected events are discarded and the collection of new events begins immediately.

- 1.4
STBService.{i}.ServiceMonitoring.MainStream.{i}. object -

List of Main AV stream objects. Each instance is associated with a specified service type and will collect statistics only for the main stream that matches that service type.

Note that this means that streams that do not match an instance's service type MUST NOT contribute to the instance's Total and Sample statistics.

It is up to the STB to determine which AV stream should be regarded as the Main AV stream for a given service type at any given time. For example, if two active streams are associated with the same service type, the STB might prefer streams that are associated with an AV player, or if more than one stream is associated with an AV player, the STB might prefer a player that is outputting a DVI stream to a player that is outputting an RF stream.

Note that some parameters, e.g. Components.FrontEnd.{i}.IP.ServiceConnect.URI, include requirements that restrict the STB's freedom to determine which AV stream should be regarded as the Main AV stream for a given service.

At most one entry in this table can exist with a given value for ServiceType, or with a given value for Alias. The non-functional key parameters ServiceType and Alias are immutable and therefore MUST NOT change once they've been assigned.

- 1.0
SessionId string­(36:36) - [UUID] Time based UUID [Section 4.2/RFC4122] that is the identifier for the associated AVStream parameter when available to the device. - 1.4
STBService.{i}.ServiceMonitoring.MainStream.{i}.EventLog. object -

This object represents the log entries of events recorded by the MainStream object instance.

When the number of log entries in the EventLog exceeds the value of the Capabilities.ServiceMonitoring.MaxMainStreamEventLogEntries parameter, the Entry object with the lowest SequenceNumber value is replaced by the new EventLog Entry object.

Log entries are persisted across reboots of the CPE.

- 1.4
Reset boolean W

When set to true, clears the events from the event log and the value of Entry.{i}.SequenceNumber parameter is reset to the parameter's minimum value.

The value of this parameter is not part of the device configuration and is always false when read.

- 1.4
EntryNumberOfEntries unsignedInt - The number of entries in the Entry table. - 1.4
STBService.{i}.ServiceMonitoring.MainStream.{i}.EventLog.Entry.{i}. object -

This object represents an entry (e.g., start session, channel change) in the event log.

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

- 1.4
SequenceNumber unsignedInt­[1:] -

The sequence number of the event within the EventLog.

This parameter is incremented by one (1) for each entry within the EventLog.

When the value of the parameter exceeds the maximium range, the lowest value of this parameter that is not contained in current EventLog entries is used.

- 1.4
Type string - Type of the event. The values for this parameter are vendor specific. - 1.4
Time dateTime - Timestamp of the event. - 1.4
ParameterNumberOfEntries unsignedInt - The number of entries in the Parameter table. - 1.4
STBService.{i}.ServiceMonitoring.MainStream.{i}.EventLog.Entry.{i}.Parameter.{i}. object - This object represents an instance of a parameter that is associated with the Entry object Instance. - 1.4
Name string - Name of the parameter (vendor-specific). - 1.4
Value string - Value of the parameter. - 1.4

Notification Requirements

Parameters for which Value Change 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.


Generated by Broadband Forum report.pl#422 (2018/03/28 version) on 2018/03/29 at 09:47:50.
report.pl --exitcode=fatals --altnotifreqstyle --ignoreenableparameter --immutablenonfunctionalkeys --cwmpindex=.. --nofontstyles --nowarnreport --quiet --lastonly --report=html --outfile=tr-135-1-4-0-diffs.html tr-135-1-4-0.xml