Reference Guide

Dell OpenManage Client Instrumentation Reference Guide
file:///T|/htdocs/SOFTWARE/smcliins/cli80/EN/refgd/index.htm[10/19/2012 9:56:27 AM]
Classes
Classes and properties are defined by the CIM schema. The profiles identify mandatory classes and properties to implement the profile. OMCI has
implemented the classes and properties listed in the following table to support the profiles.
For more information on CIM schema, classes and properties, refer to the website - dmtf.org/standards/cim.
Dell OpenManage Client Instrumentation Classes and Properties
Dell OpenMange Client Instrumentation provides information for a namespace through different classes.
Dell OpenManage Client Instrumentation DMTF Profiles
The namespace to access the Dell OMCI DMTF profiles is root\dcim\sysman.
The following tables describe the DMTF profiles and the classes associated with each profile.
Table 1-1: Dell OpenManage Client Instrumentation Classes and Properties Support CIM 2.17 Schema
DCIM_AlertIndication
AlertingElementFormat
The format of the AlertingManagedElement property is interpretable based upon the value of this property.
Possible values are:
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.
AlertingManagedElement
The identifying information of the entity (that is, 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.
AlertType
Primary classification of the Indication.
Possible values are:
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.
EventID
An instrumentation or provider specific value that describes the underlying "real-world" event represented by the Indication. Two Indications with
the same, non NULL EventID value are considered, by the creating entity, to represent the same event. The comparison of two EventID values is
only defined for Alert Indications with identical, non NULL values of SystemCreateClassName, SystemName, and ProviderName.
IndicationIdentifier
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 "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.
IndicationTime
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: IndicationTime may be the same for two Indications that are generated in rapid succession.
Message
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 An array containing the dynamic content of the message.
MessageID A string that uniquely identifies, within the scope of the OwningEntity, the format of the Message.
OtherAlertingElementFormat
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.
OtherAlertType A string describing the Alert type - used when the AlertType property is set to 1, "Other State Change".
OtherSeverity Holds the value of the user defined severity value when 'PerceivedSeverity' is 1 ("Other").
OwningEntity
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
An enumerated value that describes the severity of the Alert Indication from the notifier's point of view:
Possible values are:
2 and 0 - Information and Unknown (respectively) follow common usage. Literally, the AlertIndication is purely informational or its severity is
unknown.
1 - Other - By CIM convention, is used to indicate that the Severity's value can be found in the OtherSeverity property.
3 - Degraded/Warning - Is used when its appropriate to let the user decide if action is needed.
4 - Minor - Is used to indicate action is needed, but the situation is not serious at this time.
5 - Major - Is used to indicate action is needed NOW.
6 - Critical - Is used to indicate action is needed NOW and the scope is broad (perhaps an imminent outage to a critical resource will result).
7 - Fatal/Non recoverable - Is used to indicate an error occurred, but it is too late to take remedial action.
An enumerated value that describes the probable cause of the situation that resulted in the AlertIndication.