Class CIM_MessageLog
extends CIM_LogicalElement

MessageLog represents any type of event, error or informational register or chronicle. The object describes the existence of the log and its characteristics. Several methods are defined for retrieving, writing and deleting log entries, and maintaining the log.

Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_MessageLog

Direct Known Subclasses

None.

Class Qualifiers

NameData TypeValueScopeFlavors
DescriptionstringMessageLog represents any type of event, error or informational register or chronicle. The object describes the existence of the log and its characteristics. Several methods are defined for retrieving, writing and deleting log entries, and maintaining the log.None TRANSLATABLE= true

Local Class Properties

NameData TypeQualifiers
NameData TypeValueScopeFlavors
CharacterSetuint16
DescriptionstringAn enumeration describing the character set used to record data in the individual Log entries. For example, the Log records may contain ASCII data (value=2), or be raw octet strings (value=10).None TRANSLATABLE= true
ValuesstringUnknown, Other, ASCII, Unicode, ISO2022, ISO8859, Extended UNIX Code, UTF-8, UCS-2, Bitmapped Data, OctetString, Defined by Individual RecordsNone TRANSLATABLE= true
CreationClassNamestring
DescriptionstringCreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
CurrentNumberOfRecordsuint64
DescriptionstringCurrent number of entries (records) in the Log.None TRANSLATABLE= true
GaugebooleantrueNone None
HeaderFormatstring
DescriptionstringIf the SizeOfHeader property is non-zero, this property describes the structure and format of the Log header. It is a free-form string. If the SizeOfHeader property is 0, then the information in this property is undefined.None TRANSLATABLE= true
IsFrozenboolean
DescriptionstringBoolean indicating that the Log is currently frozen and modifications are not allowed.None TRANSLATABLE= true
LastChangeuint16
DescriptionstringAn enumeration describing the last change to the MessageLog.None TRANSLATABLE= true
ValuesstringUnknown, Add, Delete, Modify, Log ClearedNone TRANSLATABLE= true
MaxLogSizeuint64
DescriptionstringThe maximum size, in bytes, to which the Log can grow. If there is no maximum, then MaxLogSize should be set to 0.None TRANSLATABLE= true
UnitsstringBytesNone TRANSLATABLE= true
MaxNumberOfRecordsuint64
DescriptionstringMaximum number of records that can be captured in the Log. If undefined, a value of zero should be specified. Note that when the Capabilities array indicates that variable length records are supported (value=7), then it is possible that this maximum may not be achieved.None TRANSLATABLE= true
MaxRecordSizeuint64
DescriptionstringMaximum size, in bytes, to which an individual Log entry (record) can grow - if the Capabilities array includes a value of 7 ("Variable Length Records Supported"). If the Capabilities array does not include a 7, then the Log only supports fixed length entries. The size of these entries is described by this property.None TRANSLATABLE= true
UnitsstringBytesNone TRANSLATABLE= true
Namestring
DescriptionstringThe inherited Name serves as part of the key (a unique identifier) for the MessageLog instance.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
OverridestringNameNone OVERRIDABLE= false
OtherPolicyDescriptionstring
DescriptionstringWhen the OverwritePolicy specifies a value of 1 ("Other"), the Log's behavior can be explained using this property. If OverwritePolicy is not 1, then this property's contents are undefined.None TRANSLATABLE= true
ModelCorrespondencestringCIM_MessageLog.OverwritePolicyNone None
OverwritePolicyuint16
DescriptionstringAn enumeration describing the behavior of the Log, when it becomes full or near full. For example, the Log may wrap (value=2) or may simply stop recording entries (value=7). Some of the property's possible values need further explanation: 3="Clear When Near Full" indicates that all of the Log's entries will be deleted when a specified record capacity is reached. The capacity is specified in percentage, using the property, PercentageNearFull. 'Near Full' may be less than 100% if the Log takes time to clear, and a position should always be available for new records. 4="Overwrite Outdated When Needed" describes that Log entries (timestamped later than the date/time specified in the property, TimeWhenOutdated) can be overwritten. 5="Remove Outdated Records" specifies that records (timestamped later than the date/time specified in the property, TimeWhenOutdated) are logically and/or physically removed from the Log. 6="Overwrite Specific Records" indicates that specially flagged records may be overwritten. This property only makes sense when the Capabilities array includes a value of 10, "Can Flag Records for Overwrite".None TRANSLATABLE= true
ModelCorrespondencestringCIM_MessageLog.OtherPolicyDescription, CIM_MessageLog.TimeWhenOutdated, CIM_MessageLog.PercentageNearFullNone None
ValuesstringUnknown, Other, Wraps When Full, Clear When Near Full, Overwrite Outdated When Needed, Remove Outdated Records, Overwrite Specific Records, Never OverwriteNone TRANSLATABLE= true
PercentageNearFulluint8
DescriptionstringIf the OverwritePolicy is based on clearing records when the Log is near full (value=3), this property defines the record capacity (in percentage) that is considered to be 'near full'.None TRANSLATABLE= true
ModelCorrespondencestringCIM_MessageLog.OverwritePolicyNone None
UnitsstringPercentNone TRANSLATABLE= true
RecordHeaderFormatstring
DescriptionstringIf the SizeOfRecordHeader property is non-zero, this property describes the structure and format of the record headers. It is a free-form string. If the SizeOfRecordHeader property is 0, then the information in this property is undefined.None TRANSLATABLE= true
RecordLastChangeduint64
DescriptionstringWhen a change is made to the Log, the record number that was modified is captured.None TRANSLATABLE= true
SizeOfHeaderuint64
DescriptionstringThe size of the Log header, in bytes, if one is present. If there is no Log header, then this property should be set to 0. Headers may include general information about the Log such as the current number of records, time of last update, or a pointer to the location of the first Log entry. Note that this property is NOT the size of the header for an individual Log entry. The latter is described by the property, SizeOfRecordHeader.None TRANSLATABLE= true
UnitsstringBytesNone TRANSLATABLE= true
SizeOfRecordHeaderuint64
DescriptionstringThe size of the header for the Log's individual entries, in bytes, if record headers are defined. If there are no record headers, then this property should be set to 0. Record headers may include information such as the type of the Log entry, the date/time that the entry was last updated, or a pointer to the start of optional data. Note that this property defines the header size for individual records in the Log, while the SizeOfHeader property describes the Log's overall header, typically located at the start of the MessageLog.None TRANSLATABLE= true
UnitsstringBytesNone TRANSLATABLE= true
TimeOfLastChangedatetime
DescriptionstringWhen a change is made to the Log, the date/time of that modification is captured. This property could be used to event against any update to the MessageLog.None TRANSLATABLE= true
TimeWhenOutdateddatetime
DescriptionstringIf the OverwritePolicy is based on 'outdated' records (values 4 or 5), this property defines when a Log entry is considered to be outdated - either by time interval or at a specific date and time.None TRANSLATABLE= true
ModelCorrespondencestringCIM_MessageLog.OverwritePolicyNone None

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
DescriptionstringCIM_ManagedElement
InstallDatedatetimeCIM_ManagedSystemElement
StatusstringCIM_ManagedSystemElement