CIM_Error class

CIM_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 can be included as part of the response to a CIM Operation. CIM_Errors like CIM_Indications do not persist, and 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.

The CIM_Error class must be qualified with a Version qualifier. If a Version qualifier is not specified, the CIM_Errors that are returned will have the Microsoft-specific namespace: "https://schemas.microsoft.com/wbem/wsman/1/wmi/root/testmethod/CIM_ERROR".

Important  The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

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

Syntax

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

Properties

The CIM_Error class has these properties.

CIMStatusCode

Data type: uint32

Access type: Read-only

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.

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.
DMTF Reserved 21..	Reserved by the Distributed Management Task Force (DMTF).

 

CIMStatusCodeDescription

Data type: string

Access type: Read-only

A free-form string containing a human-readable description of CIMStatusCode. This description MAY extend, but MUST be consistent with, the definition of CIMStatusCode.

ErrorSource

Data type: string

Access type: Read-only

The identifying information of the entity (that is, 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.

ErrorSourceFormat

Data type: uint16

Access type: Read-only

The format of the ErrorSource property is interpretable based on the value of this property.

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.
CIMObjectHandle 2	A CIM Object Handle, encoded using the MOF syntax defined for the objectHandle non-terminal, is used to identify the entity.

 

ErrorType

Data type: uint16

Access type: Read-only

Primary classification of the error. The following values are defined:

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.

 

Message

Data type: string

Access type: Read-only

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

MessageArguments

Data type: string array

Access type: Read-only

An array containing the dynamic content of the message.

MessageID

Data type: string

Access type: Read-only

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

OtherErrorSourceFormat

Data type: string

Access type: Read-only

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

OtherErrorType

Data type: string

Access type: Read-only

A free-form string describing the ErrorType when 1, "Other", is specified as the ErrorType.

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 from the notifier's point of view.

Value	Meaning
Unknown 0	Used when the severity is unknown.
Low 2	Used for noncritical issues, such as parameters that are not valid, incorrect usage, and unsupported functionality.
Medium 3	Used to indicate action is needed, but the situation is not serious at this time.
High 4	Used to indicate that immediate action is needed.
Fatal 5	Used to indicate a loss of data or unrecoverable system or service failure.

 

ProbableCause

Data type: uint16

Access type: Read-only

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

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)

//31 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)

//60 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)

//91 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)

//115 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)

ProbableCauseDescription

Data type: string

Access type: Read-only

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.

Remarks

This documentation is derived from the CIM class descriptions published by the DMTF. Microsoft may have made changes to correct minor errors, conform to Microsoft SDK documentation standards, or provide more information.

Requirements

Namespace

Root\CIMV2