1ipmitool(1) ipmitool(1)
2
6 ipmitool - utility for controlling IPMI-enabled devices
7
9 ipmitool [ <options> ] <command> [ <sub-commands and sub-options> ]
10 <options> := [ <general-options> | <conditional-opts> ]
12 Any recognized option is accepted. Conditional options may be ignored
13 or it's usage postponed until shell or exec processes relevant command.
14 <general-options> := [ -h | -V | -v | -I <interface> | -H <address> |
16 -d <N> | -p <port> | -c | -U <username> |
17 -L <privlvl> | -l <lun> | -m <local_address> |
18 -N <sec> | -R <count> | <password-option> |
19 <oem-option> | <bridge-options> ]
20 <conditional-opts> := [ <lan-options> | <lanplus-options> |
22 <command-options> ]
23 Bridging:
24 <bridge-options> := -t <target_address> [ -b <channel> |
25 [ -T <address> | -B <channel> ] ]
26 Options used with -I lan:
28 <lan-options> := [ -A <authtype> ]
29 Options used with -I lanplus:
31 <lanplus-options> := [ -C <ciphersuite> | <key-option> ]
32 Option groups setting same value:
34 <key-option> := [ -k <key> | -K | -y <hex_key> | -Y ]
35 <password-option> := [ -f <password_file> | -a | -P <password> | -E ]
36 <oem-option> := [ -o <oemtype> | -g | -s ]
37 Options used with specific command <command-options>:
39 <options-sdr> := [ -S <sdr_cache_file> ]
40 <options-sel> := [ -O <sel_oem> ]
41 <options-sol> := [ -e <sol_escape_char> ]
42
46 This program lets you manage Intelligent Platform Management Interface
47 (IPMI) functions of either the local system, via a kernel device
48 driver, or a remote system, using IPMI v1.5 and IPMI v2.0. These func‐
49 tions include printing FRU information, LAN configuration, sensor read‐
50 ings, and remote chassis power control.
51 IPMI management of a local system interface requires a compatible IPMI
53 kernel driver to be installed and configured. On Linux this driver is
54 called OpenIPMI and it is included in standard distributions. On
55 Solaris this driver is called BMC and is inclued in Solaris 10. Man‐
56 agement of a remote station requires the IPMI-over-LAN interface to be
57 enabled and configured. Depending on the particular requirements of
58 each system it may be possible to enable the LAN interface using ipmi‐
59 tool over the system interface.
60
62 -a Prompt for the remote server password.
63 -A <authtype>
65 Specify an authentication type to use during IPMIv1.5 lan ses‐
66 sion activation. Supported types are NONE, PASSWORD, MD2, MD5,
67 or OEM.
68 -b <channel>
70 Set destination channel for bridged request.
71 -B <channel>
73 Set transit channel for bridged request (dual bridge).
74 -b <channel>
76 Set destination channel for bridged request.
77 -B <channel>
79 Set transit channel for bridged request. (dual bridge)
80 -c Present output in CSV (comma separated variable) format. This
82 is not available with all commands.
83 -C <ciphersuite>
85 The remote server authentication, integrity, and encryption
86 algorithms to use for IPMIv2.0 lanplus connections. See table
87 22-19 in the IPMIv2.0 specification. The default is 3 which
88 specifies RAKP-HMAC-SHA1 authentication, HMAC-SHA1-96 integrity,
89 and AES-CBC-128 encryption algorithms.
90 -d N Use device number N to specify the /dev/ipmiN (or /dev/ipmi/N or
92 /dev/ipmidev/N) device to use for in-band BMC communication.
93 Used to target a specific BMC on a multi-node, multi-BMC system
94 through the ipmi device driver interface. Default is 0.
95 -e <sol_escape_char>
97 Use supplied character for SOL session escape character. The
98 default is to use ~ but this can conflict with ssh sessions.
99 -E The remote server password is specified by the environment vari‐
101 able IPMI_PASSWORD or IPMITOOL_PASSWORD. The IPMITOOL_PASSWORD
102 takes precedence.
103 -f <password_file>
105 Specifies a file containing the remote server password. If this
106 option is absent, or if password_file is empty, the password
107 will default to NULL.
108 -g Deprecated. Use: -o intelplus
110 -h Get basic usage help from the command line.
112 -H <address>
114 Remote server address, can be IP address or hostname. This
115 option is required for lan and lanplus interfaces.
116 -I <interface>
118 Selects IPMI interface to use. Supported interfaces that are
119 compiled in are visible in the usage help output.
120 -k <key>
122 Use supplied Kg key for IPMIv2.0 authentication. The default is
123 not to use any Kg key.
124 -K Read Kg key from IPMITOOL_KGKEY or IPMI_KGKEY environment vari‐
126 able. IPMITOOL_KGKEY takes precedence.
127 -l <lun>
129 Set destination lun for raw commands.
130 -L <privlvl>
132 Force session privilege level. Can be CALLBACK, USER, OPERATOR,
133 ADMINISTRATOR. Default is ADMINISTRATOR. This value is ignored
134 and always set to ADMINISTRATOR when combined with -t target
135 address.
136 -m <local_address>
138 Set the local IPMB address. The local address defaults to 0x20
139 or is auto discovered on PICMG platforms when -m is not speci‐
140 fied. There should be no need to change the local address for
141 normal operation.
142 -N <sec>
144 Specify nr. of seconds between retransmissions of lan/lanplus
145 messages. Defaults are 2 seconds for lan and 1 second for lan‐
146 plus interfaces. Command raw uses fixed value of 15 seconds.
147 Command sol uses fixed value of 1 second.
148 -o <oemtype>
150 Select OEM type to support. This usually involves minor hacks
151 in place in the code to work around quirks in various BMCs from
152 various manufacturers. Use -o list to see a list of current
153 supported OEM types.
154 -O <sel oem>
156 Open selected file and read OEM SEL event descriptions to be
157 used during SEL listings. See examples in contrib dir for file
158 format.
159 -p <port>
161 Remote server UDP port to connect to. Default is 623.
162 -P <password>
164 Remote server password is specified on the command line. If
165 supported it will be obscured in the process list. Note! Speci‐
166 fying the password as a command line option is not recommended.
167 -R <count>
169 Set the number of retries for lan/lanplus interface (default=4).
170 Command raw uses fixed value of one try (no retries). Command
171 hpm uses fixed value of 10 retries.
172 -s Deprecated. Use: -o supermicro
174 -S <sdr_cache_file>
176 Use local file for remote SDR cache. Using a local SDR cache
177 can drastically increase performance for commands that require
178 knowledge of the entire SDR to perform their function. Local
179 SDR cache from a remote system can be created with the sdr dump
180 command.
181 -t <target_address>
183 Bridge IPMI requests to the remote target address. Default is
184 32. The -L privlvl option is always ignored and value set to
185 ADMINISTRATOR.
186 -T <address>
188 Set transit address for bridge request (dual bridge).
189 -T <transmit_address>
191 Set transit address for bridge request. (dual bridge)
192 -U <username>
194 Remote server username, default is NULL user.
195 -v Increase verbose output level. This option may be specified
197 multiple times to increase the level of debug output. If given
198 three times you will get hexdumps of all incoming and outgoing
199 packets. Using it five times provides details on request and
200 expected reply procesing. The hpm commands targetcap compprop
201 abort upgstatus rollback rollbackstatus selftestresult increases
202 the verbosity level
203 -V Display version information.
205 -y <hex key>
207 Use supplied Kg key for IPMIv2.0 authentication. The key is
208 expected in hexadecimal format and can be used to specify keys
209 with non-printable characters. E.g. '-k PASSWORD' and '-y
210 50415353574F5244' are equivalent. The default is not to use any
211 Kg key.
212 -Y Prompt for the Kg key for IPMIv2.0 authentication.
214 -z <size>
216 Change Size of Communication Channel. (OEM)
217 If no password method is specified then ipmitool will prompt the user
220 for a password. If no password is entered at the prompt, the remote
221 server password will default to NULL.
222 All the above options may be specified using environment variable.
224 Either IPMITOOL_OPTS or IPMI_OPTS. IPMITOOL_OPTS takes precedence.
225
227 There are several security issues be be considered before enabling the
228 IPMI LAN interface. A remote station has the ability to control a sys‐
229 tem's power state as well as being able to gather certain platform
230 information. To reduce vulnerability it is strongly advised that the
231 IPMI LAN interface only be enabled in 'trusted' environments where sys‐
232 tem security is not an issue or where there is a dedicated secure 'man‐
233 agement network'.
234 Further it is strongly advised that you should not enable IPMI for
236 remote access without setting a password, and that that password should
237 not be the same as any other password on that system.
238 When an IPMI password is changed on a remote machine with the IPMIv1.5
240 lan interface the new password is sent across the network as clear
241 text. This could be observed and then used to attack the remote sys‐
242 tem. It is thus recommended that IPMI password management only be done
243 over IPMIv2.0 lanplus interface or the system interface on the local
244 station.
245 For IPMI v1.5, the maximum password length is 16 characters. Passwords
247 longer than 16 characters will be truncated.
248 For IPMI v2.0, the maximum password length is 20 characters; longer
250 passwords are truncated.
251
253 help This can be used to get command-line help on ipmitool com‐
254 mands. It may also be placed at the end of commands to get
255 option usage help.
256 ipmitool help
258 Commands:
259 bmc Deprecated. Use mc
260 channel Configure Management Controller channels
261 chassis Get chassis status and set power state
262 dcmi Data Center Management Interface
263 delloem Manage Dell OEM Extensions.
264 echo Used to echo lines to stdout in scripts
265 ekanalyzer run FRU-Ekeying analyzer using FRU files
266 event Send events to MC
267 exec Run list of commands from file
268 firewall Configure Firmware Firewall
269 fru Print built-in FRU and scan for FRU loca‐
270 tors
271 fwum Update IPMC using Kontron OEM Firmware
272 Update Manager
273 gendev Read/Write Device associated with Generic
274 Device locators sdr
275 hpm Update HPM components using PICMG HPM.1
276 file
277 i2c Send an I2C Master Write-Read command and
278 print response
279 ime Upgrade/Query Intel ME firmware
280 isol Configure and connect Intel IPMIv1.5
281 Serial-over-LAN
282 kontronoem Manage Kontron OEM Extensions
283 lan Configure LAN Channels
284 mc Management Controller status and global
285 enables
286 pef Configure Platform Event Filtering (PEF)
287 picmg Run a PICMG/ATA extended command
288 power Shortcut to chassis power commands
289 raw Send a RAW IPMI request and print response
290 sdr Print Sensor Data Repository entries and
291 readings
292 sel Print System Event Log (SEL)
293 sensor Print detailed sensor information
294 session Print session information
295 set Set runtime variable for shell and exec
296 shell Launch interactive IPMI shell
297 sol Configure and connect IPMIv2.0
298 Serial-over-LAN
299 spd Print SPD info from remote I2C device
300 sunoem Manage Sun OEM Extensions
301 tsol Configure and connect Tyan IPMIv1.5
302 Serial-over-LAN
303 user Configure Management Controller users
304 channel
307 authcap <channel number> <max priv>
309 Displays information about the authentication capabili‐
311 ties of the selected channel at the specified privilege
312 level.
313 Possible privilege levels are:
315 1 Callback level
316 2 User level
317 3 Operator level
318 4 Administrator level
319 5 OEM Proprietary level
320 15 No access
321 info [channel number]
323 Displays information about the selected channel. If
325 no channel is given it will display information about the
326 currently used channel.
327 > ipmitool channel info
329 Channel 0xf info:
330 Channel Medium Type : System Interface
331 Channel Protocol Type : KCS
332 Session Support : session-less
333 Active Session Count : 0
334 Protocol Vendor ID : 7154
335 getaccess <channel number> [<userid>]
337 Configure the given userid as the default on the given
339 channel number. When the given channel is subsequently
340 used, the user is identified implicitly by the given
341 userid.
342 setaccess <channel number> <userid> [<callin=on|off>]
344 [<ipmi=on|off>] [<link=on|off>] [<privi‐
345 lege=level>]
346 Configure user access information on the given
348 channel for the given userid.
349 getciphers <ipmi|sol> [<channel>]
351 Displays the list of cipher suites supported for
353 the given application (ipmi or sol) on the given
354 channel.
355 setkg <hex|plain> <key> [<channel>]
357 Sets K_g key to given value. Use plain to specify
359 key as simple ASCII string. Use hex to specify
360 key as sequence of hexadecimal codes of ASCII
361 charactes. I.e. following two examples are equiv‐
362 alent:
363 ipmitool channel setkg plain PASSWORD
365 ipmitool channel setkg hex 50415353574F5244
367 chassis
370 status
372 Status information related to power, buttons, cooling,
374 drives and faults.
375 power
377 status
379 on
381 off
383 cycle
385 reset
387 diag
389 soft
391 identify [<seconds>|force]
393 Identify interval.
395 Default is 15 seconds.
396 0 - Off
397 force - To turn on indefinitely
398 policy
400 What to do when power is restored.
402 list
404 Show available options.
406 always-on
408 previous
410 always-off
412 restart_cause
415 Last restart cause.
417 poh
419 Get power on hours.
421 bootdev
423 none
425 Do not change boot device order.
427 pxe
429 Force PXE boot.
431 disk
433 Force boot from default Hard-drive.
435 safe
437 Force boot from default Hard-drive, request Safe
439 Mode.
440 diag
442 Force boot from Diagnostic Partition.
444 cdrom
446 Force boot from CD/DVD.
448 bios
450 Force boot into BIOS Setup.
452 floppy
454 Force boot from Floppy/primary removable media.
456 bootparam
458 force_pxe
460 Force PXE boot
462 force_disk
464 Force boot from default Hard-drive
466 force_safe
468 Force boot from default Hard-drive, request Safe
470 Mode
471 force_diag
473 Force boot from Diagnostic Partition
475 force_cdrom
477 Force boot from CD/DVD
479 force_bios
481 Force boot into BIOS Setup
483 selftest
485 dcmi
487 discover
489 This command is used to discover supported capabilities
491 in DCMI.
492 power <command>
495 Platform power limit command options are:
497 reading
500 Get power related readings from the system.
502 get_limit
504 Get the configured power limits.
506 set_limit <parameter> <value>
508 Set a power limit option.
510 Possible parameters/values are:
513 action <No Action | Hard Power Off & Log Event to
516 SEL | Log Event to SEL>
517 Exception Actions are taken as "No Action",
519 "Hard Power Off system and log events to
520 SEL", or "Log event to SEL only".
521 limit <number in Watts>
523 Power Limit Requested in Watts.
525 correction <number in milliseconds>
527 Correction Time Limit in milliseconds.
529 sample <number in seconds>
531 Statistics Sampling period in seconds.
533 activate
536 Activate the set power limit.
538 deactivate
540 Deactivate the set power limit.
542 sensors
544 Prints the available DCMI sensors.
546 asset_tag
548 Prints the platforms asset tag.
550 set_asset_tag <string>
552 Sets the platforms asset tag
554 get_mc_id_string
556 Get management controller identifier string.
558 set_mc_id_string <string>
560 Set management controller identifier string. The maximum
562 length is 64 bytes including a null terminator.
563 thermalpolicy [<get | set>]
565 Thermal Limit policy get/set.
567 The commands are:
570 Get <entityID> <instanceID>
573 Get Thermal Limit values.
575 entityID is the physical entity that a sensor or
577 device is associated with. instanceID is a par‐
578 ticular instance of an entity. Entity Instance
579 can be in one of two ranges, system-relative or
580 device-relative. For example, a system with four
581 processors could use an Entity Instance value of
582 "0" to identify the first processor.
583 Set <entityID> <instanceID>
585 Set Thermal Limit values.
587 entityID is the physical entity that a sensor or
589 device is associated with. instanceID is a par‐
590 ticular instance of an entity. Entity Instance
591 can be in one of two ranges, system-relative or
592 device-relative. For example, a system with four
593 processors could use an Entity Instance value of
594 "0" to identify the first processor.
595 get_temp_reading
597 Get Temperature Sensor Readings.
599 get_conf_param
601 Get DCMI Configuration Parameters.
603 set_conf_param <parameters>
605 Set DCMI Configuration Parameters.
607 The Configuration Parameters are:
609 activate_dhcp
611 Activate/restart DHCP
613 dhcp_config
615 Discover DHCP Configuration.
617 init
619 Set DHCP Initial timeout interval, in seconds.
621 The recommended default is four seconds.
622 timeout
624 Set DHCP Server contact timeout interval, in sec‐
626 onds. The recommended default timeout is two min‐
627 utes.
628 retry
630 Set DHCP Server contact retry interval, in sec‐
632 onds. The recommended default timeout is sixty-
633 four seconds.
634 oob_discover
636 Ping/Pong Message for DCMI Discovery.
638 delloem
641 The delloem commands provide information on Dell-specific fea‐
643 tures.
644 setled {b:d.f} {state..}
646 Sets the drive backplane LEDs for a device.
648 {b:d.f} = PCI Address of device (eg. 06:00.0)
649 {state} = one or more of the following:
650 online | present | hotspare | identify | rebuild‐
651 ing | fault | predict | critical | failed
652 lcd
655 set {mode}|{lcdqualifier}|{errordisplay}
656 Allows you to set the LCD mode and user-defined
658 string.
659 lcd set mode
661 {none}|{modelname}|{ipv4address}|{macaddress}|
662 {systemname}|{servicetag}|{ipv6address}|
663 {ambienttemp}|{systemwatt}|{assettag}|
664 {userdefined}<text>
665 Allows you to set the LCD display mode to any of
667 the preceding parameters.
668 lcd set lcdqualifier
671 {watt}|{btuphr}|
672 {celsius}|{fahrenheit}
673 Allows you to set the unit for the system ambient
675 temperature mode.
676 lcd set errordisplay
679 {sel}|{simple}
680 Allows you to set the error display.
682 lcd info
684 Displays the LCD screen information.
686 lcd set vkvm
688 {active}|{inactive}
689 Allows you to set the vKVM status to active or
691 inactive. When it is active and session is in
692 progress, a message appears on LCD.
693 lcd status
695 Displays the LCD status for vKVM display active or
697 inactive and Front Panel access mode (viewandmod‐
698 ify, view-only or disabled).
699 mac
701 Displays the information about the system NICs.
703 mac list
705 Displays the NIC MAC address and status of all
707 NICs. It also displays the DRAC/iDRAC MAC address.
708 mac get
711 <NIC number>
712 Displays the selected NICs MAC address and status.
714 lan
716 Displays the information of Lan.
717 lan set
720 <Mode>
721 Sets the NIC selection mode (dedicated, shared
723 with lom1, shared with lom2,shared with
724 lom3,shared with lom4,shared with failover
725 lom1,shared with failover lom2,shared with
726 failover lom3,shared with failover lom4,shared
727 with Failover all loms, shared with Failover
728 None).
729 lan get
731 Returns the current NIC selection mode (dedicated,
733 shared with lom1, shared with lom2, shared with
734 lom3, shared with lom4,shared with failover lom1,
735 shared with failover lom2,shared with failover
736 lom3,shared with failover lom4,shared with
737 Failover all loms,shared with Failover None).
738 lan get active
741 Returns the current active NIC (dedicated, LOM1,
743 LOM2, LOM3 or LOM4).
744 powermonitor
746 Displays power tracking statistics.
748 powermonitor clear cumulativepower
751 Reset cumulative power reading.
753 powermonitor clear peakpower
755 Reset peak power reading.
757 powermonitor powerconsumption
759 <watt>|<btuphr>
760 Displays the power consumption in watt or btuphr.
761 powermonitor powerconsumptionhistory
763 <watt>|<btuphr>
764 Displays the power consumption history in watt or
765 btuphr.
766 powermonitor getpowerbudget
768 <watt>|<btuphr>
769 Displays the power cap in watt or btuphr.
770 powermonitor setpowerbudget
772 <val><watt|btuphr|percent>
773 Allows you to set the power cap in watt, BTU/hr
774 or percentage.
775 powermonitor enablepowercap
777 Enables set power cap.
778 powermonitor disablepowercap
780 Disables set power cap.
782 vFlash info Card
785 Shows Extended SD Card information.
787 echo
789 For echoing lines to stdout in scripts.
791 ekanalyzer <command> <xx=filename1> <xx=filename2> [<rc=filename3>] ...
793 NOTE : This command can support a maximum of 8 files per command
795 line
796 filename1 : binary file that stores FRU data of a Carrier or an
798 AMC module
799 filename2 : binary file that stores FRU data of an AMC module.
801 These binary files can be generated from command:
802 ipmitool fru read <id> <filename>
803 filename3 : configuration file used for configuring On-Carrier
805 Device ID
806 or OEM GUID. This file is optional.
807 xx : indicates the type of the file. It can take the following
809 value:
810 oc : On-Carrier device
812 a1 : AMC slot A1
814 a2 : AMC slot A2
816 a3 : AMC slot A3
818 a4 : AMC slot A4
820 b1 : AMC slot B1
822 b2 : AMC slot B2
824 b3 : AMC slot B3
826 b4 : AMC slot B4
828 sm : Shelf Manager
830 The available commands for ekanalyzer are:
833 print [<carrier | power | all>]
836 carrier (default) <oc=filename1> <oc=filename2> ...
838 Display point to point physical connectivity
840 between carriers and AMC modules.
841 Example:
842 > ipmitool ekanalyzer print carrier oc=fru
843 oc=carrierfru
844 From Carrier file: fru
845 Number of AMC bays supported by Carrier: 2
846 AMC slot B1 topology:
847 Port 0 =====> On Carrier Device ID 0,
848 Port 16
849 Port 1 =====> On Carrier Device ID 0,
850 Port 12
851 Port 2 =====> AMC slot B2, Port 2
852 AMC slot B2 topology:
853 Port 0 =====> On Carrier Device ID 0,
854 Port 3
855 Port 2 =====> AMC slot B1, Port 2
856 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
857 From Carrier file: carrierfru
858 On Carrier Device ID 0 topology:
859 Port 0 =====> AMC slot B1, Port 4
860 Port 1 =====> AMC slot B1, Port 5
861 Port 2 =====> AMC slot B2, Port 6
862 Port 3 =====> AMC slot B2, Port 7
863 AMC slot B1 topology:
864 Port 0 =====> AMC slot B2, Port 0
865 AMC slot B1 topology:
866 Port 1 =====> AMC slot B2, Port 1
867 Number of AMC bays supported by Carrier: 2
868 power <xx=filename1> <xx=filename2> ...
871 Display power supply informations between carrier
873 and AMC modules.
874 all <xx=filename> <xx=filename> ...
876 Display both physical connectivity and power sup‐
878 ply of each carrier and AMC modules.
879 frushow <xx=filename>
882 Convert a binary FRU file into human readable text for‐
883 mat. Use -v option to get more display information.
884 summary [<match | unmatch | all>]
887 match (default) <xx=filename> <xx=filename> ...
889 Display only matched results of Ekeying match
890 between an On-Carrier device and an AMC module or
891 between 2 AMC modules. Example:
892 > ipmitool ekanalyzer summary match oc=fru
893 b1=amcB1 a2=amcA2
894 On-Carrier Device vs AMC slot B1
895 AMC slot B1 port 0 ==> On-Carrier Device 0 port
896 16
897 Matching Result
898 - From On-Carrier Device ID 0
899 -Channel ID 11 || Lane 0: enable
900 -Link Type: AMC.2 Ethernet
901 -Link Type extension: 1000BASE-BX (SerDES
902 Gigabit) Ethernet link
903 -Link Group ID: 0 || Link Asym. Match: exact
904 match
905 - To AMC slot B1
906 -Channel ID 0 || Lane 0: enable
907 -Link Type: AMC.2 Ethernet
908 -Link Type extension: 1000BASE-BX (SerDES
909 Gigabit) Ethernet link
910 -Link Group ID: 0 || Link Asym. Match: exact
911 match
912 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
913 AMC slot B1 port 1 ==> On-Carrier Device 0 port
914 12
915 Matching Result
916 - From On-Carrier Device ID 0
917 -Channel ID 6 || Lane 0: enable
918 -Link Type: AMC.2 Ethernet
919 -Link Type extension: 1000BASE-BX (SerDES
920 Gigabit) Ethernet link
921 -Link Group ID: 0 || Link Asym. Match: exact
922 match
923 - To AMC slot B1
924 -Channel ID 1 || Lane 0: enable
925 -Link Type: AMC.2 Ethernet
926 -Link Type extension: 1000BASE-BX (SerDES
927 Gigabit) Ethernet link
928 -Link Group ID: 0 || Link Asym. Match: exact
929 match
930 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
931 On-Carrier Device vs AMC slot A2
932 AMC slot A2 port 0 ==> On-Carrier Device 0 port
933 3
934 Matching Result
935 - From On-Carrier Device ID 0
936 -Channel ID 9 || Lane 0: enable
937 -Link Type: AMC.2 Ethernet
938 -Link Type extension: 1000BASE-BX (SerDES
939 Gigabit) Ethernet link
940 -Link Group ID: 0 || Link Asym. Match: exact
941 match
942 - To AMC slot A2
943 -Channel ID 0 || Lane 0: enable
944 -Link Type: AMC.2 Ethernet
945 -Link Type extension: 1000BASE-BX (SerDES
946 Gigabit) Ethernet link
947 -Link Group ID: 0 || Link Asym. Match: exact
948 match
949 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
950 AMC slot B1 vs AMC slot A2
951 AMC slot A2 port 2 ==> AMC slot B1 port 2
952 Matching Result
953 - From AMC slot B1
954 -Channel ID 2 || Lane 0: enable
955 -Link Type: AMC.3 Storage
956 -Link Type extension: Serial Attached SCSI
957 (SAS/SATA)
958 -Link Group ID: 0 || Link Asym. Match: FC or
959 SAS interface {exact match}
960 - To AMC slot A2
961 -Channel ID 2 || Lane 0: enable
962 -Link Type: AMC.3 Storage
963 -Link Type extension: Serial Attached SCSI
964 (SAS/SATA)
965 -Link Group ID: 0 || Link Asym. Match: FC or
966 SAS interface {exact match}
967 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
968 unmatch <xx=filename> <xx=filename> ...
970 Display the unmatched results of Ekeying match
972 between an On-Carrier device and an AMC module or
973 between 2 AMC modules
974 all <xx=filename> <xx=filename> ...
976 Display both matched result and unmatched results
978 of Ekeying match between two cards or two modules.
979 event
981 <predefined event number N>
983 Send a pre-defined test event to the System Event Log.
985 The following events are included as a means to test the
986 functionality of the System Event Log component of the
987 BMC (an entry will be added each time the event N command
988 is executed).
989 Currently supported values for N are:
991 1 Temperature: Upper Critical: Going High
992 2 Voltage Threshold: Lower Critical: Going Low
993 3 Memory: Correctable ECC
994 NOTE: These pre-defined events will likely not produce
996 "accurate" SEL records for a particular system because
997 they will not be correctly tied to a valid sensor number,
998 but they are sufficient to verify correct operation of
999 the SEL.
1000 file <filename>
1003 Event log records specified in <filename> will be added
1005 to the System Event Log.
1006 The format of each line in the file is as follows:
1008 <{EvM Revision} {Sensor Type} {Sensor Num} {Event
1010 Dir/Type} {Event Data 0} {Event Data 1} {Event Data 2}>[#
1011 COMMENT]
1012 e.g.: 0x4 0x2 0x60 0x1 0x52 0x0 0x0 # Voltage threshold:
1014 Lower Critical: Going Low
1015 EvM Revision - The "Event Message Revision" is 0x04 for
1017 messages that comply with the IPMI 2.0 Specification and
1018 0x03 for messages that comply with the IPMI 1.0 Specifi‐
1019 cation.
1020 Sensor Type - Indicates the Event Type or Class.
1022 Sensor Num - Represents the 'sensor' within the manage‐
1024 ment controller that generated the Event Message.
1025 Event Dir/Type - This field is encoded with the event
1027 direction as the high bit (bit 7) and the event type as
1028 the low 7 bits. Event direction is 0 for an assertion
1029 event and 1 for a deassertion event.
1030 See the IPMI 2.0 specification for further details on the
1032 definitions for each field.
1033 <sensorid> <list>
1036 Get a list of all the possible Sensor States and pre-
1038 defined Sensor State Shortcuts available for a particular
1039 sensor. sensorid is the character string representation
1040 of the sensor and must be enclosed in double quotes if it
1041 includes white space. Several different commands includ‐
1042 ing ipmitool sensor list may be used to obtain a list
1043 that includes the sensorid strings representing the sen‐
1044 sors on a given system.
1045 > ipmitool -I open event "PS 2T Fan Fault" list
1047 Finding sensor PS 2T Fan Fault... ok
1048 Sensor States:
1049 State Deasserted
1050 State Asserted
1051 Sensor State Shortcuts:
1052 present absent
1053 assert deassert
1054 limit nolimit
1055 fail nofail
1056 yes no
1057 on off
1058 up down
1059 <sensorid> <sensor state> [<direction>]
1062 Generate a custom event based on existing sensor informa‐
1064 tion. The optional event direction can be either assert
1065 (the default) or deassert.
1066 > ipmitool event "PS 2T Fan Fault" "State Asserted"
1069 Finding sensor PS 2T Fan Fault... ok
1070 0 | Pre-Init Time-stamp | Fan PS 2T Fan Fault |
1071 State Asserted
1072 > ipmitool event "PS 2T Fan Fault" "State Deasserted"
1074 Finding sensor PS 2T Fan Fault... ok
1075 0 | Pre-Init Time-stamp | Fan PS 2T Fan Fault |
1076 State Desserted
1077 exec <filename>
1079 Execute ipmitool commands from filename. Each line is a com‐
1081 plete command. The syntax of the commands are defined by the
1082 COMMANDS section in this manpage. Each line may have an
1083 optional comment at the end of the line, delimited with a `#'
1084 symbol.
1085 e.g., a command file with two lines:
1087 sdr list # get a list of sdr records
1089 sel list # get a list of sel records
1090 firewall
1092 This command supports the Firmware Firewall capability. It may
1094 be used to add or remove security-based restrictions on certain
1095 commands/command sub-functions or to list the current firmware
1096 firewall restrictions set on any commands. For each firmware
1097 firewall command listed below, parameters may be included to
1098 cause the command to be executed with increasing granularity on
1099 a specific LUN, for a specific NetFn, for a specific IPMI Com‐
1100 mand, and finally for a specific command's sub-function (see Ap‐
1101 pendix H in the IPMI 2.0 Specification for a listing of any sub-
1102 function numbers that may be associated with a particular com‐
1103 mand).
1104 Parameter syntax and dependencies are as follows:
1106 [<channel H>] [<lun L> [ <netfn N> [<command C [<subfn S>]]]]
1108 Note that if "netfn <N>" is specified, then "lun <L>" must also
1110 be specified; if "command <C>" is specified, then "netfn <N>"
1111 (and therefore "lun <L>") must also be specified, and so forth.
1112 "channel <H>" is an optional and standalone parameter. If not
1114 specified, the requested operation will be performed on the cur‐
1115 rent channel. Note that command support may vary from channel
1116 to channel.
1117 Firmware firewall commands:
1119 info [<Parms as described above>]
1121 List firmware firewall information for the specified LUN,
1123 NetFn, and Command (if supplied) on the current or speci‐
1124 fied channel. Listed information includes the support,
1125 configurable, and enabled bits for the specified command
1126 or commands.
1127 Some usage examples:
1129 info [<channel H>] [<lun L>]
1131 This command will list firmware firewall informa‐
1133 tion for all NetFns for the specified LUN on
1134 either the current or the specified channel.
1135 info [<channel H>] [<lun L> [ <netfn N> ]
1137 This command will print out all command informa‐
1139 tion for a single LUN/NetFn pair.
1140 info [<channel H>] [<lun L> [ <netfn N> [<command C] ]]
1142 This prints out detailed, human-readable informa‐
1144 tion showing the support, configurable, and
1145 enabled bits for the specified command on the
1146 specified LUN/NetFn pair. Information will be
1147 printed about each of the command subfunctions.
1148 info [<channel H>] [<lun L> [ <netfn N> [<command C
1150 [<subfn S>]]]]
1151 Print out information for a specific sub-function.
1153 enable [<Parms as described above>]
1155 This command is used to enable commands for a given
1157 NetFn/LUN combination on the specified channel.
1158 disable [<Parms as described above>] [force]
1160 This command is used to disable commands for a given
1162 NetFn/LUN combination on the specified channel. Great
1163 care should be taken if using the "force" option so as
1164 not to disable the "Set Command Enables" command.
1165 reset [<Parms as described above>]
1167 This command may be used to reset the firmware firewall
1169 back to a state where all commands and command sub-func‐
1170 tions are enabled.
1171 fru
1173 print
1175 Read all Field Replaceable Unit (FRU) inventory data
1177 and extract such information as serial number, part num‐
1178 ber, asset tags, and short strings describing the chas‐
1179 sis, board, or product.
1180 read <fru id> <fru file>
1182 fru id is the digit ID of the FRU (see output of 'fru
1184 print'). fru file is the absolute pathname of a file in
1185 which to dump the binary FRU data pertaining to the spec‐
1186 ified FRU entity.
1187 write <fru id> <fru file>
1189 fru id is the digit ID of the FRU (see output of 'fru
1191 print'). fru file is the absolute pathname of a file
1192 from which to pull the binary FRU data before uploading
1193 it to the specified FRU.
1194 upgEkey <fru id> <fru file>
1196 Update a multirecord FRU location. fru id is the digit
1198 ID of the FRU (see output of 'fru print'). fru file is
1199 the absolute pathname of a file from which to pull the
1200 binary FRU data to upload into the specified multirecord
1201 FRU entity.
1202 edit <fru id>
1205 This command provides interactive editing of some sup‐
1207 ported records, namely PICMG Carrier Activation Record.
1208 fru id is the digit ID of the FRU (see output of 'fru
1209 print'); default is 0.
1210 edit <fru id> field <section> <index> <string>
1213 This command may be used to set a field string to a new
1215 value. It replaces the FRU data found at index in the
1216 specified section with the supplied string.
1217 fru id is the digit ID of the FRU (see output of 'fru
1220 print').
1221 <section> is a string which refers to FRU Inventory
1224 Information
1225 Storage Areas and may be refer to:
1226 c FRU Inventory Chassis Info Area
1228 b FRU Inventory Board Info Area
1230 p FRU Inventory Product Info Area
1232 <index> specifies the field number. Field numbering
1235 starts on the first 'english text' field type. For
1236 instance in the <board> info area field '0' is <Board
1237 Manufacturer> and field '2' is <Board Serial Number>; see
1238 IPMI Platform Management FRU Information Storage Defini‐
1239 tion v1.0 R1.1 for field locations.
1240 <string> must be the same length as the string being
1243 replaced and must be 8-bit ASCII (0xCx).
1244 edit <fru id> oem iana <record> <format> [<args>]
1248 This command edits the data found in the multirecord
1250 area. Support for OEM specific records is limited.
1251 fwum
1253 Update IPMC using Kontron OEM Firmware Update Manager.
1254 info
1256 Show information about current firmware.
1257 status
1260 Show status of each firmware bank present in the hard‐
1261 ware.
1262 download <filename>
1265 Download specified firmware.
1267 upgrade [filename]
1270 Install firmware upgrade. If the filename is specified,
1272 the file is downloaded first, otherwise the last firmware
1273 downloaded is used.
1274 rollback
1277 Ask IPMC to rollback to previous version.
1279 tracelog
1282 Show firmware upgrade log.
1284 gendev
1287 list
1289 List All Generic Device Locators.
1291 read <sdr name> <file>
1293 Read to file eeprom specify by Generic Device Locators.
1295 write <sdr name> <file>
1297 Write from file eeprom specify by Generic Device Locators
1299 hpm
1301 PICMG HPM.1 Upgrade Agent
1302 check
1304 Check the target information.
1305 check <filename>
1308 Display both the existing target version and image ver‐
1309 sion on the screen.
1310 download <filename>
1313 Download specified firmware.
1315 upgrade <filename> [all] [component <x>] [activate]
1318 Upgrade the firmware using a valid HPM.1 image file. If
1319 no option is specified, the firmware versions are checked
1320 first and the firmware is upgraded only if they are dif‐
1321 ferent.
1322 all
1325 Upgrade all components even if the firmware ver‐
1326 sions are the same (use this only after using
1327 "check" command).
1328 component <x>
1331 Upgrade only given component from the given file.
1332 component 0 - BOOT
1333 component 1 - RTK
1334 activate
1337 Activate new firmware right away.
1338 activate
1342 Activate the newly uploaded firmware.
1344 targetcap
1347 Get the target upgrade capabilities.
1349 compprop <id> <select>
1352 Get the specified component properties. Valid component
1353 id: 0-7. Select can be one of following:
1354 0 - General properties
1355 1 - Current firmware version
1356 2 - Description string
1357 3 - Rollback firmware version
1358 4 - Deferred firmware version
1359 abort
1362 Abort the on-going firmware upgrade.
1364 upgstatus
1367 Show status of the last long duration command.
1368 rollback
1371 Perform manual rollback on the IPM Controller firmware.
1372 rollbackstatus
1375 Show the rollback status.
1377 selftestresult
1380 Query the self test results.
1382 i2c <i2caddr> <read bytes> [<write data>]
1385 This command may be used to execute raw I2C commands with the
1387 Master Write-Read IPMI command.
1388 ime
1390 help
1392 Print usage information
1394 info
1396 Displays information about the Manageability Engine (ME)
1398 update <file>
1400 Upgrade the ME firmware with the specified image file
1402 WARNING You MUST use a supported image provided by your
1403 board vendor
1404 rollback
1406 Perform manual rollback of the ME firmware
1408 isol
1411 info
1413 Retrieve information about the Intel IPMI v1.5
1415 Serial-Over-LAN configuration.
1416 set <parameter> <value>
1418 Configure parameters for Intel IPMI v1.5 Serial-over-LAN.
1420 Valid parameters and values are:
1422 enabled
1424 true, false.
1425 privilege-level
1427 user, operator, admin, oem.
1428 bit-rate
1430 9.6, 19.2, 38.4, 57.6, 115.2.
1431 activate
1433 Causes ipmitool to enter Intel IPMI v1.5 Serial Over LAN
1435 mode. An RMCP+ connection is made to the BMC, the termi‐
1436 nal is set to raw mode, and user input is sent to the
1437 serial console on the remote server. On exit, the SOL
1438 payload mode is deactivated and the terminal is reset to
1439 its original settings.
1440 Special escape sequences are provided to control the SOL
1442 session:
1443 ~. Terminate connection
1445 ~^Z Suspend ipmitool
1447 ~^X Suspend ipmitool, but don't restore tty
1449 on restart
1450 ~B Send break
1452 ~~ Send the escape character by typing it
1454 twice
1455 ~? Print the supported escape sequences
1457 Note that escapes are only recognized immediately after
1459 newline.
1460 kontronoem
1462 OEM commands specific to Kontron devices.
1464 setsn
1466 Set FRU serial number.
1468 setmfgdate
1470 Set FRU manufacturing date.
1472 nextboot <boot device>
1474 Select the next boot order on the Kontron CP6012.
1476 lan
1478 These commands will allow you to configure IPMI LAN channels
1480 with network information so they can be used with the ipmitool
1481 lan and lanplus interfaces. NOTE: To determine on which channel
1482 the LAN interface is located, issue the `channel info number'
1483 command until you come across a valid 802.3 LAN channel. For
1484 example:
1485 > ipmitool -I open channel info 1
1487 Channel 0x1 info:
1488 Channel Medium Type : 802.3 LAN
1489 Channel Protocol Type : IPMB-1.0
1490 Session Support : session-based
1491 Active Session Count : 8
1492 Protocol Vendor ID : 7154
1493 print [<channel>]
1496 Print the current configuration for the given chan‐
1498 nel. The default will print information on the first
1499 found LAN channel.
1500 set <channel number> <command> <parameter>
1502 Set the given command and parameter on the specified
1504 channel. Valid command/parameter options are:
1505 ipaddr <x.x.x.x>
1507 Set the IP address for this channel.
1509 netmask <x.x.x.x>
1511 Set the netmask for this channel.
1513 macaddr <xx:xx:xx:xx:xx:xx>
1515 Set the MAC address for this channel.
1517 defgw ipaddr <x.x.x.x>
1519 Set the default gateway IP address.
1521 defgw macaddr <xx:xx:xx:xx:xx:xx>
1523 Set the default gateway MAC address.
1525 bakgw ipaddr <x.x.x.x>
1527 Set the backup gateway IP address.
1529 bakgw macaddr <xx:xx:xx:xx:xx:xx>
1531 Set the backup gateway MAC address.
1533 password <pass>
1535 Set the null user password.
1537 snmp <community string>
1539 Set the SNMP community string.
1541 user
1543 Enable user access mode for userid 1 (issue the
1545 `user' command to display information about
1546 userids for a given channel).
1547 access <on|off>
1549 Set LAN channel access mode.
1551 alert <on|off>
1553 Enable or disable PEF alerting for this channel.
1555 ipsrc <source>
1557 Set the IP address source:
1559 none unspecified
1560 static manually configured static IP address
1561 dhcp address obtained by BMC running DHCP
1562 bios address loaded by BIOS or system software
1563 arp respond <on|off>
1565 Set BMC generated ARP responses.
1567 arp generate <on|off>
1569 Set BMC generated gratuitous ARPs.
1571 arp interval <seconds>
1573 Set BMC generated gratuitous ARP interval.
1575 vlan id <off|id>
1577 Disable VLAN operation or enable VLAN and set the
1579 ID.
1580 ID: value of the virtual lan identifier between 1
1581 and 4094 inclusive.
1582 vlan priority <priority>
1584 Set the priority associated with VLAN frames.
1586 ID: priority of the virtual lan frames between 0
1587 and 7 inclusive.
1588 auth <level,...> <type,...>
1590 Set the valid authtypes for a given auth
1592 level.
1593 Levels: callback, user, operator, admin
1594 Types: none, md2, md5, password, oem
1595 cipher_privs <privlist>
1597 Correlates cipher suite numbers with the maximum
1599 privilege level that is allowed to use it. In
1600 this way, cipher suites can restricted to users
1601 with a given privilege level, so that, for exam‐
1602 ple, administrators are required to use a stronger
1603 cipher suite than normal users.
1604 The format of privlist is as follows. Each char‐
1606 acter represents a privilege level and the charac‐
1607 ter position identifies the cipher suite number.
1608 For example, the first character represents cipher
1609 suite 0, the second represents cipher suite 1, and
1610 so on. privlist must be 15 characters in length.
1611 Characters used in privlist and their associated
1613 privilege levels are:
1614 X Cipher Suite Unused
1616 c CALLBACK
1617 u USER
1618 o OPERATOR
1619 a ADMIN
1620 O OEM
1621 So, to set the maximum privilege for cipher suite
1623 0 to USER and suite 1 to ADMIN, issue the follow‐
1624 ing command:
1625 > ipmitool -I interface lan set channel
1627 cipher_privs uaXXXXXXXXXXXXX
1628 alert print [<channel>] [<alert destination>]
1631 Print alert information for the specified channel and
1633 destination. The default will print all alerts for all
1634 alert destinations on the first found LAN channel.
1635 alert set <channel number> <alert destination> <command> <param‐
1638 eter>
1639 Set an alert on the given LAN channel and destination.
1641 Alert Destinations are listed via the 'lan alert print'
1642 command. Valid command/parameter options are:
1643 ipaddr <x.x.x.x>
1645 Set alert IP address.
1647 macaddr <xx:xx:xx:xx:xx:xx>
1649 Set alert MAC address.
1651 gateway <default | backup>
1653 Set the channel gateway to use for alerts.
1655 ack <on | off>
1657 Set Alert Acknowledge on or off.
1659 type <pet | oem1 | oem2>
1661 Set the destination type as PET or OEM.
1663 time <seconds>
1665 Set ack timeout or unack retry interval.
1667 retry <number>
1669 Set the number of alert retries.
1671 stats get [<channel number>]
1673 Retrieve information about the IP connections on the
1675 specified channel. The default will retrieve statistics
1676 on the first found LAN channel.
1677 stats clear [<channel number>]
1679 Clear all IP/UDP/RMCP Statistics to 0 on the specified
1681 channel. The default will clear statistics on the first
1682 found LAN channel.
1683 mc | bmc
1685 reset <warm|cold>
1687 Instructs the BMC to perform a warm or cold reset.
1689 guid
1691 Display the Management Controller Globally Unique IDenti‐
1693 fier.
1694 info
1696 Displays information about the BMC hardware, including
1698 device revision, firmware revision, IPMI version sup‐
1699 ported, manufacturer ID, and information on additional
1700 device support.
1701 watchdog
1703 These commands allow a user to view and change the cur‐
1705 rent state of the watchdog timer.
1706 get
1708 Show current Watchdog Timer settings and countdown
1710 state.
1711 reset
1713 Reset the Watchdog Timer to its most recent state
1715 and restart the countdown timer.
1716 off
1718 Turn off a currently running Watchdog countdown
1720 timer.
1721 selftest
1723 Check on the basic health of the BMC by executing the Get
1725 Self Test results command and report the results.
1726 getenables
1728 Displays a list of the currently enabled options for the
1730 BMC.
1731 setenables <option>=[on|off]
1733 Enables or disables the given option. This command is
1735 only supported over the system interface according to the
1736 IPMI specification. Currently supported values for
1737 option include:
1738 recv_msg_intr
1740 Receive Message Queue Interrupt
1742 event_msg_intr
1744 Event Message Buffer Full Interrupt
1746 event_msg
1748 Event Message Buffer
1750 system_event_log
1752 System Event Logging
1754 oem0
1756 OEM-Defined option #0
1758 oem1
1760 OEM-Defined option #1
1762 oem2
1764 OEM-Defined option #2
1766 getsysinfo <argument>
1769 Retrieves system info from bmc for given argument.
1770 See setsysinfo for argument definitions
1771 setsysinfo <argument> <string>
1773 Stores system info string to bmc for given argument
1774 Possible arguments are:
1776 primary_os_name Primary Operating System Name
1778 os_name Operating System Name
1780 system_name System Name of Server
1782 delloem_os_version Running version of operating
1784 system
1785 delloem_URL URL of BMC Webserver
1787 chassis
1789 status
1791 Displays information regarding the high-level sta‐
1793 tus of the system chassis and main power subsys‐
1794 tem.
1795 poh
1797 This command will return the Power-On Hours
1799 counter.
1800 identify <interval>
1802 Control the front panel identify light. Default
1804 interval is 15 seconds. Use 0 to turn off. Use
1805 "force" to turn on indefinitely.
1806 restart_cause
1808 Query the chassis for the cause of the last system
1810 restart.
1811 selftest
1813 Check on the basic health of the BMC by executing
1815 the Get Self Test results command and report the
1816 results.
1817 policy
1819 Set the chassis power policy in the event power
1821 failure.
1822 list
1824 Return supported policies.
1826 always-on
1828 Turn on when power is restored.
1830 previous
1832 Returned to previous state when power
1834 is restored.
1835 always-off
1837 Stay off after power is restored.
1839 power
1841 Performs a chassis control command to view and
1843 change the power state.
1844 status
1846 Show current chassis power status.
1848 on
1850 Power up chassis.
1852 off
1854 Power down chassis into soft off (S4/S5
1856 state). WARNING: This command does not
1857 initiate a clean shutdown of the operating
1858 system prior to powering down the system.
1859 cycle
1861 Provides a power off interval of at least 1
1863 second. No action should occur if chassis
1864 power is in S4/S5 state, but it is recom‐
1865 mended to check power state first and only
1866 issue a power cycle command if the system
1867 power is on or in lower sleep state than
1868 S4/S5.
1869 reset
1871 This command will perform a hard reset.
1873 diag
1875 Pulse a diagnostic interrupt (NMI) directly
1877 to the processor(s).
1878 soft
1880 Initiate a soft-shutdown of OS via ACPI.
1882 This can be done in a number of ways, com‐
1883 monly by simulating an overtemperture or by
1884 simulating a power button press. It is
1885 necessary for there to be Operating System
1886 support for ACPI and some sort of daemon
1887 watching for events for this soft power to
1888 work.
1889 bootdev <device> [<clear-cmos=yes|no>]
1891 [<options=help,...>]
1892 Request the system to boot from an alternate boot
1894 device on next reboot. The clear-cmos option, if
1895 supplied, will instruct the BIOS to clear its CMOS
1896 on the next reboot. Various options may be used
1897 to modify the boot device settings. Run "bootdev
1898 none options=help" for a list of available boot
1899 device modifiers/options.
1900 Currently supported values for <device> are:
1903 none
1905 Do not change boot device
1907 pxe
1909 Force PXE boot
1911 disk
1913 Force boot from BIOS default boot device
1915 safe
1917 Force boot from BIOS default boot device,
1919 request Safe Mode
1920 diag
1922 Force boot from diagnostic partition
1924 cdrom
1926 Force boot from CD/DVD
1928 bios
1930 Force boot into BIOS setup
1932 floppy
1934 Force boot from Floppy/primary removable
1936 media
1937 bootparam
1939 Get or set various system boot option parameters.
1941 get <param #>
1943 Get boot parameter. Currently supported
1945 values for <param #> are:
1946 0 - Set In Progress
1948 1 - Service Partition Selector
1950 2 - Service Partition Scan
1952 3 - BMC Boot Flag Valid Bit Clearing
1954 4 - Boot Info Acknowledge
1956 5 - Boot Flags
1958 6 - Boot Initiator Info
1960 7 - Boot Initiator Mailbox
1962 set <device> [<options=help,...>]
1965 Set boot device parameter used for next
1967 boot. Various options may be used to
1968 change when the the next boot device is
1969 cleared. Run "options=help" for a list of
1970 available bootparam set device options.
1971 Currently supported bootparam device set‐
1974 tings are:
1975 force_pxe
1977 Force PXE boot
1979 force_disk
1981 Force boot from default hard-drive
1983 force_safe
1985 Force boot from default hard-drive,
1987 request Safe Mode
1988 force_diag
1990 Force boot from diagnostic partition
1992 force_cdrom
1994 Force boot from CD/DVD
1996 force_bios
1998 Force boot into BIOS setup
2000 Currently supported bootparam options set‐
2003 tings are associated with BMC Boot Valid
2004 Bit Clearing and are as follows: Any
2005 option can be prefixed with "no-" to invert
2006 the sense of the operation.
2007 PEF
2009 Clear valid bit on reset/power cycle
2011 caused by PEF
2012 timeout
2014 Automatically clear boot flag valid
2016 bit if Chassis Control command is
2017 not received within 60 seconds.
2018 watchdog
2020 Clear valid bit on reset/power cycle
2022 caused by watchdog timeout
2023 reset
2025 Clear valid bit on push button reset
2027 / soft-reset
2028 power
2030 Clear valid bit on power up via
2032 power push button or wake event
2033 pef
2036 info
2038 This command will query the BMC and print information
2040 about the PEF supported features.
2041 status
2043 This command prints the current PEF status (the last SEL
2045 entry processed by the BMC, etc).
2046 policy
2048 This command lists the PEF policy table entries. Each
2050 policy entry describes an alert destination. A policy
2051 set is a collection of table entries. PEF alert actions
2052 reference policy sets.
2053 list
2055 This command lists the PEF table entries. Each PEF entry
2057 relates a sensor event to an action. When PEF is active,
2058 each platform event causes the BMC to scan this table for
2059 entries matching the event, and possible actions to be
2060 taken. Actions are performed in priority order (higher
2061 criticality first).
2062 picmg <properties>
2064 Run a PICMG/ATA extended command. Get PICMG properties may be
2066 used to obtain and print Extension major version information,
2067 PICMG identifier, FRU Device ID and Max FRU Device ID.
2068 addrinfo
2070 Get address information. This command may return infor‐
2072 mation on the Hardware address, IPMB-0 Address, FRU ID,
2073 Site/Entity ID, and Site/Entity Type.
2074 frucontrol <fru id> <options>
2076 Set various control options:
2078 0x00 - Cold Reset
2080 0x01 - Warm Reset
2082 0x02 - Graceful Reboot
2084 0x03 - Issue Diagnostic Interrupt
2086 0x04 - Quiesce [AMC only]
2088 0x05-0xFF - Cold Reset
2090 activate <fru id>
2092 Activate the specified FRU.
2094 deactivate <fru id>
2096 Deactivate the specified FRU.
2098 policy get <fru id>
2100 Get FRU activation policy.
2102 policy set <fru id> <lockmask> <lock>
2104 Set FRU activation policy. lockmask is 1 or 0 to indi‐
2106 cate action on the deactivation or activation locked bit
2107 respectively. lock is 1 or 0 to set/clear locked bit.
2108 portstate set|getall|getgranted|getdenied <parameters>
2110 Get or set various port states. See usage for parameter
2111 details.
2112 power <chassis power command>
2114 Shortcut to the chassis power commands. See the chassis power
2116 commands for usage information.
2117 raw <netfn> <cmd> [<data>]
2119 This will allow you to execute raw IPMI commands. For example
2121 to query the POH counter with a raw command:
2122 > ipmitool -v raw 0x0 0xf
2124 RAW REQ (netfn=0x0 cmd=0xf data_len=0)
2125 RAW RSP (5 bytes)
2126 3c 72 0c 00 00
2127 Note that the OpenIPMI driver provided by the Linux kernel will
2129 reject the Get Message, Send Message and Read Event Message Buf‐
2130 fer commands because it handles the message sequencing inter‐
2131 nally.
2132 sdr
2134 get <id> ... [<id>]
2136 Prints information for sensor data records specified by
2138 sensor id.
2139 info
2141 This command will query the BMC for Sensor Data Record
2143 (SDR) Repository information.
2144 type [<sensor type>]
2146 This command will display all records from the SDR Repos‐
2148 itory of a specific type. Run with type list (or simply
2149 with no type) to see the list of available types. For
2150 example to query for all Temperature sensors:
2151 > ipmitool sdr type Temperature
2153 Baseboard Temp | 30h | ok | 7.1 | 28 degrees C
2154 FntPnl Amb Temp | 32h | ok | 12.1 | 24 degrees C
2155 Processor1 Temp | 98h | ok | 3.1 | 57 degrees C
2156 Processor2 Temp | 99h | ok | 3.2 | 53 degrees C
2157 list | elist [<all|full|compact|event|mcloc|fru|generic>]
2160 This command will read the Sensor Data Records (SDR) and
2162 extract sensor information of a given type, then query
2163 each sensor and print its name, reading, and status. If
2164 invoked as elist then it will also print sensor number,
2165 entity id and instance, and asserted discrete states.
2166 The default output will only display full and compact
2168 sensor types, to see all sensors use the all type with
2169 this command.
2170 Valid types are:
2172 all
2174 All SDR records (Sensor and Locator)
2176 full
2178 Full Sensor Record
2180 compact
2182 Compact Sensor Record
2184 event
2186 Event-Only Sensor Record
2188 mcloc
2190 Management Controller Locator Record
2192 fru
2194 FRU Locator Record
2196 generic
2198 Generic SDR records
2200 entity <id>[.<instance>]
2202 Displays all sensors associated with an entity. Get a
2204 list of valid entity ids on the target system by issuing
2205 the sdr elist command. A list of all entity ids can be
2206 found in the IPMI specifications.
2207 dump <file>
2209 Dumps raw SDR data to a file. This data file can then be
2211 used as a local SDR cache of the remote managed system
2212 with the -S <file> option on the ipmitool command line.
2213 This can greatly improve performance over system inter‐
2214 face or remote LAN.
2215 fill sensors
2217 Create the SDR Repository for the current configuration.
2219 Will perform a 'Clear SDR Repository' command so be care‐
2220 ful.
2221 fill file <filename>
2223 Fill the SDR Repository using records stored in a binary
2225 data file. Will perform a 'Clear SDR Repository' command
2226 so be careful.
2227 sel
2229 NOTE: System Event Log (SEL) entry-times are displayed as
2231 `Pre-Init Time-stamp' if the SEL clock needs to be set. Ensure
2232 that the SEL clock is accurate by invoking the sel time get and
2233 sel time set <time string> commands.
2234 info
2236 This command will query the BMC for information about the
2238 System Event Log (SEL) and its contents.
2239 clear
2241 This command will clear the contents of the SEL. It can‐
2243 not be undone so be careful.
2244 list | elist
2246 When this command is invoked without arguments, the
2248 entire contents of the System Event Log are displayed.
2249 If invoked as elist (extended list) it will also use the
2250 Sensor Data Record entries to display the sensor ID for
2251 the sensor that caused each event. Note this can take a
2252 long time over the system interface.
2253 <count> | first <count>
2256 Displays the first count (least-recent) entries in
2258 the SEL. If count is zero, all entries are dis‐
2259 played.
2260 last <count>
2262 Displays the last count (most-recent) entries in
2264 the SEL. If count is zero, all entries are dis‐
2265 played.
2266 delete <SEL Record ID> ... <SEL Record ID>
2268 Delete one or more SEL event records.
2270 add <filename ID>
2272 Read event entries from a file and add them to the SEL.
2274 New SEL entries area added onto the SEL after the last
2275 record in the SEL. Record added is of type 2 and is
2276 automatically timestamped.
2277 get <SEL Record ID>
2279 Print information on the specified SEL Record entry.
2281 save <file>
2283 Save SEL records to a text file that can be fed back into
2285 the event file ipmitool command. This can be useful for
2286 testing Event generation by building an appropriate Plat‐
2287 form Event Message file based on existing events. Please
2288 see the available help for the 'event file ...' command
2289 for a description of the format of this file.
2290 writeraw <file>
2292 Save SEL records to a file in raw, binary format. This
2294 file can be fed back to the sel readraw ipmitool command
2295 for viewing.
2296 readraw <file>
2298 Read and display SEL records from a binary file. Such a
2300 file can be created using the sel writeraw ipmitool com‐
2301 mand.
2302 time
2304 get
2306 Displays the SEL clock's current time.
2307 set <time string>
2309 Sets the SEL clock. Future SEL entries will use
2311 the time set by this command. <time string> is of
2312 the form "MM/DD/YYYY HH:MM:SS". Note that hours
2313 are in 24-hour form. It is recommended that the
2314 SEL be cleared before setting the time.
2315 sensor
2317 list
2319 Lists sensors and thresholds in a wide table format.
2321 get <id> ... [<id>]
2323 Prints information for sensors specified by name.
2325 thresh <id> <threshold> <setting>
2327 This allows you to set a particular sensor threshold
2329 value. The sensor is specified by name.
2330 Valid thresholds are:
2332 unr Upper Non-Recoverable
2333 ucr Upper Critical
2334 unc Upper Non-Critical
2335 lnc Lower Non-Critical
2336 lcr Lower Critical
2337 lnr Lower Non-Recoverable
2338 thresh <id> lower <lnr> <lcr> <lnc>
2340 This allows you to set all lower thresholds for a sensor
2342 at the same time. The sensor is specified by name and
2343 the thresholds are listed in order of Lower Non-Recover‐
2344 able, Lower Critical, and Lower Non-Critical.
2345 thresh <id> upper <unc> <ucr> <unr>
2347 This allows you to set all upper thresholds for a sensor
2349 at the same time. The sensor is specified by name and
2350 the thresholds are listed in order of Upper Non-Critical,
2351 Upper Critical, and Upper Non-Recoverable.
2352 session
2354 info <active|all|id 0xnnnnnnnn|handle 0xnn>
2356 Get information about the specified session(s). You may
2358 identify sessions by their id, by their handle number, by
2359 their active status, or by using the keyword `all' to
2360 specify all sessions.
2361 set
2363 hostname <host>
2365 Session hostname.
2367 username <user>
2369 Session username.
2371 password <pass>
2373 Session password.
2375 privlvl <level>
2377 Session privilege level force.
2379 authtype <type>
2381 Authentication type force.
2383 localaddr <addr>
2385 Local IPMB address.
2387 targetaddr <addr>
2389 Remote target IPMB address.
2391 port <port>
2393 Remote RMCP port.
2395 csv [level]
2397 Enable output in comma separated format. Affects follow‐
2399 ing commands: user, channel, isol, sunoem, sol, sensor,
2400 sdr, sel, session.
2401 verbose [verbose]
2403 Verbosity level.
2405 shell
2407 This command will launch an interactive shell which you can use
2408 to send multiple ipmitool commands to a BMC and see the
2409 responses. This can be useful instead of running the full ipmi‐
2410 tool command each time. Some commands will make use of a Sensor
2411 Data Record cache and you will see marked improvement in speed
2412 if these commands are able to reuse the same cache in a shell
2413 session. LAN sessions will send a periodic keepalive command to
2414 keep the IPMI session from timing out.
2415 sol
2417 info [<channel number>]
2419 Retrieve information about the Serial-Over-LAN configura‐
2421 tion on the specified channel. If no channel is given,
2422 it will display SOL configuration data for the currently
2423 used channel.
2424 payload <enable | disable | status> <channel number> <userid>
2426 Enable, disable or show status of SOL payload for the
2428 user on the specified channel.
2429 set <parameter> <value> [<channel>]
2431 Configure parameters for Serial Over Lan. If no channel
2433 is given, it will display SOL configuration data for the
2434 currently used channel. Configuration parameter updates
2435 are automatically guarded with the updates to the
2436 set-in-progress parameter.
2437 Valid parameters and values are:
2439 set-in-progress
2441 set-complete set-in-progress commit-write
2442 enabled
2444 true false
2445 force-encryption
2447 true false
2448 force-authentication
2450 true false
2451 privilege-level
2453 user operator admin oem
2454 character-accumulate-level
2456 Decimal number given in 5 milliseconds increments
2457 character-send-threshold
2459 Decimal number
2460 retry-count
2462 Decimal number. 0 indicates no retries after
2463 packet is transmitted.
2464 retry-interval
2466 Decimal number in 10 millisecond increments. 0
2467 indicates that retries should be sent back to
2468 back.
2469 non-volatile-bit-rate
2471 serial, 19.2, 38.4, 57.6, 115.2. Setting this
2472 value to serial indicates that the BMC should use
2473 the setting used by the IPMI over serial channel.
2474 volatile-bit-rate
2476 serial, 19.2, 38.4, 57.6, 115.2. Setting this
2477 value to serial indicates that the BMC should use
2478 the setting used by the IPMI over serial channel.
2479 activate [usesolkeepalive | nokeepalive] [instance=<number>]
2481 Causes ipmitool to enter Serial Over LAN mode, and is
2483 only available when using the lanplus interface. An
2484 RMCP+ connection is made to the BMC, the terminal is set
2485 to raw mode, and user input is sent to the serial console
2486 on the remote server. On exit, the the SOL payload mode
2487 is deactivated and the terminal is reset to its original
2488 settings.
2489 If the instance is given, it will activate using the
2491 given instance number. The default is 1.
2492 Special escape sequences are provided to control the SOL
2494 session:
2495 ~. Terminate connection
2497 ~^Z Suspend ipmitool
2499 ~^X Suspend ipmitool, but don't restore tty on
2501 restart
2502 ~B Send break
2504 ~~ Send the escape character by typing it twice
2506 ~? Print the supported escape sequences
2508 Note that escapes are only recognized immediately after
2510 newline.
2511 deactivate [instance=<number>]
2513 Deactivates Serial Over LAN mode on the BMC. Exiting
2515 Serial Over LAN mode should automatically cause this com‐
2516 mand to be sent to the BMC, but in the case of an unin‐
2517 tentional exit from SOL mode, this command may be neces‐
2518 sary to reset the state of the BMC.
2519 If the instance is given, it will deactivate the given
2521 instance number. The default is 1.
2522 spd <i2cbus> <i2caddr> [<channel>] [<axread>]
2524 This command may be used to read SPD (Serial Presence Detect)
2526 data using the I2C Master Write-Read IPMI command.
2527 sunoem
2530 cli [<command string> ...]
2532 Execute the service processor command line interface com‐
2534 mands. Without any command string, an interactive ses‐
2535 sion is started in the service processor command line
2536 environ ment. If a command string is specified, the com‐
2537 mand string is executed on the service processor and the
2538 connection is closed.
2539 led
2541 These commands provide a way to get and set the status of
2543 LEDs on a Sun Microsystems server. Use 'sdr list
2544 generic' to get a list of devices that are controllable
2545 LEDs. The ledtype parameter is optional and not neces‐
2546 sary to provide on the command line unless it is required
2547 by hardware.
2548 get <sensorid> [<ledtype>]
2550 Get status of a particular LED described by a
2552 Generic Device Locator record in the SDR. A sen‐
2553 sorid of all will get the status of all available
2554 LEDS.
2555 set <sensorid> <ledmode> [<ledtype>]
2557 Set status of a particular LED described by a
2559 Generic Device Locator record in the SDR. A sen‐
2560 sorid of all will set the status of all available
2561 LEDS to the specified ledmode and ledtype.
2562 LED Mode is required for set operations:
2564 OFF Off
2565 ON Steady On
2566 STANDBY 100ms on 2900ms off blink rate
2567 SLOW 1HZ blink rate
2568 FAST 4HZ blink rate
2569 LED Type is optional:
2571 OK2RM Ok to Remove
2572 SERVICE Service Required
2573 ACT Activity
2574 LOCATE Locate
2575 nacname <ipmi name>
2578 Return the full NAC name of a target identified by ipmi
2580 name.
2581 ping <count> [<q>]
2583 Send and receive count packets. Each packet is 64 bytes.
2585 q - Quiet. Displays output only at the start and end of
2587 the process.
2588 getval <property name>
2590 Returns value of specified ILOM property.
2592 setval <property name> <property value> [<timeout>]
2594 Sets value of ILOM property. If timeout is not speci‐
2596 fied, the default value is 5 seconds. NOTE: setval must
2597 be executed locally on host!
2598 sshkey
2600 set <userid> <keyfile>
2602 This command will allow you to specify an SSH key
2604 to use for a particular user on the Service Pro‐
2605 cessor. This key will be used for CLI logins to
2606 the SP and not for IPMI sessions. View available
2607 users and their userids with the 'user list' com‐
2608 mand.
2609 del <userid>
2611 This command will delete the SSH key for a speci‐
2613 fied userid.
2614 version
2616 Display the version of ILOM firmware.
2618 getfile <file identifier> <destination file name>
2620 This command will return various files from service pro‐
2622 cessor and store them in specified destination file. Note
2623 that some files may not be present or be supported by
2624 your SP.
2625 File identifiers:
2627 SSH_PUBKEYS
2628 DIAG_PASSED
2629 DIAG_FAILED
2630 DIAG_END_TIME
2631 DIAG_INVENTORY
2632 DIAG_TEST_LOG
2633 DIAG_START_TIME
2634 DIAG_UEFI_LOG
2635 DIAG_TEST_LOG
2636 DIAG_LAST_LOG
2637 DIAG_LAST_CMD
2638 getbehavior <feature identifier>
2641 This command will test if various ILOM features are
2643 enabled.
2644 Feature identifiers:
2646 SUPPORTS_SIGNED_PACKAGES
2647 REQUIRES_SIGNED_PACKAGES
2648 tsol
2650 This command allows Serial-over-LAN sessions to be established
2652 with Tyan IPMIv1.5 SMDC such as the M3289 or M3290. The default
2653 command run with no arguments will establish default SOL session
2654 back to local IP address. Optional arguments may be supplied in
2655 any order.
2656 <ipaddr>
2659 Send receiver IP address to SMDC which it will use to
2661 send serial traffic to. By default this detects the
2662 local IP address and establishes two-way session. Format
2663 of ipaddr is XX.XX.XX.XX
2664 port=NUM
2667 Configure UDP port to receive serial traffic on. By
2669 default this is 6230.
2670 ro|rw
2673 Confiure SOL session as read-only or read-write. Ses‐
2675 sions are read-write by default.
2676 user
2680 summary
2682 Displays a summary of userid information, including maxi‐
2684 mum number of userids, the number of enabled users, and
2685 the number of fixed names defined.
2686 list
2688 Displays a list of user information for all defined
2690 userids.
2691 set
2693 name <userid> <username>
2695 Sets the username associated with the given
2697 userid.
2698 password <userid> [<password>]
2700 Sets the password for the given userid. If no
2702 password is given, the password is cleared (set to
2703 the NULL password). Be careful when removing
2704 passwords from administrator-level accounts.
2705 disable <userid>
2707 Disables access to the BMC by the given userid.
2709 enable <userid>
2711 Enables access to the BMC by the given userid.
2713 priv <userid> <privilege level> [<channel number>]
2715 Set user privilege level on the specified channel. If
2717 the channel is not specified, the current channel will be
2718 used.
2719 test <userid> <16|20> [<password>]
2721 Determine whether a password has been stored as 16 or 20
2723 bytes.
2724
2727 The ipmitool open interface utilizes the OpenIPMI kernel device driver.
2728 This driver is present in all modern 2.4 and all 2.6 kernels and it
2729 should be present in recent Linux distribution kernels. There are also
2730 IPMI driver kernel patches for different kernel versions available from
2731 the OpenIPMI homepage.
2732 The required kernel modules is different for 2.4 and 2.6 kernels. The
2734 following kernel modules must be loaded on a 2.4-based kernel in order
2735 for ipmitool to work:
2736 ipmi_msghandler
2738 Incoming and outgoing message handler for IPMI interfaces.
2739 ipmi_kcs_drv
2741 An IPMI Keyboard Controler Style (KCS) interface driver for the
2742 message handler.
2743 ipmi_devintf
2745 Linux character device interface for the message handler.
2746 The following kernel modules must be loaded on a 2.6-based kernel in
2748 order for ipmitool to work:
2749 ipmi_msghandler
2751 Incoming and outgoing message handler for IPMI interfaces.
2752 ipmi_si
2754 An IPMI system interface driver for the message handler. This
2755 module supports various IPMI system interfaces such as KCS, BT,
2756 SMIC, and even SMBus in 2.6 kernels.
2757 ipmi_devintf
2759 Linux character device interface for the message handler.
2760 Once the required modules are loaded there will be a dynamic character
2762 device entry that must exist at /dev/ipmi0. For systems that use devfs
2763 or udev this will appear at /dev/ipmi/0.
2764 To create the device node first determine what dynamic major number it
2766 was assigned by the kernel by looking in /proc/devices and checking for
2767 the ipmidev entry. Usually if this is the first dynamic device it will
2768 be major number 254 and the minor number for the first system interface
2769 is 0 so you would create the device entry with:
2770 mknod /dev/ipmi0 c 254 0
2772 ipmitool includes some sample initialization scripts that can perform
2774 this task automatically at start-up.
2775 In order to have ipmitool use the OpenIPMI device interface you can
2777 specifiy it on the command line:
2778 ipmitool -I open <command>
2780
2782 The ipmitool bmc interface utilizes the bmc device driver as provided
2783 by Solaris 10 and higher. In order to force ipmitool to make use of
2784 this interface you can specify it on the command line:
2785 ipmitool -I bmc <command>
2787 The following files are associated with the bmc driver:
2789 /platform/i86pc/kernel/drv/bmc
2792 32-bit ELF kernel module for the bmc driver.
2793 /platform/i86pc/kernel/drv/amd64/bmc
2795 64-bit ELF kernel module for the bmc driver.
2796 /dev/bmc
2798 Character device node used to communicate with the bmc driver.
2799
2801 The ipmitool lipmi interface uses the Solaris 9 IPMI kernel device
2802 driver. It has been superceeded by the bmc interface on Solaris 10.
2803 You can tell ipmitool to use this interface by specifying it on the
2804 command line.
2805 ipmitool -I lipmi <expression>
2807
2809 The ipmitool lan interface communicates with the BMC over an Ethernet
2810 LAN connection using UDP under IPv4. UDP datagrams are formatted to
2811 contain IPMI request/response messages with a IPMI session headers and
2812 RMCP headers.
2813 IPMI-over-LAN uses version 1 of the Remote Management Control Protocol
2815 (RMCP) to support pre-OS and OS-absent management. RMCP is a
2816 request-response protocol delivered using UDP datagrams to port 623.
2817 The LAN interface is an authentication multi-session connection; mes‐
2819 sages delivered to the BMC can (and should) be authenticated with a
2820 challenge/response protocol with either straight password/key or MD5
2821 message-digest algorithm. ipmitool will attempt to connect with admin‐
2822 istrator privilege level as this is required to perform chassis power
2823 functions.
2824 You can tell ipmitool to use the lan interface with the -I lan option:
2826 ipmitool -I lan -H <hostname> [-U <username>] [-P <password>] <command>
2829 A hostname must be given on the command line in order to use the lan
2831 interface with ipmitool. The password field is optional; if you do not
2832 provide a password on the command line, ipmitool will attempt to con‐
2833 nect without authentication. If you specify a password it will use MD5
2834 authentication if supported by the BMC and straight password/key other‐
2835 wise, unless overridden with a command line option.
2836
2838 Like the lan interface, the lanplus interface communicates with the BMC
2839 over an Ethernet LAN connection using UDP under IPv4. The difference
2840 is that the lanplus interface uses the RMCP+ protocol as described in
2841 the IPMI v2.0 specification. RMCP+ allows for improved authentication
2842 and data integrity checks, as well as encryption and the ability to
2843 carry multiple types of payloads. Generic Serial Over LAN support
2844 requires RMCP+, so the ipmitool sol activate command requires the use
2845 of the lanplus interface.
2846 RMCP+ session establishment uses a symmetric challenge-response proto‐
2848 col called RAKP (Remote Authenticated Key-Exchange Protocol) which
2849 allows the negotiation of many options. ipmitool does not yet allow
2850 the user to specify the value of every option, defaulting to the most
2851 obvious settings marked as required in the v2.0 specification. Authen‐
2852 tication and integrity HMACS are produced with SHA1, and encryption is
2853 performed with AES-CBC-128. Role-level logins are not yet supported.
2854 ipmitool must be linked with the OpenSSL library in order to perform
2856 the encryption functions and support the lanplus interface. If the
2857 required packages are not found it will not be compiled in and sup‐
2858 ported.
2859 You can tell ipmitool to use the lanplus interface with the -I lanplus
2861 option:
2862 ipmitool -I lanplus -H <hostname> [-U <username>] [-P <password>] <com‐
2865 mand>
2866 A hostname must be given on the command line in order to use the lan
2868 interface with ipmitool. With the exception of the -A and -C options
2869 the rest of the command line options are identical to those available
2870 for the lan interface.
2871 The -C option allows you specify the authentication, integrity, and
2873 encryption algorithms to use for for lanplus session based on the
2874 cipher suite ID found in the IPMIv2.0 specification in table 22-19.
2875 The default cipher suite is 3 which specifies RAKP-HMAC-SHA1 authenti‐
2876 cation, HMAC-SHA1-96 integrity, and AES-CBC-128 encryption algorightms.
2877
2880 The ipmitool free interface utilizes the FreeIPMI libfreeipmi drivers.
2881 You can tell ipmitool to use the FreeIPMI interface with the -I option:
2883 ipmitool -I free <command>
2885
2889 The ipmitool imb interface supports the Intel IMB (Intel Inter-module
2890 Bus) Interface through the /dev/imb device.
2891 You can tell ipmitool to use the IMB interface with the -I option:
2893 ipmitool -I imb <command>
2895
2898 Example 1: Listing remote sensors
2899 > ipmitool -I lan -H 1.2.3.4 -f passfile sdr list
2901 Baseboard 1.25V | 1.24 Volts | ok
2902 Baseboard 2.5V | 2.49 Volts | ok
2903 Baseboard 3.3V | 3.32 Volts | ok
2904 Example 2: Displaying status of a remote sensor
2906 > ipmitool -I lan -H 1.2.3.4 -f passfile sensor get "Baseboard
2908 1.25V"
2909 Locating sensor record...
2910 Sensor ID : Baseboard 1.25V (0x10)
2911 Sensor Type (Analog) : Voltage
2912 Sensor Reading : 1.245 (+/- 0.039) Volts
2913 Status : ok
2914 Lower Non-Recoverable : na
2915 Lower Critical : 1.078
2916 Lower Non-Critical : 1.107
2917 Upper Non-Critical : 1.382
2918 Upper Critical : 1.431
2919 Upper Non-Recoverable : na
2920 Example 3: Displaying the power status of a remote chassis
2922 > ipmitool -I lan -H 1.2.3.4 -f passfile chassis power status
2924 Chassis Power is on
2925 Example 4: Controlling the power on a remote chassis
2927 > ipmitool -I lan -H 1.2.3.4 -f passfile chassis power on
2929 Chassis Power Control: Up/On
2930
2932 Duncan Laurie <duncan@iceblink.org>
2933
2935 IPMItool Homepage
2936 http://ipmitool.sourceforge.net
2937 Intelligent Platform Management Interface Specification
2939 http://www.intel.com/design/servers/ipmi
2940 OpenIPMI Homepage
2942 http://openipmi.sourceforge.net
2943 FreeIPMI Homepage
2945 http://www.gnu.org/software/freeipmi/
2946Duncan Laurie ipmitool(1)