Class CIM_MessageLog
extends CIM_EnabledLogicalElement

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_EnabledLogicalElement
   |
   +--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
Versionstring2.7.0TOSUBCLASS= falseTRANSLATABLE= true

Local Class Properties

NameData TypeQualifiers
NameData TypeValueScopeFlavors
Captionstring
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.None TRANSLATABLE= true
MaxLenuint3264None None
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
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11None None
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
Descriptionstring
DescriptionstringThe Description property provides a textual description of the object.None TRANSLATABLE= true
ElementNamestring
DescriptionstringA user-friendly name for the object. This property allows each instance to define a user-friendly name IN ADDITION TO its key properties/identity data, and description information. Note that ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties.None TRANSLATABLE= true
EnabledDefaultuint16
DescriptionstringAn enumerated value indicating an administrator's default/startup configuration for an element's Enabled State. By default, the element is "Enabled" (value=2).None TRANSLATABLE= true
ValueMapstring2, 3, 5, 6, 7, 8..32767, 32768..65535None None
ValuesstringEnabled, Disabled, Not Applicable, Enabled but Offline, No Default, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
WritebooleantrueNone None
EnabledStateuint16
DescriptionstringEnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states: Enabled (2) indicates that the element is/could be executing commands, will process any queued commands, and queues new requests. Disabled (3) indicates that the element will not execute commands and will drop any new requests. Shutting Down (4) indicates that the element is in the process of going to a Disabled state. Not Applicable (5) indicates the element doesn't support being enabled/disabled. Enabled but Offline (6) indicates that the element may be completing commands, and will drop any new requests. Test (7) indicates that the element is in a test state. Deferred (8) indicates that the element may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes a restricted set of commands. All other requests are queued. Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.None TRANSLATABLE= true
ModelCorrespondencestringCIM_EnabledLogicalElement.OtherEnabledStateNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11..32767, 32768..65535None None
ValuesstringUnknown, Other, Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
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
InstallDatedatetime
DescriptionstringA datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.None TRANSLATABLE= true
MappingStringsstringMIF.DMTF|ComponentID|001.5None None
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
ValueMapstring0, 1, 2, 3, 4None None
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
OtherEnabledStatestring
DescriptionstringA string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1.None TRANSLATABLE= true
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledStateNone None
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
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7None 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
RequestedStateuint16
DescriptionstringRequestedState is an integer enumeration indicating the last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration. It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are "Reboot" (10) and "Reset" (11). The former, Reboot, refers to doing a "Shut Down" and then moving to an "Enabled" state. The latter, Reset, indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. The former, Shut Down, requests an orderly transition to the Disabled state, and MAY involve removing power, to completely erase any existing state. The latter, the Disabled state, requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code.None TRANSLATABLE= true
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledStateNone None
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, 10, 11, .., 32768..65535None None
ValuesstringEnabled, Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot, Reset, DMTF Reserved, Vendor ReservedNone 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
Statusstring
DeprecatedstringCIM_ManagedSystemElement.OperationalStatusTOSUBCLASS= falseNone
DescriptionstringA string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the Deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus.None TRANSLATABLE= true
MaxLenuint3210None None
ValueMapstringOK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, NonRecover, No Contact, Lost Comm, StoppedNone None
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
TimeOfLastStateChangedatetime
DescriptionstringThe date/time when the element's EnabledState last changed. If the state of the element has not changed and this property is populated, then it MUST be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property MUST NOT be updated.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
Capabilitiesuint16[]
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringAn 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.None TRANSLATABLE= true
ModelCorrespondencestringCIM_MessageLog.CapabilitiesDescriptionsNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10None None
ValuesstringUnknown, 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 OverwriteNone TRANSLATABLE= true
CapabilitiesDescriptionsstring[]
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringAn 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.None TRANSLATABLE= true
ModelCorrespondencestringCIM_MessageLog.CapabilitiesNone None
OperationalStatusuint16[]
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringIndicates the current status(es) of the element. Various health and operational statuses are defined. Many of the enumeration's values are self- explanatory. However, a few are not and are described in more detail. "Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, etc. "Predictive Failure" indicates that an element is functioning nominally but predicting a failure in the near future. "In Service" describes an element being configured, maintained, cleaned, or otherwise administered. "No Contact" indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. "Lost Communication" indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. "Stopped" and "Aborted" are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the element's state and configuration may need to be updated. "Dormant" indicates that the element is inactive or quiesced. "Supporting Entity in Error" describes that this element may be "OK" but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower layer networking problems. "Completed" indicates the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error. "Power Mode" indicates the element has additional power model information contained in the Associated PowerManagementService association. OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today's environment to the future. This change was not made earlier since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/instrumentation provide BOTH the Status and OperationalStatus properties. Further, the first value of OperationalStatus SHOULD contain the primary status for the element. When instrumented, Status (since it is single-valued) SHOULD also provide the primary status of the element.None TRANSLATABLE= true
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptionsNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, .., 0x8000..None None
ValuesstringUnknown, Other, OK, Degraded, Stressed, Predictive Failure, Error, Non-Recoverable Error, Starting, Stopping, Stopped, In Service, No Contact, Lost Communication, Aborted, Dormant, Supporting Entity in Error, Completed, Power Mode, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
StatusDescriptionsstring[]
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringStrings describing the various OperationalStatus array values. For example, if "Stopping" is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus.None TRANSLATABLE= true
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatusNone None