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). For a more powerful chassis power control utility, please
22 see ipmipower(8).
23
25 The following options are general options for configuring IPMI communi‐
26 cation and executing general tool commands.
27 -D IPMIDRIVER, --driver-type=IPMIDRIVER
29 Specify the driver type to use instead of doing an auto selec‐
30 tion. The currently available outofband drivers are LAN and
31 LAN_2_0, which perform IPMI 1.5 and IPMI 2.0 respectively. The
32 currently available inband drivers are KCS, SSIF, OPENIPMI, and
33 SUNBMC.
34 --disable-auto-probe
36 Do not probe in-band IPMI devices for default settings.
37 --driver-address=DRIVER-ADDRESS
39 Specify the in-band driver address to be used instead of the
40 probed value. DRIVER-ADDRESS should be prefixed with "0x" for a
41 hex value and '0' for an octal value.
42 --driver-device=DEVICE
44 Specify the in-band driver device path to be used instead of the
45 probed path.
46 --register-spacing=REGISTER-SPACING
48 Specify the in-band driver register spacing instead of the
49 probed value. Argument is in bytes (i.e. 32bit register spacing
50 = 4)
51 --target-channel-number=CHANNEL-NUMBER
53 Specify the in-band driver target channel number to send IPMI
54 requests to.
55 --target-slave-address=SLAVE-ADDRESS
57 Specify the in-band driver target slave number to send IPMI
58 requests to.
59 -h IPMIHOST1,IPMIHOST2,..., --hostname=IPMIHOST1[:PORT],IPMI‐
61 HOST2[:PORT],...
62 Specify the remote host(s) to communicate with. Multiple host‐
63 names may be separated by comma or may be specified in a range
64 format; see HOSTRANGED SUPPORT below. An optional port can be
65 specified with each host, which may be useful in port forwarding
66 or similar situations.
67 -u USERNAME, --username=USERNAME
69 Specify the username to use when authenticating with the remote
70 host. If not specified, a null (i.e. anonymous) username is
71 assumed. The user must have atleast ADMIN privileges in order
72 for this tool to operate fully.
73 -p PASSWORD, --password=PASSWORD
75 Specify the password to use when authenticationg with the remote
76 host. If not specified, a null password is assumed. Maximum
77 password length is 16 for IPMI 1.5 and 20 for IPMI 2.0.
78 -P, --password-prompt
80 Prompt for password to avoid possibility of listing it in
81 process lists.
82 -k K_G, --k-g=K_G
84 Specify the K_g BMC key to use when authenticating with the
85 remote host for IPMI 2.0. If not specified, a null key is
86 assumed. To input the key in hexadecimal form, prefix the string
87 with '0x'. E.g., the key 'abc' can be entered with the either
88 the string 'abc' or the string '0x616263'
89 -K, --k-g-prompt
91 Prompt for k-g to avoid possibility of listing it in process
92 lists.
93 --session-timeout=MILLISECONDS
95 Specify the session timeout in milliseconds. Defaults to 20000
96 milliseconds (20 seconds) if not specified.
97 --retransmission-timeout=MILLISECONDS
99 Specify the packet retransmission timeout in milliseconds.
100 Defaults to 1000 milliseconds (1 second) if not specified. The
101 retransmission timeout cannot be larger than the session time‐
102 out.
103 -a AUTHENTICATION-TYPE, --authentication-type=AUTHENTICATION-TYPE
105 Specify the IPMI 1.5 authentication type to use. The currently
106 available authentication types are NONE, STRAIGHT_PASSWORD_KEY,
107 MD2, and MD5. Defaults to MD5 if not specified.
108 -I CIPHER-SUITE-ID, --cipher-suite-id=CIPHER-SUITE-ID
110 Specify the IPMI 2.0 cipher suite ID to use. The Cipher Suite ID
111 identifies a set of authentication, integrity, and confidential‐
112 ity algorithms to use for IPMI 2.0 communication. The authenti‐
113 cation algorithm identifies the algorithm to use for session
114 setup, the integrity algorithm identifies the algorithm to use
115 for session packet signatures, and the confidentiality algorithm
116 identifies the algorithm to use for payload encryption. Defaults
117 to cipher suite ID 3 if not specified. The following cipher
118 suite ids are currently supported:
119 0 - Authentication Algorithm = None; Integrity Algorithm = None;
121 Confidentiality Algorithm = None
122 1 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
124 None; Confidentiality Algorithm = None
125 2 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
127 HMAC-SHA1-96; Confidentiality Algorithm = None
128 3 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm =
130 HMAC-SHA1-96; Confidentiality Algorithm = AES-CBC-128
131 6 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
133 None; Confidentiality Algorithm = None
134 7 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
136 HMAC-MD5-128; Confidentiality Algorithm = None
137 8 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
139 HMAC-MD5-128; Confidentiality Algorithm = AES-CBC-128
140 11 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
142 MD5-128; Confidentiality Algorithm = None
143 12 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm =
145 MD5-128; Confidentiality Algorithm = AES-CBC-128
146 15 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
148 = None; Confidentiality Algorithm = None
149 16 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
151 = HMAC_SHA256_128; Confidentiality Algorithm = None
152 17 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm
154 = HMAC_SHA256_128; Confidentiality Algorithm = AES-CBC-128
155 -l PRIVILEGE-LEVEL, --privilege-level=PRIVILEGE-LEVEL
157 Specify the privilege level to be used. The currently available
158 privilege levels are USER, OPERATOR, and ADMIN. Defaults to
159 ADMIN if not specified.
160 --config-file=FILE
162 Specify an alternate configuration file.
163 -W WORKAROUNDS, --workaround-flags=WORKAROUNDS
165 Specify workarounds to vendor compliance issues. Multiple work‐
166 arounds can be specified separated by commas. A special command
167 line flag of "none", will indicate no workarounds (may be useful
168 for overriding configured defaults). See WORKAROUNDS below for a
169 list of available workarounds.
170 --debug
172 Turn on debugging.
173 -?, --help
175 Output a help list and exit.
176 --usage
178 Output a usage message and exit.
179 -V, --version
181 Output the program version and exit.
182
184 The following options are specific to Ipmi-chassis.
185 -c, --get-capabilities, --get-chassis-capabilities
187 Get chassis capabilities. This command returns information on
188 which main chassis management functions are available.
189 -s, --get-status, --get-chassis-status
191 Get chassis status. This command returns high level status
192 information on the chassis.
193 -O, --chassis-control=CONTROL
195 Control the chassis. This command provides power-up, power-down,
196 and reset control. Supported values: POWER-DOWN, POWER-UP,
197 POWER-CYCLE, HARD-RESET, DIAGNOSTIC-INTERRUPT, SOFT-SHUTDOWN.
198 -i, --chassis-identify=IDENTIFY
200 Set chassis identification. This command controls physical sys‐
201 tem identification, typically a LED. Supported values: TURN-OFF
202 to turn off identification, <interval> to turn on identification
203 for "interval" seconds, FORCE to turn on indefinitely.
204 -R, --get-system-restart-cause
206 Get system restart cause.
207 -H, --get-power-on-hours-counter
209 Get power on hours (POH) counter.
210
212 The following options manipulate hostranged output. See HOSTRANGED SUP‐
213 PORT below for additional information on hostranges.
214 -B, --buffer-output
216 Buffer hostranged output. For each node, buffer standard output
217 until the node has completed its IPMI operation. When specifying
218 this option, data may appear to output slower to the user since
219 the the entire IPMI operation must complete before any data can
220 be output. See HOSTRANGED SUPPORT below for additional informa‐
221 tion.
222 -C, --consolidate-output
224 Consolidate hostranged output. The complete standard output from
225 every node specified will be consolidated so that nodes with
226 identical output are not output twice. A header will list those
227 nodes with the consolidated output. When this option is speci‐
228 fied, no output can be seen until the IPMI operations to all
229 nodes has completed. If the user breaks out of the program
230 early, all currently consolidated output will be dumped. See
231 HOSTRANGED SUPPORT below for additional information.
232 -F NUM, --fanout=NUM
234 Specify multiple host fanout. A "sliding window" (or fanout)
235 algorithm is used for parallel IPMI communication so that slower
236 nodes or timed out nodes will not impede parallel communication.
237 The maximum number of threads available at the same time is lim‐
238 ited by the fanout. The default is 64.
239 -E, --eliminate
241 Eliminate hosts determined as undetected by ipmidetect. This
242 attempts to remove the common issue of hostranged execution tim‐
243 ing out due to several nodes being removed from service in a
244 large cluster. The ipmidetectd daemon must be running on the
245 node executing the command.
246 --always-prefix
248 Always prefix output, even if only one host is specified or com‐
249 municating in-band. This option is primarily useful for script‐
250 ing purposes. Option will be ignored if specified with the -C
251 option.
252
254 Multiple hosts can be input either as an explicit comma separated lists
255 of hosts or a range of hostnames in the general form: prefix[n-m,l-
256 k,...], where n < m and l < k, etc. The later form should not be con‐
257 fused with regular expression character classes (also denoted by []).
258 For example, foo[19] does not represent foo1 or foo9, but rather repre‐
259 sents a degenerate range: foo19.
260 This range syntax is meant only as a convenience on clusters with a
262 prefixNN naming convention and specification of ranges should not be
263 considered necessary -- the list foo1,foo9 could be specified as such,
264 or by the range foo[1,9].
265 Some examples of range usage follow:
267 foo[01-05] instead of foo01,foo02,foo03,foo04,foo05
268 foo[7,9-10] instead of foo7,foo9,foo10
269 foo[0-3] instead of foo0,foo1,foo2,foo3
270 As a reminder to the reader, some shells will interpret brackets ([ and
272 ]) for pattern matching. Depending on your shell, it may be necessary
273 to enclose ranged lists within quotes.
274 When multiple hosts are specified by the user, a thread will be exe‐
276 cuted for each host in parallel up to the configured fanout (which can
277 be adjusted via the -F option). This will allow communication to large
278 numbers of nodes far more quickly than if done in serial.
279 By default, standard output from each node specified will be output
281 with the hostname prepended to each line. Although this output is read‐
282 able in many situations, it may be difficult to read in other situa‐
283 tions. For example, output from multiple nodes may be mixed together.
284 The -B and -C options can be used to change this default.
285 In-band IPMI Communication will be used when the host "localhost" is
287 specified. This allows the user to add the localhost into the hos‐
288 tranged output.
289
291 Most often, IPMI problems are due to configuration problems.
292 IPMI over LAN problems involve a misconfiguration of the remote
294 machine's BMC. Double check to make sure the following are configured
295 properly in the remote machine's BMC: IP address, MAC address, subnet
296 mask, username, user enablement, user privilege, password, LAN privi‐
297 lege, LAN enablement, and allowed authentication type(s). For IPMI 2.0
298 connections, double check to make sure the cipher suite privilege(s)
299 and K_g key are configured properly. The bmc-config(8) tool can be used
300 to check and/or change these configuration settings.
301 Inband IPMI problems are typically caused by improperly configured
303 drivers or non-standard BMCs.
304 In addition to the troubleshooting tips below, please see WORKAROUNDS
306 below to also if there are any vendor specific bugs that have been dis‐
307 covered and worked around.
308 Listed below are many of the common issues for error messages. For
310 additional support, please e-mail the <freeipmi-users@gnu.org> mailing
311 list.
312 "username invalid" - The username entered (or a NULL username if none
314 was entered) is not available on the remote machine. It may also be
315 possible the remote BMC's username configuration is incorrect.
316 "password invalid" - The password entered (or a NULL password if none
318 was entered) is not correct. It may also be possible the password for
319 the user is not correctly configured on the remote BMC.
320 "password verification timeout" - Password verification has timed out.
322 A "password invalid" error (described above) or a generic "session
323 timeout" (described below) occurred. During this point in the protocol
324 it cannot be differentiated which occurred.
325 "k_g invalid" - The K_g key entered (or a NULL K_g key if none was
327 entered) is not correct. It may also be possible the K_g key is not
328 correctly configured on the remote BMC.
329 "privilege level insufficient" - An IPMI command requires a higher user
331 privilege than the one authenticated with. Please try to authenticate
332 with a higher privilege. This may require authenticating to a different
333 user which has a higher maximum privilege.
334 "privilege level cannot be obtained for this user" - The privilege
336 level you are attempting to authenticate with is higher than the maxi‐
337 mum allowed for this user. Please try again with a lower privilege. It
338 may also be possible the maximum privilege level allowed for a user is
339 not configured properly on the remote BMC.
340 "authentication type unavailable for attempted privilege level" - The
342 authentication type you wish to authenticate with is not available for
343 this privilege level. Please try again with an alternate authentication
344 type or alternate privilege level. It may also be possible the avail‐
345 able authentication types you can authenticate with are not correctly
346 configured on the remote BMC.
347 "cipher suite id unavailable" - The cipher suite id you wish to authen‐
349 ticate with is not available on the remote BMC. Please try again with
350 an alternate cipher suite id. It may also be possible the available
351 cipher suite ids are not correctly configured on the remote BMC.
352 "ipmi 2.0 unavailable" - IPMI 2.0 was not discovered on the remote
354 machine. Please try to use IPMI 1.5 instead.
355 "connection timeout" - Initial IPMI communication failed. A number of
357 potential errors are possible, including an invalid hostname specified,
358 an IPMI IP address cannot be resolved, IPMI is not enabled on the
359 remote server, the network connection is bad, etc. Please verify con‐
360 figuration and connectivity.
361 "session timeout" - The IPMI session has timed out. Please reconnect.
363 If this error occurs often, you may wish to increase the retransmission
364 timeout. Some remote BMCs are considerably slower than others.
365 "device not found" - The specified device could not be found. Please
367 check configuration or inputs and try again.
368 "driver timeout" - Communication with the driver or device has timed
370 out. Please try again.
371 "message timeout" - Communication with the driver or device has timed
373 out. Please try again.
374 "BMC busy" - The BMC is currently busy. It may be processing informa‐
376 tion or have too many simultaneous sessions to manage. Please wait and
377 try again.
378 "could not find inband device" - An inband device could not be found.
380 Please check configuration or specify specific device or driver on the
381 command line.
382 "driver timeout" - The inband driver has timed out communicating to the
384 local BMC or service processor. The BMC or service processor may be
385 busy or (worst case) possibly non-functioning.
386
388 With so many different vendors implementing their own IPMI solutions,
389 different vendors may implement their IPMI protocols incorrectly. The
390 following describes a number of workarounds currently available to han‐
391 dle discovered compliance issues. When possible, workarounds have been
392 implemented so they will be transparent to the user. However, some will
393 require the user to specify a workaround be used via the -W option.
394 The hardware listed below may only indicate the hardware that a problem
396 was discovered on. Newer versions of hardware may fix the problems
397 indicated below. Similar machines from vendors may or may not exhibit
398 the same problems. Different vendors may license their firmware from
399 the same IPMI firmware developer, so it may be worthwhile to try work‐
400 arounds listed below even if your motherboard is not listed.
401 If you believe your hardware has an additional compliance issue that
403 needs a workaround to be implemented, please contact the FreeIPMI main‐
404 tainers on <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
405 assumeio - This workaround flag will assume inband interfaces communi‐
407 cate with system I/O rather than being memory-mapped. This will work
408 around systems that report invalid base addresses. Those hitting this
409 issue may see "device not supported" or "could not find inband device"
410 errors. Issue observed on HP ProLiant DL145 G1.
411 spinpoll - This workaround flag will inform some inband drivers (most
413 notably the KCS driver) to spin while polling rather than putting the
414 process to sleep. This may significantly improve the wall clock running
415 time of tools because an operating system scheduler's granularity may
416 be much larger than the time it takes to perform a single IPMI message
417 transaction. However, by spinning, your system may be performing less
418 useful work by not contexting out the tool for a more useful task.
419 authcap - This workaround flag will skip early checks for username
421 capabilities, authentication capabilities, and K_g support and allow
422 IPMI authentication to succeed. It works around multiple issues in
423 which the remote system does not properly report username capabilities,
424 authentication capabilities, or K_g status. Those hitting this issue
425 may see "username invalid", "authentication type unavailable for
426 attempted privilege level", or "k_g invalid" errors. Issue observed on
427 Asus P5M2/P5MT-R/RS162-E4/RX4, Intel SR1520ML/X38ML, and Sun Fire
428 2200/4150/4450 with ELOM.
429 idzero - This workaround flag will allow empty session IDs to be
431 accepted by the client. It works around IPMI sessions that report empty
432 session IDs to the client. Those hitting this issue may see "session
433 timeout" errors. Issue observed on Tyan S2882 with M3289 BMC.
434 unexpectedauth - This workaround flag will allow unexpected non-null
436 authcodes to be checked as though they were expected. It works around
437 an issue when packets contain non-null authentication data when they
438 should be null due to disabled per-message authentication. Those hit‐
439 ting this issue may see "session timeout" errors. Issue observed on
440 Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.
441 forcepermsg - This workaround flag will force per-message authentica‐
443 tion to be used no matter what is advertised by the remote system. It
444 works around an issue when per-message authentication is advertised as
445 disabled on the remote system, but it is actually required for the pro‐
446 tocol. Those hitting this issue may see "session timeout" errors.
447 Issue observed on IBM eServer 325.
448 endianseq - This workaround flag will flip the endian of the session
450 sequence numbers to allow the session to continue properly. It works
451 around IPMI 1.5 session sequence numbers that are the wrong endian.
452 Those hitting this issue may see "session timeout" errors. Issue
453 observed on some Sun ILOM 1.0/2.0 (depends on service processor
454 endian).
455 noauthcodecheck - This workaround flag will tell FreeIPMI to not check
457 the authentication codes returned from IPMI 1.5 command responses. It
458 works around systems to return invalid authentication codes due to
459 hashing or implementation errors. Users are cautioned on the use of
460 this option, as it removes an authentication check verifying the valid‐
461 ity of a packet. However, in most organizations, this is unlikely to be
462 a security issue. Those hitting this issue may see "connection time‐
463 out", "session timeout", or "password verification timeout" errors.
464 Issue observed on Xyratex FB-H8-SRAY.
465 intel20 - This workaround flag will work around several Intel IPMI 2.0
467 authentication issues. The issues covered include padding of usernames,
468 and password truncation if the authentication algorithm is HMAC-
469 MD5-128. Those hitting this issue may see "username invalid", "password
470 invalid", or "k_g invalid" errors. Issue observed on Intel SE7520AF2
471 with Intel Server Management Module (Professional Edition).
472 supermicro20 - This workaround flag will work around several Supermicro
474 IPMI 2.0 authentication issues on motherboards w/ Peppercon IPMI
475 firmware. The issues covered include handling invalid length authenti‐
476 cation codes. Those hitting this issue may see "password invalid"
477 errors. Issue observed on Supermicro H8QME with SIMSO daughter card.
478 Confirmed fixed on newerver firmware.
479 sun20 - This workaround flag will work work around several Sun IPMI 2.0
481 authentication issues. The issues covered include invalid lengthed hash
482 keys, improperly hashed keys, and invalid cipher suite records. Those
483 hitting this issue may see "password invalid" or "bmc error" errors.
484 Issue observed on Sun Fire 4100/4200/4500 with ILOM. This workaround
485 automatically includes the "opensesspriv" workaround.
486 opensesspriv - This workaround flag will slightly alter FreeIPMI's IPMI
488 2.0 connection protocol to workaround an invalid hashing algorithm used
489 by the remote system. The privilege level sent during the Open Session
490 stage of an IPMI 2.0 connection is used for hashing keys instead of the
491 privilege level sent during the RAKP1 connection stage. Those hitting
492 this issue may see "password invalid", "k_g invalid", or "bad rmcpplus
493 status code" errors. Issue observed on Sun Fire 4100/4200/4500 with
494 ILOM, Inventec 5441/Dell Xanadu II, Supermicro X8DTH, Supermicro X8DTG,
495 Intel S5500WBV/Penguin Relion 700, Intel S2600JF/Appro 512X, and Quanta
496 QSSC-S4R//Appro GB812X-CN. This workaround is automatically triggered
497 with the "sun20" workaround.
498 integritycheckvalue - This workaround flag will work around an invalid
500 integrity check value during an IPMI 2.0 session establishment when
501 using Cipher Suite ID 0. The integrity check value should be 0 length,
502 however the remote motherboard responds with a non-empty field. Those
503 hitting this issue may see "k_g invalid" errors. Issue observed on
504 Supermicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin Relion
505 700, and Intel S2600JF/Appro 512X.
506 No IPMI 1.5 Support - Some motherboards that support IPMI 2.0 have been
508 found to not support IPMI 1.5. Those hitting this issue may see "ipmi
509 2.0 unavailable" or "connection timeout" errors. This issue can be
510 worked around by using IPMI 2.0 instead of IPMI 1.5 by specifying
511 --driver-address=LAN_2_0. Issue observed on HP Proliant DL 145.
512
514 # ipmi-chassis --get-status
515 Get the chassis status of the local machine.
517 # ipmi-chassis -h ahost -u myusername -p mypassword --get-status
519 Get the chassis status of a remote machine using IPMI over LAN.
521 # ipmi-chassis -h mycluster[0-127] -u myusername -p mypassword --get-
523 status
524 Get the chassis status across a cluster using IPMI over LAN.
526 # ipmi-chassis -h ahost -u myusername -p mypassword --chassis-con‐
528 trol=POWER-UP
529 Power on a remote machine using IPMI over LAN.
531
533 Upon successful execution, exit status is 0. On error, exit status is
534 1.
535 If multiple hosts are specified for communication, the exit status is 0
537 if and only if all targets successfully execute. Otherwise the exit
538 status is 1.
539
541 On older operating systems, if you input your username, password, and
542 other potentially security relevant information on the command line,
543 this information may be discovered by other users when using tools like
544 the ps(1) command or looking in the /proc file system. It is generally
545 more secure to input password information with options like the -P or
546 -K options. Configuring security relevant information in the FreeIPMI
547 configuration file would also be an appropriate way to hide this infor‐
548 mation.
549 In order to prevent brute force attacks, some BMCs will temporarily
551 "lock up" after a number of remote authentication errors. You may need
552 to wait awhile in order to this temporary "lock up" to pass before you
553 may authenticate again.
554
556 Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
557
559 Copyright © 2007-2012 FreeIPMI Core Team
560 This program is free software; you can redistribute it and/or modify it
562 under the terms of the GNU General Public License as published by the
563 Free Software Foundation; either version 3 of the License, or (at your
564 option) any later version.
565
567 freeipmi(7), bmc-config(8), bmc-device(8), ipmi-chassis-config(8),
568 ipmipower(8)
569 http://www.gnu.org/software/freeipmi/
571ipmi-chassis 1.2.1 2017-03-22 IPMI-CHASSIS(8)