OpenClovis Logo

OpenClovis Error and Return Codes

The majority of ASP API functions return a Return Code as their return value.

A zero return code (CL_OK) always indicates success. Non-zero return codes always carry two types of information, masked into one single value: a Component Identifier and an Error Code. The component identifier identifies the component (or software layer) in which the problem occurred, while the error code describes the nature of the problem. Some error codes are common across all components, while others are component specific.

The format of the return codes returned by OpenClovis APIs is 0xCCNNNN (given in hex), where 0xCC is the ASP Component Identifier and 0xNNNN is the Error Code.

  • NNNN <= 00ff : common Error Codes shared among all ASP components
  • NNNN > 00ff : component specific Error Codes

The following macros, defined in clCommonErrors.h, help decoding the return codes:

Note
Only the Error Codes are listed as Return values in the Function Documentation of the API Reference pages. The real return value also contains the Component Identifier!

The following tables are provided to help software engineers to quickly decode return codes found in ASP log files:

ASP Component Identifiers

ValueIdentifierComponent
0x0CL_CID_UNSPECIFIEDUnspecified
0x01CL_CID_OSALOS Abstraction Layer
0x02CL_CID_HALHardware Abstraction Layer
0x03CL_CID_DBALDatabase Abstraction Layer
0x04CL_CID_EOExecution Object
0x05CL_CID_IOCIntelligent Object Communication
0x06CL_CID_RMDRemote Method Dispatch
0x07CL_CID_NAMESName Service
0x08CL_CID_TIMERTimer
0x09CL_CID_SHMShared Memory Support
0x0aCL_CID_DSHMDistributed Shared Memory
0x0bCL_CID_LOGLogging
0x0cCL_CID_MSGMessage Service
0x0dCL_CID_DIAGDiagnostics
0x0eCL_CID_DEBUGDebug
0x0fCL_CID_CPMComponent Management
0x10CL_CID_CAPCapability Management (for future use)
0x11CL_CID_RESResource Management (for future use)
0x12CL_CID_GMSGroup Membership Service
0x13CL_CID_EVENTSEvent Service
0x14CL_CID_DLOCKDistributed Locking (for future use)
0x15CL_CID_TXNTransactions
0x16CL_CID_CKPTCheckpointing Service
0x17CL_CID_CORClovis Object Registry
0x18CL_CID_CNTContainers
0x19CL_CID_DCNTDistributed Containers (for future use)
0x1aCL_CID_RCNTResilient Containers (for future use)
0x1bCL_CID_ALARMSAlarm Manager
0x1cCL_CID_POLICYPolicy Engine
0x1dCL_CID_RULERule Base Engine
0x1eCL_CID_SCRIPTINGScripting Engine (for future use)
0x1fCL_CID_CMChassis Manager
0x20CL_CID_HPIHardware Platform Interface
0x21CL_CID_FAULTSFault Management
0x22CL_CID_AMSAvailability Management Service
0x23CL_CID_MEDMediation Library
0x24CL_CID_BUFFERBuffer Management
0x25CL_CID_QUEUEQueue Management
0x26CL_CID_CLISTCircular List Management
0x27CL_CID_SNMPSNMP Agent
0x28CL_CID_NSName Service
0x29CL_CID_OMObject Manager
0x2aCL_CID_POOLPool Management
0x2bCL_CID_CDCommon Diagnostics (for future use)
0x2cCL_CID_DMDiagnostics Manager (for future use)
0x2dCL_CID_OAMP_RTOAMP RT parser
0x2eCL_CID_PROVProvisioning Manager
0x2fCL_CID_UMUpgrade Manager (for future use)
0x30CL_CID_HANDLEHandle Database
0x31CL_CID_VERSIONVersion Checker Library
0x32CL_CID_XDRXDR Library
0x33CL_CID_IDLIDL
0x34CL_CID_HEAPHeap Management
0x35CL_CID_MEMMemory Management
0x36CL_CID_PARSERParser
0x37CL_CID_BACKING_STORAGE
0x38CL_CID_JOB
0x38CL_CID_JOBQUEUE
0x39CL_CID_THREADPOOL
0x39CL_CID_TASKPOOL
0x3aCL_CID_BITMAPBitmap Management
0x3bCL_CID_LEAKY_BUCKET
0x3cCL_CID_MSOMso Services Management
0x3dCL_CID_PMPerformance Management
0x3eCL_CID_NFSAF Notification service
CL_CID_MAXThis will help validate if needs to be

Common Error Codes

