A P P E N D I X  E

IPMI Commands

The ipmi command manages the Intelligent Platform Management Interface (IPMI) functions.

TABLE E-1 lists the ipmi subcommands.



Note - Every subcommand returns a return code upon completion.




TABLE E-1 IPMI Subcommands

Subcommand

Description

ipmi disable channel

Disables one of two IPMI channels.

ipmi enable channel

Enables one of two IPMI channels.

ipmi disable pef

Disables platform-event filtering.

ipmi enable pef

Enables platform-event filtering.

ipmi get channels

Displays the list of IPMI channels and whether they are enabled or disabled.

ipmi get global enables

Displays the list of IPMI global enables and their current value.

ipmi set global enable

Sets the value of several IPMI global enable variables.

ipmi get sel

Displays the system event log (SEL) items in raw format.

ipmi clear sel

Clears the system event log (SEL).

ipmi reset

Resets IPMI information back to default factory settings.



IPMI Disable Channel Subcommand

Description: Allows you to disable one of two IPMI channels.

Format

ipmi disable channel {sms | lan} 

TABLE E-2 lists the arguments for this subcommand.


TABLE E-2 Arguments for Subcommand ipmi disable channel

Argument

Description

sms

The ID of the channel to disable for the system interface; not case-sensitive.

lan

The ID of the channel to disable for the LAN interface; not case-sensitive.


Return Codes

TABLE E-3 lists the arguments for this subcommand.


TABLE E-3 Return Codes for Subcommand ipmi disable channel

Return Code

ID

Description

NWSE_Success

0

Command successfully completed.

NWSE_InvalidUsage

1

Invalid usage: bad parameter usage, conflicting options specified.

NWSE_InvalidArgument

4

One or more arguments were incorrect or invalid.

NWSE_NoPermission

6

Not authorized to perform this operation.



IPMI Enable Channel Subcommand

Description: Allows you to enable one of two IPMI channels.

Format

ipmi enable channel {sms | lan} 

TABLE E-4 lists the arguments for this subcommand.


TABLE E-4 Arguments for Subcommand ipmi enable channel

Argument

Description

sms

The ID of the channel to enable for the system interface; not case-sensitive.

lan

The ID of the channel to enable for the LAN interface; not case-sensitive.

If you are activating the LAN channel for the first time, you are prompted for a password to associate with the null user.


Return Codes

TABLE E-5 lists the return codes for this subcommand


TABLE E-5 Return Codes for Subcommand ipmi enable channel

Return Code

ID

Description

NWSE_Success

0

Command successfully completed.

NWSE_InvalidUsage

1

Invalid usage: bad parameter usage, conflicting options specified.

NWSE_InvalidArgument

4

One or more arguments were incorrect or invalid.

NWSE_NoPermission

6

Not authorized to perform this operation.

NWSE_ServiceNotAvailable

24

Requested service is not available.



IPMI Disable PEF Subcommand

Description: Allows you to disable platform-event filtering (PEF).

Format

ipmi disable pef 

Return Codes

TABLE E-6 lists the return codes for this subcommand.


TABLE E-6 Return Codes for Subcommand ipmi disable pef

Return Code

ID

Description

NWSE_Success

0

Command successfully completed.

NWSE_InvalidUsage

1

Invalid usage: bad parameter usage, conflicting options specified.

NWSE_NoPermission

6

Not authorized to perform this operation.



IPMI Enable PEF Subcommand

Description: Allows you to enable platform-event filtering (PEF).

Format

ipmi enable pef 

Return Codes

TABLE E-7 lists the return codes for this subcommand.


TABLE E-7 Return Codes for Subcommand ipmi enable pef

Return Code

ID

Description

NWSE_Success

0

Command successfully completed.

NWSE_InvalidUsage

1

Invalid usage: bad parameter usage, conflicting options specified.

NWSE_NoPermission

6

Not authorized to perform this operation.

NWSE_ServiceNotAvailable

24

Requested service is not available.



IPMI Get Channels Subcommand

Description: Displays the list of IPMI channels and whether each channel is enabled or disabled.

Format

ipmi get channels 

Return Codes

TABLE E-8 lists the return codes for this subcommand.


TABLE E-8 Return Codes for Subcommand ipmi get channels

Return Code

ID

Description

NWSE_Success

0

Command successfully completed.

NWSE_InvalidUsage

1

Invalid usage: bad parameter usage, conflicting options specified.



IPMI Get Global Enables Subcommand

Description: Displays the list of IPMI global enables and the current value of each enable.

Format

ipmi get global enables 

Return Codes

TABLE E-9 lists the return codes for this subcommand.


TABLE E-9 Return Codes for Subcommand ipmi get global enables

Return Code

ID

Description

NWSE_Success

0

Command successfully completed.

NWSE_InvalidUsage

1

Invalid usage: bad parameter usage, conflicting options specified.



IPMI Get Sel Subcommand

Description: Displays the list of system event log items, in raw format.

Format

ipmi get sel 

The command output returns the following information, in columns from left to right:

Below is an example of successful output for the command. (Because of space limitations here, the Timestamp column, which is the third column from the left, is omitted.)

