CIM211 Class Declaration
CIM_Error

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_Error --> [top]

Class Attributes

Class Declaration Attributes
NameValue
NAMECIM_Error

Class Qualifiers

Class CIM_Error Qualifiers
NameTypeValueFrom Class
Indicationbooleantrue CIM_Error
Experimentalbooleantrue CIM_Error
Exceptionbooleantrue CIM_Error
Versionstring2.8.1000 CIM_Error
DescriptionstringCIM_Error is a specialized class that contains information about the severity, cause, recommended actions and other data related to the failure of a CIM Operation. Instances of this type MAY be included as part of the response to a CIM Operation. CIM_Errors like CIM_Indications do not persist, and therefore do not have keys. Currently, this is only allowed by defining a concrete class with the Indication qualifier. Until the CIM Specification is modified to allow other concrete classes without keys, the CIM_Error class MUST be qualified by both Indication and Exception. After this, the Indication qualifier can be removed. CIM_Error

Properties

Properties
NameTypeValueQualifiersClassOrigin
ErrorTypeuint16 Description
ValueMap
Values
CIM_Error
OtherErrorTypestring Description
ModelCorrespondence
CIM_Error
OwningEntitystring Required
Description
CIM_Error
MessageIDstring Required
Description
CIM_Error
Messagestring Required
Description
CIM_Error
MessageArgumentsstring[] Description CIM_Error
PerceivedSeverityuint16 Required
Description
ValueMap
Values
CIM_Error
ProbableCauseuint16 Required
Description
ValueMap
Values
MappingStrings
ModelCorrespondence
CIM_Error
ProbableCauseDescriptionstring Description
ModelCorrespondence
CIM_Error
RecommendedActionsstring[] Description CIM_Error
ErrorSourcestring Description
ModelCorrespondence
CIM_Error
ErrorSourceFormatuint160 Description
ValueMap
Values
ModelCorrespondence
CIM_Error
OtherErrorSourceFormatstring Description
ModelCorrespondence
CIM_Error
CIMStatusCodeuint32 Required
Description
ValueMap
Values
MappingStrings
ModelCorrespondence
CIM_Error
CIMStatusCodeDescriptionstring Description
MappingStrings
ModelCorrespondence
CIM_Error

Property Qualifiers

Property ErrorType Qualifiers
NameTypeValueFrom Class
DescriptionstringPrimary classification of the error. The following values are defined: 2 - Communications Error. Errors of this type are principally associated with the procedures and/or processes required to convey information from one point to another. 3 - Quality of Service Error. Errors of this type are principally associated with failures that result in reduced functionality or performance. 4 - Software Error. Error of this type are principally associated with a software or processing fault. 5 - Hardware Error. Errors of this type are principally associated with an equipment or hardware failure. 6 - Environmental Error. Errors of this type are principally associated with a failure condition relating the to facility, or other environmental considerations. 7 - Security Error. Errors of this type are associated with security violations, detection of viruses, and similar issues. 8 - Oversubscription Error. Errors of this type are principally associated with the failure to allocate sufficient resources to complete the operation. 9 - Unavailable Resource Error. Errors of this type are principally associated with the failure to access a required resource. 10 -Unsupported Operation Error. Errors of this type are principally associated with requests that are not supported. CIM_Error
ValueMapstring
[See below.]
CIM_Error
ValuesstringUnknown
Other
Communications Error
Quality of Service Error
Software Error
Hardware Error
Environmental Error
Security Error
Oversubscription Error
Unavailable Resource Error
Unsupported Operation Error
CIM_Error

NameValue
0Unknown
1Other
2Communications Error
3Quality of Service Error
4Software Error
5Hardware Error
6Environmental Error
7Security Error
8Oversubscription Error
9Unavailable Resource Error
10Unsupported Operation Error
Property OtherErrorType Qualifiers
NameTypeValueFrom Class
DescriptionstringA free-form string describing the ErrorType when 1, " Other " , is specified as the ErrorType. CIM_Error
ModelCorrespondencestringCIM_Error.ErrorType CIM_Error

