8.1 Resource Type <mgmtObj> primitive mappings
8.1.0 Introduction
This clause contains all information on how to map Resource Type <mgmtObj> primitives from TS-0004 [2] to the Remote Procedure Calls (RPCs) in TR-069 [4].
8.1.1 Alias-Based Addressing Mechanism
In order to utilize the Alias-Based Addressing Mechanism, the mechanism has to be supported by the ACS and CPE in order to map the M2M Service Layer identifier for the Resource instance to the CPE object instance. If the AliasBased Addressing Mechanism feature is not supported by either the ACS or CPE, the CSE has to retain the mapping of the these M2M Resource instance identifiers.
8.1.2 Create primitive mapping
8.1.2.0 Introduction
The Create Request and Response primitives shall map to the AddObject RPC. The AddObject RPC is defined in TR-069 [4] as a synchronous RPC and returns a successful response or one of the following fault codes in Table 8.1.2.0-1.
Table 8.1.2.0-1: AddObject Fault Code Mapping
| Fault code | Description | Response Status Code |
|---|---|---|
| 9001 | Request denied (no reason specified) | 4000 (BAD_REQUEST) |
| 9002 | Internal error | 4000 (BAD_REQUEST) |
| 9003 | Invalid arguments | 4000 (BAD_REQUEST) |
| 9004 | Resources exceeded (when used in association with SetParameterValues, this cannot be used to indicate Parameters in error) | 4000 (BAD_REQUEST) |
| 9005 | Invalid Parameter name (associated with Set/GetParameterValues, GetParameterNames, Set/GetParameterAttributes, AddObject, and DeleteObject) | 5001 (NOT_IMPLEMENTED) |
8.1.2.1 M2M Service Layer Resource Instance Identifier mapping
When the Resource is a multi-instance Resource, the AddObject RPC should utilize the Alias-Based Addressing Mechanism as defined in Section 3.6.1 of TR-069 [4] in order to use the Resource instance value of the URI.
8.1.3 Delete primitive mapping
8.1.3.1 Delete primitive mapping for deletion of Object Instances
The Delete Request and Response primitives that results in the deletion of a Resource shall map to the DeleteObject RPC. The DeleteObject RPC is defined in TR-069 [4] as a synchronous RPC and returns a successful response or one of the following fault codes in Table 8.1.3.1-1.
Table 8.1.3.1-1: DeleteObject Fault Code Mapping
| Fault code | Description | Response Status Code |
|---|---|---|
| 9001 | Request denied (no reason specified) | 4000 (BAD_REQUEST) |
| 9002 | Internal error | 4000 (BAD_REQUEST) |
| 9003 | Invalid arguments | 4000 (BAD_REQUEST) |
| 9005 | Invalid Parameter name (associated with Set/GetParameterValues, GetParameterNames, Set/GetParameterAttributes, AddObject, and DeleteObject) | 5001 (NOT_IMPLEMENTED) |
8.1.3.2 Delete primitive mapping for software un-install operation
The Delete Request and Response primitives that results in a software un-install operation (e.g. Resource [software]) shall use the ChangeDUState mechanism defined in TR-069 [4]. The ChangeDUState mechanism is an asynchronous command that consists of the synchronous ChangeDUState RPC for the un-installation request and the asynchronous ChangeDUStateComplete RPC. The ChangeDUState RPC returns a successful response or one of the following fault codes in Table 8.1.3.2-1. A successful response means that the CPE has accepted the ChangeDUState RPC.
Table 8.1.3.2-1: ChangeDUState Fault Code Mapping
| Fault code | Description | Response Status Code |
|---|---|---|
| 9000 | Method not supported | 4000 (BAD_REQUEST) |
| 9001 | Request denied (no reason specified) | 4000 (BAD_REQUEST) |
| 9002 | Internal error | 4000 (BAD_REQUEST) |
| 9004 | Resources exceeded (when used in association with SetParameterValues, this cannot be used to indicate Parameters in error) | 4000 (BAD_REQUEST) |
Once the CPE has attempted to change the state of the deployment unit, the CPE reports the result of the state change operation using the ChangeDUStateComplete RPC. The ChangeDUStateComplete RPC indicates a successful operation or one of the following fault codes in Table 8.1.3.2-2.
Table 8.1.3.2-2: ChangeDUStateComplete Fault Code Mapping
| Fault code | Description | Response Status Code |
|---|---|---|
| 9001 | Request denied (no reason specified) | 4000 (BAD_REQUEST) |
| 9003 | Invalid arguments | 4000 (BAD_REQUEST) |
| 9012 | File transfer server authentication failure (associated with Upload, Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9013 | Unsupported protocol for file transfer (associated with Upload, Download, ScheduleDownload, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9015 | File transfer failure: unable to contact file server (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9016 | File transfer failure: unable to access file (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9017 | File transfer failure: unable to complete download (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9018 | File transfer failure: file corrupted or otherwise unusable (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9022 | Invalid UUID Format (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install, Update, and Uninstall) | 4000 (BAD_REQUEST) |
| 9023 | Unknown Execution Environment (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install only) | 4000 (BAD_REQUEST) |
| 9024 | Disabled Execution Environment (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install, Update, and Uninstall) | 4000 (BAD_REQUEST) |
| 9025 | Deployment Unit to Execution Environment Mismatch (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install and Update) | 4000 (BAD_REQUEST) |
| 9026 | Duplicate Deployment Unit (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install only) | 4000 (BAD_REQUEST) |
| 9027 | System Resources Exceeded (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install and Update) | 4000 (BAD_REQUEST) |
| 9028 | Unknown Deployment Unit (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Update and Uninstall) | 4000 (BAD_REQUEST) |
| 9029 | Invalid Deployment Unit State (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install, Update and Uninstall) | 4000 (BAD_REQUEST) |
| 9030 | Invalid Deployment Unit Update - Downgrade not permitted (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Update only) | 4000 (BAD_REQUEST) |
| 9031 | Invalid Deployment Unit Update - Version not specified (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Update only) | 4000 (BAD_REQUEST) |
| 9032 | Invalid Deployment Unit Update - Version already exists (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Update only) | 4000 (BAD_REQUEST) |
8.1.4 Update primitive mapping
8.1.4.1 Update primitive mapping for Parameter modifications
The Update Request and Response primitives that modifies the value of Resource attributes shall map to the SetParameterValues RPC. The SetParametersValue RPC is defined in TR-069 [4] as a synchronous RPC and returns a successful response or one of the following fault codes in Table 8.1.4.1-1.
Table 8.1.4.1-1: SetParameterValues Fault Code Mapping
| Fault code | Description | Response Status Code |
|---|---|---|
| 9001 | Request denied (no reason specified) | 4000 (BAD_REQUEST) |
| 9002 | Internal error | 4000 (BAD_REQUEST) |
| 9003 | Invalid arguments | 4000 (BAD_REQUEST) |
| 9004 | Resources exceeded (when used in association with SetParameterValues, this cannot be used to indicate Parameters in error) | 4000 (BAD_REQUEST) |
| 9005 | Invalid Parameter name (associated with Set/GetParameterValues, GetParameterNames, Set/GetParameterAttributes, AddObject, and DeleteObject) | 5001 (NOT_IMPLEMENTED) |
| 9006 | Invalid Parameter type (associated with SetParameterValues) | 4000 (BAD_REQUEST) |
| 9007 | Invalid Parameter value (associated with SetParameterValues) | 4000 (BAD_REQUEST) |
| 9008 | Attempt to set a non-writable Parameter (associated with SetParameterValues) | 4000 (BAD_REQUEST) |
8.1.4.2 Update primitive mapping for upload file transfer operations
The Update Request and Response primitives that results in an upload file transfer operation (e.g. logStop attribute of the Resource [eventLog]) shall use the Upload mechanism defined in TR-069 [4]. The Upload mechanism is an asynchronous command that consists of the synchronous Upload RPC for the Upload and the asynchronous TransferComplete RPC. The Upload RPC returns a successful response or one of the following fault codes in Table 8.1.4.2-1. A successful response means that the CPE has accepted the Upload RPC.
Table 8.1.4.2-1: Upload Fault Code Mapping
| Fault code | Description | Response Status Code |
|---|---|---|
| 9000 | Method not supported | 4000 (BAD_REQUEST) |
| 9001 | Request denied (no reason specified) | 4000 (BAD_REQUEST) |
| 9002 | Internal error | 4000 (BAD_REQUEST) |
| 9003 | Invalid arguments | 4000 (BAD_REQUEST) |
| 9004 | Resources exceeded (when used in association with SetParameterValues, this cannot be used to indicate Parameters in error) | 4000 (BAD_REQUEST) |
| 9011 | Upload failure (associated with Upload, TransferComplete or AutonomousTransferComplete methods). | 4000 (BAD_REQUEST) |
| 9012 | File transfer server authentication failure (associated with Upload, Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9013 | Unsupported protocol for file transfer (associated with Upload, Download, ScheduleDownload, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
Once the CPE has attempted to upload the file, the CPE reports the result of the Upload operation using the TransferComplete RPC. The TransferComplete RPC indicates a successful operation or one of the following fault codes in Table 8.1.4.2-2.
Table 8.1.4.2-2: TransferComplete Fault Code Mapping
| Fault code | Description | Response Status Code |
|---|---|---|
| 9001 | Request denied (no reason specified) | 4000 (BAD_REQUEST) |
| 9002 | Internal error | 4000 (BAD_REQUEST) |
| 9010 | File transfer failure (associated with Download, ScheduleDownload, TransferComplete or AutonomousTransferComplete methods). | 4000 (BAD_REQUEST) |
| 9011 | Upload failure (associated with Upload, TransferComplete or AutonomousTransferComplete methods). | 4000 (BAD_REQUEST) |
| 9012 | File transfer server authentication failure (associated with Upload, Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9014 | File transfer failure: unable to join multicast group (associated with Download, TransferComplete or AutonomousTransferComplete methods). | 4000 (BAD_REQUEST) |
| 9015 | File transfer failure: unable to contact file server (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9016 | File transfer failure: unable to access file (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9017 | File transfer failure: unable to complete download (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9018 | File transfer failure: file corrupted or otherwise unusable (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9019 | File transfer failure: file authentication failure (associated with Download, TransferComplete or AutonomousTransferComplete methods). | 4000 (BAD_REQUEST) |
| 9020 | File transfer failure: unable to complete download within specified time windows (associated with TransferComplete method). | 4000 (BAD_REQUEST) |
8.1.4.3 Update primitive mapping for download file transfer operations
The Update Request and Response primitives that results in a download file transfer operation (e.g. update attribute of Resource [firmware]) shall use the Download mechanism defined in TR-069 [4]. The Download mechanism is an asynchronous command that consists of the synchronous Download RPC for the Download and the asynchronous TransferComplete RPC. The Download RPC returns a successful response or one of the following fault codes in Table 8.1.4.3-1. A successful response means that the CPE has accepted the Download RPC.
Table 8.1.4.3-1: Download Fault Code Mapping
| Fault code | Description | Response Status Code |
|---|---|---|
| 9000 | Method not supported | 4000 (BAD_REQUEST) |
| 9001 | Request denied (no reason specified) | 4000 (BAD_REQUEST) |
| 9002 | Internal error | 4000 (BAD_REQUEST) |
| 9003 | Invalid arguments | 4000 (BAD_REQUEST) |
| 9004 | Resources exceeded (when used in association with SetParameterValues, this cannot be used to indicate Parameters in error) | 4000 (BAD_REQUEST) |
| 9010 | File transfer failure (associated with Download, ScheduleDownload, TransferComplete or AutonomousTransferComplete methods). | 4000 (BAD_REQUEST) |
| 9012 | File transfer server authentication failure (associated with Upload, Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9013 | Unsupported protocol for file transfer (associated with Upload, Download, ScheduleDownload, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
Once the CPE has attempted to download the file, the CPE reports the result of the download operation using the TransferComplete RPC. The TransferComplete RPC indicates a successful operation or one of the following fault codes in Table 8.1.4.3-2.
Table 8.1.4.3-2: TransferComplete Fault Code Mapping
| Fault code | Description | Response Status Code |
|---|---|---|
| 9001 | Request denied (no reason specified) | 4000 (BAD_REQUEST) |
| 9002 | Internal error | 4000 (BAD_REQUEST) |
| 9010 | File transfer failure (associated with Download, ScheduleDownload, TransferComplete or AutonomousTransferComplete methods). | 4000 (BAD_REQUEST) |
| 9011 | Upload failure (associated with Upload, TransferComplete or AutonomousTransferComplete methods). | 4000 (BAD_REQUEST) |
| 9012 | File transfer server authentication failure (associated with Upload, Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9014 | File transfer failure: unable to join multicast group (associated with Download, TransferComplete or AutonomousTransferComplete methods). | 4000 (BAD_REQUEST) |
| 9015 | File transfer failure: unable to contact file server (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9016 | File transfer failure: unable to access file (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9017 | File transfer failure: unable to complete download (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9018 | File transfer failure: file corrupted or otherwise unusable (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9019 | File transfer failure: file authentication failure (associated with Download, TransferComplete or AutonomousTransferComplete methods). | 4000 (BAD_REQUEST) |
| 9020 | File transfer failure: unable to complete download within specified time windows (associated with TransferComplete method). | 4000 (BAD_REQUEST) |
8.1.4.4 Update primitive mapping for reboot operation
The Update Request and Response primitives that results in a reboot operation (e.g. reboot attribute of Resource [reboot]) shall use the Reboot RPC defined in TR-069 [4]. The Reboot RPC is asynchronous command. The Reboot RPC returns a successful response or one of the following fault codes in Table 8.1.4.4-1.
Table 8.1.4.4-1: Reboot Fault Code Mapping
| Fault code | Description | Response Status Code |
|---|---|---|
| 9001 | Request denied (no reason specified) | 4000 (BAD_REQUEST) |
| 9002 | Internal error | 4000 (BAD_REQUEST) |
| 9003 | Invalid arguments | 4000 (BAD_REQUEST) |
8.1.4.5 Update primitive mapping for factory reset operation
The Update Request and Response primitives that results in a factory reset operation (e.g. factoryReset attribute of Resource [ reboot]) shall use the FactoryReset RPC defined in TR-069 [4]. The FactoryReset RPC is an asynchronous command. The FactoryReset RPC returns a successful response or one of the following fault codes in Table 8.1.4.5-1.
Table 8.1.4.5-1: FactoryReset Fault Code Mapping
| Fault code | Description | Response Status Code |
|---|---|---|
| 9000 | Method not supported | 4000 (BAD_REQUEST) |
| 9001 | Request denied (no reason specified) | 4000 (BAD_REQUEST) |
| 9002 | Internal error | 4000 (BAD_REQUEST) |
| 9003 | Invalid arguments | 4000 (BAD_REQUEST) |
8.1.4.6 Update primitive mapping for software install operation
The Update Request and Response primitives that results in a software installation operation (e.g. install attribute of Resource [software]) shall use the ChangeDUState mechanism defined in TR-069 [4]. The ChangeDUState mechanism is an asynchronous command that consists of the synchronous ChangeDUState RPC for the download and the asynchronous ChangeDUStateComplete RPC. The ChangeDUState RPC returns a successful response or one of the following fault codes in Table 8.1.4.6-1. A successful response means that the CPE has accepted the ChangeDUState RPC.
Table 8.1.4.6-1: ChangeDUState Fault Code Mapping
| Fault code | Description | Response Status Code |
|---|---|---|
| 9000 | Method not supported | 4000 (BAD_REQUEST) |
| 9001 | Request denied (no reason specified) | 4000 (BAD_REQUEST) |
| 9002 | Internal error | 4000 (BAD_REQUEST) |
| 9004 | Resources exceeded (when used in association with SetParameterValues, this cannot be used to indicate Parameters in error) | 4000 (BAD_REQUEST) |
Once the CPE has attempted to change the state of the deployment unit, the CPE reports the result of the state change operation using the ChangeDUStateComplete RPC. The ChangeDUStateComplete RPC indicates a successful operation or one of the following fault codes in Table 8.1.4.6-2.
Table 8.1.4.6-2: ChangeDUStateComplete Fault Code Mapping
| Fault code | Description | Response Status Code |
|---|---|---|
| 9001 | Request denied (no reason specified) | 4000 (BAD_REQUEST) |
| 9003 | Invalid arguments | 4000 (BAD_REQUEST) |
| 9012 | File transfer server authentication failure (associated with Upload, Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9013 | Unsupported protocol for file transfer (associated with Upload, Download, ScheduleDownload, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9015 | File transfer failure: unable to contact file server (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9016 | File transfer failure: unable to access file (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9017 | File transfer failure: unable to complete download (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9018 | File transfer failure: file corrupted or otherwise unusable (associated with Download, TransferComplete, AutonomousTransferComplete, DUStateChangeComplete, or AutonomousDUStateChangeComplete methods). | 4000 (BAD_REQUEST) |
| 9022 | Invalid UUID Format (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install, Update, and Uninstall) | 4000 (BAD_REQUEST) |
| 9023 | Unknown Execution Environment (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install only) | 4000 (BAD_REQUEST) |
| 9024 | Disabled Execution Environment (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install, Update, and Uninstall) | 4000 (BAD_REQUEST) |
| 9025 | Deployment Unit to Execution Environment Mismatch (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install and Update) | 4000 (BAD_REQUEST) |
| 9026 | Duplicate Deployment Unit (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install only) | 4000 (BAD_REQUEST) |
| 9027 | System Resources Exceeded (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install and Update) | 4000 (BAD_REQUEST) |
| 9028 | Unknown Deployment Unit (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Update and Uninstall) | 4000 (BAD_REQUEST) |
| 9029 | Invalid Deployment Unit State (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Install, Update and Uninstall) | 4000 (BAD_REQUEST) |
| 9030 | Invalid Deployment Unit Update - Downgrade not permitted (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Update only) | 4000 (BAD_REQUEST) |
| 9031 | Invalid Deployment Unit Update - Version not specified (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Update only) | 4000 (BAD_REQUEST) |
| 9032 | Invalid Deployment Unit Update - Version already exists (associated with DUStateChangeComplete or AutonomousDUStateChangeComplete methods: Update only) | 4000 (BAD_REQUEST) |
8.1.5 Retrieve primitive mapping
The Retrieve Request and Response primitives shall map to the GetParameterValues RPC. The GetParametersValue RPC is defined in TR-069 [4] as a synchronous RPC and returns a successful response or one of the following fault codes in Table 8.1.5-1.
Table 8.1.5-1: GetParameterValues Fault Code Mapping
| Fault code | Description | Response Status Code |
|---|---|---|
| 9001 | Request denied (no reason specified) | 4000 (BAD_REQUEST) |
| 9002 | Internal error | 4000 (BAD_REQUEST) |
| 9003 | Invalid arguments | 4000 (BAD_REQUEST) |
| 9004 | Resources exceeded (when used in association with SetParameterValues, this cannot used to indicate Parameters in error) | 4000 (BAD_REQUEST) |
| 9005 | Invalid Parameter name (associated with Set/GetParameterValues, GetParameterNames, Set/GetParameterAttributes, AddObject, and DeleteObject) | 4000 (BAD_REQUEST) |
8.1.6 Notify primitive mapping
8.1.6.0 Introduction
The NotifyRequest and Response primitives permit notifications to AE or CSEs that have subscribed to a Resource.
While TR-069 [4] has the capability to notify the subscribed ACS when an object's parameter has been modified, TR069 [4] does not have the capability for an ACS to be notified if any parameter within the object has been modified unless the ACS individually subscribes to all the parameters of the object.
As such the procedure for mapping the Notify Request and Response primitives for TR-069 [4] is not possible unless the CSE subscribes to receive notification to all the parameters of an Object that are mapped to the Resource's attributes.
Note
In many implementations, subscribing to all the parameters of an Object that are mapped to the Resource can cause performance issues in the CPE as well as the CSE. As such using the attribute based subscription capabilities of TR-069 [4] for subscription of Resources should be avoided when possible.
8.1.6.1 Procedure for subscribed Resource attributes.
When a <subscription> Resource for a <mgmtObj> Resource is Created, Deleted or Updated the CSE shall map to the SetParameterAttributes RPC in the following manner:
- TR-069 [4] provides the capability to subscribe to changes of a specific attribute through the use of the SetParameterAttributes RPC using the "Active" value for the Notification parameter.
- TR-069 [4] provides the capability to un-subscribe to changes of a specific attribute through the use of the SetParameterAttributes RPC using the "None" value for the Notification parameter.
The SetParametersAttributes RPC is defined in TR-069 [4] as a synchronous RPC and returns a successful response or one of the following fault codes in Table 8.1.6.1-1.
Table 8.1.6.1-1: SetParameterAttributes Fault Code Mapping
| Fault code | Description | Response Status Code |
|---|---|---|
| 9000 | Method not supported | 4000 (BAD_REQUEST) |
| 9001 | Request denied (no reason specified) | 4000 (BAD_REQUEST) |
| 9002 | Internal error | 4000 (BAD_REQUEST) |
| 9003 | Invalid arguments | 4000 (BAD_REQUEST) |
| 9004 | Resources exceeded (when used in association with SetParameterValues, this cannot be used to indicate Parameters in error) | 4000 (BAD_REQUEST) |
| 9010 | File transfer failure (associated with Download, ScheduleDownload, TransferComplete or AutonomousTransferComplete methods). | 4000 (BAD_REQUEST) |
8.1.6.2 Notification primitive mapping
Notify Request and Response primitives shall map to the TR-069 notification mechanism. CPEs produce notifications for subscribed attributes using the TR-069 Inform method, the Inform method has an argument Event that has as one of the EventCodes with the value "4 VALUE CHANGE" indicating that a subscribed parameter's value has changed. The parameter(s) that have changed are included ParameterList argument of the Inform method.
The ParameterList argument is list of name-value pairs; the name is parameter name and shall be mapped to the objectPath attribute of the Resource while the value is the most recent value of the parameter.
Note
TR-069 CPEs do not report value changes of parameters that were modified by the ACS.