Goal

Description

IPMI is a specification for interacting with the platform monitoring, logging, inventory, and control capabilities of an IPMI compliant Service Processor. The 'ipmitool' utility implements IPMI functionality in a simple to use command-line utility, available for Solaris, Windows, and Linux.

Available for this topic, a Video Tutorial; Brief how-to video tutorials that provide step-by-step instructions answering Sun and Oracle's most frequently asked questions. View the video answer and/or follow the detailed instructions below.

Solution

This document describes how to use 'ipmitool' to collect information on platform events, sensors, status LEDs, and hardware components, from the Service Processor (SP). It also covers the use of ipmitool for platform startup & shutdown, and SP reconfiguration.

Where to get ipmitool

The latest Oracle supplied version is available for download from My Oracle Support

To find your download on My Oracle Support::

1. Sign in to My Oracle Support.
2. Click the "Patches & Updates" tab.
3. In the "Patch Search" box on the right side, select "Product or Family (Advanced Search)".
4. Enter a partial product name for "Product is" - a list of matches will be displayed. Select the product of interest.
5. Select one or more "releases" in the "Release is" drop down and close the pop-up window.
6. Click Search - a list of product downloads (listed as patches) will be displayed. Select the download of interest. This will take you to the Download Information Page.

If, on the Download Information Page, you get the message "You do not have permissions to download this Patch...", see How Patches and Updates Entitlement Works to help you determine the reason.

Usage and examples

Some examples of ipmitool commands for performing common tasks are given below. For more detailed usage information, see the ipmitool man page, and documentation included with the package. Not all ipmitool functionality is available across all server platforms,  refer to the service processor documentation for your server if something is not working as expected.

BMC and network interfaces

The command ipmitool can access the Service Processor (SP) of the local host via the in-band (internal) Base Management Controller (BMC) interface. For example, to display the status of the local chassis:

ipmitool -I <interface>  chassis status

Where <interface> is bmc on Solaris systems, open on Linux systems, and ms on Windows 2003Server R2 Enterprise systems. To access the SP via network, specify lan as the interface name, along with the IP address or resolvable hostname of the SP, and valid username (for which you will be prompted to enter the password).

ipmitool -I lan -H <SP IP address>  -U root chassis status

While most of the examples in this document use the lan interface, the commands will also work using the local BMC interface.

Collecting configuration, status and event log information

Useful commands for checking the state and health of a system. Provide output from these commands to Sun Oracle support when raising a service ticket.

• View the System Event Log (SEL):
  ipmitool -I lan -H <SP IP> -U root sel elist
  ipmitool -I lan -H <SP IP> -U root -v sel elist

• Display hardware FRU component information:
  ipmitool -I lan -H <SP IP> -U root fru print

• Display system sensors, status LEDs and chassis information:
  ipmitool -I lan -H <SP IP> -U root sensor list
  ipmitool -I lan -H <SP IP> -U root sunoem led get
  ipmitool -I lan -H <SP IP> -U root sunoem sbled get all
  ipmitool -I lan -H <SP IP> -U root sdr list all info
  ipmitool -I lan -H <SP IP> -U root chassis status
  ipmitool -I lan -H <SP IP> -U root chassis restart_cause

• Display details of active faults present on the system: (not available on some platforms)
  ipmitool -I lan -H <SP IP> -U root sunoem cli "show -o table -level all /SP/faultmgmt"

• Print ILOM / ELOM version:
  ipmitool -I lan -H <SP IP> -U root sunoem cli "version"

Sun Explorer will automatically try to collect ipmitool command output

See <Document: 1002383.1>

ILOM Snapshot automates the collection of ipmitool command outputs and other information from the platform needed by Sun Oracle support to troubleshoot system problems. Where possible, provide an ILOM snapshot when opening a support ticket for server problems.

See <Document: 1020204.1> for more information.

Platform management and control

• Power control:
  ipmitool -I lan -H <SP IP> -U root chassis power on
  ipmitool -I lan -H <SP IP> -U root chassis power off
  ipmitool -I lan -H <SP IP> -U root chassis power reset

• Set boot target for the next system boot:
  ipmitool -I lan -H <SP IP> -U root chassis bootdev bios
  ipmitool -I lan -H <SP IP> -U root chassis bootdev cdrom
  ipmitool -I lan -H <SP IP> -U root chassis bootdev diag
  ipmitool -I lan -H <SP IP> -U root chassis bootdev pxe

• Reset the Service Processor: (does not affect the platform OS)
  ipmitool -I lan -H <SP IP> -U root bmc reset cold

• Send diagnostic NMI:
  ipmitool -I lan -H <SP IP> -U root chassis power diag

Configuring the service processor

• Configure the SP with a static IP address and other network details:
  ipmitool -I <interface> set 1 ipsrc static
  ipmitool -I <interface> set 1 ipaddr 192.168.10.10
  ipmitool -I <interface> set 1 netmask 255.255.255.0
  ipmitool -I <interface> set 1 defgw ipaddr 192.168.10.254

• Where <interface> is bmc on Solaris, open  on Linux systems, and  ms  on Windows 2003 Server R2 Enterprise systems.

• Add a new user named 'randy' to the SP

  • List existing SP users and user ID numbers:
    ipmitool -I lan -H <SP IP> -U root user list
    

    ID Name  Callin  Link Auth   IPMI Msg   Channel Priv Limit
    1        false   false       true       NO ACCESS
    2  root  false   false       true       ADMINISTRATOR
    

  • Add randy's username to the SP, assigning it an unused ID number (3 in this example):
    ipmitool -I lan -H <SP IP> -U root user set name 3 randy

  • Assign the password 'fandango' to randy's user ID:
    ipmitool -I lan -H <SP IP> -U root user set password 3 fandango

  • Enable the account
    ipmitool -I lan -H <SP IP> -U root user enable 3

  • Assign administrator privileges to randy:
    ipmitool -I lan -H <SP IP> -U root channel setaccess 1 3 privilege=4
    (To list all available privileges run: ipmitool channel )

  • The new SP account should now be active.

Unexpected output

Output similar to the following indicates ipmitool was not able to decode data received from the SP:

Sun OEM Get LED command failed: Parameter out of range
Sun OEM Get LED command failed: Destination unavailable

This is often due to the ipmitool command revision or BIOS/SP firmware revision being too old. Update both the platform BIOS/SP firmware and the ipmitool command revision to the latest available then re-run your command.

Additional information

ILOM Snapshot	<Document: 1020204.1>
Ipmitool at sourceforge	http://ipmitool.sourceforge.net

This solution has no attachment