1ipmitool(1) ipmitool(1)
2
6 ipmitool - utility for controlling IPMI-enabled devices
7
9 ipmitool [-c|-h|-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 <kg_key>]
31 [-e <esc_char>]
32 <command>
33
35 This program lets you manage Intelligent Platform Management Interface
36 (IPMI) functions of either the local system, via a kernel device
37 driver, or a remote system, using IPMI V1.5 and IPMI v2.0. These func‐
38 tions include printing FRU information, LAN configuration, sensor read‐
39 ings, and remote chassis power control.
40 IPMI management of a local system interface requires a compatible IPMI
42 kernel driver to be installed and configured. On Linux this driver is
43 called OpenIPMI and it is included in standard distributions. On
44 Solaris this driver is called BMC and is inclued in Solaris 10. Man‐
45 agement of a remote station requires the IPMI-over-LAN interface to be
46 enabled and configured. Depending on the particular requirements of
47 each system it may be possible to enable the LAN interface using ipmi‐
48 tool over the system interface.
49
51 -a Prompt for the remote server password.
52 -A <authtype>
54 Specify an authentication type to use during IPMIv1.5 lan ses‐
55 sion activation. Supported types are NONE, PASSWORD, MD2, MD5,
56 or OEM.
57 -c Present output in CSV (comma separated variable) format. This
59 is not available with all commands.
60 -e <sol_escape_char>
62 Use supplied character for SOL session escape character. The
63 default is to use ~ but this can conflict with ssh sessions.
64 -k <key>
66 Use supplied Kg key for IPMIv2 authentication. The default is
67 not to use any Kg key.
68 -C <ciphersuite>
70 The remote server authentication, integrity, and encryption
71 algorithms to use for IPMIv2 lanplus connections. See table
72 22-19 in the IPMIv2 specification. The default is 3 which spec‐
73 ifies RAKP-HMAC-SHA1 authentication, HMAC-SHA1-96 integrity, and
74 AES-CBC-128 encryption algorightms.
75 -E The remote server password is specified by the environment vari‐
77 able IPMI_PASSWORD.
78 -f <password_file>
80 Specifies a file containing the remote server password. If this
81 option is absent, or if password_file is empty, the password
82 will default to NULL.
83 -h Get basic usage help from the command line.
85 -H <address>
87 Remote server address, can be IP address or hostname. This
88 option is required for lan and lanplus interfaces.
89 -I <interface>
91 Selects IPMI interface to use. Supported interfaces that are
92 compiled in are visible in the usage help output.
93 -L <privlvl>
95 Force session privilege level. Can be CALLBACK, USER, OPERATOR,
96 ADMINISTRATOR. Default is ADMINISTRATOR.
97 -m <local_address>
99 Set the local IPMB address. The default is 0x20 and there
100 should be no need to change it for normal operation.
101 -o <oemtype>
103 Select OEM type to support. This usually involves minor hacks
104 in place in the code to work around quirks in various BMCs from
105 various manufacturers. Use -o list to see a list of current
106 supported OEM types.
107 -O <sel oem>
109 Open selected file and read OEM SEL event descriptions to be
110 used during SEL listings. See examples in contrib dir for file
111 format.
112 -p <port>
114 Remote server UDP port to connect to. Default is 623.
115 -P <password>
117 Remote server password is specified on the command line. If
118 supported it will be obscured in the process list. Note! Speci‐
119 fying the password as a command line option is not recommended.
120 -S <sdr_cache_file>
122 Use local file for remote SDR cache. Using a local SDR cache
123 can drastically increase performance for commands that require
124 knowledge of the entire SDR to perform their function. Local
125 SDR cache from a remote system can be created with the sdr dump
126 command.
127 -t <target_address>
129 Bridge IPMI requests to the remote target address.
130 -U <username>
132 Remote server username, default is NULL user.
133 -v Increase verbose output level. This option may be specified
135 multiple times to increase the level of debug output. If given
136 three times you will get hexdumps of all incoming and outgoing
137 packets.
138 -V Display version information.
140 If no password method is specified then ipmitool will prompt the user
143 for a password. If no password is entered at the prompt, the remote
144 server password will default to NULL.
145
147 There are several security issues be be considered before enabling the
148 IPMI LAN interface. A remote station has the ability to control a sys‐
149 tem's power state as well as being able to gather certain platform
150 information. To reduce vulnerability it is strongly advised that the
151 IPMI LAN interface only be enabled in 'trusted' environments where sys‐
152 tem security is not an issue or where there is a dedicated secure 'man‐
153 agement network'.
154 Further it is strongly advised that you should not enable IPMI for
156 remote access without setting a password, and that that password should
157 not be the same as any other password on that system.
158 When an IPMI password is changed on a remote machine with the IPMIv1.5
160 lan interface the new password is sent across the network as clear
161 text. This could be observed and then used to attack the remote sys‐
162 tem. It is thus recommended that IPMI password management only be done
163 over IPMIv2.0 lanplus interface or the system interface on the local
164 station.
165 For IPMI v1.5, the maximum password length is 16 characters. Passwords
167 longer than 16 characters will be truncated.
168 For IPMI v2.0, the maximum password length is 20 characters; longer
170 passwords are truncated.
171
173 help This can be used to get command-line help on ipmitool com‐
174 mands. It may also be placed at the end of commands to get
175 option usage help.
176 ipmitool help
178 Commands:
179 raw Send a RAW IPMI request and print response
180 lan Configure LAN Channels
181 chassis Get chassis status and set power state
182 event Send events to MC
183 mc Management Controller status and global
184 enables
185 sdr Print Sensor Data Repository entries and
186 readings
187 sensor Print detailed sensor information
188 fru Print built-in FRU and scan for FRU loca‐
189 tors
190 sel Print System Event Log (SEL)
191 pef Configure Platform Event Filtering (PEF)
192 sol Configure and connect IPMIv2.0
193 Serial-over-LAN
194 tsol Configure and connect Tyan IPMIv1.5
195 Serial-over-LAN
196 isol Configure Intel IPMIv1.5 Serial-over-LAN
197 user Configure Management Controller users
198 channel Configure Management Controller channels
199 session Print session information
200 sunoem Manage Sun OEM Extensions
201 exec Run list of commands from file
202 set Set runtime variable for shell and exec
203 ipmitool chassis help
205 Chassis Commands: status, power, identify, policy,
206 restart_cause, poh, bootdev
207 ipmitool chassis power help
209 chassis power Commands: status, on, off, cycle, reset, diag,
210 soft
211 bmc|mc
213 reset <warm|cold>
215 Instructs the BMC to perform a warm or cold reset.
217 guid
219 Display the Management Controller Globally Unique IDenti‐
221 fier.
222 info
224 Displays information about the BMC hardware, including
226 device revision, firmware revision, IPMI version sup‐
227 ported, manufacturer ID, and information on additional
228 device support.
229 getenables
231 Displays a list of the currently enabled options for the
233 BMC.
234 setenables <option>=[on|off]
236 Enables or disables the given option. This command is
238 only supported over the system interface according to the
239 IPMI specification. Currently supported values for
240 option include:
241 recv_msg_intr
243 Receive Message Queue Interrupt
245 event_msg_intr
247 Event Message Buffer Full Interrupt
249 event_msg
251 Event Message Buffer
253 system_event_log
255 System Event Logging
257 oem0
259 OEM-Defined option #0
261 oem1
263 OEM-Defined option #1
265 oem2
267 OEM-Defined option #2
269 channel
271 authcap <channel number> <max priv>
273 Displays information about the authentication capabili‐
275 ties of the selected channel at the specified privilege
276 level.
277 Possible privilege levels are:
279 1 Callback level
280 2 User level
281 3 Operator level
282 4 Administrator level
283 5 OEM Proprietary level
284 info [channel number]
286 Displays information about the selected channel. If
288 no channel is given it will display information about the
289 currently used channel:
290 > ipmitool channel info
292 Channel 0xf info:
293 Channel Medium Type : System Interface
294 Channel Protocol Type : KCS
295 Session Support : session-less
296 Active Session Count : 0
297 Protocol Vendor ID : 7154
298 getaccess <channel number> [<userid>]
300 Configure the given userid as the default on the given
302 channel number. When the given channel is subsequently
303 used, the user is identified implicitly by the given
304 userid.
305 setaccess <channel number> <userid> [<callin=on|off>]
307 [<ipmi=on|off>] [<link=on|off>] [<privilege=level>]
308 Configure user access information on the given channel
310 for the given userid.
311 getciphers <ipmi|sol> [<channel>]
313 Displays the list of cipher suites supported for the
315 given application (ipmi or sol) on the given channel.
316 chassis
318 status
320 Displays information regarding the high-level status of
322 the system chassis and main power subsystem.
323 poh
325 This command will return the Power-On Hours counter.
327 identify <interval>
329 Control the front panel identify light. Default is 15.
331 Use 0 to turn off.
332 restart_cause
334 Query the chassis for the cause of the last system
336 restart.
337 policy
339 Set the chassis power policy in the event power fail‐
341 ure.
342 list
344 Return supported policies.
346 always-on
348 Turn on when power is restored.
350 previous
352 Returned to previous state when power is
354 restored.
355 always-off
357 Stay off after power is restored.
359 power
361 Performs a chassis control command to view and change
363 the power state.
364 status
366 Show current chassis power status.
368 on
370 Power up chassis.
372 off
374 Power down chassis into soft off (S4/S5 state).
376 WARNING: This command does not initiate a clean
377 shutdown of the operating system prior to powering
378 down the system.
379 cycle
381 Provides a power off interval of at least 1 sec‐
383 ond. No action should occur if chassis power is
384 in S4/S5 state, but it is recommended to check
385 power state first and only issue a power cycle
386 command if the system power is on or in lower
387 sleep state than S4/S5.
388 reset
390 This command will perform a hard reset.
392 diag
394 Pulse a diagnostic interrupt (NMI) directly to the
396 processor(s).
397 soft
399 Initiate a soft-shutdown of OS via ACPI. This can
401 be done in a number of ways, commonly by simulat‐
402 ing an overtemperture or by simulating a power
403 button press. It is necessary for there to be
404 Operating System support for ACPI and some sort of
405 daemon watching for events for this soft power to
406 work.
407 bootdev <device> [<clear-cmos=yes|no>]
409 Request the system to boot from an alternate boot device
411 on next reboot. The clear-cmos option, if supplied, will
412 instruct the BIOS to clear its CMOS on the next reboot.
413 Currently supported values for <device> are:
415 none
417 Do not change boot device
419 pxe
421 Force PXE boot
423 disk
425 Force boot from BIOS default boot device
427 safe
429 Force boot from BIOS default boot device, request
431 Safe Mode
432 diag
434 Force boot from diagnostic partition
436 cdrom
438 Force boot from CD/DVD
440 bios
442 Force boot into BIOS setup
444 event
446 <predefined event number>
448 Send a pre-defined event to the System Event Log. The
450 following events are included as a means to test the
451 functionality of the System Event Log component of the
452 BMC (an entry will be added each time the event n command
453 is executed).
454 Currently supported values for n are:
456 1 Temperature: Upper Critical: Going High
457 2 Voltage Threshold: Lower Critical: Going Low
458 3 Memory: Correctable ECC Error Detected
459 NOTE: These pre-defined events will likely not produce
461 "accurate" SEL records for a particular system because
462 they will not be correctly tied to a valid sensor number,
463 but they are sufficient to verify correct operation of
464 the SEL.
465 file <filename>
468 Event log records specified in filename will be added to
470 the System Event Log.
471 The format of each line in the file is as follows:
473 <{EvM Revision} {Sensor Type} {Sensor Num} {Event
475 Dir/Type} {Event Data 0} {Event Data 1} {Event Data 2}>[#
476 COMMENT]
477 Note: The Event Dir/Type field is encoded with the event
479 direction as the high bit (bit 7) and the event type as
480 the low 7 bits.
481 e.g.:
483 0x4 0x2 0x60 0x1 0x52 0x0 0x0 # Voltage threshold: Lower
484 Critical: Going Low
485 <sensorid> <state> [<eventdir>]
488 Generate a custom event based on existing sensor informa‐
490 tion. The optional event direction can be either assert
491 or deassert and defaults to assert. To get a list of
492 possible states for a sensor supply a state of list on
493 the command line. Each sensor may be different but some
494 states will have pre-defined shortcuts. For example:
495 > ipmitool -I open event p0.t_core
497 Finding sensor p0.t_core... ok
498 Sensor States:
499 lnr : Lower Non-Recoverable
500 lcr : Lower Critical
501 lnc : Lower Non-Critical
502 unc : Upper Non-Critical
503 ucr : Upper Critical
504 unr : Upper Non-Recoverable
505 > ipmitool -I open event ps0.prsnt
507 Finding sensor ps0.prsnt... ok
508 Sensor States:
509 Device Absent
510 Device Present
511 State State Shortcuts:
512 present absent
513 assert deassert
514 limit nolimit
515 fail nofail
516 yes no
517 on off
518 up down
519 exec <filename>
522 Execute ipmitool commands from filename. Each line is a com‐
524 plete command. The syntax of the commands are defined by the
525 COMMANDS section in this manpage. Each line may have an
526 optional comment at the end of the line, delimited with a `#'
527 symbol.
528 e.g., a command file with two lines:
530 sdr list # get a list of sdr records
532 sel list # get a list of sel records
533 fru
535 print
537 This command will read all Field Replaceable Unit (FRU)
539 inventory data and extract such information as serial
540 number, part number, asset tags, and short strings
541 describing the chassis, board, or product.
542 i2c <i2caddr> <read bytes> [<write data>]
544 This will allow you to execute raw I2C commands with the Master
546 Write-Read IPMI command.
547 isol
550 setup <baud rate>
552 Setup baud rate for Intel IPMI v1.5 Serial-over-LAN.
554 lan
556 These commands will allow you to configure IPMI LAN channels
558 with network information so they can be used with the ipmitool
559 lan and lanplus interfaces. NOTE: To determine on which channel
560 the LAN interface is located, issue the `channel info number'
561 command until you come across a valid 802.3 LAN channel. For
562 example:
563 > ipmitool -I open channel info 1
565 Channel 0x1 info:
566 Channel Medium Type : 802.3 LAN
567 Channel Protocol Type : IPMB-1.0
568 Session Support : session-based
569 Active Session Count : 8
570 Protocol Vendor ID : 7154
571 print <channel>
574 Print the current configuration for the given chan‐
576 nel.
577 set <channel> <parameter>
579 Set the given parameter on the given channel. Valid
581 parameters are:
582 ipaddr <x.x.x.x>
584 Set the IP address for this channel.
586 netmask <x.x.x.x>
588 Set the netmask for this channel.
590 macaddr <xx:xx:xx:xx:xx:xx>
592 Set the MAC address for this channel.
594 defgw ipaddr <x.x.x.x>
596 Set the default gateway IP address.
598 defgw macaddr <xx:xx:xx:xx:xx:xx>
600 Set the default gateway MAC address.
602 bakgw ipaddr <x.x.x.x>
604 Set the backup gateway IP address.
606 bakgw macaddr <xx:xx:xx:xx:xx:xx>
608 Set the backup gateway MAC address.
610 password <pass>
612 Set the null user password.
614 snmp <community string>
616 Set the SNMP community string.
618 user
620 Enable user access mode for userid 1 (issue the
622 `user' command to display information about
623 userids for a given channel).
624 access <on|off>
626 Set LAN channel access mode.
628 ipsrc <source>
630 Set the IP address source:
632 none unspecified
633 static manually configured static IP address
634 dhcp address obtained by BMC running DHCP
635 bios address loaded by BIOS or system software
636 arp respond <on|off>
638 Set BMC generated ARP responses.
640 arp generate <on|off>
642 Set BMC generated gratuitous ARPs.
644 arp interval <seconds>
646 Set BMC generated gratuitous ARP interval.
648 vlan id <off|id>
650 Disable VLAN operation or enable VLAN and set the
652 ID.
653 ID: value of the virtual lan identifier between 1
654 and 4094 inclusive.
655 vlan priority <priority>
657 Set the priority associated with VLAN frames.
659 ID: priority of the virtual lan frames between 0
660 and 7 inclusive.
661 auth <level,...> <type,...>
663 Set the valid authtypes for a given auth
665 level.
666 Levels: callback, user, operator, admin
667 Types: none, md2, md5, password, oem
668 cipher_privs <privlist>
670 Correlates cipher suite numbers with the maximum
672 privilege level that is allowed to use it. In
673 this way, cipher suites can restricted to users
674 with a given privilege level, so that, for exam‐
675 ple, administrators are required to use a stronger
676 cipher suite than normal users.
677 The format of privlist is as follows. Each char‐
679 acter represents a privilege level and the charac‐
680 ter position identifies the cipher suite number.
681 For example, the first character represents cipher
682 suite 1 (cipher suite 0 is reserved), the second
683 represents cipher suite 2, and so on. privlist
684 must be 15 characters in length.
685 Characters used in privlist and their associated
687 privilege levels are:
688 X Cipher Suite Unused
690 c CALLBACK
691 u USER
692 o OPERATOR
693 a ADMIN
694 O OEM
695 So, to set the maximum privilege for cipher suite
697 1 to USER and suite 2 to ADMIN, issue the follow‐
698 ing command:
699 > ipmitool -I interface lan set channel
701 cipher_privs uaXXXXXXXXXXXXX
702 pef
705 info
707 This command will query the BMC and print information
709 about the PEF supported features.
710 status
712 This command prints the current PEF status (the last SEL
714 entry processed by the BMC, etc).
715 policy
717 This command lists the PEF policy table entries. Each
719 policy entry describes an alert destination. A policy
720 set is a collection of table entries. PEF alert actions
721 reference policy sets.
722 list
724 This command lists the PEF table entries. Each PEF entry
726 relates a sensor event to an action. When PEF is active,
727 each platform event causes the BMC to scan this table for
728 entries matching the event, and possible actions to be
729 taken. Actions are performed in priority order (higher
730 criticality first).
731 raw <netfn> <cmd> [<data>]
733 This will allow you to execute raw IPMI commands. For example
735 to query the POH counter with a raw command:
736 > ipmitool -v raw 0x0 0xf
738 RAW REQ (netfn=0x0 cmd=0xf data_len=0)
739 RAW RSP (5 bytes)
740 3c 72 0c 00 00
741 sdr
743 get <id> ... [<id>]
745 Prints information for sensor data records specified by
747 sensor id.
748 info
750 This command will query the BMC for SDR information.
752 type <sensor type>
754 This command will display all records from the SDR of a
756 specific type. Run with type list to see the list of
757 available types. For example to query for all Tempera‐
758 ture sensors:
759 > ipmitool sdr type Temperature
761 Baseboard Temp | 30h | ok | 7.1 | 28 degrees C
762 FntPnl Amb Temp | 32h | ok | 12.1 | 24 degrees C
763 Processor1 Temp | 98h | ok | 3.1 | 57 degrees C
764 Processor2 Temp | 99h | ok | 3.2 | 53 degrees C
765 list | elist [<all|full|compact|event|mcloc|fru|generic>]
768 This command will read the Sensor Data Records (SDR) and
770 extract sensor information of a given type, then query
771 each sensor and print its name, reading, and status. If
772 invoked as elist then it will also print sensor number,
773 entity id and instance, and asserted discrete states.
774 The default output will only display full and compact
776 sensor types, to see all sensors use the all type with
777 this command.
778 Valid types are:
780 all
782 All SDR records (Sensor and Locator)
784 full
786 Full Sensor Record
788 compact
790 Compact Sensor Record
792 event
794 Event-Only Sensor Record
796 mcloc
798 Management Controller Locator Record
800 fru
802 FRU Locator Record
804 generic
806 Generic SDR records
808 entity <id>[.<instance>]
810 Displays all sensors associated with an entity. Get a
812 list of valid entity ids on the target system by issuing
813 the sdr elist command. A list of all entity ids can be
814 found in the IPMI specifications.
815 dump <file>
817 Dumps raw SDR data to a file. This data file can then be
819 used as a local SDR cache of the remote managed system
820 with the -S <file> option on the ipmitool command line.
821 This can greatly improve performance over system inter‐
822 face or remote LAN.
823 sel
825 NOTE: SEL entry-times are displayed as `Pre-Init Time-stamp' if
827 the SEL clock needs to be set. Ensure that the SEL clock is
828 accurate by invoking the sel time get and sel time set <time
829 string> commands.
830 info
832 This command will query the BMC for information about the
834 System Event Log (SEL) and its contents.
835 clear
837 This command will clear the contents of the SEL. It
839 cannot be undone so be careful.
840 list | elist
842 When this command is invoked without arguments, the
844 entire contents of the System Event Log are displayed.
845 If invoked as elist it will also use the Sensor Data
846 Record entries to display the sensor ID for the sensor
847 that caused each event. Note this can take a long time
848 over the system interface.
849 <count>|first <count>
852 Displays the first count (least-recent) entries in
854 the SEL. If count is zero, all entries are dis‐
855 played.
856 last <count>
858 Displays the last count (most-recent) entries in
860 the SEL. If count is zero, all entries are dis‐
861 played.
862 delete <number>
864 Delete a single event.
866 save <file>
868 Save SEL records to text file that can be fed back into
870 the event file ipmitool command. This can be useful for
871 testing Event generation by building an appropriate Plat‐
872 form Event Message file based on existing events. Please
873 see the help for that command to view the format of this
874 file.
875 writeraw <file>
877 Save SEL records to a file in raw, binary format. This
879 file can be fed back to the sel readraw ipmitool command
880 for viewing.
881 readraw <file>
883 Read and display SEL records from a binary file. Such a
885 file can be created using the sel writeraw ipmitool com‐
886 mand.
887 time
889 get
891 Displays the SEL clock's current time.
892 set <time string>
894 Sets the SEL clock. Future SEL entries will use
896 the time set by this command. <time string> is of
897 the form "MM/DD/YYYY HH:MM:SS". Note that hours
898 are in 24-hour form. It is recommended that the
899 SEL be cleared before setting the time.
900 sensor
902 list
904 Lists sensors and thresholds in a wide table format.
906 get <id> ... [<id>]
908 Prints information for sensors specified by name.
910 thresh <id> <threshold> <setting>
912 This allows you to set a particular sensor threshold
914 value. The sensor is specified by name.
915 Valid thresholds are:
917 unr Upper Non-Recoverable
918 ucr Upper Critical
919 unc Upper Non-Critical
920 lnc Lower Non-Critical
921 lcr Lower Critical
922 lnr Lower Non-Recoverable
923 thresh <id> lower <lnr> <lcr> <lnc>
925 This allows you to set all lower thresholds for a sensor
927 at the same time. The sensor is specified by name and
928 the thresholds are listed in order of Lower Non-Recover‐
929 able, Lower Critical, and Lower Non-Critical.
930 thresh <id> upper <unc> <ucr> <unr>
932 This allows you to set all upper thresholds for a sensor
934 at the same time. The sensor is specified by name and
935 the thresholds are listed in order of Upper Non-Critical,
936 Upper Critical, and Upper Non-Recoverable.
937 session
940 info <active|all|id 0xnnnnnnnn|handle 0xnn>
942 Get information about the specified session(s). You may
944 identify sessions by their id, by their handle number, by
945 their active status, or by using the keyword `all' to
946 specify all sessions.
947 shell
949 This command will launch an interactive shell which you can use
950 to send multiple ipmitool commands to a BMC and see the
951 responses. This can be useful instead of running the full ipmi‐
952 tool command each time. Some commands will make use of a Sensor
953 Data Record cache and you will see marked improvement in speed
954 if these commands are able to reuse the same cache in a shell
955 session. LAN sessions will send a periodic keepalive command to
956 keep the IPMI session from timing out.
957 sol
959 info [<channel number>]
961 Retrieve information about the Serial-Over-LAN configura‐
963 tion on the specified channel. If no channel is given,
964 it will display SOL configuration data for the currently
965 used channel.
966 set <parameter> <value> [<channel>]
968 Configure parameters for Serial Over Lan. If no channel
970 is given, it will display SOL configuration data for the
971 currently used channel. Configuration parameter updates
972 are automatically guarded with the updates to the
973 set-in-progress parameter.
974 Valid parameters and values are:
976 set-in-progress
978 set-complete set-in-progress commit-write
979 enabled
981 true false
982 force-encryption
984 true false
985 force-authentication
987 true false
988 privilege-level
990 user operator admin oem
991 character-accumulate-level
993 Decimal number given in 5 milliseconds increments
994 character-send-threshold
996 Decimal number
997 retry-count
999 Decimal number. 0 indicates no retries after
1000 packet is transmitted.
1001 retry-interval
1003 Decimal number in 10 millisend increments. 0
1004 indicates that retries should be sent back to
1005 back.
1006 non-volatile-bit-rate
1008 serial, 19.2, 38.4, 57.6, 115.2. Setting this
1009 value to serial indicates that the BMC should use
1010 the setting used by the IPMI over serial channel.
1011 volatile-bit-rate
1013 serial, 19.2, 38.4, 57.6, 115.2. Setting this
1014 value to serial indiates that the BMC should use
1015 the setting used by the IPMI over serial channel.
1016 activate
1018 Causes ipmitool to enter Serial Over LAN mode, and is
1020 only available when using the lanplus interface. An
1021 RMCP+ connection is made to the BMC, the terminal is set
1022 to raw mode, and user input is sent to the serial console
1023 on the remote server. On exit,the the SOL payload mode
1024 is deactivated and the terminal is reset to its original
1025 settings.
1026 Special escape sequences are provided to control the SOL
1028 session:
1029 ~. Terminate connection
1031 ~^Z Suspend ipmitool
1033 ~B Send break
1035 ~~ Send the escape character by typing it twice
1037 ~? Print the supported escape sequences
1039 deactivate
1041 Deactivates Serial Over LAN mode on the BMC. Exiting
1043 Serial Over LAN mode should automatically cause this com‐
1044 mand to be sent to the BMC, but in the case of an unin‐
1045 tentional exit from SOL mode, this command may be neces‐
1046 sary to reset the state of the BMC.
1047 sunoem
1049 led
1051 These commands provide a way to get and set the status of
1053 LEDs on a Sun Microsystems server. Use 'sdr list
1054 generic' to get a list of devices that are controllable
1055 LEDs. The ledtype parameter is optional and not neces‐
1056 sary to provide on the command line unless it is required
1057 by hardware.
1058 get <sensorid> [<ledtype>]
1060 Get status of a particular LED described by a
1062 Generic Device Locator record in the SDR. A sen‐
1063 sorid of all will get the status of all available
1064 LEDS.
1065 set <sensorid> <ledmode> [<ledtype>]
1067 Set status of a particular LED described by a
1069 Generic Device Locator record in the SDR. A sen‐
1070 sorid of all will set the status of all available
1071 LEDS to the specified ledmode and ledtype.
1072 LED Mode is required for set operations:
1074 OFF Off
1075 ON Steady On
1076 STANDBY 100ms on 2900ms off blink rate
1077 SLOW 1HZ blink rate
1078 FAST 4HZ blink rate
1079 LED Type is optional:
1081 OK2RM Ok to Remove
1082 SERVICE Service Required
1083 ACT Activity
1084 LOCATE Locate
1085 sshkey
1088 set <userid> <keyfile>
1090 This command will allow you to specify an SSH key
1092 to use for a particular user on the Service Pro‐
1093 cessor. This key will be used for CLI logins to
1094 the SP and not for IPMI sessions. View available
1095 users and their userids with the 'user list' com‐
1096 mand.
1097 del <userid>
1099 This command will delete the SSH key for a speci‐
1101 fied userid.
1102 tsol
1106 This command allows Serial-over-LAN sessions to be established
1108 with Tyan IPMIv1.5 SMDC such as the M3289 or M3290. The default
1109 command run with no arguments will establish default SOL session
1110 back to local IP address. Optional arguments may be supplied in
1111 any order.
1112 <ipaddr>
1115 Send receiver IP address to SMDC which it will use to
1117 send serial traffic to. By default this detects the
1118 local IP address and establishes two-way session.
1119 port=NUM
1122 Configure UDP port to receive serial traffic on. By
1124 default this is 6230.
1125 ro|rw
1128 Confiure SOL session as read-only or read-write. Ses‐
1130 sions are read-write by default.
1131 user
1135 summary
1137 Displays a summary of userid information, including maxi‐
1139 mum number of userids, the number of enabled users, and
1140 the number of fixed names defined.
1141 list
1143 Displays a list of user information for all defined
1145 userids.
1146 set
1148 name <userid> <username>
1150 Sets the username associated with the given
1152 userid.
1153 password <userid> [<password>]
1155 Sets the password for the given userid. If no
1157 password is given, the password is cleared (set to
1158 the NULL password). Be careful when removing
1159 passwords from administrator-level accounts.
1160 disable <userid>
1162 Disables access to the BMC by the given userid.
1164 enable <userid>
1166 Enables access to the BMC by the given userid.
1168 test <userid> <16|20> [<password>]
1170 Determine whether a password has been stored as 16 or 20
1172 bytes.
1173
1176 The ipmitool open interface utilizes the OpenIPMI kernel device driver.
1177 This driver is present in all modern 2.4 and all 2.6 kernels and it
1178 should be present in recent Linux distribution kernels. There are also
1179 IPMI driver kernel patches for different kernel versions available from
1180 the OpenIPMI homepage.
1181 The required kernel modules is different for 2.4 and 2.6 kernels. The
1183 following kernel modules must be loaded on a 2.4-based kernel in order
1184 for ipmitool to work:
1185 ipmi_msghandler
1187 Incoming and outgoing message handler for IPMI interfaces.
1188 ipmi_kcs_drv
1190 An IPMI Keyboard Controler Style (KCS) interface driver for the
1191 message handler.
1192 ipmi_devintf
1194 Linux character device interface for the message handler.
1195 The following kernel modules must be loaded on a 2.6-based kernel in
1197 order for ipmitool to work:
1198 ipmi_msghandler
1200 Incoming and outgoing message handler for IPMI interfaces.
1201 ipmi_si
1203 An IPMI system interface driver for the message handler. This
1204 module supports various IPMI system interfaces such as KCS, BT,
1205 SMIC, and even SMBus in 2.6 kernels.
1206 ipmi_devintf
1208 Linux character device interface for the message handler.
1209 Once the required modules are loaded there will be a dynamic character
1211 device entry that must exist at /dev/ipmi0. For systems that use devfs
1212 or udev this will appear at /dev/ipmi/0.
1213 To create the device node first determine what dynamic major number it
1215 was assigned by the kernel by looking in /proc/devices and checking for
1216 the ipmidev entry. Usually if this is the first dynamic device it will
1217 be major number 254 and the minor number for the first system interface
1218 is 0 so you would create the device entry with:
1219 mknod /dev/ipmi0 c 254 0
1221 ipmitool includes some sample initialization scripts that can perform
1223 this task automatically at start-up.
1224 In order to have ipmitool use the OpenIPMI device interface you can
1226 specifiy it on the command line:
1227 ipmitool -I open <command>
1229
1231 The ipmitool bmc interface utilizes the bmc device driver as provided
1232 by Solaris 10 and higher. In order to force ipmitool to make use of
1233 this interface you can specify it on the command line:
1234 ipmitool -I bmc <command>
1236 The following files are associated with the bmc driver:
1238 /platform/i86pc/kernel/drv/bmc
1241 32-bit ELF kernel module for the bmc driver.
1242 /platform/i86pc/kernel/drv/amd64/bmc
1244 64-bit ELF kernel module for the bmc driver.
1245 /dev/bmc
1247 Character device node used to communicate with the bmc driver.
1248
1250 The ipmitool lipmi interface uses the Solaris 9 IPMI kernel device
1251 driver. It has been superceeded by the bmc interface on Solaris 10.
1252 You can tell ipmitool to use this interface by specifying it on the
1253 command line.
1254 ipmitool -I lipmi <expression>
1256
1258 The ipmitool lan interface communicates with the BMC over an Ethernet
1259 LAN connection using UDP under IPv4. UDP datagrams are formatted to
1260 contain IPMI request/response messages with a IPMI session headers and
1261 RMCP headers.
1262 IPMI-over-LAN uses version 1 of the Remote Management Control Protocol
1264 (RMCP) to support pre-OS and OS-absent management. RMCP is a
1265 request-response protocol delivered using UDP datagrams to port 623.
1266 The LAN interface is an authenticatiod multi-session connection; mes‐
1268 sages delivered to the BMC can (and should) be authenticated with a
1269 challenge/response protocol with either straight password/key or MD5
1270 message-digest algorithm. ipmitool will attempt to connect with admin‐
1271 istrator privilege level as this is required to perform chassis power
1272 functions.
1273 You can tell ipmitool to use the lan interface with the -I lan option:
1275 ipmitool -I lan -H <hostname> [-U <username>] [-P <password>] <command>
1278 A hostname must be given on the command line in order to use the lan
1280 interface with ipmitool. The password field is optional; if you do not
1281 provide a password on the command line, ipmitool will attempt to con‐
1282 nect without authentication. If you specify a password it will use MD5
1283 authentication if supported by the BMC and straight password/key other‐
1284 wise, unless overridden with a command line option.
1285
1287 Like the lan interface, the lanplus interface communicates with the BMC
1288 over an Ethernet LAN connection using UDP under IPv4. The difference
1289 is that the lanplus interface uses the RMCP+ protocol as described in
1290 the IMPI v2.0 specification. RMCP+ allows for improved authentication
1291 and data integrity checks, as well as encryption and the ability to
1292 carry multiple types of payloads. Generic Serial Over LAN support
1293 requires RMCP+, so the ipmitool sol activate command requires the use
1294 of the lanplus interface.
1295 RMCP+ session establishment uses a symmetric challenge-response proto‐
1297 col called RAKP (Remote Authenticated Key-Exchange Protocol) which
1298 allows the negotiation of many options. ipmitool does not yet allow
1299 the user to specify the value of every option, defaulting to the most
1300 obvious settings marked as required in the v2.0 specification. Authen‐
1301 tication and integrity HMACS are produced with SHA1, and encryption is
1302 performed with AES-CBC-128. Role-level logins are not yet supported.
1303 ipmitool must be linked with the OpenSSL library in order to perform
1305 the encryption functions and support the lanplus interface. If the
1306 required packages are not found it will not be compiled in and sup‐
1307 ported.
1308 You can tell ipmitool to use the lanplus interface with the -I lanplus
1310 option:
1311 ipmitool -I lanplus -H <hostname> [-U <username>] [-P <password>] <com‐
1314 mand>
1315 A hostname must be given on the command line in order to use the lan
1317 interface with ipmitool. With the exception of the -A and -C options
1318 the rest of the command line options are identical to those available
1319 for the lan interface.
1320 The -C option allows you specify the authentication, integrity, and
1322 encryption algorithms to use for for lanplus session based on the
1323 cipher suite ID found in the IPMIv2.0 specification in table 22-19.
1324 The default cipher suite is 3 which specifies RAKP-HMAC-SHA1 authenti‐
1325 cation, HMAC-SHA1-96 integrity, and AES-CBC-128 encryption algorightms.
1326
1328 Example 1: Listing remote sensors
1329 > ipmitool -I lan -H 1.2.3.4 -f passfile sdr list
1331 Baseboard 1.25V | 1.24 Volts | ok
1332 Baseboard 2.5V | 2.49 Volts | ok
1333 Baseboard 3.3V | 3.32 Volts | ok
1334 Example 2: Displaying status of a remote sensor
1336 > ipmitool -I lan -H 1.2.3.4 -f passfile sensor get "Baseboard
1338 1.25V"
1339 Locating sensor record...
1340 Sensor ID : Baseboard 1.25V (0x10)
1341 Sensor Type (Analog) : Voltage
1342 Sensor Reading : 1.245 (+/- 0.039) Volts
1343 Status : ok
1344 Lower Non-Recoverable : na
1345 Lower Critical : 1.078
1346 Lower Non-Critical : 1.107
1347 Upper Non-Critical : 1.382
1348 Upper Critical : 1.431
1349 Upper Non-Recoverable : na
1350 Example 3: Displaying the power status of a remote chassis
1352 > ipmitool -I lan -H 1.2.3.4 -f passfile chassis power status
1354 Chassis Power is on
1355 Example 4: Controlling the power on a remote chassis
1357 > ipmitool -I lan -H 1.2.3.4 -f passfile chassis power on
1359 Chassis Power Control: Up/On
1360
1362 Duncan Laurie <duncan@iceblink.org>
1363
1365 IPMItool Homepage
1366 http://ipmitool.sourceforge.net
1367 Intelligent Platform Management Interface Specification
1369 http://www.intel.com/design/servers/ipmi
1370 OpenIPMI Homepage
1372 http://openipmi.sourceforge.net
1373Duncan Laurie ipmitool(1)