.TH IPMI-CONFIG 8 "2023-03-23" "ipmi-config 1.6.10" "System Commands"
.SH "NAME"
ipmi-config \- configure IPMI values
.SH "SYNOPSIS"
.B ipmi-config
[\fIOPTION\fR...]
.SH "DESCRIPTION"
.B ipmi-config
is used to get and set configuration parameters in IPMI. In can be
used to configured usernames, passwords, networking information,
security, Serial-over-LAN (SOL), Platform Event Filtering (PEF), boot
devices, power restoration policy, sensor thresholds, sensor
events, and many more configuration options.
Some configuration is typically required before most IPMI
tools can be used to access a machine remotely. By default,
.B ipmi-config,
will let you \fI\-\-checkout\fR or \fI\-\-commit\fR only the
\fIcore\fR IPMI values necessary for IPMI configuration. For
additional advanced configuration fields related to Chassis
configuration (including boot options), Platform Event Filtering
(PEF), or Sensors, see the \fI\-\-category\fR option below.
The majority of
configuration operations require ADMIN privilege when using
.B ipmi-config
out-of-band. Although connecting via a user with ADMIN privileges is
not required for out-of-band use, the vast majority of configuration
options will not be retrieved or set.
.LP
Listed below are general IPMI options, tool specific options, trouble
shooting information, workaround information, examples, and known
issues. For a general introduction to FreeIPMI please see
.B freeipmi(7).
See GENERAL USE below for a description on basic use of
.B ipmi-config.
.SH "GENERAL OPTIONS"
The following options are general options for configuring IPMI
communication and executing general tool commands.
.TP
\fB\-D\fR \fIIPMIDRIVER\fR, \fB\-\-driver\-type\fR=\fIIPMIDRIVER\fR
Specify the driver type to use instead of doing an auto selection.
The currently available outofband drivers are LAN and LAN_2_0, which
perform IPMI 1.5 and IPMI 2.0 respectively. The currently available
inband drivers are KCS, SSIF, OPENIPMI, SUNBMC, and INTELDCMI.
.TP
\fB\-\-disable\-auto\-probe\fR
Do not probe in-band IPMI devices for default settings.
.TP
\fB\-\-driver\-address\fR=\fIDRIVER-ADDRESS\fR
Specify the in-band driver address to be used instead of the probed
value. \fIDRIVER-ADDRESS\fR should be prefixed with "0x" for a hex
value and '0' for an octal value.
.TP
\fB\-\-driver\-device\fR=\fIDEVICE\fR
Specify the in-band driver device path to be used instead of the
probed path.
.TP
\fB\-\-register\-spacing\fR=\fIREGISTER-SPACING\fR
Specify the in-band driver register spacing instead of the probed
value. Argument is in bytes (i.e. 32bit register spacing = 4)
.TP
\fB\-\-target\-channel\-number\fR=\fICHANNEL\-NUMBER\FR
Specify the in-band driver target channel number to send IPMI requests
to.
.TP
\fB\-\-target\-slave\-address\fR=\fISLAVE\-ADDRESS\FR
Specify the in-band driver target slave number to send IPMI requests
to.
.TP
\fB\-h\fR \fIIPMIHOST1,IPMIHOST2,...\fR, \fB\-\-hostname\fR=\fIIPMIHOST1[:PORT],IPMIHOST2[:PORT],...\fR
Specify the remote host(s) to communicate with. Multiple hostnames
may be separated by comma or may be specified in a range format; see
HOSTRANGED SUPPORT below. An optional port can be specified with each
host, which may be useful in port forwarding or similar situations.
If specifying an IPv6 address and port, use the format [ADDRESS]:PORT.
.TP
\fB\-u\fR \fIUSERNAME\fR, \fB\-\-username\fR=\fIUSERNAME\fR
Specify the username to use when authenticating with the remote host.
If not specified, a null (i.e. anonymous) username is assumed. The
user must have atleast ADMIN privileges in order for this tool to
operate fully.
.TP
\fB\-p\fR \fIPASSWORD\fR, \fB\-\-password\fR=\fIPASSWORD\fR
Specify the password to use when authenticationg with the remote host.
If not specified, a null password is assumed. Maximum password length
is 16 for IPMI 1.5 and 20 for IPMI 2.0.
.TP
\fB\-P\fR, \fB\-\-password-prompt\fR
Prompt for password to avoid possibility of listing
it in process lists.
.TP
\fB\-k\fR \fIK_G\fR, \fB\-\-k-g\fR=\fIK_G\fR
Specify the K_g BMC key to use when authenticating with the remote
host for IPMI 2.0. If not specified, a null key is assumed. To input
the key in hexadecimal form, prefix the string with '0x'. E.g., the
key 'abc' can be entered with the either the string 'abc' or the
string '0x616263'
.TP
\fB\-K\fR, \fB\-\-k-g-prompt\fR
Prompt for k-g to avoid possibility of listing it in process lists.
.TP
\fB\-\-session-timeout\fR=\fIMILLISECONDS\fR
Specify the session timeout in milliseconds. Defaults to 20000
milliseconds (20 seconds) if not specified.
.TP
\fB\-\-retransmission-timeout\fR=\fIMILLISECONDS\fR
Specify the packet retransmission timeout in milliseconds. Defaults
to 1000 milliseconds (1 second) if not specified. The retransmission
timeout cannot be larger than the session timeout.
.TP
\fB\-a\fR \fIAUTHENTICATION\-TYPE\fR, \fB\-\-authentication\-type\fR=\fIAUTHENTICATION\-TYPE\fR
Specify the IPMI 1.5 authentication type to use. The currently
available authentication types are NONE, STRAIGHT_PASSWORD_KEY, MD2,
and MD5. Defaults to MD5 if not specified.
.TP
\fB\-I\fR \fICIPHER-SUITE-ID\fR, \fB\-\-cipher\-suite-id\fR=\fICIPHER-SUITE-ID\fR
Specify the IPMI 2.0 cipher suite ID to use. The Cipher Suite ID
identifies a set of authentication, integrity, and confidentiality
algorithms to use for IPMI 2.0 communication. The authentication
algorithm identifies the algorithm to use for session setup, the
integrity algorithm identifies the algorithm to use for session packet
signatures, and the confidentiality algorithm identifies the algorithm
to use for payload encryption. Defaults to cipher suite ID 3 if not
specified. The following cipher suite ids are currently supported:
.sp
0 - Authentication Algorithm = None; Integrity Algorithm = None; Confidentiality Algorithm = None
.sp
1 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm = None; Confidentiality Algorithm = None
.sp
2 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm = HMAC-SHA1-96; Confidentiality Algorithm = None
.sp
3 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm = HMAC-SHA1-96; Confidentiality Algorithm = AES-CBC-128
.\" .sp
.\" 4 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm = HMAC-SHA1-96; Confidentiality Algorithm = xRC4-128
.\" .sp
.\" 5 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm = HMAC-SHA1-96; Confidentiality Algorithm = xRC4-40
.sp
6 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm = None; Confidentiality Algorithm = None
.sp
7 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm = HMAC-MD5-128; Confidentiality Algorithm = None
.sp
8 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm = HMAC-MD5-128; Confidentiality Algorithm = AES-CBC-128
.\" .sp
.\" 9 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm = HMAC-MD5-128; Confidentiality Algorithm = xRC4-128
.\" .sp
.\" 10 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm = HMAC-MD5-128; Confidentiality Algorithm = xRC4-40
.sp
11 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm = MD5-128; Confidentiality Algorithm = None
.sp
12 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm = MD5-128; Confidentiality Algorithm = AES-CBC-128
.\" .sp
.\" 13 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm = MD5-128; Confidentiality Algorithm = xRC4-128
.\" .sp
.\" 14 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm = MD5-128; Confidentiality Algorithm = xRC4-40
.\" XXX GUESS
.sp
15 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm = None; Confidentiality Algorithm = None
.\" XXX GUESS
.sp
16 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm = HMAC_SHA256_128; Confidentiality Algorithm = None
.sp
17 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm = HMAC_SHA256_128; Confidentiality Algorithm = AES-CBC-128
.\" XXX GUESS
.\" .sp
.\" 18 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm = HMAC_SHA256_128; Confidentiality Algorithm = xRC4-128
.\" XXX GUESS
.\" .sp
.\" 19 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm = HMAC_SHA256_128; Confidentiality Algorithm = xRC4-40
.TP
\fB\-l\fR \fIPRIVILEGE\-LEVEL\fR, \fB\-\-privilege-level\fR=\fIPRIVILEGE\-LEVEL\fR
Specify the privilege level to be used. The currently available
privilege levels are USER, OPERATOR, and ADMIN. Defaults to ADMIN if
not specified.
.TP
\fB\-\-config\-file\fR=\fIFILE\fR
Specify an alternate configuration file.
.TP
\fB\-W\fR \fIWORKAROUNDS\fR, \fB\-\-workaround\-flags\fR=\fIWORKAROUNDS\fR
Specify workarounds to vendor compliance issues. Multiple workarounds
can be specified separated by commas. A special command line flag of
"none", will indicate no workarounds (may be useful for overriding
configured defaults). See WORKAROUNDS below for a list of available
workarounds.
.TP
\fB\-\-debug\fR
Turn on debugging.
.TP
\fB\-?\fR, \fB\-\-help\fR
Output a help list and exit.
.TP
\fB\-\-usage\fR
Output a usage message and exit.
.TP
\fB\-V\fR, \fB\-\-version\fR
Output the program version and exit.
.SH "IPMI-CONFIG OPTIONS"
The following options are used to read, write, and find differences
in configuration values.
.TP
\fB\-g\fR \fICATEGORY\fR, \fB\-\-category\fR=\fICATEGORY\fR
Specify the category or categories of configuration data to configure.
Currently available choices: \fIcore\fR, \fIchassis\fR, \fIsensors\fR,
\fIpef\fR, \fIdcmi\fR. Multiple categories can be separated by comma.
\fIcore\fR includes all major IPMI configuration necessary to get IPMI
to function on a system, such as configuration for users, passwords,
authentication, networking, and serial-over-lan (SOL). \fIchassis\fR
includes all chassis relevant configuration including boot options,
front panel buttons, and power behavior. \fIdcmi\fR includes
specialized functions provided by the Data Center Management Interface
(DCMI). Defaults to \fIcore\fR if not specified.
.TP
\fB\-o\fR, \fB\-\-checkout\fR
Fetch configuration information.
.TP
\fB\-c\fR, \fB\-\-commit\fR
Update configuration information from a config file or key pairs.
.TP
\fB\-d\fR, \fB\-\-diff\fR
Show differences between stored information and a config file or key pairs.
.TP
\fB\-n\fR \fIFILENAME\fR, \fB\-\-filename\fR=\fIFILENAME\fR
Specify a config file for checkout/commit/diff. If specified with checkout, cannot
use with multiple hosts or with \fB\-\-always\-prefix\fR.
.TP
\fB\-e\fR \fI"KEY=VALUE"\fR, \fB\-\-key\-pair\fR=\fI"KEY=VALUE"\fR
Specify KEY=VALUE pairs for checkout/commit/diff. Specify KEY by
SectionName:FieldName. This option can be used multiple times. On
commit, any KEY=VALUE pairs will overwrite any pairs specified in a
file with \fB\-\-filename\fR.
.TP
\fB\-S\fR \fISECTION\fR, \fB\-\-section\fR=\fISECTION\fR
Specify a SECTION for checkout. This option can be used multiple
times. The SECTION you are specifying must be within the category or
categories specified with \fI\-\-category\fR.
.TP
\fB\-L\fR, \fB\-\-listsections\fR
List available sections for checkout with respect to the category or
categories under \fI\-\-category\fR. Some sections in the list may
not be checked out by default and may require verbosity to be
increased.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Output verbose information. When used with \fI\-\-checkout\fR,
additional uncommon sections and/or fields will be shown. In the
\fIcore\fR category, this includes checking out Serial Configuration
parameters, Vlan parameters, IPv4 Header parameters, RMCP port, all
IPv6 configurable addresses (if > 1 is supported), and sections for
each channel on a system (if multiple channels exist). In the
\fIpef\fR category, this includes checkout out sections for each
channel on a system (if multiple channels exist).
.TP
\fB\-vv\fR
Output very verbose information. Output additional detailed
information about what fields can and cannot be checked out, and
sometimes the reason why. Sometimes output fields that are identified
as unsupported on the motherboard.
.TP
\fB\-\-lan\-channel\-number\fR=\fINUMBER\fR
Use an specific channel number for LAN configuration. Particularly
useful if motherboard contains multiple LAN channels and a user wishes
to use a specific one.
.TP
\fB\-\-serial\-channel\-number\fR=\fINUMBER\fR
Use an specific channel number for serial configuration. Particularly
useful if motherboard contains multiple serial channels and a user
wishes to use a specific one.
.TP
\fB\-\-sol\-channel\-number\fR=\fINUMBER\fR
Use an specific channel number for SOL configuration. Particularly
useful if motherboard contains multiple SOL channels and a user
wishes to use a specific one.
.SH "SDR CACHE OPTIONS"
This tool requires access to the sensor data repository (SDR) cache
for general operation. By default, SDR data will be downloaded and
cached on the local machine. The following options apply to the SDR
cache.
.TP
\fB\-\-flush\-cache\fR
Flush a cached version of the sensor data repository (SDR) cache. The
SDR is typically cached for faster subsequent access. However, it may
need to be flushed and re-generated if the SDR has been updated on a
system.
.TP
\fB\-\-quiet\-cache\fR
Do not output information about cache creation/deletion. May be
useful in scripting.
.TP
\fB\-\-sdr\-cache\-recreate\fR
If the SDR cache is out of date or invalid, automatically recreate the
sensor data repository (SDR) cache. This option may be useful for
scripting purposes.
.TP
\fB\-\-sdr\-cache\-file\fR=\fIFILE\fR
Specify a specific sensor data repository (SDR) cache file to be
stored or read from. If this option is used when multiple hosts are
specified, the same SDR cache file will be used for all hosts.
.TP
\fB\-\-sdr\-cache\-directory\fR=\fIDIRECTORY\fR
Specify an alternate directory for sensor data repository (SDR) caches
to be stored or read from. Defaults to the home directory if not
specified.
.SH "HOSTRANGED OPTIONS"
The following options manipulate hostranged output. See HOSTRANGED
SUPPORT below for additional information on hostranges.
.TP
\fB\-B\fR, \fB\-\-buffer-output\fR
Buffer hostranged output. For each node, buffer standard output until
the node has completed its IPMI operation. When specifying this
option, data may appear to output slower to the user since the the
entire IPMI operation must complete before any data can be output.
See HOSTRANGED SUPPORT below for additional information.
.TP
\fB\-C\fR, \fB\-\-consolidate-output\fR
Consolidate hostranged output. The complete standard output from
every node specified will be consolidated so that nodes with identical
output are not output twice. A header will list those nodes with the
consolidated output. When this option is specified, no output can be
seen until the IPMI operations to all nodes has completed. If the
user breaks out of the program early, all currently consolidated
output will be dumped. See HOSTRANGED SUPPORT below for additional
information.
.TP
\fB\-F\fR \fINUM\fR, \fB\-\-fanout\fR=\fINUM\fR
Specify multiple host fanout. A "sliding window" (or fanout)
algorithm is used for parallel IPMI communication so that slower nodes
or timed out nodes will not impede parallel communication. The
maximum number of threads available at the same time is limited by the
fanout. The default is 64.
.TP
\fB\-E\fR, \fB\-\-eliminate\fR
Eliminate hosts determined as undetected by
.B ipmidetect.
This attempts to remove the common issue of hostranged execution
timing out due to several nodes being removed from service in a large
cluster. The
.B ipmidetectd
daemon must be running on the node executing the command.
.TP
\fB\-\-always\-prefix\fR
Always prefix output, even if only one host is specified or
communicating in-band. This option is primarily useful for
scripting purposes. Option will be ignored if specified with
the \fB\-C\fR option.
.SH "GENERAL USE"
Most users of will want to:
.LP
A) Run with \fI\-\-checkout\fR to get a copy of the current
configuration and store it in a file. The standard output can be
redirected to a file or a file can be specified with the
\fI\-\-filename\fR option.
.LP
B) Edit the configuration file with an editor.
.LP
C) Commit the configuration back using the \fI\-\-commit\fR option and
specifying the configuration file with the \fI\-\-filename\fR option.
The configuration can be committed to multiple hosts in parallel via
the hostrange support.
.LP
Although not typically necessarily, some motherboards do not store
configuration values in non-volatile memory. Therefore, after system
reboots, some configuration values may have changed. The user may
wish to run configuration tools on each boot to ensure configuration
values remain.
.LP
Comments will be listed on occassion in checked out files with information
on how to configure fields.
The
.B ipmi-config.conf(5)
manpage also provides additional information on the meaning of
different fields.
.LP
For users with large clusters or sets of nodes, you may wish to use
the same configuration file for all nodes. The one problem with this
is that the IP address and MAC address will be different on each node
in your cluster and thus can't be configured through the same config
file. The IP address and MAC address in your config file may be
overwritten on the command line using \fI\-\-key\-pair\fR option. The
following example could be used in a script to configure each node in
a cluster with the same BMC config file. The script only needs to
determine the correct IP address and MAC address to use.
.LP
.B # ipmi-config --commit -k "Lan_Conf:Ip_Address=$MY_IP" -k "Lan_Conf:Mac_Address=$MY_MAC" --filename=my_bmc.conf
.SH "CORE SPECIAL CASE CONFIGURATION INFORMATION"
The
.B UserN:Password
fields (where N is a number) cannot be checked out on some systems,
therefore the checked out value will always be blank.
.LP
The
.B UserN:Enable_User
field (where N is a number) cannot be checked out on older IPMI
systems, therefore the checked out value will sometime be blank.
.LP
The
.B UserN:Lan_Session_Limit
and
.B UserN:Serial_Session_Limit
fields (where N is a number) cannot be checked out on some systems,
therefore the checked out value will always be blank. If not
specified in later commits of configurations, the field may be reset
to 0 due to a requirement that other fields (configured along with the
session limit) will require an input value for the session limit.
Under most conditions, it is not necessary to set this field and most
users may choose to ignore it. This field is considered optional by
IPMI standards, and may result in errors when attempting to configure
it to a non-zero value. If errors to occur, setting the value back to
0 should resolve problems.
.LP
The fields
.B Lan_Conf:IP_Address
and
.B Lan_Conf:MAC_Address
cannot be committed in parallel via hostrange support. Each machine
must be configured with a unique IP Address and MAC Address tuple,
therefore we disallow this configuration in
.B ipmi-config.
.LP
On some motherboards,
.B Lan_Conf:MAC_Address
may be read only and the MAC address is automatically configured.
.LP
On some motherboards,
.B Lan_Conf:MAC_Address
may be read only and the MAC address is configured via an OEM command. See
.B ipmi-oem(8)
to see if OEM configuration for your motherboard is supported.
.LP
On some motherboards, a number of user configuration fields cannot be
read or configured until after a non-null username or non-null
password is configured. In some of these cases, an appropriate output
in the config file will indicate this situation. However, not all
motherboard corner cases may be detected. Users may wish to play
around with the ordering of fields to work around these problems.
.LP
On some motherboards, OEM Authentication in
.B Lan_Conf_Auth
cannot be enabled. However, the default motherboard settings have
these fields enabled. Users are advised to disable all OEM
Authentication in this section.
.LP
On some motherboards, multiple channels may exist for either LAN or
Serial IPMI communication. If multiple channels exist, configuration
of both channels can be viewed and ultimately configured by running
\fI\-\-checkout\fR under verbose mode. Each section or key name will
be suffixed appropriately with the word \fIChannel\fR and the channel
number. For example, you might see a \fILan_Conf_Channel_1\fR and
\fILan_Conf_Channel_3\fR, where you can configure LAN configuration on
Channels 1 and 3 respectively.
.LP
On some motherboards, configuration changes will not be "absorbed" by
the system until the motherboard is hard-reset. This can be accomplished
by physically powering off and on the system (e.g. button push), or it can be
accomplished through a cold-reset. A cold-reset can be executed via
.B bmc-device.
.SH "CHASSIS SPECIAL CASE CONFIGURATION INFORMATION"
The
.B Chassis_Front_Panel_Buttons:Enable_Standby_Button_For_Entering_Standy,
.B Chassis_Front_Panel_Buttons:Enable_Diagnostic_Interrupt_Button
.B Chassis_Front_Panel_Buttons:Enable_Reset_Button,
and
.B Chassis_Front_Panel_Buttons:Enable_Power_Off_Button_For_Power_Off_Only
fields may not be able to be checked out on some IPMI systems, therefore
the checked out value may be blank. Some of these fields may be
disableable, while some are not.
The
.B Chassis_Power_Conf:Power_Control_Interval
field cannot be checked out. Therefore the checked out value will
always be blank.
.SH "PEF SPECIAL CASE CONFIGURATION INFORMATION"
On some motherboards, multiple channels may exist for LAN IPMI
communication. If multiple channels exist, configuration of both
channels can be viewed and ultimately configured by running
\fI\-\-checkout\fR under verbose mode. Each section name will be
suffixed appropriately with the word \fIChannel\fR and the channel
number. For example, you might see a \fICommunity_String_Channel_1\fR
and \fICommunity_String_Channel_3\fR, where you can configure the
Community String on Channels 1 and 3 respectively.
The following are the options suitable for input for Sensor_Type in
PEF configuration.
.TP
\fBSensor_Type Options\fR
Reserved, Temperature, Voltage, Current, Fan, Physical_Security,
Platform_Security_Violation_Attempt, Processor, Power_Supply,
Power_Unit, Cooling_Device, Other_Units_Based_Sensor, Memory,
Drive_Slot, Post_Memory_Resize, System_Firmware_Progress,
Event_Logging_Disabled, Watchdog1, System_Event, Critical_Interrupt,
Button_Switch, Module_Board, Microcontroller_Coprocessor, Add_In_Card,
Chassis, Chip_Set, Other_FRU, Cable_Interconnect, Terminator,
System_Boot_Initiated, Boot_Error, OS_Boot, OS_Critical_Stop,
Slot_Connector, System_ACPI_Power_State, Watchdog2, Platform_Alert,
Entity_Presence, Monitor_Asic_IC, Lan, Management_Subsystem_Health,
Battery, Session_Audit, Version_Change, FRU_State, and Any
.SH "SENSORS SPECIAL CASE CONFIGURATION INFORMATION"
Since many configurable fields involve decimal numbers,
precision/floating point inaccuracies may occur when configuring new
thresholds. The inaccuracies may not be apparent immediately. It is
recommend users verify their changes after configuring new thresholds.
.SH "HOSTRANGED SUPPORT"
Multiple hosts can be input either as an explicit comma separated
lists of hosts or a range of hostnames in the general form:
prefix[n-m,l-k,...], where n < m and l < k, etc. The later form
should not be confused with regular expression character classes (also
denoted by []). For example, foo[19] does not represent foo1 or foo9,
but rather represents a degenerate range: foo19.
.LP
This range syntax is meant only as a convenience on clusters with a
prefixNN naming convention and specification of ranges should not be
considered necessary -- the list foo1,foo9 could be specified as such,
or by the range foo[1,9].
.LP
Some examples of range usage follow:
.nf
    foo[01-05] instead of foo01,foo02,foo03,foo04,foo05
    foo[7,9-10] instead of foo7,foo9,foo10
    foo[0-3] instead of foo0,foo1,foo2,foo3
