# Class CIM_MessageLog
extends CIM_Log

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. This type of log uses iterators to access the log records, whereas its peer class, RecordLog, uses more abstracted access mechanisms.

### Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_ManagedSystemElement
|
+--CIM_LogicalElement
|
+--CIM_EnabledLogicalElement
|
+--CIM_Log
|
+--CIM_MessageLog

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | 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. This type of log uses iterators to access the log records, whereas its peer class, RecordLog, uses more abstracted access mechanisms.
UMLPackagePath | string | CIM::System::Logs
Version | string | 2.14.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
CharacterSet | uint16 |
Description | string | An 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).
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
Values | string | Unknown, Other, ASCII, Unicode, ISO2022, ISO8859, Extended UNIX Code, UTF-8, UCS-2, Bitmapped Data, OctetString, Defined by Individual Records
CreationClassName | string |
Description | string | CreationClassName 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.
Key | boolean | true
MaxLen | uint32 | 256
HeaderFormat | string |
Description | string | If 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.
IsFrozen | boolean |
Description | string | Boolean indicating that the Log is currently frozen and modifications are not allowed.
LastChange | uint16 |
Description | string | An enumeration describing the last change to the MessageLog.
ValueMap | string | 0, 1, 2, 3, 4
Values | string | Unknown, Add, Delete, Modify, Log Cleared
MaxLogSize | uint64 |
Description | string | The maximum size, in bytes, to which the Log can grow. If there is no maximum, then MaxLogSize should be set to 0.
PUnit | string | byte
Units | string | Bytes
MaxRecordSize | uint64 |
Description | string | Maximum 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.
PUnit | string | byte
Units | string | Bytes
Name | string |
Description | string | The inherited Name serves as part of the key (a unique identifier) for the MessageLog instance.
Key | boolean | true
MaxLen | uint32 | 256
Override | string | Name
OtherPolicyDescription | string |
Description | string | When 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.
ModelCorrespondence | string | CIM_MessageLog.OverwritePolicy
OverwritePolicy | uint16 |
Description | string | An 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".
ModelCorrespondence | string | CIM_MessageLog.OtherPolicyDescription, CIM_MessageLog.TimeWhenOutdated, CIM_MessageLog.PercentageNearFull
Override | string | OverwritePolicy
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7
Values | string | Unknown, Other, Wraps When Full, Clear When Near Full, Overwrite Outdated When Needed, Remove Outdated Records, Overwrite Specific Records, Never Overwrite
PercentageNearFull | uint8 |
Description | string | If 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'.
ModelCorrespondence | string | CIM_MessageLog.OverwritePolicy
PUnit | string | percent
Units | string | Percent
RecordHeaderFormat | string |
Description | string | If 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.
RecordLastChanged | uint64 |
Description | string | When a change is made to the Log, the record number that was modified is captured.
SizeOfHeader | uint64 |
Description | string | The 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.
PUnit | string | byte
Units | string | Bytes
SizeOfRecordHeader | uint64 |
Description | string | The 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.
PUnit | string | byte
Units | string | Bytes
TimeOfLastChange | datetime |
Description | string | When 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.
TimeWhenOutdated | datetime |
Description | string | If 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.
ModelCorrespondence | string | CIM_MessageLog.OverwritePolicy
Capabilities | uint16[] |
ArrayType | string | Indexed
Description | string | An array of integers indicating the Log capabilities. Information such as "Write Record Supported" (value= 2) or "Variable Length Records Supported" (8) is specified in this property.
ModelCorrespondence | string | CIM_MessageLog.CapabilitiesDescriptions
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
Values | string | Unknown, Other, Write Record Supported, Delete Record Supported, Can Move Backward in Log, Freeze Log Supported, Clear Log Supported, Supports Addressing by Ordinal Record Number, Variable Length Records Supported, Variable Formats for Records, Can Flag Records for Overwrite
CapabilitiesDescriptions | string[] |
ArrayType | string | Indexed
Description | string | An array of free-form strings providing more detailed explanations for any of the Log features indicated in the Capabilities array. Note, each entry of this array is related to the entry in the Capabilities array that is located at the same index.
ModelCorrespondence | string | CIM_MessageLog.Capabilities

### Inherited Properties

Name | Data Type
--- | ---
Caption | string
CommunicationStatus | uint16
CurrentNumberOfRecords | uint64
Description | string
DetailedStatus | uint16
ElementName | string
EnabledDefault | uint16
EnabledState | uint16
Generation | uint64
HealthState | uint16
InstallDate | datetime
InstanceID | string
LogState | uint16
MaxNumberOfRecords | uint64
OperatingStatus | uint16
OtherEnabledState | string
PrimaryStatus | uint16
RequestedState | uint16
Status | string
TimeOfLastStateChange | datetime
TransitioningToState | uint16
AvailableRequestedStates | uint16[]
OperationalStatus | uint16[]
StatusDescriptions | string[]

## Class Methods

### Inherited Class Methods

Name | Return Type
--- | ---
ClearLog | uint32
RequestStateChange | uint32