Property OwningEntity Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_Error
DescriptionstringA string that uniquely identifies the entity that owns the definition of the format of the Message described in this instance. OwningEntity MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity or standards body defining the format. CIM_Error

Property MessageID Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_Error
DescriptionstringAn opaque string that uniquely identifies, within the scope of the OwningEntity, the format of the Message. CIM_Error

Property Message Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_Error
DescriptionstringThe formatted message. This message is constructed by applying the dynamic content of the message, described in MessageArguments, to the format string uniquely identified, within the scope of the OwningEntity, by MessageID. CIM_Error

Property MessageArguments Qualifiers
NameTypeValueFrom Class
DescriptionstringAn array containing the dynamic content of the message. CIM_Error

Property PerceivedSeverity Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_Error
DescriptionstringAn enumerated value that describes the severity of the error from the notifier ’ s point of view: 2 - Low should be used for noncritical issues such as invalid parameters, incorrect usage, unsupported functionality. 3 - Medium should be used to indicate action is needed, but the situation is not serious at this time. 4 - High should be used to indicate action is needed NOW. 5 - Fatal should be used to indicate a loss of data or unrecoverable system or service failure. CIM_Error
ValueMapstring
[See below.]
CIM_Error
ValuesstringUnknown
Low
Medium
High
Fatal
CIM_Error

NameValue
0Unknown
2Low
3Medium
4High
5Fatal
Property ProbableCause Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_Error
DescriptionstringAn enumerated value that describes the probable cause of the error. CIM_Error
ValueMapstring
[See below.]
CIM_Error
ValuesstringUnknown
Other
Adapter/Card Error
Application Subsystem Failure
Bandwidth Reduced
Connection Establishment Error
Communications Protocol Error
Communications Subsystem Failure
Configuration/Customization Error
Congestion
Corrupt Data
CPU Cycles Limit Exceeded
Dataset/Modem Error
Degraded Signal
DTE-DCE Interface Error
Enclosure Door Open
Equipment Malfunction
Excessive Vibration
File Format Error
Fire Detected
Flood Detected
Framing Error
HVAC Problem
Humidity Unacceptable
I/O Device Error
Input Device Error
LAN Error
Non-Toxic Leak Detected
Local Node Transmission Error
Loss of Frame
Loss of Signal
Material Supply Exhausted
Multiplexer Problem
Out of Memory
Output Device Error
Performance Degraded
Power Problem
Pressure Unacceptable
Processor Problem (Internal Machine Error)
Pump Failure
Queue Size Exceeded
Receive Failure
Receiver Failure
Remote Node Transmission Error
Resource at or Nearing Capacity
Response Time Excessive
Retransmission Rate Excessive
Software Error
Software Program Abnormally Terminated
Software Program Error (Incorrect Results)
Storage Capacity Problem
Temperature Unacceptable
Threshold Crossed
Timing Problem
Toxic Leak Detected
Transmit Failure
Transmitter Failure
Underlying Resource Unavailable
Version Mismatch
Previous Alert Cleared
Login Attempts Failed
Software Virus Detected
Hardware Security Breached
Denial of Service Detected
Security Credential Mismatch
Unauthorized Access
Alarm Received
Loss of Pointer
Payload Mismatch
Transmission Error
Excessive Error Rate
Trace Problem
Element Unavailable
Element Missing
Loss of Multi Frame
Broadcast Channel Failure
Invalid Message Received
Routing Failure
Backplane Failure
Identifier Duplication
Protection Path Failure
Sync Loss or Mismatch
Terminal Problem
Real Time Clock Failure
Antenna Failure
Battery Charging Failure
Disk Failure
Frequency Hopping Failure
Loss of Redundancy
Power Supply Failure
Signal Quality Problem
Battery Discharging
Battery Failure
Commercial Power Problem
Fan Failure
Engine Failure
Sensor Failure
Fuse Failure
Generator Failure
Low Battery
Low Fuel
Low Water
Explosive Gas
High Winds
Ice Buildup
Smoke
Memory Mismatch
Out of CPU Cycles
Software Environment Problem
Software Download Failure
Element Reinitialized
Timeout
Logging Problems
Leak Detected
Protection Mechanism Failure
Protecting Resource Failure
Database Inconsistency
Authentication Failure
Breach of Confidentiality
Cable Tamper
Delayed Information
Duplicate Information
Information Missing
Information Modification
Information Out of Sequence
Key Expired
Non-Repudiation Failure
Out of Hours Activity
Out of Service
Procedural Error
Unexpected Information
CIM_Error
MappingStringsstringRecommendation.ITU|X733.Probable cause
Recommendation.ITU|M3100.probableCause
ITU-IANA-ALARM-TC
CIM_Error
ModelCorrespondencestringCIM_Error.ProbableCauseDescription CIM_Error

