Edit

Share via

CIM_Error WMI class

  • Article

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.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[Indication, Exception, UMLPackagePath("CIM::Interop"), Version("2.22.1"), AMENDMENT]
class CIM_Error
{
  uint16 ErrorType;
  string OtherErrorType;
  string OwningEntity;
  string MessageID;
  string Message;
  string MessageArguments[];
  uint16 PerceivedSeverity;
  uint16 ProbableCause;
  string ProbableCauseDescription;
  string RecommendedActions[];
  string ErrorSource;
  uint16 ErrorSourceFormat = 0;
  string OtherErrorSourceFormat;
  uint32 CIMStatusCode;
  string CIMStatusCodeDescription;
};

Members

The CIM_Error class has these types of members:

Properties

The CIM_Error class has these properties.

CIMStatusCode

Data type: uint32

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_Error.CIMStatusCodeDescription")

The CIM status code that characterizes this instance. This property defines the status codes that can 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 possible values are.

Value Meaning
CIM_ERR_FAILED
1
 A general error occurred that is not covered by a more specific error code.
CIM_ERR_ACCESS_DENIED
2
 Access to a CIM resource was not available to the client.
CIM_ERR_INVALID_NAMESPACE
3
 The target namespace does not exist.
CIM_ERR_INVALID_PARAMETER
4
 One or more parameter values passed to the method were not valid.
CIM_ERR_INVALID_CLASS
5
 The specified class does not exist.
CIM_ERR_NOT_FOUND
6
 The requested object could not be found.
CIM_ERR_NOT_SUPPORTED
7
 The requested operation is not supported.
CIM_ERR_CLASS_HAS_CHILDREN
8
 Operation cannot be carried out on this class since it has instances.
CIM_ERR_CLASS_HAS_INSTANCES
9
 Operation cannot be carried out on this class since it has instances.
CIM_ERR_INVALID_SUPERCLASS
10
 Operation cannot be carried out since the specified superclass does not exist.
CIM_ERR_ALREADY_EXISTS
11
 Operation cannot be carried out because an object already exists.
CIM_ERR_NO_SUCH_PROPERTY
12
 The specified Property does not exist.
CIM_ERR_TYPE_MISMATCH
13
 The value supplied is incompatible with the type.
CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED
14
 The query language is not recognized or supported.
CIM_ERR_INVALID_QUERY
15
 The query is not valid for the specified query language.
CIM_ERR_METHOD_NOT_AVAILABLE
16
 The extrinsic Method could not be executed.
CIM_ERR_METHOD_NOT_FOUND
17
 The specified extrinsic Method does not exist.
CIM_ERR_UNEXPECTED_RESPONSE
18
 The returned response to the asynchronous operation was not expected.
CIM_ERR_INVALID_RESPONSE_DESTINATION
19
 The specified destination for the asynchronous response is not valid.
CIM_ERR_NAMESPACE_NOT_EMPTY
20
 The specified namespace is not empty.
CIM_ERR_INVALID_ENUMERATION_CONTEXT
21
 The enumeration context supplied is not valid.
CIM_ERR_INVALID_OPERATION_TIMEOUT
22
 The specified Namespace is not empty.
CIM_ERR_PULL_HAS_BEEN_ABANDONED
23
 The specified Namespace is not empty.
CIM_ERR_PULL_CANNOT_BE_ABANDONED
24
 The attempt to abandon a pull operation has failed.
CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED
25
 Filtered Enumerations are not supported.
CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED
26
 Continue on error is not supported.
CIM_ERR_SERVER_LIMITS_EXCEEDED
27
 The WBEM Server limits have been exceeded (e.g. memory, connections, ...)
CIM_ERR_SERVER_IS_SHUTTING_DOWN
28
 The WBEM Server is shutting down.
CIM_ERR_QUERY_FEATURE_NOT_SUPPORTED
29
 The specified Query Feature is not supported.
DMTF Reserved
30 65535
 Reserved for future use.

CIMStatusCodeDescription

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_Error.CIMStatusCode")

