 |
TR-140 StorageService: 1.3 Service Object definition [CWMP] (changes)tr-140-1-3-1-cwmp.xml |
||
DATA MODEL DEFINITION | |||
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:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- 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.
- 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.
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 types.
| Data Type | Base Type | Description |
|---|---|---|
| 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
| [IANA-uri-schemes] | IANA Uniform Resource Identifier (URI) Schemes Registry, Uniform Resource Identifier (URI) Schemes, IANA. |
| [IEEE_EUI64] | Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority, IEEE, March 1997. |
| [RFC3986] | RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, IETF. |
| [RFC4007] | RFC 4007, IPv6 Scoped Address Architecture, IETF. |
| [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. |
| [RFC7159] | RFC7159, The JavaScript Object Notation (JSON) Data Interchange Format, IETF, March 2014. |
| [RFC7230] | RFC 7230, Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing, IETF, June 2014. |
| [RFC7252] | RFC 7252, The Constrained Application Protocol (CoAP), IETF, June 2014. |
| [RFC8141] | RFC 8141, Uniform Resource Names (URNs), IETF, April 2017. |
| [SOAP1.1] | Simple Object Access Protocol (SOAP) 1.1, W3C. |
| [TR-069] | TR-069 Amendment 6, CPE WAN Management Protocol, Broadband Forum, April 2018. |
| [TR-106] | TR-106 Amendment 8, Data Model Template for CWMP Endpoints and USP Agents, Broadband Forum, May 2018. |
| [ZigBee2007] | ZigBee 2007 Specification, ZigBee 2007 Specification, ZigBee Alliance, October 2007. |
Legend
| Object definition. |
| Parameter definition. |
StorageService:1.3 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.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.
Changes in 1.3:
- Changed attribute name = StorageService:1.2 ⇒ StorageService:1.3
| Name | Type | Write | Description | Object Default | Version |
|---|---|---|---|---|---|
| StorageService.{i}. | object(0:) | R | The Service Object for a Storage Service device. At most one entry in this table can exist with a given value for Alias. |
- | 1.0 |
| StorageService.{i}.Capabilities. | object | R | The overall capabilities of a Storage Service device. This is a constant read-only object, meaning that only a firmware upgrade will cause these values to be altered. Note that when TR-140 was originally published there was a typo in this object name, which has been corrected. | - | 1.0 |
| SupportedFileSystemTypes | string[] | R | Comma-separated list of strings. Supported FileSystems Types. Each list item is an enumeration of:
Mac OS Standard format Changes in 1.3:
)
Mac OS Extended format Changes in 1.3:
)
Journaled Mac OS Extended format Changes in 1.3:
)
ReiserFS Changes in 1.3:
)
Changes in 1.3:
|
- | 1.0 |
| StorageService.{i}.PhysicalMedium.{i}. | object(0:) | R | 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 the same values for all of Vendor, Model and SerialNumber, or with a given value for Alias. |
- | 1.0 |
| ConnectionType | string | R | The method of connection to this storage device. Enumeration of:
SATA 3.0 Gbit/s Changes in 1.3:
)
Changes in 1.3:
|
- | 1.0 |
| Type | string | R | Specifies the type of the physical medium Enumeration of:
|
- | 1.3 |
| StorageService.{i}.PhysicalMedium.{i}.SMART. | object | R | 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 | R | 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 | R | Count of hours in power-on state. It shows total count of hours in power-on state. | - | 1.3 |
| SpinRetryCount | unsignedInt | R | 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 | R | The count of full hard disk power on/off cycles. | - | 1.3 |
| Temperature | unsignedInt | R | Current internal temperature in degrees C. | - | 1.3 |
| ReallocationEventCount | unsignedInt | R | 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 | R | 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 | R | 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 | R | Total number of unrecoverable read errors. | - | 1.3 |
| SoftReadErrors | unsignedInt | R | Total number of off-track errors. | - | 1.3 |
| WriteErrors | unsignedInt | R | Total number of errors when writing a sector. | - | 1.3 |
| SparesRemaining | unsignedInt(0:100) | R | Percentage of the spare sectors that can be used for reallocations remaining. | - | 1.3 |
| PredictedFailure | int | R | 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 |
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
Generated by Broadband Forum bbfreport v2.1.0 (2024-01-18 version) on 2024-01-18 at 11:48:54 UTC.
report.py –include ../../install/cwmp –output <stdout> –transform diff –format markdown tr-140-1-2-0.xml tr-140-1-3-1-cwmp.xml