1 '\" |
|
2 .\" |
|
3 .\" CDDL HEADER START |
|
4 .\" |
|
5 .\" The contents of this file are subject to the terms of the |
|
6 .\" Common Development and Distribution License (the "License"). |
|
7 .\" You may not use this file except in compliance with the License. |
|
8 .\" |
|
9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE |
|
10 .\" or http://www.opensolaris.org/os/licensing. |
|
11 .\" See the License for the specific language governing permissions |
|
12 .\" and limitations under the License. |
|
13 .\" |
|
14 .\" When distributing Covered Code, include this CDDL HEADER in each |
|
15 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE. |
|
16 .\" If applicable, add the following below this CDDL HEADER, with the |
|
17 .\" fields enclosed by brackets "[]" replaced with your own identifying |
|
18 .\" information: Portions Copyright [yyyy] [name of copyright owner] |
|
19 .\" |
|
20 .\" CDDL HEADER END |
|
21 .\" |
|
22 .\" Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved. |
|
23 .\" |
|
24 .TH ipmitool 1m "07 November 2011" |
|
25 .SH NAME |
|
26 ipmitool \- utility for controlling IPMI\-enabled devices |
|
27 .SH "SYNOPSIS" |
|
28 ipmitool [\-c|\-h|\-d N|\-v|\-V] \-I bmc [-S <sdrcache>] <command> |
|
29 |
|
30 ipmitool [\-c|\-h|\-v|\-V] |
|
31 \-I lan \-H <hostname> |
|
32 [\-p <port>] |
|
33 [\-U <username>] |
|
34 [\-A <authtype>] |
|
35 [\-L <privlvl>] |
|
36 [\-a|\-E|\-P|\-f <password>] |
|
37 [\-o <oemtype>] |
|
38 [\-O <sel oem>] |
|
39 [\-e <esc_char>] |
|
40 <command> |
|
41 |
|
42 ipmitool [\-c|\-h|\-v|\-V] |
|
43 \-I lanplus \-H <hostname> |
|
44 [\-p <port>] |
|
45 [\-U <username>] |
|
46 [\-L <privlvl>] |
|
47 [\-a|\-E|\-P|\-f <password>] |
|
48 [\-o <oemtype>] |
|
49 [\-O <sel oem>] |
|
50 [\-C <ciphersuite>] |
|
51 [\-K|\-k <kg_key>] |
|
52 [\-y <hex_kg_key>] |
|
53 [\-e <esc_char>] |
|
54 <command> |
|
55 .SH DESCRIPTION |
|
56 This program lets you manage Intelligent Platform Management Interface |
|
57 (IPMI) functions of either the local system, via a kernel device driver, |
|
58 or a remote system, using IPMI v1.5 and IPMI v2.0. These functions include printing |
|
59 FRU information, LAN configuration, sensor readings, and remote chassis |
|
60 power control. |
|
61 |
|
62 IPMI management by a remote station is disabled on platforms as they |
|
63 are shipped. It can be enabled only by the root user on the local system. |
|
64 |
|
65 .SH SECURITY WARNING |
|
66 There are several security issues to be considered before enabling the |
|
67 IPMI LAN interface. A remote station has the ability to control a system's power |
|
68 state as well as being able to gather certain platform information. To reduce |
|
69 vulnerability it is strongly advised that the IPMI LAN interface only be |
|
70 enabled in 'trusted' environments where system security is not an issue or |
|
71 where there is a dedicated secure 'management network'. |
|
72 |
|
73 Further it is strongly advised that you should not enable IPMI for |
|
74 remote access without setting a password, and that that password should |
|
75 not be the same as any other password on that system. |
|
76 |
|
77 When an IPMI password is changed on a remote machine the new password is |
|
78 sent across the network as clear text. This could be observed and then |
|
79 used to attack the remote system. It is thus recommended that IPMI |
|
80 password management only be done using a tool, such as 'ipmitool', running |
|
81 on the local station. |
|
82 |
|
83 .SH OPTIONS |
|
84 .TP |
|
85 \-a |
|
86 Prompt for the remote server password. |
|
87 .TP |
|
88 \-A <authtype> |
|
89 Specify an authentication type to use during IPMIv1.5 lan |
|
90 session activation. Supported types are NONE, PASSWORD, MD2, MD5, or OEM. |
|
91 .TP |
|
92 \-c |
|
93 Present output in CSV (comma separated variable) format. |
|
94 This is not available with all commands. |
|
95 .TP |
|
96 \-e <sol_escape_char> |
|
97 Use supplied character for SOL session escape character. The default |
|
98 is to use ~ but this can conflict with ssh sessions. |
|
99 .TP |
|
100 \-k <key> |
|
101 Use supplied Kg key for IPMIv2 authentication. The default is not to |
|
102 use any Kg key. |
|
103 .TP |
|
104 \-y <hex key> |
|
105 Use supplied Kg key for IPMIv2 authentication. The key is expected in |
|
106 hexadecimal format and can be used to specify keys with non-printable |
|
107 characters. E.g. '-k PASSWORD' and '-y 50415353574F5244' are |
|
108 equivalent. |
|
109 The default is not to use any Kg key. |
|
110 .TP |
|
111 \-C <ciphersuite> |
|
112 The remote server authentication, integrity, and encryption algorithms |
|
113 to use for IPMIv2 lanplus connections. See table 22\-19 in the |
|
114 IPMIv2 specification. The default is 3 which specifies RAKP\-HMAC\-SHA1 |
|
115 authentication, HMAC\-SHA1\-96 integrity, and AES\-CBC\-128 encryption algorightms. |
|
116 .TP |
|
117 \-E |
|
118 The remote server password is specified by the environment |
|
119 variable IPMI_PASSWORD. |
|
120 .TP |
|
121 \-f <password_file> |
|
122 Specifies a file containing the remote server password. If this |
|
123 option is absent, or if password_file is empty, the password |
|
124 will default to NULL. |
|
125 |
|
126 If the \-f option is not present, ipmitool will prompt the |
|
127 user for a password. If no password is entered at the prompt, |
|
128 the remote server password will default to NULL. |
|
129 |
|
130 For IPMI v1.5, the maximum password length is 16 characters. |
|
131 Passwords longer than 16 characters will be truncated. |
|
132 |
|
133 For IPMI v2.0, the maximum password length is 20 characters; |
|
134 longer passwords are truncated. |
|
135 The longer password length is supported by the lanplus interface. |
|
136 .TP |
|
137 \-h |
|
138 Get basic usage help from the command line. |
|
139 .TP |
|
140 \-H <address> |
|
141 Remote server address, can be IP address or hostname. This |
|
142 option is required for lan and lanplus interfaces. |
|
143 .TP |
|
144 \-I <interface> |
|
145 Selects IPMI interface to use. Supported interfaces that are |
|
146 compiled in are visible in the usage help output. |
|
147 .TP |
|
148 \-L <privlvl> |
|
149 Force session privilege level. Can be CALLBACK, USER, |
|
150 OPERATOR, ADMINISTRATOR. Default is ADMINISTRATOR. |
|
151 .TP |
|
152 \-m <local_address> |
|
153 Set the local IPMB address. The default is 0x20 and there |
|
154 should be no need to change it for normal operation. |
|
155 .TP |
|
156 \-o <oemtype> |
|
157 Select OEM type to support. This usually involves minor hacks |
|
158 in place in the code to work around quirks in various BMCs from |
|
159 various manufacturers. Use \-o list to see a list of |
|
160 current supported OEM types. |
|
161 .TP |
|
162 \-O <sel oem> |
|
163 Open selected file and read OEM SEL event descriptions to be used |
|
164 during SEL listings. See examples in contrib dir for file format. |
|
165 .TP |
|
166 \-p <port> |
|
167 Remote server UDP port to connect to. Default is 623. |
|
168 .TP |
|
169 \-P <password> |
|
170 Remote server password is specified on the command line. |
|
171 If supported it will be obscured in the process list. |
|
172 Note! Specifying the password as a command line |
|
173 option is not recommended. |
|
174 .TP |
|
175 \-S <sdr_cache_file> |
|
176 Use Sensor Data Repository information from local file |
|
177 <sdr_cache_file> for remote SDR cache. Using a local SDR cache |
|
178 can drastically increase performance for commands that require |
|
179 knowledge of the entire SDR to perform their function. Local |
|
180 SDR cache from a remote system can be created with the |
|
181 `sdr dump <sdr_cache_file>` command. |
|
182 .TP |
|
183 \-t <target_address> |
|
184 Bridge IPMI requests to the remote target address. |
|
185 .TP |
|
186 \-U <username> |
|
187 Remote server username, default is NULL user. |
|
188 .TP |
|
189 \-d N |
|
190 Use device number N to specify the /dev/ipmiN (or |
|
191 /dev/ipmi/N or /dev/ipmidev/N) device to use for in-band |
|
192 BMC communication. Used to target a specific BMC on a |
|
193 multi-node, multi-BMC system through the ipmi device |
|
194 driver interface. Default is 0. |
|
195 .TP |
|
196 \-v |
|
197 Increase verbose output level. This option may be specified |
|
198 multiple times to increase the level of debug output. If given |
|
199 three times you will get hexdumps of all incoming and |
|
200 outgoing packets. |
|
201 .TP |
|
202 \-V |
|
203 Display version information. |
|
204 |
|
205 .LP |
|
206 If no password method is specified then ipmitool will prompt the |
|
207 user for a password. If no password is entered at the prompt, |
|
208 the remote server password will default to NULL. |
|
209 .SH COMMANDS |
|
210 .TP |
|
211 help This can be used to get command\-line help on ipmitool |
|
212 commands. It may also be placed at the end of commands |
|
213 to get option usage help. |
|
214 |
|
215 ipmitool help |
|
216 .br |
|
217 Commands: |
|
218 raw Send a RAW IPMI request and print |
|
219 response |
|
220 i2c Send an I2C Master Write-Read |
|
221 command and print response |
|
222 spd Print SPD information from remote |
|
223 I2C device |
|
224 lan Configure LAN Channels |
|
225 chassis Get chassis status and set power |
|
226 state |
|
227 power Alias for chassis power commands |
|
228 event Send pre-defined events to MC |
|
229 mc Management Controller status and |
|
230 global enables |
|
231 sdr Print Sensor Data Repository |
|
232 entries and readings |
|
233 sensor Print detailed sensor information |
|
234 fru Print built-in FRU and scan SDR |
|
235 for FRU locators |
|
236 sel Print System Event Log (SEL) |
|
237 pef Configure Platform Event Filtering |
|
238 (PEF) |
|
239 sol Configure IPMIv2.0 Serial\-over\-LAN |
|
240 tsol Configure and connect Tyan |
|
241 IPMIv1.5 Serial\-over\-LAN |
|
242 isol Configure and connect Intel |
|
243 IPMIv1.5 Serial\-over\-LAN |
|
244 user Configure Management Controller |
|
245 users |
|
246 channel Configure Management Controller |
|
247 channels |
|
248 sunoem OEM Commands for Sun servers |
|
249 kontronoem OEM Commands for Kontron |
|
250 picmg Run a PICMG/ATA extended command |
|
251 firewall Configure firmware firewall |
|
252 session Print session information |
|
253 exec Run list of commands from file |
|
254 set Set runtime variable for shell and |
|
255 exec |
|
256 echo Echo lines to stdout in scripts |
|
257 ekanalyzer Run FRU-Ekeying analyzer using FRU |
|
258 files |
|
259 |
|
260 ipmitool chassis help |
|
261 .br |
|
262 Chassis Commands: status, power, identify, policy, restart_cause, poh, bootdev, bootparam, selftest |
|
263 |
|
264 ipmitool chassis power help |
|
265 .br |
|
266 chassis power Commands: status, on, off, cycle, reset, diag, soft |
|
267 .TP |
|
268 bmc|mc |
|
269 .RS |
|
270 .TP |
|
271 reset <warm|cold> |
|
272 .br |
|
273 |
|
274 Instructs the BMC to perform a warm or cold reset. |
|
275 .TP |
|
276 info |
|
277 .br |
|
278 |
|
279 Displays information about the BMC hardware, including device revision, |
|
280 firmware revision, IPMI version supported, manufacturer ID, |
|
281 and information on additional device support. |
|
282 .TP |
|
283 watchdog |
|
284 .br |
|
285 |
|
286 These commands allow a user to view and change the current |
|
287 state of the watchdog timer. |
|
288 .RS |
|
289 .TP |
|
290 get |
|
291 .br |
|
292 |
|
293 Show current Watchdog Timer settings and countdown state. |
|
294 .TP |
|
295 reset |
|
296 .br |
|
297 |
|
298 Reset the Watchdog Timer to its most recent state and restart the |
|
299 countdown timer. |
|
300 .TP |
|
301 off |
|
302 .br |
|
303 |
|
304 Turn off a currently running Watchdog countdown timer. |
|
305 .RE |
|
306 .TP |
|
307 selftest |
|
308 .br |
|
309 |
|
310 Check on the basic health of the BMC by executing the Get Self Test |
|
311 results command and reporting the results. |
|
312 .TP |
|
313 getenables |
|
314 .br |
|
315 |
|
316 Displays a list of the currently enabled options for the BMC. |
|
317 .br |
|
318 .TP |
|
319 setenables <option>=[on|off] |
|
320 .br |
|
321 |
|
322 Enables or disables the given \fIoption\fR. Currently supported |
|
323 values for \fIoption\fR include: |
|
324 .RS |
|
325 .TP |
|
326 recv_msg_intr |
|
327 .br |
|
328 |
|
329 Receive Message Queue Interrupt |
|
330 .TP |
|
331 event_msg_intr |
|
332 .br |
|
333 |
|
334 Event Message Buffer Full Interrupt |
|
335 .TP |
|
336 event_msg |
|
337 .br |
|
338 |
|
339 Event Message Buffer |
|
340 .TP |
|
341 system_event_log |
|
342 .br |
|
343 |
|
344 System Event Logging |
|
345 .TP |
|
346 oem0 |
|
347 .br |
|
348 |
|
349 OEM-Defined option #0 |
|
350 .TP |
|
351 oem1 |
|
352 .br |
|
353 |
|
354 OEM-Defined option #1 |
|
355 .TP |
|
356 oem2 |
|
357 .br |
|
358 |
|
359 OEM-Defined option #2 |
|
360 .RE |
|
361 .RE |
|
362 .TP |
|
363 channel |
|
364 .RS |
|
365 .TP |
|
366 authcap <channel number> <max priv> |
|
367 |
|
368 Displays information about the |
|
369 authentication capabilities of the selected channel |
|
370 at the specified privilege level. |
|
371 .RS |
|
372 .TP |
|
373 Possible privilege levels are: |
|
374 .br |
|
375 1 Callback level |
|
376 .br |
|
377 2 User level |
|
378 .br |
|
379 3 Operator level |
|
380 .br |
|
381 4 Administrator level |
|
382 .br |
|
383 5 OEM Proprietary level |
|
384 .RE |
|
385 .TP |
|
386 info [channel number] |
|
387 |
|
388 Displays information about the |
|
389 selected channel. If no channel is given it will |
|
390 display information about the currently used channel: |
|
391 .RS |
|
392 .PP |
|
393 ipmitool \-I bmc channel info |
|
394 .br |
|
395 Channel 0xf info: |
|
396 .br |
|
397 Channel Medium Type : System Interface |
|
398 .br |
|
399 Channel Protocol Type : KCS |
|
400 .br |
|
401 Session Support : session\-less |
|
402 .br |
|
403 Active Session Count : 0 |
|
404 .br |
|
405 Protocol Vendor ID : 7154 |
|
406 .RE |
|
407 .TP |
|
408 getaccess <channel number> [userid] |
|
409 .br |
|
410 |
|
411 Configure the given userid as the default on the given channel number. |
|
412 When the given channel is subsequently used, the user is identified |
|
413 implicitly by the given userid. |
|
414 .TP |
|
415 setaccess <channel number> <userid> [callin=on|off] |
|
416 [ipmi=on|off] [link=on|off] [privilege=level] |
|
417 .br |
|
418 |
|
419 Configure user access information on the given channel for the given userid. |
|
420 .TP |
|
421 getciphers <all | supported> <ipmi | sol> [channel] |
|
422 .br |
|
423 |
|
424 Displays the list of cipher suites supported for the given |
|
425 application (ipmi or sol) on the given channel. |
|
426 .RE |
|
427 .TP |
|
428 chassis |
|
429 .RS |
|
430 .TP |
|
431 status |
|
432 .br |
|
433 |
|
434 Displays information regarding the high-level |
|
435 status of the system chassis and main power |
|
436 subsystem. |
|
437 .TP |
|
438 poh |
|
439 .br |
|
440 |
|
441 This command will return the Power\-On Hours counter. |
|
442 .TP |
|
443 identify <interval> |
|
444 |
|
445 Control the front panel identify light. Default interval |
|
446 is 15 seconds. Use 0 to turn off. Use "force" to turn on |
|
447 indefinitely. |
|
448 .TP |
|
449 restart_cause |
|
450 .br |
|
451 |
|
452 Query the chassis for the cause of the last system restart. |
|
453 .TP |
|
454 selftest |
|
455 .br |
|
456 |
|
457 Check on the basic health of the BMC by executing the Get Self Test |
|
458 results command and reporting the results. |
|
459 .TP |
|
460 policy |
|
461 .br |
|
462 |
|
463 Set the chassis power policy in the event power failure. |
|
464 .RS |
|
465 .TP |
|
466 list |
|
467 .br |
|
468 |
|
469 Return supported policies. |
|
470 .TP |
|
471 always\-on |
|
472 .br |
|
473 |
|
474 Turn on when power is restored. |
|
475 .TP |
|
476 previous |
|
477 .br |
|
478 |
|
479 Returned to previous state when power is restored. |
|
480 .TP |
|
481 always\-off |
|
482 .br |
|
483 |
|
484 Stay off after power is restored. |
|
485 .RE |
|
486 .TP |
|
487 power |
|
488 .br |
|
489 |
|
490 Performs a chassis control command to view and |
|
491 change the power state. |
|
492 .RS |
|
493 .TP |
|
494 status |
|
495 .br |
|
496 |
|
497 Show current chassis power status. |
|
498 .TP |
|
499 on |
|
500 .br |
|
501 |
|
502 Power up chassis. |
|
503 .TP |
|
504 off |
|
505 .br |
|
506 |
|
507 Power down chassis into soft off (S4/S5 |
|
508 state). WARNING: This command does not initiate a clean |
|
509 shutdown of the operating system prior to powering down the system. |
|
510 .TP |
|
511 cycle |
|
512 .br |
|
513 |
|
514 Provides a power off interval of |
|
515 at least 1 second. No action should occur if |
|
516 chassis power is in S4/S5 state, but it is |
|
517 recommended to check power state first and |
|
518 only issue a power cycle command if the system power is |
|
519 on or in lower sleep state than S4/S5. |
|
520 .TP |
|
521 reset |
|
522 .br |
|
523 |
|
524 This command will perform a hard reset. |
|
525 .TP |
|
526 diag |
|
527 .br |
|
528 |
|
529 Pulse a diagnostic interrupt (NMI) directly to the processor(s). |
|
530 .TP |
|
531 soft |
|
532 .br |
|
533 |
|
534 Initiate a soft\-shutdown of OS via ACPI by |
|
535 emulating a fatal overtemperature. |
|
536 .RE |
|
537 .TP |
|
538 bootdev <device> [clear-cmos=yes|no] [options=help,...] |
|
539 .br |
|
540 |
|
541 Request the system to boot from an alternate boot device on next reboot. If the optional |
|
542 `clear-cmos` argument is present, the parameter given will be used to determine if the |
|
543 values stored in persistent CMOS memory are cleared the next time the system is rebooted. |
|
544 Note that this command is not supported on many platforms. |
|
545 Various options may be used to modify the boot device settings. |
|
546 Run "bootdev none options=help" for a list of available boot device |
|
547 modifiers/options. |
|
548 |
|
549 .RS |
|
550 .TP |
|
551 Currently supported values for <device> are: |
|
552 .TP |
|
553 pxe |
|
554 .br |
|
555 |
|
556 Force PXE boot |
|
557 .TP |
|
558 disk |
|
559 .br |
|
560 |
|
561 Force boot from BIOS default boot device |
|
562 .TP |
|
563 safe |
|
564 .br |
|
565 |
|
566 Force boot from BIOS default boot device, request Safe Mode |
|
567 .TP |
|
568 diag |
|
569 .br |
|
570 |
|
571 Force boot from diagnostic partition |
|
572 .TP |
|
573 cdrom |
|
574 .br |
|
575 |
|
576 Force boot from CD/DVD |
|
577 .TP |
|
578 bios |
|
579 .br |
|
580 |
|
581 Force boot into BIOS setup |
|
582 .TP |
|
583 floppy |
|
584 .br |
|
585 |
|
586 Force boot from Floppy/primary removable media |
|
587 .RE |
|
588 .TP |
|
589 bootparam |
|
590 .br |
|
591 |
|
592 Get or set various system boot option parameters. |
|
593 .RS |
|
594 .TP |
|
595 get <param #> |
|
596 .br |
|
597 |
|
598 Get boot parameter. Currently supported values for <param #> are: |
|
599 |
|
600 0 - Set In Progress |
|
601 |
|
602 1 - Service Partition Selector |
|
603 |
|
604 2 - Service Partition Scan |
|
605 |
|
606 3 - BMC Boot Flag Valid Bit Clearing |
|
607 |
|
608 4 - Boot Info Acknowledge |
|
609 |
|
610 5 - Boot Flags |
|
611 |
|
612 6 - Boot Initiator Info |
|
613 |
|
614 7 - Boot Initiator Mailbox |
|
615 .br |
|
616 |
|
617 .TP |
|
618 set <option> [value ...] |
|
619 .br |
|
620 |
|
621 Set boot parameter. |
|
622 |
|
623 .RS |
|
624 .TP |
|
625 Currently supported values for <option> are: |
|
626 .TP |
|
627 force_pxe |
|
628 .br |
|
629 |
|
630 Force PXE boot |
|
631 .TP |
|
632 force_disk |
|
633 .br |
|
634 |
|
635 Force boot from default hard-drive |
|
636 .TP |
|
637 force_safe |
|
638 .br |
|
639 |
|
640 Force boot from default hard-drive, request Safe Mode |
|
641 .TP |
|
642 force_diag |
|
643 .br |
|
644 |
|
645 Force boot from diagnostic partition |
|
646 .TP |
|
647 force_cdrom |
|
648 .br |
|
649 |
|
650 Force boot from CD/DVD |
|
651 .TP |
|
652 force_bios |
|
653 .br |
|
654 |
|
655 Force boot into BIOS setup |
|
656 |
|
657 .RE |
|
658 .RE |
|
659 .RE |
|
660 .TP |
|
661 ekanalyzer <command> <xx=file1> <xx=file2> [<rc=file3>] ... |
|
662 .RS |
|
663 |
|
664 .br |
|
665 NOTE : This command can support a maximum of 8 files per command line |
|
666 .TP |
|
667 file1 |
|
668 .br |
|
669 binary file that stores FRU data of a Carrier or an AMC module |
|
670 .TP |
|
671 file2 |
|
672 .br |
|
673 binary file that stores FRU data of an AMC module. |
|
674 These binary files can be generated from command: |
|
675 ipmitool fru read <id> <file> |
|
676 .TP |
|
677 file3 |
|
678 .br |
|
679 configuration file used for configuring On-Carrier Device ID |
|
680 or OEM GUID. This file is optional. |
|
681 .TP |
|
682 .br |
|
683 xx : indicates the type of the file. |
|
684 .br |
|
685 It can take the following value: |
|
686 .RS |
|
687 .TP |
|
688 .br |
|
689 oc : On-Carrier device |
|
690 .TP |
|
691 .br |
|
692 a1 : AMC slot A1 |
|
693 .TP |
|
694 .br |
|
695 a2 : AMC slot A2 |
|
696 .TP |
|
697 .br |
|
698 a3 : AMC slot A3 |
|
699 .TP |
|
700 .br |
|
701 a4 : AMC slot A4 |
|
702 .TP |
|
703 .br |
|
704 b1 : AMC slot B1 |
|
705 .TP |
|
706 .br |
|
707 b2 : AMC slot B2 |
|
708 .TP |
|
709 .br |
|
710 b3 : AMC slot B3 |
|
711 .TP |
|
712 .br |
|
713 b4 : AMC slot B4 |
|
714 .TP |
|
715 .br |
|
716 sm : Shelf Manager |
|
717 |
|
718 .RE |
|
719 .TP |
|
720 .br |
|
721 The available commands for ekanalyzer are: |
|
722 |
|
723 .TP |
|
724 print [<carrier | power | all>] |
|
725 .RS |
|
726 .TP |
|
727 carrier (default) <oc=file1> <oc=file2> ... |
|
728 .br |
|
729 |
|
730 Display point-to-point physical connectivity between carriers and AMC modules. |
|
731 Example: |
|
732 ipmitool ekanalyzer print carrier oc=fru oc=carrierfru |
|
733 From Carrier file: fru |
|
734 Number of AMC bays supported by Carrier: 2 |
|
735 AMC slot B1 topology: |
|
736 Port 0 =====> On Carrier Device ID 0, Port 16 |
|
737 Port 1 =====> On Carrier Device ID 0, Port 12 |
|
738 Port 2 =====> AMC slot B2, Port 2 |
|
739 AMC slot B2 topology: |
|
740 Port 0 =====> On Carrier Device ID 0, Port 3 |
|
741 Port 2 =====> AMC slot B1, Port 2 |
|
742 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-* |
|
743 From Carrier file: carrierfru |
|
744 On Carrier Device ID 0 topology: |
|
745 Port 0 =====> AMC slot B1, Port 4 |
|
746 Port 1 =====> AMC slot B1, Port 5 |
|
747 Port 2 =====> AMC slot B2, Port 6 |
|
748 Port 3 =====> AMC slot B2, Port 7 |
|
749 AMC slot B1 topology: |
|
750 Port 0 =====> AMC slot B2, Port 0 |
|
751 AMC slot B1 topology: |
|
752 Port 1 =====> AMC slot B2, Port 1 |
|
753 Number of AMC bays supported by Carrier: 2 |
|
754 |
|
755 .TP |
|
756 power <xx=file1> <xx=file2> ... |
|
757 .br |
|
758 |
|
759 Display power supply information between carrier and AMC modules. |
|
760 .TP |
|
761 all <xx=file> <xx=file> ... |
|
762 .br |
|
763 |
|
764 Display both physical connectivity and power supply of each carrier and AMC |
|
765 modules. |
|
766 |
|
767 .RE |
|
768 .TP |
|
769 frushow <xx=file> |
|
770 .br |
|
771 |
|
772 Convert a binary FRU file into human readable text format. Use -v option to get |
|
773 more display information. |
|
774 |
|
775 .RE |
|
776 .RS |
|
777 .TP |
|
778 summary [<match | unmatch | all>] |
|
779 .RS |
|
780 .TP |
|
781 match (default) <xx=file> <xx=file> ... |
|
782 .br |
|
783 |
|
784 Display only matched results of Ekeying match between an On-Carrier device |
|
785 and an AMC module or between 2 AMC modules. Example: |
|
786 ipmitool ekanalyzer summary match oc=fru b1=amcB1 a2=amcA2 |
|
787 On-Carrier Device vs AMC slot B1 |
|
788 AMC slot B1 port 0 ==> On-Carrier Device 0 port 16 |
|
789 Matching Result |
|
790 - From On-Carrier Device ID 0 |
|
791 -Channel ID 11 || Lane 0: enable |
|
792 -Link Type: AMC.2 Ethernet |
|
793 -Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link |
|
794 -Link Group ID: 0 || Link Asym. Match: exact match |
|
795 - To AMC slot B1 |
|
796 -Channel ID 0 || Lane 0: enable |
|
797 -Link Type: AMC.2 Ethernet |
|
798 -Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link |
|
799 -Link Group ID: 0 || Link Asym. Match: exact match |
|
800 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-* |
|
801 AMC slot B1 port 1 ==> On-Carrier Device 0 port 12 |
|
802 Matching Result |
|
803 - From On-Carrier Device ID 0 |
|
804 -Channel ID 6 || Lane 0: enable |
|
805 -Link Type: AMC.2 Ethernet |
|
806 -Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link |
|
807 -Link Group ID: 0 || Link Asym. Match: exact match |
|
808 - To AMC slot B1 |
|
809 -Channel ID 1 || Lane 0: enable |
|
810 -Link Type: AMC.2 Ethernet |
|
811 -Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link |
|
812 -Link Group ID: 0 || Link Asym. Match: exact match |
|
813 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-* |
|
814 On-Carrier Device vs AMC slot A2 |
|
815 AMC slot A2 port 0 ==> On-Carrier Device 0 port 3 |
|
816 Matching Result |
|
817 - From On-Carrier Device ID 0 |
|
818 -Channel ID 9 || Lane 0: enable |
|
819 -Link Type: AMC.2 Ethernet |
|
820 -Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link |
|
821 -Link Group ID: 0 || Link Asym. Match: exact match |
|
822 - To AMC slot A2 |
|
823 -Channel ID 0 || Lane 0: enable |
|
824 -Link Type: AMC.2 Ethernet |
|
825 -Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link |
|
826 -Link Group ID: 0 || Link Asym. Match: exact match |
|
827 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-* |
|
828 AMC slot B1 vs AMC slot A2 |
|
829 AMC slot A2 port 2 ==> AMC slot B1 port 2 |
|
830 Matching Result |
|
831 - From AMC slot B1 |
|
832 -Channel ID 2 || Lane 0: enable |
|
833 -Link Type: AMC.3 Storage |
|
834 -Link Type extension: Serial Attached SCSI (SAS/SATA) |
|
835 -Link Group ID: 0 || Link Asym. Match: FC or SAS interface {exact match} |
|
836 - To AMC slot A2 |
|
837 -Channel ID 2 || Lane 0: enable |
|
838 -Link Type: AMC.3 Storage |
|
839 -Link Type extension: Serial Attached SCSI (SAS/SATA) |
|
840 -Link Group ID: 0 || Link Asym. Match: FC or SAS interface {exact match} |
|
841 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-* |
|
842 .TP |
|
843 unmatch <xx=file> <xx=file> ... |
|
844 .br |
|
845 |
|
846 Display the unmatched results of Ekeying match between an On-Carrier device |
|
847 and an AMC module or between 2 AMC modules |
|
848 .TP |
|
849 all <xx=file> <xx=file> ... |
|
850 .br |
|
851 |
|
852 Display both matched result and unmatched results of Ekeying match between two |
|
853 cards or two modules. |
|
854 .RE |
|
855 .RE |
|
856 .TP |
|
857 event |
|
858 .RS |
|
859 .TP |
|
860 <predefined event number n> |
|
861 .br |
|
862 |
|
863 Send a pre-defined test event to the System Event Log. The following events are |
|
864 included as a means to test the functionality of the System Event Log component |
|
865 of the BMC (an entry will be added each time the event \fIn\fR command is |
|
866 executed). |
|
867 |
|
868 Currently supported values for \fIn\fR are: |
|
869 .br |
|
870 1 Temperature: Upper Critical: Going High |
|
871 .br |
|
872 2 Voltage Threshold: Lower Critical: Going Low |
|
873 .br |
|
874 3 Memory: Correctable ECC |
|
875 .br |
|
876 |
|
877 \fINOTE\fR: These pre-defined events will likely not |
|
878 produce "accurate" SEL records for a particular system because they will |
|
879 not be correctly tied to a valid sensor number, but they are sufficient |
|
880 to verify correct operation of the SEL. |
|
881 |
|
882 .TP |
|
883 file <filename> |
|
884 .br |
|
885 |
|
886 Event log records specified in \fIfilename\fR will be added to the System Event Log. |
|
887 |
|
888 The format of each line in the file is as follows: |
|
889 |
|
890 <{EvM Revision} {Sensor Type} {Sensor Num} {Event Dir/Type} {Event Data 0} {Event Data 1} {Event Data 2}>[# COMMENT] |
|
891 |
|
892 e.g.: |
|
893 .br |
|
894 0x4 0x2 0x60 0x1 0x52 0x0 0x0 # Voltage threshold: Lower Critical: Going Low |
|
895 .br |
|
896 |
|
897 EvM Revision - |
|
898 The "Event Message Revision" is 0x04 for messages that comply with the IPMI 2.0 |
|
899 Specification and 0x03 for messages that comply with the IPMI 1.0 Specification. |
|
900 |
|
901 Sensor Type - |
|
902 Indicates the Event Type or Class. |
|
903 |
|
904 Sensor Num - |
|
905 Represents the 'sensor' within the management controller that generated |
|
906 the Event Message. |
|
907 |
|
908 Event Dir/Type - |
|
909 This field is encoded with the event direction as the high bit |
|
910 (bit 7) and the event type as the low 7 bits. Event direction is |
|
911 0 for an assertion event and 1 for a deassertion event. |
|
912 |
|
913 See the IPMI 2.0 specification for further details on the definitions for |
|
914 each field. |
|
915 |
|
916 .TP |
|
917 <sensorid> <list> |
|
918 .br |
|
919 |
|
920 Get a list of all the possible Sensor States and pre-defined Sensor State |
|
921 Shortcuts available for a particular sensor. \fIsensorid\fR is the character |
|
922 string representation of the sensor and must be enclosed in double quotes |
|
923 if it includes white space. Several different commands including |
|
924 \fIipmitool sensor list\fR may be used to obtain a list that includes |
|
925 the \fIsensorid\fR strings representing the sensors on a given system. |
|
926 .RS |
|
927 .PP |
|
928 ipmitool \-I open event "PS 2T Fan Fault" list |
|
929 .br |
|
930 Finding sensor PS 2T Fan Fault... ok |
|
931 .br |
|
932 Sensor States: |
|
933 .br |
|
934 State Deasserted |
|
935 .br |
|
936 State Asserted |
|
937 .br |
|
938 Sensor State Shortcuts: |
|
939 .br |
|
940 present absent |
|
941 .br |
|
942 assert deassert |
|
943 .br |
|
944 limit nolimit |
|
945 .br |
|
946 fail nofail |
|
947 .br |
|
948 yes no |
|
949 .br |
|
950 on off |
|
951 .br |
|
952 up down |
|
953 |
|
954 .RE |
|
955 .TP |
|
956 <sensorid> <sensor state> [<direction>] |
|
957 |
|
958 Generate a custom event based on existing sensor information. |
|
959 The optional event \fBdirection\fR can be either \fIassert\fR |
|
960 (the default) or \fIdeassert\fR. |
|
961 |
|
962 .RS |
|
963 .PP |
|
964 ipmitool event "PS 2T Fan Fault" "State Asserted" |
|
965 .br |
|
966 Finding sensor PS 2T Fan Fault... ok |
|
967 .br |
|
968 0 | Pre-Init Time-stamp | Fan PS 2T Fan Fault | State Asserted |
|
969 .RE |
|
970 .RS |
|
971 .PP |
|
972 ipmitool event "PS 2T Fan Fault" "State Deasserted" |
|
973 .br |
|
974 Finding sensor PS 2T Fan Fault... ok |
|
975 .br |
|
976 0 | Pre-Init Time-stamp | Fan PS 2T Fan Fault | State Desserted |
|
977 .RE |
|
978 .RS |
|
979 .PP |
|
980 .RE |
|
981 |
|
982 .RE |
|
983 .TP |
|
984 exec <filename> |
|
985 |
|
986 .RS |
|
987 Execute ipmitool commands from \fIfilename\fR. Each line |
|
988 is a complete command. The syntax of the commands |
|
989 are defined by the COMMANDS section in this manpage. |
|
990 Each line may have an optional comment at the end |
|
991 of the line, delimited with a `#' symbol. |
|
992 |
|
993 e.g., a command file with one line: |
|
994 |
|
995 sdr list # get a list of sdr records |
|
996 .br |
|
997 .RE |
|
998 .TP |
|
999 fru |
|
1000 .RS |
|
1001 .TP |
|
1002 print |
|
1003 .br |
|
1004 |
|
1005 This command will read all Field Replaceable Unit (FRU) |
|
1006 inventory data and extract such information as |
|
1007 serial number, part number, asset tags, and short |
|
1008 strings describing the chassis, board, or product. |
|
1009 .TP |
|
1010 read <fru id> <fru file> |
|
1011 .br |
|
1012 |
|
1013 \fIfru id\fR is the digit ID of the FRU (see output of 'fru print'). |
|
1014 \fIfru file\fR is the absolute pathname of a file in which to dump the |
|
1015 binary FRU data pertaining to the specified FRU entity. |
|
1016 .TP |
|
1017 write <fru id> <fru file> |
|
1018 .br |
|
1019 |
|
1020 \fIfru id\fR is the digit ID of the FRU (see output of 'fru print'). |
|
1021 \fIfru file\fR is the absolute pathname of a file from which to pull |
|
1022 the binary FRU data before uploading it to the specified FRU. |
|
1023 .TP |
|
1024 upgEkey <fru id> <fru file> |
|
1025 .br |
|
1026 |
|
1027 Update a multirecord FRU location. |
|
1028 \fIfru id\fR is the digit ID of the FRU (see output of 'fru print'). |
|
1029 \fIfru file\fR is the absolute pathname of a file from which to pull the |
|
1030 binary FRU data to upload into the specified multirecord FRU entity. |
|
1031 |
|
1032 .TP |
|
1033 edit <fru id> |
|
1034 .br |
|
1035 |
|
1036 This command provides interactive editing of some supported records, namely |
|
1037 PICMG Carrier Activation Record. \fIfru id\fR is the digit ID of the FRU |
|
1038 (see output of 'fru print'); default is 0. |
|
1039 |
|
1040 .TP |
|
1041 edit <fru id> field <section> <index> <string> |
|
1042 .br |
|
1043 |
|
1044 This command may be used to set a field string to a new value. It replaces |
|
1045 the FRU data found at \fIindex\fR in the specified \fIsection\fR with the |
|
1046 supplied \fIstring\fR. |
|
1047 |
|
1048 .RS |
|
1049 .TP |
|
1050 fru id |
|
1051 .br |
|
1052 |
|
1053 is the digit ID of the FRU (see output of 'fru print'). |
|
1054 .TP |
|
1055 section |
|
1056 .br |
|
1057 |
|
1058 is a string which refers to FRU Inventory Information |
|
1059 Storage Areas and may be refer to: |
|
1060 .RS |
|
1061 .TP |
|
1062 c FRU Inventory Chassis Info Area |
|
1063 .br |
|
1064 .TP |
|
1065 b FRU Inventory Board Info Area |
|
1066 .br |
|
1067 .TP |
|
1068 p FRU Inventory Product Info Area |
|
1069 .RE |
|
1070 .TP |
|
1071 index |
|
1072 .br |
|
1073 |
|
1074 specifies the field number. Field numbering starts on the first 'english text' field type. For instance in the <\fBboard\fR> info area field '0' is <\fBBoard Manufacturer\fR> and field '2' is <\fBBoard Serial Number\fR>; see IPMI Platform Management FRU Information Storage Definition v1.0 R1.1 for field locations. |
|
1075 .TP |
|
1076 string |
|
1077 .br |
|
1078 |
|
1079 must be the same length as the string being replaced and must be 8-bit ASCII (0xCx). |
|
1080 .RE |
|
1081 .TP |
|
1082 edit <fru id> oem iana <record> <format> [<args>] |
|
1083 .br |
|
1084 |
|
1085 This command edits the data found in the multirecord area. Support for |
|
1086 OEM specific records is limited. |
|
1087 .RE |
|
1088 .TP |
|
1089 firewall |
|
1090 .br |
|
1091 |
|
1092 This command supports the firmware firewall capability. It may be used to |
|
1093 add or remove security-based restrictions on certain commands/command |
|
1094 sub-functions or to list the current firmware firewall restrictions set on |
|
1095 any commands. For each firmware firewall command listed below, parameters |
|
1096 may be included to cause the command to be executed with increasing |
|
1097 granularity on a specific LUN, for a specific NetFn, for a specific IPMI |
|
1098 Command, and finally for a specific command's sub-function (see Appendix H in the |
|
1099 IPMI 2.0 Specification for a listing of any sub-function numbers that may |
|
1100 be associated with a particular command). |
|
1101 |
|
1102 Parameter syntax and dependencies are as follows: |
|
1103 |
|
1104 [<channel H>] [<lun L> [<netfn N> [<command C [<subfn S>]]]] |
|
1105 |
|
1106 Note that if "netfn <\fBN\fR>" is specified, then "lun <\fBL\fR>" must also be |
|
1107 specified; if "command <\fBC\fR>" is specified, then "netfn <\fBN\fR>" (and |
|
1108 therefore "lun <\fBL\fR>") must also be specified, and so forth. |
|
1109 |
|
1110 "channel <\fBH\fR>" is an optional and standalone parameter. If not specified, |
|
1111 the requested operation will be performed on the current channel. Note that |
|
1112 command support may vary from channel to channel. |
|
1113 |
|
1114 Firmware firewall commands: |
|
1115 .RS |
|
1116 .TP |
|
1117 info [<parms as described above>] |
|
1118 .br |
|
1119 |
|
1120 List firmware firewall information for the specified LUN, NetFn, and |
|
1121 Command (if supplied) on the current or specified channel. Listed |
|
1122 information includes the support, configurable, and enabled bits for |
|
1123 the specified command or commands. |
|
1124 |
|
1125 Some usage examples: |
|
1126 .RS |
|
1127 .TP |
|
1128 info [<channel H>] [<lun L>] |
|
1129 .br |
|
1130 |
|
1131 This command will list firmware firewall information for all NetFns for the |
|
1132 specified LUN on either the current or the specified channel. |
|
1133 .TP |
|
1134 info [<channel H>] [<lun L> [<netfn N>]] |
|
1135 .br |
|
1136 |
|
1137 This command will print out all command information for a single LUN/NetFn pair. |
|
1138 .TP |
|
1139 info [<channel H>] [<lun L> [<netfn N> [<command C]]] |
|
1140 .br |
|
1141 |
|
1142 This prints out detailed, human-readable information showing the support, configurable, |
|
1143 and enabled bits for the specified command on the specified LUN/NetFn pair. Information |
|
1144 will be printed about each of the command subfunctions. |
|
1145 .TP |
|
1146 info [<channel H>] [<lun L> [<netfn N> [<command C [<subfn S>]]]] |
|
1147 .br |
|
1148 |
|
1149 Print out information for a specific sub-function. |
|
1150 .RE |
|
1151 .TP |
|
1152 enable [<parms as described above>] |
|
1153 .br |
|
1154 |
|
1155 This command is used to enable commands for a given NetFn/LUN combination on |
|
1156 the specified channel. |
|
1157 .TP |
|
1158 disable [<parms as described above>] [force] |
|
1159 .br |
|
1160 |
|
1161 This command is used to disable commands for a given NetFn/LUN combination on |
|
1162 the specified channel. Great care should be taken if using the "force" |
|
1163 option so as not to disable the "Set Command Enables" command. |
|
1164 .TP |
|
1165 reset [<parms as described above>] |
|
1166 .br |
|
1167 |
|
1168 This command may be used to reset the firmware firewall back to a state |
|
1169 where all commands and command sub-functions are enabled. |
|
1170 |
|
1171 .RE |
|
1172 .TP |
|
1173 i2c <i2caddr> <read bytes> [<write data>] |
|
1174 .br |
|
1175 |
|
1176 Sends an I^2C Master Write-Read command (if <write data> is supplied, |
|
1177 it is written to the I^2C master first) |
|
1178 to the device at address <i2caddr> and displays <read bytes> bytes of response. |
|
1179 .br |
|
1180 |
|
1181 Note: this command is not supported by all BMCs. |
|
1182 .br |
|
1183 |
|
1184 The following command writes the values 0x2, 0x3, and 0x4, then attempts to read 5 bytes from the I^2C master |
|
1185 at address 0xa: |
|
1186 .br |
|
1187 |
|
1188 ipmitool i2c 0xa 5 0x2 0x3 0x4 |
|
1189 |
|
1190 .TP |
|
1191 isol |
|
1192 .RS |
|
1193 .TP |
|
1194 info |
|
1195 .br |
|
1196 |
|
1197 Retrieve information about the Intel IPMI v1.5 Serial\-Over\-LAN |
|
1198 configuration. |
|
1199 .TP |
|
1200 set <parameter> <value> |
|
1201 .br |
|
1202 |
|
1203 Configure parameters for Intel IPMI v1.5 Serial\-over\-LAN. |
|
1204 .RS |
|
1205 .TP |
|
1206 Valid parameters and values are: |
|
1207 .br |
|
1208 .TP |
|
1209 enabled |
|
1210 true, false |
|
1211 .TP |
|
1212 privilege\-level |
|
1213 user, operator, admin, oem |
|
1214 .TP |
|
1215 bit\-rate |
|
1216 9.6, 19.2, 38.4, 57.6, 115.2 |
|
1217 .RE |
|
1218 .TP |
|
1219 activate |
|
1220 .br |
|
1221 |
|
1222 Causes ipmitool to enter Intel IPMI v1.5 Serial Over LAN mode. An RMCP+ |
|
1223 connection is made to the BMC, the terminal is set to raw mode, and user |
|
1224 input is sent to the serial console on the remote server. On exit, the |
|
1225 the SOL payload mode is deactivated and the terminal is reset to its |
|
1226 original settings. |
|
1227 .RS |
|
1228 |
|
1229 Special escape sequences are provided to control the SOL session: |
|
1230 .RS |
|
1231 .TP |
|
1232 ~. Terminate connection |
|
1233 .TP |
|
1234 ~^Z Suspend ipmitool |
|
1235 .TP |
|
1236 ~^X Suspend ipmitool, but don't restore tty on restart |
|
1237 .TP |
|
1238 ~B Send break |
|
1239 .TP |
|
1240 ~~ Send the escape character by typing it twice |
|
1241 .TP |
|
1242 ~? Print the supported escape sequences |
|
1243 .RE |
|
1244 |
|
1245 Note that escapes are only recognized immediately after newline. |
|
1246 .RE |
|
1247 |
|
1248 .RE |
|
1249 .TP |
|
1250 kontronoem |
|
1251 .RS |
|
1252 |
|
1253 OEM commands specific to Kontron devices. |
|
1254 .TP |
|
1255 setsn |
|
1256 .br |
|
1257 |
|
1258 Set FRU serial number. |
|
1259 .TP |
|
1260 setmfgdate |
|
1261 .br |
|
1262 |
|
1263 Set FRU manufacturing date. |
|
1264 .TP |
|
1265 nextboot <boot device> |
|
1266 .br |
|
1267 |
|
1268 Select the next boot order on the Kontron CP6012. |
|
1269 .RE |
|
1270 .TP |
|
1271 lan |
|
1272 .RS |
|
1273 .TP |
|
1274 print [<channel>] |
|
1275 .br |
|
1276 |
|
1277 Print the current configuration for the given channel. |
|
1278 The default will print information on the first found LAN channel. |
|
1279 .TP |
|
1280 set <channel> <command> <parameter> |
|
1281 .br |
|
1282 |
|
1283 Set the given command and parameter on the given channel. |
|
1284 Valid command/parameters are: |
|
1285 .RS |
|
1286 .TP |
|
1287 ipaddr <x.x.x.x> |
|
1288 .br |
|
1289 |
|
1290 Set the IP address for this channel. |
|
1291 .TP |
|
1292 netmask <x.x.x.x> |
|
1293 .br |
|
1294 |
|
1295 Set the netmask for this channel. |
|
1296 .TP |
|
1297 macaddr <xx:xx:xx:xx:xx:xx> |
|
1298 .br |
|
1299 |
|
1300 Set the MAC address for this channel. |
|
1301 .TP |
|
1302 defgw ipaddr <x.x.x.x> |
|
1303 .br |
|
1304 |
|
1305 Set the default gateway IP address. |
|
1306 .TP |
|
1307 defgw macaddr <xx:xx:xx:xx:xx:xx> |
|
1308 .br |
|
1309 |
|
1310 Set the default gateway MAC address. |
|
1311 .TP |
|
1312 bakgw ipaddr <x.x.x.x> |
|
1313 .br |
|
1314 |
|
1315 Set the backup gateway IP address. |
|
1316 .TP |
|
1317 bakgw macaddr <xx:xx:xx:xx:xx:xx> |
|
1318 .br |
|
1319 |
|
1320 Set the backup gateway MAC address. |
|
1321 .TP |
|
1322 password <pass> |
|
1323 .br |
|
1324 |
|
1325 Set the null user password. |
|
1326 .TP |
|
1327 snmp <community string> |
|
1328 .br |
|
1329 |
|
1330 Set the SNMP community string. |
|
1331 .TP |
|
1332 user |
|
1333 .br |
|
1334 |
|
1335 Enable user access mode for userid 1 (issue the `user' |
|
1336 command to display information about userids for a given channel). |
|
1337 .TP |
|
1338 access <on|off> |
|
1339 .br |
|
1340 |
|
1341 Set LAN channel access mode. |
|
1342 .TP |
|
1343 alert <on|off> |
|
1344 .br |
|
1345 |
|
1346 Enable or disable PEF alerting for this channel. |
|
1347 .TP |
|
1348 ipsrc <source> |
|
1349 .br |
|
1350 |
|
1351 Set the IP address source: |
|
1352 .br |
|
1353 none = unspecified |
|
1354 .br |
|
1355 static = manually configured static IP address |
|
1356 .br |
|
1357 dhcp = address obtained by BMC running DHCP |
|
1358 .br |
|
1359 bios = address loaded by BIOS or system software |
|
1360 .TP |
|
1361 arp respond <on|off> |
|
1362 .br |
|
1363 |
|
1364 Set BMC generated ARP responses. |
|
1365 .TP |
|
1366 arp generate <on|off> |
|
1367 .br |
|
1368 |
|
1369 Set BMC generated gratuitous ARPs. |
|
1370 .TP |
|
1371 arp interval <seconds> |
|
1372 .br |
|
1373 |
|
1374 Set BMC generated gratuitous ARP interval. |
|
1375 .TP |
|
1376 auth <level,...> <type,...> |
|
1377 .br |
|
1378 |
|
1379 Set the valid authtypes for a given auth level. |
|
1380 .br |
|
1381 Levels: callback, user, operator, admin |
|
1382 .br |
|
1383 Types: none, md2, md5, password, oem |
|
1384 .TP |
|
1385 cipher_privs <privlist> |
|
1386 .br |
|
1387 |
|
1388 Correlates cipher suite numbers with the maximum privilege |
|
1389 level that is allowed to use it. In this way, cipher suites can restricted |
|
1390 to users with a given privilege level, so that, for example, |
|
1391 administrators are required to use a stronger cipher suite than |
|
1392 normal users. |
|
1393 |
|
1394 The format of \fIprivlist\fR is as follows. Each character represents a privilege level |
|
1395 and the character position identifies the cipher suite number. For example, the |
|
1396 first character represents cipher suite 1 (cipher suite 0 is reserved), the second represents |
|
1397 cipher suite 2, and so on. \fIprivlist\fR must be 15 characters in length. |
|
1398 |
|
1399 Characters used in \fIprivlist\fR and their associated privilege levels are: |
|
1400 |
|
1401 X Cipher Suite Unused |
|
1402 .br |
|
1403 c CALLBACK |
|
1404 .br |
|
1405 u USER |
|
1406 .br |
|
1407 o OPERATOR |
|
1408 .br |
|
1409 a ADMIN |
|
1410 .br |
|
1411 O OEM |
|
1412 .br |
|
1413 |
|
1414 So, to set the maximum privilege for cipher suite 1 to USER and suite 2 to |
|
1415 ADMIN, issue the following command: |
|
1416 |
|
1417 ipmitool -I \fIinterface\fR lan set \fIchannel\fR cipher_privs uaXXXXXXXXXXXXX |
|
1418 |
|
1419 .RE |
|
1420 .TP |
|
1421 alert print [<channel>] [<destination>] |
|
1422 .br |
|
1423 |
|
1424 Print alert information for the specified channel and destination. |
|
1425 The default will print all alerts for all alert destinations on the |
|
1426 first found LAN channel. |
|
1427 |
|
1428 .TP |
|
1429 alert set <channel> <destination> <command> <parameter> |
|
1430 .br |
|
1431 |
|
1432 Set an alert on the given LAN channel and destination. Alert Destinations are |
|
1433 listed via the 'lan alert print' command. Valid command/parameters are: |
|
1434 .RS |
|
1435 .TP |
|
1436 ipaddr <x.x.x.x> |
|
1437 .br |
|
1438 |
|
1439 Set alert IP address. |
|
1440 .TP |
|
1441 macaddr <xx:xx:xx:xx:xx:xx> |
|
1442 .br |
|
1443 |
|
1444 Set alert MAC address. |
|
1445 .TP |
|
1446 gateway <default | backup> |
|
1447 .br |
|
1448 |
|
1449 Set the channel gateway to use for alerts. |
|
1450 .TP |
|
1451 ack <on | off> |
|
1452 .br |
|
1453 |
|
1454 Set Alert Acknowledge on or off. |
|
1455 .TP |
|
1456 type <pet | oem1 | oem2> |
|
1457 .br |
|
1458 |
|
1459 Set the destination type as PET or OEM. |
|
1460 .TP |
|
1461 time <seconds> |
|
1462 .br |
|
1463 |
|
1464 Set ack timeout or unack retry interval. |
|
1465 .TP |
|
1466 retry <number> |
|
1467 .br |
|
1468 |
|
1469 Set the number of alert retries. |
|
1470 .RE |
|
1471 .TP |
|
1472 stats get [<channel>] |
|
1473 .br |
|
1474 |
|
1475 Retrieve information about the IP connections on the specified channel. |
|
1476 The default will retrieve statistics on the first found LAN channel. |
|
1477 .TP |
|
1478 stats clear [<channel>] |
|
1479 .br |
|
1480 |
|
1481 Clear all IP/UDP/RMCP Statistics to 0 on the specified channel. |
|
1482 The default will clear statistics on the first found LAN channel. |
|
1483 .RE |
|
1484 .TP |
|
1485 pef |
|
1486 .RS |
|
1487 .TP |
|
1488 info |
|
1489 .br |
|
1490 |
|
1491 This command will query the BMC and print information about the PEF supported features. |
|
1492 .TP |
|
1493 status |
|
1494 .br |
|
1495 |
|
1496 This command prints the current PEF status (the last SEL entry processed by the BMC, etc). |
|
1497 .TP |
|
1498 policy |
|
1499 .br |
|
1500 |
|
1501 This command lists the PEF policy table entries. Each policy |
|
1502 entry describes an alert destination. A policy set is a |
|
1503 collection of table entries. PEF alert actions reference policy sets. |
|
1504 .TP |
|
1505 list |
|
1506 .br |
|
1507 |
|
1508 This command lists the PEF table entries. Each PEF entry |
|
1509 relates a sensor event to an action. When PEF is active, |
|
1510 each platform event causes the BMC to scan this table for |
|
1511 entries matching the event, and possible actions to be taken. |
|
1512 Actions are performed in priority order (higher criticality first). |
|
1513 .RE |
|
1514 .TP |
|
1515 picmg <properties> |
|
1516 .RS |
|
1517 |
|
1518 Run a PICMG/ATA extended command. Get PICMG properties may be used to |
|
1519 obtain and print Extension major version information, PICMG identifier, |
|
1520 FRU Device ID and Max FRU Device ID. |
|
1521 .TP |
|
1522 addrinfo |
|
1523 .br |
|
1524 |
|
1525 Get address information. This command may return information on the Hardware |
|
1526 address, IPMB-0 Address, FRU ID, Site/Entity ID, and Site/Entity Type. |
|
1527 .TP |
|
1528 frucontrol <fru id> <options> |
|
1529 .br |
|
1530 |
|
1531 Set various control options: |
|
1532 .RS |
|
1533 .TP |
|
1534 0x00 - Cold Reset |
|
1535 .br |
|
1536 .TP |
|
1537 0x01 - Warm Reset |
|
1538 .br |
|
1539 .TP |
|
1540 0x02 - Graceful Reboot |
|
1541 .br |
|
1542 .TP |
|
1543 0x03 - Issue Diagnostic Interrupt |
|
1544 .br |
|
1545 .TP |
|
1546 0x04 - Quiesce [AMC only] |
|
1547 .br |
|
1548 .TP |
|
1549 0x05-0xFF - Cold Reset |
|
1550 .br |
|
1551 .RE |
|
1552 .TP |
|
1553 activate <fru id> |
|
1554 .br |
|
1555 |
|
1556 Activate the specified FRU. |
|
1557 .TP |
|
1558 deactivate <fru id> |
|
1559 .br |
|
1560 |
|
1561 Deactivate the specified FRU. |
|
1562 .TP |
|
1563 policy get <fru id> |
|
1564 .br |
|
1565 |
|
1566 Get FRU activation policy. |
|
1567 .TP |
|
1568 policy set <fru id> <lockmask> <lock> |
|
1569 .br |
|
1570 |
|
1571 Set FRU activation policy. \fIlockmask\fR is 1 or 0 to indicate action |
|
1572 on the deactivation or activation locked bit respectively. \fIlock\fR is |
|
1573 1 or 0 to set/clear locked bit. |
|
1574 .TP |
|
1575 portstate set|getall|getgranted|getdenied <parameters> |
|
1576 .br |
|
1577 |
|
1578 Get or set various port states. See usage for parameter details. |
|
1579 .RE |
|
1580 .TP |
|
1581 power <chassis power command> |
|
1582 .br |
|
1583 |
|
1584 Alias for the "chassis power" commands. |
|
1585 See the "chassis power" commands for usage information. |
|
1586 .TP |
|
1587 raw <netfn> <cmd> [<data>] |
|
1588 .br |
|
1589 |
|
1590 This will allow you to execute raw IPMI commands. For |
|
1591 example to query the POH counter with a raw command: |
|
1592 |
|
1593 ipmitool \-v \-I bmc raw 0x0 0xf |
|
1594 .br |
|
1595 RAW REQ (netfn=0x0 cmd=0xf data_len=0) |
|
1596 .br |
|
1597 RAW RSP (5 bytes) |
|
1598 .br |
|
1599 3c 72 0c 00 00 |
|
1600 .TP |
|
1601 sdr |
|
1602 .RS |
|
1603 .TP |
|
1604 info |
|
1605 .br |
|
1606 |
|
1607 This command will query the BMC for Sensor Data Record (SDR) Repository information. |
|
1608 .TP |
|
1609 type [list|<sensor type>] |
|
1610 .br |
|
1611 |
|
1612 Displays sensor data records only for the sensor type (e.g. `temperature', `voltage', etc.) |
|
1613 chosen. A list of all supported sensor types may be displayed if the `list' keyword is used instead |
|
1614 of a sensor type. Note that the sensor type is not case sensitive. Also note that there may be a large |
|
1615 delay before any information is displayed, because ipmitool does a full scan of all sensor records and builds |
|
1616 a list of just those that meet the type criterion given. |
|
1617 .TP |
|
1618 list|elist [all|full|compact|event|mcloc|fru|generic] |
|
1619 .br |
|
1620 |
|
1621 This command will read the Sensor Data Records (SDR) and |
|
1622 extract sensor information of a given type, then query each sensor and |
|
1623 print its name, reading, and status. The `elist' form of this command |
|
1624 prints additional information about each data record (e.g. threshold type, |
|
1625 sensor number, sensor entity). |
|
1626 .RS |
|
1627 .TP |
|
1628 Valid types are: |
|
1629 .RS |
|
1630 .TP |
|
1631 all |
|
1632 .br |
|
1633 |
|
1634 All SDR records (Sensor and Locator) |
|
1635 .TP |
|
1636 full |
|
1637 .br |
|
1638 |
|
1639 Full Sensor Record |
|
1640 .TP |
|
1641 compact |
|
1642 .br |
|
1643 |
|
1644 Compact Sensor Record |
|
1645 .TP |
|
1646 event |
|
1647 .br |
|
1648 |
|
1649 Event-Only Sensor Record |
|
1650 .TP |
|
1651 mcloc |
|
1652 .br |
|
1653 |
|
1654 Management Controller Locator Record |
|
1655 .TP |
|
1656 fru |
|
1657 .br |
|
1658 |
|
1659 FRU Locator Record |
|
1660 .TP |
|
1661 generic |
|
1662 .br |
|
1663 |
|
1664 Generic SDR records |
|
1665 .RE |
|
1666 .RE |
|
1667 .TP |
|
1668 entity <id>[.<instance>] |
|
1669 .br |
|
1670 |
|
1671 Displays all sensors associated with an entity. Get a list of |
|
1672 valid entity ids on the target system by issuing the `sdr list' command |
|
1673 with the verbose option (`-v'). A list of all entity ids can be found |
|
1674 in the IPMI specifications. |
|
1675 .TP |
|
1676 dump <file> |
|
1677 .br |
|
1678 |
|
1679 Dumps raw SDR data to a file. This file may also be used as the sdr cache, supplied to ipmitool |
|
1680 with the `\-S' option, dramatically speeding up the `sdr' and `sel elist' commands. |
|
1681 .TP |
|
1682 fill sensors |
|
1683 .br |
|
1684 |
|
1685 Create the SDR Repository for the current configuration. Will perform |
|
1686 a 'Clear SDR Repository' command so be careful. |
|
1687 .TP |
|
1688 fill file <filename> |
|
1689 .br |
|
1690 |
|
1691 Fill the SDR Repository using records stored in a binary data file. Will perform |
|
1692 a 'Clear SDR Repository' command so be careful. |
|
1693 .RE |
|
1694 .TP |
|
1695 sel |
|
1696 .br |
|
1697 |
|
1698 NOTE: System Event Log (SEL) entry-times are displayed as |
|
1699 `Pre-Init Time-stamp' if the SEL clock needs to be set. |
|
1700 Ensure that the SEL clock is accurate by invoking the |
|
1701 `sel time get' and |
|
1702 `sel time set <time string>' commands. |
|
1703 .RS |
|
1704 .TP |
|
1705 info |
|
1706 .br |
|
1707 |
|
1708 This command will query the BMC for information |
|
1709 about the System Event Log (SEL) and its contents. |
|
1710 .TP |
|
1711 clear |
|
1712 .br |
|
1713 |
|
1714 This command will clear the contents of the SEL. |
|
1715 It cannot be undone so be careful. |
|
1716 .TP |
|
1717 list|elist |
|
1718 .br |
|
1719 |
|
1720 When this command is invoked without arguments, the entire |
|
1721 contents of the SEL are displayed. In addition to the information |
|
1722 displayed by the `list' command, the `elist' command will cross-reference |
|
1723 SEL records with SDR records to produce descriptive event output. |
|
1724 |
|
1725 .RS |
|
1726 .TP |
|
1727 <count> | first <count> |
|
1728 .br |
|
1729 |
|
1730 Displays the first \fIcount\fR (least-recent) entries in the SEL. |
|
1731 If \fIcount\fR is zero, all entries are displayed. |
|
1732 .TP |
|
1733 last <count> |
|
1734 .br |
|
1735 |
|
1736 Displays the last \fIcount\fR (most-recent) entries in the SEL. |
|
1737 If \fIcount\fR is zero, all entries are displayed. |
|
1738 .RE |
|
1739 .TP |
|
1740 delete <SEL Record ID> ... <SEL Record ID> |
|
1741 .br |
|
1742 |
|
1743 Delete one or more SEL event records. |
|
1744 .TP |
|
1745 add <file> |
|
1746 .br |
|
1747 |
|
1748 Read event entries from a file and add them to the SEL. New SEL |
|
1749 entries area added onto the SEL after the last record in the SEL. |
|
1750 Record added is of type 2 and is automatically timestamped. |
|
1751 .TP |
|
1752 get <SEL Record ID> |
|
1753 .br |
|
1754 |
|
1755 Print information on the specified SEL Record entry. |
|
1756 .TP |
|
1757 save <file> |
|
1758 |
|
1759 Save SEL records to a text file that can be fed back into the |
|
1760 `event file' ipmitool command. This can be useful for |
|
1761 testing Event generation by building an appropriate Platform |
|
1762 Event Message file based on existing events. Please see the |
|
1763 available help for the 'event file ...' command for a description of |
|
1764 the format of this file. |
|
1765 .TP |
|
1766 writeraw <file> |
|
1767 |
|
1768 Save SEL records to a file in raw, binary format. This file can |
|
1769 be fed back to the `sel readraw' ipmitool command for viewing. |
|
1770 .TP |
|
1771 readraw <file> |
|
1772 |
|
1773 Read and display SEL records from a binary file. Such a file can |
|
1774 be created using the `sel writeraw' ipmitool command. |
|
1775 .TP |
|
1776 time |
|
1777 .RS |
|
1778 .TP |
|
1779 get |
|
1780 .br |
|
1781 |
|
1782 Displays the SEL clock's current time. |
|
1783 .TP |
|
1784 set <time string> |
|
1785 .br |
|
1786 |
|
1787 Sets the SEL clock. Future SEL entries will use the time |
|
1788 set by this command. <time string> is of the |
|
1789 form "MM/DD/YYYY HH:MM:SS". Note that hours are in 24-hour |
|
1790 form. It is recommended that the SEL be cleared before |
|
1791 setting the time. |
|
1792 .RE |
|
1793 .RE |
|
1794 .TP |
|
1795 sensor |
|
1796 .RS |
|
1797 .TP |
|
1798 list |
|
1799 .br |
|
1800 |
|
1801 Lists sensors and thresholds in a wide table format. |
|
1802 .TP |
|
1803 get <id> ... [id] |
|
1804 .br |
|
1805 |
|
1806 Prints information for sensors specified by name. |
|
1807 .TP |
|
1808 thresh <id> <threshold> <setting> |
|
1809 .br |
|
1810 |
|
1811 This allows you to set a particular sensor threshold |
|
1812 value. The sensor is specified by name. |
|
1813 .RS |
|
1814 .TP |
|
1815 Valid thresholds are: |
|
1816 .br |
|
1817 unr Upper Non\-Recoverable |
|
1818 .br |
|
1819 ucr Upper Critical |
|
1820 .br |
|
1821 unc Upper Non\-Critical |
|
1822 .br |
|
1823 lnc Lower Non\-Critical |
|
1824 .br |
|
1825 lcr Lower Critical |
|
1826 .br |
|
1827 lnr Lower Non\-Recoverable |
|
1828 .RE |
|
1829 .RE |
|
1830 .TP |
|
1831 session |
|
1832 .RS |
|
1833 .TP |
|
1834 info <active | all | id 0xnnnnnnnn | handle 0xnn> |
|
1835 .br |
|
1836 |
|
1837 Get information about the specified session(s). You may identify |
|
1838 sessions by their id, by their handle number, by their active status, |
|
1839 or by using the keyword `all' to specify all sessions. |
|
1840 .RE |
|
1841 .TP |
|
1842 sol |
|
1843 .RS |
|
1844 .TP |
|
1845 info [<channel number>] |
|
1846 .br |
|
1847 |
|
1848 Retrieve information about the Serial-Over-LAN configuration on |
|
1849 the specified channel. If no channel is given, it will display |
|
1850 SOL configuration data for the currently used channel. |
|
1851 .TP |
|
1852 payload <enable | disable | status> <channel> <userid> |
|
1853 .br |
|
1854 |
|
1855 Enable, disable or show status of SOL payload for the user on the |
|
1856 specified channel. |
|
1857 .TP |
|
1858 set <parameter> <value> [channel] |
|
1859 .br |
|
1860 |
|
1861 Configure parameters for Serial Over Lan. If no channel is given, |
|
1862 it will display SOL configuration data for the currently used |
|
1863 channel. Configuration parameter updates are automatically guarded |
|
1864 with the updates to the set-in-progress parameter. |
|
1865 .RS |
|
1866 .TP |
|
1867 Valid parameters and values are: |
|
1868 .br |
|
1869 .TP |
|
1870 set-in-progress |
|
1871 set-complete set-in-progress commit-write |
|
1872 .TP |
|
1873 enabled |
|
1874 true false |
|
1875 .TP |
|
1876 force-encryption |
|
1877 true false |
|
1878 .TP |
|
1879 force-authentication |
|
1880 true false |
|
1881 .TP |
|
1882 privilege-level |
|
1883 user operator admin oem |
|
1884 .TP |
|
1885 character-accumulate-level |
|
1886 Decimal number given in 5-millisecond increments |
|
1887 .TP |
|
1888 character-send-threshold |
|
1889 Decimal number |
|
1890 .TP |
|
1891 retry-count |
|
1892 Decimal number. 0 indicates no retries after packet is transmitted. |
|
1893 .TP |
|
1894 retry-interval |
|
1895 Decimal number in 10 millisend increments. 0 indicates |
|
1896 that retries should be sent back to back. |
|
1897 .TP |
|
1898 non-volatile-bit-rate |
|
1899 serial, 19.2, 38.4, 57.6, 115.2. Setting this value to |
|
1900 serial indicates that the BMC should use the setting used |
|
1901 by the IPMI over serial channel. |
|
1902 .TP |
|
1903 volatile-bit-rate |
|
1904 serial, 19.2, 38.4, 57.6, 115.2. Setting this value to |
|
1905 serial indiates that the BMC should use the setting used |
|
1906 by the IPMI over serial channel. |
|
1907 .RE |
|
1908 .TP |
|
1909 activate [usesolkeepalive | nokeepalive] |
|
1910 .br |
|
1911 |
|
1912 Causes ipmitool to enter Serial Over LAN |
|
1913 mode, and is only available when using the lanplus |
|
1914 interface. An RMCP+ connection is made to the BMC, |
|
1915 the terminal is set to raw mode, and user input is |
|
1916 sent to the serial console on the remote server. |
|
1917 On exit,the the SOL payload mode is deactivated and |
|
1918 the terminal is reset to its original settings. |
|
1919 .RS |
|
1920 |
|
1921 Special escape sequences are provided to control the SOL session: |
|
1922 .RS |
|
1923 .TP |
|
1924 ~. Terminate connection |
|
1925 .TP |
|
1926 ~^Z Suspend ipmitool |
|
1927 .TP |
|
1928 ~^X Suspend ipmitool, but don't restore tty on restart |
|
1929 .TP |
|
1930 ~B Send break |
|
1931 .TP |
|
1932 ~~ Send the escape character by typing it twice |
|
1933 .TP |
|
1934 ~? Print the supported escape sequences |
|
1935 .RE |
|
1936 |
|
1937 Note that escapes are only recognized immediately after newline. |
|
1938 .RE |
|
1939 .TP |
|
1940 deactivate |
|
1941 .br |
|
1942 |
|
1943 Deactivates Serial Over LAN mode on the BMC. |
|
1944 Exiting Serial Over LAN mode should automatically cause |
|
1945 this command to be sent to the BMC, but in the case of an |
|
1946 unintentional exit from SOL mode, this command may be |
|
1947 necessary to reset the state of the BMC. |
|
1948 .RE |
|
1949 .TP |
|
1950 spd <i2cbus> <i2caddr> [<channel>] [<maxread>] |
|
1951 .br |
|
1952 |
|
1953 This command may be used to read SPD (Serial Presence Detect) data using the |
|
1954 I2C Master Write-Read IPMI command. |
|
1955 |
|
1956 .TP |
|
1957 sunoem |
|
1958 .br |
|
1959 |
|
1960 Sun OEM-specific IPMI commands. Support for these commands depends heavily on the Sun platform targeted. |
|
1961 Please consult your Sun Hardware Reference Guide for information on Sun OEM-specific IPMI |
|
1962 functionality to determine if the following commands are supported on your desired platform. |
|
1963 .RS |
|
1964 .TP |
|
1965 fan speed <0-100> |
|
1966 .br |
|
1967 |
|
1968 Sets the system fan speed (in units of PWM duty cycle) |
|
1969 .RE |
|
1970 .RS |
|
1971 .TP |
|
1972 sshkey |
|
1973 .br |
|
1974 |
|
1975 Administer SSH keys for service processor users. |
|
1976 .RS |
|
1977 .TP |
|
1978 set <userid> <id_rsa.pub> |
|
1979 .br |
|
1980 |
|
1981 Sets the SSH key for the given userid to the key found in the given file. (A |
|
1982 list of users may be obtained with the 'user list' command). |
|
1983 .RE |
|
1984 .RS |
|
1985 .TP |
|
1986 del <userid> |
|
1987 .br |
|
1988 |
|
1989 Delete the SSH key for the given userid. |
|
1990 .RE |
|
1991 .RE |
|
1992 |
|
1993 .RS |
|
1994 .TP |
|
1995 led |
|
1996 .br |
|
1997 |
|
1998 Manipulate the settings for LEDs found via the `sdr elist generic' command. |
|
1999 Once the sensor ID of the LED is found (the `elist' command displayed the sensor ID), |
|
2000 it may be used in the following subcommands. When an LED type is required, it can |
|
2001 be one of the following values: `OK2RM' (OK to Remove), `SERVICE' (Service Required), |
|
2002 `ACT' (Activity), or `LOCATE' (Locate). When an LED mode is required, it can be one |
|
2003 of the following values: `OFF' (Off), `ON' (Steady On), `STANDBY' (100ms ON, 2900ms OFF blink rate), |
|
2004 `SLOW' (1HZ blink rate), or `FAST' (4HZ blink rate). |
|
2005 |
|
2006 .RS |
|
2007 .TP |
|
2008 get <sensorid> [<ledtype>] |
|
2009 .br |
|
2010 |
|
2011 Read the status of the LED with the given <sensorid>. If <sensorid> is the special keyword `all', then |
|
2012 the status of all LEDs will be displayed. The optional parameter, <ledtype>, further restricts the output |
|
2013 to LEDs of the given type. |
|
2014 .RE |
|
2015 .RS |
|
2016 .TP |
|
2017 set <sensorid> <ledmode> [<ledtype>] |
|
2018 .br |
|
2019 |
|
2020 Sets the mode of the LED with the given <sensorid> (and optionally the given type <ledtype>) to the given <ledmode>. |
|
2021 If <sensorid> is the special keyword `all', then the status of all LEDs will be set (optionally qualified by the |
|
2022 given type <ledtype>). |
|
2023 .RE |
|
2024 .RE |
|
2025 .TP |
|
2026 user |
|
2027 .RS |
|
2028 .TP |
|
2029 summary |
|
2030 .br |
|
2031 |
|
2032 Displays a summary of userid information, including maximum number of userids, |
|
2033 the number of enabled users, and the number of fixed names defined. |
|
2034 .TP |
|
2035 list |
|
2036 .br |
|
2037 |
|
2038 Displays a list of user information for all defined userids. |
|
2039 .TP |
|
2040 set |
|
2041 .RS |
|
2042 .TP |
|
2043 name <userid> <username> |
|
2044 .br |
|
2045 |
|
2046 Sets the username associated with the given userid. |
|
2047 .TP |
|
2048 password <userid> [<password>] |
|
2049 .br |
|
2050 |
|
2051 Sets the password for the given userid. If no password is given, |
|
2052 the password is cleared (set to the NULL password). Be careful when |
|
2053 removing passwords from administrator-level accounts. |
|
2054 .RE |
|
2055 .TP |
|
2056 disable <userid> |
|
2057 .br |
|
2058 |
|
2059 Disables access to the BMC by the given userid. |
|
2060 .TP |
|
2061 enable <userid> |
|
2062 .br |
|
2063 |
|
2064 Enables access to the BMC by the given userid. |
|
2065 .TP |
|
2066 priv <userid> <privilege level> [<channel>] |
|
2067 .br |
|
2068 |
|
2069 Set user privilege level on the specified channel. If the channel is not |
|
2070 specified, the current channel will be used. |
|
2071 .TP |
|
2072 test <userid> <16|20> [<password>] |
|
2073 .br |
|
2074 |
|
2075 Determine whether a password has been stored as 16 or 20 bytes. |
|
2076 .RE |
|
2077 |
|
2078 \fINOTE\fR: Sun systems, such |
|
2079 as the v20z and v40z, maintain the LAN interface on |
|
2080 channel 1. To determine on which channel the LAN interface |
|
2081 is located, issue the `channel info \fIchannel\fR' command. |
|
2082 .SH BMC INTERFACE |
|
2083 The ipmitool bmc interface utilizes the bmc device driver. |
|
2084 |
|
2085 In order to force ipmitool to make use of the device interface |
|
2086 you can specify it on the command line: |
|
2087 |
|
2088 ipmitool \-I bmc <command> |
|
2089 |
|
2090 .SH LAN INTERFACE |
|
2091 The ipmitool lan interface communicates with a remote BMC over an |
|
2092 Ethernet LAN connection using UDP over IPv4. UDP datagrams |
|
2093 are formatted to contain IPMI request/response messages with |
|
2094 IPMI session headers and RMCP headers. |
|
2095 |
|
2096 IPMI\-over\-LAN uses version 1 of the Remote Management Control |
|
2097 Protocol (RMCP) to support pre\-OS and OS\-absent management. |
|
2098 RMCP is a request\-response protocol delivered using |
|
2099 UDP datagrams to port 623. |
|
2100 |
|
2101 The LAN interface is an authenticated multi\-session connection; |
|
2102 messages delivered to the BMC can (and should) be |
|
2103 authenticate with a challenge/response protocol with either |
|
2104 straight password/key or MD5 message\-digest. |
|
2105 ipmitool will attempt to connect with administrator |
|
2106 privilege level as this is required to perform chassis power |
|
2107 functions. |
|
2108 |
|
2109 You can tell ipmitool to use the lan interface with the \-I |
|
2110 option: |
|
2111 |
|
2112 ipmitool \-I lan \-H <hostname> [\-f password_file] <command> |
|
2113 |
|
2114 A hostname must be given on the command line in order to use |
|
2115 the lan interface with 'ipmitool'. The \fIpassword_file\fR |
|
2116 is optional but, if present, should contain the password to be |
|
2117 used for authentication. If no password is given, ipmitool will |
|
2118 attempt to connect without authentication. |
|
2119 |
|
2120 If \fIpassword_file\fR is present and non\-empty ipmitool will |
|
2121 attempt to authenticate with an MD5 message-digest if MD5 is |
|
2122 supported by the BMC. If MD5 is not supported by the BMC, |
|
2123 straight password/key authentication will be attempted. |
|
2124 |
|
2125 .SH LANPLUS INTERFACE |
|
2126 |
|
2127 .LP |
|
2128 Like the \fIlan\fP interface, the \fIlanplus\fP interface |
|
2129 communicates with the BMC over an Ethernet LAN connection |
|
2130 using UDP over IPv4. The difference is that the \fIlanplus\fP |
|
2131 interface uses the RMCP+ protocol as described in the IPMI v2.0 |
|
2132 specification. RMCP+ allows for improved authentication and data |
|
2133 integrity checks, as well as encryption and the ability to carry |
|
2134 multiple types of payloads. Generic Serial-over-LAN support |
|
2135 requires RMCP+, so the ipmitool \fIsol activate\fP command requires |
|
2136 the use of the \fIlanplus\fP interface. |
|
2137 .LP |
|
2138 Establishing a RMCP+ session uses RAKP (Remote |
|
2139 Authenticated Key-Exchange Protocol), which enables the negotiation of |
|
2140 many options. ipmitool does not yet allow the user to specify |
|
2141 values for all the options, defaulting to the most obvious settings for those |
|
2142 settings marked as required in the v2.0 specification. Authentication and integrity |
|
2143 HMACs use the SHA-1 algorithm, and encryption is performed with AES, in CBC mode, |
|
2144 at 128-bits of strength. Role-level logins are not supported. ipmitool must |
|
2145 be configured with the appropriate option for the \fIlanplus\fP interface |
|
2146 to be available, as it is not enabled by default. This interface currently |
|
2147 requires the OpenSSL library. |
|
2148 .LP |
|
2149 You can tell ipmitool to use the lanplus interface with the \fB\-I\fR option: |
|
2150 .PP |
|
2151 ipmitool \-I lanplus \-H <hostname> [\-U username] [\-f password_file] <expression> |
|
2152 .LP |
|
2153 The options available for the \fIlanplus\fP interface are identical to those available for |
|
2154 the \fIlan\fP interface. |
|
2155 |
|
2156 .SH EXIT STATUS |
|
2157 |
|
2158 Upon successful completion, ipmitool returns 0. On failure, 1 is returned. |
|
2159 |
|
2160 .SH EXAMPLES |
|
2161 .TP |
|
2162 Example 1 : Listing remote sensors: |
|
2163 |
|
2164 > ipmitool \-I lan \-H 1.2.3.4 \-f passfile sdr list |
|
2165 .br |
|
2166 Baseboard 1.25V | 1.24 Volts | ok |
|
2167 .br |
|
2168 Baseboard 2.5V | 2.49 Volts | ok |
|
2169 .br |
|
2170 Baseboard 3.3V | 3.32 Volts | ok |
|
2171 .TP |
|
2172 Example 2: Displaying status of a remote sensor: |
|
2173 |
|
2174 > ipmitool \-I lan \-H 1.2.3.4 \-f passfile sensor get "Baseboard 1.25V" |
|
2175 .br |
|
2176 Locating sensor record... |
|
2177 .br |
|
2178 Sensor ID : Baseboard 1.25V (0x10) |
|
2179 .br |
|
2180 Sensor Type (Analog) : Voltage |
|
2181 .br |
|
2182 Sensor Reading : 1.245 (+/\- 0.039) Volts |
|
2183 .br |
|
2184 Status : ok |
|
2185 .br |
|
2186 Lower Non\-Recoverable : na |
|
2187 .br |
|
2188 Lower Critical : 1.078 |
|
2189 .br |
|
2190 Lower Non\-Critical : 1.107 |
|
2191 .br |
|
2192 Upper Non\-Critical : 1.382 |
|
2193 .br |
|
2194 Upper Critical : 1.431 |
|
2195 .br |
|
2196 Upper Non\-Recoverable : na |
|
2197 .TP |
|
2198 Example 3: Displaying the power status of a remote chassis: |
|
2199 |
|
2200 > ipmitool \-I lan \-H 1.2.3.4 \-f passfile chassis power status |
|
2201 .br |
|
2202 Chassis Power is on |
|
2203 .TP |
|
2204 Example 4: Controlling the power on a remote chassis: |
|
2205 |
|
2206 > ipmitool \-I lan \-H 1.2.3.4 \-f passfile chassis power on |
|
2207 .br |
|
2208 Chassis Power Control: Up/On |
|
2209 |
|
2210 .SH FILES |
|
2211 |
|
2212 \fB/kernel/drv/amd64//bmc\fR |
|
2213 .in +30n |
|
2214 .sp |
|
2215 x86 \fBELF\fR kernel module for the bmc driver. |
|
2216 .sp |
|
2217 .in -30n |
|
2218 \fB/platform/sun4v/kernel/drv/sparcv9/bmc\fR |
|
2219 .in +30n |
|
2220 .sp |
|
2221 sparc \fBELF\fR kernel module for the bmc driver. |
|
2222 .in -30n |
|
2223 \fB/dev/bmc\fR |
|
2224 .in +30n |
|
2225 .sp |
|
2226 Character device node used to communicate with the bmc driver. |
|
2227 .in -30n |
|
2228 |
|
2229 .TP |
|
2230 IPMI Specifications |
|
2231 http://www.intel.com/design/servers/ipmi/spec.htm |
|
2232 .SH SEE ALSO |
|
2233 attributes(5) |
|
2234 .SH NOTES |
|
2235 IPMI V1.5 and, at the time of writing, IPMI V2.X only support IPv4. |
|
2236 There is no requirement for a BMC to use the same IP address as its |
|
2237 host system. In an IPv6 environment the host system can have an IPv6 |
|
2238 address and 'ipmitool' can be used to assign an IPv4 address to the |
|
2239 BMC. |
|