.\"

.\" CDDL HEADER START

.\"

.\" The contents of this file are subject to the terms of the

.\" Common Development and Distribution License (the "License").

.\" You may not use this file except in compliance with the License.

.\"

.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE

.\" or http://www.opensolaris.org/os/licensing.

.\" See the License for the specific language governing permissions

.\" and limitations under the License.

.\"

.\" When distributing Covered Code, include this CDDL HEADER in each

.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.

.\" If applicable, add the following below this CDDL HEADER, with the

.\" fields enclosed by brackets "[]" replaced with your own identifying

.\" information: Portions Copyright [yyyy] [name of copyright owner]

.\"

.\" CDDL HEADER END

.\"

.\"

.TH ipmitool 1m "07 November 2011"

.SH NAME

ipmitool \- utility for controlling IPMI\-enabled devices

.SH "SYNOPSIS"

ipmitool [\-c|\-h|\-d N|\-v|\-V] \-I bmc [-S <sdrcache>] <command>

ipmitool [\-c|\-h|\-v|\-V]

\-I lan \-H <hostname>

         [\-p <port>]

         [\-U <username>]

         [\-A <authtype>]

         [\-L <privlvl>]

         [\-a|\-E|\-P|\-f <password>]

         [\-o <oemtype>]

         [\-O <sel oem>]

         [\-e <esc_char>]

         <command>

ipmitool [\-c|\-h|\-v|\-V]

\-I lanplus \-H <hostname>

         [\-p <port>]

         [\-U <username>]

         [\-L <privlvl>]

         [\-a|\-E|\-P|\-f <password>]

         [\-o <oemtype>]

         [\-O <sel oem>]

         [\-C <ciphersuite>]

         [\-K|\-k <kg_key>]

         [\-y <hex_kg_key>]

         [\-e <esc_char>]

         <command>

.SH DESCRIPTION

This program lets you manage Intelligent Platform Management Interface 

(IPMI) functions of either the local system, via a kernel device driver,

or a remote system, using IPMI v1.5 and IPMI v2.0. These functions include printing 

FRU information, LAN configuration, sensor readings, and remote chassis 

power control.

IPMI management by a remote station is disabled on platforms as they 

are shipped. It can be enabled only by the root user on the local system.

.SH SECURITY WARNING

There are several security issues to be considered before enabling the

IPMI LAN interface. A remote station has the ability to control a system's power 

state as well as being able to gather certain platform information. To reduce 

vulnerability it is strongly advised that the IPMI LAN interface only be 

enabled in 'trusted' environments where system security is not an issue or 

where there is a dedicated secure 'management network'. 

Further it is strongly advised that you should not enable IPMI for

remote access without setting a password, and that that password should

not be the same as any other password on that system.  

When an IPMI password is changed on a remote machine the new password is 

sent across the network as clear text. This could be observed and then 

used to attack the remote system. It is thus recommended that IPMI

password management only be done using a tool, such as 'ipmitool', running

on the local station.

.SH OPTIONS

.TP 

\-a

Prompt for the remote server password.

.TP 

\-A <authtype>

Specify an authentication type to use during IPMIv1.5 lan

session activation.  Supported types are NONE, PASSWORD, MD2, MD5, or OEM.

.TP 

\-c

Present output in CSV (comma separated variable) format.  

This is not available with all commands.

.TP

\-e <sol_escape_char>

Use supplied character for SOL session escape character.  The default

is to use ~ but this can conflict with ssh sessions.

.TP

\-k <key>

Use supplied Kg key for IPMIv2 authentication.  The default is not to

use any Kg key.

.TP

\-y <hex key>

Use supplied Kg key for IPMIv2 authentication. The key is expected in

hexadecimal format and can be used to specify keys with non-printable

characters. E.g. '-k PASSWORD' and '-y 50415353574F5244' are

equivalent.

The default is not to use any Kg key.

.TP 

\-C <ciphersuite>

The remote server authentication, integrity, and encryption algorithms

to use for IPMIv2 lanplus connections.  See table 22\-19 in the

IPMIv2 specification.  The default is 3 which specifies RAKP\-HMAC\-SHA1 

authentication, HMAC\-SHA1\-96 integrity, and AES\-CBC\-128 encryption algorightms.

.TP 

\-E

The remote server password is specified by the environment

variable IPMI_PASSWORD.

.TP 

\-f <password_file>

Specifies a file containing the remote server password. If this

