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
14 or it's usage postponed until shell or exec processes relevant command.
15 <general-options> := [ -h | -V | -v | -I <interface> | -H <address> |
17 -d <N> | -p <port> | -c | -U <username> |
18 -L <privlvl> | -l <lun> | -m <local_address> |
19 -N <sec> | -R <count> | <password-option> |
20 <oem-option> | <bridge-options> ]
21 <conditional-opts> := [ <lan-options> | <lanplus-options> |
23 <command-options> ]
24 Bridging:
25 <bridge-options> := -t <target_address> [ -b <channel> |
26 [ -T <address> | -B <channel> ] ]
27 Options used with -I lan:
29 <lan-options> := [ -A <authtype> ]
30 Options used with -I lanplus:
32 <lanplus-options> := [ -C <ciphersuite> | <key-option> ]
33 Option groups setting same value:
35 <key-option> := [ -k <key> | -K | -y <hex_key> | -Y ]
36 <password-option> := [ -f <password_file> | -a | -P <password> | -E ]
37 <oem-option> := [ -o <oemtype> | -g | -s ]
38 Options used with specific command <command-options>:
40 <options-sdr> := [ -S <sdr_cache_file> ]
41 <options-sel> := [ -O <sel_oem> ]
42 <options-sol> := [ -e <sol_escape_char> ]
43
47 This program lets you manage Intelligent Platform Management Interface
48 (IPMI) functions of either the local system, via a kernel device
49 driver, or a remote system, using IPMI v1.5 and IPMI v2.0. These func‐
50 tions include printing FRU information, LAN configuration, sensor read‐
51 ings, and remote chassis power control.
52 IPMI management of a local system interface requires a compatible IPMI
54 kernel driver to be installed and configured. On Linux this driver is
55 called OpenIPMI and it is included in standard distributions. On So‐
56 laris this driver is called BMC and is included in Solaris 10. Manage‐
57 ment of a remote station requires the IPMI-over-LAN interface to be en‐
58 abled and configured. Depending on the particular requirements of each
59 system it may be possible to enable the LAN interface using ipmitool
60 over the system interface.
61
63 -a Prompt for the remote server password.
64 -A <authtype>
66 Specify an authentication type to use during IPMIv1.5 lan ses‐
67 sion activation. Supported types are NONE, PASSWORD, MD2, MD5,
68 or OEM.
69 -b <channel>
71 Set destination channel for bridged request.
72 -B <channel>
74 Set transit channel for bridged request (dual bridge).
75 -b <channel>
77 Set destination channel for bridged request.
78 -B <channel>
80 Set transit channel for bridged request. (dual bridge)
81 -c Present output in CSV (comma separated variable) format. This
83 is not available with all commands.
84 -C <ciphersuite>
86 The remote server authentication, integrity, and encryption al‐
87 gorithms to use for IPMIv2.0 lanplus connections. See table
88 22-20 in the IPMI v2.0 specification. The default is 17 which
89 specifies RAKP-HMAC-SHA256 authentication, HMAC-SHA256-128 in‐
90 tegrity, and AES-CBC-128 encryption algorithms.
91 NOTE: In ipmitool 1.8.18 and earlier the default was 3, which
93 was insecure and was not supported by some more recent BMC im‐
94 plementations.
95 -d N Use device number N to specify the /dev/ipmiN (or /dev/ipmi/N or
97 /dev/ipmidev/N) device to use for in-band BMC communication.
98 Used to target a specific BMC on a multi-node, multi-BMC system
99 through the ipmi device driver interface. Default is 0.
100 -e <sol_escape_char>
102 Use supplied character for SOL session escape character. The
103 default is to use ~ but this can conflict with ssh sessions.
104 -E The remote server password is specified by the environment vari‐
106 able IPMI_PASSWORD or IPMITOOL_PASSWORD. The IPMITOOL_PASSWORD
107 takes precedence.
108 -f <password_file>
110 Specifies a file containing the remote server password. If this
111 option is absent, or if password_file is empty, the password
112 will default to NULL.
113 -g Deprecated. Use: -o intelplus
115 -h Get basic usage help from the command line.
117 -H <address>
119 Remote server address, can be IP address or hostname. This op‐
120 tion is required for lan and lanplus interfaces.
121 -I <interface>
123 Selects IPMI interface to use. Supported interfaces that are
124 compiled in are visible in the usage help output.
125 -k <key>
127 Use supplied Kg key for IPMIv2.0 authentication. The default is
128 not to use any Kg key.
129 -K Read Kg key from IPMI_KGKEY environment variable.
131 -l <lun>
133 Set destination lun for raw commands.
134 -L <privlvl>
136 Force session privilege level. Can be CALLBACK, USER, OPERATOR,
137 ADMINISTRATOR. Default is ADMINISTRATOR. This value is ignored
138 and always set to ADMINISTRATOR when combined with -t target ad‐
139 dress.
140 -m <local_address>
142 Set the local IPMB address. The local address defaults to 0x20
143 or is auto discovered on PICMG platforms when -m is not speci‐
144 fied. There should be no need to change the local address for
145 normal operation.
146 -N <sec>
148 Specify nr. of seconds between retransmissions of lan/lanplus
149 messages. Defaults are 2 seconds for lan and 1 second for lan‐
150 plus interfaces. Command raw uses fixed value of 15 seconds.
151 Command sol uses fixed value of 1 second.
152 -o <oemtype>
154 Select OEM type to support. This usually involves minor hacks
155 in place in the code to work around quirks in various BMCs from
156 various manufacturers. Use -o list to see a list of current
157 supported OEM types.
158 -O <sel oem>
160 Open selected file and read OEM SEL event descriptions to be
161 used during SEL listings. See examples in contrib dir for file
162 format.
163 -p <port>
165 Remote server UDP port to connect to. Default is 623.
166 -P <password>
168 Remote server password is specified on the command line. If
169 supported it will be obscured in the process list. Note! Speci‐
170 fying the password as a command line option is not recommended.
171 -R <count>
173 Set the number of retries for lan/lanplus interface (default=4).
174 Command raw uses fixed value of one try (no retries). Command
175 hpm uses fixed value of 10 retries.
176 -s Deprecated. Use: -o supermicro
178 -S <sdr_cache_file>
180 Use local file for remote SDR cache. Using a local SDR cache
181 can drastically increase performance for commands that require
182 knowledge of the entire SDR to perform their function. Local
183 SDR cache from a remote system can be created with the sdr dump
184 command.
185 -t <target_address>
187 Bridge IPMI requests to the remote target address. Default is
188 32. The -L privlvl option is always ignored and value set to
189 ADMINISTRATOR.
190 -T <address>
192 Set transit address for bridge request (dual bridge).
193 -T <transmit_address>
195 Set transit address for bridge request. (dual bridge)
196 -U <username>
198 Remote server username, default is NULL user.
199 -v Increase verbose output level. This option may be specified
201 multiple times to increase the level of debug output. If given
202 three times you will get hexdumps of all incoming and outgoing
203 packets. Using it five times provides details on request and ex‐
204 pected reply processing. The hpm commands targetcap compprop
205 abort upgstatus rollback rollbackstatus selftestresult increases
206 the verbosity level
207 -V Display version information.
209 -y <hex key>
211 Use supplied Kg key for IPMIv2.0 authentication. The key is ex‐
212 pected in hexadecimal format and can be used to specify keys
213 with non-printable characters. E.g. '-k PASSWORD' and '-y
214 50415353574F5244' are equivalent. The default is not to use any
215 Kg key.
216 -Y Prompt for the Kg key for IPMIv2.0 authentication.
218 -z <size>
220 Change Size of Communication Channel. (OEM)
221 If no password method is specified then ipmitool will prompt the user
224 for a password. If no password is entered at the prompt, the remote
225 server password will default to NULL.
226
228 There are several security issues be be considered before enabling the
229 IPMI LAN interface. A remote station has the ability to control a sys‐
230 tem's power state as well as being able to gather certain platform in‐
231 formation. To reduce vulnerability it is strongly advised that the IPMI
232 LAN interface only be enabled in 'trusted' environments where system
233 security is not an issue or where there is a dedicated secure 'manage‐
234 ment network'.
235 Further it is strongly advised that you should not enable IPMI for re‐
237 mote access without setting a password, and that that password should
238 not be the same as any other password on that system.
239 When an IPMI password is changed on a remote machine with the IPMIv1.5
241 lan interface the new password is sent across the network as clear
242 text. This could be observed and then used to attack the remote sys‐
243 tem. It is thus recommended that IPMI password management only be done
244 over IPMIv2.0 lanplus interface or the system interface on the local
245 station.
246 For IPMI v1.5, the maximum password length is 16 characters; longer
248 passwords might be truncated or rejected by the server, or rejected by
249 ipmitool.
250 For IPMI v2.0, the maximum password length is 20 characters; longer
252 passwords will be rejected by ipmitool.
253
256 help This can be used to get command-line help on ipmitool commands.
257 It may also be placed at the end of commands to get option usage
258 help.
259 > ipmitool help
261 Commands:
262 bmc Deprecated. Use mc
263 channel Configure Management Controller channels
264 chassis Get chassis status and set power state
265 dcmi Data Center Management Interface
266 delloem Manage Dell OEM Extensions.
267 echo Used to echo lines to stdout in scripts
268 ekanalyzer run FRU-Ekeying analyzer using FRU files
269 event Send events to MC
270 exec Run list of commands from file
271 firewall Configure Firmware Firewall
272 fru Print built-in FRU and scan for FRU loca‐
273 tors
274 fwum Update IPMC using Kontron OEM Firmware Up‐
275 date Manager
276 gendev Read/Write Device associated with Generic
277 Device locators sdr
278 hpm Update HPM components using PICMG HPM.1
279 file
280 i2c Send an I2C Master Write-Read command and
281 print response
282 ime Upgrade/Query Intel ME firmware
283 isol Configure and connect Intel IPMIv1.5 Se‐
284 rial-over-LAN
285 kontronoem Manage Kontron OEM Extensions
286 lan Configure LAN Channels
287 mc Management Controller status and global en‐
288 ables
289 nm Node Manager
290 pef Configure Platform Event Filtering (PEF)
291 picmg Run a PICMG/ATA extended command
292 power Shortcut to chassis power commands
293 raw Send a RAW IPMI request and print response
294 sdr Print Sensor Data Repository entries and
295 readings
296 sel Print System Event Log (SEL)
297 sensor Print detailed sensor information
298 session Print session information
299 set Set runtime variable for shell and exec
300 shell Launch interactive IPMI shell
301 sol Configure and connect IPMIv2.0 Se‐
302 rial-over-LAN
303 spd Print SPD info from remote I2C device
304 sunoem Manage Sun OEM Extensions
305 tsol Configure and connect Tyan IPMIv1.5 Se‐
306 rial-over-LAN
307 user Configure Management Controller users
308 channel
311 authcap <channel number> <max priv>
313 Displays information about the authentication capabili‐
315 ties of the selected channel at the specified privilege
316 level.
317 Possible privilege levels are:
319 1 Callback level
320 2 User level
321 3 Operator level
322 4 Administrator level
323 5 OEM Proprietary level
324 15 No access
325 info [channel number]
327 Displays information about the selected channel. If
329 no channel is given it will display information about the
330 currently used channel.
331 > ipmitool channel info
333 Channel 0xf info:
334 Channel Medium Type : System Interface
335 Channel Protocol Type : KCS
336 Session Support : session-less
337 Active Session Count : 0
338 Protocol Vendor ID : 7154
339 getaccess <channel number> [<userid>]
341 Configure the given userid as the default on the given
343 channel number. When the given channel is subsequently
344 used, the user is identified implicitly by the given
345 userid.
346 setaccess <channel number> <userid> [<callin=on|off>]
348 [<ipmi=on|off>] [<link=on|off>] [<privi‐
349 lege=level>]
350 Configure user access information on the given
352 channel for the given userid.
353 getciphers <ipmi|sol> [<channel>]
355 Displays the list of cipher suites supported for
357 the given application (ipmi or sol) on the given
358 channel.
359 setkg <hex|plain> <key> [<channel>]
361 Sets K_g key to given value. Use plain to specify
363 key as simple ASCII string. Use hex to specify
364 key as sequence of hexadecimal codes of ASCII
365 charactes. I.e. following two examples are equiv‐
366 alent:
367 ipmitool channel setkg plain PASSWORD
369 ipmitool channel setkg hex 50415353574F5244
371 chassis
374 status
376 Status information related to power, buttons, cooling,
378 drives and faults.
379 power
381 status
383 on
385 off
387 cycle
389 reset
391 diag
393 soft
395 identify [<seconds>|force]
397 Identify interval.
399 Default is 15 seconds.
400 0 - Off
401 force - To turn on indefinitely
402 policy
404 What to do when power is restored.
406 list
408 Show available options.
410 always-on
412 previous
414 always-off
416 restart_cause
419 Last restart cause.
421 poh
423 Get power on hours.
425 bootdev
427 none
429 Do not change boot device order.
431 pxe
433 Force PXE boot.
435 disk
437 Force boot from default Hard-drive.
439 safe
441 Force boot from default Hard-drive, request Safe
443 Mode.
444 diag
446 Force boot from Diagnostic Partition.
448 cdrom
450 Force boot from CD/DVD.
452 bios
454 Force boot into BIOS Setup.
456 floppy
458 Force boot from Floppy/primary removable media.
460 bootmbox get [text] [block <block#>]
463 Read the Boot Initiator Mailbox in hex dump or in text
465 mode.
466 By default the whole mailbox is read. If block number is
468 specified, that particular block is read. For block 0 or
469 when the whole mailbox is read, the Boot Initiator IANA
470 Enterprise Number and the corresponding enterprise name
471 are printed.
472 bootmbox set text [block <block#>] <IANA_PEN> "<data_string>"
475 Write the specified <block> or the entire Boot Initiator
477 Mailbox in text mode. It is required to specify a deci‐
478 mal IANA Enterprise Number recognized by the boot initia‐
479 tor on the target system. Refer to your target system
480 manufacturer for details. The rest of the arguments are a
481 text string.
482 When single block write is requested, the total length of
484 <data> may not exceed 13 bytes for block 0, or 16 bytes
485 otherwise.
486 bootmbox set [block <block#>] <IANA_PEN> <data_byte>
489 [<data_byte> ...]
490 Same as above, but the arguments after IANA PEN are sepa‐
492 rate data byte values separated by spaces.
493 bootparam get <opt_id> [<opt_param>]
496 Get value of system boot option number <opt_id>. Some
498 boot options (e.g. option 7) can also take an optional
499 numeric parameter.
500 bootparam set bootflag <device> [options=...]
503 Set a boot flag. Valid devices are:
505 force_pxe
508 Force PXE boot
510 force_disk
512 Force boot from default Hard-drive
514 force_safe
516 Force boot from default Hard-drive, request Safe
518 Mode
519 force_diag
521 Force boot from Diagnostic Partition
523 force_cdrom
525 Force boot from CD/DVD
527 force_bios
529 Force boot into BIOS Setup
531 Valid options are:
534 PEF
537 Clear valid bit on reset/power cycle cause by PEF
539 timeout
542 Automatically clear boot flag valid bit on timeout
544 watchdog
547 Clear valid bit on reset/power cycle cause by
549 watchdog
550 reset
553 Clear valid bit on push button reset/soft reset
555 power
558 Clear valid bit on power up via power push button
560 or wake event
561 selftest
564 Get the chassis self-test results
566 dcmi
569 discover
571 This command is used to discover supported capabilities
573 in DCMI.
574 power <command>
577 Platform power limit command options are:
579 reading
582 Get power related readings from the system.
584 get_limit
586 Get the configured power limits.
588 set_limit <parameter> <value>
590 Set a power limit option.
592 Possible parameters/values are:
595 action <No Action | Hard Power Off & Log Event to
598 SEL | Log Event to SEL>
599 Exception Actions are taken as "No Action",
601 "Hard Power Off system and log events to
602 SEL", or "Log event to SEL only".
603 limit <number in Watts>
605 Power Limit Requested in Watts.
607 correction <number in milliseconds>
609 Correction Time Limit in milliseconds.
611 sample <number in seconds>
613 Statistics Sampling period in seconds.
615 activate
618 Activate the set power limit.
620 deactivate
622 Deactivate the set power limit.
624 sensors
626 Prints the available DCMI sensors.
628 asset_tag
630 Prints the platforms asset tag.
632 set_asset_tag <string>
634 Sets the platforms asset tag
636 get_mc_id_string
638 Get management controller identifier string.
640 set_mc_id_string <string>
642 Set management controller identifier string. The maximum
644 length is 64 bytes including a null terminator.
645 thermalpolicy [<get | set>]
647 Thermal Limit policy get/set.
649 The commands are:
652 Get <entityID> <instanceID>
655 Get Thermal Limit values.
657 entityID is the physical entity that a sensor or
659 device is associated with. instanceID is a par‐
660 ticular instance of an entity. Entity Instance
661 can be in one of two ranges, system-relative or
662 device-relative. For example, a system with four
663 processors could use an Entity Instance value of
664 "0" to identify the first processor.
665 Set <entityID> <instanceID>
667 Set Thermal Limit values.
669 entityID is the physical entity that a sensor or
671 device is associated with. instanceID is a par‐
672 ticular instance of an entity. Entity Instance
673 can be in one of two ranges, system-relative or
674 device-relative. For example, a system with four
675 processors could use an Entity Instance value of
676 "0" to identify the first processor.
677 get_temp_reading
679 Get Temperature Sensor Readings.
681 get_conf_param
683 Get DCMI Configuration Parameters.
685 set_conf_param <parameters>
687 Set DCMI Configuration Parameters.
689 The Configuration Parameters are:
691 activate_dhcp
693 Activate/restart DHCP
695 dhcp_config
697 Discover DHCP Configuration.
699 init
701 Set DHCP Initial timeout interval, in seconds.
703 The recommended default is four seconds.
704 timeout
706 Set DHCP Server contact timeout interval, in sec‐
708 onds. The recommended default timeout is two min‐
709 utes.
710 retry
712 Set DHCP Server contact retry interval, in sec‐
714 onds. The recommended default timeout is sixty-
715 four seconds.
716 oob_discover
718 Ping/Pong Message for DCMI Discovery.
720 delloem
723 The delloem commands provide information on Dell-specific fea‐
725 tures.
726 setled {b:d.f} {state..}
728 Sets the drive backplane LEDs for a device.
730 {b:d.f} = PCI Address of device (eg. 06:00.0)
731 {state} = one or more of the following:
732 online | present | hotspare | identify | rebuild‐
733 ing | fault | predict | critical | failed
734 lcd
737 set {mode}|{lcdqualifier}|{errordisplay}
738 Allows you to set the LCD mode and user-defined
740 string.
741 lcd set mode
743 {none}|{modelname}|{ipv4address}|{macaddress}|
744 {systemname}|{servicetag}|{ipv6address}|
745 {ambienttemp}|{systemwatt}|{assettag}|
746 {userdefined}<text>
747 Allows you to set the LCD display mode to any of
749 the preceding parameters.
750 lcd set lcdqualifier
753 {watt}|{btuphr}|
754 {celsius}|{fahrenheit}
755 Allows you to set the unit for the system ambient
757 temperature mode.
758 lcd set errordisplay
761 {sel}|{simple}
762 Allows you to set the error display.
764 lcd info
766 Displays the LCD screen information.
768 lcd set vkvm
770 {active}|{inactive}
771 Allows you to set the vKVM status to active or in‐
773 active. When it is active and session is in
774 progress, a message appears on LCD.
775 lcd status
777 Displays the LCD status for vKVM display active or
779 inactive and Front Panel access mode (viewandmod‐
780 ify, view-only or disabled).
781 mac
783 Displays the information about the system NICs.
785 mac list
787 Displays the NIC MAC address and status of all
789 NICs. It also displays the DRAC/iDRAC MAC address.
790 mac get
793 <NIC number>
794 Displays the selected NICs MAC address and status.
796 lan
798 Displays the information of Lan.
799 lan set
802 <Mode>
803 Sets the NIC selection mode (dedicated, shared
805 with lom1, shared with lom2,shared with
806 lom3,shared with lom4,shared with failover
807 lom1,shared with failover lom2,shared with
808 failover lom3,shared with failover lom4,shared
809 with Failover all loms, shared with Failover
810 None).
811 lan get
813 Returns the current NIC selection mode (dedicated,
815 shared with lom1, shared with lom2, shared with
816 lom3, shared with lom4,shared with failover lom1,
817 shared with failover lom2,shared with failover
818 lom3,shared with failover lom4,shared with
819 Failover all loms,shared with Failover None).
820 lan get active
823 Returns the current active NIC (dedicated, LOM1,
825 LOM2, LOM3 or LOM4).
826 powermonitor
828 Displays power tracking statistics.
830 powermonitor clear cumulativepower
833 Reset cumulative power reading.
835 powermonitor clear peakpower
837 Reset peak power reading.
839 powermonitor powerconsumption
841 <watt>|<btuphr>
842 Displays the power consumption in watt or btuphr.
843 powermonitor powerconsumptionhistory
845 <watt>|<btuphr>
846 Displays the power consumption history in watt or
847 btuphr.
848 powermonitor getpowerbudget
850 <watt>|<btuphr>
851 Displays the power cap in watt or btuphr.
852 powermonitor setpowerbudget
854 <val><watt|btuphr|percent>
855 Allows you to set the power cap in watt, BTU/hr
856 or percentage.
857 powermonitor enablepowercap
859 Enables set power cap.
860 powermonitor disablepowercap
862 Disables set power cap.
864 vFlash info Card
867 Shows Extended SD Card information.
869 echo
871 For echoing lines to stdout in scripts.
873 ekanalyzer <command> <xx=filename1> <xx=filename2> [<rc=filename3>] ...
875 NOTE : This command can support a maximum of 8 files per command
877 line
878 filename1 : binary file that stores FRU data of a Carrier or an
880 AMC module
881 filename2 : binary file that stores FRU data of an AMC module.
883 These binary files can be generated from command:
884 ipmitool fru read <id> <filename>
885 filename3 : configuration file used for configuring On-Carrier
887 Device ID
888 or OEM GUID. This file is optional.
889 xx : indicates the type of the file. It can take the following
891 value:
892 oc : On-Carrier device
894 a1 : AMC slot A1
896 a2 : AMC slot A2
898 a3 : AMC slot A3
900 a4 : AMC slot A4
902 b1 : AMC slot B1
904 b2 : AMC slot B2
906 b3 : AMC slot B3
908 b4 : AMC slot B4
910 sm : Shelf Manager
912 The available commands for ekanalyzer are:
915 print [<carrier | power | all>]
918 carrier (default) <oc=filename1> <oc=filename2> ...
920 Display point to point physical connectivity be‐
922 tween carriers and AMC modules.
923 Example:
924 > ipmitool ekanalyzer print carrier oc=fru
925 oc=carrierfru
926 From Carrier file: fru
927 Number of AMC bays supported by Carrier: 2
928 AMC slot B1 topology:
929 Port 0 =====> On Carrier Device ID 0,
930 Port 16
931 Port 1 =====> On Carrier Device ID 0,
932 Port 12
933 Port 2 =====> AMC slot B2, Port 2
934 AMC slot B2 topology:
935 Port 0 =====> On Carrier Device ID 0,
936 Port 3
937 Port 2 =====> AMC slot B1, Port 2
938 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
939 From Carrier file: carrierfru
940 On Carrier Device ID 0 topology:
941 Port 0 =====> AMC slot B1, Port 4
942 Port 1 =====> AMC slot B1, Port 5
943 Port 2 =====> AMC slot B2, Port 6
944 Port 3 =====> AMC slot B2, Port 7
945 AMC slot B1 topology:
946 Port 0 =====> AMC slot B2, Port 0
947 AMC slot B1 topology:
948 Port 1 =====> AMC slot B2, Port 1
949 Number of AMC bays supported by Carrier: 2
950 power <xx=filename1> <xx=filename2> ...
953 Display power supply information between carrier
955 and AMC modules.
956 all <xx=filename> <xx=filename> ...
958 Display both physical connectivity and power sup‐
960 ply of each carrier and AMC modules.
961 frushow <xx=filename>
964 Convert a binary FRU file into human readable text for‐
965 mat. Use -v option to get more display information.
966 summary [<match | unmatch | all>]
969 match (default) <xx=filename> <xx=filename> ...
971 Display only matched results of Ekeying match be‐
972 tween an On-Carrier device and an AMC module or
973 between 2 AMC modules. Example:
974 > ipmitool ekanalyzer summary match oc=fru
975 b1=amcB1 a2=amcA2
976 On-Carrier Device vs AMC slot B1
977 AMC slot B1 port 0 ==> On-Carrier Device 0 port
978 16
979 Matching Result
980 - From On-Carrier Device ID 0
981 -Channel ID 11 || Lane 0: enable
982 -Link Type: AMC.2 Ethernet
983 -Link Type extension: 1000BASE-BX (SerDES Gi‐
984 gabit) Ethernet link
985 -Link Group ID: 0 || Link Asym. Match: exact
986 match
987 - To AMC slot B1
988 -Channel ID 0 || Lane 0: enable
989 -Link Type: AMC.2 Ethernet
990 -Link Type extension: 1000BASE-BX (SerDES Gi‐
991 gabit) Ethernet link
992 -Link Group ID: 0 || Link Asym. Match: exact
993 match
994 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
995 AMC slot B1 port 1 ==> On-Carrier Device 0 port
996 12
997 Matching Result
998 - From On-Carrier Device ID 0
999 -Channel ID 6 || Lane 0: enable
1000 -Link Type: AMC.2 Ethernet
1001 -Link Type extension: 1000BASE-BX (SerDES Gi‐
1002 gabit) Ethernet link
1003 -Link Group ID: 0 || Link Asym. Match: exact
1004 match
1005 - To AMC slot B1
1006 -Channel ID 1 || Lane 0: enable
1007 -Link Type: AMC.2 Ethernet
1008 -Link Type extension: 1000BASE-BX (SerDES Gi‐
1009 gabit) Ethernet link
1010 -Link Group ID: 0 || Link Asym. Match: exact
1011 match
1012 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
1013 On-Carrier Device vs AMC slot A2
1014 AMC slot A2 port 0 ==> On-Carrier Device 0 port
1015 3
1016 Matching Result
1017 - From On-Carrier Device ID 0
1018 -Channel ID 9 || Lane 0: enable
1019 -Link Type: AMC.2 Ethernet
1020 -Link Type extension: 1000BASE-BX (SerDES Gi‐
1021 gabit) Ethernet link
1022 -Link Group ID: 0 || Link Asym. Match: exact
1023 match
1024 - To AMC slot A2
1025 -Channel ID 0 || Lane 0: enable
1026 -Link Type: AMC.2 Ethernet
1027 -Link Type extension: 1000BASE-BX (SerDES Gi‐
1028 gabit) Ethernet link
1029 -Link Group ID: 0 || Link Asym. Match: exact
1030 match
1031 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
1032 AMC slot B1 vs AMC slot A2
1033 AMC slot A2 port 2 ==> AMC slot B1 port 2
1034 Matching Result
1035 - From AMC slot B1
1036 -Channel ID 2 || Lane 0: enable
1037 -Link Type: AMC.3 Storage
1038 -Link Type extension: Serial Attached SCSI
1039 (SAS/SATA)
1040 -Link Group ID: 0 || Link Asym. Match: FC or
1041 SAS interface {exact match}
1042 - To AMC slot A2
1043 -Channel ID 2 || Lane 0: enable
1044 -Link Type: AMC.3 Storage
1045 -Link Type extension: Serial Attached SCSI
1046 (SAS/SATA)
1047 -Link Group ID: 0 || Link Asym. Match: FC or
1048 SAS interface {exact match}
1049 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
1050 unmatch <xx=filename> <xx=filename> ...
1052 Display the unmatched results of Ekeying match be‐
1054 tween an On-Carrier device and an AMC module or
1055 between 2 AMC modules
1056 all <xx=filename> <xx=filename> ...
1058 Display both matched result and unmatched results
1060 of Ekeying match between two cards or two modules.
1061 event
1063 <predefined event number N>
1065 Send a pre-defined test event to the System Event Log.
1067 The following events are included as a means to test the
1068 functionality of the System Event Log component of the
1069 BMC (an entry will be added each time the event N command
1070 is executed).
1071 Currently supported values for N are:
1073 1 Temperature: Upper Critical: Going High
1074 2 Voltage Threshold: Lower Critical: Going Low
1075 3 Memory: Correctable ECC
1076 NOTE: These pre-defined events will likely not produce
1078 "accurate" SEL records for a particular system because
1079 they will not be correctly tied to a valid sensor number,
1080 but they are sufficient to verify correct operation of
1081 the SEL.
1082 file <filename>
1085 Event log records specified in <filename> will be added
1087 to the System Event Log.
1088 The format of each line in the file is as follows:
1090 <{EvM Revision} {Sensor Type} {Sensor Num} {Event
1092 Dir/Type} {Event Data 0} {Event Data 1} {Event Data 2}>[#
1093 COMMENT]
1094 e.g.: 0x4 0x2 0x60 0x1 0x52 0x0 0x0 # Voltage threshold:
1096 Lower Critical: Going Low
1097 EvM Revision - The "Event Message Revision" is 0x04 for
1099 messages that comply with the IPMI 2.0 Specification and
1100 0x03 for messages that comply with the IPMI 1.0 Specifi‐
1101 cation.
1102 Sensor Type - Indicates the Event Type or Class.
1104 Sensor Num - Represents the 'sensor' within the manage‐
1106 ment controller that generated the Event Message.
1107 Event Dir/Type - This field is encoded with the event di‐
1109 rection as the high bit (bit 7) and the event type as the
1110 low 7 bits. Event direction is 0 for an assertion event
1111 and 1 for a deassertion event.
1112 See the IPMI 2.0 specification for further details on the
1114 definitions for each field.
1115 <sensorid> <list>
1118 Get a list of all the possible Sensor States and pre-de‐
1120 fined Sensor State Shortcuts available for a particular
1121 sensor. sensorid is the character string representation
1122 of the sensor and must be enclosed in double quotes if it
1123 includes white space. Several different commands includ‐
1124 ing ipmitool sensor list may be used to obtain a list
1125 that includes the sensorid strings representing the sen‐
1126 sors on a given system.
1127 > ipmitool -I open event "PS 2T Fan Fault" list
1129 Finding sensor PS 2T Fan Fault... ok
1130 Sensor States:
1131 State Deasserted
1132 State Asserted
1133 Sensor State Shortcuts:
1134 present absent
1135 assert deassert
1136 limit nolimit
1137 fail nofail
1138 yes no
1139 on off
1140 up down
1141 <sensorid> <sensor state> [<direction>]
1144 Generate a custom event based on existing sensor informa‐
1146 tion. The optional event direction can be either assert
1147 (the default) or deassert.
1148 > ipmitool event "PS 2T Fan Fault" "State Asserted"
1151 Finding sensor PS 2T Fan Fault... ok
1152 0 | Pre-Init Time-stamp | Fan PS 2T Fan Fault |
1153 State Asserted
1154 > ipmitool event "PS 2T Fan Fault" "State Deasserted"
1156 Finding sensor PS 2T Fan Fault... ok
1157 0 | Pre-Init Time-stamp | Fan PS 2T Fan Fault |
1158 State Desserted
1159 exec <filename>
1161 Execute ipmitool commands from filename. Each line is a com‐
1163 plete command. The syntax of the commands are defined by the
1164 COMMANDS section in this manpage. Each line may have an op‐
1165 tional comment at the end of the line, delimited with a `#' sym‐
1166 bol.
1167 e.g., a command file with two lines:
1169 sdr list # get a list of sdr records
1171 sel list # get a list of sel records
1172 firewall
1174 This command supports the Firmware Firewall capability. It may
1176 be used to add or remove security-based restrictions on certain
1177 commands/command sub-functions or to list the current firmware
1178 firewall restrictions set on any commands. For each firmware
1179 firewall command listed below, parameters may be included to
1180 cause the command to be executed with increasing granularity on
1181 a specific LUN, for a specific NetFn, for a specific IPMI Com‐
1182 mand, and finally for a specific command's sub-function (see Ap‐
1183 pendix H in the IPMI 2.0 Specification for a listing of any sub-
1184 function numbers that may be associated with a particular com‐
1185 mand).
1186 Parameter syntax and dependencies are as follows:
1188 [<channel H>] [<lun L> [ <netfn N> [<command C [<subfn S>]]]]
1190 Note that if "netfn <N>" is specified, then "lun <L>" must also
1192 be specified; if "command <C>" is specified, then "netfn <N>"
1193 (and therefore "lun <L>") must also be specified, and so forth.
1194 "channel <H>" is an optional and standalone parameter. If not
1196 specified, the requested operation will be performed on the cur‐
1197 rent channel. Note that command support may vary from channel
1198 to channel.
1199 Firmware firewall commands:
1201 info [<Parms as described above>]
1203 List firmware firewall information for the specified LUN,
1205 NetFn, and Command (if supplied) on the current or speci‐
1206 fied channel. Listed information includes the support,
1207 configurable, and enabled bits for the specified command
1208 or commands.
1209 Some usage examples:
1211 info [<channel H>] [<lun L>]
1213 This command will list firmware firewall informa‐
1215 tion for all NetFns for the specified LUN on ei‐
1216 ther the current or the specified channel.
1217 info [<channel H>] [<lun L> [ <netfn N> ]
1219 This command will print out all command informa‐
1221 tion for a single LUN/NetFn pair.
1222 info [<channel H>] [<lun L> [ <netfn N> [<command C] ]]
1224 This prints out detailed, human-readable informa‐
1226 tion showing the support, configurable, and en‐
1227 abled bits for the specified command on the speci‐
1228 fied LUN/NetFn pair. Information will be printed
1229 about each of the command subfunctions.
1230 info [<channel H>] [<lun L> [ <netfn N> [<command C
1232 [<subfn S>]]]]
1233 Print out information for a specific sub-function.
1235 enable [<Parms as described above>]
1237 This command is used to enable commands for a given
1239 NetFn/LUN combination on the specified channel.
1240 disable [<Parms as described above>] [force]
1242 This command is used to disable commands for a given
1244 NetFn/LUN combination on the specified channel. Great
1245 care should be taken if using the "force" option so as
1246 not to disable the "Set Command Enables" command.
1247 reset [<Parms as described above>]
1249 This command may be used to reset the firmware firewall
1251 back to a state where all commands and command sub-func‐
1252 tions are enabled.
1253 fru
1255 print
1257 Read all Field Replaceable Unit (FRU) inventory data
1259 and extract such information as serial number, part num‐
1260 ber, asset tags, and short strings describing the chas‐
1261 sis, board, or product.
1262 read <fru id> <fru file>
1264 fru id is the digit ID of the FRU (see output of 'fru
1266 print'). fru file is the absolute pathname of a file in
1267 which to dump the binary FRU data pertaining to the spec‐
1268 ified FRU entity.
1269 write <fru id> <fru file>
1271 fru id is the digit ID of the FRU (see output of 'fru
1273 print'). fru file is the absolute pathname of a file
1274 from which to pull the binary FRU data before uploading
1275 it to the specified FRU.
1276 upgEkey <fru id> <fru file>
1278 Update a multirecord FRU location. fru id is the digit
1280 ID of the FRU (see output of 'fru print'). fru file is
1281 the absolute pathname of a file from which to pull the
1282 binary FRU data to upload into the specified multirecord
1283 FRU entity.
1284 edit <fru id>
1287 This command provides interactive editing of some sup‐
1289 ported records, namely PICMG Carrier Activation Record.
1290 fru id is the digit ID of the FRU (see output of 'fru
1291 print'); default is 0.
1292 edit <fru id> field <section> <index> <string>
1295 This command may be used to set a field string to a new
1297 value. It replaces the FRU data found at index in the
1298 specified section with the supplied string.
1299 fru id is the digit ID of the FRU (see output of 'fru
1302 print').
1303 <section> is a string which refers to FRU Inventory In‐
1306 formation
1307 Storage Areas and may be refer to:
1308 c FRU Inventory Chassis Info Area
1310 b FRU Inventory Board Info Area
1312 p FRU Inventory Product Info Area
1314 <index> specifies the field number. Field numbering
1317 starts on the first 'english text' field type. For in‐
1318 stance in the <board> info area field '0' is <Board Manu‐
1319 facturer> and field '2' is <Board Serial Number>; see
1320 IPMI Platform Management FRU Information Storage Defini‐
1321 tion v1.0 R1.1 for field locations.
1322 <string> must be the same length as the string being re‐
1325 placed and must be 8-bit ASCII (0xCx).
1326 edit <fru id> oem iana <record> <format> [<args>]
1330 This command edits the data found in the multirecord
1332 area. Support for OEM specific records is limited.
1333 fwum
1335 Update IPMC using Kontron OEM Firmware Update Manager.
1336 info
1338 Show information about current firmware.
1339 status
1342 Show status of each firmware bank present in the hard‐
1343 ware.
1344 download <filename>
1347 Download specified firmware.
1349 upgrade [filename]
1352 Install firmware upgrade. If the filename is specified,
1354 the file is downloaded first, otherwise the last firmware
1355 downloaded is used.
1356 rollback
1359 Ask IPMC to rollback to previous version.
1361 tracelog
1364 Show firmware upgrade log.
1366 gendev
1369 list
1371 List All Generic Device Locators.
1373 read <sdr name> <file>
1375 Read to file eeprom specify by Generic Device Locators.
1377 write <sdr name> <file>
1379 Write from file eeprom specify by Generic Device Locators
1381 hpm
1383 PICMG HPM.1 Upgrade Agent
1384 check
1386 Check the target information.
1387 check <filename>
1390 Display both the existing target version and image ver‐
1391 sion on the screen.
1392 download <filename>
1395 Download specified firmware.
1397 upgrade <filename> [all] [component <x>] [activate]
1400 Upgrade the firmware using a valid HPM.1 image file. If
1401 no option is specified, the firmware versions are checked
1402 first and the firmware is upgraded only if they are dif‐
1403 ferent.
1404 all
1407 Upgrade all components even if the firmware ver‐
1408 sions are the same (use this only after using
1409 "check" command).
1410 component <x>
1413 Upgrade only given component from the given file.
1414 component 0 - BOOT
1415 component 1 - RTK
1416 activate
1419 Activate new firmware right away.
1420 activate
1424 Activate the newly uploaded firmware.
1426 targetcap
1429 Get the target upgrade capabilities.
1431 compprop <id> <select>
1434 Get the specified component properties. Valid component
1435 id: 0-7. Select can be one of following:
1436 0 - General properties
1437 1 - Current firmware version
1438 2 - Description string
1439 3 - Rollback firmware version
1440 4 - Deferred firmware version
1441 abort
1444 Abort the on-going firmware upgrade.
1446 upgstatus
1449 Show status of the last long duration command.
1450 rollback
1453 Perform manual rollback on the IPM Controller firmware.
1454 rollbackstatus
1457 Show the rollback status.
1459 selftestresult
1462 Query the self test results.
1464 i2c <i2caddr> <read bytes> [<write data>]
1467 This command may be used to execute raw I2C commands with the
1469 Master Write-Read IPMI command.
1470 ime
1472 help
1474 Print usage information
1476 info
1478 Displays information about the Manageability Engine (ME)
1480 update <file>
1482 Upgrade the ME firmware with the specified image file
1484 WARNING You MUST use a supported image provided by your
1485 board vendor
1486 rollback
1488 Perform manual rollback of the ME firmware
1490 isol
1493 info
1495 Retrieve information about the Intel IPMI v1.5 Se‐
1497 rial-Over-LAN configuration.
1498 set <parameter> <value>
1500 Configure parameters for Intel IPMI v1.5 Serial-over-LAN.
1502 Valid parameters and values are:
1504 enabled
1506 true, false.
1507 privilege-level
1509 user, operator, admin, oem.
1510 bit-rate
1512 9.6, 19.2, 38.4, 57.6, 115.2.
1513 activate
1515 Causes ipmitool to enter Intel IPMI v1.5 Serial Over LAN
1517 mode. An RMCP+ connection is made to the BMC, the termi‐
1518 nal is set to raw mode, and user input is sent to the se‐
1519 rial console on the remote server. On exit, the SOL pay‐
1520 load mode is deactivated and the terminal is reset to its
1521 original settings.
1522 Special escape sequences are provided to control the SOL
1524 session:
1525 ~. Terminate connection
1527 ~^Z Suspend ipmitool
1529 ~^X Suspend ipmitool, but don't restore tty
1531 on restart
1532 ~B Send break
1534 ~~ Send the escape character by typing it
1536 twice
1537 ~? Print the supported escape sequences
1539 Note that escapes are only recognized immediately after
1541 newline.
1542 kontronoem
1544 OEM commands specific to Kontron devices.
1546 setsn
1548 Set FRU serial number.
1550 setmfgdate
1552 Set FRU manufacturing date.
1554 nextboot <boot device>
1556 Select the next boot order on the Kontron CP6012.
1558 lan
1560 These commands will allow you to configure IPMI LAN channels
1562 with network information so they can be used with the lan and
1563 lanplus interfaces. NOTE: To determine on which channel the LAN
1564 interface is located, issue the `channel info number' command
1565 until you come across a valid 802.3 LAN channel. For example:
1566 > ipmitool -I open channel info 1
1568 Channel 0x1 info:
1569 Channel Medium Type : 802.3 LAN
1570 Channel Protocol Type : IPMB-1.0
1571 Session Support : session-based
1572 Active Session Count : 8
1573 Protocol Vendor ID : 7154
1574 print [<channel>]
1577 Print the current configuration for the given chan‐
1579 nel. The default will print information on the first
1580 found LAN channel.
1581 set <channel number> <command> <parameter>
1583 Set the given command and parameter on the specified
1585 channel. Valid command/parameter options are:
1586 ipaddr <x.x.x.x>
1588 Set the IP address for this channel.
1590 netmask <x.x.x.x>
1592 Set the netmask for this channel.
1594 macaddr <xx:xx:xx:xx:xx:xx>
1596 Set the MAC address for this channel.
1598 defgw ipaddr <x.x.x.x>
1600 Set the default gateway IP address.
1602 defgw macaddr <xx:xx:xx:xx:xx:xx>
1604 Set the default gateway MAC address.
1606 bakgw ipaddr <x.x.x.x>
1608 Set the backup gateway IP address.
1610 bakgw macaddr <xx:xx:xx:xx:xx:xx>
1612 Set the backup gateway MAC address.
1614 password <pass>
1616 Set the null user password.
1618 snmp <community string>
1620 Set the SNMP community string.
1622 user
1624 Enable user access mode for userid 1 (issue the
1626 `user' command to display information about
1627 userids for a given channel).
1628 access <on|off>
1630 Set LAN channel access mode.
1632 alert <on|off>
1634 Enable or disable PEF alerting for this channel.
1636 ipsrc <source>
1638 Set the IP address source:
1640 none unspecified
1641 static manually configured static IP address
1642 dhcp address obtained by BMC running DHCP
1643 bios address loaded by BIOS or system software
1644 arp respond <on|off>
1646 Set BMC generated ARP responses.
1648 arp generate <on|off>
1650 Set BMC generated gratuitous ARPs.
1652 arp interval <seconds>
1654 Set BMC generated gratuitous ARP interval.
1656 vlan id <off|id>
1658 Disable VLAN operation or enable VLAN and set the
1660 ID.
1661 ID: value of the virtual lan identifier between 1
1662 and 4094 inclusive.
1663 vlan priority <priority>
1665 Set the priority associated with VLAN frames.
1667 ID: priority of the virtual lan frames between 0
1668 and 7 inclusive.
1669 auth <level,...> <type,...>
1671 Set the valid authtypes for a given auth
1673 level.
1674 Levels: callback, user, operator, admin
1675 Types: none, md2, md5, password, oem
1676 cipher_privs <privlist>
1678 Correlates cipher suite numbers with the maximum
1680 privilege level that is allowed to use it. In
1681 this way, cipher suites can restricted to users
1682 with a given privilege level, so that, for exam‐
1683 ple, administrators are required to use a stronger
1684 cipher suite than normal users.
1685 The format of privlist is as follows. Each char‐
1687 acter represents a privilege level and the charac‐
1688 ter position identifies the cipher suite number.
1689 For example, the first character represents cipher
1690 suite 0, the second represents cipher suite 1, and
1691 so on. privlist must be 15 characters in length.
1692 Characters used in privlist and their associated
1694 privilege levels are:
1695 X Cipher Suite Unused
1697 c CALLBACK
1698 u USER
1699 o OPERATOR
1700 a ADMIN
1701 O OEM
1702 So, to set the maximum privilege for cipher suite
1704 0 to USER and suite 1 to ADMIN, issue the follow‐
1705 ing command:
1706 > ipmitool -I interface lan set channel ci‐
1708 pher_privs uaXXXXXXXXXXXXX
1709 bad_pass_thresh <thresh_num> <1|0> <reset_interval>
1713 <lockout_interval>
1714 Sets the Bad Password Threshold.
1716 <thresh_num> If non-zero, this value determines
1718 the number of sequential bad passwords that will
1719 be allowed to be entered for the identified user
1720 before the user is automatically disabled from ac‐
1721 cess on the channel.
1722 <1|0> 1 = generate a Session Audit sensor "Invalid
1724 password disable" event message. 0 = do not gen‐
1725 erate an event message when the user is disabled.
1726 <reset_interval> Attempt Count Reset Interval. The
1728 interval, in tens of seconds, for which the accu‐
1729 mulated count of bad password attempts is retained
1730 before being automatically reset to zero.
1731 <lockout_interval> User Lockout Interval. The in‐
1733 terval, in tens of seconds, that the user will re‐
1734 main disabled after being disabled because the Bad
1735 Password Threshold number was reached.
1736 alert print [<channel>] [<alert destination>]
1739 Print alert information for the specified channel and
1741 destination. The default will print all alerts for all
1742 alert destinations on the first found LAN channel.
1743 alert set <channel number> <alert destination> <command> <param‐
1746 eter>
1747 Set an alert on the given LAN channel and destination.
1749 Alert Destinations are listed via the 'lan alert print'
1750 command. Valid command/parameter options are:
1751 ipaddr <x.x.x.x>
1753 Set alert IP address.
1755 macaddr <xx:xx:xx:xx:xx:xx>
1757 Set alert MAC address.
1759 gateway <default | backup>
1761 Set the channel gateway to use for alerts.
1763 ack <on | off>
1765 Set Alert Acknowledge on or off.
1767 type <pet | oem1 | oem2>
1769 Set the destination type as PET or OEM.
1771 time <seconds>
1773 Set ack timeout or unack retry interval.
1775 retry <number>
1777 Set the number of alert retries.
1779 stats get [<channel number>]
1781 Retrieve information about the IP connections on the
1783 specified channel. The default will retrieve statistics
1784 on the first found LAN channel.
1785 stats clear [<channel number>]
1787 Clear all IP/UDP/RMCP Statistics to 0 on the specified
1789 channel. The default will clear statistics on the first
1790 found LAN channel.
1791 mc | bmc
1793 reset <warm|cold>
1795 Instructs the BMC to perform a warm or cold reset.
1797 guid [smbios|rfc4122|ipmi|dump]
1799 Display the Management Controller Globally Unique IDenti‐
1801 fier.
1802 auto
1805 This is the default behavior for ipmitool(1).
1807 Try to automatically detect the encoding based on
1809 the value of the version field and (for version 1)
1810 the timestamp. The version is considered valid if
1811 it is 1 through 5, and the timestamp is valid if
1812 the year is past or equal to UNIX Epoch (1970) and
1813 is before or equal to the current year.
1814 If multiple encodings happen to have valid version
1816 fields, then precedence takes the one with version
1817 1 and a valid timestamp. If neither one has that,
1818 then the precedence order is as follows: smbios,
1819 ipmi, rfc4122.
1820 If neither encoding yields a valid version field,
1822 then ipmitool(1) defaults to dump mode.
1823 If this option is in use, then ipmitool(1) will
1825 also print out the detected encoding and warn re‐
1826 garding IPMI specification violation if the encod‐
1827 ing isn't ipmi.
1828 smbios
1831 Decode GUID as if it was sent by BMC as prescribed
1833 by SMBIOS specification.
1834 NOTE: This is a violation of IPMI specification,
1836 but many BMC implementations do it this way. If
1837 your BMC's GUID is shown correctly using this op‐
1838 tion, you may want to inform your BMC manufacturer
1839 that they have a bug.
1840 ipmi
1843 Decode GUID according to IPMI specification. It
1845 MUST show the correct GUID. If it doesn't, try
1846 other options and inform your BMC manufacturer of
1847 the bug.
1848 rfc4122 or rfc
1851 Decode GUID as if it was sent by BMC as prescribed
1853 by RFC4122 specification.
1854 NOTE: This is a violation of IPMI specification.
1856 If your BMC's GUID is shown correctly using this
1857 option, you may want to inform your BMC manufac‐
1858 turer that they have a bug.
1859 dump
1862 Dump as hex the data received from BMC in response
1864 to Get Device GUID command. No decoding or inter‐
1865 pretation is performed. First received byte is
1866 dumped first.
1867 info
1871 Displays information about the BMC hardware, including
1873 device revision, firmware revision, IPMI version sup‐
1874 ported, manufacturer ID, and information on additional
1875 device support.
1876 watchdog
1878 These commands allow a user to view and change the cur‐
1880 rent state of the watchdog timer.
1881 get
1883 Show current Watchdog Timer settings and countdown
1885 state.
1886 reset
1888 Reset the Watchdog Timer to its most recent state
1890 and restart the countdown timer.
1891 off
1893 Turn off a currently running Watchdog countdown
1895 timer.
1896 selftest
1898 Check on the basic health of the BMC by executing the Get
1900 Self Test results command and report the results.
1901 getenables
1903 Displays a list of the currently enabled options for the
1905 BMC.
1906 setenables <option>=[on|off]
1908 Enables or disables the given option. This command is
1910 only supported over the system interface according to the
1911 IPMI specification. Currently supported values for op‐
1912 tion include:
1913 recv_msg_intr
1915 Receive Message Queue Interrupt
1917 event_msg_intr
1919 Event Message Buffer Full Interrupt
1921 event_msg
1923 Event Message Buffer
1925 system_event_log
1927 System Event Logging
1929 oem0
1931 OEM-Defined option #0
1933 oem1
1935 OEM-Defined option #1
1937 oem2
1939 OEM-Defined option #2
1941 getsysinfo <argument>
1944 Retrieves system info from bmc for given argument.
1945 See setsysinfo for argument definitions
1946 setsysinfo <argument> <string>
1948 Stores system info string to bmc for given argument
1949 Possible arguments are:
1951 primary_os_name Primary Operating System Name
1953 os_name Operating System Name
1955 system_name System Name of Server
1957 delloem_os_version Running version of operating
1959 system
1960 delloem_URL URL of BMC Webserver
1962 chassis
1964 status
1966 Displays information regarding the high-level sta‐
1968 tus of the system chassis and main power subsys‐
1969 tem.
1970 poh
1972 This command will return the Power-On Hours
1974 counter.
1975 identify <interval>
1977 Control the front panel identify light. Default
1979 interval is 15 seconds. Use 0 to turn off. Use
1980 "force" to turn on indefinitely.
1981 restart_cause
1983 Query the chassis for the cause of the last system
1985 restart.
1986 selftest
1988 Check on the basic health of the BMC by executing
1990 the Get Self Test results command and report the
1991 results.
1992 policy
1994 Set the chassis power policy in the event power
1996 failure.
1997 list
1999 Return supported policies.
2001 always-on
2003 Turn on when power is restored.
2005 previous
2007 Returned to previous state when power
2009 is restored.
2010 always-off
2012 Stay off after power is restored.
2014 power
2016 Performs a chassis control command to view and
2018 change the power state.
2019 status
2021 Show current chassis power status.
2023 on
2025 Power up chassis.
2027 off
2029 Power down chassis into soft off (S4/S5
2031 state). WARNING: This command does not
2032 initiate a clean shutdown of the operating
2033 system prior to powering down the system.
2034 cycle
2036 Provides a power off interval of at least 1
2038 second. No action should occur if chassis
2039 power is in S4/S5 state, but it is recom‐
2040 mended to check power state first and only
2041 issue a power cycle command if the system
2042 power is on or in lower sleep state than
2043 S4/S5.
2044 reset
2046 This command will perform a hard reset.
2048 diag
2050 Pulse a diagnostic interrupt (NMI) directly
2052 to the processor(s).
2053 soft
2055 Initiate a soft-shutdown of OS via ACPI.
2057 This can be done in a number of ways, com‐
2058 monly by simulating an overtemperture or by
2059 simulating a power button press. It is
2060 necessary for there to be Operating System
2061 support for ACPI and some sort of daemon
2062 watching for events for this soft power to
2063 work.
2064 bootdev <device> [<clear-cmos=yes|no>] [<op‐
2066 tions=help,...>]
2067 Request the system to boot from an alternate boot
2069 device on next reboot. The clear-cmos option, if
2070 supplied, will instruct the BIOS to clear its CMOS
2071 on the next reboot. Various options may be used
2072 to modify the boot device settings. Run "bootdev
2073 none options=help" for a list of available boot
2074 device modifiers/options.
2075 Currently supported values for <device> are:
2078 none
2080 Do not change boot device
2082 pxe
2084 Force PXE boot
2086 disk
2088 Force boot from BIOS default boot device
2090 safe
2092 Force boot from BIOS default boot device,
2094 request Safe Mode
2095 diag
2097 Force boot from diagnostic partition
2099 cdrom
2101 Force boot from CD/DVD
2103 bios
2105 Force boot into BIOS setup
2107 floppy
2109 Force boot from Floppy/primary removable
2111 media
2112 bootparam
2114 Get or set various system boot option parameters.
2116 get <param #>
2118 Get boot parameter. Currently supported
2120 values for <param #> are:
2121 0 - Set In Progress
2123 1 - Service Partition Selector
2125 2 - Service Partition Scan
2127 3 - BMC Boot Flag Valid Bit Clearing
2129 4 - Boot Info Acknowledge
2131 5 - Boot Flags
2133 6 - Boot Initiator Info
2135 7 - Boot Initiator Mailbox
2137 set <device> [<options=help,...>]
2140 Set boot device parameter used for next
2142 boot. Various options may be used to
2143 change when the the next boot device is
2144 cleared. Run "options=help" for a list of
2145 available bootparam set device options.
2146 Currently supported bootparam device set‐
2149 tings are:
2150 force_pxe
2152 Force PXE boot
2154 force_disk
2156 Force boot from default hard-drive
2158 force_safe
2160 Force boot from default hard-drive,
2162 request Safe Mode
2163 force_diag
2165 Force boot from diagnostic partition
2167 force_cdrom
2169 Force boot from CD/DVD
2171 force_bios
2173 Force boot into BIOS setup
2175 Currently supported bootparam options set‐
2178 tings are associated with BMC Boot Valid
2179 Bit Clearing and are as follows: Any op‐
2180 tion can be prefixed with "no-" to invert
2181 the sense of the operation.
2182 PEF
2184 Clear valid bit on reset/power cycle
2186 caused by PEF
2187 timeout
2189 Automatically clear boot flag valid
2191 bit if Chassis Control command is
2192 not received within 60 seconds.
2193 watchdog
2195 Clear valid bit on reset/power cycle
2197 caused by watchdog timeout
2198 reset
2200 Clear valid bit on push button reset
2202 / soft-reset
2203 power
2205 Clear valid bit on power up via
2207 power push button or wake event
2208 nm
2211 alert
2213 clear dest <dest>
2215 Clear the Node Manager Alert lan destination.
2217 get
2220 Get the Node Manager Alert settings.
2221 set chan <chan> dest <dest> string <string>
2224 Set the Node Manager alert channel, lan destina‐
2226 tion, and alert string number.
2227 capability
2230 Obtain the Node Manager power control capabilities and
2232 ranges.
2233 control
2236 enable|disable
2238 global
2240 Enable/disable all policies for all do‐
2242 mains.
2243 per_domain <platform|CPU|Memory>
2245 Enable/disable all policies of the speci‐
2247 fied domain.
2248 per_policy <0-7>
2250 Enable/disable the policy for the specified
2252 domain/policy combination.
2253 discover
2255 Discover Node Manager presence as well as the Node Man‐
2257 ager version, revision, and patch number.
2258 policy
2261 add
2263 power <watts> policy_id <0-7> [correction
2265 auto|soft|hard] trig_lim <seconds> stats <seconds>
2266 [domain <platform|CPU|Memory>] enable|disable
2267 Add a new power policy, or overwrite an ex‐
2269 isting policy. The correction parameter is
2270 the agressiveness of frequency limiting,
2271 default is auto. The trig_lim is the cor‐
2272 rection time limit and must be at least
2273 6000 and not greater than 65535. The stats
2274 setting is the averaging period in seconds
2275 and ranges from 1-65535. If domain is not
2276 supplied a default of platform is used.
2277 inlet <temp> policy_id <0-7> [correction
2281 auto|soft|hard] trig_lim <seconds> stats <seconds>
2282 [domain <platform|CPU|Memory>] enable|disable
2283 Add a new inlet temp policy, or overwrite
2285 an existing policy. The correction parame‐
2286 ter is the agressiveness of frequency lim‐
2287 iting, default is auto. The trig_lim is
2288 the correction time limit and must be at
2289 least 6000 and not greater than 65535. The
2290 stats setting is the averaging period in
2291 seconds and ranges from 1-65535. If domain
2292 is not supplied a default of platform is
2293 used.
2294 get policy_id <0-7>
2298 Get a previously stored policy.
2300 limiting
2302 Report policy number if any policy is limiting
2304 power.
2305 remove policy_id <0-7> [domain <platform|CPU|Memory>]
2307 Remove a policy. If domain is not supplied a de‐
2309 fault of platform is used.
2310 power min <minimum> max <maximum> [domain <platform|CPU|Memory>]
2312 Configure Node Manager power minimum and maximum power
2314 draw limits. The min and max values must be in the range
2315 of 0-65535. If domain is not supplied a default of plat‐
2316 form is used.
2317 reset
2320 comm policy_id <0-7> [domain <platform|CPU|Memory>]
2322 Reset Node Manager communication statistics. If
2324 domain is not supplied a default of platform is
2325 used.
2326 global
2329 Reset Node Manager global statistics.
2331 memory policy_id <0-7> [domain <platform|CPU|Memory>]
2334 Reset Node Manager memory throttling statistics.
2336 If domain is not supplied a default of platform is
2337 used.
2338 per_policy policy_id <0-7> [domain <platform|CPU|Memory>]
2341 Reset Node Manager per policy statistics. If do‐
2343 main is not supplied a default of platform is
2344 used.
2345 requests policy_id <0-7> [domain <platform|CPU|Memory>]
2348 Reset Node Manager unhandled requests statistics.
2350 If domain is not supplied a default of platform is
2351 used.
2352 response policy_id <0-7> [domain <platform|CPU|Memory>]
2355 Reset Node Manager response time statistics. If
2357 domain is not supplied a default of platform is
2358 used.
2359 throttling policy_id <0-7> [domain <platform|CPU|Memory>]
2362 Reset Node Manager throttling statistics. If do‐
2364 main is not supplied a default of platform is
2365 used.
2366 statistics
2369 comm_fail
2371 Report Node Manager communication failure statis‐
2373 tics.
2374 cpu_throttling
2377 Report Node Manager cpu throttling statistics.
2379 mem_throttling
2382 Report Node Manager memory throttling statistics.
2384 policy_power policy_id <0-7> [domain <platform|CPU|Mem‐
2387 ory>]
2388 Report Node Manager per policy power statistics
2390 (policy must be a power limit type policy). If
2391 domain is not supplied a default of platform is
2392 used.
2393 policy_temps policy_id <0-7> [domain <platform|CPU|Mem‐
2396 ory>]
2397 Report Node Manager per policy temp statistics
2399 (policy must be an inlet temp limit policy). If
2400 domain is not supplied a default of platform is
2401 used.
2402 policy_throt policy_id <0-7> [domain <platform|CPU|Mem‐
2405 ory>]
2406 Report Node Manager per policy throttling statis‐
2408 tics. If domain is not supplied a default of
2409 platform is used.
2410 requests
2413 Report Node Manager unhandled requests statistics.
2415 response
2418 Report Node Manager response time statistics.
2420 suspend
2423 get policy_id <0-7> [domain <platform|CPU|Memory>]
2425 Get Node Manager policy suspend periods. If do‐
2427 main is not supplied a default of platform is
2428 used.
2429 set policy_id <0-7> [domain <platform|CPU|Memory>]
2432 <start> <stop> <repeat>
2433 Set Node Manager policy suspend periods. If do‐
2435 main is not supplied a default of platform is
2436 used. The <start> and <stop> values must be in
2437 the range of 0-239, which is the number of minutes
2438 past midnight divided by 6. The <repeat> value is
2439 the daily recurrence pattern. Bit 0 is repeat ev‐
2440 ery Monday, bit 1 is repeat every Tuesday, on
2441 through bit 6 for Sunday.
2442 threshold
2445 get policy_id <0-7> [domain <platform|CPU|Memory>]
2447 Get Node Manager policy Alert Threshold settings.
2449 If domain is not supplied a default of platform is
2450 used.
2451 set policy_id <0-7> [domain <platform|CPU|Memory>]
2454 thresh_array
2455 Set Node Manager policy Alert Threshold values.
2457 If domain is not supplied a default of platform is
2458 used. The thresh_array is 1, 2, or 3 integers
2459 that set three alert threshold settings. The set‐
2460 ting type is a power or temperature value which
2461 must match the type of policy.
2462 pef
2466 info
2468 This command will query the BMC and print information
2470 about the PEF supported features.
2471 status
2473 This command prints the current PEF status (the last SEL
2475 entry processed by the BMC, etc).
2476 policy
2478 This command lists the PEF policy table entries. Each
2480 policy entry describes an alert destination. A policy
2481 set is a collection of table entries. PEF alert actions
2482 reference policy sets.
2483 list
2485 This command lists the PEF table entries. Each PEF entry
2487 relates a sensor event to an action. When PEF is active,
2488 each platform event causes the BMC to scan this table for
2489 entries matching the event, and possible actions to be
2490 taken. Actions are performed in priority order (higher
2491 criticality first).
2492 picmg <properties>
2494 Run a PICMG/ATA extended command. Get PICMG properties may be
2496 used to obtain and print Extension major version information,
2497 PICMG identifier, FRU Device ID and Max FRU Device ID.
2498 addrinfo
2500 Get address information. This command may return infor‐
2502 mation on the Hardware address, IPMB-0 Address, FRU ID,
2503 Site/Entity ID, and Site/Entity Type.
2504 frucontrol <fru id> <options>
2506 Set various control options:
2508 0x00 - Cold Reset
2510 0x01 - Warm Reset
2512 0x02 - Graceful Reboot
2514 0x03 - Issue Diagnostic Interrupt
2516 0x04 - Quiesce [AMC only]
2518 0x05-0xFF - Cold Reset
2520 activate <fru id>
2522 Activate the specified FRU.
2524 deactivate <fru id>
2526 Deactivate the specified FRU.
2528 policy get <fru id>
2530 Get FRU activation policy.
2532 policy set <fru id> <lockmask> <lock>
2534 Set FRU activation policy. lockmask is 1 or 0 to indi‐
2536 cate action on the deactivation or activation locked bit
2537 respectively. lock is 1 or 0 to set/clear locked bit.
2538 portstate set|getall|getgranted|getdenied <parameters>
2540 Get or set various port states. See usage for parameter
2541 details.
2542 power <chassis power command>
2544 Shortcut to the chassis power commands. See the chassis power
2546 commands for usage information.
2547 raw <netfn> <cmd> [<data>]
2549 This will allow you to execute raw IPMI commands. For example
2551 to query the POH counter with a raw command:
2552 > ipmitool -v raw 0x0 0xf
2554 RAW REQ (netfn=0x0 cmd=0xf data_len=0)
2555 RAW RSP (5 bytes)
2556 3c 72 0c 00 00
2557 Note that the OpenIPMI driver provided by the Linux kernel will
2559 reject the Get Message, Send Message and Read Event Message Buf‐
2560 fer commands because it handles the message sequencing inter‐
2561 nally.
2562 sdr
2564 get <id> ... [<id>]
2566 Prints information for sensor data records specified by
2568 sensor id.
2569 info
2571 This command will query the BMC for Sensor Data Record
2573 (SDR) Repository information.
2574 type [<sensor type>]
2576 This command will display all records from the SDR Repos‐
2578 itory of a specific type. Run with type list (or simply
2579 with no type) to see the list of available types. For
2580 example to query for all Temperature sensors:
2581 > ipmitool sdr type Temperature
2583 Baseboard Temp | 30h | ok | 7.1 | 28 degrees C
2584 FntPnl Amb Temp | 32h | ok | 12.1 | 24 degrees C
2585 Processor1 Temp | 98h | ok | 3.1 | 57 degrees C
2586 Processor2 Temp | 99h | ok | 3.2 | 53 degrees C
2587 list | elist [<all|full|compact|event|mcloc|fru|generic>]
2590 This command will read the Sensor Data Records (SDR) and
2592 extract sensor information of a given type, then query
2593 each sensor and print its name, reading, and status. If
2594 invoked as elist then it will also print sensor number,
2595 entity id and instance, and asserted discrete states.
2596 The default output will only display full and compact
2598 sensor types, to see all sensors use the all type with
2599 this command.
2600 Valid types are:
2602 all
2604 All SDR records (Sensor and Locator)
2606 full
2608 Full Sensor Record
2610 compact
2612 Compact Sensor Record
2614 event
2616 Event-Only Sensor Record
2618 mcloc
2620 Management Controller Locator Record
2622 fru
2624 FRU Locator Record
2626 generic
2628 Generic SDR records
2630 entity <id>[.<instance>]
2632 Displays all sensors associated with an entity. Get a
2634 list of valid entity ids on the target system by issuing
2635 the sdr elist command. A list of all entity ids can be
2636 found in the IPMI specifications.
2637 dump <file>
2639 Dumps raw SDR data to a file. This data file can then be
2641 used as a local SDR cache of the remote managed system
2642 with the -S <file> option on the ipmitool command line.
2643 This can greatly improve performance over system inter‐
2644 face or remote LAN.
2645 fill sensors
2647 Create the SDR Repository for the current configuration.
2649 Will perform a 'Clear SDR Repository' command so be care‐
2650 ful.
2651 fill file <filename>
2653 Fill the SDR Repository using records stored in a binary
2655 data file. Will perform a 'Clear SDR Repository' command
2656 so be careful.
2657 sel
2659 NOTE: System Event Log (SEL) entry-times are displayed as
2661 `Pre-Init Time-stamp' if the SEL clock needs to be set. Ensure
2662 that the SEL clock is accurate by invoking the sel time get and
2663 sel time set <time string> commands.
2664 info
2666 This command will query the BMC for information about the
2668 System Event Log (SEL) and its contents.
2669 clear
2671 This command will clear the contents of the SEL. It can‐
2673 not be undone so be careful.
2674 list | elist
2676 When this command is invoked without arguments, the en‐
2678 tire contents of the System Event Log are displayed. If
2679 invoked as elist (extended list) it will also use the
2680 Sensor Data Record entries to display the sensor ID for
2681 the sensor that caused each event. Note this can take a
2682 long time over the system interface.
2683 <count> | first <count>
2686 Displays the first count (least-recent) entries in
2688 the SEL. If count is zero, all entries are dis‐
2689 played.
2690 last <count>
2692 Displays the last count (most-recent) entries in
2694 the SEL. If count is zero, all entries are dis‐
2695 played.
2696 delete <SEL Record ID> ... <SEL Record ID>
2698 Delete one or more SEL event records.
2700 add <filename ID>
2702 Read event entries from a file and add them to the SEL.
2704 New SEL entries area added onto the SEL after the last
2705 record in the SEL. Record added is of type 2 and is au‐
2706 tomatically timestamped.
2707 get <SEL Record ID>
2709 Print information on the specified SEL Record entry.
2711 save <file>
2713 Save SEL records to a text file that can be fed back into
2715 the event file ipmitool command. This can be useful for
2716 testing Event generation by building an appropriate Plat‐
2717 form Event Message file based on existing events. Please
2718 see the available help for the 'event file ...' command
2719 for a description of the format of this file.
2720 writeraw <file>
2722 Save SEL records to a file in raw, binary format. This
2724 file can be fed back to the sel readraw ipmitool command
2725 for viewing.
2726 readraw <file>
2728 Read and display SEL records from a binary file. Such a
2730 file can be created using the sel writeraw ipmitool com‐
2731 mand.
2732 time
2734 get
2736 Displays the SEL clock's current time.
2737 set <time string>
2739 Sets the SEL clock. Future SEL entries will use
2741 the time set by this command. <time string> is of
2742 the form "MM/DD/YYYY HH:MM:SS". Note that hours
2743 are in 24-hour form. It is recommended that the
2744 SEL be cleared before setting the time.
2745 sensor
2747 list
2749 Lists sensors and thresholds in a wide table format.
2751 get <id> ... [<id>]
2753 Prints information for sensors specified by name.
2755 thresh <id> <threshold> <setting>
2757 This allows you to set a particular sensor threshold
2759 value. The sensor is specified by name.
2760 Valid thresholds are:
2762 unr Upper Non-Recoverable
2763 ucr Upper Critical
2764 unc Upper Non-Critical
2765 lnc Lower Non-Critical
2766 lcr Lower Critical
2767 lnr Lower Non-Recoverable
2768 thresh <id> lower <lnr> <lcr> <lnc>
2770 This allows you to set all lower thresholds for a sensor
2772 at the same time. The sensor is specified by name and
2773 the thresholds are listed in order of Lower Non-Recover‐
2774 able, Lower Critical, and Lower Non-Critical.
2775 thresh <id> upper <unc> <ucr> <unr>
2777 This allows you to set all upper thresholds for a sensor
2779 at the same time. The sensor is specified by name and
2780 the thresholds are listed in order of Upper Non-Critical,
2781 Upper Critical, and Upper Non-Recoverable.
2782 session
2784 info <active|all|id 0xnnnnnnnn|handle 0xnn>
2786 Get information about the specified session(s). You may
2788 identify sessions by their id, by their handle number, by
2789 their active status, or by using the keyword `all' to
2790 specify all sessions.
2791 set
2793 hostname <host>
2795 Session hostname.
2797 username <user>
2799 Session username.
2801 password <pass>
2803 Session password.
2805 privlvl <level>
2807 Session privilege level force.
2809 authtype <type>
2811 Authentication type force.
2813 localaddr <addr>
2815 Local IPMB address.
2817 targetaddr <addr>
2819 Remote target IPMB address.
2821 port <port>
2823 Remote RMCP port.
2825 csv [level]
2827 Enable output in comma separated format. Affects follow‐
2829 ing commands: user, channel, isol, sunoem, sol, sensor,
2830 sdr, sel, session.
2831 verbose [verbose]
2833 Verbosity level.
2835 shell
2837 This command will launch an interactive shell which you can use
2838 to send multiple ipmitool commands to a BMC and see the re‐
2839 sponses. This can be useful instead of running the full ipmitool
2840 command each time. Some commands will make use of a Sensor Data
2841 Record cache and you will see marked improvement in speed if
2842 these commands are able to reuse the same cache in a shell ses‐
2843 sion. LAN sessions will send a periodic keepalive command to
2844 keep the IPMI session from timing out.
2845 sol
2847 info [<channel number>]
2849 Retrieve information about the Serial-Over-LAN configura‐
2851 tion on the specified channel. If no channel is given,
2852 it will display SOL configuration data for the currently
2853 used channel.
2854 payload <enable | disable | status> <channel number> <userid>
2856 Enable, disable or show status of SOL payload for the
2858 user on the specified channel.
2859 set <parameter> <value> [<channel>] [noguard]
2861 Configure parameters for Serial Over Lan. If no channel
2863 is given, it will display SOL configuration data for the
2864 currently used channel. Configuration parameter updates
2865 are automatically guarded with the updates to the
2866 set-in-progress parameter, unless noguard parameter is
2867 present.
2868 Valid parameters and values are:
2870 set-in-progress
2872 set-complete set-in-progress commit-write
2873 enabled
2875 true false
2876 force-encryption
2878 true false
2879 force-authentication
2881 true false
2882 privilege-level
2884 user operator admin oem
2885 character-accumulate-level
2887 Decimal number given in 5 milliseconds increments
2888 character-send-threshold
2890 Decimal number
2891 retry-count
2893 Decimal number. 0 indicates no retries after
2894 packet is transmitted.
2895 retry-interval
2897 Decimal number in 10 millisecond increments. 0
2898 indicates that retries should be sent back to
2899 back.
2900 non-volatile-bit-rate
2902 serial, 19.2, 38.4, 57.6, 115.2. Setting this
2903 value to serial indicates that the BMC should use
2904 the setting used by the IPMI over serial channel.
2905 volatile-bit-rate
2907 serial, 19.2, 38.4, 57.6, 115.2. Setting this
2908 value to serial indicates that the BMC should use
2909 the setting used by the IPMI over serial channel.
2910 activate [usesolkeepalive | nokeepalive] [instance=<number>]
2912 Causes ipmitool to enter Serial Over LAN mode, and is
2914 only available when using the lanplus interface. An
2915 RMCP+ connection is made to the BMC, the terminal is set
2916 to raw mode, and user input is sent to the serial console
2917 on the remote server. On exit, the the SOL payload mode
2918 is deactivated and the terminal is reset to its original
2919 settings.
2920 If the instance is given, it will activate using the
2922 given instance number. The default is 1.
2923 Special escape sequences are provided to control the SOL
2925 session:
2926 ~. Terminate connection
2928 ~^Z Suspend ipmitool
2930 ~^X Suspend ipmitool, but don't restore tty on
2932 restart
2933 ~B Send break
2935 ~~ Send the escape character by typing it twice
2937 ~? Print the supported escape sequences
2939 Note that escapes are only recognized immediately after
2941 newline.
2942 deactivate [instance=<number>]
2944 Deactivates Serial Over LAN mode on the BMC. Exiting Se‐
2946 rial Over LAN mode should automatically cause this com‐
2947 mand to be sent to the BMC, but in the case of an unin‐
2948 tentional exit from SOL mode, this command may be neces‐
2949 sary to reset the state of the BMC.
2950 If the instance is given, it will deactivate the given
2952 instance number. The default is 1.
2953 spd <i2cbus> <i2caddr> [<channel>] [<axread>]
2955 This command may be used to read SPD (Serial Presence Detect)
2957 data using the I2C Master Write-Read IPMI command.
2958 sunoem
2961 cli [<command string> ...]
2963 Execute the service processor command line interface com‐
2965 mands. Without any command string, an interactive ses‐
2966 sion is started in the service processor command line en‐
2967 vironment. If a command string is specified, the command
2968 string is executed on the service processor and the con‐
2969 nection is closed.
2970 led
2972 These commands provide a way to get and set the status of
2974 LEDs on a Sun Microsystems server. Use 'sdr list
2975 generic' to get a list of devices that are controllable
2976 LEDs. The ledtype parameter is optional and not neces‐
2977 sary to provide on the command line unless it is required
2978 by hardware.
2979 get <sensorid> [<ledtype>]
2981 Get status of a particular LED described by a
2983 Generic Device Locator record in the SDR. A sen‐
2984 sorid of all will get the status of all available
2985 LEDS.
2986 set <sensorid> <ledmode> [<ledtype>]
2988 Set status of a particular LED described by a
2990 Generic Device Locator record in the SDR. A sen‐
2991 sorid of all will set the status of all available
2992 LEDS to the specified ledmode and ledtype.
2993 LED Mode is required for set operations:
2995 OFF Off
2996 ON Steady On
2997 STANDBY 100ms on 2900ms off blink rate
2998 SLOW 1HZ blink rate
2999 FAST 4HZ blink rate
3000 LED Type is optional:
3002 OK2RM Ok to Remove
3003 SERVICE Service Required
3004 ACT Activity
3005 LOCATE Locate
3006 nacname <ipmi name>
3009 Return the full NAC name of a target identified by ipmi
3011 name.
3012 ping <count> [<q>]
3014 Send and receive count packets. Each packet is 64 bytes.
3016 q - Quiet. Displays output only at the start and end of
3018 the process.
3019 getval <property name>
3021 Returns value of specified ILOM property.
3023 setval <property name> <property value> [<timeout>]
3025 Sets value of ILOM property. If timeout is not speci‐
3027 fied, the default value is 5 seconds. NOTE: setval must
3028 be executed locally on host!
3029 sshkey
3031 set <userid> <keyfile>
3033 This command will allow you to specify an SSH key
3035 to use for a particular user on the Service Pro‐
3036 cessor. This key will be used for CLI logins to
3037 the SP and not for IPMI sessions. View available
3038 users and their userids with the 'user list' com‐
3039 mand.
3040 del <userid>
3042 This command will delete the SSH key for a speci‐
3044 fied userid.
3045 version
3047 Display the version of ILOM firmware.
3049 getfile <file identifier> <destination file name>
3051 This command will return various files from service pro‐
3053 cessor and store them in specified destination file. Note
3054 that some files may not be present or be supported by
3055 your SP.
3056 File identifiers:
3058 SSH_PUBKEYS
3059 DIAG_PASSED
3060 DIAG_FAILED
3061 DIAG_END_TIME
3062 DIAG_INVENTORY
3063 DIAG_TEST_LOG
3064 DIAG_START_TIME
3065 DIAG_UEFI_LOG
3066 DIAG_TEST_LOG
3067 DIAG_LAST_LOG
3068 DIAG_LAST_CMD
3069 getbehavior <feature identifier>
3072 This command will test if various ILOM features are en‐
3074 abled.
3075 Feature identifiers:
3077 SUPPORTS_SIGNED_PACKAGES
3078 REQUIRES_SIGNED_PACKAGES
3079 tsol
3081 This command allows Serial-over-LAN sessions to be established
3083 with Tyan IPMIv1.5 SMDC such as the M3289 or M3290. The default
3084 command run with no arguments will establish default SOL session
3085 back to local IP address. Optional arguments may be supplied in
3086 any order.
3087 <ipaddr>
3090 Send receiver IP address to SMDC which it will use to
3092 send serial traffic to. By default this detects the lo‐
3093 cal IP address and establishes two-way session. Format
3094 of ipaddr is XX.XX.XX.XX
3095 port=NUM
3098 Configure UDP port to receive serial traffic on. By de‐
3100 fault this is 6230.
3101 ro|rw
3104 Confiure SOL session as read-only or read-write. Ses‐
3106 sions are read-write by default.
3107 user
3111 summary
3113 Displays a summary of userid information, including maxi‐
3115 mum number of userids, the number of enabled users, and
3116 the number of fixed names defined.
3117 list
3119 Displays a list of user information for all defined
3121 userids.
3122 set
3124 name <userid> <username>
3126 Sets the username associated with the given
3128 userid.
3129 password <userid> [<password> [<16|20>]]
3131 Sets the password for the given userid. If no
3133 password is given, the password is cleared (set to
3134 the NULL password). Be careful when removing
3135 passwords from administrator-level accounts. If
3136 specified, 16 or 20 determines the maximum pass‐
3137 word length.
3138 disable <userid>
3140 Disables access to the BMC by the given userid.
3142 enable <userid>
3144 Enables access to the BMC by the given userid.
3146 priv <userid> <privilege level> [<channel number>]
3148 Set user privilege level on the specified channel. If
3150 the channel is not specified, the current channel will be
3151 used.
3152 test <userid> <16|20> [<password>]
3154 Determine whether a password has been stored as 16 or 20
3156 bytes.
3157
3160 The ipmitool open interface utilizes the OpenIPMI kernel device driver.
3161 This driver is present in all modern 2.4 and all 2.6 kernels and it
3162 should be present in recent Linux distribution kernels. There are also
3163 IPMI driver kernel patches for different kernel versions available from
3164 the OpenIPMI homepage.
3165 The required kernel modules is different for 2.4 and 2.6 kernels. The
3167 following kernel modules must be loaded on a 2.4-based kernel in order
3168 for ipmitool to work:
3169 ipmi_msghandler
3171 Incoming and outgoing message handler for IPMI interfaces.
3172 ipmi_kcs_drv
3174 An IPMI Keyboard Controller Style (KCS) interface driver for the
3175 message handler.
3176 ipmi_devintf
3178 Linux character device interface for the message handler.
3179 The following kernel modules must be loaded on a 2.6-based kernel in
3181 order for ipmitool to work:
3182 ipmi_msghandler
3184 Incoming and outgoing message handler for IPMI interfaces.
3185 ipmi_si
3187 An IPMI system interface driver for the message handler. This
3188 module supports various IPMI system interfaces such as KCS, BT,
3189 SMIC, and even SMBus in 2.6 kernels.
3190 ipmi_devintf
3192 Linux character device interface for the message handler.
3193 Once the required modules are loaded there will be a dynamic character
3195 device entry that must exist at /dev/ipmi0. For systems that use devfs
3196 or udev this will appear at /dev/ipmi/0.
3197 To create the device node first determine what dynamic major number it
3199 was assigned by the kernel by looking in /proc/devices and checking for
3200 the ipmidev entry. Usually if this is the first dynamic device it will
3201 be major number 254 and the minor number for the first system interface
3202 is 0 so you would create the device entry with:
3203 mknod /dev/ipmi0 c 254 0
3205 ipmitool includes some sample initialization scripts that can perform
3207 this task automatically at start-up.
3208 In order to have ipmitool use the OpenIPMI device interface you can
3210 specify it on the command line:
3211 > ipmitool -I open <command>
3213
3215 The ipmitool bmc interface utilizes the bmc device driver as provided
3216 by Solaris 10 and higher. In order to force ipmitool to make use of
3217 this interface you can specify it on the command line:
3218 > ipmitool -I bmc <command>
3220 The following files are associated with the bmc driver:
3222 /platform/i86pc/kernel/drv/bmc
3225 32-bit ELF kernel module for the bmc driver.
3226 /platform/i86pc/kernel/drv/amd64/bmc
3228 64-bit ELF kernel module for the bmc driver.
3229 /dev/bmc
3231 Character device node used to communicate with the bmc driver.
3232
3234 The ipmitool lipmi interface uses the Solaris 9 IPMI kernel device
3235 driver. It has been superceeded by the bmc interface on Solaris 10.
3236 You can tell ipmitool to use this interface by specifying it on the
3237 command line.
3238 > ipmitool -I lipmi <expression>
3240
3242 The ipmitool lan interface communicates with the BMC over an Ethernet
3243 LAN connection using UDP under IPv4. UDP datagrams are formatted to
3244 contain IPMI request/response messages with a IPMI session headers and
3245 RMCP headers.
3246 IPMI-over-LAN uses version 1 of the Remote Management Control Protocol
3248 (RMCP) to support pre-OS and OS-absent management. RMCP is a re‐
3249 quest-response protocol delivered using UDP datagrams to port 623.
3250 The LAN interface is an authentication multi-session connection; mes‐
3252 sages delivered to the BMC can (and should) be authenticated with a
3253 challenge/response protocol with either straight password/key or MD5
3254 message-digest algorithm. ipmitool will attempt to connect with admin‐
3255 istrator privilege level as this is required to perform chassis power
3256 functions.
3257 You can tell ipmitool to use the lan interface with the -I lan option:
3259 > ipmitool -I lan -H <hostname> [-U <username>] [-P <password>] <com‐
3262 mand>
3263 A hostname must be given on the command line in order to use the lan
3265 interface with ipmitool. The password field is optional; if you do not
3266 provide a password on the command line, ipmitool will attempt to con‐
3267 nect without authentication. If you specify a password it will use MD5
3268 authentication if supported by the BMC and straight password/key other‐
3269 wise, unless overridden with a command line option.
3270
3272 Like the lan interface, the lanplus interface communicates with the BMC
3273 over an Ethernet LAN connection using UDP under IPv4. The difference
3274 is that the lanplus interface uses the RMCP+ protocol as described in
3275 the IPMI v2.0 specification. RMCP+ allows for improved authentication
3276 and data integrity checks, as well as encryption and the ability to
3277 carry multiple types of payloads. Generic Serial Over LAN support re‐
3278 quires RMCP+, so the ipmitool sol activate command requires the use of
3279 the lanplus interface.
3280 RMCP+ session establishment uses a symmetric challenge-response proto‐
3282 col called RAKP (Remote Authenticated Key-Exchange Protocol) which al‐
3283 lows the negotiation of many options. ipmitool does not yet allow the
3284 user to specify the value of every option, defaulting to the most obvi‐
3285 ous settings marked as required in the v2.0 specification. Authentica‐
3286 tion and integrity HMACS are produced with SHA1, and encryption is per‐
3287 formed with AES-CBC-128. Role-level logins are not yet supported.
3288 ipmitool must be linked with the OpenSSL library in order to perform
3290 the encryption functions and support the lanplus interface. If the re‐
3291 quired packages are not found it will not be compiled in and supported.
3292 You can tell ipmitool to use the lanplus interface with the -I lanplus
3294 option:
3295 > ipmitool -I lanplus -H <hostname> [-U <username>] [-P <password>]
3298 <command>
3299 A hostname must be given on the command line in order to use the lan
3301 interface with ipmitool. With the exception of the -A and -C options
3302 the rest of the command line options are identical to those available
3303 for the lan interface.
3304 The -C option allows you specify the authentication, integrity, and en‐
3306 cryption algorithms to use for for lanplus session based on the cipher
3307 suite ID found in the IPMIv2.0 specification in table 22-20. The de‐
3308 fault cipher suite is 17 which specifies RAKP-HMAC-SHA256 authentica‐
3309 tion, HMAC-SHA256-128 integrity, and AES-CBC-128 encryption algo‐
3310 rightms.
3311
3314 The ipmitool free interface utilizes the FreeIPMI libfreeipmi drivers.
3315 You can tell ipmitool to use the FreeIPMI interface with the -I option:
3317 > ipmitool -I free <command>
3319
3323 The ipmitool imb interface supports the Intel IMB (Intel Inter-module
3324 Bus) Interface through the /dev/imb device.
3325 You can tell ipmitool to use the IMB interface with the -I option:
3327 > ipmitool -I imb <command>
3329
3332 Example 1: Listing remote sensors
3333 > ipmitool -I lan -H 1.2.3.4 -f passfile sdr list
3335 Baseboard 1.25V | 1.24 Volts | ok
3336 Baseboard 2.5V | 2.49 Volts | ok
3337 Baseboard 3.3V | 3.32 Volts | ok
3338 Example 2: Displaying status of a remote sensor
3340 > ipmitool -I lan -H 1.2.3.4 -f passfile sensor get "Baseboard
3342 1.25V"
3343 Locating sensor record...
3344 Sensor ID : Baseboard 1.25V (0x10)
3345 Sensor Type (Analog) : Voltage
3346 Sensor Reading : 1.245 (+/- 0.039) Volts
3347 Status : ok
3348 Lower Non-Recoverable : na
3349 Lower Critical : 1.078
3350 Lower Non-Critical : 1.107
3351 Upper Non-Critical : 1.382
3352 Upper Critical : 1.431
3353 Upper Non-Recoverable : na
3354 Example 3: Displaying the power status of a remote chassis
3356 > ipmitool -I lan -H 1.2.3.4 -f passfile chassis power status
3358 Chassis Power is on
3359 Example 4: Controlling the power on a remote chassis
3361 > ipmitool -I lan -H 1.2.3.4 -f passfile chassis power on
3363 Chassis Power Control: Up/On
3364
3367 /usr/share/misc/enterprise-numbers
3368 system IANA PEN registry taken from http://www.iana.org/assign‐
3369 ments/enterprise-numbers
3370 ~/.local/usr/share/misc/enterprise-numbers
3372 user's override for the system IANA PEN registry, this file if
3373 it exists is loaded instead of the system registry (see above).
3374
3377 Originally written by Duncan Laurie <duncan@iceblink.org>.
3378 Numerous contributors over time.
3379
3382 Any bugs found in ipmitool please report via GitHub issue system at
3383 https://github.com/ipmitool/ipmitool/issues
3384
3387 IPMItool Homepage
3388 http://github.com/ipmitool/ipmitool
3389 Intelligent Platform Management Interface Specification
3391 http://www.intel.com/design/servers/ipmi
3392 OpenIPMI Homepage
3394 http://openipmi.sourceforge.net
3395 FreeIPMI Homepage
3397 http://www.gnu.org/software/freeipmi/
3398Duncan Laurie ipmitool(1)