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 Release 5.1.x.
Table 5-2 Supported IPMItool Options
IPMI Option | Function |
---|---|
|
Prompt for the remote server password. |
|
Specify the authentication type to use during an IPMI 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. |
|
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. |
|
Use supplied Kg key for IPMI v2 authentication. The default is not to use any Kg 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. |
|
The remote server authentication, integrity, and encryption algorithms to use for IPMI
v2 |
|
The remote server password is specified by the environment variable IPMI_PASSWORD. |
|
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. |
|
Remote server address, can be IP address or hostname. This option is required for
|
|
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 |
|
Attempt the most secure interface first ( Note: If the |
|
Set the local IPMB address. The default is 0x20 and there should be no need to change it for normal operation. |
|
Specify number of seconds between retransmissions of |
|
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. |
|
Open selected file and read OEM SEL event descriptions to be used during SEL listings. |
|
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). |
|
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. |
|
Set the number of retries for |
|
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 |
|
Selects IPMI interface to use. Supported interfaces that are compiled in are visible in the usage help output. |
|
Remote server username, default is NULL user. |
|
Use device number N to specify the |
|
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. |
|
Location of trusted SSL certificates on host server SP. |
Table 5-3 Supported IPMItool Commands
IPMI Command | Function |
---|---|
|
Configure an SSH key for a remote shell user. |
|
Remove an SSH key from a remote shell user. |
|
Read LED status. |
|
Set LED status. |
|
Enter Oracle ILOM CLI commands as if you were using the ILOM CLI directly. The
|
|
Available as of Oracle ILOM 3.0.10, a |
|
Execute raw IPMI commands. |
|
Print the current configuration for the given channel. |
|
Set the given parameter on the given channel. |
|
Display information regarding the high-level status of the system chassis and main power subsystem. |
|
Perform a chassis control command to view and change the power state. |
|
Control the front panel identify light. Default is 15. Use 0 to turn off. |
|
Query the chassis for the cause of the last system restart. |
|
Request the system to boot from an alternative boot device on next reboot. |
|
Set the host boot parameters. |
|
Display the BMC self-test results. |
|
Return the BMC self-test results. |
|
Send a predefined event to the system event log. |
|
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. |
|
List sensors and thresholds in a wide table format. |
|
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. |
|
View the Oracle ILOM SP system event log (SEL). |
|
Query the BMC and print information about the PEF- supported features. |
|
Print the current PEF status (the last SEL entry processed by the BMC, and so on). |
|
Print the current PEF list (the last SEL entry processed by the BMC, and so on). |
|
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. |
|
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. |
|
Enable or disable individual command and command sub-functions; determine which commands and command sub-functions can be configured on a given implementation. |
|
Set the runtime options including session host name, user name, password, and privilege level. |
|
Execute IPMItool commands from file name. Each line is a complete command. |