ValueError CodeComments
0x01CL_ERR_NO_MEMORYMemory is not available
0x02CL_ERR_INVALID_PARAMETERInput parameters are invalid
0x03CL_ERR_NULL_POINTERInput parameter is a NULL pointer
0x04CL_ERR_NOT_EXISTRequested resource does not exist
0x05CL_ERR_INVALID_HANDLEThe handle passed is invalid
0x06CL_ERR_INVALID_BUFFERThe buffer passed in is invalid
0x07CL_ERR_NOT_IMPLEMENTEDThe function not yet implemented
0x08CL_ERR_DUPLICATEDuplicate entry
0x09CL_ERR_QUEUE_NOT_AVAILABLEThe destination queue is not available.
0x0aCL_ERR_OUT_OF_RANGEOut of range paramenters
0x0bCL_ERR_NO_RESOURCENo resources
0x0cCL_ERR_INITIALIZEDAlready initialized
0x0dCL_ERR_BUFFER_OVERRUNBuffer over run
0x0eCL_ERR_NOT_INITIALIZEDComponent not initialized
0x0fCL_ERR_VERSION_MISMATCHVersion mismatch
0x10CL_ERR_ALREADY_EXISTAn entry is already existing
0x11CL_ERR_UNSPECIFIEDUnknown/Unspecified error
0x12CL_ERR_INVALID_STATEInvalid State
0x13CL_ERR_DOESNT_EXISTAn entry does not exist
0x14CL_ERR_TIMEOUTTimeout
0x15CL_ERR_INUSEResource is in use
0x16CL_ERR_TRY_AGAINComponent is busy , Try again
0x17CL_ERR_NO_CALLBACKNo callback available for request
0x18CL_ERR_MUTEX_ERRORThread mutex error
0x19CL_ERR_NO_OPNull operation
0x1aCL_ERR_NAME_TOO_LONGName exceeds maximum allowed length.
0x1bCL_ERR_NAME_NOT_FOUNDName doesnt exist or cannot be found.
0x1cCL_ERR_MESSAGE_ERRORA communication error occurred.
0x1dCL_ERR_TOO_BIGA value is larger than the maximum value permitted.
0x1eCL_ERR_NO_SECTIONSThere are no or no more sections matching the specified sections.
0x1fCL_ERR_FAILED_OPERATIONThe requested operation Failed.
0x20CL_ERR_OP_NOT_PERMITTEDRequested operation is not permitted
0x21CL_ERR_NO_SPACESpace limitation
0x22CL_ERR_BAD_FLAGThe passed flag is invalid
0x23CL_ERR_BAD_OPERATIONThe requested operation is invalid
0x24CL_ERR_LIBRARYSystem call invocation failed and returned an error
0x25CL_ERR_NOT_SUPPORTEDRequested feature is not supported
0x26CL_ERR_INTERRUPTThe operation interrupted by application/user.
0x27CL_ERR_CONTINUE
0xffCL_ERR_COMMON_MAX2^8-1, the max for common errors

Alarm Error Codes

ValueError CodeComments
0x100CL_ALARM_ERR_INVALID_CATThe alarm category is invalid.
0x101CL_ALARM_ERR_VERSION_UNSUPPORTEDClient Library version error.
0x102CL_ALARM_ERR_INVALID_SEVERITYThe alarm severity is invalid.
0x103CL_ALARM_ERR_PROB_CAUSE_NOT_PRESENTThe probable cause of alarm is not present.
0x104CL_ALARM_ERR_GEN_RULE_NOT_VALIDThe Generation Rule of alarm is invalid.
0x105CL_ALARM_ERR_SUPP_RULE_NOT_VALIDThe Suppression Rule of alarm is invalid.
0x106CL_ALARM_ERR_OM_CREATE_FAILEDThe OM class creation of alarm failed.
0x107CL_ALARM_ERR_INTERNAL_ERRORInternal error related to alarms.
0x108CL_ALARM_ERR_EVT_INITThe event initialization failure.
0x109CL_ALARM_ERR_EVT_CHANNEL_OPENThe event channel open failure for alarm event channel.
0x10aCL_ALARM_ERR_EVT_SUBSCRIBEFailed while subscribing for the event.
0x10bCL_ALARM_ERR_EVT_SUBSCRIBE_AGAINThe event initialization had been done already.
0x10cCL_ALARM_ERR_EVT_CHANNEL_CLOSEThe event channel close failure while unsubscribing for the event.
0x10dCL_ALARM_ERR_EVT_FINALIZEThe event finalize failure while unsubscribing for the event.
0x10eCL_ALARM_ERR_INVALID_MOIDThe managed object Identifier is invalid.
0x10fCL_ALARM_ERR_NO_OWNERThe managed object doesn't have any owner registered in COR.

Availability Management Service Error Codes

ValueError CodeComments
0x100CL_AMS_ERR_INVALID_COMPThe component is invalid.
0x101CL_AMS_ERR_INVALID_ENTITYThe AMS entity (node, service group, service unit, service instance, component or component service instance) is invalid.
0x102CL_AMS_ERR_INVALID_ENTITY_STATEThe administrative state of an entity (node, service group, service unit or service instance) is invalid.
0x103CL_AMS_ERR_INVALID_ENTITY_LISTThe entity list name is invalid. (Used by AMS management APIs.)
0x104CL_AMS_ERR_ENTITY_NOT_ENABLEDThe entity state is invalid w.r.t to the requested operation.
0x105CL_AMS_ERR_BAD_CONFIGInvalid AMF configuration.
0x106CL_AMS_ERR_INVALID_ARGSInvalid arguments. (Mostly used in AMF debug CLI)
0x107CL_AMS_ERR_INVALID_OPERATIONThe requested operation is (currently) invalid.
0x108CL_AMS_ERR_OPERATION_FAILEDThe requested operation could not be completed.
0x109CL_AMS_ERR_SI_NOT_ASSIGNABLEThe service instance cannot be assigned an active HA state.
0x10aCL_AMS_ERR_CSI_NOT_ASSIGNABLEThe component service instance cannot be assigned an active HA state.
0x10bCL_AMS_ERR_UNMARSHALING_FAILEDUnmarshalling of the AMS buffer failed.

Clovis Object Repository Error Codes

