Class CIM_AlertIndication

Used in features: WS-Eventing
Compatible with the following Intel AMT Releases: 3.2, 4.0, 5.0, 5.1, 6.0, 6.1, 6.2, 7.0, 8.0, 8.1, 9.0, 9.5
CIM_Indication
   extended by CIM_ProcessIndication
      extended by CIM_AlertIndication


class CIM_AlertIndication
extends CIM_ProcessIndication

General Information:
A concrete superclass for CIM Alert notifications. An AlertIndication is a specialized type of CIM_Indication that contains information about the severity, cause, recommended actions and other data of a real world event. This event and its data may or may not be modeled in the CIM class hierarchy.

Qualifiers:
-------------
Indication
Version=2.27.0
UMLPackagePath=CIM::Event


Supported Fields Summary
 string IndicationIdentifier
An identifier for the Indication . . .
 datetime IndicationTime
The time and date of creation of the Indication . . .
 string OtherSeverity
Holds the value of the user defined severity value when 'PerceivedSeverity' is 1 ("Other").
 string IndicationFilterName
An identifier for the indication filter that selects this indication and causes it to be sent . . .
 string AlertingManagedElement
The identifying information of the entity (ie, the instance) for which this Indication is generated . . .
 uint16 AlertingElementFormat
The format of the AlertingManagedElement property is interpretable based upon the value of this property . . .
 string OtherAlertingElementFormat
A string defining "Other" values for AlertingElementFormat . . .
 uint16 AlertType
Primary classification of the Indication . . .
 uint16 PerceivedSeverity
An enumerated value that describes the severity of the Alert Indication from the notifier's point of view: 1 - Other, by CIM convention, is used to indicate that the Severity's value can be found in the OtherSeverity property . . .
 uint16 ProbableCause
An enumerated value that describes the probable cause of the situation which resulted in the AlertIndication.
 string SystemName
The scoping System's Name for the Provider generating this Indication.
 string Message
The formatted message . . .
 string[6] MessageArguments
An array containing the dynamic content of the message.
 string MessageID
A string that uniquely identifies, within the scope of the OwningEntity, the format of the Message.
 string OwningEntity
A string that uniquely identifies the entity that owns the definition of the format of the Message described in this instance . . .

Methods Summary
  Get(Instance)
Gets the representation of the instance
  Enumerate()
Enumerates the instances of this class

Field Detail

IndicationIdentifier

public string IndicationIdentifier
General Information:
An identifier for the Indication. This property is similar to a key value in that it can be used for identification, when correlating Indications (see the CorrelatedIndications array). Its value SHOULD be unique as long as correlations are reported, but MAY be reused or left NULL if no future Indications will reference it in their CorrelatedIndications array.To ensure uniqueness, the value of IndicationIdentifier should be constructed using the following "preferred" algorithm:
<OrgID>:<LocalID>
Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the IndicationIdentifier or that is a recognized ID that is assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in IndicationIdentifier must appear between <OrgID> and <LocalID>.
<LocalID> is chosen by the business entity and should not be re-used to identify different underlying (real-world) elements.
If the above "preferred" algorithm is not used, the defining entity should assure that the resulting IndicationIdentifier is not re-used across any IndicationIdentifiers that are produced by this or other providers for the NameSpace of this instance.
For DMTF-defined instances, the "preferred" algorithm should be used with the <OrgID> set to CIM.

Product Specific Usage:
In Intel AMT Release 6.0 and later releases value is empty string

Qualifiers:
-------------
MappingStrings={Recommendation.ITU|X733.Notification identifier}
MaxLen=64


IndicationTime

public datetime IndicationTime
General Information:
The time and date of creation of the Indication. The property may be set to NULL if the entity creating the Indication is not capable of determining this information. Note that IndicationTime may be the same for two Indications that are generated in rapid succession.

