Class CIM_RecordLog
Used in features: Event Manager & User
Notification
Compatible with the following Intel AMT Releases: 3.0,
3.2, 4.0, 5.0, 5.1, 6.0, 6.1, 6.2, 7.0, 8.0, 8.1, 9.0, 9.5, 10.0, 11.0
CIM_ManagedElement
CIM_ManagedSystemElement
CIM_LogicalElement
CIM_EnabledLogicalElement
CIM_Log
CIM_RecordLog
- Known Subclasses:
- IPS_ProvisioningRecordLog
class CIM_RecordLog
- extends CIM_Log
General Information:
RecordLog serves as an aggregation point for
LogRecord objects. This class presents a higher level view of a log than its
peer class MessageLog (which uses iterators) and introduces a new key structure.
Access to records in this log is achieved through the use of the standard CIM
Operations defined as part of WBEM.
Product Specific
Usage:
Additional Notes:
In releases up to Intel AMT Release 6.1,
there is one instance of CIM_RecordLog in the system, for the event log.
From Intel AMT Release 6.1, there is an additional instance of CIM_RecordLog
in the system for the provisioning record log.
The instances differ in their
permissions and supported methods and properties. See description of every
method or property for
details.
Qualifiers:
-------------
Version=2.19.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 . . .
|
uint16
|
OverwritePolicy
OverwritePolicy 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 . .
.
|
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
|
Name The Name property
defines the label by which the object is known . . .
|
uint16[]
|
OperationalStatus
Indicates the current statuses of the element . . .
|
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 . . .
|
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 . . .
|
string
|
InstanceID Within the scope of the instantiating Namespace,
InstanceID opaquely and uniquely identifies an instance of this class . .
.
|
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 . .
.
|
|
Get(Instance) Gets the
representation of the 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
|
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.
Product Specific Usage:
Additional Notes:
1) Event
log instance: this property is not supported
2) Provisioning record
instance: this property is set to "not applicable"
Qualifiers:
-------------
ValueMap={0, 2, 3, 4, ..,
32768..65535}
Values={Unknown, Normal, Erasing, Not Applicable, DMTF
Reserved, Vendor
Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.EnabledState}
OverwritePolicy
public uint16 OverwritePolicy
- General Information:
OverwritePolicy 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.
Product Specific Usage:
Additional Notes:
1)
Event log instance: this property is not supported
2) Provisioning record
instance: this property is set to "wrap when full"
Qualifiers:
-------------
ValueMap={0, 2, 7, ..,
32768..65535}
Values={Unknown, Wraps When Full, Never Overwrites, DMTF
Reserved, Vendor Reserved}
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.
Product Specific Usage:
Additional Notes:
1) Event log instance: this property is not supported
2) Provisioning
record instance: this property is set to "Intel(r) AMT Provisioning Record
Log"
Qualifiers:
-------------
MaxLen=64
Name
public string Name
- General Information:
The Name property defines the label by
which the object is known. When subclassed, the Name property can be
overridden to be a Key property.
Product Specific
Usage:
Additional Notes:
1) Event log instance: In Intel AMT
Release 6.0 and later releases value is "Intel(r) AMT Event Log"
2)
Provisioning record instance: value is "Intel(r) AMT Provisioning Record Log"
Qualifiers:
-------------
MaxLen=40
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}
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.
Product Specific Usage:
Additional Notes:
1)
Event log instance: possible values are "enabled" or "disabled"
2)
Provisioning record instance: value is always set to
"enabled"
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}
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}
InstanceID
public string InstanceID
- General Information:
Within the scope of the instantiating
Namespace, InstanceID opaquely and uniquely identifies an instance of this
class.
In order to ensure uniqueness within the NameSpace, the value of
InstanceID SHOULD be constructed using the following 'preferred' algorithm:
<OrgID>:<LocalID>
Where <OrgID> and <LocalID>
are separated by a colon ':', and where <OrgID> MUST include a
copyrighted, trademarked or otherwise unique name that is owned by the
business entity creating/defining the InstanceID, or is a registered ID that
is assigned to the business entity by a recognized global authority (This is
similar to the <Schema Name>_<Class Name> structure of Schema
class names.) In addition, to ensure uniqueness <OrgID> MUST NOT contain
a colon (':'). When using this algorithm, the first colon to appear in
InstanceID MUST appear between <OrgID> and <LocalID>.
<LocalID> is chosen by the business entity and SHOULD not be re-used
to identify different underlying (real-world) elements. If the above
'preferred' algorithm is not used, the defining entity MUST assure that the
resultant InstanceID is not re-used across any InstanceIDs produced by this or
other providers for this instance's NameSpace.
For DMTF defined instances,
the 'preferred' algorithm MUST be used with the <OrgID> set to
'CIM'.
Product Specific Usage:
Additional Notes:
1) Event
log instance: In Intel AMT Release 6.0 and later releases value is "Intel(r)
AMT:RecordLog 0"
2) Provisioning Record instance: value is "Intel(r)
AMT:RecordLog
1"
Qualifiers:
-------------
Key
Override=InstanceID
MaxLen=64
ClearLog
public uint32 ClearLog()
- Permission Information:
Permitted realms:
ADMIN_SECURITY_EVENT_MANAGER_REALM
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.
Product Specific
Usage:
Additional Notes:
1) Event log instance:
Since vendor
reserved values start at 0x8000, any error status values will be biased by
0x8000. The document Intel AMT WS-Management Flows lists the possible Intel
AMT error status values in the section Function Return Values and Errors.
The method is permitted only to 'ADMIN_SECURITY_EVENT_LOG_MANAGER_REALM'
2) Provisioning record instance:
This method is not supported - always
returns Not supported (1)
The method is permitted only to
'ADMIN_SECURITY_ADMINISTRATION_REALM', 'ADMIN_SECURITY_LOCAL_SYSTEM_REALM'
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:
Permitted realms:
ADMIN_SECURITY_EVENT_MANAGER_REALM
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.
Product Specific
Usage:
Additional Note:
1) Event log instance:
This method is
used in order to freeze/unfreeze the log.
The supported return values are
Enabled (2) and Disabled (3).
AMT doesn't support the TimeoutPeriod
parameter (only value 0 is valid).
The method is permitted only to
'ADMIN_SECURITY_EVENT_LOG_MANAGER_REALM'
2) Provisioning record instance:
This method is not supported - always returns Not supported (1)
The
method is permitted only to 'ADMIN_SECURITY_ADMINISTRATION_REALM',
'ADMIN_SECURITY_LOCAL_SYSTEM_REALM'
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
Get
public Get([OUT]CIM_RecordLog Instance)
- Permission Information:
Permitted realms:
ADMIN_SECURITY_EVENT_LOG_READER_REALM,
ADMIN_SECURITY_EVENT_MANAGER_REALM
General Information:
Gets
the representation of the instance
Product Specific
Usage:
Additional Note:
1) Event log instance:
The method is
permitted only to 'ADMIN_SECURITY_EVENT_LOG_MANAGER_REALM' and
'ADMIN_SECURITY_EVENT_LOG_READER_REALM'
2) Provisioning record instance:
The method is permitted only to 'ADMIN_SECURITY_ADMINISTRATION_REALM',
'ADMIN_SECURITY_LOCAL_SYSTEM_REALM', ADMIN_SECURITY_LOCAL_APPS_REALM' and
'ADMIN_SECURITY_GENERAL_INFO_REALM'
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