option is absent, or if password_file is empty, the password

will default to NULL.

If the \-f option is not present, ipmitool will prompt the

user for a password. If no password is entered at the prompt,

the remote server password will default to NULL.

For IPMI v1.5, the maximum password length is 16 characters.

Passwords longer than 16 characters will be truncated.

For IPMI v2.0, the maximum password length is 20 characters;

longer passwords are truncated.

The longer password length is supported by the lanplus interface.

.TP 

\-h

Get basic usage help from the command line.

.TP 

\-H <address>

Remote server address, can be IP address or hostname.  This 

option is required for lan and lanplus interfaces.

.TP 

\-I <interface>

Selects IPMI interface to use.  Supported interfaces that are

compiled in are visible in the usage help output.

.TP 

\-L <privlvl>

Force session privilege level.  Can be CALLBACK, USER,

OPERATOR, ADMINISTRATOR. Default is ADMINISTRATOR.

.TP 

\-m <local_address>

Set the local IPMB address.  The default is 0x20 and there

should be no need to change it for normal operation.

.TP 

\-o <oemtype>

Select OEM type to support.  This usually involves minor hacks

in place in the code to work around quirks in various BMCs from

various manufacturers.  Use \-o list to see a list of

current supported OEM types.

.TP 

\-O <sel oem>

Open selected file and read OEM SEL event descriptions to be used

during SEL listings.  See examples in contrib dir for file format.

.TP

\-p <port>

Remote server UDP port to connect to.  Default is 623.

.TP 

\-P <password>

Remote server password is specified on the command line.

If supported it will be obscured in the process list. 

Note! Specifying the password as a command line

option is not recommended.

.TP 

\-S <sdr_cache_file>

Use Sensor Data Repository information from local file 

<sdr_cache_file> for remote SDR cache.  Using a local SDR cache

can drastically increase performance for commands that require

knowledge of the entire SDR to perform their function.  Local

SDR cache from a remote system can be created with the

`sdr dump <sdr_cache_file>` command.

.TP 

\-t <target_address>

Bridge IPMI requests to the remote target address.

.TP 

\-U <username>

Remote server username, default is NULL user.

.TP

\-d N

Use device number N to specify the /dev/ipmiN (or 

/dev/ipmi/N or /dev/ipmidev/N) device to use for in-band 

BMC communication.  Used to target a specific BMC on a 

multi-node, multi-BMC system through the ipmi device 

driver interface.  Default is 0.

.TP 

\-v

Increase verbose output level.  This option may be specified

multiple times to increase the level of debug output.  If given

three times you will get hexdumps of all incoming and

outgoing packets.

.TP 

\-V

Display version information.

.LP 

If no password method is specified then ipmitool will prompt the

user for a password. If no password is entered at the prompt,

the remote server password will default to NULL.

.SH COMMANDS

.TP

help This can be used to get command\-line help  on  ipmitool

commands.  It may also be placed at the end of commands

to get option usage help.

ipmitool help

.br

Commands:

        raw          Send a RAW IPMI request and print

                     response

        i2c          Send an I2C Master Write-Read

                     command and print response

        spd          Print SPD information from remote

                     I2C device

        lan          Configure LAN Channels

        chassis      Get chassis status and set power

                     state

        power        Alias for chassis power commands

        event        Send pre-defined events to MC

        mc           Management Controller status and

                     global enables

        sdr          Print Sensor Data Repository

                     entries and readings

        sensor       Print detailed sensor information

        fru          Print built-in FRU and scan SDR

                     for FRU locators

        sel          Print System Event Log (SEL)

        pef          Configure Platform Event Filtering

                     (PEF)

        sol          Configure IPMIv2.0 Serial\-over\-LAN

        tsol         Configure and connect Tyan

                     IPMIv1.5 Serial\-over\-LAN

        isol         Configure and connect Intel

                     IPMIv1.5 Serial\-over\-LAN

        user         Configure Management Controller

                     users

        channel      Configure Management Controller

                     channels

        sunoem       OEM Commands for Sun servers

        kontronoem   OEM Commands for Kontron

        picmg        Run a PICMG/ATA extended command

        firewall     Configure firmware firewall

        session      Print session information

        exec         Run list of commands from file

        set          Set runtime variable for shell and

                     exec

        echo         Echo lines to stdout in scripts

        ekanalyzer   Run FRU-Ekeying analyzer using FRU

                     files

ipmitool chassis help

.br