Product Specific Usage:
Additional Notes:
1) In Intel AMT Release 5.0 and earlier releases 'datetime' format is simple string. In Intel AMT Release 5.1 and later releases 'datetime' format is as defined in DSP0230 'DMTF WS-CIM Mapping Specification'.


OtherSeverity

public string OtherSeverity
General Information:
Holds the value of the user defined severity value when 'PerceivedSeverity' is 1 ("Other").

Qualifiers:
-------------
ModelCorrespondence={CIM_AlertIndication.PerceivedSeverity}
MaxLen=32


IndicationFilterName

public string IndicationFilterName
General Information:
An identifier for the indication filter that selects this indication and causes it to be sent. This property is to be filled out by the indication sending service. The value shall be correlatable with the Name property of the instance of CIM_IndicationFilter describing the criteria of the indication. The value of the IndicationFilterName should be formatted using the following algorithm: < OrgID > : < LocalID >, where < OrgID > and < LocalID > are separated by a colon (:) and < OrgID > shall include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the value or that is a registered ID assigned to the business entity by a recognized global authority. In addition, to ensure uniqueness, < OrgID > shall not contain a colon (:).When using this algorithm, the first colon to appear in the value shall appear between < OrgID > and < LocalID >. < LocalID > is chosen by the business entity and shall be used uniquely.

Qualifiers:
-------------
ModelCorrespondence={CIM_IndicationFilter.Name}
MaxLen=64


AlertingManagedElement

public string AlertingManagedElement
General Information:
The identifying information of the entity (ie, the instance) for which this Indication is generated. The property contains the path of an instance, encoded as a string parameter - if the instance is modeled in the CIM Schema. If not a CIM instance, the property contains some identifying string that names the entity for which the Alert is generated. The path or identifying string is formatted per the AlertingElementFormat property.

Product Specific Usage:
Additional Notes:
1) In Intel AMT Release 6.0 and later releases, AlertingManagedElement is restricted to a maximum of 64 characters

Qualifiers:
-------------
ModelCorrespondence={CIM_AlertIndication.AlertingElementFormat}
MaxLen=256


AlertingElementFormat

public uint16 AlertingElementFormat
General Information:
The format of the AlertingManagedElement property is interpretable based upon 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 OtherAlertingElementFormat property.
2 - CIMObjectPath. The format is a CIMObjectPath, with format <NamespacePath>:<ClassName>.<Prop1>="<Value1>", <Prop2>="<Value2>", . . . specifying an instance in the CIM Schema.

Qualifiers:
-------------
ValueMap={0, 1, 2}
Values={Unknown, Other, CIMObjectPath}
ModelCorrespondence={CIM_AlertIndication.AlertingManagedElement, CIM_AlertIndication.OtherAlertingElementFormat}


OtherAlertingElementFormat

public string OtherAlertingElementFormat
General Information:
A string defining "Other" values for AlertingElementFormat. This value MUST be set to a non NULL value when AlertingElementFormat is set to a value of 1 ("Other"). For all other values of AlertingElementFormat, the value of this string must be set to NULL.

Qualifiers:
-------------
ModelCorrespondence={CIM_AlertIndication.AlertingElementFormat}
MaxLen=64


AlertType

public uint16 AlertType
General Information:
Primary classification of the Indication. The following values are defined:
1 - Other. The Indication's OtherAlertType property conveys its classification. Use of "Other" in an enumeration is a standard CIM convention. It means that the current Indication does not fit into the categories described by this enumeration.
2 - Communications Alert. An Indication of this type is principally associated with the procedures and/or processes required to convey information from one point to another.
3 - Quality of Service Alert. An Indication of this type is principally associated with a degradation or errors in the performance or function of an entity.
4 - Processing Error. An Indication of this type is principally associated with a software or processing fault.
5 - Device Alert. An Indication of this type is principally associated with an equipment or hardware fault.
6 - Environmental Alert. An Indication of this type is principally associated with a condition relating to an enclosure in which the hardware resides, or other environmental considerations.
7 - Model Change. The Indication addresses changes in the Information Model. For example, it may embed a Lifecycle Indication to convey the specific model change being alerted.
8 - Security Alert. An Indication of this type is associated with security violations, detection of viruses, and similar issues.

