CIM_Error class

Article
05/31/2018

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 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"), dynamic, provider("RAServerPSProvider"), 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

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

21 - CIM_ERR_INVALID_ENUMERATION_CONTEXT. The enumeration context supplied is not valid.

22 - CIM_ERR_INVALID_OPERATION_TIMEOUT. The specified Namespace is not empty.

23 - CIM_ERR_PULL_HAS_BEEN_ABANDONED. The specified Namespace is not empty.

24 - CIM_ERR_PULL_CANNOT_BE_ABANDONED. The attempt to abandon a pull operation has failed.

25 - CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED. Filtered Enumerations are not supported.

26 - CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED. Continue on error is not supported.

27 - CIM_ERR_SERVER_LIMITS_EXCEEDED. The WBEM Server limits have been exceeded (e.g. memory, connections, ...).

28 - CIM_ERR_SERVER_IS_SHUTTING_DOWN. The WBEM Server is shutting down.

29 - CIM_ERR_QUERY_FEATURE_NOT_SUPPORTED. The specified Query Feature is not supported.

CIM_ERR_FAILED (1)

CIM_ERR_ACCESS_DENIED (2)

CIM_ERR_INVALID_NAMESPACE (3)

CIM_ERR_INVALID_PARAMETER (4)

CIM_ERR_INVALID_CLASS (5)

CIM_ERR_NOT_FOUND (6)

CIM_ERR_NOT_SUPPORTED (7)

CIM_ERR_CLASS_HAS_CHILDREN (8)

CIM_ERR_CLASS_HAS_INSTANCES (9)

CIM_ERR_INVALID_SUPERCLASS (10)

CIM_ERR_ALREADY_EXISTS (11)

CIM_ERR_NO_SUCH_PROPERTY (12)

CIM_ERR_TYPE_MISMATCH (13)

CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED (14)

CIM_ERR_INVALID_QUERY (15)

CIM_ERR_METHOD_NOT_AVAILABLE (16)

CIM_ERR_METHOD_NOT_FOUND (17)

CIM_ERR_UNEXPECTED_RESPONSE (18)

CIM_ERR_INVALID_RESPONSE_DESTINATION (19)

CIM_ERR_NAMESPACE_NOT_EMPTY (20)

CIM_ERR_INVALID_ENUMERATION_CONTEXT (21)

CIM_ERR_INVALID_OPERATION_TIMEOUT (22)

CIM_ERR_PULL_HAS_BEEN_ABANDONED (23)

CIM_ERR_PULL_CANNOT_BE_ABANDONED (24)

CIM_ERR_FILTERED_ENUMERATION_NOT_SUPPORTED (25)

CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED (26)

CIM_ERR_SERVER_LIMITS_EXCEEDED (27)

CIM_ERR_SERVER_IS_SHUTTING_DOWN (28)

CIM_ERR_QUERY_FEATURE_NOT_SUPPORTED (29)

DMTF Reserved

30 4294967295

CIMStatusCodeDescription

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_Error.CIMStatusCode")

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
Qualifiers: ModelCorrespondence ("CIM_Error.ErrorSourceFormat")

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

ErrorSourceFormat

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_Error.ErrorSource", "CIM_Error.OtherErrorSourceFormat")

The 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 - CIMObjectPath. A CIM Object Path as defined in the CIM Infrastructure specification. Note: CIM 2.5 and earlier used the term object names.

Unknown (0)

Other (1)

CIMObjectPath (2)

DMTF Reserved

3 65535

ErrorType

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_Error.OtherErrorType")

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

Unknown (0)

Other (1)

Communications Error (2)

Quality of Service Error (3)

Software Error (4)

Hardware Error (5)

Environmental Error (6)

Security Error (7)

Oversubscription Error (8)

Unavailable Resource Error (9)

Unsupported Operation Error (10)

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 uniquely identified by the MessageID in a message registry or other catalog associated with the OwningEntity.

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 opaque 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")

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
Qualifiers: ModelCorrespondence ("CIM_Error.ErrorType")

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

0 - the Perceived Severity of the indication is unknown or indeterminate.

1 - Other, by CIM convention, is used to indicate that the Severity\'s value can be found in the OtherSeverity property.

2 - Information should be used when providing an informative response.

3 - Degraded/Warning should be used when its appropriate to let the user decide if action is needed.

4 - Minor should be used to indicate action is needed, but the situation is not serious at this time.

5 - Major should be used to indicate action is needed NOW.

6 - Critical should be used to indicate action is needed NOW and the scope is broad (perhaps an imminent outage to a critical resource will result).

7 - Fatal/NonRecoverable should be used to indicate an error occurred, but it\'s too late to take remedial action.

2 and 0 - Information and Unknown (respectively) follow common usage. Literally, the Error is purely informational or its severity is simply unknown.

Unknown (0)

Other (1)

Information (2)

Degraded/Warning (3)

Minor (4)

Major (5)

Critical (6)

Fatal/NonRecoverable (7)

DMTF Reserved

8 65535

ProbableCause

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_Error.ProbableCauseDescription")

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)

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

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


Minimum supported client	None supported
Minimum supported server	Windows Server 2012
Namespace	Root\Microsoft\Windows\RemoteAccess\Server
MOF	RAServerPSProvider.mof
DLL	RAServerPSProvider.dll

CIM_Error class

Syntax

Members

Properties

Requirements

Additional resources