ValueError CodeComments
0x100CL_COR_ERR_INVALID_CLASSThe class Identifier passed is invalid.
0x101CL_COR_ERR_INVALID_STATEThe processing has reached an invalid state.
0x102CL_COR_ERR_INVALID_MSP_IDThe invalid MSP ID is supplied.
0x103CL_COR_ERR_MAX_DEPTHThe respective append functions cannot add any more nodes to the MOID or MO class path.
0x104CL_COR_ERR_INVALID_DEPTHThe depth specified in the MOID or Object Handle is invalid.
0x105CL_COR_ERR_CLASS_PRESENTThe class being created is already present in the COR.
0x106CL_COR_ERR_CLASS_NOT_PRESENTThe class being searched is not present in the COR.
0x107CL_COR_ERR_CLASS_INSTANCES_PRESENTThe class information cannot be modified as it has instances present the object tree.
0x108CL_COR_ERR_CLASS_ATTR_INVALID_VALThe error shows that the value supplied to the attribute is invalid.
0x109CL_COR_ERR_CLASS_ATTR_PRESENTThe class already has an attribute with the attribute Identifier being added.
0x10aCL_COR_ERR_OBJECT_LOCKEDThe object is locked so no more operation can be done till it is unlocked.
0x10bCL_COR_ERR_OBJECT_INVALIDThe object on which operation is requested is invalid.
0x10cCL_COR_ERR_CLASS_ATTR_NOT_PRESENTThe attribute being searched is not present in the class.
0x10dCL_COR_ERR_CLASS_ATTR_TILL_REACHEDThe end marker for the class being searched has encountered.
0x10eCL_COR_ERR_CLASS_ATTR_OUT_OF_RANGEThe value of attribute is more than the range of value of its data type.
0x10fCL_COR_ERR_CLASS_ATTR_INVALID_INDEXThe index specified for the attribute is invalid. This can be an index for an array attribute which is out of range of the array length or for a simple attribute it is not specified as CL_COR_INVALID_ATTR_IDX.
0x110CL_COR_ERR_CLASS_ATTR_INVALID_RELATIONThe size of the attribute is not matching its data type.
0x111CL_COR_ERR_OBJ_ATTR_INVALID_SETThe set operation is done on a containment attribute.
0x112CL_COR_ERR_CLASS_INVALID_PATHThe MO class path specified is invalid.
0x113CL_COR_ERR_OBJECT_ACTIVEThe object being enabled is already active.
0x114CL_COR_ERR_ROUTE_PRESENTThe error shows that OI is already present in the route list.
0x115CL_COR_ERR_UNKNOWN_COR_INSTANCEThe disable request for an invalid COR instance has arrived.
0x116CL_COR_ERR_INSUFFICIENT_BUFFERThe buffer supplied is not enough for the processing.
0x117CL_COR_ERR_CLASS_MISMATCHThe classes does not match either due to class identifier or attribute identifier present in the classes.
0x118CL_COR_ERR_CLASS_ATTR_INVALID_TYPEThe class attribute data type specified is invalid.
0x119CL_COR_ERR_ROUTE_NOT_PRESENTThe specified OI does not exist in the route list.
0x11aCL_COR_ERR_NOT_SUPPORTEDAn unsupported state has reached while processing the request.
0x11bCL_COR_ERR_INVALID_OH_MASKThe Object Handle (OH) mask provided is invalid.
0x11cCL_COR_ERR_ALREADY_INITThe COR EO is already been initialized.
0x11dCL_COR_ERR_CLASS_ATTR_NOT_INITIALIZEDThe object is created for a class containing initialized attributes, without specifying any value for them.
0x11eCL_COR_ERR_OBJ_ATTR_NOT_PRESENTThe attribute being set does not exist in the object.
0x11fCL_COR_ERR_CLASS_IS_BASEThis error will occur when base class is deleted.
0x120CL_COR_ERR_OBJ_NOT_PRESENTThe managed object does not exist in the COR.
0x121CL_COR_ERR_INVALID_SIZEThe size specified for the attribute is invalid. This can happen in the the case of set or get operation on the Managed object attribute.
0x122CL_COR_ERR_VERSION_UNSUPPORTEDThe version specified by the client is not supported at server.
0x130CL_COR_MO_TREE_ERR_FAILED_TO_ADD_NODEThe error occured while adding the node to the MO class tree.
0x131CL_COR_MO_TREE_ERR_FAILED_TO_DEL_NODEThe failure occured while deleting the MO-class tree node.
0x132CL_COR_MO_TREE_ERR_FAILED_USR_BUFThe error specifies that a failure occured while getting the user buffer from the MO class tree.
0x133CL_COR_MO_TREE_ERR_CLASS_NO_PRESENTThe MO class tree do not have a node corresponding to the class identifier specified.
0x134CL_COR_MO_TREE_ERR_NODE_NOT_FOUNDThe MO class tree node not found for a given MO class path.
0x135CL_COR_MO_TREE_ERR_NODE_FOUNDThe class node already exist in the MO class tree.
0x136CL_COR_MO_TREE_ERR_MAX_INSTThe maximum instance for the MO class tree has reached.
0x137CL_COR_MO_TREE_ERR_CHILD_CLASS_EXISTThe MO tree node cannot be deleted as the child node(s) exists.
0x140CL_COR_INST_ERR_NODE_NOT_FOUNDThe Mananged object node does not exist in the object tree.
0x141CL_COR_INST_ERR_MSO_ALREADY_PRESENTThe Managed service object for a Managed object is already present in the object tree.
0x142CL_COR_INST_ERR_MO_ALREADY_PRESENTThe Managed object is already present in the object tree.
0x143CL_COR_INST_ERR_MSO_NOT_PRESENTThe Managed service object for a MO doesn't exist in the object tree.
0x144CL_COR_INST_ERR_INVALID_MOIDThe invalid MOID is supplied to the function. This can be either due to an invalid class identifier or invalid instance identifier for a class.
0x145CL_COR_INST_ERR_UNPACK_FAILEDAn error occured while upacking the object tree.
0x146CL_COR_INST_ERR_NODE_ALREADY_PRESENTThe object instance node is already present in the object tree.
0x147CL_COR_INST_ERR_NODE_NOT_TO_PACKA failure has occured while packing the instance tree.
0x148CL_COR_INST_ERR_CHILD_MO_EXISTThe object node cannot be chopped as there is a child node(s) existing.
0x149CL_COR_INST_ERR_MSO_EXISTThe object node cannot be delete as there are MSO node(s) existing.
0x14aCL_COR_INST_ERR_MAX_INSTANCEThe request for the object instance creation has exceeded the maximum instance limit specified while modeling.
0x14bCL_COR_INST_ERR_PARENT_MO_NOT_EXISTAn error occurred while looking for the parent in the object tree.
0x150CL_COR_TXN_ERR_OUT_OF_TXNThe transaction is completed for this trasaction id.
0x151CL_COR_TXN_ERR_INVALID_IDThe transaction id is invalid.
0x152CL_COR_TXN_ERR_INVALID_STATEThis error will occur when both set and delete operation are done on same Managed Object in one transaction.
0x153CL_COR_TXN_ERR_SPANS_MULTI_OBJThe transaction spans mutlitple object. This is an obselete error code.
0x154CL_COR_TXN_ERR_INVALID_OPThe Invalid operation type has been supplied. The operation type should be one of value present in the enum ClCorOpsT.
0x155CL_COR_TXN_ERR_FIRST_JOBThe failure occured to get the previous job when there is only one job in the transacation.
0x156CL_COR_TXN_ERR_LAST_JOBThe get-next is done after reaching the last job in the job-list.
0x157CL_COR_TXN_ERR_ZERO_JOBSThere are no jobs in the transaction being started.
0x158CL_COR_TXN_ERR_INVALID_JOB_IDThe job-Identifier specified is invalid.
0x159CL_COR_TXN_ERR_FAILED_JOB_GETAn error has occured while getting the transaction failed-jobs for a given cor-transaction session identifier.
0x15aCL_COR_TXN_ERR_FAILED_JOB_NOT_EXISTThere are no transaction failed-jobs existing for the given cor-transaction session identifier.
0x15bCL_COR_ERR_RUNTIME_CACHED_SETA set operation is performed on a runtime cached attribute by a non-primary OI.
0x15cCL_COR_ERR_ATTR_NON_WRITABLE_SETA set operation is performed on a non-writable attribute.
0x15dCL_COR_TXN_ERR_JOB_WALK_TERMINATEThe transaction job walk is terminated. This can be used to break the transaction job walk at any desired point.
0x160CL_COR_NOTIFY_ERR_INVALID_OPThe invalid operation type is specified. The operation type should be one of values specified in ClCorOpsT.
0x161CL_COR_NOTIFY_ERR_CANNOT_RESOLVE_CLASSThe service Id of the MOID is specified as wild card while doing event subscription.
0x170CL_COR_SVC_ERR_INVALID_FLAGSThe Object flag specified is invalid.
0x171CL_COR_SVC_ERR_INVALID_IDThe service Id for the MSO specified in the MOID is invalid. This should be one of the value defined in ClCorServiceIdT.
0x172CL_COR_INTERNAL_ERR_INVALID_COR_LISTThe COR-List is not initialized.
0x173CL_COR_INTERNAL_ERR_INVALID_RM_FLAGSThe object flag type supplied is invalid.
0x180CL_COR_UTILS_ERR_INVALID_KEYThe COR server could not find a specified entry in the object tree or the class tree.
0x181CL_COR_UTILS_ERR_MEMBER_NOT_FOUNDThe member does not exist in the list.
0x182CL_COR_UTILS_ERR_INVALID_NODE_REFThe invalid node is referred by giving a MO-class path.
0x183CL_COR_UTILS_ERR_INVALID_TAGThe tags supplied while packing MO-class tree or object tree at the active COR are not found proper after unpacking at the standby COR.
0x184CL_COR_UTILS_ERR_FOUND_END_TAGThe end tag is encountered while upacking the object or MO-class tree.
0x185CL_COR_UTILS_ERR_MOCLASSPATH_MISMATCHThe failure occured in comparing two MO-Class paths.
0x190CL_COR_ERR_CONFIG_ATTR_FLAGThe config attribute is either marked as non-cached or non-persistent.
0x191CL_COR_ERR_RUNTIME_ATTR_WRITEThe attribute flag of a runtime attribute is marked as writable.
0x192CL_COR_ERR_ATTR_PERS_WITHOUT_CACHEA runtime attribute is marked as persistent without being marked as cached.
0x193CL_COR_ERR_ATTR_FLAGS_INVALIDThe attribute user flag passed is invalid.
0x194CL_COR_ERR_OP_ATTR_TYPE_INVALIDThe attribute data type is invalid.
0x1a0CL_COR_ERR_GET_DATA_NOT_FOUNDThe attribute data not found at the OI or at the COR.
0x1a1CL_COR_ERR_BUNDLE_INIT_FAILUREA failure occured in the bundle initialization.
0x1a2CL_COR_ERR_BUNDLE_APPLY_FAILUREFailure while doing a bundle apply.
0x1a3CL_COR_ERR_ZERO_JOBS_BUNDLEThe bundle is applied without adding any jobs to it.
0x1a4CL_COR_ERR_ATTR_READ_ONLYA read-only attribute is being set.
0x1a5CL_COR_ERR_BUNDLE_FINALIZEThe failure occured finalizing the bundle.
0x1a6CL_COR_ERR_BUNDLE_TIMED_OUTThe bundle timeout has occured in the case of a synchronous bundle.
0x1a7CL_COR_ERR_BUNDLE_IN_EXECUTIONThe bundle is applied or finalized to a bundle for which the response has not yet reached after applying.
0x1a8CL_COR_ERR_BUNDLE_INVALID_TYPEThe bundle type (ClCorBundleConfigT) is supplied wrongly to the bundle initialize. For this release it should be only CL_COR_BUNDLE_NON_TRANSACTIONAL.
0x1c0CL_COR_ERR_OI_NOT_REGISTEREDThe OI is not registered when doing get of the primary OI. It also indicate that a primary OI flag is being set for OI without adding it to the route list.
0x1c1CL_COR_ERR_OI_ALREADY_REGISTEREDAn OI is already registered as a primary OI for the Managed object.
0x1d0CL_COR_COMM_ERR_INVALID_OPThe invalid Operation type supplied to the comm.
0x1e0CL_COR_CLI_ERR_INVALID_USAGEThe invalid usage of the CLI command has occured.

