{{docname|StorageService:1.3 Service Object Definition}} {{appdate|September 2019}} {{trname|TR-140a3}} May 2017: {{xmlref|tr-140-1-3-0|Original}} * Update file system and connection enumerations * Added SMART data model September 2019: {{xmlref|tr-140-1-3-1-cwmp|Corrigendum 1}} * Added USP support (split XML into common, CWMP and USP files) A non-volatile handle used to reference this instance. '''This is intended only for use in protocol-independent "common" definitions, and MUST NOT be used in protocol-specific definitions.''' 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 {{bibref|TR-069|3.6.1}} and described in {{bibref|TR-069|Appendix II}}, 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. 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 {{bibref|TR-069|3.6.1}} and described in {{bibref|TR-069|Appendix II}}, 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. 3GPP TS 23.003 Numbering, addressing and identification 3GPP CT WG4 https://www.3gpp.org/ftp/Specs/html-info/23003.htm Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority Guidelines for 64-bit Global Identifier (EUI-64) Registration Authority IEEE March 1997 https://standards.ieee.org/regauth/oui/tutorials/EUI64.html IANA Uniform Resource Identifier (URI) Schemes Registry Uniform Resource Identifier (URI) Schemes IANA https://www.iana.org/assignments/uri-schemes RFC 3986 Uniform Resource Identifier (URI): Generic Syntax IETF RFC https://www.rfc-editor.org/rfc/rfc3986 RFC 4007 IPv6 Scoped Address Architecture IETF RFC https://www.rfc-editor.org/rfc/rfc4007 RFC 4122 A Universally Unique IDentifier (UUID) URN Namespace IETF RFC 2005 https://www.rfc-editor.org/rfc/rfc4122 RFC 4291 IP Version 6 Addressing Architecture IETF RFC 2006 https://www.rfc-editor.org/rfc/rfc4291 RFC 4632 Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan IETF 2006 https://www.rfc-editor.org/rfc/rfc4632 RFC7159 The JavaScript Object Notation (JSON) Data Interchange Format IETF RFC March 2014 https://www.rfc-editor.org/rfc/rfc7159 RFC 7230 Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing IETF RFC June 2014 https://www.rfc-editor.org/rfc/rfc7230 RFC 7252 The Constrained Application Protocol (CoAP) IETF RFC June 2014 https://www.rfc-editor.org/rfc/rfc7252 RFC 8141 Uniform Resource Names (URNs) IETF RFC April 2017 https://www.rfc-editor.org/rfc/rfc8141 TR-069 Amendment 6 CPE WAN Management Protocol Broadband Forum TR April 2018 TR-106 Amendment 8 Data Model Template for CWMP Endpoints and USP Agents Broadband Forum TR May 2018 Simple Object Access Protocol (SOAP) 1.1 W3C https://www.w3.org/TR/2000/NOTE-SOAP-20000508 ZigBee 2007 Specification ZigBee 2007 Specification ZigBee Alliance October 2007 https://csa-iot.org/all-solutions/zigbee Number of entries in {{object|StorageService}}. The Service Object for a Storage Service device. Enables or Disables the entire Storage mechanism. {{datatype|expand}} The number of instances of {{object|.PhysicalMedium.{i}.}}. The number of instances of {{object|.StorageArray.{i}.}}. The number of instances of {{object|.LogicalVolume.{i}.}}. The number of instances of {{object|.UserAccount.{i}.}}. The number of instances of {{object|.UserGroup.{i}.}}. 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. Does this device contain an FTP server allowing clients to access the data via an FTP client? Does this device contain an SSH FTP server allowing clients to access the data via an SFTP client? Does this device contain an HTTP server allowing clients to access the data via an HTTP client? Does this device contain an HTTPS server allowing clients to access the data via an HTTPS client? 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. {{list}} Supported application-level network protocols. {{enum}} The list MAY include vendor-specific protocols, which MUST be in the format defined in {{bibref|TR-106}}. For example: "X_EXAMPLE-COM_MyProt. {{list}} Supported FileSystems Types. {{enum}} The list MAY include vendor-specific protocols, which MUST be in the format defined in {{bibref|TR-106}}. For example: "X_EXAMPLE-COM_MyType. Resilient File System - Microsoft Mac OS Standard format Mac OS Extended format Journaled Mac OS Extended format ReiserFS Zetta File System Encrypted File System Extended File Allocation Table for Flash memory {{list}} Supported RAID types. {{enum}} The list MAY include vendor-specific protocols, which MUST be in the format defined in {{bibref|TR-106}}. For example:"X_EXAMPLE-COM_MyRaid. Does this device have the ability to encrypt and decrypt Logical Volumes as they are stored and retrieved? This object provides general LAN network information about this device. Logical name which identifies the device on the local network. This is the first segment of a fully qualified domain name (FQDN). Combining {{param}}, a "." and the {{param|DomainName}} will result in a fully qualified domain name. Domain name for the device on the local network. Combining {{param|HostName}}, a "." and {{param}} 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". This object provides information about each user group configured on this device, which allows the grouping of user accounts for easier maintenance of permissions. Enables or disables this group. {{datatype|expand}} The unique name of the group. This object provides information about each user configured on this device, which provides a means for controlling access to the device. Enables or disables this user. {{datatype|expand}} The unique name of the user. Also used for authentication. Password used to authenticate the user when connecting to the Storage Service Device. Represents a User Group that this User Account is a member of. Each {{object|.UserGroup.{i}.}} referenced by this parameter MUST exist within the same StorageService instance. Enables or disables access via FTP (including SSH FTP access) for this user. Enables or disables access via HTTP (including HTTPS access) for this user. This object allows the control of network layer protocols authorization enforcement. Enables or disables the AFP network protocol. Enables or disables the NFS network protocol. Enables or disables the SMB network protocol. 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 {{object|.UserAccount.{i}.}} found on this device. This object allows the configuration of the FTP server. Enables or disables the FTP server. The current status of this FTP server. Maximum number of users allowed to log in to the device at once via FTP. Maximum amount of time in {{units}} that the FTP socket will remain open without any activity. If set to 0 an infinite timeout will apply. The port number that the FTP server is listening on. This object allows the configuration of anonymous FTP access. Enables or disables support for anonymous access into the FTP server Represents the home directory for anonymous FTP access. The {{object|.LogicalVolume.{i}.Folder.{i}.}} referenced by this parameter MUST exist within the same StorageService instance. 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 {{param|StartingFolder}}. This SHOULD default to True. This object allows the configuration of the SSH FTP server. Enables or disables the SSH FTP server. The current status of this SSH FTP server. Maximum number of users allowed to log in to the device at once via SFTP. Maximum amount of time in {{units}} that the SFTP socket will remain open without any activity. If set to 0 an infinite timeout will apply. The port number that the SSH FTP server is listening on. This object allows the configuration of the HTTP server. Enables or disables the HTTP server. The current status of this HTTP server. Maximum number of users allowed to log in to the device at once via HTTP. Maximum amount of time in {{units}} that the HTTP socket will remain open without any activity. If set to 0 an infinite timeout will apply. Is support for the HTTP PUT/POST mechanism (WebDAV) enabled? The port number that the HTTP server is listening on. If {{true}}, HTTP will require login prior to access (basic or digest authentication). This object allows the configuration of the HTTPS server. Enables or disables the HTTPS server. The current status of this HTTPS server. Maximum number of users allowed to log in to the device at once via HTTPS. Maximum amount of time in {{units}} that the HTTPS socket will remain open without any activity. If set to 0 an infinite timeout will apply. Is support for the HTTP PUT/POST mechanism (WebDAV) enabled? The port number that the HTTPS server is listening on. If {{true}}, HTTPS will require login prior to access (basic or digest authentication). This object provides information about each physical medium connected to this device. {{datatype|expand}} A user-friendly name for this physical storage medium. The vendor of this physical storage medium. The model name/number of this physical storage medium. The serial number of this physical storage medium. The firmware version for firmware contained within the physical medium's controller. The method of connection to this storage device. {{enum}} The parameter MAY instead be a vendor-specific connection type, which MUST be in the format defined in {{bibref|TR-106}}. For example: "X_EXAMPLE-COM_MyConnType" SATA 3.0 Gbit/s SATA 6.0 Gbit/s SATA 16.0 Gbit/s serial attached SCSI 3.0 Gbit/s serial attached SCSI 6.0 Gbit/s serial attached SCSI 12.0 Gbit/s serial attached SCSI 22.5 Gbit/s Specifies the type of the physical medium Hybrid Drive 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. The formatted capacity of the physical storage medium in {{units}}. The general activity status of this physical storage medium. Time since boot in {{units}}. This MAY reflect S.M.A.R.T. PowerOnHours. Is this physical medium capable of reporting S.M.A.R.T. statistics? The general health of this physical storage medium. {{enum}} Note: Health MAY be obtained from S.M.A.R.T. data where available. 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. This object provides SMART data information about the physical medium. SMART attributes are not standardized, but many vendors provide the data below. 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. Count of hours in power-on state. It shows total count of {{units}} in power-on state. 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. The count of full hard disk power on/off cycles. Current internal temperature in {{units}}. 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. 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. 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. Total number of unrecoverable read errors. Total number of off-track errors. Total number of errors when writing a sector. Percentage of the spare sectors that can be used for reallocations remaining. Estimated number of {{units}} until the failure model in the device predicts the drive will fail. -1 means the failure model is unable to make a prediction. This object provides information about each storage array (RAID) configured on this device. Creating an instance of this object generates a disabled {{object}} instance. Before this new {{object}} instance can be enabled (via a SetParameterValues command), it MUST have the following parameters configured: {{param|Name}}, {{param|RaidType}}, and {{param|PhysicalMediumReference}}. Once an instance is enabled the following parameters become immutable for the life of the instance: {{param|Name}}, {{param|RaidType}}, and {{param|PhysicalMediumReference}}. {{datatype|expand}} A user-friendly name for this Storage Array. Once this instance becomes enabled, this parameter will be immutable for the life of the instance. The current status of this StorageArray. 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. 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. 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. Indicates the RAID array is fully operational. 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. 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. Indicates the loss of data redundancy, and a possible degraded state. The array continues to perform read/write operations. Enables or disables this StorageArray instance. 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 {{param|.Capabilities.SupportedRaidTypes}}. Once this instance becomes enabled, this parameter will be immutable for the life of the instance. The total Usable Capacity of the Storage Array in {{units}}. This is computed by the system based on {{param|PhysicalMediumReference}} and {{param|RaidType}}. Disk size is a consideration, as many RAID Types use the smallest drive in the group for calculations. Represents the physical medium used by this RAID. Each Physical Medium referenced by this parameter MUST exist within the same StorageService instance. A {{object|.PhysicalMedium.{i}.}} MUST only be referenced by one {{object|.StorageArray.{i}.}} instance. Once this instance becomes enabled, this parameter will be immutable for the life of the instance. This object provides information about each logical volume configured on this device. A logical volume can reside either on an instance of a single {{object|.PhysicalMedium.{i}.}} or on an instance of a single {{object|.StorageArray.{i}.}} instance, but it can not span multiple instances of either. {{param|PhysicalReference}} is used to define where this {{object}} instance resides. Creating an instance of this object generates a disabled {{object}} instance. Before this new {{object}} instance can be enabled (via a SetParameterValues command), it MUST have the following parameters configured: {{param|Name}}, {{param|PhysicalReference}}, and {{param|Capacity}}. Once an instance is enabled the following parameters become immutable for the life of the instance: {{param|Name}}, {{param|PhysicalReference}}, and {{param|Capacity}}. {{datatype|expand}} 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 {{object}} instances to use the same {{param}}. The current status of this Logical Volume. {{enum}} The default {{enum|Offline}} status will exist until this {{object}} is enabled. Enables or disables this {{object}} instance. Represents the physical medium or RAID where this {{object}} resides. The {{object|.PhysicalMedium.{i}.}} or {{object|.StorageArray.{i}.}} referenced by this parameter MUST exist within the same StorageService instance. An AddObject followed by an enabling SetParameterValues on {{param|Name}}, {{param}}, and {{param|Capacity}} will cause the formatting of this logical partition and these parameters to become immutable for the life of this instance. The file system for this {{object}} as it is currently formatted. The Capacity of the Logical Volume in {{units}}. Once this instance becomes enabled, this parameter will be immutable for the life of the instance. The Amount of Used Space on the Logical Volume in {{units}}. This value is specified in {{units}} and controls when {{param|ThresholdReached}} will have its value altered. If the value of {{param|UsedSpace}} plus the value of {{param}}r is greater than or equal to the value of {{param|Capacity}} then the value of {{param|ThresholdReached}} will be {{true}}, otherwise it will be {{false}}. Setting the value of this parameter to 0 will disable the Thresholding mechanism. When {{param|ThresholdLimit}} > 0 and {{param|UsedSpace}} + {{param|ThresholdLimit}} >= {{param|Capacity}} this will be {{true}}, else {{false}}. Is the Volume Encrypted? The type of encryption will be handled by the device internally and is not a matter for remote management. The number of instances of {{object|.LogicalVolume.{i}.Folder.{i}.}} on this {{object}}. 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 {{object}} instance. Before this new {{object}} instance can be enabled (via a SetParameterValues command), it MUST have the {{param|Name}} configured. Folder instances are unique per {{object|.LogicalVolume.{i}.}} and the unique key for this object is {{param|Name}} which also means that once an instance is enabled {{param|Name}} becomes immutable for the life of the instance. {{datatype|expand}} 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 {{object}} instances within a {{object|.LogicalVolume.{i}.}} to use the same {{param}}. Entry is enabled or disabled 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 The number of instances of {{object|.LogicalVolume.{i}.Folder.{i}.UserAccess.{i}.}} on this {{object|.LogicalVolume.{i}.Folder.{i}.}}. The number of instances of {{object|.LogicalVolume.{i}.Folder.{i}.GroupAccess.{i}.}} on this {{object|.LogicalVolume.{i}.Folder.{i}.}} This object provides information about each user account configured for access permissions on this folder. {{datatype|expand}} Enables or disables the entry. Represents a user that has access to this folder. The instance of {{object|.UserAccount.{i}.}} referenced by this parameter MUST exist within the same StorageService instance. What permissions the user account has over this {{object|.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 This object provides information about each user group configured for access permissions on this folder. {{datatype|expand}} Enables or disables the entry. Represents a user group that is a collection of User Accounts that have access to this folder. The {{object|.UserGroup.{i}.}} referenced by this parameter MUST exist within the same StorageService instance. What permissions the group members have over this {{object|.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 This object allows the configuration of per-folder storage quota management. Enables or disables quota management for this folder. Maximum size in {{units}} of the quota for this folder. Current size in {{units}} of this folder. This value is specified in {{units}} and controls when {{param|ThresholdReached}} will have its value altered. If the value of {{param|UsedSpace}} plus the value of this parameter is greater than or equal to the value of {{param|Capacity}} then the value of {{param|ThresholdReached}} will be {{true}}, otherwise it will be {{false}}. Setting the value of this parameter to 0 will disable the Thresholding mechanism. When {{param|ThresholdLimit}} > 0 and {{param|UsedSpace}} + {{param|ThresholdLimit}} >= {{param|Capacity}} this will be {{true}}, else {{false}}.