1ipmitool(1) ipmitool(1)
2
6 ipmitool - utility for controlling IPMI-enabled devices
7
9 ipmitool [-c|-h|-d N|-v|-V] -I open <command>
10 ipmitool [-c|-h|-v|-V] -I lan -H <hostname>
12 [-p <port>]
13 [-U <username>]
14 [-A <authtype>]
15 [-L <privlvl>]
16 [-a|-E|-P|-f <password>]
17 [-o <oemtype>]
18 [-O <sel oem>]
19 [-e <esc_char>]
20 <command>
21 ipmitool [-c|-h|-v|-V] -I lanplus -H <hostname>
23 [-p <port>]
24 [-U <username>]
25 [-L <privlvl>]
26 [-a|-E|-P|-f <password>]
27 [-o <oemtype>]
28 [-O <sel oem>]
29 [-C <ciphersuite>]
30 [-K|-k <kg_key>]
31 [-y <hex_kg_key>]
32 [-e <esc_char>]
33 <command>
34
36 This program lets you manage Intelligent Platform Management Interface
37 (IPMI) functions of either the local system, via a kernel device
38 driver, or a remote system, using IPMI V1.5 and IPMI v2.0. These func‐
39 tions include printing FRU information, LAN configuration, sensor read‐
40 ings, and remote chassis power control.
41 IPMI management of a local system interface requires a compatible IPMI
43 kernel driver to be installed and configured. On Linux this driver is
44 called OpenIPMI and it is included in standard distributions. On
45 Solaris this driver is called BMC and is inclued in Solaris 10. Man‐
46 agement of a remote station requires the IPMI-over-LAN interface to be
47 enabled and configured. Depending on the particular requirements of
48 each system it may be possible to enable the LAN interface using ipmi‐
49 tool over the system interface.
50
52 -a Prompt for the remote server password.
53 -A <authtype>
55 Specify an authentication type to use during IPMIv1.5 lan ses‐
56 sion activation. Supported types are NONE, PASSWORD, MD2, MD5,
57 or OEM.
58 -c Present output in CSV (comma separated variable) format. This
60 is not available with all commands.
61 -e <sol_escape_char>
63 Use supplied character for SOL session escape character. The
64 default is to use ~ but this can conflict with ssh sessions.
65 -k <key>
67 Use supplied Kg key for IPMIv2 authentication. The default is
68 not to use any Kg key.
69 -y <hex key>
71 Use supplied Kg key for IPMIv2 authentication. The key is
72 expected in hexadecimal format and can be used to specify keys
73 with non-printable characters. E.g. '-k PASSWORD' and '-y
74 50415353574F5244' are equivalent. The default is not to use any
75 Kg key.
76 -C <ciphersuite>
78 The remote server authentication, integrity, and encryption
79 algorithms to use for IPMIv2 lanplus connections. See table
80 22-19 in the IPMIv2 specification. The default is 3 which spec‐
81 ifies RAKP-HMAC-SHA1 authentication, HMAC-SHA1-96 integrity, and
82 AES-CBC-128 encryption algorightms.
83 -E The remote server password is specified by the environment vari‐
85 able IPMI_PASSWORD.
86 -f <password_file>
88 Specifies a file containing the remote server password. If this
89 option is absent, or if password_file is empty, the password
90 will default to NULL.
91 -h Get basic usage help from the command line.
93 -H <address>
95 Remote server address, can be IP address or hostname. This
96 option is required for lan and lanplus interfaces.
97 -I <interface>
99 Selects IPMI interface to use. Supported interfaces that are
100 compiled in are visible in the usage help output.
101 -L <privlvl>
103 Force session privilege level. Can be CALLBACK, USER, OPERATOR,
104 ADMINISTRATOR. Default is ADMINISTRATOR.
105 -m <local_address>
107 Set the local IPMB address. The default is 0x20 and there
108 should be no need to change it for normal operation.
109 -o <oemtype>
111 Select OEM type to support. This usually involves minor hacks
112 in place in the code to work around quirks in various BMCs from
113 various manufacturers. Use -o list to see a list of current
114 supported OEM types.
115 -O <sel oem>
117 Open selected file and read OEM SEL event descriptions to be
118 used during SEL listings. See examples in contrib dir for file
119 format.
120 -p <port>
122 Remote server UDP port to connect to. Default is 623.
123 -P <password>
125 Remote server password is specified on the command line. If
126 supported it will be obscured in the process list. Note! Speci‐
127 fying the password as a command line option is not recommended.
128 -S <sdr_cache_file>
130 Use local file for remote SDR cache. Using a local SDR cache
131 can drastically increase performance for commands that require
132 knowledge of the entire SDR to perform their function. Local
133 SDR cache from a remote system can be created with the sdr dump
134 command.
135 -t <target_address>
137 Bridge IPMI requests to the remote target address.
138 -U <username>
140 Remote server username, default is NULL user.
141 -d N Use device number N to specify the /dev/ipmiN (or /dev/ipmi/N or
143 /dev/ipmidev/N) device to use for in-band BMC communication.
144 Used to target a specific BMC on a multi-node, multi-BMC system
145 through the ipmi device driver interface. Default is 0.
146 -v Increase verbose output level. This option may be specified
148 multiple times to increase the level of debug output. If given
149 three times you will get hexdumps of all incoming and outgoing
150 packets.
151 -V Display version information.
153 If no password method is specified then ipmitool will prompt the user
156 for a password. If no password is entered at the prompt, the remote
157 server password will default to NULL.
158
160 There are several security issues be be considered before enabling the
161 IPMI LAN interface. A remote station has the ability to control a sys‐
162 tem's power state as well as being able to gather certain platform
163 information. To reduce vulnerability it is strongly advised that the
164 IPMI LAN interface only be enabled in 'trusted' environments where sys‐
165 tem security is not an issue or where there is a dedicated secure 'man‐
166 agement network'.
167 Further it is strongly advised that you should not enable IPMI for
169 remote access without setting a password, and that that password should
170 not be the same as any other password on that system.
171 When an IPMI password is changed on a remote machine with the IPMIv1.5
173 lan interface the new password is sent across the network as clear
174 text. This could be observed and then used to attack the remote sys‐
175 tem. It is thus recommended that IPMI password management only be done
176 over IPMIv2.0 lanplus interface or the system interface on the local
177 station.
178 For IPMI v1.5, the maximum password length is 16 characters. Passwords
180 longer than 16 characters will be truncated.
181 For IPMI v2.0, the maximum password length is 20 characters; longer
183 passwords are truncated.
184
186 help This can be used to get command-line help on ipmitool com‐
187 mands. It may also be placed at the end of commands to get
188 option usage help.
189 ipmitool help
191 Commands:
192 raw Send a RAW IPMI request and print response
193 i2c Send an I2C Master Write-Read command and
194 print response
195 spd Print SPD info from remote I2C device
196 lan Configure LAN Channels
197 chassis Get chassis status and set power state
198 power Shortcut to chassis power commands
199 event Send events to MC
200 mc Management Controller status and global
201 enables
202 sdr Print Sensor Data Repository entries and
203 readings
204 sensor Print detailed sensor information
205 fru Print built-in FRU and scan for FRU loca‐
206 tors
207 sel Print System Event Log (SEL)
208 pef Configure Platform Event Filtering (PEF)
209 sol Configure and connect IPMIv2.0
210 Serial-over-LAN
211 tsol Configure and connect Tyan IPMIv1.5
212 Serial-over-LAN
213 isol Configure and connect Intel IPMIv1.5
214 Serial-over-LAN
215 user Configure Management Controller users
216 channel Configure Management Controller channels
217 session Print session information
218 sunoem Manage Sun OEM Extensions
219 kontronoem Manage Kontron OEM Extensions
220 picmg Run a PICMG/ATA extended command
221 firewall Configure Firmware Firewall
222 shell Launch interactive IPMI shell
223 exec Run list of commands from file
224 set Set runtime variable for shell and exec
225 echo Used to echo lines to stdout in scripts
226 ekanalyzer run FRU-Ekeying analyzer using FRU files
227 ipmitool chassis help
229 Chassis Commands: status, power, identify, policy,
230 restart_cause, poh, bootdev, bootparam, selftest
231 ipmitool chassis power help
233 chassis power Commands: status, on, off, cycle, reset, diag,
234 soft
235 bmc|mc
237 reset <warm|cold>
239 Instructs the BMC to perform a warm or cold reset.
241 guid
243 Display the Management Controller Globally Unique IDenti‐
245 fier.
246 info
248 Displays information about the BMC hardware, including
250 device revision, firmware revision, IPMI version sup‐
251 ported, manufacturer ID, and information on additional
252 device support.
253 watchdog
255 These commands allow a user to view and change the cur‐
257 rent state of the watchdog timer.
258 get
260 Show current Watchdog Timer settings and countdown
262 state.
263 reset
265 Reset the Watchdog Timer to its most recent state
267 and restart the countdown timer.
268 off
270 Turn off a currently running Watchdog countdown
272 timer.
273 selftest
275 Check on the basic health of the BMC by executing the Get
277 Self Test results command and report the results.
278 getenables
280 Displays a list of the currently enabled options for the
282 BMC.
283 setenables <option>=[on|off]
285 Enables or disables the given option. This command is
287 only supported over the system interface according to the
288 IPMI specification. Currently supported values for
289 option include:
290 recv_msg_intr
292 Receive Message Queue Interrupt
294 event_msg_intr
296 Event Message Buffer Full Interrupt
298 event_msg
300 Event Message Buffer
302 system_event_log
304 System Event Logging
306 oem0
308 OEM-Defined option #0
310 oem1
312 OEM-Defined option #1
314 oem2
316 OEM-Defined option #2
318 channel
320 authcap <channel number> <max priv>
322 Displays information about the authentication capabili‐
324 ties of the selected channel at the specified privilege
325 level.
326 Possible privilege levels are:
328 1 Callback level
329 2 User level
330 3 Operator level
331 4 Administrator level
332 5 OEM Proprietary level
333 info [channel number]
335 Displays information about the selected channel. If
337 no channel is given it will display information about the
338 currently used channel.
339 > ipmitool channel info
341 Channel 0xf info:
342 Channel Medium Type : System Interface
343 Channel Protocol Type : KCS
344 Session Support : session-less
345 Active Session Count : 0
346 Protocol Vendor ID : 7154
347 getaccess <channel number> [<userid>]
349 Configure the given userid as the default on the given
351 channel number. When the given channel is subsequently
352 used, the user is identified implicitly by the given
353 userid.
354 setaccess <channel number> <userid> [<callin=on|off>]
356 [<ipmi=on|off>] [<link=on|off>] [<privilege=level>]
357 Configure user access information on the given channel
359 for the given userid.
360 getciphers <ipmi|sol> [<channel>]
362 Displays the list of cipher suites supported for the
364 given application (ipmi or sol) on the given channel.
365 chassis
367 status
369 Displays information regarding the high-level status of
371 the system chassis and main power subsystem.
372 poh
374 This command will return the Power-On Hours counter.
376 identify <interval>
378 Control the front panel identify light. Default inter‐
380 val is 15 seconds. Use 0 to turn off. Use "force" to
381 turn on indefinitely.
382 restart_cause
384 Query the chassis for the cause of the last system
386 restart.
387 selftest
389 Check on the basic health of the BMC by executing the Get
391 Self Test results command and report the results.
392 policy
394 Set the chassis power policy in the event power fail‐
396 ure.
397 list
399 Return supported policies.
401 always-on
403 Turn on when power is restored.
405 previous
407 Returned to previous state when power is
409 restored.
410 always-off
412 Stay off after power is restored.
414 power
416 Performs a chassis control command to view and change
418 the power state.
419 status
421 Show current chassis power status.
423 on
425 Power up chassis.
427 off
429 Power down chassis into soft off (S4/S5 state).
431 WARNING: This command does not initiate a clean
432 shutdown of the operating system prior to powering
433 down the system.
434 cycle
436 Provides a power off interval of at least 1 sec‐
438 ond. No action should occur if chassis power is
439 in S4/S5 state, but it is recommended to check
440 power state first and only issue a power cycle
441 command if the system power is on or in lower
442 sleep state than S4/S5.
443 reset
445 This command will perform a hard reset.
447 diag
449 Pulse a diagnostic interrupt (NMI) directly to the
451 processor(s).
452 soft
454 Initiate a soft-shutdown of OS via ACPI. This can
456 be done in a number of ways, commonly by simulat‐
457 ing an overtemperture or by simulating a power
458 button press. It is necessary for there to be
459 Operating System support for ACPI and some sort of
460 daemon watching for events for this soft power to
461 work.
462 bootdev <device> [<clear-cmos=yes|no>] [<options=help,...>]
464 Request the system to boot from an alternate boot device
466 on next reboot. The clear-cmos option, if supplied, will
467 instruct the BIOS to clear its CMOS on the next reboot.
468 Various options may be used to modify the boot device
469 settings. Run "bootdev none options=help" for a list of
470 available boot device modifiers/options.
471 Currently supported values for <device> are:
474 none
476 Do not change boot device
478 pxe
480 Force PXE boot
482 disk
484 Force boot from BIOS default boot device
486 safe
488 Force boot from BIOS default boot device, request
490 Safe Mode
491 diag
493 Force boot from diagnostic partition
495 cdrom
497 Force boot from CD/DVD
499 bios
501 Force boot into BIOS setup
503 floppy
505 Force boot from Floppy/primary removable media
507 bootparam
509 Get or set various system boot option parameters.
511 get <param #>
513 Get boot parameter. Currently supported values for
515 <param #> are:
516 0 - Set In Progress
518 1 - Service Partition Selector
520 2 - Service Partition Scan
522 3 - BMC Boot Flag Valid Bit Clearing
524 4 - Boot Info Acknowledge
526 5 - Boot Flags
528 6 - Boot Initiator Info
530 7 - Boot Initiator Mailbox
532 set <option> [value ...]
535 Set boot parameter.
537 Currently supported values for <option> are:
540 force_pxe
542 Force PXE boot
544 force_disk
546 Force boot from default hard-drive
548 force_safe
550 Force boot from default hard-drive, request
552 Safe Mode
553 force_diag
555 Force boot from diagnostic partition
557 force_cdrom
559 Force boot from CD/DVD
561 force_bios
563 Force boot into BIOS setup
565 ekanalyzer <command> <xx=filename1> <xx=filename2> [<rc=filename3>] ...
568 NOTE : This command can support a maximum of 8 files per command
570 line
571 filename1 : binary file that stores FRU data of a Carrier or an
573 AMC module
574 filename2 : binary file that stores FRU data of an AMC module.
576 These binary files can be generated from command:
577 ipmitool fru read <id> <filename>
578 filename3 : configuration file used for configuring On-Carrier
580 Device ID
581 or OEM GUID. This file is optional.
582 xx : indicates the type of the file. It can take the following
584 value:
585 oc : On-Carrier device
587 a1 : AMC slot A1
589 a2 : AMC slot A2
591 a3 : AMC slot A3
593 a4 : AMC slot A4
595 b1 : AMC slot B1
597 b2 : AMC slot B2
599 b3 : AMC slot B3
601 b4 : AMC slot B4
603 sm : Shelf Manager
605 The available commands for ekanalyzer are:
608 print [<carrier | power | all>]
611 carrier (default) <oc=filename1> <oc=filename2> ...
613 Display point to point physical connectivity
615 between carriers and AMC modules.
616 Example:
617 > ipmitool ekanalyzer print carrier oc=fru
618 oc=carrierfru
619 From Carrier file: fru
620 Number of AMC bays supported by Carrier: 2
621 AMC slot B1 topology:
622 Port 0 =====> On Carrier Device ID 0,
623 Port 16
624 Port 1 =====> On Carrier Device ID 0,
625 Port 12
626 Port 2 =====> AMC slot B2, Port 2
627 AMC slot B2 topology:
628 Port 0 =====> On Carrier Device ID 0,
629 Port 3
630 Port 2 =====> AMC slot B1, Port 2
631 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
632 From Carrier file: carrierfru
633 On Carrier Device ID 0 topology:
634 Port 0 =====> AMC slot B1, Port 4
635 Port 1 =====> AMC slot B1, Port 5
636 Port 2 =====> AMC slot B2, Port 6
637 Port 3 =====> AMC slot B2, Port 7
638 AMC slot B1 topology:
639 Port 0 =====> AMC slot B2, Port 0
640 AMC slot B1 topology:
641 Port 1 =====> AMC slot B2, Port 1
642 Number of AMC bays supported by Carrier: 2
643 power <xx=filename1> <xx=filename2> ...
646 Display power supply informations between carrier
648 and AMC modules.
649 all <xx=filename> <xx=filename> ...
651 Display both physical connectivity and power sup‐
653 ply of each carrier and AMC modules.
654 frushow <xx=filename>
657 Convert a binary FRU file into human readable text for‐
658 mat. Use -v option to get more display information.
659 summary [<match | unmatch | all>]
662 match (default) <xx=filename> <xx=filename> ...
664 Display only matched results of Ekeying match
665 between an On-Carrier device and an AMC module or
666 between 2 AMC modules. Example:
667 > ipmitool ekanalyzer summary match oc=fru
668 b1=amcB1 a2=amcA2
669 On-Carrier Device vs AMC slot B1
670 AMC slot B1 port 0 ==> On-Carrier Device 0 port
671 16
672 Matching Result
673 - From On-Carrier Device ID 0
674 -Channel ID 11 || Lane 0: enable
675 -Link Type: AMC.2 Ethernet
676 -Link Type extension: 1000BASE-BX (SerDES
677 Gigabit) Ethernet link
678 -Link Group ID: 0 || Link Asym. Match: exact
679 match
680 - To AMC slot B1
681 -Channel ID 0 || Lane 0: enable
682 -Link Type: AMC.2 Ethernet
683 -Link Type extension: 1000BASE-BX (SerDES
684 Gigabit) Ethernet link
685 -Link Group ID: 0 || Link Asym. Match: exact
686 match
687 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
688 AMC slot B1 port 1 ==> On-Carrier Device 0 port
689 12
690 Matching Result
691 - From On-Carrier Device ID 0
692 -Channel ID 6 || Lane 0: enable
693 -Link Type: AMC.2 Ethernet
694 -Link Type extension: 1000BASE-BX (SerDES
695 Gigabit) Ethernet link
696 -Link Group ID: 0 || Link Asym. Match: exact
697 match
698 - To AMC slot B1
699 -Channel ID 1 || Lane 0: enable
700 -Link Type: AMC.2 Ethernet
701 -Link Type extension: 1000BASE-BX (SerDES
702 Gigabit) Ethernet link
703 -Link Group ID: 0 || Link Asym. Match: exact
704 match
705 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
706 On-Carrier Device vs AMC slot A2
707 AMC slot A2 port 0 ==> On-Carrier Device 0 port
708 3
709 Matching Result
710 - From On-Carrier Device ID 0
711 -Channel ID 9 || Lane 0: enable
712 -Link Type: AMC.2 Ethernet
713 -Link Type extension: 1000BASE-BX (SerDES
714 Gigabit) Ethernet link
715 -Link Group ID: 0 || Link Asym. Match: exact
716 match
717 - To AMC slot A2
718 -Channel ID 0 || Lane 0: enable
719 -Link Type: AMC.2 Ethernet
720 -Link Type extension: 1000BASE-BX (SerDES
721 Gigabit) Ethernet link
722 -Link Group ID: 0 || Link Asym. Match: exact
723 match
724 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
725 AMC slot B1 vs AMC slot A2
726 AMC slot A2 port 2 ==> AMC slot B1 port 2
727 Matching Result
728 - From AMC slot B1
729 -Channel ID 2 || Lane 0: enable
730 -Link Type: AMC.3 Storage
731 -Link Type extension: Serial Attached SCSI
732 (SAS/SATA)
733 -Link Group ID: 0 || Link Asym. Match: FC or
734 SAS interface {exact match}
735 - To AMC slot A2
736 -Channel ID 2 || Lane 0: enable
737 -Link Type: AMC.3 Storage
738 -Link Type extension: Serial Attached SCSI
739 (SAS/SATA)
740 -Link Group ID: 0 || Link Asym. Match: FC or
741 SAS interface {exact match}
742 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
743 unmatch <xx=filename> <xx=filename> ...
745 Display the unmatched results of Ekeying match
747 between an On-Carrier device and an AMC module or
748 between 2 AMC modules
749 all <xx=filename> <xx=filename> ...
751 Display both matched result and unmatched results
753 of Ekeying match between two cards or two modules.
754 event
756 <predefined event number N>
758 Send a pre-defined test event to the System Event Log.
760 The following events are included as a means to test the
761 functionality of the System Event Log component of the
762 BMC (an entry will be added each time the event N command
763 is executed).
764 Currently supported values for N are:
766 1 Temperature: Upper Critical: Going High
767 2 Voltage Threshold: Lower Critical: Going Low
768 3 Memory: Correctable ECC
769 NOTE: These pre-defined events will likely not produce
771 "accurate" SEL records for a particular system because
772 they will not be correctly tied to a valid sensor number,
773 but they are sufficient to verify correct operation of
774 the SEL.
775 file <filename>
778 Event log records specified in <filename> will be added
780 to the System Event Log.
781 The format of each line in the file is as follows:
783 <{EvM Revision} {Sensor Type} {Sensor Num} {Event
785 Dir/Type} {Event Data 0} {Event Data 1} {Event Data 2}>[#
786 COMMENT]
787 e.g.: 0x4 0x2 0x60 0x1 0x52 0x0 0x0 # Voltage threshold:
789 Lower Critical: Going Low
790 EvM Revision - The "Event Message Revision" is 0x04 for
792 messages that comply with the IPMI 2.0 Specification and
793 0x03 for messages that comply with the IPMI 1.0 Specifi‐
794 cation.
795 Sensor Type - Indicates the Event Type or Class.
797 Sensor Num - Represents the 'sensor' within the manage‐
799 ment controller that generated the Event Message.
800 Event Dir/Type - This field is encoded with the event
802 direction as the high bit (bit 7) and the event type as
803 the low 7 bits. Event direction is 0 for an assertion
804 event and 1 for a deassertion event.
805 See the IPMI 2.0 specification for further details on the
807 definitions for each field.
808 <sensorid> <list>
811 Get a list of all the possible Sensor States and pre-
813 defined Sensor State Shortcuts available for a particular
814 sensor. sensorid is the character string representation
815 of the sensor and must be enclosed in double quotes if it
816 includes white space. Several different commands includ‐
817 ing ipmitool sensor list may be used to obtain a list
818 that includes the sensorid strings representing the sen‐
819 sors on a given system.
820 > ipmitool -I open event "PS 2T Fan Fault" list
822 Finding sensor PS 2T Fan Fault... ok
823 Sensor States:
824 State Deasserted
825 State Asserted
826 Sensor State Shortcuts:
827 present absent
828 assert deassert
829 limit nolimit
830 fail nofail
831 yes no
832 on off
833 up down
834 <sensorid> <sensor state> [<direction>]
837 Generate a custom event based on existing sensor informa‐
839 tion. The optional event direction can be either assert
840 (the default) or deassert.
841 > ipmitool event "PS 2T Fan Fault" "State Asserted"
844 Finding sensor PS 2T Fan Fault... ok
845 0 | Pre-Init Time-stamp | Fan PS 2T Fan Fault |
846 State Asserted
847 > ipmitool event "PS 2T Fan Fault" "State Deasserted"
849 Finding sensor PS 2T Fan Fault... ok
850 0 | Pre-Init Time-stamp | Fan PS 2T Fan Fault |
851 State Desserted
852 exec <filename>
854 Execute ipmitool commands from filename. Each line is a com‐
856 plete command. The syntax of the commands are defined by the
857 COMMANDS section in this manpage. Each line may have an
858 optional comment at the end of the line, delimited with a `#'
859 symbol.
860 e.g., a command file with two lines:
862 sdr list # get a list of sdr records
864 sel list # get a list of sel records
865 fru
867 print
869 Read all Field Replaceable Unit (FRU) inventory data
871 and extract such information as serial number, part num‐
872 ber, asset tags, and short strings describing the chas‐
873 sis, board, or product.
874 read <fru id> <fru file>
876 fru id is the digit ID of the FRU (see output of 'fru
878 print'). fru file is the absolute pathname of a file in
879 which to dump the binary FRU data pertaining to the spec‐
880 ified FRU entity.
881 write <fru id> <fru file>
883 fru id is the digit ID of the FRU (see output of 'fru
885 print'). fru file is the absolute pathname of a file
886 from which to pull the binary FRU data before uploading
887 it to the specified FRU.
888 upgEkey <fru id> <fru file>
890 Update a multirecord FRU location. fru id is the digit
892 ID of the FRU (see output of 'fru print'). fru file is
893 the absolute pathname of a file from which to pull the
894 binary FRU data to upload into the specified multirecord
895 FRU entity.
896 edit <fru id>
899 This command provides interactive editing of some sup‐
901 ported records, namely PICMG Carrier Activation Record.
902 fru id is the digit ID of the FRU (see output of 'fru
903 print'); default is 0.
904 edit <fru id> field <section> <index> <string>
907 This command may be used to set a field string to a new
909 value. It replaces the FRU data found at index in the
910 specified section with the supplied string.
911 fru id is the digit ID of the FRU (see output of 'fru
914 print').
915 <section> is a string which refers to FRU Inventory
918 Information
919 Storage Areas and may be refer to:
920 c FRU Inventory Chassis Info Area
922 b FRU Inventory Board Info Area
924 p FRU Inventory Product Info Area
926 <index> specifies the field number. Field numbering
929 starts on the first 'english text' field type. For
930 instance in the <board> info area field '0' is <Board
931 Manufacturer> and field '2' is <Board Serial Number>; see
932 IPMI Platform Management FRU Information Storage Defini‐
933 tion v1.0 R1.1 for field locations.
934 <string> must be the same length as the string being
937 replaced and must be 8-bit ASCII (0xCx).
938 edit <fru id> oem iana <record> <format> [<args>]
942 This command edits the data found in the multirecord
944 area. Support for OEM specific records is limited.
945 firewall
947 This command supports the Firmware Firewall capability. It may
949 be used to add or remove security-based restrictions on certain
950 commands/command sub-functions or to list the current firmware
951 firewall restrictions set on any commands. For each firmware
952 firewall command listed below, parameters may be included to
953 cause the command to be executed with increasing granularity on
954 a specific LUN, for a specific NetFn, for a specific IPMI Com‐
955 mand, and finally for a specific command's sub-function (see Ap‐
956 pendix H in the IPMI 2.0 Specification for a listing of any sub-
957 function numbers that may be associated with a particular com‐
958 mand).
959 Parameter syntax and dependencies are as follows:
961 [<channel H>] [<lun L> [ <netfn N> [<command C [<subfn S>]]]]
963 Note that if "netfn <N>" is specified, then "lun <L>" must also
965 be specified; if "command <C>" is specified, then "netfn <N>"
966 (and therefore "lun <L>") must also be specified, and so forth.
967 "channel <H>" is an optional and standalone parameter. If not
969 specified, the requested operation will be performed on the cur‐
970 rent channel. Note that command support may vary from channel
971 to channel.
972 Firmware firewall commands:
974 info [<Parms as described above>]
976 List firmware firewall information for the specified LUN,
978 NetFn, and Command (if supplied) on the current or speci‐
979 fied channel. Listed information includes the support,
980 configurable, and enabled bits for the specified command
981 or commands.
982 Some usage examples:
984 info [<channel H>] [<lun L>]
986 This command will list firmware firewall informa‐
988 tion for all NetFns for the specified LUN on
989 either the current or the specified channel.
990 info [<channel H>] [<lun L> [ <netfn N> ]
992 This command will print out all command informa‐
994 tion for a single LUN/NetFn pair.
995 info [<channel H>] [<lun L> [ <netfn N> [<command C] ]]
997 This prints out detailed, human-readable informa‐
999 tion showing the support, configurable, and
1000 enabled bits for the specified command on the
1001 specified LUN/NetFn pair. Information will be
1002 printed about each of the command subfunctions.
1003 info [<channel H>] [<lun L> [ <netfn N> [<command C
1005 [<subfn S>]]]]
1006 Print out information for a specific sub-function.
1008 enable [<Parms as described above>]
1010 This command is used to enable commands for a given
1012 NetFn/LUN combination on the specified channel.
1013 disable [<Parms as described above>] [force]
1015 This command is used to disable commands for a given
1017 NetFn/LUN combination on the specified channel. Great
1018 care should be taken if using the "force" option so as
1019 not to disable the "Set Command Enables" command.
1020 reset [<Parms as described above>]
1022 This command may be used to reset the firmware firewall
1024 back to a state where all commands and command sub-func‐
1025 tions are enabled.
1026 i2c <i2caddr> <read bytes> [<write data>]
1030 This command may be used to execute raw I2C commands with the
1032 Master Write-Read IPMI command.
1033 isol
1036 info
1038 Retrieve information about the Intel IPMI v1.5
1040 Serial-Over-LAN configuration.
1041 set <parameter> <value>
1043 Configure parameters for Intel IPMI v1.5 Serial-over-LAN.
1045 Valid parameters and values are:
1047 enabled
1049 true, false.
1050 privilege-level
1052 user, operator, admin, oem.
1053 bit-rate
1055 9.6, 19.2, 38.4, 57.6, 115.2.
1056 activate
1058 Causes ipmitool to enter Intel IPMI v1.5 Serial Over LAN
1060 mode. An RMCP+ connection is made to the BMC, the termi‐
1061 nal is set to raw mode, and user input is sent to the
1062 serial console on the remote server. On exit, the the SOL
1063 payload mode is deactivated and the terminal is reset to
1064 its original settings.
1065 Special escape sequences are provided to control the SOL
1067 session:
1068 ~. Terminate connection
1070 ~^Z Suspend ipmitool
1072 ~^X Suspend ipmitool, but don't restore tty
1074 on restart
1075 ~B Send break
1077 ~~ Send the escape character by typing it
1079 twice
1080 ~? Print the supported escape sequences
1082 Note that escapes are only recognized immediately after
1084 newline.
1085 kontronoem
1088 OEM commands specific to Kontron devices.
1090 setsn
1092 Set FRU serial number.
1094 setmfgdate
1096 Set FRU manufacturing date.
1098 nextboot <boot device>
1100 Select the next boot order on the Kontron CP6012.
1102 lan
1104 These commands will allow you to configure IPMI LAN channels
1106 with network information so they can be used with the ipmitool
1107 lan and lanplus interfaces. NOTE: To determine on which channel
1108 the LAN interface is located, issue the `channel info number'
1109 command until you come across a valid 802.3 LAN channel. For
1110 example:
1111 > ipmitool -I open channel info 1
1113 Channel 0x1 info:
1114 Channel Medium Type : 802.3 LAN
1115 Channel Protocol Type : IPMB-1.0
1116 Session Support : session-based
1117 Active Session Count : 8
1118 Protocol Vendor ID : 7154
1119 print [<channel>]
1122 Print the current configuration for the given chan‐
1124 nel. The default will print information on the first
1125 found LAN channel.
1126 set <channel number> <command> <parameter>
1128 Set the given command and parameter on the specified
1130 channel. Valid command/parameter options are:
1131 ipaddr <x.x.x.x>
1133 Set the IP address for this channel.
1135 netmask <x.x.x.x>
1137 Set the netmask for this channel.
1139 macaddr <xx:xx:xx:xx:xx:xx>
1141 Set the MAC address for this channel.
1143 defgw ipaddr <x.x.x.x>
1145 Set the default gateway IP address.
1147 defgw macaddr <xx:xx:xx:xx:xx:xx>
1149 Set the default gateway MAC address.
1151 bakgw ipaddr <x.x.x.x>
1153 Set the backup gateway IP address.
1155 bakgw macaddr <xx:xx:xx:xx:xx:xx>
1157 Set the backup gateway MAC address.
1159 password <pass>
1161 Set the null user password.
1163 snmp <community string>
1165 Set the SNMP community string.
1167 user
1169 Enable user access mode for userid 1 (issue the
1171 `user' command to display information about
1172 userids for a given channel).
1173 access <on|off>
1175 Set LAN channel access mode.
1177 alert <on|off>
1179 Enable or disable PEF alerting for this channel.
1181 ipsrc <source>
1183 Set the IP address source:
1185 none unspecified
1186 static manually configured static IP address
1187 dhcp address obtained by BMC running DHCP
1188 bios address loaded by BIOS or system software
1189 arp respond <on|off>
1191 Set BMC generated ARP responses.
1193 arp generate <on|off>
1195 Set BMC generated gratuitous ARPs.
1197 arp interval <seconds>
1199 Set BMC generated gratuitous ARP interval.
1201 vlan id <off|id>
1203 Disable VLAN operation or enable VLAN and set the
1205 ID.
1206 ID: value of the virtual lan identifier between 1
1207 and 4094 inclusive.
1208 vlan priority <priority>
1210 Set the priority associated with VLAN frames.
1212 ID: priority of the virtual lan frames between 0
1213 and 7 inclusive.
1214 auth <level,...> <type,...>
1216 Set the valid authtypes for a given auth
1218 level.
1219 Levels: callback, user, operator, admin
1220 Types: none, md2, md5, password, oem
1221 cipher_privs <privlist>
1223 Correlates cipher suite numbers with the maximum
1225 privilege level that is allowed to use it. In
1226 this way, cipher suites can restricted to users
1227 with a given privilege level, so that, for exam‐
1228 ple, administrators are required to use a stronger
1229 cipher suite than normal users.
1230 The format of privlist is as follows. Each char‐
1232 acter represents a privilege level and the charac‐
1233 ter position identifies the cipher suite number.
1234 For example, the first character represents cipher
1235 suite 1 (cipher suite 0 is reserved), the second
1236 represents cipher suite 2, and so on. privlist
1237 must be 15 characters in length.
1238 Characters used in privlist and their associated
1240 privilege levels are:
1241 X Cipher Suite Unused
1243 c CALLBACK
1244 u USER
1245 o OPERATOR
1246 a ADMIN
1247 O OEM
1248 So, to set the maximum privilege for cipher suite
1250 1 to USER and suite 2 to ADMIN, issue the follow‐
1251 ing command:
1252 > ipmitool -I interface lan set channel
1254 cipher_privs uaXXXXXXXXXXXXX
1255 alert print [<channel>] [<alert destination>]
1258 Print alert information for the specified channel and
1260 destination. The default will print all alerts for all
1261 alert destinations on the first found LAN channel.
1262 alert set <channel number> <alert destination> <command> <param‐
1265 eter>
1266 Set an alert on the given LAN channel and destination.
1268 Alert Destinations are listed via the 'lan alert print'
1269 command. Valid command/parameter options are:
1270 ipaddr <x.x.x.x>
1272 Set alert IP address.
1274 macaddr <xx:xx:xx:xx:xx:xx>
1276 Set alert MAC address.
1278 gateway <default | backup>
1280 Set the channel gateway to use for alerts.
1282 ack <on | off>
1284 Set Alert Acknowledge on or off.
1286 type <pet | oem1 | oem2>
1288 Set the destination type as PET or OEM.
1290 time <seconds>
1292 Set ack timeout or unack retry interval.
1294 retry <number>
1296 Set the number of alert retries.
1298 stats get [<channel number>]
1300 Retrieve information about the IP connections on the
1302 specified channel. The default will retrieve statistics
1303 on the first found LAN channel.
1304 stats clear [<channel number>]
1306 Clear all IP/UDP/RMCP Statistics to 0 on the specified
1308 channel. The default will clear statistics on the first
1309 found LAN channel.
1310 pef
1312 info
1314 This command will query the BMC and print information
1316 about the PEF supported features.
1317 status
1319 This command prints the current PEF status (the last SEL
1321 entry processed by the BMC, etc).
1322 policy
1324 This command lists the PEF policy table entries. Each
1326 policy entry describes an alert destination. A policy
1327 set is a collection of table entries. PEF alert actions
1328 reference policy sets.
1329 list
1331 This command lists the PEF table entries. Each PEF entry
1333 relates a sensor event to an action. When PEF is active,
1334 each platform event causes the BMC to scan this table for
1335 entries matching the event, and possible actions to be
1336 taken. Actions are performed in priority order (higher
1337 criticality first).
1338 picmg <properties>
1340 Run a PICMG/ATA extended command. Get PICMG properties may be
1342 used to obtain and print Extension major version information,
1343 PICMG identifier, FRU Device ID and Max FRU Device ID.
1344 addrinfo
1346 Get address information. This command may return infor‐
1348 mation on the Hardware address, IPMB-0 Address, FRU ID,
1349 Site/Entity ID, and Site/Entity Type.
1350 frucontrol <fru id> <options>
1352 Set various control options:
1354 0x00 - Cold Reset
1356 0x01 - Warm Reset
1358 0x02 - Graceful Reboot
1360 0x03 - Issue Diagnostic Interrupt
1362 0x04 - Quiesce [AMC only]
1364 0x05-0xFF - Cold Reset
1366 activate <fru id>
1368 Activate the specified FRU.
1370 deactivate <fru id>
1372 Deactivate the specified FRU.
1374 policy get <fru id>
1376 Get FRU activation policy.
1378 policy set <fru id> <lockmask> <lock>
1380 Set FRU activation policy. lockmask is 1 or 0 to indi‐
1382 cate action on the deactivation or activation locked bit
1383 respectively. lock is 1 or 0 to set/clear locked bit.
1384 portstate set|getall|getgranted|getdenied <parameters>
1386 Get or set various port states. See usage for parameter
1388 details.
1389 power <chassis power command>
1392 Shortcut to the chassis power commands. See the chassis power
1394 commands for usage information.
1395 raw <netfn> <cmd> [<data>]
1398 This will allow you to execute raw IPMI commands. For example
1400 to query the POH counter with a raw command:
1401 > ipmitool -v raw 0x0 0xf
1403 RAW REQ (netfn=0x0 cmd=0xf data_len=0)
1404 RAW RSP (5 bytes)
1405 3c 72 0c 00 00
1406 sdr
1408 get <id> ... [<id>]
1410 Prints information for sensor data records specified by
1412 sensor id.
1413 info
1415 This command will query the BMC for Sensor Data Record
1417 (SDR) Repository information.
1418 type [<sensor type>]
1420 This command will display all records from the SDR Repos‐
1422 itory of a specific type. Run with type list (or simply
1423 with no type) to see the list of available types. For
1424 example to query for all Temperature sensors:
1425 > ipmitool sdr type Temperature
1427 Baseboard Temp | 30h | ok | 7.1 | 28 degrees C
1428 FntPnl Amb Temp | 32h | ok | 12.1 | 24 degrees C
1429 Processor1 Temp | 98h | ok | 3.1 | 57 degrees C
1430 Processor2 Temp | 99h | ok | 3.2 | 53 degrees C
1431 list | elist [<all|full|compact|event|mcloc|fru|generic>]
1434 This command will read the Sensor Data Records (SDR) and
1436 extract sensor information of a given type, then query
1437 each sensor and print its name, reading, and status. If
1438 invoked as elist then it will also print sensor number,
1439 entity id and instance, and asserted discrete states.
1440 The default output will only display full and compact
1442 sensor types, to see all sensors use the all type with
1443 this command.
1444 Valid types are:
1446 all
1448 All SDR records (Sensor and Locator)
1450 full
1452 Full Sensor Record
1454 compact
1456 Compact Sensor Record
1458 event
1460 Event-Only Sensor Record
1462 mcloc
1464 Management Controller Locator Record
1466 fru
1468 FRU Locator Record
1470 generic
1472 Generic SDR records
1474 entity <id>[.<instance>]
1476 Displays all sensors associated with an entity. Get a
1478 list of valid entity ids on the target system by issuing
1479 the sdr elist command. A list of all entity ids can be
1480 found in the IPMI specifications.
1481 dump <file>
1483 Dumps raw SDR data to a file. This data file can then be
1485 used as a local SDR cache of the remote managed system
1486 with the -S <file> option on the ipmitool command line.
1487 This can greatly improve performance over system inter‐
1488 face or remote LAN.
1489 fill sensors
1491 Create the SDR Repository for the current configuration.
1493 Will perform a 'Clear SDR Repository' command so be care‐
1494 ful.
1495 fill file <filename>
1497 Fill the SDR Repository using records stored in a binary
1499 data file. Will perform a 'Clear SDR Repository' command
1500 so be careful.
1501 sel
1503 NOTE: System Event Log (SEL) entry-times are displayed as
1505 `Pre-Init Time-stamp' if the SEL clock needs to be set. Ensure
1506 that the SEL clock is accurate by invoking the sel time get and
1507 sel time set <time string> commands.
1508 info
1510 This command will query the BMC for information about the
1512 System Event Log (SEL) and its contents.
1513 clear
1515 This command will clear the contents of the SEL. It can‐
1517 not be undone so be careful.
1518 list | elist
1520 When this command is invoked without arguments, the
1522 entire contents of the System Event Log are displayed.
1523 If invoked as elist (extended list) it will also use the
1524 Sensor Data Record entries to display the sensor ID for
1525 the sensor that caused each event. Note this can take a
1526 long time over the system interface.
1527 <count> | first <count>
1530 Displays the first count (least-recent) entries in
1532 the SEL. If count is zero, all entries are dis‐
1533 played.
1534 last <count>
1536 Displays the last count (most-recent) entries in
1538 the SEL. If count is zero, all entries are dis‐
1539 played.
1540 delete <SEL Record ID> ... <SEL Record ID>
1542 Delete one or more SEL event records.
1544 add <filename ID>
1546 Read event entries from a file and add them to the SEL.
1548 New SEL entries area added onto the SEL after the last
1549 record in the SEL. Record added is of type 2 and is
1550 automatically timestamped.
1551 get <SEL Record ID>
1553 Print information on the specified SEL Record entry.
1555 save <file>
1557 Save SEL records to a text file that can be fed back into
1559 the event file ipmitool command. This can be useful for
1560 testing Event generation by building an appropriate Plat‐
1561 form Event Message file based on existing events. Please
1562 see the available help for the 'event file ...' command
1563 for a description of the format of this file.
1564 writeraw <file>
1566 Save SEL records to a file in raw, binary format. This
1568 file can be fed back to the sel readraw ipmitool command
1569 for viewing.
1570 readraw <file>
1572 Read and display SEL records from a binary file. Such a
1574 file can be created using the sel writeraw ipmitool com‐
1575 mand.
1576 time
1578 get
1580 Displays the SEL clock's current time.
1581 set <time string>
1583 Sets the SEL clock. Future SEL entries will use
1585 the time set by this command. <time string> is of
1586 the form "MM/DD/YYYY HH:MM:SS". Note that hours
1587 are in 24-hour form. It is recommended that the
1588 SEL be cleared before setting the time.
1589 sensor
1591 list
1593 Lists sensors and thresholds in a wide table format.
1595 get <id> ... [<id>]
1597 Prints information for sensors specified by name.
1599 thresh <id> <threshold> <setting>
1601 This allows you to set a particular sensor threshold
1603 value. The sensor is specified by name.
1604 Valid thresholds are:
1606 unr Upper Non-Recoverable
1607 ucr Upper Critical
1608 unc Upper Non-Critical
1609 lnc Lower Non-Critical
1610 lcr Lower Critical
1611 lnr Lower Non-Recoverable
1612 thresh <id> lower <lnr> <lcr> <lnc>
1614 This allows you to set all lower thresholds for a sensor
1616 at the same time. The sensor is specified by name and
1617 the thresholds are listed in order of Lower Non-Recover‐
1618 able, Lower Critical, and Lower Non-Critical.
1619 thresh <id> upper <unc> <ucr> <unr>
1621 This allows you to set all upper thresholds for a sensor
1623 at the same time. The sensor is specified by name and
1624 the thresholds are listed in order of Upper Non-Critical,
1625 Upper Critical, and Upper Non-Recoverable.
1626 session
1628 info <active|all|id 0xnnnnnnnn|handle 0xnn>
1630 Get information about the specified session(s). You may
1632 identify sessions by their id, by their handle number, by
1633 their active status, or by using the keyword `all' to
1634 specify all sessions.
1635 shell
1637 This command will launch an interactive shell which you can use
1638 to send multiple ipmitool commands to a BMC and see the
1639 responses. This can be useful instead of running the full ipmi‐
1640 tool command each time. Some commands will make use of a Sensor
1641 Data Record cache and you will see marked improvement in speed
1642 if these commands are able to reuse the same cache in a shell
1643 session. LAN sessions will send a periodic keepalive command to
1644 keep the IPMI session from timing out.
1645 sol
1647 info [<channel number>]
1649 Retrieve information about the Serial-Over-LAN configura‐
1651 tion on the specified channel. If no channel is given,
1652 it will display SOL configuration data for the currently
1653 used channel.
1654 payload <enable | disable | status> <channel number> <userid>
1656 Enable, disable or show status of SOL payload for the
1658 user on the specified channel.
1659 set <parameter> <value> [<channel>]
1661 Configure parameters for Serial Over Lan. If no channel
1663 is given, it will display SOL configuration data for the
1664 currently used channel. Configuration parameter updates
1665 are automatically guarded with the updates to the
1666 set-in-progress parameter.
1667 Valid parameters and values are:
1669 set-in-progress
1671 set-complete set-in-progress commit-write
1672 enabled
1674 true false
1675 force-encryption
1677 true false
1678 force-authentication
1680 true false
1681 privilege-level
1683 user operator admin oem
1684 character-accumulate-level
1686 Decimal number given in 5 milliseconds increments
1687 character-send-threshold
1689 Decimal number
1690 retry-count
1692 Decimal number. 0 indicates no retries after
1693 packet is transmitted.
1694 retry-interval
1696 Decimal number in 10 millisend increments. 0
1697 indicates that retries should be sent back to
1698 back.
1699 non-volatile-bit-rate
1701 serial, 19.2, 38.4, 57.6, 115.2. Setting this
1702 value to serial indicates that the BMC should use
1703 the setting used by the IPMI over serial channel.
1704 volatile-bit-rate
1706 serial, 19.2, 38.4, 57.6, 115.2. Setting this
1707 value to serial indiates that the BMC should use
1708 the setting used by the IPMI over serial channel.
1709 activate [usesolkeepalive | nokeepalive]
1711 Causes ipmitool to enter Serial Over LAN mode, and is
1713 only available when using the lanplus interface. An
1714 RMCP+ connection is made to the BMC, the terminal is set
1715 to raw mode, and user input is sent to the serial console
1716 on the remote server. On exit,the the SOL payload mode
1717 is deactivated and the terminal is reset to its original
1718 settings.
1719 Special escape sequences are provided to control the SOL
1721 session:
1722 ~. Terminate connection
1724 ~^Z Suspend ipmitool
1726 ~^X Suspend ipmitool, but don't restore tty on
1728 restart
1729 ~B Send break
1731 ~~ Send the escape character by typing it twice
1733 ~? Print the supported escape sequences
1735 Note that escapes are only recognized immediately after
1737 newline.
1738 deactivate
1740 Deactivates Serial Over LAN mode on the BMC. Exiting
1742 Serial Over LAN mode should automatically cause this com‐
1743 mand to be sent to the BMC, but in the case of an unin‐
1744 tentional exit from SOL mode, this command may be neces‐
1745 sary to reset the state of the BMC.
1746 spd <i2cbus> <i2caddr> [<channel>] [<axread>]
1748 This command may be used to read SPD (Serial Presence Detect)
1750 data using the I2C Master Write-Read IPMI command.
1751 sunoem
1754 led
1756 These commands provide a way to get and set the status of
1758 LEDs on a Sun Microsystems server. Use 'sdr list
1759 generic' to get a list of devices that are controllable
1760 LEDs. The ledtype parameter is optional and not neces‐
1761 sary to provide on the command line unless it is required
1762 by hardware.
1763 get <sensorid> [<ledtype>]
1765 Get status of a particular LED described by a
1767 Generic Device Locator record in the SDR. A sen‐
1768 sorid of all will get the status of all available
1769 LEDS.
1770 set <sensorid> <ledmode> [<ledtype>]
1772 Set status of a particular LED described by a
1774 Generic Device Locator record in the SDR. A sen‐
1775 sorid of all will set the status of all available
1776 LEDS to the specified ledmode and ledtype.
1777 LED Mode is required for set operations:
1779 OFF Off
1780 ON Steady On
1781 STANDBY 100ms on 2900ms off blink rate
1782 SLOW 1HZ blink rate
1783 FAST 4HZ blink rate
1784 LED Type is optional:
1786 OK2RM Ok to Remove
1787 SERVICE Service Required
1788 ACT Activity
1789 LOCATE Locate
1790 fan speed <0-100>
1793 Set system fan speed (PWM duty cycle).
1795 sshkey
1797 set <userid> <keyfile>
1799 This command will allow you to specify an
1801 SSH key to use for a particular user on the
1802 Service Processor. This key will be used
1803 for CLI logins to the SP and not for IPMI
1804 sessions. View available users and their
1805 userids with the 'user list' command.
1806 del <userid>
1808 This command will delete the SSH key for a
1810 specified userid.
1811 tsol
1814 This command allows Serial-over-LAN sessions to be established
1816 with Tyan IPMIv1.5 SMDC such as the M3289 or M3290. The default
1817 command run with no arguments will establish default SOL session
1818 back to local IP address. Optional arguments may be supplied in
1819 any order.
1820 <ipaddr>
1823 Send receiver IP address to SMDC which it will use to
1825 send serial traffic to. By default this detects the
1826 local IP address and establishes two-way session. Format
1827 of ipaddr is XX.XX.XX.XX
1828 port=NUM
1831 Configure UDP port to receive serial traffic on. By
1833 default this is 6230.
1834 ro|rw
1837 Confiure SOL session as read-only or read-write. Ses‐
1839 sions are read-write by default.
1840 user
1844 summary
1846 Displays a summary of userid information, including maxi‐
1848 mum number of userids, the number of enabled users, and
1849 the number of fixed names defined.
1850 list
1852 Displays a list of user information for all defined
1854 userids.
1855 set
1857 name <userid> <username>
1859 Sets the username associated with the given
1861 userid.
1862 password <userid> [<password>]
1864 Sets the password for the given userid. If no
1866 password is given, the password is cleared (set to
1867 the NULL password). Be careful when removing
1868 passwords from administrator-level accounts.
1869 disable <userid>
1871 Disables access to the BMC by the given userid.
1873 enable <userid>
1875 Enables access to the BMC by the given userid.
1877 priv <userid> <privilege level> [<channel number>]
1879 Set user privilege level on the specified channel. If
1881 the channel is not specified, the current channel will be
1882 used.
1883 test <userid> <16|20> [<password>]
1885 Determine whether a password has been stored as 16 or 20
1887 bytes.
1888
1891 The ipmitool open interface utilizes the OpenIPMI kernel device driver.
1892 This driver is present in all modern 2.4 and all 2.6 kernels and it
1893 should be present in recent Linux distribution kernels. There are also
1894 IPMI driver kernel patches for different kernel versions available from
1895 the OpenIPMI homepage.
1896 The required kernel modules is different for 2.4 and 2.6 kernels. The
1898 following kernel modules must be loaded on a 2.4-based kernel in order
1899 for ipmitool to work:
1900 ipmi_msghandler
1902 Incoming and outgoing message handler for IPMI interfaces.
1903 ipmi_kcs_drv
1905 An IPMI Keyboard Controler Style (KCS) interface driver for the
1906 message handler.
1907 ipmi_devintf
1909 Linux character device interface for the message handler.
1910 The following kernel modules must be loaded on a 2.6-based kernel in
1912 order for ipmitool to work:
1913 ipmi_msghandler
1915 Incoming and outgoing message handler for IPMI interfaces.
1916 ipmi_si
1918 An IPMI system interface driver for the message handler. This
1919 module supports various IPMI system interfaces such as KCS, BT,
1920 SMIC, and even SMBus in 2.6 kernels.
1921 ipmi_devintf
1923 Linux character device interface for the message handler.
1924 Once the required modules are loaded there will be a dynamic character
1926 device entry that must exist at /dev/ipmi0. For systems that use devfs
1927 or udev this will appear at /dev/ipmi/0.
1928 To create the device node first determine what dynamic major number it
1930 was assigned by the kernel by looking in /proc/devices and checking for
1931 the ipmidev entry. Usually if this is the first dynamic device it will
1932 be major number 254 and the minor number for the first system interface
1933 is 0 so you would create the device entry with:
1934 mknod /dev/ipmi0 c 254 0
1936 ipmitool includes some sample initialization scripts that can perform
1938 this task automatically at start-up.
1939 In order to have ipmitool use the OpenIPMI device interface you can
1941 specifiy it on the command line:
1942 ipmitool -I open <command>
1944
1946 The ipmitool bmc interface utilizes the bmc device driver as provided
1947 by Solaris 10 and higher. In order to force ipmitool to make use of
1948 this interface you can specify it on the command line:
1949 ipmitool -I bmc <command>
1951 The following files are associated with the bmc driver:
1953 /platform/i86pc/kernel/drv/bmc
1956 32-bit ELF kernel module for the bmc driver.
1957 /platform/i86pc/kernel/drv/amd64/bmc
1959 64-bit ELF kernel module for the bmc driver.
1960 /dev/bmc
1962 Character device node used to communicate with the bmc driver.
1963
1965 The ipmitool lipmi interface uses the Solaris 9 IPMI kernel device
1966 driver. It has been superceeded by the bmc interface on Solaris 10.
1967 You can tell ipmitool to use this interface by specifying it on the
1968 command line.
1969 ipmitool -I lipmi <expression>
1971
1973 The ipmitool lan interface communicates with the BMC over an Ethernet
1974 LAN connection using UDP under IPv4. UDP datagrams are formatted to
1975 contain IPMI request/response messages with a IPMI session headers and
1976 RMCP headers.
1977 IPMI-over-LAN uses version 1 of the Remote Management Control Protocol
1979 (RMCP) to support pre-OS and OS-absent management. RMCP is a
1980 request-response protocol delivered using UDP datagrams to port 623.
1981 The LAN interface is an authenticatiod multi-session connection; mes‐
1983 sages delivered to the BMC can (and should) be authenticated with a
1984 challenge/response protocol with either straight password/key or MD5
1985 message-digest algorithm. ipmitool will attempt to connect with admin‐
1986 istrator privilege level as this is required to perform chassis power
1987 functions.
1988 You can tell ipmitool to use the lan interface with the -I lan option:
1990 ipmitool -I lan -H <hostname> [-U <username>] [-P <password>] <command>
1993 A hostname must be given on the command line in order to use the lan
1995 interface with ipmitool. The password field is optional; if you do not
1996 provide a password on the command line, ipmitool will attempt to con‐
1997 nect without authentication. If you specify a password it will use MD5
1998 authentication if supported by the BMC and straight password/key other‐
1999 wise, unless overridden with a command line option.
2000
2002 Like the lan interface, the lanplus interface communicates with the BMC
2003 over an Ethernet LAN connection using UDP under IPv4. The difference
2004 is that the lanplus interface uses the RMCP+ protocol as described in
2005 the IPMI v2.0 specification. RMCP+ allows for improved authentication
2006 and data integrity checks, as well as encryption and the ability to
2007 carry multiple types of payloads. Generic Serial Over LAN support
2008 requires RMCP+, so the ipmitool sol activate command requires the use
2009 of the lanplus interface.
2010 RMCP+ session establishment uses a symmetric challenge-response proto‐
2012 col called RAKP (Remote Authenticated Key-Exchange Protocol) which
2013 allows the negotiation of many options. ipmitool does not yet allow
2014 the user to specify the value of every option, defaulting to the most
2015 obvious settings marked as required in the v2.0 specification. Authen‐
2016 tication and integrity HMACS are produced with SHA1, and encryption is
2017 performed with AES-CBC-128. Role-level logins are not yet supported.
2018 ipmitool must be linked with the OpenSSL library in order to perform
2020 the encryption functions and support the lanplus interface. If the
2021 required packages are not found it will not be compiled in and sup‐
2022 ported.
2023 You can tell ipmitool to use the lanplus interface with the -I lanplus
2025 option:
2026 ipmitool -I lanplus -H <hostname> [-U <username>] [-P <password>] <com‐
2029 mand>
2030 A hostname must be given on the command line in order to use the lan
2032 interface with ipmitool. With the exception of the -A and -C options
2033 the rest of the command line options are identical to those available
2034 for the lan interface.
2035 The -C option allows you specify the authentication, integrity, and
2037 encryption algorithms to use for for lanplus session based on the
2038 cipher suite ID found in the IPMIv2.0 specification in table 22-19.
2039 The default cipher suite is 3 which specifies RAKP-HMAC-SHA1 authenti‐
2040 cation, HMAC-SHA1-96 integrity, and AES-CBC-128 encryption algorightms.
2041
2044 The ipmitool free interface utilizes the FreeIPMI libfreeipmi drivers.
2045 You can tell ipmitool to use the FreeIPMI interface with the -I option:
2047 ipmitool -I free <command>
2049
2053 The ipmitool imb interface supports the Intel IMB (Intel Inter-module
2054 Bus) Interface through the /dev/imb device.
2055 You can tell ipmitool to use the IMB interface with the -I option:
2057 ipmitool -I imb <command>
2059
2062 Example 1: Listing remote sensors
2063 > ipmitool -I lan -H 1.2.3.4 -f passfile sdr list
2065 Baseboard 1.25V | 1.24 Volts | ok
2066 Baseboard 2.5V | 2.49 Volts | ok
2067 Baseboard 3.3V | 3.32 Volts | ok
2068 Example 2: Displaying status of a remote sensor
2070 > ipmitool -I lan -H 1.2.3.4 -f passfile sensor get "Baseboard
2072 1.25V"
2073 Locating sensor record...
2074 Sensor ID : Baseboard 1.25V (0x10)
2075 Sensor Type (Analog) : Voltage
2076 Sensor Reading : 1.245 (+/- 0.039) Volts
2077 Status : ok
2078 Lower Non-Recoverable : na
2079 Lower Critical : 1.078
2080 Lower Non-Critical : 1.107
2081 Upper Non-Critical : 1.382
2082 Upper Critical : 1.431
2083 Upper Non-Recoverable : na
2084 Example 3: Displaying the power status of a remote chassis
2086 > ipmitool -I lan -H 1.2.3.4 -f passfile chassis power status
2088 Chassis Power is on
2089 Example 4: Controlling the power on a remote chassis
2091 > ipmitool -I lan -H 1.2.3.4 -f passfile chassis power on
2093 Chassis Power Control: Up/On
2094
2096 Duncan Laurie <duncan@iceblink.org>
2097
2099 IPMItool Homepage
2100 http://ipmitool.sourceforge.net
2101 Intelligent Platform Management Interface Specification
2103 http://www.intel.com/design/servers/ipmi
2104 OpenIPMI Homepage
2106 http://openipmi.sourceforge.net
2107 FreeIPMI Homepage
2109 http://www.gnu.org/software/freeipmi/
2110Duncan Laurie ipmitool(1)