Class CIM_MessageLog
CIM_ManagedElement
CIM_ManagedSystemElement
CIM_LogicalElement
CIM_EnabledLogicalElement
CIM_Log
CIM_MessageLog
- Known Subclasses:
- AMT_MessageLog
class CIM_MessageLog
- extends CIM_Log
General Information:
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.
Qualifiers:
-------------
Version=2.14.0
UMLPackagePath=CIM::System::Logs
Supported Fields
Summary |
uint16
|
LogState LogState is
an integer enumeration that indicates the current state of a log
represented by CIM_Log subclasses . . .
|
uint64
|
CurrentNumberOfRecords
Current number of records in the Log.
|
uint64
|
MaxNumberOfRecords
Maximum number of records that can be captured in the Log . .
.
|
string
|
ElementName A
user-friendly name for the object . . .
|
string
|
Description The
Description property provides a textual description of the object.
|
string
|
Caption The Caption
property is a short textual description (one- line string) of the
object.
|
datetime
|
InstallDate A
datetime value that indicates when the object was installed . . .
|
uint16[]
|
OperationalStatus
Indicates the current statuses of the element . . .
|
string[]
|
StatusDescriptions
Strings describing the various OperationalStatus array values .
. .
|
string
|
Status A string
indicating the current status of the object . . .
|
uint16
|
HealthState
Indicates the current health of the element . . .
|
uint16
|
EnabledState
EnabledState is an integer enumeration that indicates the
enabled and disabled states of an element . . .
|
string
|
OtherEnabledState
A string that describes the enabled or disabled state of the
element when the EnabledState property is set to 1 ("Other") . . .
|
uint16
|
RequestedState
RequestedState is an integer enumeration that indicates the
last requested or desired state for the element, irrespective of the
mechanism through which it was requested . . .
|
uint16
|
EnabledDefault
An enumerated value indicating an administrator's default or
startup configuration for the Enabled State of an element . . .
|
datetime
|
TimeOfLastStateChange The
date or time when the EnabledState of the element last changed . .
.
|
string
|
CreationClassName CreationClassName indicates the name
of the class or the subclass used in the creation of an instance . .
.
|
string
|
Name The inherited Name serves as part of the key (a
unique identifier) for the MessageLog instance.
|
uint16[]
|
Capabilities An
array of integers indicating the Log capabilities . . .
|
string[]
|
CapabilitiesDescriptions
An array of free-form strings providing more detailed
explanations for any of the Log features indicated in the Capabilities
array . . .
|
uint64
|
MaxLogSize The
maximum size, in bytes, to which the Log can grow . . .
|
uint64
|
SizeOfHeader The
size of the Log header, in bytes, if one is present . . .
|
string
|
HeaderFormat If
the SizeOfHeader property is non-zero, this property describes the
structure and format of the Log header . . .
|
uint64
|
MaxRecordSize
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") . . .
|
uint64
|
SizeOfRecordHeader
The size of the header for the Log's individual entries, in
bytes, if record headers are defined . . .
|
string
|
RecordHeaderFormat
If the SizeOfRecordHeader property is non-zero, this property
describes the structure and format of the record headers . . .
|
uint16
|
OverwritePolicy
An enumeration describing the behavior of the Log, when it
becomes full or near full . . .
|
string
|
OtherPolicyDescription
When the OverwritePolicy specifies a value of 1 ("Other"), the
Log's behavior can be explained using this property . . .
|
datetime
|
TimeWhenOutdated
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.
|
uint8
|
PercentageNearFull
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'.
|
uint16
|
LastChange An
enumeration describing the last change to the MessageLog.
|
datetime
|
TimeOfLastChange
When a change is made to the Log, the date/time of that
modification is captured . . .
|
uint64
|
RecordLastChanged
When a change is made to the Log, the record number that was
modified is captured.
|
boolean
|
IsFrozen Boolean
indicating that the Log is currently frozen and modifications are not
allowed.
|
uint16
|
CharacterSet An
enumeration describing the character set used to record data in the
individual Log entries . . .
|
Methods Summary |
uint32 |
ClearLog() Requests
that the Log be cleared of all entries . . .
|
uint32 |
RequestStateChange(RequestedState, REF
Job, TimeoutPeriod) Requests that the state of the element be
changed to the value specified in the RequestedState parameter . .
.
|
uint32 |
PositionToFirstRecord(IterationIdentifier)
Requests that an iteration of the MessageLog be established and that
the iterator be set to the first entry in the Log . . .
|
uint32 |
PositionAtRecord(IterationIdentifier,
MoveAbsolute, RecordNumber) Requests that the Log's iteration
identifier be advanced or retreated a specific number of records, or set
to the entry at a specified numeric location . . .
|
uint32 |
GetRecord(IterationIdentifier,
PositionToNext, RecordNumber, RecordData) Requests that the
record indicated by the IterationIdentifier be retrieved from the
MessageLog . . .
|
uint32 |
DeleteRecord(IterationIdentifier,
PositionToNext, RecordNumber, RecordData) Requests that the
record indicated by the IterationIdentifier be deleted from the MessageLog
. . .
|
uint32 |
WriteRecord(IterationIdentifier,
PositionToNext, RecordData, RecordNumber) Requests that a
record be inserted at the Log position indicated by the
IterationIdentifier . . .
|
uint32 |
CancelIteration(IterationIdentifier)
Requests that an iteration of the Log, identified by the
IterationIdentifier input parameter, be stopped . . .
|
uint32 |
FreezeLog(Freeze)
Requests that the MessageLog be placed in a frozen state ("Freeze"
input parameter = TRUE) or 'unfrozen' (= FALSE) . . .
|
uint32 |
FlagRecordForOverwrite(IterationIdentifier,
PositionToNext, RecordNumber) Requests that the record
indicated by the IterationIdentifier be flagged as overwriteable . .
.
|
|
Create(Instance,
ResourceCreated) Creates a new instance of this class
|
|
Put(Instance) Changes
properties of the selected instance
|
|
Get(Instance) Gets the
representation of the instance
|
|
Delete() Deletes an
instance
|
|
Pull(EnumerationContext,
MaxElements) Pulls instances of this class, following an
Enumerate operation
|
|
Enumerate()
Enumerates the instances of this class
|
|
Release(EnumerationContext)
Releases an enumeration context
|
|
Subscribe()
Subscribes to this resource (WS-Eventing)
|
|
Unsubscribe()
Remove subscription to this resource
(WS-Eventing)
|
LogState
public uint16 LogState
- General Information:
LogState 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.
Qualifiers:
-------------
ValueMap={0, 2, 3, 4, ..,
32768..65535}
Values={Unknown, Normal, Erasing, Not Applicable, DMTF
Reserved, Vendor
Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.EnabledState}
CurrentNumberOfRecords
public uint64 CurrentNumberOfRecords
- General Information:
Current number of records in the
Log.
Qualifiers:
-------------
Gauge
MaxNumberOfRecords
public uint64 MaxNumberOfRecords
- General Information:
Maximum number of records that can be
captured in the Log. If undefined, a value of zero should be specified.
ElementName
public string ElementName
- General Information:
A 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
the Name property of ManagedSystemElement 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 can be present in both the Name and
ElementName properties. Note that if there is an associated instance of
CIM_EnabledLogicalElementCapabilities, restrictions on this properties may
exist as defined in ElementNameMask and MaxElementNameLen properties defined
in that
class.
Qualifiers:
-------------
MaxLen=256
Description
public string Description
- General Information:
The Description property provides a textual
description of the
object.
Qualifiers:
-------------
MaxLen=256
Caption
public string Caption
- General Information:
The Caption property is a short textual
description (one- line string) of the
object.
Qualifiers:
-------------
MaxLen=64
InstallDate
public datetime InstallDate
- General Information:
A datetime value that indicates when the
object was installed. Lack of a value does not indicate that the object is not
installed.
Qualifiers:
-------------
MappingStrings={MIF.DMTF|ComponentID|001.5}
OperationalStatus
public uint16[] OperationalStatus
- General Information:
Indicates the current statuses of the
element. Various operational statuses are defined. Many of the enumeration's
values are self-explanatory. However, a few are not and are described here in
more detail.
"Stressed" indicates that the element is functioning, but
needs attention. Examples of "Stressed" states are overload, overheated, and
so on.
"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 state and configuration of the element might need to be
updated.
"Dormant" indicates that the element is inactive or quiesced.
"Supporting Entity in Error" indicates that this element might 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 that the element has completed its
operation. This value should be combined with either OK, Error, or Degraded so
that a client can tell if the complete operation Completed with OK (passed),
Completed with Error (failed), or Completed with Degraded (the operation
finished, but it did not complete OK or did not report an error).
"Power
Mode" indicates that the element has additional power model information
contained in the Associated PowerManagementService association.
"Relocating" indicates the element is being
relocated.
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
because it required the deprecated qualifier. Due to the widespread use of the
existing Status property in management applications, it is strongly
recommended that providers or 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
(because it is single-valued) should also provide the primary status of the
element.
Qualifiers:
-------------
ValueMap={0, 1, 2, 3,
4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, ..,
0x8000..}
Values={Unknown, 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, Relocating, DMTF Reserved, Vendor
Reserved}
ArrayType=Indexed
ModelCorrespondence={CIM_ManagedSystemElement.StatusDescriptions}
StatusDescriptions
public string[] StatusDescriptions
- General Information:
Strings 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.
Qualifiers:
-------------
ArrayType=Indexed
ModelCorrespondence={CIM_ManagedSystemElement.OperationalStatus}
MaxLen=256
Status
public string Status
- General Information:
A 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 definition overcomes the
limitation of describing status using a single value, when it is really a
multi-valued property (for example, an element might be OK AND Stopped.
2)
A MaxLen of 10 is too restrictive and leads to unclear enumerated values.
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.
Qualifiers:
-------------
Deprecated={CIM_ManagedSystemElement.OperationalStatus}
ValueMap={OK,
Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed,
NonRecover, No Contact, Lost Comm, Stopped}
MaxLen=10
HealthState
public uint16 HealthState
- General Information:
Indicates the current health of the
element. This attribute expresses the health of this element but not
necessarily that of its subcomponents. The possible values are 0 to 30, where
5 means the element is entirely healthy and 30 means the element is completely
non-functional. The following continuum is defined:
"Non-recoverable
Error" (30) - The element has completely failed, and recovery is not possible.
All functionality provided by this element has been lost.
"Critical
Failure" (25) - The element is non-functional and recovery might not be
possible.
"Major Failure" (20) - The element is failing. It is possible
that some or all of the functionality of this component is degraded or not
working.
"Minor Failure" (15) - All functionality is available but some
might be degraded.
"Degraded/Warning" (10) - The element is in working
order and all functionality is provided. However, the element is not working
to the best of its abilities. For example, the element might not be operating
at optimal performance or it might be reporting recoverable errors.
"OK"
(5) - The element is fully functional and is operating within normal
operational parameters and without error.
"Unknown" (0) - The
implementation cannot report on HealthState at this time.
DMTF has
reserved the unused portion of the continuum for additional HealthStates in
the future.
Qualifiers:
-------------
ValueMap={0, 5, 10,
15, 20, 25, 30, .., 32768..65535}
Values={Unknown, OK, Degraded/Warning,
Minor failure, Major failure, Critical failure, Non-recoverable error, DMTF
Reserved, Vendor Specific}
EnabledState
public uint16 EnabledState
- General Information:
EnabledState is an integer enumeration that
indicates the enabled and 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 and
disabled states:
Enabled (2) indicates that the element is or 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 does not support being enabled or disabled.
Enabled but Offline
(6) indicates that the element might 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 might be completing commands, but
will queue any new requests.
Quiesce (9) indicates that the element is
enabled but in a restricted mode.
Starting (10) indicates that the element
is in the process of going to an Enabled state. New requests are
queued.
Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4,
5, 6, 7, 8, 9, 10, 11..32767, 32768..65535}
Values={Unknown, Other,
Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In
Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor
Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.OtherEnabledState}
OtherEnabledState
public string OtherEnabledState
- General Information:
A string that describes the enabled or
disabled state of the element when the EnabledState property is set to 1
("Other"). This property must be set to null when EnabledState is any value
other than
1.
Qualifiers:
-------------
ModelCorrespondence={CIM_EnabledLogicalElement.EnabledState}
MaxLen=256
RequestedState
public uint16 RequestedState
- General Information:
RequestedState is an integer enumeration
that indicates the last requested or desired state for the element,
irrespective of the mechanism through which it was requested. The actual state
of the element is represented by EnabledState. This property is provided to
compare the last requested and current enabled or disabled states. Note that
when EnabledState is set to 5 ("Not Applicable"), then this property has no
meaning. Refer to the EnabledState property description for explanations of
the values in the RequestedState enumeration.
"Unknown" (0) indicates the
last requested state for the element is unknown.
Note that the value "No
Change" (5) has been deprecated in lieu of indicating the last requested state
is "Unknown" (0). If the last requested or desired state is unknown,
RequestedState should have the value "Unknown" (0), but may have the value "No
Change" (5).Offline (6) indicates that the element has been requested to
transition to the Enabled but Offline EnabledState.
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). Reboot refers to doing
a "Shut Down" and then moving to an "Enabled" state. Reset indicates that the
element is first "Disabled" and then "Enabled". The distinction between
requesting "Shut Down" and "Disabled" should also be noted. Shut Down requests
an orderly transition to the Disabled state, and might involve removing power,
to completely erase any existing state. 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 can be overridden and defined as WRITEable in a subclass. The method
approach is considered superior to a WRITEable property, because it allows an
explicit invocation of the operation and the return of a result code.
If knowledge of the last RequestedState is not supported for the
EnabledLogicalElement, the property shall be NULL or have the value 12 "Not
Applicable".
Qualifiers:
-------------
ValueMap={0, 2, 3,
4, 5, 6, 7, 8, 9, 10, 11, 12, .., 32768..65535}
Values={Unknown, Enabled,
Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot,
Reset, Not Applicable, DMTF Reserved, Vendor
Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.EnabledState}
EnabledDefault
public uint16 EnabledDefault
- General Information:
An enumerated value indicating an
administrator's default or startup configuration for the Enabled State of an
element. By default, the element is "Enabled"
(value=2).
Qualifiers:
-------------
Write
ValueMap={2,
3, 5, 6, 7, 9, .., 32768..65535}
Values={Enabled, Disabled, Not Applicable,
Enabled but Offline, No Default, Quiesce, DMTF Reserved, Vendor
Reserved}
TimeOfLastStateChange
public datetime TimeOfLastStateChange
- General Information:
The date or time when the EnabledState of
the element 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.
CreationClassName
public string CreationClassName
- General Information:
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.
Qualifiers:
-------------
Key
MaxLen=256
Name
public string Name
- General Information:
The inherited Name serves as part of the
key (a unique identifier) for the MessageLog
instance.
Qualifiers:
-------------
Key
Override=Name
MaxLen=256
Capabilities
public uint16[] Capabilities
- General Information:
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.
Qualifiers:
-------------
ValueMap={0, 1, 2, 3,
4, 5, 6, 7, 8, 9, 10}
Values={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}
ArrayType=Indexed
ModelCorrespondence={CIM_MessageLog.CapabilitiesDescriptions}
CapabilitiesDescriptions
public string[] CapabilitiesDescriptions
- General Information:
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.
Qualifiers:
-------------
ArrayType=Indexed
ModelCorrespondence={CIM_MessageLog.Capabilities}
MaxLen=256
MaxLogSize
public uint64 MaxLogSize
- General Information:
The maximum size, in bytes, to which the
Log can grow. If there is no maximum, then MaxLogSize should be set to
0.
Qualifiers:
-------------
Units=Bytes
SizeOfHeader
public uint64 SizeOfHeader
- General Information:
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.
Qualifiers:
-------------
Units=Bytes
HeaderFormat
public string HeaderFormat
- General Information:
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.
Qualifiers:
-------------
MaxLen=256
MaxRecordSize
public uint64 MaxRecordSize
- General Information:
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.
Qualifiers:
-------------
Units=Bytes
SizeOfRecordHeader
public uint64 SizeOfRecordHeader
- General Information:
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.
Qualifiers:
-------------
Units=Bytes
RecordHeaderFormat
public string RecordHeaderFormat
- General Information:
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.
Qualifiers:
-------------
MaxLen=256
OverwritePolicy
public uint16 OverwritePolicy
- General Information:
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".
Qualifiers:
-------------
Override=OverwritePolicy
ValueMap={0,
1, 2, 3, 4, 5, 6, 7}
Values={Unknown, Other, Wraps When Full, Clear When
Near Full, Overwrite Outdated When Needed, Remove Outdated Records, Overwrite
Specific Records, Never
Overwrite}
ModelCorrespondence={CIM_MessageLog.OtherPolicyDescription,
CIM_MessageLog.TimeWhenOutdated, CIM_MessageLog.PercentageNearFull}
OtherPolicyDescription
public string OtherPolicyDescription
- General Information:
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.
Qualifiers:
-------------
ModelCorrespondence={CIM_MessageLog.OverwritePolicy}
MaxLen=256
TimeWhenOutdated
public datetime TimeWhenOutdated
- General Information:
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.
Qualifiers:
-------------
ModelCorrespondence={CIM_MessageLog.OverwritePolicy}
PercentageNearFull
public uint8 PercentageNearFull
- General Information:
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'.
Qualifiers:
-------------
Units=Percent
ModelCorrespondence={CIM_MessageLog.OverwritePolicy}
LastChange
public uint16 LastChange
- General Information:
An enumeration describing the last change
to the MessageLog.
Qualifiers:
-------------
ValueMap={0,
1, 2, 3, 4}
Values={Unknown, Add, Delete, Modify, Log Cleared}
TimeOfLastChange
public datetime TimeOfLastChange
- General Information:
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.
RecordLastChanged
public uint64 RecordLastChanged
- General Information:
When a change is made to the Log, the
record number that was modified is captured.
IsFrozen
public boolean IsFrozen
- General Information:
Boolean indicating that the Log is
currently frozen and modifications are not allowed.
CharacterSet
public uint16 CharacterSet
- General Information:
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).
Qualifiers:
-------------
ValueMap={0, 1, 2,
3, 4, 5, 6, 7, 8, 9, 10, 11}
Values={Unknown, Other, ASCII, Unicode,
ISO2022, ISO8859, Extended UNIX Code, UTF-8, UCS-2, Bitmapped Data,
OctetString, Defined by Individual Records}
ClearLog
public uint32 ClearLog()
- Permission Information:
No permissions defined
General
Information:
Requests 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.
Qualifiers:
-------------
ValueMap={0, 1, 2, 3,
4, 5, 6..0x0FFF, 0x1000..0x7FFF, 0x8000..}
Values={Completed with no error,
Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter,
DMTF_Reserved, Method_Reserved, Vendor_Reserved}
RequestStateChange
public uint32 RequestStateChange([IN]uint16 RequestedState, [OUT]REF CIM_ConcreteJob Job, [IN]datetime TimeoutPeriod)
- Permission Information:
No permissions defined
General
Information:
Requests that the state of the element be changed to the
value specified in the RequestedState parameter. When the requested state
change takes place, the EnabledState and RequestedState of the element will be
the same. Invoking the RequestStateChange method multiple times could result
in earlier requests being overwritten or lost.
A return code of 0 shall
indicate the state change was successfully initiated.
A return code of 3
shall indicate that the state transition cannot complete within the interval
specified by the TimeoutPeriod parameter.
A return code of 4096 (0x1000)
shall indicate the state change was successfully initiated, a ConcreteJob has
been created, and its reference returned in the output parameter Job. Any
other return code indicates an error
condition.
Qualifiers:
-------------
ValueMap={0, 1, 2, 3,
4, 5, 6, .., 4096, 4097, 4098, 4099, 4100..32767,
32768..65535}
Values={Completed with No Error, Not Supported, Unknown or
Unspecified Error, Cannot complete within Timeout Period, Failed, Invalid
Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started,
Invalid State Transition, Use of Timeout Parameter Not Supported, Busy, Method
Reserved, Vendor
Specific}
ModelCorrespondence={CIM_EnabledLogicalElement.RequestedState}
Parameters:
--------------
- RequestedState
- General Information:
The state requested for the element. This
information will be placed into the RequestedState property of the instance
if the return code of the RequestStateChange method is 0 ('Completed with No
Error'), or 4096 (0x1000) ('Job Started'). Refer to the description of the
EnabledState and RequestedState properties for the detailed explanations of
the RequestedState
values.
Qualifiers:
-------------
IN
ValueMap={2, 3,
4, 6, 7, 8, 9, 10, 11, .., 32768..65535}
Values={Enabled, Disabled, Shut
Down, Offline, Test, Defer, Quiesce, Reboot, Reset, DMTF Reserved, Vendor
Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.RequestedState}
- Job
- General Information:
May contain a reference to the
ConcreteJob created to track the state transition initiated by the method
invocation.
Qualifiers:
-------------
IN=false
OUT
- TimeoutPeriod
- General Information:
A timeout period that specifies the
maximum amount of time that the client expects the transition to the new
state to take. The interval format must be used to specify the
TimeoutPeriod. A value of 0 or a null parameter indicates that the client
has no time requirements for the transition.
If this property does not
contain 0 or null and the implementation does not support this parameter, a
return code of 'Use Of Timeout Parameter Not Supported' shall be
returned.
Qualifiers:
-------------
IN
PositionToFirstRecord
public uint32 PositionToFirstRecord([OUT]string IterationIdentifier)
- Permission Information:
No permissions defined
General
Information:
Requests that an iteration of the MessageLog be
established and that the iterator be set to the first entry in the Log. An
identifier for the iterator is returned as an output parameter of the method.
Regarding iteration, you have 2 choices: 1) Embed iteration data in
the method call, and allow implementations to track/ store this data manually;
or, 2) Iterate using a separate object (for example, class ActiveIterator) as
an iteration agent. The first approach is used here for interoperability. The
second requires an instance of the Iterator object for EACH iteration in
progress. 2's functionality could be implemented underneath 1.
The
return value from PositionToFirstRecord should be 0 if the request was
successfully executed, 1 if the request is not supported and some other value
if an error occurred. In a subclass, the set of possible return codes could be
specified, using a ValueMap qualifier on the method. The strings to which the
ValueMap contents are 'translated' may also be specified in the subclass as a
Values array qualifier.
Parameters:
--------------
- IterationIdentifier
- General Information:
An identifier for the
iterator.
Qualifiers:
-------------
IN=false
OUT
PositionAtRecord
public uint32 PositionAtRecord([IN][OUT]string IterationIdentifier, [IN]boolean MoveAbsolute, [IN][OUT]sint64 RecordNumber)
- Permission Information:
No permissions defined
General
Information:
Requests that the Log's iteration identifier be advanced
or retreated a specific number of records, or set to the entry at a specified
numeric location. These two different behaviors are accomplished using the
input parameters of the method. Advancing or retreating is achieved by setting
the MoveAbsolute boolean to FALSE, and then specifying the number of entries
to advance or retreat as positive or negative values in the RecordNumber
parameter. Moving to a specific record number is accomplished by setting the
MoveAbsolute input parameter to TRUE, and then placing the record number into
the RecordNumber parameter. This can only be done if the Capabilities array
includes a value of 7, "Supports Addressing by Ordinal Record Number".
After the method completes and if ordinal record numbers are supported
(the Capabilities array includes a 7), the current record number is returned
in the RecordNumber output parameter. Otherwise, the value of the parameter is
undefined.
IterationIdentifier is defined as an Input/Output method
parameter to allow the Log to embed state information in the Identifier and
potentially let the identifier be maintained by the using application.
The return value from PositionAtRecord should be 0 if the request was
successfully executed, 1 if the request is not supported and some other value
if an error occurred. If the request is not supported, check the Capabilities
array regarding support for ordinal record number addressing and backward
movement in the Log (values 7 and 4, respectively).
Note: In a
subclass, the set of possible return codes could be described using a ValueMap
qualifier on the method. The strings to which the ValueMap contents are
'translated' may also be specified in the subclass as a Values array
qualifier.
Product Specific Usage:
Additional Notes:
1)
The argument 'RecordNumber' of the 'PositionAtRecord' method is of type
'sint32' in Intel AMT Release 3.2 and earlier
releases.
Parameters:
--------------
- IterationIdentifier
- General Information:
An identifier for the
iterator.
Qualifiers:
-------------
IN
OUT
- MoveAbsolute
- General Information:
Advancing or retreating the
IterationIdentifier is achieved by setting the MoveAbsolute boolean to
FALSE, and specifying the number of entries to advance or retreat as
positive or negative values in the RecordNumber parameter. Moving to a
specific record number is accomplished by setting the MoveAbsolute parameter
to TRUE, and placing the record number into the RecordNumber
parameter.
Qualifiers:
-------------
IN
- RecordNumber
- General Information:
The relative or absolute record
number.
Qualifiers:
-------------
IN
OUT
GetRecord
public uint32 GetRecord([IN][OUT]string IterationIdentifier, [IN]boolean PositionToNext, [OUT]uint64 RecordNumber, [OUT]uint8 RecordData[])
- Permission Information:
No permissions defined
General
Information:
Requests that the record indicated by the
IterationIdentifier be retrieved from the MessageLog. After retrieval, the
IterationIdentifier may be advanced to the next record by setting the
PositionToNext input parameter to TRUE. Two output parameters are defined for
the method - RecordData which holds the contents of the Log entry (as an array
of bytes that can be recast to an appropriate format), and RecordNumber which
returns the current record number addressed via the Iteration Identifier. The
RecordNumber parameter is only defined/valid when the Capabilities array
indicates that ordinal record number addressing is supported (a value of 7).
IterationIdentifier is defined as an Input/Output method parameter to
allow the Log to embed state information in the Identifier and potentially let
the identifier be maintained by the using application.
The return
value from GetRecord should be 0 if the request was successfully executed, 1
if the request is not supported, and some other value if an error occurred. In
a subclass, the set of possible return codes could be specified, using a
ValueMap qualifier on the method. The strings to which the ValueMap contents
are 'translated' may also be specified in the subclass as a Values array
qualifier.
Parameters:
--------------
- IterationIdentifier
- General Information:
An identifier for the
iterator.
Qualifiers:
-------------
IN
OUT
- PositionToNext
- General Information:
Boolean indicating that the Iteration
Identifier should be advanced to the next record, after retrieving the
current Log entry.
Qualifiers:
-------------
IN
- RecordNumber
- General Information:
The record
number.
Qualifiers:
-------------
IN=false
OUT
- RecordData
- General Information:
The record
data.
Qualifiers:
-------------
IN=false
OUT
DeleteRecord
public uint32 DeleteRecord([IN][OUT]string IterationIdentifier, [IN]boolean PositionToNext, [OUT]uint64 RecordNumber, [OUT]uint8 RecordData[])
- Permission Information:
No permissions defined
General
Information:
Requests that the record indicated by the
IterationIdentifier be deleted from the MessageLog. After deletion, the
Iteration Identifier may be advanced to the next record by setting the
PositionToNext input parameter to TRUE. If set to FALSE, then the
IterationIdentifier will be positioned at the previous record. Two output
parameters are defined for the method - RecordData which holds the contents of
the deleted Log entry (as an array of bytes that can be recast to an
appropriate format or discarded), and RecordNumber which returns the current
record number addressed via the IterationIdentifier. The RecordNumber
parameter is only defined/valid when the Capabilities array indicates that
ordinal record number addressing is supported (a value of 7).
IterationIdentifier is defined as an Input/Output method parameter to
allow the Log to embed state information in the Identifier and potentially let
the identifier be maintained by the using application.
The return
value from DeleteRecord should be 0 if the request was successfully executed,
1 if the request is not supported, and some other value if an error occurred.
If the request is not supported, check the Capabilities array that a value of
3 ("Delete Record Supported") is specified.
Note: In a subclass, the
set of possible return codes could be described using a ValueMap qualifier on
the method. The strings to which the ValueMap contents are 'translated' may
also be specified in the subclass as a Values array
qualifier.
Parameters:
--------------
- IterationIdentifier
- General Information:
An identifier for the
iterator.
Qualifiers:
-------------
IN
OUT
- PositionToNext
- General Information:
Boolean that when set to TRUE requests
the IterationIdentifier to be advanced to the next record, after the current
entry is deleted. If set to FALSE, IterationIdentifier is set to the
previous record.
Qualifiers:
-------------
IN
- RecordNumber
- General Information:
The record
number.
Qualifiers:
-------------
IN=false
OUT
- RecordData
- General Information:
The record
data.
Qualifiers:
-------------
IN=false
OUT
WriteRecord
public uint32 WriteRecord([IN][OUT]string IterationIdentifier, [IN]boolean PositionToNext, [IN]uint8 RecordData[], [OUT]uint64 RecordNumber)
- Permission Information:
No permissions defined
General
Information:
Requests that a record be inserted at the Log position
indicated by the IterationIdentifier. The entry's data is provided in the
RecordData input parameter. After insertion, the IterationIdentifier may be
advanced to the next record by setting the PositionToNext input parameter to
TRUE. The output parameter, RecordNumber, returns the current record number
addressed via the IterationIdentifier. This parameter is only defined/valid
when the Capabilities array indicates that ordinal record number addressing is
supported (a value of 7).
IterationIdentifier is defined as an
Input/Output method parameter to allow the Log to embed state information in
the Identifier and potentially let the identifier be maintained by the using
application.
The return value from WriteRecord should be 0 if the
request was successfully executed, 1 if the request is not supported, and some
other value if an error occurred. If the request is not supported, check the
Capabilities array that a value of 2 ("Write Record Supported") is specified.
Note: In a subclass, the set of possible return codes could be
described using a ValueMap qualifier on the method. The strings to which the
ValueMap contents are 'translated' may also be specified in the subclass as a
Values array qualifier.
Parameters:
--------------
- IterationIdentifier
- General Information:
An identifier for the
iterator.
Qualifiers:
-------------
IN
OUT
- PositionToNext
- General Information:
Boolean indicating that the Iteration
Identifier should be advanced to the next record, after writing the Log
entry.
Qualifiers:
-------------
IN
- RecordData
- General Information:
The record
data.
Qualifiers:
-------------
IN
- RecordNumber
- General Information:
The record
number.
Qualifiers:
-------------
IN=false
OUT
CancelIteration
public uint32 CancelIteration([IN]string IterationIdentifier)
- Permission Information:
No permissions defined
General
Information:
Requests that an iteration of the Log, identified by the
IterationIdentifier input parameter, be stopped. The return value from
CancelIteration should be 0 if the request was successfully executed, 1 if the
request is not supported and some other value if an error occurred. In a
subclass, the set of possible return codes could be specified, using a
ValueMap qualifier on the method. The strings to which the ValueMap contents
are 'translated' may also be specified in the subclass as a Values array
qualifier.
Parameters:
--------------
- IterationIdentifier
- General Information:
An identifier for the
iterator.
Qualifiers:
-------------
IN
FreezeLog
public uint32 FreezeLog([IN]boolean Freeze)
- Permission Information:
No permissions defined
General
Information:
Requests that the MessageLog be placed in a frozen state
("Freeze" input parameter = TRUE) or 'unfrozen' (= FALSE). If frozen,
modifications to the Log will not be allowed. If successful, the Log's
IsFrozen boolean property will be updated to reflect the desired state.
The method's return code should be 0 if the request was successfully
executed, 1 if the request is not supported and some other value if an error
occurred. If the request is not supported, check the Capabilities array that a
value of 5 ("Freeze Log Supported") is specified.
Note: In a subclass,
the set of possible return codes could be described using a ValueMap qualifier
on the method. The strings to which the ValueMap contents are 'translated' may
also be specified in the subclass as a Values array
qualifier.
Parameters:
--------------
- Freeze
- General Information:
If TRUE then freeze the log, if FALSE
'unfreeze' the
log.
Qualifiers:
-------------
IN
FlagRecordForOverwrite
public uint32 FlagRecordForOverwrite([IN][OUT]string IterationIdentifier, [IN]boolean PositionToNext, [OUT]uint64 RecordNumber)
- Permission Information:
No permissions defined
General
Information:
Requests that the record indicated by the
IterationIdentifier be flagged as overwriteable. This method is only supported
when the Capabilities array includes a value of 10, "Can Flag Records for
Overwrite". After updating the entry, the IterationIdentifier may be advanced
to the next record by setting the PositionToNext input parameter to TRUE. One
output parameter is defined for the method RecordNumber. It returns the
current record number addressed via the Iteration Identifier. This parameter
is only defined/valid when the Capabilities array indicates that ordinal
record number addressing is supported (a value of 7).
IterationIdentifier is defined as an Input/Output method parameter to
allow the Log to embed state information in the Identifier and potentially let
the identifier be maintained by the using application.
The return
value from FlagRecordForOverwrite should be 0 if the request was successfully
executed, 1 if the request is not supported, and some other value if an error
occurred. In a subclass, the set of possible return codes could be specified,
using a ValueMap qualifier on the method. The strings to which the ValueMap
contents are 'translated' may also be specified in the subclass as a Values
array qualifier.
Parameters:
--------------
- IterationIdentifier
- General Information:
An identifier for the
iterator.
Qualifiers:
-------------
IN
OUT
- PositionToNext
- General Information:
Boolean indicating that the Iteration
Identifier should be advanced to the next record, after updating the current
Log entry.
Qualifiers:
-------------
IN
- RecordNumber
- General Information:
The record
number.
Qualifiers:
-------------
IN=false
OUT
Create
public Create([IN]CIM_MessageLog Instance, [OUT] REF CIM_MessageLog ResourceCreated)
- Permission Information:
No permissions defined
General
Information:
Creates a new instance of this class
Product
Specific Usage:
The following properties must be included in any
representation of CIM_MessageLog:
CreationClassName
Name
Put
public Put([IN]CIM_MessageLog Instance)
- Permission Information:
No permissions defined
General
Information:
Changes properties of the selected
instance
Product Specific Usage:
The following properties
must be included in any representation of CIM_MessageLog:
CreationClassName
Name
Get
public Get([OUT]CIM_MessageLog Instance)
- Permission Information:
No permissions defined
General
Information:
Gets the representation of the instance
Delete
public Delete()
- Permission Information:
No permissions defined
General
Information:
Deletes an instance
Pull
public Pull([IN]String EnumerationContext, [IN]String MaxElements)
- Permission Information:
All users permitted to use method, only
instances to whom the user has permissions will be returned
General
Information:
Pulls instances of this class, following an Enumerate
operation
Enumerate
public Enumerate()
- Permission Information:
All users permitted to use
method
General Information:
Enumerates the instances of this
class
Release
public Release([IN]String EnumerationContext)
- Permission Information:
All users permitted to use
method
General Information:
Releases an enumeration
context
Subscribe
public Subscribe()
- Permission Information:
No permissions defined
General
Information:
Subscribes to this resource (WS-Eventing)
Unsubscribe
public Unsubscribe()
- Permission Information:
No permissions defined
General
Information:
Remove subscription to this resource
(WS-Eventing)