1IPMI-CHASSIS(8) System Commands IPMI-CHASSIS(8)
2
6 ipmi-chassis - IPMI chassis management utility
7
9 ipmi-chassis [OPTION...]
10
12 Ipmi-chassis is used for managing/monitoring an IPMI chassis, such as
13 chassis power, indentification (i.e. LED control), and status. See
14 OPTIONS below for all chassis management options available.
15 Listed below are general IPMI options, tool specific options, trouble
17 shooting information, workaround information, examples, and known
18 issues. For a general introduction to FreeIPMI please see freeipmi(7).
19 To perform IPMI chassis configuration, please see ipmi-chassis-con‐
20 fig(8). To perform some advanced chassis management, please see bmc-
21 device(8).
22
24 The following options are general options for configuring IPMI communi‐
25 cation and executing general tool commands.
26 -D, --driver-type=IPMIDRIVER
28 Specify the driver type to use instead of doing an auto selec‐
29 tion. The currently available outofband drivers are LAN and
30 LAN_2_0, which perform IPMI 1.5 and IPMI 2.0 respectively. The
31 currently available inband drivers are KCS, SSIF, OPENIPMI, and
32 SUNBMC.
33 --disable-auto-probe
35 Do not probe in-band IPMI devices for default settings.
36 --driver-address=DRIVER-ADDRESS
38 Specify the in-band driver address to be used instead of the
39 probed value. DRIVER-ADDRESS should be prefixed with "0x" for a
40 hex value and '0' for an octal value.
41 --driver-device=DEVICE
43 Specify the in-band driver device path to be used instead of the
44 probed path.
45 --register-spacing=REGISTER-SPACING
47 Specify the in-band driver register spacing instead of the
48 probed value.
49 -h, --hostname=IPMIHOST1,IPMIHOST2,...
51 Specify the remote host(s) to communicate with. Multiple host‐
52 names may be separated by comma or may be specified in a range
53 format; see HOSTRANGED SUPPORT below.
54 -u, --username=USERNAME
56 Specify the username to use when authenticating with the remote
57 host. If not specified, a null (i.e. anonymous) username is
58 assumed. The user must have atleast ADMIN privileges in order
59 for this tool to operate fully.
60 -p, --password=PASSWORD
62 Specify the password to use when authenticationg with the remote
63 host. If not specified, a null password is assumed. Maximum
64 password length is 16 for IPMI 1.5 and 20 for IPMI 2.0.
65 -P, --password-prompt
67 Prompt for password to avoid possibility of listing it in
68 process lists.
69 -k, --k-g=K_G
71 Specify the K_g BMC key to use when authenticating with the
72 remote host for IPMI 2.0. If not specified, a null key is
73 assumed. To input the key in hexadecimal form, prefix the string
74 with '0x'. E.g., the key 'abc' can be entered with the either
75 the string 'abc' or the string '0x616263'
76 -K, --k-g-prompt
78 Prompt for k-g to avoid possibility of listing it in process
79 lists.
80 --session-timeout=MILLISECONDS
82 Specify the session timeout in milliseconds. Defaults to 20000
83 milliseconds (20 seconds) if not specified.
84 --retransmission-timeout=MILLISECONDS
86 Specify the packet retransmission timeout in milliseconds.
87 Defaults to 1000 milliseconds (1 second) if not specified. The
88 retransmission timeout cannot be larger than the session time‐
89 out.
90 -a, --authentication-type=AUTHENTICATION-TYPE
92 Specify the IPMI 1.5 authentication type to use. The currently
93 available authentication types are NONE, STRAIGHT_PASSWORD_KEY,
94 MD2, and MD5. Defaults to MD5 if not specified.
95 -I, --cipher-suite-id=CIPHER-SUITE-ID
97 Specify the IPMI 2.0 cipher suite ID to use. The Cipher Suite ID
98 identifies a set of authentication, integrity, and confidential‐
99 ity algorithms to use for IPMI 2.0 communication. The authenti‐
100 cation algorithm identifies the algorithm to use for session
101 setup, the integrity algorithm identifies the algorithm to use
102 for session packet signatures, and the confidentiality algorithm
103 identifies the algorithm to use for payload encryption. Defaults
104 to cipher suite ID 3 if not specified. The following cipher
105 suite ids are currently supported:
106 0 - Authentication Algorithm = None; Integrity Algorithm = None;
108 Confidentiality Algorithm = None
109 1 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
111 None; Confidentiality Algorithm = None
112 2 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
114 HMAC-SHA1-96; Confidentiality Algorithm = None
115 3 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
117 HMAC-SHA1-96; Confidentiality Algorithm = AES-CBC-128
118 6 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
120 None; Confidentiality Algorithm = None
121 7 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
123 HMAC-MD5-128; Confidentiality Algorithm = None
124 8 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
126 HMAC-MD5-128; Confidentiality Algorithm = AES-CBC-128
127 11 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
129 MD5-128; Confidentiality Algorithm = None
130 12 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
132 MD5-128; Confidentiality Algorithm = AES-CBC-128
133 -l, --privilege-level=PRIVILEGE-LEVEL
135 Specify the privilege level to be used. The currently available
136 privilege levels are USER, OPERATOR, and ADMIN. Defaults to
137 ADMIN if not specified.
138 --config-file=FILE
140 Specify an alternate configuration file.
141 -W, --workaround-flags=WORKAROUNDS
143 Specify workarounds to vendor compliance issues. Multiple work‐
144 arounds can be specified separated by commas. See WORKAROUNDS
145 below for a list of available workarounds.
146 --debug
148 Turn on debugging.
149 -?, --help
151 Output a help list and exit.
152 --usage
154 Output a usage message and exit.
155 -V, --version
157 Output the program version and exit.
158
160 The following options are specific to Ipmi-chassis.
161 --get-chassis-capabilities
163 Get chassis capabilities. This command returns information on
164 which main chassis management functions are available.
165 --get-chassis-status
167 Get chassis status. This command returns high level status
168 information on the chassis.
169 --chassis-control=CONTROL
171 Control the chassis. This command provides power-up, power-down,
172 and reset control. Supported values: POWER-DOWN, POWER-UP,
173 POWER-CYCLE, HARD-RESET, DIAGNOSTIC-INTERRUPT, SOFT-SHUTDOWN.
174 --chassis-identify=IDENTIFY
176 Set chassis identification. This command controls physical sys‐
177 tem identification, typically a LED. Supported values: TURN-OFF
178 to turn off identification, <interval> to turn on identification
179 for "interval" seconds, FORCE to turn on indefinitely.
180 --get-system-restart-cause
182 Get system restart cause.
183 --get-power-on-hours-counter
185 Get power on hours (POH) counter.
186
188 The following options manipulate hostranged output. See HOSTRANGED SUP‐
189 PORT below for additional information on hostranges.
190 -B, --buffer-output
192 Buffer hostranged output. For each node, buffer standard output
193 until the node has completed its IPMI operation. When specifying
194 this option, data may appear to output slower to the user since
195 the the entire IPMI operation must complete before any data can
196 be output. See HOSTRANGED SUPPORT below for additional informa‐
197 tion.
198 -C, --consolidate-output
200 Consolidate hostranged output. The complete standard output from
201 every node specified will be consolidated so that nodes with
202 identical output are not output twice. A header will list those
203 nodes with the consolidated output. When this option is speci‐
204 fied, no output can be seen until the IPMI operations to all
205 nodes has completed. If the user breaks out of the program
206 early, all currently consolidated output will be dumped. See
207 HOSTRANGED SUPPORT below for additional information.
208 -F, --fanout
210 Specify multiple host fanout. A "sliding window" (or fanout)
211 algorithm is used for parallel IPMI communication so that slower
212 nodes or timed out nodes will not impede parallel communication.
213 The maximum number of threads available at the same time is lim‐
214 ited by the fanout. The default is 64.
215 -E, --eliminate
217 Eliminate hosts determined as undetected by ipmidetect. This
218 attempts to remove the common issue of hostranged execution tim‐
219 ing out due to several nodes being removed from service in a
220 large cluster. The ipmidetectd daemon must be running on the
221 node executing the command.
222 --always-prefix
224 Always prefix output, even if only one host is specified or com‐
225 municating in-band. This option is primarily useful for script‐
226 ing purposes. Option will be ignored if specified with the -C
227 option.
228
230 Multiple hosts can be input either as an explicit comma separated lists
231 of hosts or a range of hostnames in the general form: prefix[n-m,l-
232 k,...], where n < m and l < k, etc. The later form should not be con‐
233 fused with regular expression character classes (also denoted by []).
234 For example, foo[19] does not represent foo1 or foo9, but rather repre‐
235 sents a degenerate range: foo19.
236 This range syntax is meant only as a convenience on clusters with a
238 prefixNN naming convention and specification of ranges should not be
239 considered necessary -- the list foo1,foo9 could be specified as such,
240 or by the range foo[1,9].
241 Some examples of range usage follow:
243 foo[01-05] instead of foo01,foo02,foo03,foo04,foo05
244 foo[7,9-10] instead of foo7,foo9,foo10
245 foo[0-3] instead of foo0,foo1,foo2,foo3
246 As a reminder to the reader, some shells will interpret brackets ([ and
248 ]) for pattern matching. Depending on your shell, it may be necessary
249 to enclose ranged lists within quotes.
250 When multiple hosts are specified by the user, a thread will be exe‐
252 cuted for each host in parallel up to the configured fanout (which can
253 be adjusted via the -F option). This will allow communication to large
254 numbers of nodes far more quickly than if done in serial.
255 By default, standard output from each node specified will be output
257 with the hostname prepended to each line. Although this output is read‐
258 able in many situations, it may be difficult to read in other situa‐
259 tions. For example, output from multiple nodes may be mixed together.
260 The -B and -C options can be used to change this default.
261 In-band IPMI Communication will be used when the host "localhost" is
263 specified. This allows the user to add the localhost into the hos‐
264 tranged output.
265
267 Most often, IPMI problems are due to configuration problems. Inband
268 IPMI problems are typically caused by improperly configured drivers or
269 non-standard BMCs. IPMI over LAN problems involve a misconfiguration of
270 the remote machine's BMC. Double check to make sure the following are
271 configured properly in the remote machine's BMC: IP address, MAC
272 address, subnet mask, username, user enablement, user privilege, pass‐
273 word, LAN privilege, LAN enablement, and allowed authentication
274 type(s). For IPMI 2.0 connections, double check to make sure the cipher
275 suite privilege(s) and K_g key are configured properly. The bmc-con‐
276 fig(8) tool can be used to check and/or change these configuration set‐
277 tings.
278 The following are common issues for given error messages:
280 "username invalid" - The username entered (or a NULL username if none
282 was entered) is not available on the remote machine. It may also be
283 possible the remote BMC's username configuration is incorrect.
284 "password invalid" - The password entered (or a NULL password if none
286 was entered) is not correct. It may also be possible the password for
287 the user is not correctly configured on the remote BMC.
288 "password verification timeout" - Password verification has timed out.
290 A "password invalid" error (described above) or a generic "session
291 timeout" (described below) occurred. During this point in the protocol
292 it cannot be differentiated which occurred.
293 "k_g invalid" - The K_g key entered (or a NULL K_g key if none was
295 entered) is not correct. It may also be possible the K_g key is not
296 correctly configured on the remote BMC.
297 "privilege level insufficient" - An IPMI command requires a higher user
299 privilege than the one authenticated with. Please try to authenticate
300 with a higher privilege. This may require authenticating to a different
301 user which has a higher maximum privilege.
302 "privilege level cannot be obtained for this user" - The privilege
304 level you are attempting to authenticate with is higher than the maxi‐
305 mum allowed for this user. Please try again with a lower privilege. It
306 may also be possible the maximum privilege level allowed for a user is
307 not configured properly on the remote BMC.
308 "authentication type unavailable for attempted privilege level" - The
310 authentication type you wish to authenticate with is not available for
311 this privilege level. Please try again with an alternate authentication
312 type or alternate privilege level. It may also be possible the avail‐
313 able authentication types you can authenticate with are not correctly
314 configured on the remote BMC.
315 "cipher suite id unavailable" - The cipher suite id you wish to authen‐
317 ticate with is not available on the remote BMC. Please try again with
318 an alternate cipher suite id. It may also be possible the available
319 cipher suite ids are not correctly configured on the remote BMC.
320 "ipmi 2.0 unavailable" - IPMI 2.0 was not discovered on the remote
322 machine. Please try to use IPMI 1.5 instead.
323 "connection timeout" - Initial IPMI communication failed. A number of
325 potential errors are possible, including an invalid hostname specified,
326 an IPMI IP address cannot be resolved, IPMI is not enabled on the
327 remote server, the network connection is bad, etc. Please verify con‐
328 figuration and connectivity.
329 "session timeout" - The IPMI session has timed out. Please reconnect.
331 If this error occurs often, you may wish to increase the retransmission
332 timeout. Some remote BMCs are considerably slower than others.
333 "device not found" - The specified device could not be found. Please
335 check configuration or inputs and try again.
336 "driver timeout" - Communication with the driver or device has timed
338 out. Please try again.
339 "message timeout" - Communication with the driver or device has timed
341 out. Please try again.
342 "BMC busy" - The BMC is currently busy. It may be processing informa‐
344 tion or have too many simultaneous sessions to manage. Please wait and
345 try again.
346 "could not find inband device" - An inband device could not be found.
348 Please check configuration or specify specific device or driver on the
349 command line.
350 Please see WORKAROUNDS below to also if there are any vendor specific
352 bugs that have been discovered and worked around.
353
355 With so many different vendors implementing their own IPMI solutions,
356 different vendors may implement their IPMI protocols incorrectly. The
357 following lists the workarounds currently available to handle discov‐
358 ered compliance issues.
359 When possible, workarounds have been implemented so they will be trans‐
361 parent to the user. However, some will require the user to specify a
362 workaround be used via the -W option.
363 The hardware listed below may only indicate the hardware that a problem
365 was discovered on. Newer versions of hardware may fix the problems
366 indicated below. Similar machines from vendors may or may not exhibit
367 the same problems. Different vendors may license their firmware from
368 the same IPMI firmware developer, so it may be worthwhile to try work‐
369 arounds listed below even if your motherboard is not listed.
370 "idzero" - This workaround option will allow empty session IDs to be
372 accepted by the client. It works around IPMI sessions that report empty
373 session IDs to the client. Those hitting this issue may see "session
374 timeout" errors. Issue observed on Tyan S2882 with M3289 BMC.
375 "unexpectedauth" - This workaround option will allow unexpected non-
377 null authcodes to be checked as though they were expected. It works
378 around an issue when packets contain non-null authentication data when
379 they should be null due to disabled per-message authentication. Those
380 hitting this issue may see "session timeout" errors. Issue observed on
381 Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.
382 "forcepermsg" - This workaround option will force per-message authenti‐
384 cation to be used no matter what is advertised by the remote system. It
385 works around an issue when per-message authentication is advertised as
386 disabled on the remote system, but it is actually required for the pro‐
387 tocol. Those hitting this issue may see "session timeout" errors.
388 Issue observed on IBM eServer 325.
389 "endianseq" - This workaround option will flip the endian of the ses‐
391 sion sequence numbers to allow the session to continue properly. It
392 works around IPMI 1.5 session sequence numbers that are the wrong
393 endian. Those hitting this issue may see "session timeout" errors.
394 Issue observed on some Sun ILOM 1.0/2.0 (depends on service processor
395 endian).
396 "authcap" - This workaround option will skip early checks for username
398 capabilities, authentication capabilities, and K_g support and allow
399 IPMI authentication to succeed. It works around multiple issues in
400 which the remote system does not properly report username capabilities,
401 authentication capabilities, or K_g status. Those hitting this issue
402 may see "username invalid", "authentication type unavailable for
403 attempted privilege level", or "k_g invalid" errors. Issue observed on
404 Asus P5M2/P5MT-R/RS162-E4/RX4, Intel SR1520ML/X38ML, and Sun Fire
405 2200/4150/4450 with ELOM.
406 "intel20" - This workaround option will work around several Intel IPMI
408 2.0 authentication issues. The issues covered include padding of user‐
409 names, automatic acceptance of a RAKP 4 response integrity check when
410 using the integrity algorithm MD5-128, and password truncation if the
411 authentication algorithm is HMAC-MD5-128. Those hitting this issue may
412 see "username invalid", "password invalid", or "k_g invalid" errors.
413 Issue observed on Intel SE7520AF2 with Intel Server Management Module
414 (Professional Edition).
415 "supermicro20" - This workaround option will work around several Super‐
417 micro IPMI 2.0 authentication issues on motherboards w/ Peppercon IPMI
418 firmware. The issues covered include handling invalid length authenti‐
419 cation codes. Those hitting this issue may see "password invalid"
420 errors. Issue observed on Supermicro H8QME with SIMSO daughter card.
421 Confirmed fixed on newerver firmware.
422 "sun20" - This workaround option will work work around several Sun IPMI
424 2.0 authentication issues. The issues covered include invalid lengthed
425 hash keys, improperly hashed keys, and invalid cipher suite records.
426 Those hitting this issue may see "password invalid" or "bmc error"
427 errors. Issue observed on Sun Fire 4100/4200/4500 with ILOM. This
428 workaround automatically includes the "opensesspriv" workaround.
429 "opensesspriv" - This workaround option will slightly alter FreeIPMI's
431 IPMI 2.0 connection protocol to workaround an invalid hashing algorithm
432 used by the remote system. The privilege level sent during the Open
433 Session stage of an IPMI 2.0 connection is sometimes invalid and used
434 for hashing keys instead of the privilege level sent during the RAKP1
435 connection stage. Those hitting this issue may see "password invalid",
436 "k_g invalid", "bad rmcpplus status code", or "privilege level cannot
437 be obtained for this user " errors. Issue observed on Sun Fire
438 4100/4200/4500 with ILOM, Inventec 5441/Dell Xanadu II, Supermicro
439 X8DTH, Supermicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin
440 Relion 700. This workaround is automatically triggered with the "sun20"
441 workaround.
442 "integritycheckvalue" - This workaround option will work around an
444 invalid integrity check value during an IPMI 2.0 session establishment
445 when using Cipher Suite ID 0. The integrity check value should be 0
446 length, however the remote motherboard responds with a non-empty field.
447 Those hitting this issue may see "k_g invalid" errors. Issue observed
448 on Supermicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin
449 Relion 700.
450
452 # ipmi-chassis --get-status
453 Get the chassis status of the local machine.
455 # ipmi-chassis -h ahost -u myusername -p mypassword --get-status
457 Get the chassis status of a remote machine using IPMI over LAN.
459 # ipmi-chassis -h mycluster[0-127] -u myusername -p mypassword --get-
461 status
462 Get the chassis status across a cluster using IPMI over LAN.
464 # ipmi-chassis -h ahost -u myusername -p mypassword --chassis-con‐
466 trol=POWER-ON
467 Power on a remote machine using IPMI over LAN.
469
471 On older operating systems, if you input your username, password, and
472 other potentially security relevant information on the command line,
473 this information may be discovered by other users when using tools like
474 the ps(1) command or looking in the /proc file system. It is generally
475 more secure to input password information with options like the -P or
476 -K options. Configuring security relevant information in the FreeIPMI
477 configuration file would also be an appropriate way to hide this infor‐
478 mation.
479 In order to prevent brute force attacks, some BMCs will temporarily
481 "lock up" after a number of remote authentication errors. You may need
482 to wait awhile in order to this temporary "lock up" to pass before you
483 may authenticate again.
484
486 Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
487
489 Copyright © 2007-2010 FreeIPMI Core Team
490 This program is free software; you can redistribute it and/or modify it
492 under the terms of the GNU General Public License as published by the
493 Free Software Foundation; either version 2 of the License, or (at your
494 option) any later version.
495
497 freeipmi(7), bmc-config(8), bmc-device(8), ipmi-chassis-config(8)
498 http://www.gnu.org/software/freeipmi/
500ipmi-chassis 0.8.8 2010-07-21 IPMI-CHASSIS(8)