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 included 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 IPMI_KGKEY environment variable.
126 -l <lun>
128 Set destination lun for raw commands.
129 -L <privlvl>
131 Force session privilege level. Can be CALLBACK, USER, OPERATOR,
132 ADMINISTRATOR. Default is ADMINISTRATOR. This value is ignored
133 and always set to ADMINISTRATOR when combined with -t target
134 address.
135 -m <local_address>
137 Set the local IPMB address. The local address defaults to 0x20
138 or is auto discovered on PICMG platforms when -m is not speci‐
139 fied. There should be no need to change the local address for
140 normal operation.
141 -N <sec>
143 Specify nr. of seconds between retransmissions of lan/lanplus
144 messages. Defaults are 2 seconds for lan and 1 second for lan‐
145 plus interfaces. Command raw uses fixed value of 15 seconds.
146 Command sol uses fixed value of 1 second.
147 -o <oemtype>
149 Select OEM type to support. This usually involves minor hacks
150 in place in the code to work around quirks in various BMCs from
151 various manufacturers. Use -o list to see a list of current
152 supported OEM types.
153 -O <sel oem>
155 Open selected file and read OEM SEL event descriptions to be
156 used during SEL listings. See examples in contrib dir for file
157 format.
158 -p <port>
160 Remote server UDP port to connect to. Default is 623.
161 -P <password>
163 Remote server password is specified on the command line. If
164 supported it will be obscured in the process list. Note! Speci‐
165 fying the password as a command line option is not recommended.
166 -R <count>
168 Set the number of retries for lan/lanplus interface (default=4).
169 Command raw uses fixed value of one try (no retries). Command
170 hpm uses fixed value of 10 retries.
171 -s Deprecated. Use: -o supermicro
173 -S <sdr_cache_file>
175 Use local file for remote SDR cache. Using a local SDR cache
176 can drastically increase performance for commands that require
177 knowledge of the entire SDR to perform their function. Local
178 SDR cache from a remote system can be created with the sdr dump
179 command.
180 -t <target_address>
182 Bridge IPMI requests to the remote target address. Default is
183 32. The -L privlvl option is always ignored and value set to
184 ADMINISTRATOR.
185 -T <address>
187 Set transit address for bridge request (dual bridge).
188 -T <transmit_address>
190 Set transit address for bridge request. (dual bridge)
191 -U <username>
193 Remote server username, default is NULL user.
194 -v Increase verbose output level. This option may be specified
196 multiple times to increase the level of debug output. If given
197 three times you will get hexdumps of all incoming and outgoing
198 packets. Using it five times provides details on request and
199 expected reply procesing. The hpm commands targetcap compprop
200 abort upgstatus rollback rollbackstatus selftestresult increases
201 the verbosity level
202 -V Display version information.
204 -y <hex key>
206 Use supplied Kg key for IPMIv2.0 authentication. The key is
207 expected in hexadecimal format and can be used to specify keys
208 with non-printable characters. E.g. '-k PASSWORD' and '-y
209 50415353574F5244' are equivalent. The default is not to use any
210 Kg key.
211 -Y Prompt for the Kg key for IPMIv2.0 authentication.
213 -z <size>
215 Change Size of Communication Channel. (OEM)
216 If no password method is specified then ipmitool will prompt the user
219 for a password. If no password is entered at the prompt, the remote
220 server password will default to NULL.
221
223 There are several security issues be be considered before enabling the
224 IPMI LAN interface. A remote station has the ability to control a sys‐
225 tem's power state as well as being able to gather certain platform
226 information. To reduce vulnerability it is strongly advised that the
227 IPMI LAN interface only be enabled in 'trusted' environments where sys‐
228 tem security is not an issue or where there is a dedicated secure 'man‐
229 agement network'.
230 Further it is strongly advised that you should not enable IPMI for
232 remote access without setting a password, and that that password should
233 not be the same as any other password on that system.
234 When an IPMI password is changed on a remote machine with the IPMIv1.5
236 lan interface the new password is sent across the network as clear
237 text. This could be observed and then used to attack the remote sys‐
238 tem. It is thus recommended that IPMI password management only be done
239 over IPMIv2.0 lanplus interface or the system interface on the local
240 station.
241 For IPMI v1.5, the maximum password length is 16 characters. Passwords
243 longer than 16 characters will be truncated.
244 For IPMI v2.0, the maximum password length is 20 characters; longer
246 passwords are truncated.
247
249 help This can be used to get command-line help on ipmitool com‐
250 mands. It may also be placed at the end of commands to get
251 option usage help.
252 ipmitool help
254 Commands:
255 bmc Deprecated. Use mc
256 channel Configure Management Controller channels
257 chassis Get chassis status and set power state
258 dcmi Data Center Management Interface
259 delloem Manage Dell OEM Extensions.
260 echo Used to echo lines to stdout in scripts
261 ekanalyzer run FRU-Ekeying analyzer using FRU files
262 event Send events to MC
263 exec Run list of commands from file
264 firewall Configure Firmware Firewall
265 fru Print built-in FRU and scan for FRU loca‐
266 tors
267 fwum Update IPMC using Kontron OEM Firmware
268 Update Manager
269 gendev Read/Write Device associated with Generic
270 Device locators sdr
271 hpm Update HPM components using PICMG HPM.1
272 file
273 i2c Send an I2C Master Write-Read command and
274 print response
275 ime Upgrade/Query Intel ME firmware
276 isol Configure and connect Intel IPMIv1.5
277 Serial-over-LAN
278 kontronoem Manage Kontron OEM Extensions
279 lan Configure LAN Channels
280 mc Management Controller status and global
281 enables
282 nm Node Manager
283 pef Configure Platform Event Filtering (PEF)
284 picmg Run a PICMG/ATA extended command
285 power Shortcut to chassis power commands
286 raw Send a RAW IPMI request and print response
287 sdr Print Sensor Data Repository entries and
288 readings
289 sel Print System Event Log (SEL)
290 sensor Print detailed sensor information
291 session Print session information
292 set Set runtime variable for shell and exec
293 shell Launch interactive IPMI shell
294 sol Configure and connect IPMIv2.0
295 Serial-over-LAN
296 spd Print SPD info from remote I2C device
297 sunoem Manage Sun OEM Extensions
298 tsol Configure and connect Tyan IPMIv1.5
299 Serial-over-LAN
300 user Configure Management Controller users
301 channel
304 authcap <channel number> <max priv>
306 Displays information about the authentication capabili‐
308 ties of the selected channel at the specified privilege
309 level.
310 Possible privilege levels are:
312 1 Callback level
313 2 User level
314 3 Operator level
315 4 Administrator level
316 5 OEM Proprietary level
317 15 No access
318 info [channel number]
320 Displays information about the selected channel. If
322 no channel is given it will display information about the
323 currently used channel.
324 > ipmitool channel info
326 Channel 0xf info:
327 Channel Medium Type : System Interface
328 Channel Protocol Type : KCS
329 Session Support : session-less
330 Active Session Count : 0
331 Protocol Vendor ID : 7154
332 getaccess <channel number> [<userid>]
334 Configure the given userid as the default on the given
336 channel number. When the given channel is subsequently
337 used, the user is identified implicitly by the given
338 userid.
339 setaccess <channel number> <userid> [<callin=on|off>]
341 [<ipmi=on|off>] [<link=on|off>] [<privi‐
342 lege=level>]
343 Configure user access information on the given
345 channel for the given userid.
346 getciphers <ipmi|sol> [<channel>]
348 Displays the list of cipher suites supported for
350 the given application (ipmi or sol) on the given
351 channel.
352 setkg <hex|plain> <key> [<channel>]
354 Sets K_g key to given value. Use plain to specify
356 key as simple ASCII string. Use hex to specify
357 key as sequence of hexadecimal codes of ASCII
358 charactes. I.e. following two examples are equiv‐
359 alent:
360 ipmitool channel setkg plain PASSWORD
362 ipmitool channel setkg hex 50415353574F5244
364 chassis
367 status
369 Status information related to power, buttons, cooling,
371 drives and faults.
372 power
374 status
376 on
378 off
380 cycle
382 reset
384 diag
386 soft
388 identify [<seconds>|force]
390 Identify interval.
392 Default is 15 seconds.
393 0 - Off
394 force - To turn on indefinitely
395 policy
397 What to do when power is restored.
399 list
401 Show available options.
403 always-on
405 previous
407 always-off
409 restart_cause
412 Last restart cause.
414 poh
416 Get power on hours.
418 bootdev
420 none
422 Do not change boot device order.
424 pxe
426 Force PXE boot.
428 disk
430 Force boot from default Hard-drive.
432 safe
434 Force boot from default Hard-drive, request Safe
436 Mode.
437 diag
439 Force boot from Diagnostic Partition.
441 cdrom
443 Force boot from CD/DVD.
445 bios
447 Force boot into BIOS Setup.
449 floppy
451 Force boot from Floppy/primary removable media.
453 bootparam
455 force_pxe
457 Force PXE boot
459 force_disk
461 Force boot from default Hard-drive
463 force_safe
465 Force boot from default Hard-drive, request Safe
467 Mode
468 force_diag
470 Force boot from Diagnostic Partition
472 force_cdrom
474 Force boot from CD/DVD
476 force_bios
478 Force boot into BIOS Setup
480 selftest
482 dcmi
484 discover
486 This command is used to discover supported capabilities
488 in DCMI.
489 power <command>
492 Platform power limit command options are:
494 reading
497 Get power related readings from the system.
499 get_limit
501 Get the configured power limits.
503 set_limit <parameter> <value>
505 Set a power limit option.
507 Possible parameters/values are:
510 action <No Action | Hard Power Off & Log Event to
513 SEL | Log Event to SEL>
514 Exception Actions are taken as "No Action",
516 "Hard Power Off system and log events to
517 SEL", or "Log event to SEL only".
518 limit <number in Watts>
520 Power Limit Requested in Watts.
522 correction <number in milliseconds>
524 Correction Time Limit in milliseconds.
526 sample <number in seconds>
528 Statistics Sampling period in seconds.
530 activate
533 Activate the set power limit.
535 deactivate
537 Deactivate the set power limit.
539 sensors
541 Prints the available DCMI sensors.
543 asset_tag
545 Prints the platforms asset tag.
547 set_asset_tag <string>
549 Sets the platforms asset tag
551 get_mc_id_string
553 Get management controller identifier string.
555 set_mc_id_string <string>
557 Set management controller identifier string. The maximum
559 length is 64 bytes including a null terminator.
560 thermalpolicy [<get | set>]
562 Thermal Limit policy get/set.
564 The commands are:
567 Get <entityID> <instanceID>
570 Get Thermal Limit values.
572 entityID is the physical entity that a sensor or
574 device is associated with. instanceID is a par‐
575 ticular instance of an entity. Entity Instance
576 can be in one of two ranges, system-relative or
577 device-relative. For example, a system with four
578 processors could use an Entity Instance value of
579 "0" to identify the first processor.
580 Set <entityID> <instanceID>
582 Set Thermal Limit values.
584 entityID is the physical entity that a sensor or
586 device is associated with. instanceID is a par‐
587 ticular instance of an entity. Entity Instance
588 can be in one of two ranges, system-relative or
589 device-relative. For example, a system with four
590 processors could use an Entity Instance value of
591 "0" to identify the first processor.
592 get_temp_reading
594 Get Temperature Sensor Readings.
596 get_conf_param
598 Get DCMI Configuration Parameters.
600 set_conf_param <parameters>
602 Set DCMI Configuration Parameters.
604 The Configuration Parameters are:
606 activate_dhcp
608 Activate/restart DHCP
610 dhcp_config
612 Discover DHCP Configuration.
614 init
616 Set DHCP Initial timeout interval, in seconds.
618 The recommended default is four seconds.
619 timeout
621 Set DHCP Server contact timeout interval, in sec‐
623 onds. The recommended default timeout is two min‐
624 utes.
625 retry
627 Set DHCP Server contact retry interval, in sec‐
629 onds. The recommended default timeout is sixty-
630 four seconds.
631 oob_discover
633 Ping/Pong Message for DCMI Discovery.
635 delloem
638 The delloem commands provide information on Dell-specific fea‐
640 tures.
641 setled {b:d.f} {state..}
643 Sets the drive backplane LEDs for a device.
645 {b:d.f} = PCI Address of device (eg. 06:00.0)
646 {state} = one or more of the following:
647 online | present | hotspare | identify | rebuild‐
648 ing | fault | predict | critical | failed
649 lcd
652 set {mode}|{lcdqualifier}|{errordisplay}
653 Allows you to set the LCD mode and user-defined
655 string.
656 lcd set mode
658 {none}|{modelname}|{ipv4address}|{macaddress}|
659 {systemname}|{servicetag}|{ipv6address}|
660 {ambienttemp}|{systemwatt}|{assettag}|
661 {userdefined}<text>
662 Allows you to set the LCD display mode to any of
664 the preceding parameters.
665 lcd set lcdqualifier
668 {watt}|{btuphr}|
669 {celsius}|{fahrenheit}
670 Allows you to set the unit for the system ambient
672 temperature mode.
673 lcd set errordisplay
676 {sel}|{simple}
677 Allows you to set the error display.
679 lcd info
681 Displays the LCD screen information.
683 lcd set vkvm
685 {active}|{inactive}
686 Allows you to set the vKVM status to active or
688 inactive. When it is active and session is in
689 progress, a message appears on LCD.
690 lcd status
692 Displays the LCD status for vKVM display active or
694 inactive and Front Panel access mode (viewandmod‐
695 ify, view-only or disabled).
696 mac
698 Displays the information about the system NICs.
700 mac list
702 Displays the NIC MAC address and status of all
704 NICs. It also displays the DRAC/iDRAC MAC address.
705 mac get
708 <NIC number>
709 Displays the selected NICs MAC address and status.
711 lan
713 Displays the information of Lan.
714 lan set
717 <Mode>
718 Sets the NIC selection mode (dedicated, shared
720 with lom1, shared with lom2,shared with
721 lom3,shared with lom4,shared with failover
722 lom1,shared with failover lom2,shared with
723 failover lom3,shared with failover lom4,shared
724 with Failover all loms, shared with Failover
725 None).
726 lan get
728 Returns the current NIC selection mode (dedicated,
730 shared with lom1, shared with lom2, shared with
731 lom3, shared with lom4,shared with failover lom1,
732 shared with failover lom2,shared with failover
733 lom3,shared with failover lom4,shared with
734 Failover all loms,shared with Failover None).
735 lan get active
738 Returns the current active NIC (dedicated, LOM1,
740 LOM2, LOM3 or LOM4).
741 powermonitor
743 Displays power tracking statistics.
745 powermonitor clear cumulativepower
748 Reset cumulative power reading.
750 powermonitor clear peakpower
752 Reset peak power reading.
754 powermonitor powerconsumption
756 <watt>|<btuphr>
757 Displays the power consumption in watt or btuphr.
758 powermonitor powerconsumptionhistory
760 <watt>|<btuphr>
761 Displays the power consumption history in watt or
762 btuphr.
763 powermonitor getpowerbudget
765 <watt>|<btuphr>
766 Displays the power cap in watt or btuphr.
767 powermonitor setpowerbudget
769 <val><watt|btuphr|percent>
770 Allows you to set the power cap in watt, BTU/hr
771 or percentage.
772 powermonitor enablepowercap
774 Enables set power cap.
775 powermonitor disablepowercap
777 Disables set power cap.
779 vFlash info Card
782 Shows Extended SD Card information.
784 echo
786 For echoing lines to stdout in scripts.
788 ekanalyzer <command> <xx=filename1> <xx=filename2> [<rc=filename3>] ...
790 NOTE : This command can support a maximum of 8 files per command
792 line
793 filename1 : binary file that stores FRU data of a Carrier or an
795 AMC module
796 filename2 : binary file that stores FRU data of an AMC module.
798 These binary files can be generated from command:
799 ipmitool fru read <id> <filename>
800 filename3 : configuration file used for configuring On-Carrier
802 Device ID
803 or OEM GUID. This file is optional.
804 xx : indicates the type of the file. It can take the following
806 value:
807 oc : On-Carrier device
809 a1 : AMC slot A1
811 a2 : AMC slot A2
813 a3 : AMC slot A3
815 a4 : AMC slot A4
817 b1 : AMC slot B1
819 b2 : AMC slot B2
821 b3 : AMC slot B3
823 b4 : AMC slot B4
825 sm : Shelf Manager
827 The available commands for ekanalyzer are:
830 print [<carrier | power | all>]
833 carrier (default) <oc=filename1> <oc=filename2> ...
835 Display point to point physical connectivity
837 between carriers and AMC modules.
838 Example:
839 > ipmitool ekanalyzer print carrier oc=fru
840 oc=carrierfru
841 From Carrier file: fru
842 Number of AMC bays supported by Carrier: 2
843 AMC slot B1 topology:
844 Port 0 =====> On Carrier Device ID 0,
845 Port 16
846 Port 1 =====> On Carrier Device ID 0,
847 Port 12
848 Port 2 =====> AMC slot B2, Port 2
849 AMC slot B2 topology:
850 Port 0 =====> On Carrier Device ID 0,
851 Port 3
852 Port 2 =====> AMC slot B1, Port 2
853 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
854 From Carrier file: carrierfru
855 On Carrier Device ID 0 topology:
856 Port 0 =====> AMC slot B1, Port 4
857 Port 1 =====> AMC slot B1, Port 5
858 Port 2 =====> AMC slot B2, Port 6
859 Port 3 =====> AMC slot B2, Port 7
860 AMC slot B1 topology:
861 Port 0 =====> AMC slot B2, Port 0
862 AMC slot B1 topology:
863 Port 1 =====> AMC slot B2, Port 1
864 Number of AMC bays supported by Carrier: 2
865 power <xx=filename1> <xx=filename2> ...
868 Display power supply information between carrier
870 and AMC modules.
871 all <xx=filename> <xx=filename> ...
873 Display both physical connectivity and power sup‐
875 ply of each carrier and AMC modules.
876 frushow <xx=filename>
879 Convert a binary FRU file into human readable text for‐
880 mat. Use -v option to get more display information.
881 summary [<match | unmatch | all>]
884 match (default) <xx=filename> <xx=filename> ...
886 Display only matched results of Ekeying match
887 between an On-Carrier device and an AMC module or
888 between 2 AMC modules. Example:
889 > ipmitool ekanalyzer summary match oc=fru
890 b1=amcB1 a2=amcA2
891 On-Carrier Device vs AMC slot B1
892 AMC slot B1 port 0 ==> On-Carrier Device 0 port
893 16
894 Matching Result
895 - From On-Carrier Device ID 0
896 -Channel ID 11 || Lane 0: enable
897 -Link Type: AMC.2 Ethernet
898 -Link Type extension: 1000BASE-BX (SerDES
899 Gigabit) Ethernet link
900 -Link Group ID: 0 || Link Asym. Match: exact
901 match
902 - To AMC slot B1
903 -Channel ID 0 || Lane 0: enable
904 -Link Type: AMC.2 Ethernet
905 -Link Type extension: 1000BASE-BX (SerDES
906 Gigabit) Ethernet link
907 -Link Group ID: 0 || Link Asym. Match: exact
908 match
909 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
910 AMC slot B1 port 1 ==> On-Carrier Device 0 port
911 12
912 Matching Result
913 - From On-Carrier Device ID 0
914 -Channel ID 6 || Lane 0: enable
915 -Link Type: AMC.2 Ethernet
916 -Link Type extension: 1000BASE-BX (SerDES
917 Gigabit) Ethernet link
918 -Link Group ID: 0 || Link Asym. Match: exact
919 match
920 - To AMC slot B1
921 -Channel ID 1 || Lane 0: enable
922 -Link Type: AMC.2 Ethernet
923 -Link Type extension: 1000BASE-BX (SerDES
924 Gigabit) Ethernet link
925 -Link Group ID: 0 || Link Asym. Match: exact
926 match
927 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
928 On-Carrier Device vs AMC slot A2
929 AMC slot A2 port 0 ==> On-Carrier Device 0 port
930 3
931 Matching Result
932 - From On-Carrier Device ID 0
933 -Channel ID 9 || Lane 0: enable
934 -Link Type: AMC.2 Ethernet
935 -Link Type extension: 1000BASE-BX (SerDES
936 Gigabit) Ethernet link
937 -Link Group ID: 0 || Link Asym. Match: exact
938 match
939 - To AMC slot A2
940 -Channel ID 0 || Lane 0: enable
941 -Link Type: AMC.2 Ethernet
942 -Link Type extension: 1000BASE-BX (SerDES
943 Gigabit) Ethernet link
944 -Link Group ID: 0 || Link Asym. Match: exact
945 match
946 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
947 AMC slot B1 vs AMC slot A2
948 AMC slot A2 port 2 ==> AMC slot B1 port 2
949 Matching Result
950 - From AMC slot B1
951 -Channel ID 2 || Lane 0: enable
952 -Link Type: AMC.3 Storage
953 -Link Type extension: Serial Attached SCSI
954 (SAS/SATA)
955 -Link Group ID: 0 || Link Asym. Match: FC or
956 SAS interface {exact match}
957 - To AMC slot A2
958 -Channel ID 2 || Lane 0: enable
959 -Link Type: AMC.3 Storage
960 -Link Type extension: Serial Attached SCSI
961 (SAS/SATA)
962 -Link Group ID: 0 || Link Asym. Match: FC or
963 SAS interface {exact match}
964 *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
965 unmatch <xx=filename> <xx=filename> ...
967 Display the unmatched results of Ekeying match
969 between an On-Carrier device and an AMC module or
970 between 2 AMC modules
971 all <xx=filename> <xx=filename> ...
973 Display both matched result and unmatched results
975 of Ekeying match between two cards or two modules.
976 event
978 <predefined event number N>
980 Send a pre-defined test event to the System Event Log.
982 The following events are included as a means to test the
983 functionality of the System Event Log component of the
984 BMC (an entry will be added each time the event N command
985 is executed).
986 Currently supported values for N are:
988 1 Temperature: Upper Critical: Going High
989 2 Voltage Threshold: Lower Critical: Going Low
990 3 Memory: Correctable ECC
991 NOTE: These pre-defined events will likely not produce
993 "accurate" SEL records for a particular system because
994 they will not be correctly tied to a valid sensor number,
995 but they are sufficient to verify correct operation of
996 the SEL.
997 file <filename>
1000 Event log records specified in <filename> will be added
1002 to the System Event Log.
1003 The format of each line in the file is as follows:
1005 <{EvM Revision} {Sensor Type} {Sensor Num} {Event
1007 Dir/Type} {Event Data 0} {Event Data 1} {Event Data 2}>[#
1008 COMMENT]
1009 e.g.: 0x4 0x2 0x60 0x1 0x52 0x0 0x0 # Voltage threshold:
1011 Lower Critical: Going Low
1012 EvM Revision - The "Event Message Revision" is 0x04 for
1014 messages that comply with the IPMI 2.0 Specification and
1015 0x03 for messages that comply with the IPMI 1.0 Specifi‐
1016 cation.
1017 Sensor Type - Indicates the Event Type or Class.
1019 Sensor Num - Represents the 'sensor' within the manage‐
1021 ment controller that generated the Event Message.
1022 Event Dir/Type - This field is encoded with the event
1024 direction as the high bit (bit 7) and the event type as
1025 the low 7 bits. Event direction is 0 for an assertion
1026 event and 1 for a deassertion event.
1027 See the IPMI 2.0 specification for further details on the
1029 definitions for each field.
1030 <sensorid> <list>
1033 Get a list of all the possible Sensor States and pre-
1035 defined Sensor State Shortcuts available for a particular
1036 sensor. sensorid is the character string representation
1037 of the sensor and must be enclosed in double quotes if it
1038 includes white space. Several different commands includ‐
1039 ing ipmitool sensor list may be used to obtain a list
1040 that includes the sensorid strings representing the sen‐
1041 sors on a given system.
1042 > ipmitool -I open event "PS 2T Fan Fault" list
1044 Finding sensor PS 2T Fan Fault... ok
1045 Sensor States:
1046 State Deasserted
1047 State Asserted
1048 Sensor State Shortcuts:
1049 present absent
1050 assert deassert
1051 limit nolimit
1052 fail nofail
1053 yes no
1054 on off
1055 up down
1056 <sensorid> <sensor state> [<direction>]
1059 Generate a custom event based on existing sensor informa‐
1061 tion. The optional event direction can be either assert
1062 (the default) or deassert.
1063 > ipmitool event "PS 2T Fan Fault" "State Asserted"
1066 Finding sensor PS 2T Fan Fault... ok
1067 0 | Pre-Init Time-stamp | Fan PS 2T Fan Fault |
1068 State Asserted
1069 > ipmitool event "PS 2T Fan Fault" "State Deasserted"
1071 Finding sensor PS 2T Fan Fault... ok
1072 0 | Pre-Init Time-stamp | Fan PS 2T Fan Fault |
1073 State Desserted
1074 exec <filename>
1076 Execute ipmitool commands from filename. Each line is a com‐
1078 plete command. The syntax of the commands are defined by the
1079 COMMANDS section in this manpage. Each line may have an
1080 optional comment at the end of the line, delimited with a `#'
1081 symbol.
1082 e.g., a command file with two lines:
1084 sdr list # get a list of sdr records
1086 sel list # get a list of sel records
1087 firewall
1089 This command supports the Firmware Firewall capability. It may
1091 be used to add or remove security-based restrictions on certain
1092 commands/command sub-functions or to list the current firmware
1093 firewall restrictions set on any commands. For each firmware
1094 firewall command listed below, parameters may be included to
1095 cause the command to be executed with increasing granularity on
1096 a specific LUN, for a specific NetFn, for a specific IPMI Com‐
1097 mand, and finally for a specific command's sub-function (see Ap‐
1098 pendix H in the IPMI 2.0 Specification for a listing of any sub-
1099 function numbers that may be associated with a particular com‐
1100 mand).
1101 Parameter syntax and dependencies are as follows:
1103 [<channel H>] [<lun L> [ <netfn N> [<command C [<subfn S>]]]]
1105 Note that if "netfn <N>" is specified, then "lun <L>" must also
1107 be specified; if "command <C>" is specified, then "netfn <N>"
1108 (and therefore "lun <L>") must also be specified, and so forth.
1109 "channel <H>" is an optional and standalone parameter. If not
1111 specified, the requested operation will be performed on the cur‐
1112 rent channel. Note that command support may vary from channel
1113 to channel.
1114 Firmware firewall commands:
1116 info [<Parms as described above>]
1118 List firmware firewall information for the specified LUN,
1120 NetFn, and Command (if supplied) on the current or speci‐
1121 fied channel. Listed information includes the support,
1122 configurable, and enabled bits for the specified command
1123 or commands.
1124 Some usage examples:
1126 info [<channel H>] [<lun L>]
1128 This command will list firmware firewall informa‐
1130 tion for all NetFns for the specified LUN on
1131 either the current or the specified channel.
1132 info [<channel H>] [<lun L> [ <netfn N> ]
1134 This command will print out all command informa‐
1136 tion for a single LUN/NetFn pair.
1137 info [<channel H>] [<lun L> [ <netfn N> [<command C] ]]
1139 This prints out detailed, human-readable informa‐
1141 tion showing the support, configurable, and
1142 enabled bits for the specified command on the
1143 specified LUN/NetFn pair. Information will be
1144 printed about each of the command subfunctions.
1145 info [<channel H>] [<lun L> [ <netfn N> [<command C
1147 [<subfn S>]]]]
1148 Print out information for a specific sub-function.
1150 enable [<Parms as described above>]
1152 This command is used to enable commands for a given
1154 NetFn/LUN combination on the specified channel.
1155 disable [<Parms as described above>] [force]
1157 This command is used to disable commands for a given
1159 NetFn/LUN combination on the specified channel. Great
1160 care should be taken if using the "force" option so as
1161 not to disable the "Set Command Enables" command.
1162 reset [<Parms as described above>]
1164 This command may be used to reset the firmware firewall
1166 back to a state where all commands and command sub-func‐
1167 tions are enabled.
1168 fru
1170 print
1172 Read all Field Replaceable Unit (FRU) inventory data
1174 and extract such information as serial number, part num‐
1175 ber, asset tags, and short strings describing the chas‐
1176 sis, board, or product.
1177 read <fru id> <fru file>
1179 fru id is the digit ID of the FRU (see output of 'fru
1181 print'). fru file is the absolute pathname of a file in
1182 which to dump the binary FRU data pertaining to the spec‐
1183 ified FRU entity.
1184 write <fru id> <fru file>
1186 fru id is the digit ID of the FRU (see output of 'fru
1188 print'). fru file is the absolute pathname of a file
1189 from which to pull the binary FRU data before uploading
1190 it to the specified FRU.
1191 upgEkey <fru id> <fru file>
1193 Update a multirecord FRU location. fru id is the digit
1195 ID of the FRU (see output of 'fru print'). fru file is
1196 the absolute pathname of a file from which to pull the
1197 binary FRU data to upload into the specified multirecord
1198 FRU entity.
1199 edit <fru id>
1202 This command provides interactive editing of some sup‐
1204 ported records, namely PICMG Carrier Activation Record.
1205 fru id is the digit ID of the FRU (see output of 'fru
1206 print'); default is 0.
1207 edit <fru id> field <section> <index> <string>
1210 This command may be used to set a field string to a new
1212 value. It replaces the FRU data found at index in the
1213 specified section with the supplied string.
1214 fru id is the digit ID of the FRU (see output of 'fru
1217 print').
1218 <section> is a string which refers to FRU Inventory
1221 Information
1222 Storage Areas and may be refer to:
1223 c FRU Inventory Chassis Info Area
1225 b FRU Inventory Board Info Area
1227 p FRU Inventory Product Info Area
1229 <index> specifies the field number. Field numbering
1232 starts on the first 'english text' field type. For
1233 instance in the <board> info area field '0' is <Board
1234 Manufacturer> and field '2' is <Board Serial Number>; see
1235 IPMI Platform Management FRU Information Storage Defini‐
1236 tion v1.0 R1.1 for field locations.
1237 <string> must be the same length as the string being
1240 replaced and must be 8-bit ASCII (0xCx).
1241 edit <fru id> oem iana <record> <format> [<args>]
1245 This command edits the data found in the multirecord
1247 area. Support for OEM specific records is limited.
1248 fwum
1250 Update IPMC using Kontron OEM Firmware Update Manager.
1251 info
1253 Show information about current firmware.
1254 status
1257 Show status of each firmware bank present in the hard‐
1258 ware.
1259 download <filename>
1262 Download specified firmware.
1264 upgrade [filename]
1267 Install firmware upgrade. If the filename is specified,
1269 the file is downloaded first, otherwise the last firmware
1270 downloaded is used.
1271 rollback
1274 Ask IPMC to rollback to previous version.
1276 tracelog
1279 Show firmware upgrade log.
1281 gendev
1284 list
1286 List All Generic Device Locators.
1288 read <sdr name> <file>
1290 Read to file eeprom specify by Generic Device Locators.
1292 write <sdr name> <file>
1294 Write from file eeprom specify by Generic Device Locators
1296 hpm
1298 PICMG HPM.1 Upgrade Agent
1299 check
1301 Check the target information.
1302 check <filename>
1305 Display both the existing target version and image ver‐
1306 sion on the screen.
1307 download <filename>
1310 Download specified firmware.
1312 upgrade <filename> [all] [component <x>] [activate]
1315 Upgrade the firmware using a valid HPM.1 image file. If
1316 no option is specified, the firmware versions are checked
1317 first and the firmware is upgraded only if they are dif‐
1318 ferent.
1319 all
1322 Upgrade all components even if the firmware ver‐
1323 sions are the same (use this only after using
1324 "check" command).
1325 component <x>
1328 Upgrade only given component from the given file.
1329 component 0 - BOOT
1330 component 1 - RTK
1331 activate
1334 Activate new firmware right away.
1335 activate
1339 Activate the newly uploaded firmware.
1341 targetcap
1344 Get the target upgrade capabilities.
1346 compprop <id> <select>
1349 Get the specified component properties. Valid component
1350 id: 0-7. Select can be one of following:
1351 0 - General properties
1352 1 - Current firmware version
1353 2 - Description string
1354 3 - Rollback firmware version
1355 4 - Deferred firmware version
1356 abort
1359 Abort the on-going firmware upgrade.
1361 upgstatus
1364 Show status of the last long duration command.
1365 rollback
1368 Perform manual rollback on the IPM Controller firmware.
1369 rollbackstatus
1372 Show the rollback status.
1374 selftestresult
1377 Query the self test results.
1379 i2c <i2caddr> <read bytes> [<write data>]
1382 This command may be used to execute raw I2C commands with the
1384 Master Write-Read IPMI command.
1385 ime
1387 help
1389 Print usage information
1391 info
1393 Displays information about the Manageability Engine (ME)
1395 update <file>
1397 Upgrade the ME firmware with the specified image file
1399 WARNING You MUST use a supported image provided by your
1400 board vendor
1401 rollback
1403 Perform manual rollback of the ME firmware
1405 isol
1408 info
1410 Retrieve information about the Intel IPMI v1.5
1412 Serial-Over-LAN configuration.
1413 set <parameter> <value>
1415 Configure parameters for Intel IPMI v1.5 Serial-over-LAN.
1417 Valid parameters and values are:
1419 enabled
1421 true, false.
1422 privilege-level
1424 user, operator, admin, oem.
1425 bit-rate
1427 9.6, 19.2, 38.4, 57.6, 115.2.
1428 activate
1430 Causes ipmitool to enter Intel IPMI v1.5 Serial Over LAN
1432 mode. An RMCP+ connection is made to the BMC, the termi‐
1433 nal is set to raw mode, and user input is sent to the
1434 serial console on the remote server. On exit, the SOL
1435 payload mode is deactivated and the terminal is reset to
1436 its original settings.
1437 Special escape sequences are provided to control the SOL
1439 session:
1440 ~. Terminate connection
1442 ~^Z Suspend ipmitool
1444 ~^X Suspend ipmitool, but don't restore tty
1446 on restart
1447 ~B Send break
1449 ~~ Send the escape character by typing it
1451 twice
1452 ~? Print the supported escape sequences
1454 Note that escapes are only recognized immediately after
1456 newline.
1457 kontronoem
1459 OEM commands specific to Kontron devices.
1461 setsn
1463 Set FRU serial number.
1465 setmfgdate
1467 Set FRU manufacturing date.
1469 nextboot <boot device>
1471 Select the next boot order on the Kontron CP6012.
1473 lan
1475 These commands will allow you to configure IPMI LAN channels
1477 with network information so they can be used with the ipmitool
1478 lan and lanplus interfaces. NOTE: To determine on which channel
1479 the LAN interface is located, issue the `channel info number'
1480 command until you come across a valid 802.3 LAN channel. For
1481 example:
1482 > ipmitool -I open channel info 1
1484 Channel 0x1 info:
1485 Channel Medium Type : 802.3 LAN
1486 Channel Protocol Type : IPMB-1.0
1487 Session Support : session-based
1488 Active Session Count : 8
1489 Protocol Vendor ID : 7154
1490 print [<channel>]
1493 Print the current configuration for the given chan‐
1495 nel. The default will print information on the first
1496 found LAN channel.
1497 set <channel number> <command> <parameter>
1499 Set the given command and parameter on the specified
1501 channel. Valid command/parameter options are:
1502 ipaddr <x.x.x.x>
1504 Set the IP address for this channel.
1506 netmask <x.x.x.x>
1508 Set the netmask for this channel.
1510 macaddr <xx:xx:xx:xx:xx:xx>
1512 Set the MAC address for this channel.
1514 defgw ipaddr <x.x.x.x>
1516 Set the default gateway IP address.
1518 defgw macaddr <xx:xx:xx:xx:xx:xx>
1520 Set the default gateway MAC address.
1522 bakgw ipaddr <x.x.x.x>
1524 Set the backup gateway IP address.
1526 bakgw macaddr <xx:xx:xx:xx:xx:xx>
1528 Set the backup gateway MAC address.
1530 password <pass>
1532 Set the null user password.
1534 snmp <community string>
1536 Set the SNMP community string.
1538 user
1540 Enable user access mode for userid 1 (issue the
1542 `user' command to display information about
1543 userids for a given channel).
1544 access <on|off>
1546 Set LAN channel access mode.
1548 alert <on|off>
1550 Enable or disable PEF alerting for this channel.
1552 ipsrc <source>
1554 Set the IP address source:
1556 none unspecified
1557 static manually configured static IP address
1558 dhcp address obtained by BMC running DHCP
1559 bios address loaded by BIOS or system software
1560 arp respond <on|off>
1562 Set BMC generated ARP responses.
1564 arp generate <on|off>
1566 Set BMC generated gratuitous ARPs.
1568 arp interval <seconds>
1570 Set BMC generated gratuitous ARP interval.
1572 vlan id <off|id>
1574 Disable VLAN operation or enable VLAN and set the
1576 ID.
1577 ID: value of the virtual lan identifier between 1
1578 and 4094 inclusive.
1579 vlan priority <priority>
1581 Set the priority associated with VLAN frames.
1583 ID: priority of the virtual lan frames between 0
1584 and 7 inclusive.
1585 auth <level,...> <type,...>
1587 Set the valid authtypes for a given auth
1589 level.
1590 Levels: callback, user, operator, admin
1591 Types: none, md2, md5, password, oem
1592 cipher_privs <privlist>
1594 Correlates cipher suite numbers with the maximum
1596 privilege level that is allowed to use it. In
1597 this way, cipher suites can restricted to users
1598 with a given privilege level, so that, for exam‐
1599 ple, administrators are required to use a stronger
1600 cipher suite than normal users.
1601 The format of privlist is as follows. Each char‐
1603 acter represents a privilege level and the charac‐
1604 ter position identifies the cipher suite number.
1605 For example, the first character represents cipher
1606 suite 0, the second represents cipher suite 1, and
1607 so on. privlist must be 15 characters in length.
1608 Characters used in privlist and their associated
1610 privilege levels are:
1611 X Cipher Suite Unused
1613 c CALLBACK
1614 u USER
1615 o OPERATOR
1616 a ADMIN
1617 O OEM
1618 So, to set the maximum privilege for cipher suite
1620 0 to USER and suite 1 to ADMIN, issue the follow‐
1621 ing command:
1622 > ipmitool -I interface lan set channel
1624 cipher_privs uaXXXXXXXXXXXXX
1625 bad_pass_thresh <thresh_num> <1|0> <reset_interval>
1629 <lockout_interval>
1630 Sets the Bad Password Threshold.
1632 <thresh_num> If non-zero, this value determines
1634 the number of sequential bad passwords that will
1635 be allowed to be entered for the identified user
1636 before the user is automatically disabled from
1637 access on the channel.
1638 <1|0> 1 = generate a Session Audit sensor "Invalid
1640 password disable" event message. 0 = do not gen‐
1641 erate an event message when the user is disabled.
1642 <reset_interval> Attempt Count Reset Interval. The
1644 interval, in tens of seconds, for which the accu‐
1645 mulated count of bad password attempts is retained
1646 before being automatically reset to zero.
1647 <lockout_interval> User Lockout Interval. The
1649 interval, in tens of seconds, that the user will
1650 remain disabled after being disabled because the
1651 Bad Password Threshold number was reached.
1652 alert print [<channel>] [<alert destination>]
1655 Print alert information for the specified channel and
1657 destination. The default will print all alerts for all
1658 alert destinations on the first found LAN channel.
1659 alert set <channel number> <alert destination> <command> <param‐
1662 eter>
1663 Set an alert on the given LAN channel and destination.
1665 Alert Destinations are listed via the 'lan alert print'
1666 command. Valid command/parameter options are:
1667 ipaddr <x.x.x.x>
1669 Set alert IP address.
1671 macaddr <xx:xx:xx:xx:xx:xx>
1673 Set alert MAC address.
1675 gateway <default | backup>
1677 Set the channel gateway to use for alerts.
1679 ack <on | off>
1681 Set Alert Acknowledge on or off.
1683 type <pet | oem1 | oem2>
1685 Set the destination type as PET or OEM.
1687 time <seconds>
1689 Set ack timeout or unack retry interval.
1691 retry <number>
1693 Set the number of alert retries.
1695 stats get [<channel number>]
1697 Retrieve information about the IP connections on the
1699 specified channel. The default will retrieve statistics
1700 on the first found LAN channel.
1701 stats clear [<channel number>]
1703 Clear all IP/UDP/RMCP Statistics to 0 on the specified
1705 channel. The default will clear statistics on the first
1706 found LAN channel.
1707 mc | bmc
1709 reset <warm|cold>
1711 Instructs the BMC to perform a warm or cold reset.
1713 guid
1715 Display the Management Controller Globally Unique IDenti‐
1717 fier.
1718 info
1720 Displays information about the BMC hardware, including
1722 device revision, firmware revision, IPMI version sup‐
1723 ported, manufacturer ID, and information on additional
1724 device support.
1725 watchdog
1727 These commands allow a user to view and change the cur‐
1729 rent state of the watchdog timer.
1730 get
1732 Show current Watchdog Timer settings and countdown
1734 state.
1735 reset
1737 Reset the Watchdog Timer to its most recent state
1739 and restart the countdown timer.
1740 off
1742 Turn off a currently running Watchdog countdown
1744 timer.
1745 selftest
1747 Check on the basic health of the BMC by executing the Get
1749 Self Test results command and report the results.
1750 getenables
1752 Displays a list of the currently enabled options for the
1754 BMC.
1755 setenables <option>=[on|off]
1757 Enables or disables the given option. This command is
1759 only supported over the system interface according to the
1760 IPMI specification. Currently supported values for
1761 option include:
1762 recv_msg_intr
1764 Receive Message Queue Interrupt
1766 event_msg_intr
1768 Event Message Buffer Full Interrupt
1770 event_msg
1772 Event Message Buffer
1774 system_event_log
1776 System Event Logging
1778 oem0
1780 OEM-Defined option #0
1782 oem1
1784 OEM-Defined option #1
1786 oem2
1788 OEM-Defined option #2
1790 getsysinfo <argument>
1793 Retrieves system info from bmc for given argument.
1794 See setsysinfo for argument definitions
1795 setsysinfo <argument> <string>
1797 Stores system info string to bmc for given argument
1798 Possible arguments are:
1800 primary_os_name Primary Operating System Name
1802 os_name Operating System Name
1804 system_name System Name of Server
1806 delloem_os_version Running version of operating
1808 system
1809 delloem_URL URL of BMC Webserver
1811 chassis
1813 status
1815 Displays information regarding the high-level sta‐
1817 tus of the system chassis and main power subsys‐
1818 tem.
1819 poh
1821 This command will return the Power-On Hours
1823 counter.
1824 identify <interval>
1826 Control the front panel identify light. Default
1828 interval is 15 seconds. Use 0 to turn off. Use
1829 "force" to turn on indefinitely.
1830 restart_cause
1832 Query the chassis for the cause of the last system
1834 restart.
1835 selftest
1837 Check on the basic health of the BMC by executing
1839 the Get Self Test results command and report the
1840 results.
1841 policy
1843 Set the chassis power policy in the event power
1845 failure.
1846 list
1848 Return supported policies.
1850 always-on
1852 Turn on when power is restored.
1854 previous
1856 Returned to previous state when power
1858 is restored.
1859 always-off
1861 Stay off after power is restored.
1863 power
1865 Performs a chassis control command to view and
1867 change the power state.
1868 status
1870 Show current chassis power status.
1872 on
1874 Power up chassis.
1876 off
1878 Power down chassis into soft off (S4/S5
1880 state). WARNING: This command does not
1881 initiate a clean shutdown of the operating
1882 system prior to powering down the system.
1883 cycle
1885 Provides a power off interval of at least 1
1887 second. No action should occur if chassis
1888 power is in S4/S5 state, but it is recom‐
1889 mended to check power state first and only
1890 issue a power cycle command if the system
1891 power is on or in lower sleep state than
1892 S4/S5.
1893 reset
1895 This command will perform a hard reset.
1897 diag
1899 Pulse a diagnostic interrupt (NMI) directly
1901 to the processor(s).
1902 soft
1904 Initiate a soft-shutdown of OS via ACPI.
1906 This can be done in a number of ways, com‐
1907 monly by simulating an overtemperture or by
1908 simulating a power button press. It is
1909 necessary for there to be Operating System
1910 support for ACPI and some sort of daemon
1911 watching for events for this soft power to
1912 work.
1913 bootdev <device> [<clear-cmos=yes|no>]
1915 [<options=help,...>]
1916 Request the system to boot from an alternate boot
1918 device on next reboot. The clear-cmos option, if
1919 supplied, will instruct the BIOS to clear its CMOS
1920 on the next reboot. Various options may be used
1921 to modify the boot device settings. Run "bootdev
1922 none options=help" for a list of available boot
1923 device modifiers/options.
1924 Currently supported values for <device> are:
1927 none
1929 Do not change boot device
1931 pxe
1933 Force PXE boot
1935 disk
1937 Force boot from BIOS default boot device
1939 safe
1941 Force boot from BIOS default boot device,
1943 request Safe Mode
1944 diag
1946 Force boot from diagnostic partition
1948 cdrom
1950 Force boot from CD/DVD
1952 bios
1954 Force boot into BIOS setup
1956 floppy
1958 Force boot from Floppy/primary removable
1960 media
1961 bootparam
1963 Get or set various system boot option parameters.
1965 get <param #>
1967 Get boot parameter. Currently supported
1969 values for <param #> are:
1970 0 - Set In Progress
1972 1 - Service Partition Selector
1974 2 - Service Partition Scan
1976 3 - BMC Boot Flag Valid Bit Clearing
1978 4 - Boot Info Acknowledge
1980 5 - Boot Flags
1982 6 - Boot Initiator Info
1984 7 - Boot Initiator Mailbox
1986 set <device> [<options=help,...>]
1989 Set boot device parameter used for next
1991 boot. Various options may be used to
1992 change when the the next boot device is
1993 cleared. Run "options=help" for a list of
1994 available bootparam set device options.
1995 Currently supported bootparam device set‐
1998 tings are:
1999 force_pxe
2001 Force PXE boot
2003 force_disk
2005 Force boot from default hard-drive
2007 force_safe
2009 Force boot from default hard-drive,
2011 request Safe Mode
2012 force_diag
2014 Force boot from diagnostic partition
2016 force_cdrom
2018 Force boot from CD/DVD
2020 force_bios
2022 Force boot into BIOS setup
2024 Currently supported bootparam options set‐
2027 tings are associated with BMC Boot Valid
2028 Bit Clearing and are as follows: Any
2029 option can be prefixed with "no-" to invert
2030 the sense of the operation.
2031 PEF
2033 Clear valid bit on reset/power cycle
2035 caused by PEF
2036 timeout
2038 Automatically clear boot flag valid
2040 bit if Chassis Control command is
2041 not received within 60 seconds.
2042 watchdog
2044 Clear valid bit on reset/power cycle
2046 caused by watchdog timeout
2047 reset
2049 Clear valid bit on push button reset
2051 / soft-reset
2052 power
2054 Clear valid bit on power up via
2056 power push button or wake event
2057 nm
2060 alert
2062 clear dest <dest>
2064 Clear the Node Manager Alert lan destination.
2066 get
2069 Get the Node Manager Alert settings.
2070 set chan <chan> dest <dest> string <string>
2073 Set the Node Manager alert channel, lan destina‐
2075 tion, and alert string number.
2076 capability
2079 Obtain the Node Manager power control capabilities and
2081 ranges.
2082 control
2085 enable|disable
2087 global
2089 Enable/disable all policies for all
2091 domains.
2092 per_domain <platform|CPU|Memory>
2094 Enable/disable all policies of the speci‐
2096 fied domain.
2097 per_policy <0-7>
2099 Enable/disable the policy for the specified
2101 domain/policy combination.
2102 discover
2104 Discover Node Manager presence as well as the Node Man‐
2106 ager version, revision, and patch number.
2107 policy
2110 add
2112 power <watts> policy_id <0-7> [correction
2114 auto|soft|hard] trig_lim <seconds> stats <seconds>
2115 [domain <platform|CPU|Memory>] enable|disable
2116 Add a new power policy, or overwrite an
2118 existing policy. The correction parameter
2119 is the agressiveness of frequency limiting,
2120 default is auto. The trig_lim is the cor‐
2121 rection time limit and must be at least
2122 6000 and not greater than 65535. The stats
2123 setting is the averaging period in seconds
2124 and ranges from 1-65535. If domain is not
2125 supplied a default of platform is used.
2126 inlet <temp> policy_id <0-7> [correction
2130 auto|soft|hard] trig_lim <seconds> stats <seconds>
2131 [domain <platform|CPU|Memory>] enable|disable
2132 Add a new inlet temp policy, or overwrite
2134 an existing policy. The correction parame‐
2135 ter is the agressiveness of frequency lim‐
2136 iting, default is auto. The trig_lim is
2137 the correction time limit and must be at
2138 least 6000 and not greater than 65535. The
2139 stats setting is the averaging period in
2140 seconds and ranges from 1-65535. If domain
2141 is not supplied a default of platform is
2142 used.
2143 get policy_id <0-7>
2147 Get a previously stored policy.
2149 limiting
2151 Report policy number if any policy is limiting
2153 power.
2154 remove policy_id <0-7> [domain <platform|CPU|Memory>]
2156 Remove a policy. If domain is not supplied a
2158 default of platform is used.
2159 power min <minimum> max <maximum> [domain <platform|CPU|Memory>]
2161 Configure Node Manager power minimum and maximum power
2163 draw limits. The min and max values must be in the range
2164 of 0-65535. If domain is not supplied a default of plat‐
2165 form is used.
2166 reset
2169 comm policy_id <0-7> [domain <platform|CPU|Memory>]
2171 Reset Node Manager communication statistics. If
2173 domain is not supplied a default of platform is
2174 used.
2175 global
2178 Reset Node Manager global statistics.
2180 memory policy_id <0-7> [domain <platform|CPU|Memory>]
2183 Reset Node Manager memory throttling statistics.
2185 If domain is not supplied a default of platform is
2186 used.
2187 per_policy policy_id <0-7> [domain <platform|CPU|Memory>]
2190 Reset Node Manager per policy statistics. If
2192 domain is not supplied a default of platform is
2193 used.
2194 requests policy_id <0-7> [domain <platform|CPU|Memory>]
2197 Reset Node Manager unhandled requests statistics.
2199 If domain is not supplied a default of platform is
2200 used.
2201 response policy_id <0-7> [domain <platform|CPU|Memory>]
2204 Reset Node Manager response time statistics. If
2206 domain is not supplied a default of platform is
2207 used.
2208 throttling policy_id <0-7> [domain <platform|CPU|Memory>]
2211 Reset Node Manager throttling statistics. If
2213 domain is not supplied a default of platform is
2214 used.
2215 statistics
2218 comm_fail
2220 Report Node Manager communication failure statis‐
2222 tics.
2223 cpu_throttling
2226 Report Node Manager cpu throttling statistics.
2228 mem_throttling
2231 Report Node Manager memory throttling statistics.
2233 policy_power policy_id <0-7> [domain <platform|CPU|Mem‐
2236 ory>]
2237 Report Node Manager per policy power statistics
2239 (policy must be a power limit type policy). If
2240 domain is not supplied a default of platform is
2241 used.
2242 policy_temps policy_id <0-7> [domain <platform|CPU|Mem‐
2245 ory>]
2246 Report Node Manager per policy temp statistics
2248 (policy must be an inlet temp limit policy). If
2249 domain is not supplied a default of platform is
2250 used.
2251 policy_throt policy_id <0-7> [domain <platform|CPU|Mem‐
2254 ory>]
2255 Report Node Manager per policy throttling statis‐
2257 tics. If domain is not supplied a default of
2258 platform is used.
2259 requests
2262 Report Node Manager unhandled requests statistics.
2264 response
2267 Report Node Manager response time statistics.
2269 suspend
2272 get policy_id <0-7> [domain <platform|CPU|Memory>]
2274 Get Node Manager policy suspend periods. If
2276 domain is not supplied a default of platform is
2277 used.
2278 set policy_id <0-7> [domain <platform|CPU|Memory>]
2281 <start> <stop> <repeat>
2282 Set Node Manager policy suspend periods. If
2284 domain is not supplied a default of platform is
2285 used. The <start> and <stop> values must be in
2286 the range of 0-239, which is the number of minutes
2287 past midnight divided by 6. The <repeat> value is
2288 the daily recurrence pattern. Bit 0 is repeat
2289 every Monday, bit 1 is repeat every Tuesday, on
2290 through bit 6 for Sunday.
2291 threshold
2294 get policy_id <0-7> [domain <platform|CPU|Memory>]
2296 Get Node Manager policy Alert Threshold settings.
2298 If domain is not supplied a default of platform is
2299 used.
2300 set policy_id <0-7> [domain <platform|CPU|Memory>]
2303 thresh_array
2304 Set Node Manager policy Alert Threshold values.
2306 If domain is not supplied a default of platform is
2307 used. The thresh_array is 1, 2, or 3 integers
2308 that set three alert threshold settings. The set‐
2309 ting type is a power or temperature value which
2310 must match the type of policy.
2311 pef
2315 info
2317 This command will query the BMC and print information
2319 about the PEF supported features.
2320 status
2322 This command prints the current PEF status (the last SEL
2324 entry processed by the BMC, etc).
2325 policy
2327 This command lists the PEF policy table entries. Each
2329 policy entry describes an alert destination. A policy
2330 set is a collection of table entries. PEF alert actions
2331 reference policy sets.
2332 list
2334 This command lists the PEF table entries. Each PEF entry
2336 relates a sensor event to an action. When PEF is active,
2337 each platform event causes the BMC to scan this table for
2338 entries matching the event, and possible actions to be
2339 taken. Actions are performed in priority order (higher
2340 criticality first).
2341 picmg <properties>
2343 Run a PICMG/ATA extended command. Get PICMG properties may be
2345 used to obtain and print Extension major version information,
2346 PICMG identifier, FRU Device ID and Max FRU Device ID.
2347 addrinfo
2349 Get address information. This command may return infor‐
2351 mation on the Hardware address, IPMB-0 Address, FRU ID,
2352 Site/Entity ID, and Site/Entity Type.
2353 frucontrol <fru id> <options>
2355 Set various control options:
2357 0x00 - Cold Reset
2359 0x01 - Warm Reset
2361 0x02 - Graceful Reboot
2363 0x03 - Issue Diagnostic Interrupt
2365 0x04 - Quiesce [AMC only]
2367 0x05-0xFF - Cold Reset
2369 activate <fru id>
2371 Activate the specified FRU.
2373 deactivate <fru id>
2375 Deactivate the specified FRU.
2377 policy get <fru id>
2379 Get FRU activation policy.
2381 policy set <fru id> <lockmask> <lock>
2383 Set FRU activation policy. lockmask is 1 or 0 to indi‐
2385 cate action on the deactivation or activation locked bit
2386 respectively. lock is 1 or 0 to set/clear locked bit.
2387 portstate set|getall|getgranted|getdenied <parameters>
2389 Get or set various port states. See usage for parameter
2390 details.
2391 power <chassis power command>
2393 Shortcut to the chassis power commands. See the chassis power
2395 commands for usage information.
2396 raw <netfn> <cmd> [<data>]
2398 This will allow you to execute raw IPMI commands. For example
2400 to query the POH counter with a raw command:
2401 > ipmitool -v raw 0x0 0xf
2403 RAW REQ (netfn=0x0 cmd=0xf data_len=0)
2404 RAW RSP (5 bytes)
2405 3c 72 0c 00 00
2406 Note that the OpenIPMI driver provided by the Linux kernel will
2408 reject the Get Message, Send Message and Read Event Message Buf‐
2409 fer commands because it handles the message sequencing inter‐
2410 nally.
2411 sdr
2413 get <id> ... [<id>]
2415 Prints information for sensor data records specified by
2417 sensor id.
2418 info
2420 This command will query the BMC for Sensor Data Record
2422 (SDR) Repository information.
2423 type [<sensor type>]
2425 This command will display all records from the SDR Repos‐
2427 itory of a specific type. Run with type list (or simply
2428 with no type) to see the list of available types. For
2429 example to query for all Temperature sensors:
2430 > ipmitool sdr type Temperature
2432 Baseboard Temp | 30h | ok | 7.1 | 28 degrees C
2433 FntPnl Amb Temp | 32h | ok | 12.1 | 24 degrees C
2434 Processor1 Temp | 98h | ok | 3.1 | 57 degrees C
2435 Processor2 Temp | 99h | ok | 3.2 | 53 degrees C
2436 list | elist [<all|full|compact|event|mcloc|fru|generic>]
2439 This command will read the Sensor Data Records (SDR) and
2441 extract sensor information of a given type, then query
2442 each sensor and print its name, reading, and status. If
2443 invoked as elist then it will also print sensor number,
2444 entity id and instance, and asserted discrete states.
2445 The default output will only display full and compact
2447 sensor types, to see all sensors use the all type with
2448 this command.
2449 Valid types are:
2451 all
2453 All SDR records (Sensor and Locator)
2455 full
2457 Full Sensor Record
2459 compact
2461 Compact Sensor Record
2463 event
2465 Event-Only Sensor Record
2467 mcloc
2469 Management Controller Locator Record
2471 fru
2473 FRU Locator Record
2475 generic
2477 Generic SDR records
2479 entity <id>[.<instance>]
2481 Displays all sensors associated with an entity. Get a
2483 list of valid entity ids on the target system by issuing
2484 the sdr elist command. A list of all entity ids can be
2485 found in the IPMI specifications.
2486 dump <file>
2488 Dumps raw SDR data to a file. This data file can then be
2490 used as a local SDR cache of the remote managed system
2491 with the -S <file> option on the ipmitool command line.
2492 This can greatly improve performance over system inter‐
2493 face or remote LAN.
2494 fill sensors
2496 Create the SDR Repository for the current configuration.
2498 Will perform a 'Clear SDR Repository' command so be care‐
2499 ful.
2500 fill file <filename>
2502 Fill the SDR Repository using records stored in a binary
2504 data file. Will perform a 'Clear SDR Repository' command
2505 so be careful.
2506 sel
2508 NOTE: System Event Log (SEL) entry-times are displayed as
2510 `Pre-Init Time-stamp' if the SEL clock needs to be set. Ensure
2511 that the SEL clock is accurate by invoking the sel time get and
2512 sel time set <time string> commands.
2513 info
2515 This command will query the BMC for information about the
2517 System Event Log (SEL) and its contents.
2518 clear
2520 This command will clear the contents of the SEL. It can‐
2522 not be undone so be careful.
2523 list | elist
2525 When this command is invoked without arguments, the
2527 entire contents of the System Event Log are displayed.
2528 If invoked as elist (extended list) it will also use the
2529 Sensor Data Record entries to display the sensor ID for
2530 the sensor that caused each event. Note this can take a
2531 long time over the system interface.
2532 <count> | first <count>
2535 Displays the first count (least-recent) entries in
2537 the SEL. If count is zero, all entries are dis‐
2538 played.
2539 last <count>
2541 Displays the last count (most-recent) entries in
2543 the SEL. If count is zero, all entries are dis‐
2544 played.
2545 delete <SEL Record ID> ... <SEL Record ID>
2547 Delete one or more SEL event records.
2549 add <filename ID>
2551 Read event entries from a file and add them to the SEL.
2553 New SEL entries area added onto the SEL after the last
2554 record in the SEL. Record added is of type 2 and is
2555 automatically timestamped.
2556 get <SEL Record ID>
2558 Print information on the specified SEL Record entry.
2560 save <file>
2562 Save SEL records to a text file that can be fed back into
2564 the event file ipmitool command. This can be useful for
2565 testing Event generation by building an appropriate Plat‐
2566 form Event Message file based on existing events. Please
2567 see the available help for the 'event file ...' command
2568 for a description of the format of this file.
2569 writeraw <file>
2571 Save SEL records to a file in raw, binary format. This
2573 file can be fed back to the sel readraw ipmitool command
2574 for viewing.
2575 readraw <file>
2577 Read and display SEL records from a binary file. Such a
2579 file can be created using the sel writeraw ipmitool com‐
2580 mand.
2581 time
2583 get
2585 Displays the SEL clock's current time.
2586 set <time string>
2588 Sets the SEL clock. Future SEL entries will use
2590 the time set by this command. <time string> is of
2591 the form "MM/DD/YYYY HH:MM:SS". Note that hours
2592 are in 24-hour form. It is recommended that the
2593 SEL be cleared before setting the time.
2594 sensor
2596 list
2598 Lists sensors and thresholds in a wide table format.
2600 get <id> ... [<id>]
2602 Prints information for sensors specified by name.
2604 thresh <id> <threshold> <setting>
2606 This allows you to set a particular sensor threshold
2608 value. The sensor is specified by name.
2609 Valid thresholds are:
2611 unr Upper Non-Recoverable
2612 ucr Upper Critical
2613 unc Upper Non-Critical
2614 lnc Lower Non-Critical
2615 lcr Lower Critical
2616 lnr Lower Non-Recoverable
2617 thresh <id> lower <lnr> <lcr> <lnc>
2619 This allows you to set all lower thresholds for a sensor
2621 at the same time. The sensor is specified by name and
2622 the thresholds are listed in order of Lower Non-Recover‐
2623 able, Lower Critical, and Lower Non-Critical.
2624 thresh <id> upper <unc> <ucr> <unr>
2626 This allows you to set all upper thresholds for a sensor
2628 at the same time. The sensor is specified by name and
2629 the thresholds are listed in order of Upper Non-Critical,
2630 Upper Critical, and Upper Non-Recoverable.
2631 session
2633 info <active|all|id 0xnnnnnnnn|handle 0xnn>
2635 Get information about the specified session(s). You may
2637 identify sessions by their id, by their handle number, by
2638 their active status, or by using the keyword `all' to
2639 specify all sessions.
2640 set
2642 hostname <host>
2644 Session hostname.
2646 username <user>
2648 Session username.
2650 password <pass>
2652 Session password.
2654 privlvl <level>
2656 Session privilege level force.
2658 authtype <type>
2660 Authentication type force.
2662 localaddr <addr>
2664 Local IPMB address.
2666 targetaddr <addr>
2668 Remote target IPMB address.
2670 port <port>
2672 Remote RMCP port.
2674 csv [level]
2676 Enable output in comma separated format. Affects follow‐
2678 ing commands: user, channel, isol, sunoem, sol, sensor,
2679 sdr, sel, session.
2680 verbose [verbose]
2682 Verbosity level.
2684 shell
2686 This command will launch an interactive shell which you can use
2687 to send multiple ipmitool commands to a BMC and see the
2688 responses. This can be useful instead of running the full ipmi‐
2689 tool command each time. Some commands will make use of a Sensor
2690 Data Record cache and you will see marked improvement in speed
2691 if these commands are able to reuse the same cache in a shell
2692 session. LAN sessions will send a periodic keepalive command to
2693 keep the IPMI session from timing out.
2694 sol
2696 info [<channel number>]
2698 Retrieve information about the Serial-Over-LAN configura‐
2700 tion on the specified channel. If no channel is given,
2701 it will display SOL configuration data for the currently
2702 used channel.
2703 payload <enable | disable | status> <channel number> <userid>
2705 Enable, disable or show status of SOL payload for the
2707 user on the specified channel.
2708 set <parameter> <value> [<channel>] [noguard]
2710 Configure parameters for Serial Over Lan. If no channel
2712 is given, it will display SOL configuration data for the
2713 currently used channel. Configuration parameter updates
2714 are automatically guarded with the updates to the
2715 set-in-progress parameter, unless noguard parameter is
2716 present.
2717 Valid parameters and values are:
2719 set-in-progress
2721 set-complete set-in-progress commit-write
2722 enabled
2724 true false
2725 force-encryption
2727 true false
2728 force-authentication
2730 true false
2731 privilege-level
2733 user operator admin oem
2734 character-accumulate-level
2736 Decimal number given in 5 milliseconds increments
2737 character-send-threshold
2739 Decimal number
2740 retry-count
2742 Decimal number. 0 indicates no retries after
2743 packet is transmitted.
2744 retry-interval
2746 Decimal number in 10 millisecond increments. 0
2747 indicates that retries should be sent back to
2748 back.
2749 non-volatile-bit-rate
2751 serial, 19.2, 38.4, 57.6, 115.2. Setting this
2752 value to serial indicates that the BMC should use
2753 the setting used by the IPMI over serial channel.
2754 volatile-bit-rate
2756 serial, 19.2, 38.4, 57.6, 115.2. Setting this
2757 value to serial indicates that the BMC should use
2758 the setting used by the IPMI over serial channel.
2759 activate [usesolkeepalive | nokeepalive] [instance=<number>]
2761 Causes ipmitool to enter Serial Over LAN mode, and is
2763 only available when using the lanplus interface. An
2764 RMCP+ connection is made to the BMC, the terminal is set
2765 to raw mode, and user input is sent to the serial console
2766 on the remote server. On exit, the the SOL payload mode
2767 is deactivated and the terminal is reset to its original
2768 settings.
2769 If the instance is given, it will activate using the
2771 given instance number. The default is 1.
2772 Special escape sequences are provided to control the SOL
2774 session:
2775 ~. Terminate connection
2777 ~^Z Suspend ipmitool
2779 ~^X Suspend ipmitool, but don't restore tty on
2781 restart
2782 ~B Send break
2784 ~~ Send the escape character by typing it twice
2786 ~? Print the supported escape sequences
2788 Note that escapes are only recognized immediately after
2790 newline.
2791 deactivate [instance=<number>]
2793 Deactivates Serial Over LAN mode on the BMC. Exiting
2795 Serial Over LAN mode should automatically cause this com‐
2796 mand to be sent to the BMC, but in the case of an unin‐
2797 tentional exit from SOL mode, this command may be neces‐
2798 sary to reset the state of the BMC.
2799 If the instance is given, it will deactivate the given
2801 instance number. The default is 1.
2802 spd <i2cbus> <i2caddr> [<channel>] [<axread>]
2804 This command may be used to read SPD (Serial Presence Detect)
2806 data using the I2C Master Write-Read IPMI command.
2807 sunoem
2810 cli [<command string> ...]
2812 Execute the service processor command line interface com‐
2814 mands. Without any command string, an interactive ses‐
2815 sion is started in the service processor command line
2816 environment. If a command string is specified, the com‐
2817 mand string is executed on the service processor and the
2818 connection is closed.
2819 led
2821 These commands provide a way to get and set the status of
2823 LEDs on a Sun Microsystems server. Use 'sdr list
2824 generic' to get a list of devices that are controllable
2825 LEDs. The ledtype parameter is optional and not neces‐
2826 sary to provide on the command line unless it is required
2827 by hardware.
2828 get <sensorid> [<ledtype>]
2830 Get status of a particular LED described by a
2832 Generic Device Locator record in the SDR. A sen‐
2833 sorid of all will get the status of all available
2834 LEDS.
2835 set <sensorid> <ledmode> [<ledtype>]
2837 Set status of a particular LED described by a
2839 Generic Device Locator record in the SDR. A sen‐
2840 sorid of all will set the status of all available
2841 LEDS to the specified ledmode and ledtype.
2842 LED Mode is required for set operations:
2844 OFF Off
2845 ON Steady On
2846 STANDBY 100ms on 2900ms off blink rate
2847 SLOW 1HZ blink rate
2848 FAST 4HZ blink rate
2849 LED Type is optional:
2851 OK2RM Ok to Remove
2852 SERVICE Service Required
2853 ACT Activity
2854 LOCATE Locate
2855 nacname <ipmi name>
2858 Return the full NAC name of a target identified by ipmi
2860 name.
2861 ping <count> [<q>]
2863 Send and receive count packets. Each packet is 64 bytes.
2865 q - Quiet. Displays output only at the start and end of
2867 the process.
2868 getval <property name>
2870 Returns value of specified ILOM property.
2872 setval <property name> <property value> [<timeout>]
2874 Sets value of ILOM property. If timeout is not speci‐
2876 fied, the default value is 5 seconds. NOTE: setval must
2877 be executed locally on host!
2878 sshkey
2880 set <userid> <keyfile>
2882 This command will allow you to specify an SSH key
2884 to use for a particular user on the Service Pro‐
2885 cessor. This key will be used for CLI logins to
2886 the SP and not for IPMI sessions. View available
2887 users and their userids with the 'user list' com‐
2888 mand.
2889 del <userid>
2891 This command will delete the SSH key for a speci‐
2893 fied userid.
2894 version
2896 Display the version of ILOM firmware.
2898 getfile <file identifier> <destination file name>
2900 This command will return various files from service pro‐
2902 cessor and store them in specified destination file. Note
2903 that some files may not be present or be supported by
2904 your SP.
2905 File identifiers:
2907 SSH_PUBKEYS
2908 DIAG_PASSED
2909 DIAG_FAILED
2910 DIAG_END_TIME
2911 DIAG_INVENTORY
2912 DIAG_TEST_LOG
2913 DIAG_START_TIME
2914 DIAG_UEFI_LOG
2915 DIAG_TEST_LOG
2916 DIAG_LAST_LOG
2917 DIAG_LAST_CMD
2918 getbehavior <feature identifier>
2921 This command will test if various ILOM features are
2923 enabled.
2924 Feature identifiers:
2926 SUPPORTS_SIGNED_PACKAGES
2927 REQUIRES_SIGNED_PACKAGES
2928 tsol
2930 This command allows Serial-over-LAN sessions to be established
2932 with Tyan IPMIv1.5 SMDC such as the M3289 or M3290. The default
2933 command run with no arguments will establish default SOL session
2934 back to local IP address. Optional arguments may be supplied in
2935 any order.
2936 <ipaddr>
2939 Send receiver IP address to SMDC which it will use to
2941 send serial traffic to. By default this detects the
2942 local IP address and establishes two-way session. Format
2943 of ipaddr is XX.XX.XX.XX
2944 port=NUM
2947 Configure UDP port to receive serial traffic on. By
2949 default this is 6230.
2950 ro|rw
2953 Confiure SOL session as read-only or read-write. Ses‐
2955 sions are read-write by default.
2956 user
2960 summary
2962 Displays a summary of userid information, including maxi‐
2964 mum number of userids, the number of enabled users, and
2965 the number of fixed names defined.
2966 list
2968 Displays a list of user information for all defined
2970 userids.
2971 set
2973 name <userid> <username>
2975 Sets the username associated with the given
2977 userid.
2978 password <userid> [<password>]
2980 Sets the password for the given userid. If no
2982 password is given, the password is cleared (set to
2983 the NULL password). Be careful when removing
2984 passwords from administrator-level accounts.
2985 disable <userid>
2987 Disables access to the BMC by the given userid.
2989 enable <userid>
2991 Enables access to the BMC by the given userid.
2993 priv <userid> <privilege level> [<channel number>]
2995 Set user privilege level on the specified channel. If
2997 the channel is not specified, the current channel will be
2998 used.
2999 test <userid> <16|20> [<password>]
3001 Determine whether a password has been stored as 16 or 20
3003 bytes.
3004
3007 The ipmitool open interface utilizes the OpenIPMI kernel device driver.
3008 This driver is present in all modern 2.4 and all 2.6 kernels and it
3009 should be present in recent Linux distribution kernels. There are also
3010 IPMI driver kernel patches for different kernel versions available from
3011 the OpenIPMI homepage.
3012 The required kernel modules is different for 2.4 and 2.6 kernels. The
3014 following kernel modules must be loaded on a 2.4-based kernel in order
3015 for ipmitool to work:
3016 ipmi_msghandler
3018 Incoming and outgoing message handler for IPMI interfaces.
3019 ipmi_kcs_drv
3021 An IPMI Keyboard Controller Style (KCS) interface driver for the
3022 message handler.
3023 ipmi_devintf
3025 Linux character device interface for the message handler.
3026 The following kernel modules must be loaded on a 2.6-based kernel in
3028 order for ipmitool to work:
3029 ipmi_msghandler
3031 Incoming and outgoing message handler for IPMI interfaces.
3032 ipmi_si
3034 An IPMI system interface driver for the message handler. This
3035 module supports various IPMI system interfaces such as KCS, BT,
3036 SMIC, and even SMBus in 2.6 kernels.
3037 ipmi_devintf
3039 Linux character device interface for the message handler.
3040 Once the required modules are loaded there will be a dynamic character
3042 device entry that must exist at /dev/ipmi0. For systems that use devfs
3043 or udev this will appear at /dev/ipmi/0.
3044 To create the device node first determine what dynamic major number it
3046 was assigned by the kernel by looking in /proc/devices and checking for
3047 the ipmidev entry. Usually if this is the first dynamic device it will
3048 be major number 254 and the minor number for the first system interface
3049 is 0 so you would create the device entry with:
3050 mknod /dev/ipmi0 c 254 0
3052 ipmitool includes some sample initialization scripts that can perform
3054 this task automatically at start-up.
3055 In order to have ipmitool use the OpenIPMI device interface you can
3057 specify it on the command line:
3058 ipmitool -I open <command>
3060
3062 The ipmitool bmc interface utilizes the bmc device driver as provided
3063 by Solaris 10 and higher. In order to force ipmitool to make use of
3064 this interface you can specify it on the command line:
3065 ipmitool -I bmc <command>
3067 The following files are associated with the bmc driver:
3069 /platform/i86pc/kernel/drv/bmc
3072 32-bit ELF kernel module for the bmc driver.
3073 /platform/i86pc/kernel/drv/amd64/bmc
3075 64-bit ELF kernel module for the bmc driver.
3076 /dev/bmc
3078 Character device node used to communicate with the bmc driver.
3079
3081 The ipmitool lipmi interface uses the Solaris 9 IPMI kernel device
3082 driver. It has been superceeded by the bmc interface on Solaris 10.
3083 You can tell ipmitool to use this interface by specifying it on the
3084 command line.
3085 ipmitool -I lipmi <expression>
3087
3089 The ipmitool lan interface communicates with the BMC over an Ethernet
3090 LAN connection using UDP under IPv4. UDP datagrams are formatted to
3091 contain IPMI request/response messages with a IPMI session headers and
3092 RMCP headers.
3093 IPMI-over-LAN uses version 1 of the Remote Management Control Protocol
3095 (RMCP) to support pre-OS and OS-absent management. RMCP is a
3096 request-response protocol delivered using UDP datagrams to port 623.
3097 The LAN interface is an authentication multi-session connection; mes‐
3099 sages delivered to the BMC can (and should) be authenticated with a
3100 challenge/response protocol with either straight password/key or MD5
3101 message-digest algorithm. ipmitool will attempt to connect with admin‐
3102 istrator privilege level as this is required to perform chassis power
3103 functions.
3104 You can tell ipmitool to use the lan interface with the -I lan option:
3106 ipmitool -I lan -H <hostname> [-U <username>] [-P <password>] <command>
3109 A hostname must be given on the command line in order to use the lan
3111 interface with ipmitool. The password field is optional; if you do not
3112 provide a password on the command line, ipmitool will attempt to con‐
3113 nect without authentication. If you specify a password it will use MD5
3114 authentication if supported by the BMC and straight password/key other‐
3115 wise, unless overridden with a command line option.
3116
3118 Like the lan interface, the lanplus interface communicates with the BMC
3119 over an Ethernet LAN connection using UDP under IPv4. The difference
3120 is that the lanplus interface uses the RMCP+ protocol as described in
3121 the IPMI v2.0 specification. RMCP+ allows for improved authentication
3122 and data integrity checks, as well as encryption and the ability to
3123 carry multiple types of payloads. Generic Serial Over LAN support
3124 requires RMCP+, so the ipmitool sol activate command requires the use
3125 of the lanplus interface.
3126 RMCP+ session establishment uses a symmetric challenge-response proto‐
3128 col called RAKP (Remote Authenticated Key-Exchange Protocol) which
3129 allows the negotiation of many options. ipmitool does not yet allow
3130 the user to specify the value of every option, defaulting to the most
3131 obvious settings marked as required in the v2.0 specification. Authen‐
3132 tication and integrity HMACS are produced with SHA1, and encryption is
3133 performed with AES-CBC-128. Role-level logins are not yet supported.
3134 ipmitool must be linked with the OpenSSL library in order to perform
3136 the encryption functions and support the lanplus interface. If the
3137 required packages are not found it will not be compiled in and sup‐
3138 ported.
3139 You can tell ipmitool to use the lanplus interface with the -I lanplus
3141 option:
3142 ipmitool -I lanplus -H <hostname> [-U <username>] [-P <password>] <com‐
3145 mand>
3146 A hostname must be given on the command line in order to use the lan
3148 interface with ipmitool. With the exception of the -A and -C options
3149 the rest of the command line options are identical to those available
3150 for the lan interface.
3151 The -C option allows you specify the authentication, integrity, and
3153 encryption algorithms to use for for lanplus session based on the
3154 cipher suite ID found in the IPMIv2.0 specification in table 22-19.
3155 The default cipher suite is 3 which specifies RAKP-HMAC-SHA1 authenti‐
3156 cation, HMAC-SHA1-96 integrity, and AES-CBC-128 encryption algorightms.
3157
3160 The ipmitool free interface utilizes the FreeIPMI libfreeipmi drivers.
3161 You can tell ipmitool to use the FreeIPMI interface with the -I option:
3163 ipmitool -I free <command>
3165
3169 The ipmitool imb interface supports the Intel IMB (Intel Inter-module
3170 Bus) Interface through the /dev/imb device.
3171 You can tell ipmitool to use the IMB interface with the -I option:
3173 ipmitool -I imb <command>
3175
3178 Example 1: Listing remote sensors
3179 > ipmitool -I lan -H 1.2.3.4 -f passfile sdr list
3181 Baseboard 1.25V | 1.24 Volts | ok
3182 Baseboard 2.5V | 2.49 Volts | ok
3183 Baseboard 3.3V | 3.32 Volts | ok
3184 Example 2: Displaying status of a remote sensor
3186 > ipmitool -I lan -H 1.2.3.4 -f passfile sensor get "Baseboard
3188 1.25V"
3189 Locating sensor record...
3190 Sensor ID : Baseboard 1.25V (0x10)
3191 Sensor Type (Analog) : Voltage
3192 Sensor Reading : 1.245 (+/- 0.039) Volts
3193 Status : ok
3194 Lower Non-Recoverable : na
3195 Lower Critical : 1.078
3196 Lower Non-Critical : 1.107
3197 Upper Non-Critical : 1.382
3198 Upper Critical : 1.431
3199 Upper Non-Recoverable : na
3200 Example 3: Displaying the power status of a remote chassis
3202 > ipmitool -I lan -H 1.2.3.4 -f passfile chassis power status
3204 Chassis Power is on
3205 Example 4: Controlling the power on a remote chassis
3207 > ipmitool -I lan -H 1.2.3.4 -f passfile chassis power on
3209 Chassis Power Control: Up/On
3210
3212 Duncan Laurie <duncan@iceblink.org>
3213
3215 IPMItool Homepage
3216 http://ipmitool.sourceforge.net
3217 Intelligent Platform Management Interface Specification
3219 http://www.intel.com/design/servers/ipmi
3220 OpenIPMI Homepage
3222 http://openipmi.sourceforge.net
3223 FreeIPMI Homepage
3225 http://www.gnu.org/software/freeipmi/
3226Duncan Laurie ipmitool(1)