![]() DATA MODEL DEFINITION |
|
This Broadband Forum Document is provided AS IS, WITH ALL FAULTS. ANY PERSON HOLDING A COPYRIGHT IN THIS BROADBAND FORUM DOCUMENT, OR ANY PORTION THEREOF, DISCLAIMS TO THE FULLEST EXTENT PERMITTED BY LAW ANY REPRESENTATION OR WARRANTY, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY:
By using this Broadband Forum Document, users acknowledge that implementation may require licenses to patents. The Broadband Forum encourages but does not require its members to identify such patents. For a list of declarations made by Broadband Forum member companies, please see http://www.broadband-forum.org. No assurance is given that licenses to patents necessary to implement this Document will be available for license at all or on reasonable and non-discriminatory terms.
ANY PERSON HOLDING A COPYRIGHT IN THIS BROADBAND FORUM DOCUMENT, OR ANY PORTION THEREOF, DISCLAIMS TO THE FULLEST EXTENT PERMITTED BY LAW (A) ANY LIABILITY (INCLUDING DIRECT, INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES UNDER ANY LEGAL THEORY) ARISING FROM OR RELATED TO THE USE OF OR RELIANCE UPON THIS DOCUMENT; AND (B) ANY OBLIGATION TO UPDATE OR CORRECT THIS DOCUMENT.
Broadband Forum Documents may be copied, downloaded, stored on a server or otherwise re-distributed in their entirety only, and may not be modified without the advance written permission of the Broadband Forum.
The text of this notice must be included in all copies of this Broadband Forum Document.
| Data Type | Base Type | Description |
|---|---|---|
| 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-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
| [SOAP1.1] | Simple Object Access Protocol (SOAP) 1.1, W3C. |
| [TR-106a6] | TR-106 Amendment 6, Data Model Template for TR-069-Enabled Devices, Broadband Forum, 2011. |
For a given implementation of this data model, the CPE MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the CPE supports only a single parameter that was introduced in version 1.2, then it will indicate support for version 1.2. 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. |
- | 1.0 |
| Alias | string(64) | W | 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-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.2 |
| StorageService.{i}.UserGroup.{i}. | object | 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 CPE 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 |
| Alias | string(64) | W | 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-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.2 |
| StorageService.{i}.UserAccount.{i}. | object | 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 CPE 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 |
| Alias | string(64) | W | 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-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.2 |
| 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. |
- | 1.0 |
| Alias | string(64) | W | 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-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.2 |
| StorageService.{i}.StorageArray.{i}. | object | 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 CPE 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 | 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-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.2 |
| StorageService.{i}.LogicalVolume.{i}. | object | 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 CPE 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 | 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-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.2 |
| StorageService.{i}.LogicalVolume.{i}.Folder.{i}. | object | 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 CPE 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 | 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-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.2 |
| StorageService.{i}.LogicalVolume.{i}.Folder.{i}.UserAccess.{i}. | object | 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 CPE 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 | 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-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.2 |
| StorageService.{i}.LogicalVolume.{i}.Folder.{i}.GroupAccess.{i}. | object | 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 CPE 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 | 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-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:
|
- | 1.2 |
| Parameter |
|---|
| Parameter |
|---|
| Parameter |
|---|
| 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 via AddObject and DeleteObject is REQUIRED. |
| A | Creation of instances of the object via AddObject is REQUIRED, but deletion is not REQUIRED. |
| D | Deletion of instances of the object via DeleteObject is REQUIRED, but creation is not REQUIRED. |