man ipmitool Command

Man page for apt-get ipmitool Command

Man Page for ipmitool in Linux

Ubuntu Man Command : man ipmitool

Man Ipmitool  Command

This tutorial shows the man page for man ipmitool in linux.

Open terminal with 'su' access and type the command as shown below:
man ipmitool

Result of the Command Execution shown below:

ipmitool(1)                                                                                                                                              ipmitool(1)

ipmitool utility for controlling IPMI enabled devices

ipmitool [ c| h| d N| v| V] I open <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>]

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>]

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 con Äê

IPMI management of a local system interface requires a compatible IPMI kernel driver to be installed and configured. On Linux this driver is called OpenIPMI
and it is included in standard distributions. On Solaris this driver is called BMC and is included in Solaris 10. Management of a remote station requires
the IPMI over LAN interface to be enabled and configured. Depending on the particular requirements of each system it may be possible to enable the LAN
interface using ipmitool over the system interface.

a Prompt for the remote server password.

A <authtype>
Specify an authentication type to use during IPMIv1.5 lan session activation. Supported types are NONE, PASSWORD, MD2, MD5, or OEM.

c Present output in CSV (comma separated variable) format. This is not available with all commands.

e <sol_escape_char>
Use supplied character for SOL session escape character. The default is to use ~ but this can conflict with ssh sessions.

k <key>
Use supplied Kg key for IPMIv2 authentication. The default is not to use any Kg key.

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 charac Äê
ters. E.g. ' k PASSWORD' and ' y 50415353574F5244' are equivalent. The default is not to use any Kg key.

C <ciphersuite>
The remote server authentication, integrity, and encryption algorithms to use for IPMIv2 lanplus connections. See table 22 19 in the IPMIv2 specifi Äê
cation. The default is 3 which specifies RAKP HMAC SHA1 authentication, HMAC SHA1 96 integrity, and AES CBC 128 encryption algorightms.

E The remote server password is specified by the environment variable IPMI_PASSWORD.

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.

h Get basic usage help from the command line.

H <address>
Remote server address, can be IP address or hostname. This option is required for lan and lanplus interfaces.

I <interface>
Selects IPMI interface to use. Supported interfaces that are compiled in are visible in the usage help output.

L <privlvl>
Force session privilege level. Can be CALLBACK, USER, OPERATOR, ADMINISTRATOR. Default is ADMINISTRATOR.

m <local_address>
Set the local IPMB address. The default is 0x20 and there should be no need to change it for normal operation.

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.

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.

p <port>
Remote server UDP port to connect to. Default is 623.

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.

S <sdr_cache_file>
Use local 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 command.

t <target_address>
Bridge IPMI requests to the remote target address.

U <username>
Remote server username, default is NULL user.

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 spe Äê
cific BMC on a multi node, multi BMC system through the ipmi device driver interface. Default is 0.

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.

V Display version information.

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.

There are several security issues be 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 with the IPMIv1.5 lan interface 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 over IPMIv2.0 lanplus interface or
the system interface on the local station.

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.

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
raw Send a RAW IPMI request and print response
i2c Send an I2C Master Write Read command and print response
spd Print SPD info from remote I2C device
lan Configure LAN Channels
chassis Get chassis status and set power state
power Shortcut to chassis power commands
event Send 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 for FRU locators
sel Print System Event Log (SEL)
pef Configure Platform Event Filtering (PEF)
sol Configure and connect 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
session Print session information
sunoem Manage Sun OEM Extensions
kontronoem Manage Kontron OEM Extensions
picmg Run a PICMG/ATA extended command
firewall Configure Firmware Firewall
shell Launch interactive IPMI shell
exec Run list of commands from file
set Set runtime variable for shell and exec
echo Used to echo lines to stdout in scripts
ekanalyzer run FRU Ekeying analyzer using FRU files

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

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


reset <warm|cold>

Instructs the BMC to perform a warm or cold reset.


Display the Management Controller Globally Unique IDentifier.


Displays information about the BMC hardware, including device revision, firmware revision, IPMI version supported, manufacturer ID, and infor Äê
mation on additional device support.


These commands allow a user to view and change the current state of the watchdog timer.


Show current Watchdog Timer settings and countdown state.


Reset the Watchdog Timer to its most recent state and restart the countdown timer.


Turn off a currently running Watchdog countdown timer.


Check on the basic health of the BMC by executing the Get Self Test results command and report the results.


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

setenables <option>=[on|off]

Enables or disables the given option. This command is only supported over the system interface according to the IPMI specification. Currently
supported values for option include:


Receive Message Queue Interrupt


Event Message Buffer Full Interrupt


Event Message Buffer


System Event Logging


OEM Defined option

Related Topics

Apt Get Commands