Component Manager Error Codes

ValueError CodeComments
0x100CL_CPM_ERR_OPERATION_NOT_ALLOWEDRequested operation is not allowed.
0x101CL_CPM_ERR_EO_UNREACHABLEEO is not reachable.
0x102CL_CPM_ERR_INVALID_ARGUMENTSOne of the passed argument is invalid.
0x103CL_CPM_ERR_OPERATION_FAILEDRequested operation could not be performed by Component Manager.
0x104CL_CPM_ERR_FORWARDING_FAILEDComponent Manager is not able to forward the request to the required node.
0x105CL_CPM_ERR_OPERATION_IN_PROGRESSComponent Manager cannot handle this request at this point, as it is currently doing similar operation.
0x106CL_CPM_ERR_INITComponent Manager returns this error if the initialization was not in a proper way and other functions are being accessed.
0x107CL_CPM_ERR_BAD_OPERATIONComponent Manager returns this error when it receives an invalid request.
0x108CL_CPM_ERR_EXISTComponent Manager returns this error when the same registration request is performed multiple times.
0x109CL_CPM_ERR_OPER_ABANDONEDBug 3610: Added this message. Component Manager returns this error when processing of the request was abandoned due to higher priority request.

Database Abstraction Layer Error Codes

ValueError CodeComments
0x100CL_DBAL_ERR_DB_ERRORAn unextected error has occured during DB operation.
0x101CL_DBAL_ERR_COMMIT_FAILEDAn error has occured during transaction commit.
0x102CL_DBAL_ERR_ABORT_FAILEDAn error has occured during transaction abort.