NameValue
0Unknown
1Other
2Adapter/Card Error
3Application Subsystem Failure
4Bandwidth Reduced
5Connection Establishment Error
6Communications Protocol Error
7Communications Subsystem Failure
8Configuration/Customization Error
9Congestion
10Corrupt Data
11CPU Cycles Limit Exceeded
12Dataset/Modem Error
13Degraded Signal
14DTE-DCE Interface Error
15Enclosure Door Open
16Equipment Malfunction
17Excessive Vibration
18File Format Error
19Fire Detected
20Flood Detected
21Framing Error
22HVAC Problem
23Humidity Unacceptable
24I/O Device Error
25Input Device Error
26LAN Error
27Non-Toxic Leak Detected
28Local Node Transmission Error
29Loss of Frame
30Loss of Signal
31Material Supply Exhausted
32Multiplexer Problem
33Out of Memory
34Output Device Error
35Performance Degraded
36Power Problem
37Pressure Unacceptable
38Processor Problem (Internal Machine Error)
39Pump Failure
40Queue Size Exceeded
41Receive Failure
42Receiver Failure
43Remote Node Transmission Error
44Resource at or Nearing Capacity
45Response Time Excessive
46Retransmission Rate Excessive
47Software Error
48Software Program Abnormally Terminated
49Software Program Error (Incorrect Results)
50Storage Capacity Problem
51Temperature Unacceptable
52Threshold Crossed
53Timing Problem
54Toxic Leak Detected
55Transmit Failure
56Transmitter Failure
57Underlying Resource Unavailable
58Version Mismatch
59Previous Alert Cleared
60Login Attempts Failed
61Software Virus Detected
62Hardware Security Breached
63Denial of Service Detected
64Security Credential Mismatch
65Unauthorized Access
66Alarm Received
67Loss of Pointer
68Payload Mismatch
69Transmission Error
70Excessive Error Rate
71Trace Problem
72Element Unavailable
73Element Missing
74Loss of Multi Frame
75Broadcast Channel Failure
76Invalid Message Received
77Routing Failure
78Backplane Failure
79Identifier Duplication
80Protection Path Failure
81Sync Loss or Mismatch
82Terminal Problem
83Real Time Clock Failure
84Antenna Failure
85Battery Charging Failure
86Disk Failure
87Frequency Hopping Failure
88Loss of Redundancy
89Power Supply Failure
90Signal Quality Problem
91Battery Discharging
92Battery Failure
93Commercial Power Problem
94Fan Failure
95Engine Failure
96Sensor Failure
97Fuse Failure
98Generator Failure
99Low Battery
100Low Fuel
101Low Water
102Explosive Gas
103High Winds
104Ice Buildup
105Smoke
106Memory Mismatch
107Out of CPU Cycles
108Software Environment Problem
109Software Download Failure
110Element Reinitialized
111Timeout
112Logging Problems
113Leak Detected
114Protection Mechanism Failure
115Protecting Resource Failure
116Database Inconsistency
117Authentication Failure
118Breach of Confidentiality
119Cable Tamper
120Delayed Information
121Duplicate Information
122Information Missing
123Information Modification
124Information Out of Sequence
125Key Expired
126Non-Repudiation Failure
127Out of Hours Activity
128Out of Service
129Procedural Error
130Unexpected Information
Property ProbableCauseDescription Qualifiers
NameTypeValueFrom Class
DescriptionstringA free-form string describing the probable cause of the error. CIM_Error
ModelCorrespondencestringCIM_Error.ProbableCause CIM_Error

