Class CIM_Log
extends CIM_EnabledLogicalElement

Log represents any type of event, error or informational register or chronicle. The object describes the existence of the log and its characteristics. Log does not dictate the form of the data represented or how records/messages are stored in the log and/or accessed. Subclasses will define the appropriate methods and behavior.

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

Direct Known Subclasses

CIM_MessageLog
CIM_RecordLog

Class Qualifiers

NameData TypeValue
Abstractbooleantrue
DescriptionstringLog represents any type of event, error or informational register or chronicle. The object describes the existence of the log and its characteristics. Log does not dictate the form of the data represented or how records/messages are stored in the log and/or accessed. Subclasses will define the appropriate methods and behavior.
UMLPackagePathstringCIM::System::Logs
Versionstring2.28.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
CurrentNumberOfRecordsuint64
DescriptionstringCurrent number of records in the Log.
Gaugebooleantrue
LogStateuint164
DescriptionstringLogState is an integer enumeration that indicates the current state of a log represented by CIM_Log subclasses. LogState is to be used in conjunction with the EnabledState property to fully describe the current state of the log. The following text briefly summarizes the various log states: Unknown (0) indicates the state of the log is unknown. Normal (2) indicates that the log is or could be executing logging commands, will process any queued log entries, and will queue new logging requests. Erasing (3) indicates that the log is being erased. Not Applicable (4) indicates the log does not support representing a log state.
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledState
ValueMapstring0, 2, 3, 4, .., 32768..65535
ValuesstringUnknown, Normal, Erasing, Not Applicable, DMTF Reserved, Vendor Reserved
MaxNumberOfRecordsuint64
DescriptionstringMaximum number of records that can be captured in the Log. If undefined, a value of zero should be specified.
OverwritePolicyuint160
DescriptionstringOverwritePolicy is an integer enumeration that indicates whether the log, represented by the CIM_Log subclasses, can overwrite its entries.Unknown (0) indicates the log's overwrite policy is unknown. Wraps when Full (2) indicates that the log overwrites its entries with new entries when the log has reached its maximum capacity. Never Overwrites (7) indicates that the log never overwrites its entries by the new entries. Archives (8) indicates that the logging is never interupted, and the log archives old entries using an algorithm such as reaching a specific threshold on number of entries to archive a specific number of old ones to free space for new entries. The archived entries may not be readily retreived through the enumeration of log entries.
ValueMapstring0, 2, 7, 8, .., 32768..65535
ValuesstringUnknown, Wraps When Full, Never Overwrites, Archives, DMTF Reserved, Vendor Reserved

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
NamestringCIM_ManagedSystemElement
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StatusstringCIM_ManagedSystemElement
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

ClearLog (uint32)

Method Qualifiers (ClearLog)

NameData TypeValue
DescriptionstringRequests that the Log be cleared of all entries. The return value should be 0 if the request was successfully executed, 1 if the request is not supported, and some other value, as indicated by the ValueMap/Values qualifiers, if an error occurred.
ValueMapstring0, 1, 2, 3, 4, 5, 6..0x0FFF, 0x1000..0x7FFF, 0x8000..
ValuesstringCompleted with no error, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF_Reserved, Method_Reserved, Vendor_Reserved

Method Parameters (ClearLog)

NameTypeQualifiers
NameData TypeValue

Inherited Class Methods

NameReturn TypeClass Origin
RequestStateChangeuint32CIM_EnabledLogicalElement