TR-140 StorageService: 1.3 Service Object definition [CWMP]

tr-140-1-3-1-cwmp.xml

DATA MODEL DEFINITION

License

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

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.

Name	Type	Write	Description	Object Default	Version
StorageServiceNumberOfEntries	unsignedInt	R	Number of entries in StorageService.	-	1.1
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
Enable	boolean	W	Enables or Disables the entire Storage mechanism.	-	1.0
Alias	string(:64)	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. Active Notification requests for this parameter MAY be denied.	-	1.2
PhysicalMediumNumberOfEntries	unsignedInt	R	The number of instances of PhysicalMedium.{i}..	-	1.0
StorageArrayNumberOfEntries	unsignedInt	R	The number of instances of StorageArray.{i}..	-	1.0
LogicalVolumeNumberOfEntries	unsignedInt	R	The number of instances of LogicalVolume.{i}..	-	1.0
UserAccountNumberOfEntries	unsignedInt	R	The number of instances of UserAccount.{i}..	-	1.0
UserGroupNumberOfEntries	unsignedInt	R	The number of instances of UserGroup.{i}..	-	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
FTPCapable	boolean	R	Does this device contain an FTP server allowing clients to access the data via an FTP client?	-	1.0
SFTPCapable	boolean	R	Does this device contain an SSH FTP server allowing clients to access the data via an SFTP client?	-	1.0
HTTPCapable	boolean	R	Does this device contain an HTTP server allowing clients to access the data via an HTTP client?	-	1.0
HTTPSCapable	boolean	R	Does this device contain an HTTPS server allowing clients to access the data via an HTTPS client?	-	1.0
HTTPWritable	boolean	R	Does this device contain an HTTP server that supports creating files via an HTTP PUT/POST mechanism that would allow an HTTP client to upload files via HTTP? This is also sometimes referred to as “WebDAV” support.	-	1.0
SupportedNetworkProtocols	string[]	R	Comma-separated list of strings. Supported application-level network protocols. Each list item is an enumeration of: SMB NFS AFP The list MAY include vendor-specific protocols, which MUST be in the format defined in [TR-106]. For example: “X_EXAMPLE-COM_MyProt.	-	1.0
SupportedFileSystemTypes	string[]	R	Comma-separated list of strings. Supported FileSystems Types. Each list item is an enumeration of: FAT16 FAT32 NTFS ReFs (Resilient File System - Microsoft) HFS (Mac OS Standard format) HFS+ (Mac OS Extended format) HSFJ (Journaled Mac OS Extended format) ext2 ext3 ext4 XFS REISER (ReiserFS) Reiser4 btrfs ZFS (Zetta File System) EncFs (Encrypted File System) exFAT (Extended File Allocation Table for Flash memory) The list MAY include vendor-specific protocols, which MUST be in the format defined in [TR-106]. For example: “X_EXAMPLE-COM_MyType.	-	1.0
SupportedRaidTypes	string[]	R	Comma-separated list of strings. Supported RAID types. Each list item is an enumeration of: RAID0 RAID1 RAID2 RAID3 RAID4 RAID5 RAID6 RAID10 RAID0+1 RAID30 RAID50 RAID60 The list MAY include vendor-specific protocols, which MUST be in the format defined in [TR-106]. For example:“X_EXAMPLE-COM_MyRaid.	-	1.0
VolumeEncryptionCapable	boolean	R	Does this device have the ability to encrypt and decrypt Logical Volumes as they are stored and retrieved?	-	1.0
StorageService.{i}.NetInfo.	object	R	This object provides general LAN network information about this device.	-	1.0
HostName	string(:64)	W	Logical name which identifies the device on the local network. This is the first segment of a fully qualified domain name (FQDN). Combining HostName, a “.” and the DomainName will result in a fully qualified domain name.	-	1.0
DomainName	string(:255)	W	Domain name for the device on the local network. Combining HostName, a “.” and DomainName will result in a fully qualified domain name (FQDN). For example, if the HostName contains “myLaptop” and the DomainName contains “dsl.sp1.com”, then the FQDN would be “myLaptop.dsl.sp1.com”.	-	1.0
StorageService.{i}.UserGroup.{i}.	object(0:)	W	This object provides information about each user group configured on this device, which allows the grouping of user accounts for easier maintenance of permissions. 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 GroupName.	-	1.0
Enable	boolean	W	Enables or disables this group.	false	1.0
Alias	string(:64)	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. Active Notification requests for this parameter MAY be denied.	-	1.2
GroupName	string(:64)	W	The unique name of the group.	<Empty>	1.0
StorageService.{i}.UserAccount.{i}.	object(0:)	W	This object provides information about each user configured on this device, which provides a means for controlling access to the device. 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 Username.	-	1.0
Enable	boolean	W	Enables or disables this user.	false	1.0
Alias	string(:64)	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. Active Notification requests for this parameter MAY be denied.	-	1.2
Username	string(:64)	W	The unique name of the user. Also used for authentication.	<Empty>	1.0
Password	string(:64)	W	Password used to authenticate the user when connecting to the Storage Service Device. When read, this parameter returns an empty string, regardless of the actual value.	-	1.0
UserGroupParticipation	string[](:1024)	W	Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of a row in the UserGroup. table. If the referenced object is deleted, the corresponding item MUST be removed from the list. Represents a User Group that this User Account is a member of. Each UserGroup.{i}. referenced by this parameter MUST exist within the same StorageService instance.	<Empty>	1.0
AllowFTPAccess	boolean	W	Enables or disables access via FTP (including SSH FTP access) for this user.	false	1.0
AllowHTTPAccess	boolean	W	Enables or disables access via HTTP (including HTTPS access) for this user.	false	1.0
StorageService.{i}.NetworkServer.	object	R	This object allows the control of network layer protocols authorization enforcement.	-	1.0
AFPEnable	boolean	W	Enables or disables the AFP network protocol.	-	1.0
NFSEnable	boolean	W	Enables or disables the NFS network protocol.	-	1.0
SMBEnable	boolean	W	Enables or disables the SMB network protocol.	-	1.0
NetworkProtocolAuthReq	boolean	W	If this parameter is set to false then the device MUST NOT attempt to request login credentials or authenticate access from network layer protocols such as AFP, NFS, and SMB. If this parameter is set to true then the device MUST attempt to request login credentials or authenticate access from network layer protocols such as AFP, NFS, and SMB by using an instance of UserAccount.{i}. found on this device.	-	1.0
StorageService.{i}.FTPServer.	object	R	This object allows the configuration of the FTP server.	-	1.0
Enable	boolean	W	Enables or disables the FTP server.	-	1.0
Status	string	R	The current status of this FTP server. Enumeration of: Enabled Disabled Error	-	1.0
MaxNumUsers	unsignedInt(1:32)	W	Maximum number of users allowed to log in to the device at once via FTP.	-	1.0
IdleTime	unsignedInt(0:600)	W	Maximum amount of time in seconds that the FTP socket will remain open without any activity. If set to 0 an infinite timeout will apply.	-	1.0
PortNumber	unsignedInt(0:65535)	W	The port number that the FTP server is listening on. The factory default value MUST be 21.	-	1.0
StorageService.{i}.FTPServer.AnonymousUser.	object	R	This object allows the configuration of anonymous FTP access.	-	1.0
Enable	boolean	W	Enables or disables support for anonymous access into the FTP server	-	1.0
StartingFolder	string(:256)	W	The value MUST be the Path Name of a row in the LogicalVolume.{i}.Folder. table. Represents the home directory for anonymous FTP access. The LogicalVolume.{i}.Folder.{i}. referenced by this parameter MUST exist within the same StorageService instance.	-	1.0
ReadOnlyAccess	boolean	W	If this is set to true, then the anonymous user is limited to only retrieval of files from the Storage Service (no deletions, copies, creations or uploads). If this is set to false, then the anonymous user has full permissions within the folder specified in StartingFolder. This SHOULD default to True.	-	1.0
StorageService.{i}.SFTPServer.	object	R	This object allows the configuration of the SSH FTP server.	-	1.0
Enable	boolean	W	Enables or disables the SSH FTP server.	-	1.0
Status	string	R	The current status of this SSH FTP server. Enumeration of: Enabled Disabled Error	-	1.0
MaxNumUsers	unsignedInt(1:32)	W	Maximum number of users allowed to log in to the device at once via SFTP.	-	1.0
IdleTime	unsignedInt(0:600)	W	Maximum amount of time in seconds that the SFTP socket will remain open without any activity. If set to 0 an infinite timeout will apply.	-	1.0
PortNumber	unsignedInt(0:65535)	W	The port number that the SSH FTP server is listening on. The factory default value MUST be 115.	-	1.0
StorageService.{i}.HTTPServer.	object	R	This object allows the configuration of the HTTP server.	-	1.0
Enable	boolean	W	Enables or disables the HTTP server.	-	1.0
Status	string	R	The current status of this HTTP server. Enumeration of: Enabled Disabled Error	-	1.0
MaxNumUsers	unsignedInt(1:32)	W	Maximum number of users allowed to log in to the device at once via HTTP.	-	1.0
IdleTime	unsignedInt(0:600)	W	Maximum amount of time in seconds that the HTTP socket will remain open without any activity. If set to 0 an infinite timeout will apply.	-	1.0
HTTPWritingEnabled	boolean	R	Is support for the HTTP PUT/POST mechanism (WebDAV) enabled?	-	1.0
PortNumber	unsignedInt(0:65535)	W	The port number that the HTTP server is listening on. The factory default value MUST be 80.	-	1.0
AuthenticationReq	boolean	W	If true, HTTP will require login prior to access (basic or digest authentication).	-	1.0
StorageService.{i}.HTTPSServer.	object	R	This object allows the configuration of the HTTPS server.	-	1.0
Enable	boolean	W	Enables or disables the HTTPS server.	-	1.0
Status	string	R	The current status of this HTTPS server. Enumeration of: Enabled Disabled Error	-	1.0
MaxNumUsers	unsignedInt(1:32)	W	Maximum number of users allowed to log in to the device at once via HTTPS.	-	1.0
IdleTime	unsignedInt(0:600)	W	Maximum amount of time in seconds that the HTTPS socket will remain open without any activity. If set to 0 an infinite timeout will apply.	-	1.0
HTTPWritingEnabled	boolean	R	Is support for the HTTP PUT/POST mechanism (WebDAV) enabled?	-	1.0
PortNumber	unsignedInt(0:65535)	W	The port number that the HTTPS server is listening on. The factory default value MUST be 443.	-	1.0
AuthenticationReq	boolean	W	If true, HTTPS will require login prior to access (basic or digest authentication).	-	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
Alias	string(:64)	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. Active Notification requests for this parameter MAY be denied.	-	1.2
Name	string(:64)	W	A user-friendly name for this physical storage medium.	-	1.0
Vendor	string(:64)	R	The vendor of this physical storage medium.	-	1.0
Model	string(:128)	R	The model name/number of this physical storage medium.	-	1.0
SerialNumber	string(:64)	R	The serial number of this physical storage medium.	-	1.0
FirmwareVersion	string(:64)	R	The firmware version for firmware contained within the physical medium’s controller.	-	1.0
ConnectionType	string	R	The method of connection to this storage device. Enumeration of: USB 1.1 USB 2.0 USB 3.0 USB 3.1 IEEE1394 IEEE1394b IDE EIDE ATA/33 ATA/66 ATA/100 ATA/133 SATA/150 SATA/300 (SATA 3.0 Gbit/s) SATA/600 (SATA 6.0 Gbit/s) SATA/1969 (SATA 16.0 Gbit/s) SCSI-1 Fast SCSI Fast-Wide SCSI Ultra SCSI Ultra Wide SCSI Ultra2 SCSI Ultra2 Wide SCSI Ultra3 SCSI Ultra-320 SCSI Ultra-640 SCSI SAS-1 (serial attached SCSI 3.0 Gbit/s) SAS-2 (serial attached SCSI 6.0 Gbit/s) SAS-3 (serial attached SCSI 12.0 Gbit/s) SAS-4 (serial attached SCSI 22.5 Gbit/s) SSA SSA-40 Fibre Channel The parameter MAY instead be a vendor-specific connection type, which MUST be in the format defined in [TR-106]. For example: “X_EXAMPLE-COM_MyConnType”	-	1.0
Type	string	R	Specifies the type of the physical medium Enumeration of: HDD SSD SSHD (Hybrid Drive)	-	1.3
Removable	boolean	R	Is this physical storage medium removable? Removable storage implies that the removal action is part of normal operations and is expected to leave the data on the removable storage intact.	-	1.0
Capacity	unsignedInt	R	The formatted capacity of the physical storage medium in MB.	-	1.0
Status	string	R	The general activity status of this physical storage medium. Enumeration of: Online Standby Offline	-	1.0
Uptime	unsignedInt	R	Time since boot in hours. This MAY reflect S.M.A.R.T. PowerOnHours. Active Notification requests for this parameter MAY be denied.	-	1.0
SMARTCapable	boolean	R	Is this physical medium capable of reporting S.M.A.R.T. statistics?	-	1.0
Health	string	R	The general health of this physical storage medium. Enumeration of: OK Failing Error Note: Health MAY be obtained from S.M.A.R.T. data where available.	-	1.0
HotSwappable	boolean	R	Is this physical medium capable of being removed while the device is powered up? Hot-Swappable storage does not imply Removable storage; hot-swappable is an operation taken only when the disk has failed and needs to be replaced. The data on the hot-swapped storage will not remain intact.	-	1.0
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
StorageService.{i}.StorageArray.{i}.	object(0:)	W	This object provides information about each storage array (RAID) configured on this device. Creating an instance of this object generates a disabled StorageArray instance. Before this new StorageArray instance can be enabled (via a SetParameterValues command), it MUST have the following parameters configured: Name, RaidType, and PhysicalMediumReference. Once an instance is enabled the following parameters become immutable for the life of the instance: Name, RaidType, and PhysicalMediumReference. 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 PhysicalMediumReference.	-	1.0
Alias	string(:64)	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. Active Notification requests for this parameter MAY be denied.	-	1.2
Name	string(:64)	W	A user-friendly name for this Storage Array. Once this instance becomes enabled, this parameter will be immutable for the life of the instance.	<Empty>	1.0
Status	string	R	The current status of this StorageArray. Enumeration of: Rebuilding (Indicates a drive participating in an array is replaced, while the data striping and/or redundancy of the array are reestablished on the new disk. In this state, data operations to the array will function properly, but its performance could be significantly diminished) Initializing (The state when the RAID array is being first constructed, and the data striping and/or redundancy of the array are first being established. In this state, data operations to the array will function properly, but its performance could be significantly diminished and the redundancy might not be fully established) Offline (Indicates the RAID array is not available. This might occur because the administrator explicitly has disabled the array, or because underlying elements of the array, such as the physical disks, are not ready) Online (Indicates the RAID array is fully operational) Error (Indicates an error condition exists within the RAID array. In this state, data operations to the array are not possible, and data loss might have occurred) Degraded (Indicates the loss of a drive only in a Raid Type of more than 2 drives, that can support multiple failures. Data redundancy continues to be available but with degraded capability) Critical (Indicates the loss of data redundancy, and a possible degraded state. The array continues to perform read/write operations)	Offline	1.0
Enable	boolean	W	Enables or disables this StorageArray instance.	false	1.0
RaidType	string	W	The value MUST be a member of the list reported by the Capabilities.SupportedRaidTypes parameter. Note that after creation of the Storage Array, any subsequent writes to this parameter MUST be ignored as array type migration is not supported. To identify which RAID Types are supported, see Capabilities.SupportedRaidTypes. Once this instance becomes enabled, this parameter will be immutable for the life of the instance.	Linear	1.0
UsableCapacity	unsignedInt	R	The total Usable Capacity of the Storage Array in MB. This is computed by the system based on PhysicalMediumReference and RaidType. Disk size is a consideration, as many RAID Types use the smallest drive in the group for calculations.	-	1.0
PhysicalMediumReference	string[](:1024)	W	Comma-separated list (maximum number of characters 1024) of strings. Each list item MUST be the Path Name of a row in the PhysicalMedium. table. Represents the physical medium used by this RAID. Each Physical Medium referenced by this parameter MUST exist within the same StorageService instance. A PhysicalMedium.{i}. MUST only be referenced by one StorageArray.{i}. instance. Once this instance becomes enabled, this parameter will be immutable for the life of the instance.	-	1.0
StorageService.{i}.LogicalVolume.{i}.	object(0:)	W	This object provides information about each logical volume configured on this device. A logical volume can reside either on an instance of a single PhysicalMedium.{i}. or on an instance of a single StorageArray.{i}. instance, but it can not span multiple instances of either. PhysicalReference is used to define where this LogicalVolume instance resides. Creating an instance of this object generates a disabled LogicalVolume instance. Before this new LogicalVolume instance can be enabled (via a SetParameterValues command), it MUST have the following parameters configured: Name, PhysicalReference, and Capacity. Once an instance is enabled the following parameters become immutable for the life of the instance: Name, PhysicalReference, and Capacity. 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 Name.	-	1.0
Alias	string(:64)	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. Active Notification requests for this parameter MAY be denied.	-	1.2
Name	string(:64)	W	The name of the partition for this logical volume. Once this instance becomes enabled, this parameter will be immutable for the life of the instance. This parameter acts as the unique identifier for the instance, thus the device MUST NOT allow multiple LogicalVolume instances to use the same Name.	<Empty>	1.0
Status	string	R	The current status of this Logical Volume. Enumeration of: Offline Online Error The default Offline status will exist until this LogicalVolume is enabled.	Offline	1.0
Enable	boolean	W	Enables or disables this LogicalVolume instance.	false	1.0
PhysicalReference	string(:256)	W	The value MUST be the Path Name of a row in the PhysicalMedium. or StorageArray. tables. Represents the physical medium or RAID where this LogicalVolume resides. The PhysicalMedium.{i}. or StorageArray.{i}. referenced by this parameter MUST exist within the same StorageService instance. An AddObject followed by an enabling SetParameterValues on Name, PhysicalReference, and Capacity will cause the formatting of this logical partition and these parameters to become immutable for the life of this instance.	-	1.0
FileSystem	string	R	The value MUST be a member of the list reported by the Capabilities.SupportedFileSystemTypes parameter. The file system for this LogicalVolume as it is currently formatted.	-	1.0
Capacity	unsignedInt	W	The Capacity of the Logical Volume in MB. Once this instance becomes enabled, this parameter will be immutable for the life of the instance.	-	1.0
UsedSpace	unsignedInt	R	The Amount of Used Space on the Logical Volume in MB. Active Notification requests for this parameter MAY be denied.	-	1.0
ThresholdLimit	unsignedInt	W	This value is specified in MB and controls when ThresholdReached will have its value altered. If the value of UsedSpace plus the value of ThresholdLimitr is greater than or equal to the value of Capacity then the value of ThresholdReached will be true, otherwise it will be false. Setting the value of this parameter to 0 will disable the Thresholding mechanism.	0	1.0
ThresholdReached	boolean	R	When ThresholdLimit > 0 and UsedSpace + ThresholdLimit >= Capacity this will be true, else false.	false	1.0
Encrypted	boolean	R	Is the Volume Encrypted? The type of encryption will be handled by the device internally and is not a matter for remote management.	-	1.0
FolderNumberOfEntries	unsignedInt	R	The number of instances of LogicalVolume.{i}.Folder.{i}. on this LogicalVolume.	-	1.0
StorageService.{i}.LogicalVolume.{i}.Folder.{i}.	object(0:)	W	This object provides information about each top-level folder configured on this logical volume. Each top-level folder allows the configuration of quotas and access permissions. Creating an instance of this object generates a disabled Folder instance. Before this new Folder instance can be enabled (via a SetParameterValues command), it MUST have the Name configured. Folder instances are unique per LogicalVolume.{i}. and the unique key for this object is Name which also means that once an instance is enabled Name becomes immutable for the life of the instance. 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 Name.	-	1.0
Alias	string(:64)	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. Active Notification requests for this parameter MAY be denied.	-	1.2
Name	string(:64)	W	Setting of this variable will add a new folder. The full hierarchical pathname of the folder MUST be specified. All folders created on the Logical Volume will appear here, created locally or via AddObject. The local directory name will be formatted as a UNIX-style directory name, for example: /home/ftp The presence of a trailing `/’ character is inconsequential, meaning that /home/ftp/ is the same as /home/ftp. Once this instance becomes enabled, this parameter will be immutable for the life of the instance. This parameter acts as the unique identifier for the instance, thus the device MUST NOT allow multiple Folder instances within a LogicalVolume.{i}. to use the same Name.	<Empty>	1.0
Enable	boolean	W	Entry is enabled or disabled	false	1.0
UserAccountAccess	unsignedInt(0:3)	W	What are the User authentication requirements of this folder? The following bitmap is used. 11 = Authenticated Access required for Network protocols (NFS/AFP/SMB) and for non Network protocols (FTP/SFTP/HTTP/HTTPS) 10 = Authenticated Access required for Network protocols (NFS/AFP/SMB) 01 = Authenticated Access Required for non Network protocols (FTP/SFTP/HTTP/HTTPS) 00 = No Authentication required	2	1.0
UserAccessNumberOfEntries	unsignedInt	R	The number of instances of LogicalVolume.{i}.Folder.{i}.UserAccess.{i}. on this LogicalVolume.{i}.Folder.{i}..	-	1.0
GroupAccessNumberOfEntries	unsignedInt	R	The number of instances of LogicalVolume.{i}.Folder.{i}.GroupAccess.{i}. on this LogicalVolume.{i}.Folder.{i}.	-	1.0
StorageService.{i}.LogicalVolume.{i}.Folder.{i}.UserAccess.{i}.	object(0:)	W	This object provides information about each user account configured for access permissions on this folder. 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 UserReference.	-	1.0
Alias	string(:64)	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. Active Notification requests for this parameter MAY be denied.	-	1.2
Enable	boolean	W	Enables or disables the entry.	false	1.1
UserReference	string(:256)	W	The value MUST be the Path Name of a row in the UserAccount. table. Represents a user that has access to this folder. The instance of UserAccount.{i}. referenced by this parameter MUST exist within the same StorageService instance.	<Empty>	1.0
Permissions	unsignedInt(0:7)	W	What permissions the user account has over this LogicalVolume.{i}.Folder.{i}.. This is an integer value like the xNIX systems use for access permissions, meaning that it is a 3-bit field with the following structure: 100 = read field 010 = write field 001 = execute field	7	1.0
StorageService.{i}.LogicalVolume.{i}.Folder.{i}.GroupAccess.{i}.	object(0:)	W	This object provides information about each user group configured for access permissions on this folder. 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 GroupReference.	-	1.0
Alias	string(:64)	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. Active Notification requests for this parameter MAY be denied.	-	1.2
Enable	boolean	W	Enables or disables the entry. The factory default value MUST be false.	-	1.1
GroupReference	string(:256)	W	The value MUST be the Path Name of a row in the UserGroup. table. Represents a user group that is a collection of User Accounts that have access to this folder. The UserGroup.{i}. referenced by this parameter MUST exist within the same StorageService instance.	<Empty>	1.0
Permissions	unsignedInt(0:7)	W	What permissions the group members have over this LogicalVolume.{i}.Folder.{i}. instance. This is an integer value like the xNIX systems use for access permissions, meaning that it is a 3-bit field with the following structure: 100 = read field 010 = write field 001 = execute field	7	1.0
StorageService.{i}.LogicalVolume.{i}.Folder.{i}.Quota.	object	R	This object allows the configuration of per-folder storage quota management.	-	1.0
Enable	boolean	W	Enables or disables quota management for this folder.	false	1.0
Capacity	unsignedInt	W	Maximum size in MB of the quota for this folder.	-	1.0
UsedSpace	unsignedInt	R	Current size in MB of this folder. Active Notification requests for this parameter MAY be denied.	-	1.0
ThresholdLimit	unsignedInt	W	This value is specified in MB and controls when ThresholdReached will have its value altered. If the value of UsedSpace plus the value of this parameter is greater than or equal to the value of Capacity then the value of ThresholdReached will be true, otherwise it will be false. Setting the value of this parameter to 0 will disable the Thresholding mechanism.	0	1.0
ThresholdReached	boolean	R	When ThresholdLimit > 0 and UsedSpace + ThresholdLimit >= Capacity this will be true, else false.	false	1.0

Inform and Notification Requirements

Parameters for which Active Notification MAY be Denied

Parameter
StorageService.{i}.
Alias
StorageService.{i}.UserGroup.{i}.
Alias
StorageService.{i}.UserAccount.{i}.
Alias
StorageService.{i}.PhysicalMedium.{i}.
Alias
Uptime
StorageService.{i}.StorageArray.{i}.
Alias
StorageService.{i}.LogicalVolume.{i}.
Alias
UsedSpace
StorageService.{i}.LogicalVolume.{i}.Folder.{i}.
Alias
StorageService.{i}.LogicalVolume.{i}.Folder.{i}.UserAccess.{i}.
Alias
StorageService.{i}.LogicalVolume.{i}.Folder.{i}.GroupAccess.{i}.
Alias
StorageService.{i}.LogicalVolume.{i}.Folder.{i}.Quota.
UsedSpace

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.

Baseline:1 Profile

This table defines the Baseline:1 profile for the StorageService:1 data model. The minimum REQUIRED version for this profile is StorageService:1.0.

Name	Requirement
StorageService.{i}.	P
Enable	W
PhysicalMediumNumberOfEntries	R
LogicalVolumeNumberOfEntries	R
StorageService.{i}.Capabilities.	P
FTPCapable	R
SFTPCapable	R
HTTPCapable	R
HTTPSCapable	R
HTTPWritable	R
SupportedNetworkProtocols	R
SupportedFileSystemTypes	R
VolumeEncryptionCapable	R
StorageService.{i}.NetInfo.	P
HostName	W
DomainName	W
StorageService.{i}.NetworkServer.	P
AFPEnable	R
NFSEnable	R
SMBEnable	R
NetworkProtocolAuthReq	R
StorageService.{i}.PhysicalMedium.{i}.	P
Name	R
Vendor	R
Model	R
SerialNumber	R
FirmwareVersion	R
ConnectionType	R
Removable	R
Capacity	R
Status	R
SMARTCapable	R
HotSwappable	R
StorageService.{i}.LogicalVolume.{i}.	P
Name	R
Status	R
Enable	R
PhysicalReference	R
FileSystem	R
Capacity	R
UsedSpace	R
Encrypted	R
FolderNumberOfEntries	R
StorageService.{i}.LogicalVolume.{i}.Folder.{i}.	P
Name	R
Enable	R
UserAccountAccess	R

UserAccess:1 Profile

This table defines the UserAccess:1 profile for the StorageService:1 data model. The minimum REQUIRED version for this profile is StorageService:1.0.

Name	Requirement
StorageService.{i}.	P
UserAccountNumberOfEntries	R
StorageService.{i}.NetworkServer.	P
NetworkProtocolAuthReq	W
StorageService.{i}.UserAccount.{i}.	C
Enable	W
Username	W
Password	W
StorageService.{i}.LogicalVolume.{i}.Folder.{i}.	P
UserAccountAccess	W
UserAccessNumberOfEntries	R
StorageService.{i}.LogicalVolume.{i}.Folder.{i}.UserAccess.{i}.	C
UserReference	W
Permissions	W

GroupAccess:1 Profile

The GroupAccess:1 profile for the StorageService:1 data model is defined as the union of the UserAccess:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is StorageService:1.0.

Name	Requirement
StorageService.{i}.	P
UserGroupNumberOfEntries	R
StorageService.{i}.UserGroup.{i}.	C
Enable	W
GroupName	W
StorageService.{i}.UserAccount.{i}.	C
UserGroupParticipation	W
StorageService.{i}.LogicalVolume.{i}.Folder.{i}.GroupAccess.{i}.	C
GroupReference	W
Permissions	W

FTPServer:1 Profile

This table defines the FTPServer:1 profile for the StorageService:1 data model. The minimum REQUIRED version for this profile is StorageService:1.0.

Name	Requirement
StorageService.{i}.FTPServer.	P
Enable	W
Status	R
MaxNumUsers	W
IdleTime	W
PortNumber	W
StorageService.{i}.FTPServer.AnonymousUser.	P
Enable	W
StartingFolder	W
ReadOnlyAccess	W

SFTPServer:1 Profile

The SFTPServer:1 profile for the StorageService:1 data model is defined as the union of the FTPServer:1 and UserAccess:1 profiles and the additional requirements defined in this table. The minimum REQUIRED version for this profile is StorageService:1.0.

Name	Requirement
StorageService.{i}.UserAccount.{i}.	P
AllowFTPAccess	W
StorageService.{i}.SFTPServer.	P
Enable	W
Status	R
MaxNumUsers	W
IdleTime	W
PortNumber	W

HTTPServer:1 Profile

This table defines the HTTPServer:1 profile for the StorageService:1 data model. The minimum REQUIRED version for this profile is StorageService:1.0.

Name	Requirement
StorageService.{i}.HTTPServer.	P
Enable	W
Status	R
MaxNumUsers	W
IdleTime	W
HTTPWritingEnabled	R
PortNumber	W
AuthenticationReq	W

HTTPSServer:1 Profile

The HTTPSServer:1 profile for the StorageService:1 data model is defined as the union of the HTTPServer:1 and UserAccess:1 profiles and the additional requirements defined in this table. The minimum REQUIRED version for this profile is StorageService:1.0.

Name	Requirement
StorageService.{i}.UserAccount.{i}.	P
AllowHTTPAccess	W
StorageService.{i}.HTTPSServer.	P
Enable	W
Status	R
MaxNumUsers	W
IdleTime	W
HTTPWritingEnabled	R
PortNumber	W
AuthenticationReq	W

VolumeConfig:1 Profile

The VolumeConfig:1 profile for the StorageService:1 data model is defined as the union of the Baseline:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is StorageService:1.0.

Name	Requirement
StorageService.{i}.PhysicalMedium.{i}.	P
Name	W
StorageService.{i}.LogicalVolume.{i}.	C
Name	W
Enable	W
FileSystem	R
Capacity	W
StorageService.{i}.LogicalVolume.{i}.Folder.{i}.	C
Name	W
Enable	W
UserAccountAccess	W

RAID:1 Profile

This table defines the RAID:1 profile for the StorageService:1 data model. The minimum REQUIRED version for this profile is StorageService:1.0.

Name	Requirement
StorageService.{i}.	P
StorageArrayNumberOfEntries	R
StorageService.{i}.Capabilities.	P
SupportedRaidTypes	R
StorageService.{i}.StorageArray.{i}.	C
Name	W
Status	R
Enable	W
RaidType	W
UsableCapacity	R
PhysicalMediumReference	W

FolderQuota:1 Profile

This table defines the FolderQuota:1 profile for the StorageService:1 data model. The minimum REQUIRED version for this profile is StorageService:1.0.

Name	Requirement
StorageService.{i}.LogicalVolume.{i}.Folder.{i}.Quota.	P
Enable	W
Capacity	W
UsedSpace	R
ThresholdLimit	W
ThresholdReached	R

VolumeThresh:1 Profile

This table defines the VolumeThresh:1 profile for the StorageService:1 data model. The minimum REQUIRED version for this profile is StorageService:1.0.

Name	Requirement
StorageService.{i}.LogicalVolume.{i}.	P
Capacity	R
ThresholdLimit	W
ThresholdReached	R

NetServer:1 Profile

This table defines the NetServer:1 profile for the StorageService:1 data model. The minimum REQUIRED version for this profile is StorageService:1.0.

Name	Requirement
StorageService.{i}.NetworkServer.	P
AFPEnable	W
NFSEnable	W
SMBEnable	W

Baseline:2 Profile

The Baseline:2 profile for the StorageService:1 data model is defined as the union of the Baseline:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is StorageService:1.1.

Name	Requirement
StorageServiceNumberOfEntries	R

UserAccess:2 Profile

The UserAccess:2 profile for the StorageService:1 data model is defined as the union of the UserAccess:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is StorageService:1.1.

Name	Requirement
StorageService.{i}.LogicalVolume.{i}.Folder.{i}.UserAccess.{i}.	C
Enable	W

GroupAccess:2 Profile

The GroupAccess:2 profile for the StorageService:1 data model is defined as the union of the GroupAccess:1 profile and the additional requirements defined in this table. The minimum REQUIRED version for this profile is StorageService:1.1.

Name	Requirement
StorageService.{i}.LogicalVolume.{i}.Folder.{i}.GroupAccess.{i}.	C
Enable	W

Generated by Broadband Forum bbfreport v2.2.0 (2024-07-23 version) on 2024-09-04 at 10:40:20 UTC.
report.py –output –format markdown tr-140-1-3-1-cwmp.xml