Debug Service Error Codes

ValueError CodeComments
0x100CL_DBG_ERR_CMD_NOT_FOUNDDebug Library error.
0x101CL_DBG_ERR_UNRECOGNIZED_CMDDebug unrecognized command
0x102CL_DBG_ERR_INVALID_CTXDebug command ignored
0x103CL_DBG_ERR_INVALID_PARAMInvalid time out
0x104CL_DBG_ERR_COMMON_ERRORLoglevel set failed

Event Service Error Codes

ValueError CodeComments
0x100CL_EVENT_ERR_INIT_NOT_DONEEvent Library has not been initialized.
0x101CL_EVENT_ERR_INTERNALAn unexpected error has occured in the Event Library and it may not be able to process the request.
0x102CL_EVENT_ERR_INVALID_PARAMThe parameter passed to the API is invalid.
0x103CL_EVENT_ERR_BAD_FLAGSThe flags specified are invalid - out of range or not compatible with each other.
0x104CL_EVENT_ERR_INVALID_CHANNEL_HANDLEThe channel handle passed is invalid - the channel has not been created. It may be closed/deleted/unlinked.
0x105CL_EVENT_ERR_BAD_HANDLEThe event handle specified is invalid - has not been allocated or has been already deleted.
0x106CL_EVENT_ERR_NO_MEMThe Event Library is out of memory and no memory can be allocated at this point in time.
0x107CL_EVENT_ERR_NULL_PTRThe parameter passed to the API is NULL.
0x108CL_EVENT_ERR_CHANNEL_ALREADY_OPENEDThe channel has been already openend by the EO.
0x109CL_EVENT_ERR_CHANNEL_NOT_OPENEDThe channel specified by the channel handle has not been opened.
0x10aCL_EVENT_ERR_DUPLICATE_SUBSCRIPTIONThe EO has already subscribed on the specified channel using the given subscription ID.
0x10bCL_EVENT_ERR_NOT_OPENED_FOR_SUBSCRIPTIONThe channel has not been opened for subscription and an attempt to subscribe was made on the same.
0x10cCL_EVENT_ERR_NOT_OPENED_FOR_PUBLISHThe channel has not been opened for publish and an attempt to subscribe was made on the same.
0x10dCL_EVENT_ERR_INFO_WALK_STOPThis return code is used to check the normal termination of the event info walk.
0x10eCL_EVENT_ERR_ALREADY_INITIALIZEDThe Event Library has already been initialized by this EO.
0x10fCL_EVENT_ERR_STOP_WALKThis return code is used to check the normal termination of a walk to remove subscribers.
0x110CL_EVENT_ERR_NO_SPACEThe memory allocated by the user for the event data (payload) is insufficient.
0x111CL_EVENT_ERR_VERSIONThe version specified is not supported or is incorrect.
0x112CL_EVENT_ERR_EXISTThe specified resource such as Subscription ID, Channel, and so on already exists.
0x113CL_EVENT_ERR_NO_RESOURCEThe Event Library is out of some resource other than memory like file descriptors.
0x114CL_EVENT_ERR_INITThe ChannelOpen Callback is NULL

