Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

RecordLog class

Represents the system event log (SEL) of a Baseboard Management Controller (BMC). Each BMC has one associated RecordLog instance.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties and methods are in alphabetic order, not MOF order.

Syntax

[Provider("IPMIPrv"), Dynamic]class RecordLog : CIM_RecordLog
{
  string   Caption;
  string   Description;
  string   ElementName;
  datetime InstallDate;
  string   Name;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  uint16   EnabledState;
  string   OtherEnabledState;
  uint16   RequestedState;
  uint16   EnabledDefault;
  datetime TimeOfLastStateChange;
  uint64   CurrentNumberOfRecords;
  uint64   MaxNumberOfRecords;
  string   InstanceId;
};

Members

The RecordLog class has these types of members:

Methods

The RecordLog class has these methods.

MethodDescription
ClearLog

Clears the log of all entries.

This method is inherited from CIM_Log.

RequestStateChange

Initiates a request to change the state of the event log.

This method is inherited from CIM_EnabledLogicalElement.

 

Properties

The RecordLog class has these properties.

Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64) , Dynamic

A short description of the event log.

Fixed value: "IPMI SEL". This property is inherited from CIM_ManagedElement.

CurrentNumberOfRecords
Data type: uint64
Access type: Read-only

The current number of records in the log. This property is inherited from CIM_Log.

Description
Data type: string
Access type: Read-only

A description of the event log.

Fixed value: "IPMI SEL". This property is inherited from CIM_ManagedElement.

ElementName
Data type: string
Access type: Read-only

The user-friendly name of the event log.

Fixed value: "IPMI SEL". This property is inherited from CIM_ManagedElement.

EnabledDefault
Data type: uint16
Access type: Write-only

Indicates the default startup configuration for the EnabledState property.

Default value: "2". This property is inherited from CIM_EnabledLogicalElement.

This property contains one of the following values:

ValueMeaning
2

Enabled

3

Disabled

5

Not Applicable

6

Enabled but Offline

7

No Default

8

Quiesce

9–32767

DMTF Reserved

32768–65535

Vendor Reserved

 

EnabledState
Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence (CIM_EnabledLogicalElement.OtherEnabledState)

Indicates whether the event log is enabled or in another related state.

Default value: "5" (not applicable). This property is inherited from CIM_EnabledLogicalElement.

This property contains one of the following values:

ValueMeaning
0

Unknown

1

Other

2

Enabled

3

Disabled

4

Shutting Down

5

Not Applicable

6

Enabled but Offline

7

In Test

8

Deferred

9

Quiesce

10

Starting

11–32767

DMTF Reserved

32768–65535

Vendor Reserved

 

HealthState
Data type: uint16
Access type: Read-only
Qualifiers: Experimental

Indicates the current health of the event log.

This property is inherited from CIM_ManagedSystemElement.

This property contains one of the following values:

ValueMeaning
0

Unknown

5

OK

10

Degraded/Warning

15

Minor failure

20

Major failure

25

Critical failure

30

Non-recoverable error

31–32767

DMTF Reserved

32768–65535

Vendor Specific

 

InstallDate
Data type: datetime
Access type: Read-only
Qualifiers: MappingStrings (MIF.DMTF|ComponentID|001.5)

The datetime value that indicates when the event log was installed.

This property is inherited from CIM_ManagedSystemElement.

InstanceId
Data type: string
Access type: Read/write
Qualifiers: Key, Dynamic

String that identifies the computer system instance with which the RecordLog instance is associated. If there are several BMCs in the same namespace, unique names must be used.

To create the string, concatenate the following items without spaces.

  • "IPMI"
  • ComputerSystem.Name key property of associated BMC.
  • "SEL Log"
For example, if the BMC Name is BMC32, then InstanceId contains "IPMIBMC32SEL Log".

This property is inherited from CIM_RecordLog.

MaxNumberOfRecords
Data type: uint64
Access type: Read-only

The maximum number of records that can be captured in the log. This property is inherited from CIM_Log.

Name
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (1024)

The label of the event log. This property value can contain the same value as the UserID property.

This property is inherited from CIM_ManagedSystemElement.

OperationalStatus
Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType (Indexed) , ModelCorrespondence (CIM_ManagedSystemElement.StatusDescriptions)

An array that contains the operational status of the event log.

This property is inherited from CIM_ManagedSystemElement.

This property can contain the following values:

ValueMeaning
0

Unknown

1

Other

2

OK

3

Degraded

4

Stressed

5

Predictive Failure

6

Error

7

Non-Recoverable Error

8

Starting

9

Stopping

10

Stopped

11

In Service

12

No Contact

13

Lost Communication

14

Aborted

15

Dormant

16

Supporting Entity in Error

17

Completed

18

Power Mode

19

DMTF Reserved

20

Vendor Reserved

 

OtherEnabledState
Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence (CIM_EnabledLogicalElement.EnabledState)

Describes the value of the EnabledState property when EnabledState is set to "1" (other).

This property is inherited from CIM_EnabledLogicalElement.

RequestedState
Data type: uint16
Access type: Read-only

Indicates the last requested state of the event log. The actual state of the event log is represented by the EnabledState property.

Default value: "12".

This property is inherited from CIM_EnabledLogicalElement.

This property contains one of the following values:

ValueMeaning
2

Enabled

3

Disabled

4

Shut Down

5

No Change

6

Offline

7

Test

8

Deferred

9

Quiesce

10

Reboot

11

Reset

12

Not Applicable

13–32767

DMTF Reserved

32768–65535

Vendor Reserved

 

Status
Data type: string
Access type: Read-only
Qualifiers: MaxLen (10) , Deprecated (CIM_ManagedSystemElement.OperationalStatus)

Note  This property is deprecated. Instead, use OperationalStatus.

The status of the event log.

This property is inherited from CIM_ManagedSystemElement.

This property contains one of the following values:

ValueMeaning
OK

The event log is functioning without errors.

Error

The event log experienced an error.

Degraded

The event log is functioning but some features are turned off.

Unknown

The status of the event log is unknown.

Pred Fail

The event log experienced a predictive failure.

Starting

The event log is being started.

Stopping

The event log is being shut down.

Service

The event log is being serviced.

Stressed

The event log is having performance issues.

NonRecover

The event log has an error and cannot recover.

No Contact

There is no contact with the event log.

Lost Comm

Communication with the event log has been lost.

Stopped

The event log is not running, however, it might be possible to restart the event log.

 

StatusDescriptions
Data type: string array
Access type: Read-only
Qualifiers: ArrayType (Indexed) , ModelCorrespondence (CIM_ManagedSystemElement.OperationalStatus)

An array of strings that describe the details of the corresponding array values in the OperationalStatus property.

This property is inherited from CIM_ManagedSystemElement.

TimeOfLastStateChange
Data type: datetime
Access type: Read-only

The datetime of the last change to the value of the EnabledState property.

This property is inherited from CIM_EnabledLogicalElement.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2003 R2

Namespace

\root\hardware

MOF

IpmiPrv.mof

DLL

IpmiPrv.dll

See also

IPMI Provider

 

 

Show:
© 2014 Microsoft