Chassis Commands:  status, power, identify, policy, restart_cause, poh, bootdev, bootparam, selftest

ipmitool chassis power help

.br

chassis power Commands: status, on, off, cycle, reset, diag, soft

.TP

bmc|mc

.RS

.TP

reset <warm|cold>

.br

Instructs the BMC to perform a warm or cold reset.

.TP

info

.br

Displays information about the BMC hardware, including device revision,

firmware revision, IPMI version supported, manufacturer ID,

and information on additional device support.

.TP 

watchdog

.br 

These commands allow a user to view and change the current 

state of the watchdog timer.

.RS

.TP 

get

.br

Show current Watchdog Timer settings and countdown state.

.TP 

reset

.br

Reset the Watchdog Timer to its most recent state and restart the 

countdown timer.

.TP 

off

.br

Turn off a currently running Watchdog countdown timer.

.RE

.TP 

selftest

.br 

Check on the basic health of the BMC by executing the Get Self Test

results command and reporting the results.

.TP

getenables

.br

Displays a list of the currently enabled options for the BMC.

.br

.TP

setenables <option>=[on|off]

.br

Enables or disables the given \fIoption\fR.  Currently supported

values for \fIoption\fR include:

.RS

.TP

recv_msg_intr

.br

Receive Message Queue Interrupt

.TP

event_msg_intr

.br

Event Message Buffer Full Interrupt

.TP

event_msg

.br

Event Message Buffer

.TP

system_event_log

.br

System Event Logging

.TP

oem0

.br

OEM-Defined option #0

.TP

oem1

.br

OEM-Defined option #1

.TP

oem2

.br

OEM-Defined option #2

.RE

.RE

.TP

channel

.RS

.TP

authcap <channel number> <max priv>

Displays  information  about  the

authentication capabilities of the selected channel

at the specified privilege level.

.RS

.TP

Possible privilege levels are:

.br

1   Callback level

.br

2   User level

.br

3   Operator level

.br

4   Administrator level

.br

5   OEM Proprietary level

.RE

.TP

info [channel number]

Displays  information  about  the

selected  channel.  If no channel is given it will

display information about the currently used channel:

.RS

.PP

ipmitool \-I bmc channel info

.br

Channel 0xf info:

.br

  Channel Medium Type   : System Interface

.br

  Channel Protocol Type : KCS

.br

  Session Support       : session\-less

.br

  Active Session Count  : 0

.br

  Protocol Vendor ID    : 7154

.RE

.TP

getaccess <channel number> [userid]

.br

Configure the given userid as the default on the given channel number.

When the given channel is subsequently used, the user is identified

implicitly by the given userid.

.TP

setaccess <channel number> <userid> [callin=on|off]

 [ipmi=on|off] [link=on|off] [privilege=level]

.br

Configure user access information on the given channel for the given userid.

.TP

getciphers <all | supported> <ipmi | sol> [channel]

.br

Displays the list of cipher suites supported for the given

application (ipmi or sol) on the given channel.

.RE

.TP

chassis

.RS

.TP

status

.br

Displays information regarding the high-level

status of the system chassis and main power

subsystem.

.TP

poh

.br

This  command  will  return  the  Power\-On Hours counter.

.TP

identify <interval>

Control the front panel identify  light.   Default interval

is 15 seconds.  Use 0 to turn off.  Use "force" to turn on 

indefinitely.

.TP

restart_cause

.br

Query the chassis for the cause of the last system restart.

.TP 

selftest

.br 

Check on the basic health of the BMC by executing the Get Self Test

results command and reporting the results.

.TP

policy

.br

Set the chassis power policy in  the  event  power failure.

.RS

.TP

list

.br

Return supported policies.

.TP

always\-on

.br

Turn on when power is restored.

.TP

previous

.br

Returned to  previous  state  when  power  is restored.

.TP

always\-off

.br

Stay off after power is restored.

.RE

.TP

power

.br

Performs a chassis control  command  to  view  and

change the power state.

.RS

.TP

status

.br

Show current chassis power status.

.TP

on

.br

Power up chassis.

.TP

off

.br

Power  down  chassis  into  soft  off  (S4/S5

state).   WARNING: This command does not initiate a clean 

shutdown of the operating  system prior to powering down the system.

.TP

cycle

.br

Provides a power off interval of

at least 1 second.  No action should occur if

chassis power is in S4/S5 state,  but  it  is

recommended  to  check  power state first and