Execution Object Error Codes

ValueError CodeComments
0x101CL_EO_ERR_EO_SUSPENDEDEO is currently in suspended state, so will be be able to provide service
0x102CL_EO_ERR_FUNC_NOT_REGISTEREDCalled EO RMD function is not currently registered
0x103CL_EO_ERR_INVALID_CLIENTIDInvalid client ID is passed, as one of the arguments
0x104CL_EO_ERR_INVALID_SERVICEIDInvalid service ID is passed, as one of the arguments
0x105CL_EO_ERR_LIB_ID_INVALIDThe Library ID specified is invalid
0x106CL_EO_ERR_WATER_MARK_ID_INVALIDThe Water Mark ID specified is invalid
0x107CL_EO_ERR_IMPROPER_STATEEO state can not be set to the provided value
0x108CL_EO_ERR_QUEUE_OVERFLOWThe Action Queue has overflown
0x109CL_EO_ERR_ENQUEUE_MSGEnqueue this message, even though it was originally targeted as non-blocking

Fault Manager Error Codes

ValueError CodeComments
0x100CL_FAULT_ERR_DUPLICATEThe fault occured is duplicate. It is a carbon copy of a fault that has occured earlier.
0x101CL_FAULT_ERR_FAULT_NOT_FOUNDThe fault is not found.
0x102CL_FAULT_ERR_INVLD_VALThe fault is invalid.
0x103CL_FAULT_ERR_SEVERITY_EXCEEDThe fault has exceeded the severity level.
0x104CL_FAULT_ERR_HISTORY_ADD_ERRORThe fault is not being added to the history.
0x105CL_FAULT_ERR_HISTORY_CREATE_ERRORThe fault is not being created in the history.
0x106CL_FAULT_ERR_HISTORY_MUTEX_CREATE_ERRORA violation of shared data occurs when a fault is being created in the history.
0x107CL_FAULT_ERR_HISTORY_QUERY_ERRORThe fault is not being queried from the history.
0x108CL_FAULT_ERR_CREATE_FAILEDThe fault is not created.
0x109CL_FAULT_ERR_ADD_FAILEDThe fault is not added.
0x10aCL_FAULT_ERR_FAULT_HANDLER_NOT_FOUNDThe fault handler is not found.
0x10bCL_FAULT_ERR_REPAIR_SEQ_TBL_NULLThe fault sequence table is NULL.
0x10cCL_FAULT_ERR_INTERNALFault Internal Error.
0x10dCL_FAULT_ERR_INVALID_CATEGORYThe fault category is invalid.
0x10eCL_FAULT_ERR_INVALID_SEVERITYThe fault severity is invalid.
0x10fCL_FAULT_ERR_MOID_NULLMOID of the fault is NULL.
0x110CL_FAULT_ERR_CLIENT_INIT_FAILEDFault client library initialize failure.
0x111CL_FAULT_ERR_CLIENT_FINALIZE_FAILEDFault client library finalize failure.
0x112CL_FAULT_ERR_COMPNAME_NULLComponent name passed to fault is NULL.
0x113CL_FAULT_ERR_VERSION_UNSUPPORTEDOn version mismatch.

Group Membership Service Error Codes

ValueError CodeComments
0x100CL_GMS_ERR_UNMARSHALING_FAILEDUnmarshalling RMD Reply failed.
0x101CL_GMS_ERR_TOTEM_PROTOCOL_ERRORAn error found while performing operation on openais interface
0x102CL_GMS_ERR_CONFIG_FILE_INVALIDThe config file paramer is invalid(NOT used)
0x103CL_GMS_ERR_GROUP_DOESNT_EXISTRequested group doesnt exist.
0x104CL_GMS_ERR_EMPTY_GROUPThe group is empty (INCOMPLETE Usage)
0x105CL_GMS_ERR_IOC_REGISTRATIONIOC registration of the group member failed.
0x106CL_GMS_ERR_IOC_DEREGISTRATIONIOC Deregistration of the group member failed
0x107CL_GMS_ERR_CLUSTER_VERSION_MISMATCHIf the joining node is version incompatible with that of the other nodes in the cluster .

Intelligent Object Communication Error Codes

