Broadband Forum

    DATA MODEL DEFINITION


TR-140 StorageService: 1.3 Service Object definition [USP]
tr-140-1-3-1-usp.xml (changes)

License

Copyright (c) 2017-2019, Broadband Forum

The undersigned members have elected to grant the copyright to their contributed material used in this software:
Copyright (c) 2017-2018 ARRIS Enterprises, LLC.

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

May 2017:

September 2019: Corrigendum 1

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 unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference.

The following mandatory constraints MUST be enforced:

  • The value MUST NOT be empty.
  • The value MUST start with a letter.
  • If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an "cpe-" prefix.

The value MUST NOT change once it's been assigned.

boolean - Boolean, where the allowed values are 0 or 1 (or equivalently, true or false).
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.

References

[SOAP1.1] Simple Object Access Protocol (SOAP) 1.1, W3C.
[TR-106] TR-106 Amendment 8, Data Model Template for CWMP Endpoints and USP Agents, Broadband Forum, May 2018.

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

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

The Service Object for a Storage Service device.

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
StorageService.{i}.PhysicalMedium.{i}. object -

This object provides information about each physical medium connected to this device.

At most one entry in this table can exist with a given value for Name, or with all the same values for Vendor, Model and SerialNumber, or 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
Type string -

Specifies the type of the physical medium

Enumeration of:

- 1.3
StorageService.{i}.PhysicalMedium.{i}.SMART. object - This object provides SMART data information about the physical medium. SMART attributes are not standardized, but many vendors provide the data below. - 1.3
ReallocatedSectorsCount unsignedInt -

Count of reallocated sectors. When the hard drive finds a read/write/verification error, it marks this sector as "reallocated" and transfers data to a special reserved area (spare area).

This process is also known as remapping, and "reallocated" sectors are called remaps. However, as the number of reallocated sectors increases, the read/write speed tends to decrease.

The raw value represents a count of the number of bad sectors that have been found and remapped. Thus, the higher the attribute value, the more sectors the drive has had to reallocate.

- 1.3
PowerOnHours unsignedInt - Count of hours in power-on state. It shows total count of hours in power-on state. - 1.3
SpinRetryCount unsignedInt - Count of retry of spin start attempts. This attribute stores a total count of the spin start attempts to reach the fully operational speed (under the condition that the first attempt was unsuccessful). An increase of this attribute value is a sign of problems in the hard disk mechanical subsystem. - 1.3
PowerCycleCount unsignedInt - The count of full hard disk power on/off cycles. - 1.3
Temperature unsignedInt - Current internal temperature in degrees C. - 1.3
ReallocationEventCount unsignedInt -

Count of remap operations. The raw value of this attribute shows the total count of attempts to transfer data from reallocated sectors to a spare area.

Both successful and unsuccessful attempts are counted.

- 1.3
CurrentPendingSectorCount unsignedInt - Count of "unstable" sectors (waiting to be remapped, because of unrecoverable read errors). If an unstable sector is subsequently read successfully, the sector is remapped and this value is decreased. - 1.3
UncorrectableSectorCount unsignedInt -

The total number of uncorrectable errors when reading/writing a sector.

A rise in the value of this attribute indicates defects of the disk surface and/or problems in the mechanical subsystem.

- 1.3
ReadErrors unsignedInt - Total number of unrecoverable read errors. - 1.3
SoftReadErrors unsignedInt - Total number of off-track errors. - 1.3
WriteErrors unsignedInt - Total number of errors when writing a sector. - 1.3
SparesRemaining unsignedInt­[0:100] - Percentage of the spare sectors that can be used for reallocations remaining. - 1.3
PredictedFailure int - Estimated number of days until the failure model in the device predicts the drive will fail. -1 means the failure model is unable to make a prediction. - 1.3

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#424 (2019-07-26 version) on 2019/09/04 at 16:22:52.
report.pl --exitcode=fatals --altnotifreqstyle --ignoreenableparameter --immutablenonfunctionalkeys --markmounttype --cwmpindex=.. --nofontstyles --nowarnreport --quiet --lastonly --report=html --outfile=tr-140-1-3-1-usp-diffs.html tr-140-1-3-1-usp.xml