A free-form string containing a human-readable description of the CIMStatusCode property. This description can extend, but must be consistent with, the value of CIMStatusCode.

ErrorSource

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_Error.ErrorSourceFormat")

Identifies the entity or 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.

ErrorSourceFormat

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_Error.ErrorSource", "CIM_Error.OtherErrorSourceFormat")

Describes the format of the ErrorSource property.

The possible values are.

Value Meaning
Unknown
0
 The format is unknown or not meaningfully interpretable by a CIM client application.
Other
1
 The format is defined by the value of the OtherErrorSourceFormat property.
CIMObjectPath
2
 A CIM Object Path as defined in the CIM Infrastructure specification.
DMTF Reserved
3 65535
 Reserved for future use.

ErrorType

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_Error.OtherErrorType")

Primary classification of the error.

The possible values are.

Value Meaning
Unknown
0
 Unknown.
Other
1
 Other.
Communications Error
2
 Errors of this type are principally associated with the procedures and/or processes required to convey information from one point to another.
Quality of Service Error
3
 Quality of Service Error. Errors of this type are principally associated with failures that result in reduced functionality or performance.
Software Error
4
 Error of this type are principally associated with a software or processing fault.
Hardware Error
5
 Errors of this type are principally associated with an equipment or hardware failure.
Environmental Error
6
 Errors of this type are principally associated with a failure condition relating the to facility, or other environmental considerations.
Security Error
7
 Errors of this type are associated with security violations, detection of viruses, and similar issues.
Oversubscription Error
8
 Errors of this type are principally associated with the failure to allocate sufficient resources to complete the operation.
Unavailable Resource Error
9
 Errors of this type are principally associated with the failure to access a required resource.
Unsupported Operation Error
10
 Errors of this type are principally associated with requests that are not supported.
DMTF Reserved
11 65535

Message

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_Error.MessageID", "CIM_Error.MessageArguments")

The formatted message. This message is constructed by combining some or all of the dynamic elements specified in the MessageArguments property with the static elements defined in the MessageID.

MessageArguments

Data type: string array

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_Error.MessageID", "CIM_Error.Message")

An array containing the dynamic content of the message.

MessageID

Data type: string

Access type: Read-only

Qualifiers: Required, ModelCorrespondence ("CIM_Error.Message", "CIM_Error.MessageArguments")

An externally defined string that uniquely identifies, within the scope of the OwningEntity, the format of the Message.

OtherErrorSourceFormat

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_Error.ErrorSourceFormat")

Describes other values for ErrorSourceFormat. When ErrorSourceFormat is Other, this property must be non-NULL. For all other values of ErrorSourceFormat, this property must be set to NULL.

OtherErrorType

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_Error.ErrorType")

A free-form string describing the error when the ErrorType property is Other.

OwningEntity

Data type: string

Access type: Read-only

A 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.

PerceivedSeverity

Data type: uint16

Access type: Read-only

An enumerated value that describes the severity of the error as determined by the notifier.

The possible values are.

Value Meaning
Unknown
0
 The severity is unknown.
Other
1
 The severity's value can be found in the OtherSeverity property.
Information
2
 Provides an informative response.
Degraded/Warning
3
 An action may be needed.
Minor
4
 An action is needed, but the situation is not serious at this time.
Major
5
 Action is needed immediately.
Critical
6
 Action is needed immediately, and the scope is broad.
Fatal/NonRecoverable
7
 An error has occurred, but it too late to take action.
DMTF Reserved
8 65535
 Reserved for future use.

ProbableCause

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_Error.ProbableCauseDescription")

An enumerated value that describes the probable cause of the error.

The possible values are.

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

ProbableCauseDescription

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_Error.ProbableCause")

A free-form string describing the probable cause of the error.

RecommendedActions

Data type: string array

Access type: Read-only

A free-form string describing recommended actions to take to resolve the error.

Requirements

Requirement Value
Minimum supported client
 Windows 8
Minimum supported server
 Windows Server 2012
Namespace
 Root\standardcimv2
MOF
NetTCPIP.mof
DLL
NetTCPIP.dll