ValueError CodeComments
0x100CL_IOC_ERR_INIT_FAILEDIOC or Transport is not initialized.
0x101CL_IOC_ERR_COMMPORT_REG_FAILRegistering the communication port with IOC has failed.
0x102CL_IOC_ERR_TRY_AGAINThe operation could not succeed. Can be tried again.
0x103CL_IOC_ERR_COMMPORT_INVALID_MODEInvalid mode of communication port.
0x104CL_IOC_ERR_TL_LIMIT_EXCEEDEDNo more entries can be added to TL.
0x105CL_IOC_ERR_TL_DUPLICATE_ENTRYEntry already exists.
0x106CL_IOC_ERR_TL_ACTIVE_INST_NOT_PRESENTNo active instance present.
0x107CL_IOC_ERR_INVALID_SESSIONNot a valid session.
0x108CL_IOC_ERR_COMP_UNREACHABLEThe requested component/commport is not reachable.
0x109CL_IOC_ERR_XPORT_NOT_REGISTEREDTransport is not registered.
0x10aCL_IOC_ERR_XPORT_ALREADY_REGISTEREDTransport is already registered.
0x10bCL_IOC_ERR_XPORT_LINK_NOT_REGISTEREDLink is not registered.
0x10cCL_IOC_ERR_XPORT_LINK_NOT_DELETEDLink couldnot be deleted.
0x10dCL_IOC_ERR_HOST_UNREACHABLEThe requested host is not reachable.
0x10eCL_IOC_ERR_COMMPORT_BLOCKEDThe communications is blocked, performing the requested operation.
0x10fCL_IOC_ERR_ROUTE_NOT_EXISTRoute entry does not exist.
0x110CL_IOC_ERR_PROTO_IN_USE_WITH_IOCThe passed protocol type is IOC internal protocol.
0x111CL_IOC_ERR_FLOW_XOFF_STATEFlow control is in XOFF state.
0x112CL_IOC_ERR_RECV_UNBLOCKEDReceive call did not succeed, blocked receive call is unblocked.
0x113CL_IOC_ERR_INVALID_MSG_OPTIONInvalid type of message passed.
0x114CL_IOC_ERR_XPORT_LINK_LIMIT_EXCEEDEDMaximum number of links allowed per transport has already reached.
0x115CL_IOC_ERR_NODE_EXISTSNode is already registered.
0x116CL_IOC_ERR_MAXIOC maximum of error code.

Log Service Error Codes

ValueError CodeComments
0x101CL_LOG_ERR_FILE_FULLIf file full action is CL_LOG_FILE_FULL_ACTION_HALT, then file becomes full, this error will be returned to the user.
0x102CL_LOG_ERR_INVALID_XML_FILEIf the configuration clLog.xml is not proper, some of the expected fields are not proper, then this error will be returned.

Mediation Library Error Codes

ValueError CodeComments
0x100CL_MED_ERR_NO_OPCODEOpCode is not found in Container.
0x101CL_MED_ERR_WRONG_IDAgentId is incorrect.
0x102CL_MED_ERR_NO_INSTANCEInstance translation is not found.

Name Service Error Codes

ValueError CodeComments
0x100CL_NS_ERR_ENTRY_NOT_FOUNDOn querying an entry that is not present.
0x101CL_NS_ERR_LIMIT_EXCEEDEDOn creating or registering the contexts and entries more than the maximum allowed.
0x102CL_NS_ERR_CONTEXT_NOT_CREATEDOn registering, deregistering or querying a context that does not exist.
0x103CL_NS_ERR_SERVICE_NOT_REGISTEREDTrying to delete a service that was not registered.
0x104CL_NS_ERR_CONTEXT_CREATION_FAILEDContext creation failed.
0x105CL_NS_ERR_OPERATION_NOT_PERMITTEDRequested operation not permitted.
0x106CL_NS_ERR_CONTEXT_ALREADY_CREATEDWhile trying to create a context that is already created.

Provisioning Library Error Codes

ValueError CodeComments
0x100CL_PROV_INTERNAL_ERRORProvision Library returns this error when internal error happens.

Operating System Abstraction Layer Error Codes

