OS Manuals

/usr/bin/ipmitool

Utility for managing and configuring devices that support IPMI

From ipmitool 1.8.19-r3 (enterprise-packages), captured 2026-11-08 by running ipmitool --help (exit 1). permalink

/usr/bin/ipmitool: invalid option -- '-'
ipmitool version 1.8.19

usage: ipmitool [options...] <command>

       -h             This help
       -V             Show version information
       -v             Verbose (can use multiple times)
       -c             Display output in comma separated format
       -d N           Specify a /dev/ipmiN device to use (default=0)
       -I intf        Interface to use
       -H hostname    Remote host name for LAN interface
       -p port        Remote RMCP port [default=623]
       -U username    Remote session username
       -f file        Read remote session password from file
       -z size        Change Size of Communication Channel (OEM)
       -S sdr         Use local file for remote SDR cache
       -D tty:b[:s]   Specify the serial device, baud rate to use
                      and, optionally, specify that interface is the system one
       -4             Use only IPv4
       -6             Use only IPv6
       -a             Prompt for remote password
       -Y             Prompt for the Kg key for IPMIv2 authentication
       -e char        Set SOL escape character
       -C ciphersuite Cipher suite to be used by lanplus interface
       -k key         Use Kg key for IPMIv2 authentication
       -y hex_key     Use hexadecimal-encoded Kg key for IPMIv2 authentication
       -L level       Remote session privilege level [default=ADMINISTRATOR]
                      Append a '+' to use name/privilege lookup in RAKP1
       -A authtype    Force use of auth type NONE, PASSWORD, MD2, MD5 or OEM
       -P password    Remote session password
       -E             Read password from IPMI_PASSWORD environment variable
       -K             Read kgkey from IPMI_KGKEY environment variable
       -m address     Set local IPMB address
       -b channel     Set destination channel for bridged request
       -t address     Bridge request to remote target address
       -B channel     Set transit channel for bridged request (dual bridge)
       -T address     Set transit address for bridge request (dual bridge)
       -l lun         Set destination lun for raw commands
       -o oemtype     Setup for OEM (use 'list' to see available OEM types)
       -O seloem      Use file for OEM SEL event descriptions
       -N seconds     Specify timeout for lan [default=2] / lanplus [default=1] interface
       -R retry       Set the number of retries for lan/lanplus interface [default=4]
       -Z             Display all dates in UTC

Interfaces:
	open          Linux OpenIPMI Interface [default]
	imb           Intel IMB Interface
	lan           IPMI v1.5 LAN Interface
	lanplus       IPMI v2.0 RMCP+ LAN Interface
	serial-terminal  Serial Interface, Terminal Mode
	serial-basic  Serial Interface, Basic Mode

Commands:
	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 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
	gendev        Read/Write Device associated with Generic Device locators sdr
	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 with Tyan IPMIv1.5 Serial-over-LAN
	isol          Configure IPMIv1.5 Serial-over-LAN
	user          Configure Management Controller users
	channel       Configure Management Controller channels
	session       Print session information
	dcmi          Data Center Management Interface
	nm            Node Manager Interface
	sunoem        OEM Commands for Sun servers
	kontronoem    OEM Commands for Kontron devices
	picmg         Run a PICMG/ATCA extended cmd
	fwum          Update IPMC using Kontron OEM Firmware Update Manager
	firewall      Configure Firmware Firewall
	delloem       OEM Commands for Dell systems
	shell         Launch interactive IPMI shell
	exec          Run list of commands from file
	set           Set runtime variable for shell and exec
	hpm           Update HPM components using PICMG HPM.1 file
	ekanalyzer    run FRU-Ekeying analyzer using FRU files
	ime           Update Intel Manageability Engine Firmware
	vita          Run a VITA 46.11 extended cmd
	lan6          Configure IPv6 LAN Channels
Options (39)
OptionDescriptionSource
-hGet basic usage help from the command line.help + man
-VDisplay version information.help + man
-vVerbose (can use multiple times)help + man
-cPresent output in CSV (comma separated variable) format.help + man
-d NUse device number N to specify the /dev/ipmiN (or /dev/ipmi/N or /dev/ipmidev/N) device to use for in-band BMC communication.help + man
-I intfSelects IPMI interface to use.help + man
-H hostnameRemote server address, can be IP address or hostname.help + man
-p portRemote server UDP port to connect to.help + man
-U usernameRemote server username, default is NULL user.help + man
-f fileSpecifies a file containing the remote server password.help + man
-z sizeChange Size of Communication Channel (OEM)help + man
-S sdrUse local file for remote SDR cache.help + man
-D tty:b[:sSpecify the serial device, baud rate to use and, optionally, specify that interface is the system onehelp
-4Use only IPv4help
-6Use only IPv6help
-aPrompt for the remote server password.help + man
-YPrompt for the Kg key for IPMIv2.0 authentication.help + man
-e charUse supplied character for SOL session escape character.help + man
-k keyUse supplied Kg key for IPMIv2.0 authentication.help + man
-y hex_keyUse hexadecimal-encoded Kg key for IPMIv2 authenticationhelp + man
-L levelRemote session privilege level [default=ADMINISTRATOR] Append a '+' to use name/privilege lookup in RAKP1help + man
-A authtypeSpecify an authentication type to use during IPMIv1.5 lan session activation.help + man
-P passwordRemote server password is specified on the command line.help + man
-EThe remote server password is specified by the environment variable IPMI_PASSWORD or IPMITOOL_PASSWORD.help + man
-KRead Kg key from IPMI_KGKEY environment variable.help + man
-m addressSet the local IPMB address.help + man
-b channelSet destination channel for bridged request.help + man
-t addressBridge IPMI requests to the remote target address.help + man
-B channelSet transit channel for bridged request (dual bridge).help + man
-T addressSet transit address for bridge request (dual bridge).help + man
-l lunSet destination lun for raw commands.help + man
-o oemtypeSetup for OEM (use 'list' to see available OEM types)help + man
-O seloemOpen selected file and read OEM SEL event descriptions to be used during SEL listings.help + man
-N secondsSpecify timeout for lan [default=2] / lanplus [default=1] interfacehelp + man
-R retrySet the number of retries for lan/lanplus interface (default=4).help + man
-ZDisplay all dates in UTChelp
-C ciphersuiteThe remote server authentication, integrity, and encryption algorithms to use for IPMIv2.0 lanplus connections. (in the manual page but not in --help)man
-gDeprecated. (in the manual page but not in --help)man
-sDeprecated. (in the manual page but not in --help)man

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.