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 groups of ipmi subcommands.


TABLE E-1 IPMI Subommands Groups

Subcommand

Description

ipmi disable channel

Disables one of two IPMI channels.

ipmi enable channel

Enables one of two IPMI channels.

ipmi get channels

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

ipmi enable pef

Enables platform-event filtering.

ipmi disable pef

Disables platform-event filtering.

ipmi get global enables

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

ipmi set global enable

Enables one of two IPMI channels.

ipmi reset

Resets IPMI information back to default factory settings.




Note - Every command returns a return code upon completion.




IPMI Disable Channel Subcommand

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

Format

Command format:

ipmi disable channel {sms | lan} 

TABLE E-2 lists the arguments for this subcommand.


TABLE E-2 Arguments for Subcommand ipmi disable channel

Arguments

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

Command format:

ipmi enable channel {sms | lan} 

TABLE E-4 lists the arguments for this subcommand.


TABLE E-4 Arguments for Subcommand ipmi enable channel

Arguments

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 Get Channels Subcommand

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

Format

Command format:

ipmi get channels 

Return Codes

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


TABLE E-6 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 Disable PEF Subcommand

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

Format

Command format:

ipmi disable pef 

Return Codes

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


TABLE E-7 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

Command format:

ipmi enable pef 

Return Codes

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


TABLE E-8 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 Global Enables Subcommand

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

Format

Command 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 Set Global Enable Subcommand

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

Format

Command format:

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

TABLE E-10 lists the arguments for this subcommand.

TABLE E-11 provides information about the aliases.


TABLE E-10 Arguments for Subcommand ipmi set global enable

Arguments

Description

{-n |--name}

The name of one of the IPMI global enable variables; see TABLE E-11. 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-11 Information about the 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-12 lists the return codes for this subcommand.


TABLE E-12 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

Command format:

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

TABLE E-13 lists the arguments for this subcommand.


TABLE E-13 Arguments for Subcommand ipmi reset

Arguments

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-14 lists the return codes for this subcommand.


TABLE E-14 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.