ValueError CodeComments
0x100CL_OSAL_ERR_OS_ERRORError returned when the osal library is not initialized
0x101CL_OSAL_ERR_CREATE_MUTEXError returned when creation of mutex fails.
0x102CL_OSAL_ERR_TASK_ATTRIBUTE_INITError returned when initialization of task attribute fails.
0x103CL_OSAL_ERR_TASK_CREATEError returned when creation of task fails.
0x104CL_OSAL_ERR_TASK_DELETEError returned when deletion of task fails.
0x105CL_OSAL_ERR_TASK_ATTRIBUTE_SETError returned when task attribute cannot be set.
0x106CL_OSAL_ERR_TASK_DELAYError returned when delaying a task fails.
0x107CL_OSAL_ERR_MUTEX_CREATEError returned when creation of mutex fails.
0x108CL_OSAL_ERR_MUTEX_LOCKError returned when locking of mutex fails.
0x109CL_OSAL_ERR_MUTEX_UNLOCKError returned when unlocking of mutex fails.
0x10aCL_OSAL_ERR_MUTEX_DELETEError returned when deletion of mutex fails.
0x10bCL_OSAL_ERR_CONDITION_CREATEError returned when initializing condition variable fails.
0x10cCL_OSAL_ERR_CONDITION_DELETEError returned when destroying condition variable fails.
0x10dCL_OSAL_ERR_CONDITION_WAITError returned when waiting on a condition variable fails.
0x10eCL_OSAL_ERR_CONDITION_BROADCASTError returned when unable to restart all threads waiting on a condition variable.
0x10fCL_OSAL_ERR_CONDITION_SIGNALError returned when unable to restart a thread waiting on a condition variable
0x110CL_OSAL_ERR_SCHEDULE_POLICYNot used
0x111CL_OSAL_ERR_COS_CLEANUPError returned when finalization of osal library fails.
0x112CL_OSAL_ERR_TASK_ATTRIBUTE_GETError returned when task attribute cannot be retrieved.
0x113CL_OSAL_ERR_NO_TASK_EXISTError returned when the task referred to does not exist.
0x114CL_OSAL_ERR_TASK_STACK_SIZEError returned when stack size of thread creation attribute cannot be set
0x115CL_OSAL_ERR_TIME_OF_DAYError returned when time of day cannot be obtained
0x116CL_OSAL_ERR_SEM_CREATEError returned when creation of semaphore fails.
0x117CL_OSAL_ERR_SEM_ID_GETError returned when the semaphore ID cannot be retrieved.
0x118CL_OSAL_ERR_SEM_LOCKError returned when locking of a semaphore fails.
0x119CL_OSAL_ERR_SEM_UNLOCKError returned when unlocking of a semaphore fails.
0x11aCL_OSAL_ERR_SEM_GET_VALUEError returned when the value of semaphore cannot be obtained.
0x11bCL_OSAL_ERR_SEM_DELETEError returned when deletion of a semaphore fails.
0x11cCL_OSAL_ERR_PROCESS_CREATEError returned when process creation fails.
0x11dCL_OSAL_ERR_PROCESS_DELETEError returned when deletion fails.
0x11eCL_OSAL_ERR_PROCESS_WAITError returned when waiting on a child process fails.
0x11fCL_OSAL_ERR_SHM_CREATEError returned when creation of shared memory fails.
0x120CL_OSAL_ERR_SHM_ID_GETError returned when the ID of the shared memory cannot be retrieved.
0x121CL_OSAL_ERR_SHM_DELETEError returned when deletion of shared memory fails.
0x122CL_OSAL_ERR_SHM_ATTACHOn failure in attaching a shared memory.
0x123CL_OSAL_ERR_SHM_DETACHOn failure in detaching a shared memory.
0x124CL_OSAL_ERR_SHM_MODE_SETOn failure in setting permissions to a shared memory.
0x125CL_OSAL_ERR_SHM_MODE_GETOn failure in retrieving permissions of a shared memory.
0x126CL_OSAL_ERR_SHM_SIZEOn failure in retrieving size of a shared memory.
0x127CL_OSAL_ERR_COS_INITError returned when initialization of osal library failed.
0x128CL_OSAL_ERR_MEM_POOL_CREATEError returned when creation of memory pool fails.
0x129CL_OSAL_ERR_MEM_POOL_DETACHError returned when detaching of memory pool fails.
0x130CL_OSAL_ERR_MEM_POOL_DELETEError returned when deleting of memory pool fails.
0x131CL_OSAL_ERR_NAME_TOO_LONGError returned when the name given in semaphore creation is greater than 20
0x132CL_OSAL_ERR_CONDITION_TIMEDOUTError returned when the thread is not signalled within a time period specified

Timer Error Codes

ValueError CodeComments
0x100CL_TIMER_ERR_INVALID_TIMER(0x100) The timer is either already freed, or in a state that makes this operation invalid. For example, if you called "start" but the timer is already started.
0x102CL_TIMER_ERR_INVALID_TIMER_TYPE(0x102) The timer type (one-shot or repetitive) was set incorrectly. The value is corrupt or an unknown timer type.
0x103CL_TIMER_ERR_INVALID_TIMER_CONTEXT_TYPE(0x103) The timer context (CL_TIMER_TASK_CONTEXT, or CL_TIMER_SEPARATE_CONTEXT) was set incorrectly. The value is corrupt.
0x104CL_TIMER_ERR_NULL_TIMER_CALLBACK(0x104) The timer was created without a callback function. The callback is called upon timer expiry, so setting a timer without a callback is useless.

Transaction Error Codes

ValueError CodeComments
0x100CL_TXN_ERR_VALIDATE_FAILEDError code representing validation failure. This value is 0x100
0x101CL_TXN_ERR_TRANSACTION_ROLLED_BACKError code representing commit failure. This value is 0x101
0x102CL_TXN_ERR_TRANSACTION_FAILUREError code representing transaction failure. This value is 0x102
0x103CL_TXN_ERR_NO_REGD_SERVICEError code representing no services registered at a transaction-agent. This value is 0x103
0x104CL_TXN_ERR_INVALID_CMP_CAPABILITYError code representing invalid/mis-match of component and agent capability. This value is 0x104
0x105CL_TXN_ERR_AGENT_FAILED_VOIDError code representing failed agent count is void. This value is 0x105
0x106CL_TXN_ERR_NO_JOBSError code representing failed agent count is void. This value is 0x106
0x107CL_TXN_ERR_NO_COMPONENTSError code representing failed agent count is void. This value is 0x107

Performance Management Error Codes

ValueError CodeComments

Generated on Tue Jan 10 10:29:15 PST 2012 for OpenClovis SDK using Doxygen