Property RecommendedActions Qualifiers
NameTypeValueFrom Class
DescriptionstringA free-form string describing recommended actions to take to resolve the error. CIM_Error

Property ErrorSource Qualifiers
NameTypeValueFrom Class
DescriptionstringThe identifying information of the entity (i.e., the instance) generating the error. If this entity is modeled in the CIM Schema, this property contains the path of the instance encoded as a string parameter. If not modeled, the property contains some identifying string that names the entity that generated the error. The path or identifying string is formatted per the ErrorSourceFormat property. CIM_Error
ModelCorrespondencestringCIM_Error.ErrorSourceFormat CIM_Error

Property ErrorSourceFormat Qualifiers
NameTypeValueFrom Class
DescriptionstringThe format of the ErrorSource property is interpretable based on the value of this property. Values are defined as: 0 - Unknown. The format is unknown or not meaningfully interpretable by a CIM client application. 1 - Other. The format is defined by the value of the OtherErrorSourceFormat property. 2 - CIMObjectHandle. A CIM Object Handle, encoded using the MOF syntax defined for the objectHandle non-terminal, is used to identify the entity. CIM_Error
ValueMapstring
[See below.]
CIM_Error
ValuesstringUnknown
Other
CIMObjectHandle
CIM_Error
ModelCorrespondencestringCIM_Error.ErrorSource
CIM_Error.OtherErrorSourceFormat
CIM_Error

NameValue
0Unknown
1Other
2CIMObjectHandle
Property OtherErrorSourceFormat Qualifiers
NameTypeValueFrom Class
DescriptionstringA string defining " Other " values for ErrorSourceFormat. This value MUST be set to a non NULL value when ErrorSourceFormat is set to a value of 1 ( " Other " ). For all other values of ErrorSourceFormat, the value of this string must be set to NULL. CIM_Error
ModelCorrespondencestringCIM_Error.ErrorSourceFormat CIM_Error

