TR-369 USP Error Code Details
As with any system, errors can occur during message exchanges. TR-369 USP provides a set of error codes to help identify and troubleshoot these issues.
In this post, we will delve into the USP error codes and their significance in diagnosing and resolving communication problems.
In a failed message sequence, the interaction begins with a Controller sending a request to a CPE. The message is successfully parsed by the CPE. However, during further processing, the Agent encounters an error. In response to this error, the error arguments are then encapsulated in an Error Message and sent back to the TR-369 USP Controller.
The Error Message serves as a means of communication between the CPE and the Controller, informing the Controller about the encountered error and providing relevant details. By including specific error arguments in the Error Message, the CPE offers insights into the nature of the error, helping the Controller understand the cause of the failure.
- What are USP Error Codes? USP error codes are numerical codes assigned to specific error conditions encountered during message exchanges. Each error code represents a unique type of error or failure, providing valuable information about the cause of the problem. By examining the error code, developers and system administrators can identify the nature of the error and take appropriate actions to rectify it.
Let's explore some of the most commonly encountered USP error codes along with their descriptions:
(Please clink on the error code to load details to the right side!)
CODE
7000
NAME
Message failed
APPLICABILITY
Error Message
DESCRIPTION
This error indicates a general failure that is described in an err_msg field.
CODE
7001
NAME
Message not supported
APPLICABILITY
Error Message
DESCRIPTION
This error indicates that the attempted message was not understood by the target endpoint.
CODE
7002
NAME
Request denied (no reason specified)
APPLICABILITY
Error Message
DESCRIPTION
This error indicates that the target endpoint cannot or will not process the message.
CODE
7003
NAME
Internal error
APPLICABILITY
Error Message
DESCRIPTION
This error indicates that the message failed due to internal hardware or software reasons.
CODE
7004
NAME
Invalid arguments
APPLICABILITY
Error Message
DESCRIPTION
This error indicates that the message failed due to invalid values in the USP message.
CODE
7005
NAME
Resources exceeded
APPLICABILITY
Error Message
DESCRIPTION
This error indicates that the message failed due to memory or processing limitations on the target endpoint.
CODE
7006
NAME
Permission denied
APPLICABILITY
Error Message
DESCRIPTION
This error indicates that the source endpoint does not have the authorization for this action.
CODE
7007
NAME
Invalid configuration
APPLICABILITY
Error Message
DESCRIPTION
This error indicates that the message failed because processing the message would put the target endpoint in an invalid or unrecoverable state.
CODE
7008
NAME
Invalid path syntax
APPLICABILITY
any requested_path
DESCRIPTION
This error indicates that the Path Name used was not understood by the target endpoint.
CODE
7009
NAME
Parameter action failed
APPLICABILITY
Set
DESCRIPTION
This error indicates that the parameter failed to update for a general reason described in an err_msg field.
CODE
7010
NAME
Unsupported parameter
APPLICABILITY
Add, Set
DESCRIPTION
This error indicates that the requested Path Name associated with this ParamError did not match any instantiated parameters.
CODE
7011
NAME
Invalid type
APPLICABILITY
Add, Set
DESCRIPTION
This error indicates that the requested value was not of the correct data type for the parameter.
CODE
7012
NAME
Invalid value
APPLICABILITY
Add, Set
DESCRIPTION
This error indicates that the requested value was not within the acceptable values for the parameter.
CODE
7013
NAME
Attempt to update non-writable parameter
APPLICABILITY
Add, Set
DESCRIPTION
This error indicates that the source endpoint attempted to update a parameter that is not defined as a writable parameter.
CODE
7014
NAME
Value conflict
APPLICABILITY
Add, Set
DESCRIPTION
This error indicates that the requested value would result in an invalid configuration based on other parameter values.
CODE
7015
NAME
Operation error
APPLICABILITY
Add, Set, Delete
DESCRIPTION
This error indicates a general failure in the creation, update, or deletion of an Object that is described in an err_msg field.
CODE
7016
NAME
Object does not exist
APPLICABILITY
Add, Set
DESCRIPTION
This error indicates that the requested Path Name associated with this OperationStatus did not match any instantiated Objects.
CODE
7017
NAME
Object could not be created
APPLICABILITY
Add
DESCRIPTION
This error indicates that the operation failed to create an instance of the specified Object.
CODE
7018
NAME
Object is not a table
APPLICABILITY
Add
DESCRIPTION
This error indicates that the requested Path Name associated with this OperationStatus is not a Multi-Instance Object.
CODE
7019
NAME
Attempt to create non-creatable Object
APPLICABILITY
Add
DESCRIPTION
This error indicates that the source endpoint attempted to create an Object that is not defined as able to be created.
CODE
7020
NAME
Object could not be updated
APPLICABILITY
Set
DESCRIPTION
This error indicates that the requested Object in a Set request failed to update.
CODE
7021
NAME
Required parameter failed
APPLICABILITY
Add, Set
DESCRIPTION
This error indicates that the request failed on this Object because one or more required parameters failed to update. Details on the failed parameters are included in an associated ParamError message.
CODE
7022
NAME
Command failure
APPLICABILITY
Operate
DESCRIPTION
This error indicates that a command initiated in an Operate Request failed to complete for one or more reasons explained in the err_msg field.
CODE
7023
NAME
Command canceled
APPLICABILITY
Operate
DESCRIPTION
This error indicates that an asynchronous command initiated in an Operate Request failed to complete because it was canceled using the Cancel() operation.
CODE
7024
NAME
Delete failure
APPLICABILITY
Delete
DESCRIPTION
This error indicates that this Object Instance failed to be deleted.
CODE
7025
NAME
Object exists with duplicate key
APPLICABILITY
Add
DESCRIPTION
This error indicates that an Object tried to be created with unique keys that already exist or the unique keys were configured to those that already exist.
CODE
7026
NAME
Invalid path
APPLICABILITY
Any
DESCRIPTION
This error indicates that the Object or Parameter Path Name specified does not match any Objects or Parameters in the Agent's Supported Data Model.
CODE
7027
NAME
Invalid Command Arguments
APPLICABILITY
Operate
DESCRIPTION
This error indicates that an Operate message failed due to invalid or unknown arguments specified in the command.
CODE
7100-7199
NAME
USP Record error codes
APPLICABILITY
-
DESCRIPTION
These errors are listed and described in the Message Transfer Protocols.
CODE
7800-7999
NAME
Vendor defined error codes
APPLICABILITY
-
DESCRIPTION
These errors are vendor defined. There are no requirements on the content of these errors.
Here, you may found official list of TR-369 USP Error Code Details as a Table:
| Code | Name | Applicability | Description |
|---|---|---|---|
| 7000 | Message failed | Error Message | This error indicates a general failure that is described in an err_msg field. |
| 7001 | Message not supported | Error Message | This error indicates that the attempted message was not understood by the target endpoint. |
| 7002 | Request denied (no reason specified) | Error Message | This error indicates that the target endpoint cannot or will not process the message. |
| 7003 | Internal error | Error Message | This error indicates that the message failed due to internal hardware or software reasons. |
| 7004 | Invalid arguments | Error Message | This error indicates that the message failed due to invalid values in the USP message. |
| 7005 | Resources exceeded | Error Message | This error indicates that the message failed due to memory or processing limitations on the target endpoint. |
| 7006 | Permission denied | Error Message | This error indicates that the source endpoint does not have the authorization for this action. |
| 7007 | Invalid configuration | Error Message | This error indicates that the message failed because processing the message would put the target endpoint in an invalid or unrecoverable state. |
| 7008 | Invalid path syntax | any requested_path | This error indicates that the Path Name used was not understood by the target endpoint. |
| 7009 | Parameter action failed | Set | This error indicates that the parameter failed to update for a general reason described in an err_msg field. |
| 7010 | Unsupported parameter | Add, Set | This error indicates that the requested Path Name associated with this ParamError did not match any instantiated parameters. |
| 7011 | Invalid type | Add, Set | This error indicates that the requested value was not of the correct data type for the parameter. |
| 7012 | Invalid value | Add, Set | This error indicates that the requested value was not within the acceptable values for the parameter. |
| 7013 | Attempt to update non-writable parameter | Add, Set | This error indicates that the source endpoint attempted to update a parameter that is not defined as a writable parameter. |
| 7014 | Value conflict | Add, Set | This error indicates that the requested value would result in an invalid configuration based on other parameter values. |
| 7015 | Operation error | Add, Set, Delete | This error indicates a general failure in the creation, update, or deletion of an Object that is described in an err_msg field. |
| 7016 | Object does not exist | Add, Set | This error indicates that the requested Path Name associated with this OperationStatus did not match any instantiated Objects. |
| 7017 | Object could not be created | Add | This error indicates that the operation failed to create an instance of the specified Object. |
| 7018 | Object is not a table | Add | This error indicates that the requested Path Name associated with this OperationStatus is not a Multi-Instance Object. |
| 7019 | Attempt to create non-creatable Object | Add | This error indicates that the source endpoint attempted to create an Object that is not defined as able to be created. |
| 7020 | Object could not be updated | Set | This error indicates that the requested Object in a Set request failed to update. |
| 7021 | Required parameter failed | Add, Set | This error indicates that the request failed on this Object because one or more required parameters failed to update. Details on the failed parameters are included in an associated ParamError message. |
| 7022 | Command failure | Operate | This error indicates that a command initiated in an Operate Request failed to complete for one or more reasons explained in the err_msg field. |
| 7023 | Command canceled | Operate | This error indicates that an asynchronous command initiated in an Operate Request failed to complete because it was canceled using the Cancel() operation. |
| 7024 | Delete failure | Delete | This error indicates that this Object Instance failed to be deleted. |
| 7025 | Object exists with duplicate key | Add | This error indicates that an Object tried to be created with unique keys that already exist or the unique keys were configured to those that already exist. |
| 7026 | Invalid path | Any | This error indicates that the Object or Parameter Path Name specified does not match any Objects or Parameters in the Agent's Supported Data Model. |
| 7027 | Invalid Command Arguments | Operate | This error indicates that an Operate message failed due to invalid or unknown arguments specified in the command. |
| 7100-7199 | USP Record error codes | - | These errors are listed and described in the Message Transfer Protocols. |
| 7800-7999 | Vendor defined error codes | - | These errors are vendor defined. There are no requirements on the content of these errors. |
Handling USP Error Codes: When encountering a USP error code, it is crucial to analyze the code and accompanying information to determine the appropriate course of action. Here are some general steps to handle USP error codes:
- Identify the error code and refer to the official USP documentation or specifications to understand its meaning and potential causes.
- Review the additional details provided with the error code, such as error messages or associated parameters. These details can offer insights into the specific issue.
- Verify the message content, including the arguments and syntax, to ensure compliance with the protocol's requirements.
- Check the system's configuration, permissions, and available resources to eliminate any potential constraints that might be causing the error.
- Implement appropriate error-handling mechanisms in your application or system to gracefully handle and report the encountered errors.
References:
- TR-369 USP Specification Section 7.8 Error Codes, Broadband Forum, https://www.broadband-forum.org/tr-369
2. TR-369 USP Specification Section 7.2.3 Example Message Flows, Broadband Forum, https://www.broadband-forum.org/tr-369