Qualifiers:
-------------
Required
ValueMap={1, 2, 3, 4, 5, 6, 7, 8}
Values={Other, Communications Alert, Quality of Service Alert, Processing Error, Device Alert, Environmental Alert, Model Change, Security Alert}
MappingStrings={Recommendation.ITU|X733.Event type}


PerceivedSeverity

public uint16 PerceivedSeverity
General Information:
An enumerated value that describes the severity of the Alert Indication from the notifier's point of view:
1 - Other, by CIM convention, is used to indicate that the Severity's value can be found in the OtherSeverity property.
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 AlertIndication is purely informational or its severity is simply unknown.

Qualifiers:
-------------
Required
Override=PerceivedSeverity
ValueMap={0, 1, 2, 3, 4, 5, 6, 7}
Values={Unknown, Other, Information, Degraded/Warning, Minor, Major, Critical, Fatal/NonRecoverable}
MappingStrings={Recommendation.ITU|X733.Perceived severity}


ProbableCause

public uint16 ProbableCause
General Information:
An enumerated value that describes the probable cause of the situation which resulted in the AlertIndication.

Qualifiers:
-------------
Required
ValueMap={0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130}
Values={Unknown, 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}
MappingStrings={Recommendation.ITU|X733.Probable cause, Recommendation.ITU|M3100.probableCause, ITU-IANA-ALARM-TC}
ModelCorrespondence={CIM_AlertIndication.ProbableCauseDescription, CIM_AlertIndication.EventID, CIM_AlertIndication.EventTime}


SystemName

public string SystemName
General Information:
The scoping System's Name for the Provider generating this Indication.

Qualifiers:
-------------
MaxLen=64


Message

public string Message
General Information:
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.

Product Specific Usage:
Each MessageId has a pre-defined message. In current implementation ME doesn't send the message. The message that corrospons to the MessageID can be found in the supported events list.

Qualifiers:
-------------
ModelCorrespondence={CIM_AlertIndication.MessageID, CIM_AlertIndication.MessageArguments}
MaxLen=256


MessageArguments

public string[6] MessageArguments
General Information:
An array containing the dynamic content of the message.

Product Specific Usage:
Additional Notes:
1) In Intel AMT Release 6.0 and later releases, MessageArguments is restricted to a maximum of 6 strings
2) The MessageArgument fields should be attached to the event's Message in order to get more details on the received event.

Qualifiers:
-------------
ModelCorrespondence={CIM_AlertIndication.Message, CIM_AlertIndication.MessageID}
MaxLen=256


MessageID

public string MessageID
General Information:
A string that uniquely identifies, within the scope of the OwningEntity, the format of the Message.

Product Specific Usage:
2 types can be returned in that field:
PLATXXXX - a standard DMTF event
AMTXXXX - a propriety ME event


Qualifiers:
-------------
ModelCorrespondence={CIM_AlertIndication.Message, CIM_AlertIndication.MessageArguments}
MaxLen=32


OwningEntity

public string OwningEntity
General Information:
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.

Product Specific Usage:
ME supports 2 types of events:
"DMTF" - a standard DMTF event
"Intel(r) AMT" - a propriety ME event

Qualifiers:
-------------
MaxLen=64


Method Detail

Get

public  Get([OUT]CIM_AlertIndication Instance)
Permission Information:
Permitted realms: ADMIN_SECURITY_EVENT_MANAGER_REALM, ADMIN_SECURITY_GENERAL_INFO_REALM

General Information:
Gets the representation of the instance

Enumerate

public  Enumerate()
Permission Information:
All users permitted to use method

General Information:
Enumerates the instances of this class

Copyright © 2006-2013, Intel Corporation. All rights reserved.