Property CIMStatusCode Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_Error
DescriptionstringThe CIM status code that characterizes this instance. This property defines the status codes that MAY be return by a conforming CIM Server or Listener. Note that not all status codes are valid for each operation. The specification for each operation SHOULD define the status codes that may be returned by that operation. The following values for CIM status code are defined: 1 - CIM_ERR_FAILED. A general error occurred that is not covered by a more specific error code. 2 - CIM_ERR_ACCESS_DENIED. Access to a CIM resource was not available to the client. 3 - CIM_ERR_INVALID_NAMESPACE. The target namespace does not exist. 4 - CIM_ERR_INVALID_PARAMETER. One or more parameter values passed to the method were invalid. 5 - CIM_ERR_INVALID_CLASS. The specified Class does not exist. 6 - CIM_ERR_NOT_FOUND. The requested object could not be found. 7 - CIM_ERR_NOT_SUPPORTED. The requested operation is not supported. 8 - CIM_ERR_CLASS_HAS_CHILDREN. Operation cannot be carried out on this class since it has instances. 9 - CIM_ERR_CLASS_HAS_INSTANCES. Operation cannot be carried out on this class since it has instances. 10 - CIM_ERR_INVALID_SUPERCLASS. Operation cannot be carried out since the specified superclass does not exist. 11 - CIM_ERR_ALREADY_EXISTS. Operation cannot be carried out because an object already exists. 12 - CIM_ERR_NO_SUCH_PROPERTY. The specified Property does not exist. 13 - CIM_ERR_TYPE_MISMATCH. The value supplied is incompatible with the type. 14 - CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED. The query language is not recognized or supported. 15 - CIM_ERR_INVALID_QUERY. The query is not valid for the specified query language. 16 - CIM_ERR_METHOD_NOT_AVAILABLE. The extrinsic Method could not be executed. 17 - CIM_ERR_METHOD_NOT_FOUND. The specified extrinsic Method does not exist. 18 - CIM_ERR_UNEXPECTED_RESPONSE. The returned response to the asynchronous operation was not expected. 19 - CIM_ERR_INVALID_RESPONSE_DESTINATION. The specified destination for the asynchronous response is not valid. 20 - CIM_ERR_NAMESPACE_NOT_EMPTY. The specified Namespace is not empty. CIM_Error
ValueMapstring
[See below.]
CIM_Error
ValuesstringCIM_ERR_FAILED
CIM_ERR_ACCESS_DENIED
CIM_ERR_INVALID_NAMESPACE
CIM_ERR_INVALID_PARAMETER
CIM_ERR_INVALID_CLASS
CIM_ERR_NOT_FOUND
CIM_ERR_NOT_SUPPORTED
CIM_ERR_CLASS_HAS_CHILDREN
CIM_ERR_CLASS_HAS_INSTANCES
CIM_ERR_INVALID_SUPERCLASS
CIM_ERR_ALREADY_EXISTS
CIM_ERR_NO_SUCH_PROPERTY
CIM_ERR_TYPE_MISMATCH
CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
CIM_ERR_INVALID_QUERY
CIM_ERR_METHOD_NOT_AVAILABLE
CIM_ERR_METHOD_NOT_FOUND
CIM_ERR_UNEXPECTED_RESPONSE
CIM_ERR_INVALID_RESPONSE_DESTINATION
CIM_ERR_NAMESPACE_NOT_EMPTY
DMTF Reserved
CIM_Error
MappingStringsstringDSP0201.DMTF|ERROR.CODE|2.2 CIM_Error
ModelCorrespondencestringCIM_Error.CIMStatusCodeDescription CIM_Error

NameValue
1CIM_ERR_FAILED
2CIM_ERR_ACCESS_DENIED
3CIM_ERR_INVALID_NAMESPACE
4CIM_ERR_INVALID_PARAMETER
5CIM_ERR_INVALID_CLASS
6CIM_ERR_NOT_FOUND
7CIM_ERR_NOT_SUPPORTED
8CIM_ERR_CLASS_HAS_CHILDREN
9CIM_ERR_CLASS_HAS_INSTANCES
10CIM_ERR_INVALID_SUPERCLASS
11CIM_ERR_ALREADY_EXISTS
12CIM_ERR_NO_SUCH_PROPERTY
13CIM_ERR_TYPE_MISMATCH
14CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
15CIM_ERR_INVALID_QUERY
16CIM_ERR_METHOD_NOT_AVAILABLE
17CIM_ERR_METHOD_NOT_FOUND
18CIM_ERR_UNEXPECTED_RESPONSE
19CIM_ERR_INVALID_RESPONSE_DESTINATION
20CIM_ERR_NAMESPACE_NOT_EMPTY
21..DMTF Reserved
Property CIMStatusCodeDescription Qualifiers
NameTypeValueFrom Class
DescriptionstringA free-form string containing a human-readable description of CIMStatusCode. This description MAY extend, but MUST be consistent with, the definition of CIMStatusCode. CIM_Error
MappingStringsstringDSP0201.DMTF|ERROR.DESCRIPTION|2.2 CIM_Error
ModelCorrespondencestringCIM_Error.CIMStatusCode CIM_Error

Methods

Method Qualifiers

Parameters

Parameter Qualifiers

Associations this class can participate in