.fi
.LP
As a reminder to the reader, some shells will interpret brackets ([
and ]) for pattern matching. Depending on your shell, it may be
necessary to enclose ranged lists within quotes.
.LP
When multiple hosts are specified by the user, a thread will be
executed for each host in parallel up to the configured fanout (which
can be adjusted via the \fB\-F\fR option). This will allow
communication to large numbers of nodes far more quickly than if done
in serial.
.LP
By default, standard output from each node specified will be output
with the hostname prepended to each line. Although this output is
readable in many situations, it may be difficult to read in other
situations. For example, output from multiple nodes may be mixed
together. The \fB\-B\fR and \fB\-C\fR options can be used to change
this default.
.LP
In-band IPMI Communication will be used when the host "localhost" is
specified. This allows the user to add the localhost into the
hostranged output.
.SH "GENERAL TROUBLESHOOTING"
Most often, IPMI problems are due to configuration problems.
.LP
IPMI over LAN problems involve a misconfiguration of the remote
machine's BMC.  Double check to make sure the following are configured
properly in the remote machine's BMC: IP address, MAC address, subnet
mask, username, user enablement, user privilege, password, LAN
privilege, LAN enablement, and allowed authentication type(s). For
IPMI 2.0 connections, double check to make sure the cipher suite
privilege(s) and K_g key are configured properly. The
.B ipmi-config(8)
tool can be used to check and/or change these configuration
settings.
.LP
Inband IPMI problems are typically caused by improperly configured
drivers or non-standard BMCs.
.LP
In addition to the troubleshooting tips below, please see WORKAROUNDS
below to also if there are any vendor specific bugs that have been
discovered and worked around.
.LP
Listed below are many of the common issues for error messages.
For additional support, please e-mail the <freeipmi\-users@gnu.org>
mailing list.
.LP
"username invalid" - The username entered (or a NULL username if none
was entered) is not available on the remote machine. It may also be
possible the remote BMC's username configuration is incorrect.
.LP
"password invalid" - The password entered (or a NULL password if none
was entered) is not correct. It may also be possible the password for
the user is not correctly configured on the remote BMC.
.LP
"password verification timeout" - Password verification has timed out.
A "password invalid" error (described above) or a generic "session
timeout" (described below) occurred.  During this point in the
protocol it cannot be differentiated which occurred.
.LP
"k_g invalid" - The K_g key entered (or a NULL K_g key if none was
entered) is not correct. It may also be possible the K_g key is not
correctly configured on the remote BMC.
.LP
"privilege level insufficient" - An IPMI command requires a higher
user privilege than the one authenticated with. Please try to
authenticate with a higher privilege. This may require authenticating
to a different user which has a higher maximum privilege.
.LP
"privilege level cannot be obtained for this user" - The privilege
level you are attempting to authenticate with is higher than the
maximum allowed for this user. Please try again with a lower
privilege. It may also be possible the maximum privilege level
allowed for a user is not configured properly on the remote BMC.
.LP
"authentication type unavailable for attempted privilege level" - The
authentication type you wish to authenticate with is not available for
this privilege level. Please try again with an alternate
authentication type or alternate privilege level. It may also be
possible the available authentication types you can authenticate with
are not correctly configured on the remote BMC.
.LP
"cipher suite id unavailable" - The cipher suite id you wish to
authenticate with is not available on the remote BMC. Please try
again with an alternate cipher suite id. It may also be possible the
available cipher suite ids are not correctly configured on the remote
BMC.
.LP
"ipmi 2.0 unavailable" - IPMI 2.0 was not discovered on the remote
machine. Please try to use IPMI 1.5 instead.
.LP
"connection timeout" - Initial IPMI communication failed. A number of
potential errors are possible, including an invalid hostname
specified, an IPMI IP address cannot be resolved, IPMI is not enabled
on the remote server, the network connection is bad, etc. Please
verify configuration and connectivity.
.LP
"session timeout" - The IPMI session has timed out. Please reconnect.
If this error occurs often, you may wish to increase the
retransmission timeout. Some remote BMCs are considerably slower than
others.
.LP
"device not found" - The specified device could not be found. Please
check configuration or inputs and try again.
.LP
"driver timeout" - Communication with the driver or device has timed
out. Please try again.
.LP
"message timeout" - Communication with the driver or device has timed
out. Please try again.
.LP
"BMC busy" - The BMC is currently busy. It may be processing
information or have too many simultaneous sessions to manage. Please
wait and try again.
.LP
"could not find inband device" - An inband device could not be found.
Please check configuration or specify specific device or driver on the
command line.
.LP
"driver timeout" - The inband driver has timed out communicating to
the local BMC or service processor. The BMC or service processor may
be busy or (worst case) possibly non-functioning.
.SH "WORKAROUNDS"
With so many different vendors implementing their own IPMI solutions,
different vendors may implement their IPMI protocols incorrectly. The
following describes a number of workarounds currently available to
handle discovered compliance issues. When possible, workarounds have
been implemented so they will be transparent to the user. However,
some will require the user to specify a workaround be used via the -W
option.
.LP
The hardware listed below may only indicate the hardware that a
problem was discovered on. Newer versions of hardware may fix the
problems indicated below. Similar machines from vendors may or may
not exhibit the same problems. Different vendors may license their
firmware from the same IPMI firmware developer, so it may be
worthwhile to try workarounds listed below even if your motherboard is
not listed.
.LP
If you believe your hardware has an additional compliance issue that
needs a workaround to be implemented, please contact the FreeIPMI
maintainers on <freeipmi\-users@gnu.org> or <freeipmi\-devel@gnu.org>.
.LP
\fIassumeio\fR - This workaround flag will assume inband interfaces
communicate with system I/O rather than being memory-mapped. This
will work around systems that report invalid base addresses. Those
hitting this issue may see "device not supported" or "could not find
inband device" errors.  Issue observed on HP ProLiant DL145 G1.
.LP
\fIspinpoll\fR - This workaround flag will inform some inband drivers
(most notably the KCS driver) to spin while polling rather than
putting the process to sleep. This may significantly improve the wall
clock running time of tools because an operating system scheduler's
granularity may be much larger than the time it takes to perform a
single IPMI message transaction. However, by spinning, your system
may be performing less useful work by not contexting out the tool for
a more useful task.
.LP
\fIauthcap\fR - This workaround flag will skip early checks for username
capabilities, authentication capabilities, and K_g support and allow
IPMI authentication to succeed. It works around multiple issues in
which the remote system does not properly report username
capabilities, authentication capabilities, or K_g status. Those
hitting this issue may see "username invalid", "authentication type
unavailable for attempted privilege level", or "k_g invalid" errors.
Issue observed on Asus P5M2/P5MT-R/RS162-E4/RX4, Intel SR1520ML/X38ML,
and Sun Fire 2200/4150/4450 with ELOM.
.LP
\fInochecksumcheck\fR - This workaround flag will tell FreeIPMI to not
check the checksums returned from IPMI command responses. It works
around systems that return invalid checksums due to implementation
errors, but the packet is otherwise valid. Users are cautioned on the
use of this option, as it removes validation of packet integrity in a
number of circumstances. However, it is unlikely to be an issue in
most situations. Those hitting this issue may see "connection
timeout", "session timeout", or "password verification timeout"
errors. On IPMI 1.5 connections, the "noauthcodecheck" workaround may
also needed too. Issue observed on Supermicro X9SCM-iiF, Supermicro
X9DRi-F, and Supermicro X9DRFR.
.LP
\fIidzero\fR - This workaround flag will allow empty session IDs to be
accepted by the client. It works around IPMI sessions that report
empty session IDs to the client. Those hitting this issue may see
"session timeout" errors. Issue observed on Tyan S2882 with M3289
BMC.
.LP
\fIunexpectedauth\fR - This workaround flag will allow unexpected non-null
authcodes to be checked as though they were expected. It works around
an issue when packets contain non-null authentication data when they
should be null due to disabled per-message authentication. Those
hitting this issue may see "session timeout" errors. Issue observed
on Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.
.LP
\fIforcepermsg\fR - This workaround flag will force per-message
authentication to be used no matter what is advertised by the remote
system. It works around an issue when per-message authentication is
advertised as disabled on the remote system, but it is actually
required for the protocol. Those hitting this issue may see "session
timeout" errors.  Issue observed on IBM eServer 325.
.LP
\fIendianseq\fR - This workaround flag will flip the endian of the session
sequence numbers to allow the session to continue properly. It works
around IPMI 1.5 session sequence numbers that are the wrong endian.
Those hitting this issue may see "session timeout" errors. Issue
observed on some Sun ILOM 1.0/2.0 (depends on service processor
endian).
.LP
\fInoauthcodecheck\fR - This workaround flag will tell FreeIPMI to not
check the authentication codes returned from IPMI 1.5 command
responses. It works around systems that return invalid authentication
codes due to hashing or implementation errors. Users are cautioned on
the use of this option, as it removes an authentication check
verifying the validity of a packet. However, in most organizations,
this is unlikely to be a security issue. Those hitting this issue may
see "connection timeout", "session timeout", or "password verification
timeout" errors.  Issue observed on Xyratex FB-H8-SRAY, Intel
Windmill, Quanta Winterfell, and Wiwynn Windmill.
.LP
\fIintel20\fR - This workaround flag will work around several Intel IPMI
2.0 authentication issues. The issues covered include padding of
usernames, and password truncation if the authentication algorithm is
HMAC-MD5-128. Those hitting this issue may see "username invalid",
"password invalid", or "k_g invalid" errors. Issue observed on Intel
SE7520AF2 with Intel Server Management Module (Professional Edition).
.LP
\fIsupermicro20\fR - This workaround flag will work around several
Supermicro IPMI 2.0 authentication issues on motherboards w/ Peppercon
IPMI firmware. The issues covered include handling invalid length
authentication codes. Those hitting this issue may see "password
invalid" errors.  Issue observed on Supermicro H8QME with SIMSO
daughter card. Confirmed fixed on newerver firmware.
.LP
\fIsun20\fR - This workaround flag will work work around several Sun IPMI
2.0 authentication issues. The issues covered include invalid
lengthed hash keys, improperly hashed keys, and invalid cipher suite
records. Those hitting this issue may see "password invalid" or "bmc
error" errors.  Issue observed on Sun Fire 4100/4200/4500 with ILOM.
This workaround automatically includes the "opensesspriv" workaround.
.LP
\fIopensesspriv\fR - This workaround flag will slightly alter
FreeIPMI's IPMI 2.0 connection protocol to workaround an invalid
hashing algorithm used by the remote system. The privilege level sent
during the Open Session stage of an IPMI 2.0 connection is used for
hashing keys instead of the privilege level sent during the RAKP1
connection stage. Those hitting this issue may see "password
invalid", "k_g invalid", or "bad rmcpplus status code" errors.  Issue
observed on Sun Fire 4100/4200/4500 with ILOM, Inventec 5441/Dell
Xanadu II, Supermicro X8DTH, Supermicro X8DTG, Intel S5500WBV/Penguin
Relion 700, Intel S2600JF/Appro 512X, Quanta QSSC-S4R/Appro GB812X-CN,
and Dell C5220. This workaround is automatically triggered with the
"sun20" workaround.
.LP
\fIintegritycheckvalue\fR - This workaround flag will work around an
invalid integrity check value during an IPMI 2.0 session establishment
when using Cipher Suite ID 0. The integrity check value should be 0
length, however the remote motherboard responds with a non-empty
field. Those hitting this issue may see "k_g invalid" errors. Issue
observed on Supermicro X8DTG, Supermicro X8DTU, and Intel
S5500WBV/Penguin Relion 700, and Intel S2600JF/Appro 512X.
.LP
No IPMI 1.5 Support - Some motherboards that support IPMI 2.0 have
been found to not support IPMI 1.5. Those hitting this issue may see
"ipmi 2.0 unavailable" or "connection timeout" errors. This issue can
be worked around by using IPMI 2.0 instead of IPMI 1.5 by specifying
\fB\-\-driver\-type\fR=\fILAN_2_0\fR. Issue observed on a number of
HP and Supermicro motherboards.
.LP
\fIslowcommit\fR - This workaround will slow down commits to the BMC
by sleeping one second between the commit of sections. It works
around motherboards that have BMCs that can be overwhelmed by commits.
Those hitting this issue may see commit errors or commits not being
written to the BMC. Issue observed on Supermicro H8QME.
.LP
\fIveryslowcommit\fR - This workaround will slow down commits to the
BMC by sleeping one second between the commit of every key. It works
around motherboards that have BMCs that can be overwhelmed by commits.
Those hitting this issue may see commit errors or commits not being
written to the BMC. Issue observed on Quanta S99Q/Dell FS12-TY and
Dell PowerEdge T320.
.LP
\fIsolchannelassumelanchannel\fR - This workaround will force
.B ipmi-config
to assume that the channel used SOL is identical to the channel used
for LAN. On some motherboards, the SOL channel is reported
incorrectly, leading to incorrect configuration. Most notably, this
problem has come up when attempting to configure multiple channels.
Issue observed on Intel S5500WBV/Penguin Relion 700.
.SH "EXAMPLES"
.B # ipmi-config --checkout
.PP
Output all core configuration information to the console.
.B # ipmi-config --checkout --category=pef
.PP
Output all pef configuration information to the console.
.B # ipmi-config --checkout --category=pef,chassis
.PP
Output all pef and chassis configuration information to the console.
.PP
.B # ipmi-config --checkout --filename=bmc-data1.conf
.PP
Store all core configuration information in bmc-data1.conf.
.PP
.B # ipmi-config --diff --filename=bmc-data2.conf
.PP
Show all difference between the current configuration and the bmc-data2.conf file.
.PP
.B # ipmi-config --diff --key-pair="lan_conf_misc:gratuitous_arp_interval=8"
.PP
Show difference with the current configuration and the 'lan_conf_misc:gratuitous_arp_interval' of value '8'.
.PP
.B # ipmi-config --commit --filename=bmc-data1.conf
.PP
Commit all configuration values from the bmc-data1.conf file.
.PP
.B # ipmi-config --commit --key-pair="lan_conf_misc:gratuitous_arp_interval=4"
.PP
Commit key 'lan_conf_misc:gratuitous_arp_interval' of value '4'.
.PP
.B # ipmi-config --commit --filename=bmc-data-updt.conf --key-pair="lan_conf_misc:gratuitous_arp_interval=4"
.PP
Commit all configuration values from bmc-data-updt.conf and key 'lan_conf_misc:gratuitous_arp_interval' of value '4'.
.PP
.SH "DIAGNOSTICS"
Upon successful execution, exit status is 0. On non-fatal error, exit
status is 1. On fatal error, exit status is 2.
.LP
If multiple hosts are specified for communication, the exit status is
0 if and only if all targets successfully execute. If any non-fatal
error occurs, exit status is 1. If any fatal error occurs, exit
status is 2.
.SH "KNOWN ISSUES"
On older operating systems, if you input your username, password,
and other potentially security relevant information on the command
line, this information may be discovered by other users when using
tools like the
.B ps(1)
command or looking in the /proc file system. It is generally more
secure to input password information with options like the -P or -K
options. Configuring security relevant information in the FreeIPMI
configuration file would also be an appropriate way to hide this information.
.LP
In order to prevent brute force attacks, some BMCs will temporarily
"lock up" after a number of remote authentication errors. You may
need to wait awhile in order to this temporary "lock up" to pass
before you may authenticate again.
.SH "REPORTING BUGS"
Report bugs to <freeipmi\-users@gnu.org> or <freeipmi\-devel@gnu.org>.
.SH "COPYRIGHT"
Copyright \(co 2003-2015 FreeIPMI Core Team.
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or (at
your option) any later version.
.SH "SEE ALSO"
ipmi-config.conf(5), freeipmi(7), bmc-device(8)
.PP
http://www.gnu.org/software/freeipmi/