Go to main content

Oracle® ILOM Protocol Management Reference SNMP and IPMI Firmware Release 4.0.x

Exit Print View

Updated: August 2017

IPMItool Options and Command Summary

The following tables summarize the supported IPMItool options and commands:

Note -  The IPMI TLS interface (orcltls) is supported as of Oracle ILOM firmware version 3.2.8 and later. For a higher level of security, you should always specify the IPMI TLS interface (-I orcltls) when executing Oracle ILOM commands from the IMPItool utility. For more information about using the IPMI TLS interface from Oracle, see these topics:IPMI TLS Service and Interface and Configure IPMI Management Access for Increased Security in Oracle ILOM Security Guide For Firmware Releases 3.x and 4.x.
Table 7  Supported IPMItool Options
IPMI Option
Prompt for the remote server password.
-A [authtype]
Specify an authentication type to use during IPMI v1.5 lan session activation. Supported authentication types are NONE, PASSWORD, MD2, MD5, or OEM.
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.
Read Kg key from IPMI_KGKEY environment variable.
-k [key]
Use supplied Kg key for IPMI v2 authentication. The default is not to use any Kg key.
-y [hex key]
Use supplied Kg key for IPMI v2 authentication. The key is expected in hexadecimal format and can be used to specify keys with non-printable characters. For example: '-k PASSWORD' and 'y 50415353574F5244' are equivalent. The default is not to use any Kg key.
Prompt for the Kg key for IPMI v2 authentication.
-C [ciphersuite]
The remote server authentication, integrity, and encryption algorithms to use for IPMI v2 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 algorithms.
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.
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 the IPMI interface to use. Supported interfaces that are compiled in are visible in the usage help output. No auto-detect is attempted. See the -I description for more information.
-I [interface]
Attempt the most secure interface first (orcltls). If the BMC does not support the interface, attempt the next most secured interface until the specified interface. Supported interfaces that are compiled in are visible in the usage help output. If lanplus interface or lan interface is specified, certificate checking is disabled when attempting the orcltls interface.

Note -  If the -I option is not specified, auto-detect is enabled and certificate checking is enabled when attempting the orcltls interface.

-m [local_address]
Set the local IPMB address. The default is 0x20 and there should be no need to change it for normal operation.
-N [sec]
Specify number of seconds between retransmissions of lan or lanplus messages. Default are 2 seconds for lan and 1 second for lanplus interfaces.
-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.
-p [port]
The remote server TLS TCP connection port is 443 (default).
For IPMI v2.0 and 1.5, the remote server UDP TCP connection is port 623 (default).
-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.

-R [count]
Set the number of retries for lan interface or lanplus interface (default=4).
-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]
Selects IPMI interface to use. Supported interfaces that are compiled in are visible in the usage help output.
-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 specific BMC on a multi-node, multi-BMC system through the IPMI device driver interface. Default is 0.
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.
Display version information.
Disables the check for validating the SSL certificate when the orcltls IPMI interface is specified.
--cert-dir [path]
Location of trusted SSL certificates on host server SP.
Table 8  Supported IPMItool Commands
IPMI Command
sunoem sshkey set
Configure an SSH key for a remote shell user.
ipmitool sunoem sshkey del
Remove an SSH key from a remote shell user.
ipmitool sunoem led get
Read LED status.
ipmitool sunoem led set
Set LED status.
ipmitool sunoem cli
Enter Oracle ILOM CLI commands as if you were using the ILOM CLI directly. The lan interface or lanplus interface should be used.
ipmitool sunoem CLI force
Available as of Oracle ILOM 3.0.10, a force option can be invoked as an argument to the sunoem CLI command.
ipmitool raw
Execute raw IPMI commands.
ipmitool lan print
Print the current configuration for the given channel.
ipmitool lan set (1) (2)
Set the given parameter on the given channel.
ipmitool chassis status
Display information regarding the high-level status of the system chassis and main power subsystem.
ipmitool chassis power
Perform a chassis control command to view and change the power state.
ipmitool chassis identify
Control the front panel identify light. Default is 15. Use 0 to turn off.
ipmitool chassis restart_cause
Query the chassis for the cause of the last system restart.
ipmitool chassis bootdev (1)
Request the system to boot from an alternative boot device on next reboot.
ipmitool chassis bootparam (1)
Set the host boot parameters.
ipmitool chassis selftest
Display the BMC self-test results.
ipmitool power
Return the BMC self-test results.
ipmitool event
Send a predefined event to the system event log.
ipmitool sdr
Query the BMC for sensor data records (SDR) and extract sensor information of a given type, then query each sensor and print its name, reading, and status.
ipmitool sensor
List sensors and thresholds in a wide table format.
ipmitool fru print
Read all field-replaceable unit (FRU) inventory data and extract such information as serial number, part number, asset tags, and short strings describing the chassis, board, or product.
ipmitool sel
View the Oracle ILOM SP system event log (SEL).
ipmitool pef info
Query the BMC and print information about the PEF- supported features.
ipmitool pef status
Print the current PEF status (the last SEL entry processed by the BMC, and so on).
ipmitool pef list
Print the current PEF list (the last SEL entry processed by the BMC, and so on).
ipmitool user
Display a summary of user ID information, including maximum number of user IDs, the number of enabled users, and the number of fixed names defined.
ipmitool session
Get information about the specified sessions. You can identify sessions by their ID, by their handle number, by their active status, or by using the keyword “all” to specify all sessions.
ipmitool firewall (1)
Enable or disable individual command and command sub-functions; determine which commands and command sub-functions can be configured on a given implementation.
ipmitool set (1)
Set the runtime options including session host name, user name, password, and privilege level.
ipmitool exec
Execute IPMItool commands from file name. Each line is a complete command.