localhost # ipmi get sel
Record	Record	Generator	Format	Sensor	Sensor	Event	Data
ID	Type	ID	Ver	Type	#	Dir/
0001	0x02	0x0020	0x04	0x10	0xfc	0x6f	02ffff
0002	0x02	0x0000	0x04	0x51	0x06	0x07	08090a
0003	0x02	0x0000	0x04	0x51	0x06	0x07	08090a
0004	0x02	0x0000	0x04	0x51	0x06	0x07	08090a
0005	0x02	0x0020	0x04	0x12	0x27	0x6f	c500ff
0006	0x02	0x0020	0x04	0x12	0x27	0x6f	c580ff
0007	0x02	0x0020	0x04	0x04	0x31	0x01	520121
localhost # ipmi get sel -H
0001	0x02	0x0020	0x04	0x10	0xfc	0x6f	02ffff
0002	0x02	0x0000	0x04	0x51	0x06	0x07	08090a
0003	0x02	0x0000	0x04	0x51	0x06	0x07	08090a
0004	0x02	0x0000	0x04	0x51	0x06	0x07	08090a
0005	0x02	0x0020	0x04	0x12	0x27	0x6f	c500ff
0006	0x02	0x0020	0x04	0x12	0x27	0x6f	c580ff
0007	0x02	0x0020	0x04	0x04	0x31	0x01	520121
localhost # ipmi get sel -H -D ,
0001,0x02,02/28/2005 18:53:17,0x0020,0x04,0x10,0xfc,0x6f,02ffff
0002,0x02,02/28/2005 18:53:17,0x0000,0x04,0x51,0x06,0x07,08090a
0003,0x02,02/28/2005 18:53:17,0x0000,0x04,0x51,0x06,0x07,08090a
0004,0x02,02/28/2005 18:53:17,0x0000,0x04,0x51,0x06,0x07,08090a
0005,0x02,02/28/2005 18:53:17,0x0020,0x04,0x12,0x27,0x6f,c500ff
0006,0x02,06/14/1906 21:02:57,0x0020,0x04,0x12,0x27,0x6f,c580ff
0007,0x02,06/15/1906 00:00:05,0x0020,0x04,0x04,0x31,0x01,520121

TABLE E-10 Arguments for the Subcommand ipmi get sel

Argument

Description

[{-H|--noheader}]

Suppresses column headings

[{-D|--Delim}]

Specifies a different field separator.



TABLE E-11 Return Codes for Subcommand ipmi get sel

Return Code

ID

Description

NWSE_Success

0

Command completed successfully.

NWSE_Busy

9

Device or resource is busy.



IPMI Clear Sel Subcommand

Description: Clears the system event log.

ipmi clear sel

Successful output is:

localhost # ipmi clear sel

TABLE E-12 Return Codes for Subcommand ipmi clear sel

Return Code

ID

Description

NWSE_Success

0

Command completed successfully.

NWSE_Busy

9

Unable to reserve SEL.

NWSE_NotRecognized

20

Request not recognized or understood.

NWSE_DeviceError

25

Unable to access SEL information.



IPMI Set Global Enable Subcommand

Description: Allows you to set the value of several IPMI global-enable variables.

Format

ipmi set global enable {-n |--name} GLOBAL_NAME {{-e|--enabled} |{-d|--disabled}}

TABLE E-13 lists the arguments for this subcommand.

TABLE E-14 provides information about the aliases.


TABLE E-13 Arguments for Subcommand ipmi set global enable

Argument

Description

{-n |--name}

The name of one of the IPMI global enable variables; see TABLE E-14. You can use either a quoted long string or an alias without quotes for the list of global enables.

{-e|--enabled}

Turns the channel on.

{-d|--disabled}

Turns the channel off.



TABLE E-14 IPMI Global-Enabled Aliases

Alias

Name String

Values

Default

oem0

OEM0 Enable

Enabled/Disabled

Disabled

oem1

OEM1 Enable

Enabled/Disabled

Disabled

oem2

OEM 2 Enable

Enabled/Disabled

 

logging

Enable System Event Logging

Enabled/Disabled

Enabled

msg_buf

Enable Event Message Buffer

Enabled/Disabled

 

msg_buf_interrupt

Enable the Event Message Buffer Full

Enabled/Disabled

 

msg_queue_interrupt

Enable Receive Message Queue Interrupt

Enabled/Disabled

Enabled


Return Codes

TABLE E-15 lists the return codes for this subcommand.


TABLE E-15 Return Codes for Subcommand ipmi set global enable

Return Code

ID

Description

NWSE_Success

0

Command successfully completed.

NWSE_InvalidUsage

1

Invalid usage: bad parameter usage, conflicting options specified.

NWSE_InvalidArgument

4

One or more arguments were incorrect or invalid.

NWSE_NoPermission

6

Not authorized to perform this operation.



IPMI Reset Subcommand

Description: Resets IPMI information back to default factory settings.

Format

ipmi reset {-s | --sdrr} {-c | --config} {-p | --password} {-a | --all}

TABLE E-16 lists the arguments for this subcommand.


TABLE E-16 Arguments for Subcommand ipmi reset

Argument

Description

{-s | --sdrr}

Copies the original database file to pstore.

{-c | --config}

Deletes the configuration file and global enables.

{-p | --password}

Deletes the password file.

{-a | --all}

Performs the functions of all the parameters.


Return Codes

TABLE E-17 lists the return codes for this subcommand.


TABLE E-17 Return Codes for Subcommand ipmi reset

Return Code

ID

Description

NWSE_Success

0

Command successfully completed.

NWSE_InvalidUsage

1

Invalid usage: bad parameter usage, conflicting options specified.

NWSE_NoPermission

6

Not authorized to perform this operation.