# phpman > man > ipmitool(1) > **TLDR:** Interface with the Intelligent Platform Management Interface (IPMI). > - Open IPMI shell on the local hardware: `sudo ipmitool shell` - Open IPMI shell on a remote host: `ipmitool -H {{ip_address}} -U {{user_name}} shell` *Source: tldr-pages* --- [ipmitool(1)](https://www.chedong.com/phpMan.php/man/ipmitool/1/markdown) [ipmitool(1)](https://www.chedong.com/phpMan.php/man/ipmitool/1/markdown) ## NAME ipmitool - utility for controlling IPMI-enabled devices ## SYNOPSIS ipmitool [ ] [ ] := [ | ] Any recognized option is accepted. Conditional options may be ignored or it's usage postponed until shell or exec processes relevant command. := [ -h | -V | -v | -I | -H
| -d | -p | -c | -U | -L | -l | -m | -N | -R | | | ] := [ | | ] Bridging: := -t [ -b | [ -T
| -B ] ] Options used with -I lan: := [ -A ] Options used with -I lanplus: := [ -C | ] Option groups setting same value: := [ -k | -K | -y | -Y ] := [ -f | -a | -P | -E ] := [ -o | -g | -s ] Options used with specific command : := [ -S ] := [ -O ] := [ -e ] ## DESCRIPTION This program lets you manage Intelligent Platform Management Interface (IPMI) functions of either the local system, via a kernel device driver, or a remote system, using IPMI v1.5 and IPMI v2.0. These functions include printing FRU information, LAN configuration, sensor read‐ ings, and remote chassis power control. IPMI management of a local system interface requires a compatible IPMI kernel driver to be installed and configured. On Linux this driver is called _OpenIPMI_ and it is included in standard distributions. On Solaris this driver is called _BMC_ and is included in Solaris 10. Management of a remote station requires the IPMI-over-LAN interface to be enabled and config‐ ured. Depending on the particular requirements of each system it may be possible to enable the LAN interface using ipmitool over the system interface. ## OPTIONS ### -a ### -A Specify an authentication type to use during IPMIv1.5 _lan_ session activation. Sup‐ ported types are NONE, PASSWORD, MD2, MD5, or OEM. ### -b Set destination channel for bridged request. ### -B Set transit channel for bridged request (dual bridge). ### -b Set destination channel for bridged request. ### -B Set transit channel for bridged request. (dual bridge) ### -c all commands. ### -C The remote server authentication, integrity, and encryption algorithms to use for IP‐ MIv2.0 _lanplus_ connections. See table 22-19 in the IPMIv2.0 specification. The de‐ fault is 3 which specifies RAKP-HMAC-SHA1 authentication, HMAC-SHA1-96 integrity, and AES-CBC-128 encryption algorithms. ### -d vice to use for in-band BMC communication. Used to target a specific BMC on a multi- node, multi-BMC system through the ipmi device driver interface. Default is 0. ### -e Use supplied character for SOL session escape character. The default is to use _~_ but this can conflict with ssh sessions. ### -E _IPMITOOL_PASSWORD_. The _IPMITOOL_PASSWORD_ takes precedence. ### -f Specifies a file containing the remote server password. If this option is absent, or if password_file is empty, the password will default to NULL. ### -g ### -h ### -H Remote server address, can be IP address or hostname. This option is required for _lan_ and _lanplus_ interfaces. ### -I Selects IPMI interface to use. Supported interfaces that are compiled in are visible in the usage help output. ### -k Use supplied Kg key for IPMIv2.0 authentication. The default is not to use any Kg key. ### -K ### -l Set destination lun for raw commands. ### -L Force session privilege level. Can be CALLBACK, USER, OPERATOR, ADMINISTRATOR. De‐ fault is ADMINISTRATOR. This value is ignored and always set to ADMINISTRATOR when combined with _-t_ _target_ _address_. ### -m Set the local IPMB address. The local address defaults to 0x20 or is auto discovered on PICMG platforms when -m is not specified. There should be no need to change the local address for normal operation. ### -N Specify nr. of seconds between retransmissions of lan/lanplus messages. Defaults are 2 seconds for lan and 1 second for lanplus interfaces. Command _raw_ uses fixed value of 15 seconds. Command _sol_ uses fixed value of 1 second. ### -o Select OEM type to support. This usually involves minor hacks in place in the code to work around quirks in various BMCs from various manufacturers. Use _-o_ _list_ to see a list of current supported OEM types. ### -O Open selected file and read OEM SEL event descriptions to be used during SEL listings. See examples in contrib dir for file format. ### -p Remote server UDP port to connect to. Default is 623. ### -P Remote server password is specified on the command line. If supported it will be ob‐ scured in the process list. **Note!** Specifying the password as a command line option is not recommended. ### -R Set the number of retries for lan/lanplus interface (default=4). Command _raw_ uses fixed value of one try (no retries). Command _hpm_ uses fixed value of 10 retries. ### -s ### -S Use local file for remote SDR cache. Using a local SDR cache can drastically increase performance for commands that require knowledge of the entire SDR to perform their function. Local SDR cache from a remote system can be created with the _sdr_ _dump_ com‐ mand. ### -t Bridge IPMI requests to the remote target address. Default is 32. The _-L_ _privlvl_ op‐ tion is always ignored and value set to ADMINISTRATOR. ### -T Set transit address for bridge request (dual bridge). ### -T Set transit address for bridge request. (dual bridge) ### -U Remote server username, default is NULL user. ### -v crease the level of debug output. If given three times you will get hexdumps of all incoming and outgoing packets. Using it five times provides details on request and ex‐ pected reply procesing. The _hpm_ commands _targetcap_ _compprop_ _abort_ _upgstatus_ _rollback_ _rollbackstatus_ _selftestresult_ increases the verbosity level ### -V ### -y Use supplied Kg key for IPMIv2.0 authentication. The key is expected in hexadecimal format and can be used to specify keys with non-printable characters. E.g. '-k PASS‐ WORD' and '-y 50415353574F5244' are equivalent. The default is not to use any Kg key. ### -Y ### -z Change Size of Communication Channel. (OEM) If no password method is specified then ipmitool will prompt the user for a password. If no password is entered at the prompt, the remote server password will default to NULL. ## SECURITY There are several security issues be be considered before enabling the IPMI LAN interface. A remote station has the ability to control a system's power state as well as being able to gather certain platform information. To reduce vulnerability it is strongly advised that the IPMI LAN interface only be enabled in 'trusted' environments where system security is not an issue or where there is a dedicated secure 'management network'. Further it is strongly advised that you should not enable IPMI for remote access without set‐ ting a password, and that that password should not be the same as any other password on that system. When an IPMI password is changed on a remote machine with the IPMIv1.5 _lan_ interface the new password is sent across the network as clear text. This could be observed and then used to attack the remote system. It is thus recommended that IPMI password management only be done over IPMIv2.0 _lanplus_ interface or the system interface on the local station. For IPMI v1.5, the maximum password length is 16 characters. Passwords longer than 16 char‐ acters will be truncated. For IPMI v2.0, the maximum password length is 20 characters; longer passwords are truncated. ## COMMANDS _help_ This can be used to get command-line help on ipmitool commands. It may also be placed at the end of commands to get option usage help. ipmitool help Commands: bmc Deprecated. Use mc channel Configure Management Controller channels chassis Get chassis status and set power state dcmi Data Center Management Interface delloem Manage Dell OEM Extensions. echo Used to echo lines to stdout in scripts ekanalyzer run FRU-Ekeying analyzer using FRU files event Send events to MC exec Run list of commands from file firewall Configure Firmware Firewall fru Print built-in FRU and scan for FRU locators fwum Update IPMC using Kontron OEM Firmware Update Manager gendev Read/Write Device associated with Generic Device locators sdr hpm Update HPM components using PICMG HPM.1 file i2c Send an I2C Master Write-Read command and print response ime Upgrade/Query Intel ME firmware isol Configure and connect Intel IPMIv1.5 Serial-over-LAN kontronoem Manage Kontron OEM Extensions lan Configure LAN Channels mc Management Controller status and global enables nm Node Manager pef Configure Platform Event Filtering (PEF) picmg Run a PICMG/ATA extended command power Shortcut to chassis power commands raw Send a RAW IPMI request and print response sdr Print Sensor Data Repository entries and readings sel Print System Event Log (SEL) sensor Print detailed sensor information session Print session information set Set runtime variable for shell and exec shell Launch interactive IPMI shell sol Configure and connect IPMIv2.0 Serial-over-LAN spd Print SPD info from remote I2C device sunoem Manage Sun OEM Extensions tsol Configure and connect Tyan IPMIv1.5 Serial-over-LAN user Configure Management Controller users _channel_ _authcap_ <**channel** **number**> <**max** **priv**> Displays information about the authentication capabilities of the selected channel at the specified privilege level. Possible privilege levels are: _1_ Callback level _2_ User level _3_ Operator level _4_ Administrator level _5_ OEM Proprietary level _15_ No access _info_ [**channel** **number**] Displays information about the selected channel. If no channel is given it will display information about the currently used channel. > ipmitool channel info Channel 0xf info: Channel Medium Type : System Interface Channel Protocol Type : KCS Session Support : session-less Active Session Count : 0 Protocol Vendor ID : 7154 _getaccess_ <**channel** **number**> [<**userid**>] Configure the given userid as the default on the given channel number. When the given channel is subsequently used, the user is identified implicitly by the given userid. _setaccess_ <**channel** **number**> <**userid**> [<_callin_=**on**|**off**>] [<_ipmi_=**on**|**off**>] [<_link_=**on**|**off**>] [<_privilege_=**level**>] Configure user access information on the given channel for the given userid. _getciphers_ <_ipmi_|_sol_> [<**channel**>] Displays the list of cipher suites supported for the given application (ipmi or sol) on the given channel. _chassis_ _status_ Status information related to power, buttons, cooling, drives and faults. _power_ _status_ _on_ _off_ _cycle_ _reset_ _diag_ _soft_ _identify_ [|force] Identify interval. Default is 15 seconds. 0 - Off force - To turn on indefinitely _policy_ What to do when power is restored. _list_ Show available options. _always-on_ _previous_ _always-off_ _restart_cause_ Last restart cause. _poh_ Get power on hours. _bootdev_ _none_ Do not change boot device order. _pxe_ Force PXE boot. _disk_ Force boot from default Hard-drive. _safe_ Force boot from default Hard-drive, request Safe Mode. _diag_ Force boot from Diagnostic Partition. _cdrom_ Force boot from CD/DVD. _bios_ Force boot into BIOS Setup. _floppy_ Force boot from Floppy/primary removable media. _bootparam_ _force_pxe_ Force PXE boot _force_disk_ Force boot from default Hard-drive _force_safe_ Force boot from default Hard-drive, request Safe Mode _force_diag_ Force boot from Diagnostic Partition _force_cdrom_ Force boot from CD/DVD _force_bios_ Force boot into BIOS Setup _selftest_ _dcmi_ _discover_ This command is used to discover supported capabilities in DCMI. _power_ <**command**> Platform power limit command options are: _reading_ Get power related readings from the system. _get_limit_ Get the configured power limits. _set_limit_ <**parameter**> <**value**> Set a power limit option. Possible parameters/values are: _action_ <**No** **Action** **|** **Hard** **Power** **Off** **&** **Log** **Event** **to** **SEL** **|** **Log** **Event** **to** **SEL**> Exception Actions are taken as "No Action", "Hard Power Off sys‐ tem and log events to SEL", or "Log event to SEL only". _limit_ <**number** **in** **Watts**> Power Limit Requested in Watts. _correction_ <**number** **in** **milliseconds**> Correction Time Limit in milliseconds. _sample_ <**number** **in** **seconds**> Statistics Sampling period in seconds. _activate_ Activate the set power limit. _deactivate_ Deactivate the set power limit. _sensors_ Prints the available DCMI sensors. _asset_tag_ Prints the platforms asset tag. _set_asset_tag_ <**string**> Sets the platforms asset tag _get_mc_id_string_ Get management controller identifier string. _set_mc_id_string_ <**string**> Set management controller identifier string. The maximum length is 64 bytes including a null terminator. _thermalpolicy_ [<**get** | **set**>] Thermal Limit policy get/set. The commands are: _Get_ <**entityID**> <**instanceID**> Get Thermal Limit values. **entityID** is the physical entity that a sensor or device is associated with. **instanceID** is a particular instance of an entity. Entity In‐ stance can be in one of two ranges, system-relative or device-relative. For example, a system with four processors could use an Entity Instance value of "0" to identify the first processor. _Set_ <**entityID**> <**instanceID**> Set Thermal Limit values. **entityID** is the physical entity that a sensor or device is associated with. **instanceID** is a particular instance of an entity. Entity In‐ stance can be in one of two ranges, system-relative or device-relative. For example, a system with four processors could use an Entity Instance value of "0" to identify the first processor. _get_temp_reading_ Get Temperature Sensor Readings. _get_conf_param_ Get DCMI Configuration Parameters. _set_conf_param_ <**parameters**> Set DCMI Configuration Parameters. The Configuration Parameters are: _activate_dhcp_ Activate/restart DHCP _dhcp_config_ Discover DHCP Configuration. _init_ Set DHCP Initial timeout interval, in seconds. The recommended default is four seconds. _timeout_ Set DHCP Server contact timeout interval, in seconds. The recommended default timeout is two minutes. _retry_ Set DHCP Server contact retry interval, in seconds. The recommended de‐ fault timeout is sixty-four seconds. _oob_discover_ Ping/Pong Message for DCMI Discovery. _delloem_ The delloem commands provide information on Dell-specific features. _setled_ _{b:d.f}_ _{state..}_ Sets the drive backplane LEDs for a device. {b:d.f} = PCI Address of device (eg. 06:00.0) {state} = one or more of the following: _online_ _|_ _present_ _|_ _hotspare_ _|_ _identify_ _|_ _rebuilding_ _|_ _fault_ _|_ _predict_ _|_ _critical_ _|_ _failed_ _lcd_ _set_ _{mode}_|_{lcdqualifier}_|_{errordisplay}_ Allows you to set the LCD mode and user-defined string. _lcd_ _set_ _mode_ _{none}_|_{modelname}_|_{ipv4address}_|_{macaddress}_| _{systemname}_|_{servicetag}_|_{ipv6address}_| _{ambienttemp}_|_{systemwatt}_|_{assettag}_| _{userdefined}_ Allows you to set the LCD display mode to any of the preceding parame‐ ters. _lcd_ _set_ _lcdqualifier_ _{watt}_|_{btuphr}_| _{celsius}_|_{fahrenheit}_ Allows you to set the unit for the system ambient temperature mode. _lcd_ _set_ _errordisplay_ _{sel}_|_{simple}_ Allows you to set the error display. _lcd_ _info_ Displays the LCD screen information. _lcd_ _set_ _vkvm_ _{active}_|_{inactive}_ Allows you to set the vKVM status to active or inactive. When it is ac‐ tive and session is in progress, a message appears on LCD. _lcd_ _status_ Displays the LCD status for vKVM display active or inactive and Front Panel access mode (viewandmodify, view-only or disabled). _mac_ Displays the information about the system NICs. _mac_ _list_ Displays the NIC MAC address and status of all NICs. It also displays the DRAC/iDRAC MAC address. _mac_ _get_ __ Displays the selected NICs MAC address and status. _lan_ Displays the information of Lan. _lan_ _set_ __ Sets the NIC selection mode (dedicated, shared with lom1, shared with lom2,shared with lom3,shared with lom4,shared with failover lom1,shared with failover lom2,shared with failover lom3,shared with failover lom4,shared with Failover all loms, shared with Failover None). _lan_ _get_ Returns the current NIC selection mode (dedicated, shared with lom1, shared with lom2, shared with lom3, shared with lom4,shared with failover lom1, shared with failover lom2,shared with failover lom3,shared with failover lom4,shared with Failover all loms,shared with Failover None). _lan_ _get_ _active_ Returns the current active NIC (dedicated, LOM1, LOM2, LOM3 or LOM4). _powermonitor_ Displays power tracking statistics. _powermonitor_ _clear_ _cumulativepower_ Reset cumulative power reading. _powermonitor_ _clear_ _peakpower_ Reset peak power reading. _powermonitor_ _powerconsumption_ __|__ Displays the power consumption in watt or btuphr. _powermonitor_ _powerconsumptionhistory_ __|__ Displays the power consumption history in watt or btuphr. _powermonitor_ _getpowerbudget_ __|__ Displays the power cap in watt or btuphr. _powermonitor_ _setpowerbudget_ __ Allows you to set the power cap in watt, BTU/hr or percentage. _powermonitor_ _enablepowercap_ Enables set power cap. _powermonitor_ _disablepowercap_ Disables set power cap. _vFlash_ _info_ _Card_ Shows Extended SD Card information. _echo_ For echoing lines to stdout in scripts. _ekanalyzer_ <**command**> <**xx=filename1**> <**xx=filename2**> [<**rc=filename3**>] **...** _NOTE_ : This command can support a maximum of 8 files per command line _filename1_ : binary file that stores FRU data of a Carrier or an AMC module _filename2_ : binary file that stores FRU data of an AMC module. These binary files can be generated from command: _ipmitool_ _fru_ _read_ __ __ _filename3_ : configuration file used for configuring On-Carrier Device ID or OEM GUID. This file is optional. _xx_ : indicates the type of the file. It can take the following value: _oc_ : On-Carrier device _a1_ : AMC slot A1 _a2_ : AMC slot A2 _a3_ : AMC slot A3 _a4_ : AMC slot A4 _b1_ : AMC slot B1 _b2_ : AMC slot B2 _b3_ : AMC slot B3 _b4_ : AMC slot B4 _sm_ : Shelf Manager The available commands for ekanalyzer are: _print_ [<**carrier** | **power** | **all**>] _carrier_ (default) <**oc=filename1**> <**oc=filename2**> **...** Display point to point physical connectivity between carriers and AMC modules. Example: > ipmitool ekanalyzer print carrier oc=fru oc=carrierfru From Carrier file: fru Number of AMC bays supported by Carrier: 2 AMC slot B1 topology: Port 0 =====> On Carrier Device ID 0, Port 16 Port 1 =====> On Carrier Device ID 0, Port 12 Port 2 =====> AMC slot B2, Port 2 AMC slot B2 topology: Port 0 =====> On Carrier Device ID 0, Port 3 Port 2 =====> AMC slot B1, Port 2 *-*-*-* *-*-* *-*-* *-*-* *-*-* *-*-* *-*-* From Carrier file: carrierfru On Carrier Device ID 0 topology: Port 0 =====> AMC slot B1, Port 4 Port 1 =====> AMC slot B1, Port 5 Port 2 =====> AMC slot B2, Port 6 Port 3 =====> AMC slot B2, Port 7 AMC slot B1 topology: Port 0 =====> AMC slot B2, Port 0 AMC slot B1 topology: Port 1 =====> AMC slot B2, Port 1 Number of AMC bays supported by Carrier: 2 _power_ <**xx=filename1**> <**xx=filename2**> **...** Display power supply information between carrier and AMC modules. _all_ <**xx=filename**> <**xx=filename**> **...** Display both physical connectivity and power supply of each carrier and AMC modules. _frushow_ <**xx=filename**> Convert a binary FRU file into human readable text format. Use -v option to get more display information. _summary_ [<**match** | **unmatch** | **all**>] _match_ (default) <**xx=filename**> <**xx=filename**> **...** Display only matched results of Ekeying match between an On-Carrier de‐ vice and an AMC module or between 2 AMC modules. Example: > ipmitool ekanalyzer summary match oc=fru b1=amcB1 a2=amcA2 On-Carrier Device vs AMC slot B1 AMC slot B1 port 0 ==> On-Carrier Device 0 port 16 Matching Result - From On-Carrier Device ID 0 -Channel ID 11 || Lane 0: enable -Link Type: AMC.2 Ethernet -Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link -Link Group ID: 0 || Link Asym. Match: exact match - To AMC slot B1 -Channel ID 0 || Lane 0: enable -Link Type: AMC.2 Ethernet -Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link -Link Group ID: 0 || Link Asym. Match: exact match *-*-*-* *-*-* *-*-* *-*-* *-*-* *-*-* *-*-* AMC slot B1 port 1 ==> On-Carrier Device 0 port 12 Matching Result - From On-Carrier Device ID 0 -Channel ID 6 || Lane 0: enable -Link Type: AMC.2 Ethernet -Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link -Link Group ID: 0 || Link Asym. Match: exact match - To AMC slot B1 -Channel ID 1 || Lane 0: enable -Link Type: AMC.2 Ethernet -Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link -Link Group ID: 0 || Link Asym. Match: exact match *-*-*-* *-*-* *-*-* *-*-* *-*-* *-*-* *-*-* On-Carrier Device vs AMC slot A2 AMC slot A2 port 0 ==> On-Carrier Device 0 port 3 Matching Result - From On-Carrier Device ID 0 -Channel ID 9 || Lane 0: enable -Link Type: AMC.2 Ethernet -Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link -Link Group ID: 0 || Link Asym. Match: exact match - To AMC slot A2 -Channel ID 0 || Lane 0: enable -Link Type: AMC.2 Ethernet -Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link -Link Group ID: 0 || Link Asym. Match: exact match *-*-*-* *-*-* *-*-* *-*-* *-*-* *-*-* *-*-* AMC slot B1 vs AMC slot A2 AMC slot A2 port 2 ==> AMC slot B1 port 2 Matching Result - From AMC slot B1 -Channel ID 2 || Lane 0: enable -Link Type: AMC.3 Storage -Link Type extension: Serial Attached SCSI (SAS/SATA) -Link Group ID: 0 || Link Asym. Match: FC or SAS interface {exact match} - To AMC slot A2 -Channel ID 2 || Lane 0: enable -Link Type: AMC.3 Storage -Link Type extension: Serial Attached SCSI (SAS/SATA) -Link Group ID: 0 || Link Asym. Match: FC or SAS interface {exact match} *-*-*-* *-*-* *-*-* *-*-* *-*-* *-*-* *-*-* _unmatch_ <**xx=filename**> <**xx=filename**> **...** Display the unmatched results of Ekeying match between an On-Carrier de‐ vice and an AMC module or between 2 AMC modules _all_ <**xx=filename**> <**xx=filename**> **...** Display both matched result and unmatched results of Ekeying match be‐ tween two cards or two modules. _event_ <**predefined** **event** **number** _N_> Send a pre-defined test event to the System Event Log. The following events are included as a means to test the functionality of the System Event Log com‐ ponent of the BMC (an entry will be added each time the event _N_ command is exe‐ cuted). Currently supported values for _N_ are: _1_ Temperature: Upper Critical: Going High _2_ Voltage Threshold: Lower Critical: Going Low _3_ Memory: Correctable ECC **NOTE**: These pre-defined events will likely not produce "accurate" SEL records for a particular system because they will not be correctly tied to a valid sen‐ sor number, but they are sufficient to verify correct operation of the SEL. _file_ <**filename**> Event log records specified in <**filename**> will be added to the System Event Log. The format of each line in the file is as follows: <{_EvM_ _Revision_} {_Sensor_ _Type_} {_Sensor_ _Num_} {_Event_ _Dir/Type_} {_Event_ _Data_ _0_} {_Event_ _Data_ _1_} {_Event_ _Data_ _2_}>[_#_ _COMMENT_] e.g.: 0x4 0x2 0x60 0x1 0x52 0x0 0x0 # Voltage threshold: Lower Critical: Going Low _EvM_ _Revision_ - The "Event Message Revision" is 0x04 for messages that comply with the IPMI 2.0 Specification and 0x03 for messages that comply with the IPMI 1.0 Specification. _Sensor_ _Type_ - Indicates the Event Type or Class. _Sensor_ _Num_ - Represents the 'sensor' within the management controller that gen‐ erated the Event Message. _Event_ _Dir/Type_ - This field is encoded with the event direction as the high bit (bit 7) and the event type as the low 7 bits. Event direction is 0 for an as‐ sertion event and 1 for a deassertion event. See the IPMI 2.0 specification for further details on the definitions for each field. <**sensorid**> <**list**> Get a list of all the possible Sensor States and pre-defined Sensor State Shortcuts available for a particular sensor. **sensorid** is the character string representation of the sensor and must be enclosed in double quotes if it in‐ cludes white space. Several different commands including _ipmitool_ _sensor_ _list_ may be used to obtain a list that includes the **sensorid** strings representing the sensors on a given system. > ipmitool -I open event "PS 2T Fan Fault" list Finding sensor PS 2T Fan Fault... ok Sensor States: State Deasserted State Asserted Sensor State Shortcuts: present absent assert deassert limit nolimit fail nofail yes no on off up down <**sensorid**> <**sensor** **state**> [<**direction**>] Generate a custom event based on existing sensor information. The optional event **direction** **can** **be** **either** _assert_ **(the** **default)** **or** _deassert_**.** > ipmitool event "PS 2T Fan Fault" "State Asserted" Finding sensor PS 2T Fan Fault... ok 0 | Pre-Init Time-stamp | Fan PS 2T Fan Fault | State Asserted > ipmitool event "PS 2T Fan Fault" "State Deasserted" Finding sensor PS 2T Fan Fault... ok 0 | Pre-Init Time-stamp | Fan PS 2T Fan Fault | State Desserted _exec_ <**filename**> Execute ipmitool commands from _filename_. Each line is a complete command. The syntax of the commands are defined by the COMMANDS section in this manpage. Each line may have an optional comment at the end of the line, delimited with a `#' symbol. e.g., a command file with two lines: sdr list # get a list of sdr records sel list # get a list of sel records _firewall_ This command supports the Firmware Firewall capability. It may be used to add or re‐ move security-based restrictions on certain commands/command sub-functions or to list the current firmware firewall restrictions set on any commands. For each firmware firewall command listed below, parameters may be included to cause the command to be executed with increasing granularity on a specific LUN, for a specific NetFn, for a specific IPMI Command, and finally for a specific command's sub-function (see Appendix H in the IPMI 2.0 Specification for a listing of any sub-function numbers that may be associated with a particular command). Parameter syntax and dependencies are as follows: [<_channel_ **H**>] [<_lun_ **L**> [ <_netfn_ **N**> [<_command_ **C** [<_subfn_ **S**>]]]] Note that if "netfn <**N**>" is specified, then "lun <**L**>" must also be specified; if "command <**C**>" is specified, then "netfn <**N**>" (and therefore "lun <**L**>") must also be specified, and so forth. "channel <**H**>" is an optional and standalone parameter. If not specified, the re‐ quested operation will be performed on the current channel. Note that command support may vary from channel to channel. Firmware firewall commands: _info_ [<**Parms** **as** **described** **above**>] List firmware firewall information for the specified LUN, NetFn, and Command (if supplied) on the current or specified channel. Listed information includes the support, configurable, and enabled bits for the specified command or com‐ mands. Some usage examples: _info_ [<**channel** **H**>] [<**lun** **L**>] This command will list firmware firewall information for all NetFns for the specified LUN on either the current or the specified channel. _info_ [<**channel** **H**>] [<**lun** **L**> [ <**netfn** **N**> ] This command will print out all command information for a single LUN/NetFn pair. _info_ [<**channel** **H**>] [<**lun** **L**> [ <**netfn** **N**> [<**command** **C**] ]] This prints out detailed, human-readable information showing the sup‐ port, configurable, and enabled bits for the specified command on the specified LUN/NetFn pair. Information will be printed about each of the command subfunctions. _info_ [<**channel** **H**>] [<**lun** **L**> [ <**netfn** **N**> [<**command** **C** [<**subfn** **S**>]]]] Print out information for a specific sub-function. _enable_ [<**Parms** **as** **described** **above**>] This command is used to enable commands for a given NetFn/LUN combination on the specified channel. _disable_ [<**Parms** **as** **described** **above**>] [**force**] This command is used to disable commands for a given NetFn/LUN combination on the specified channel. Great care should be taken if using the "force" option so as not to disable the "Set Command Enables" command. _reset_ [<**Parms** **as** **described** **above**>] This command may be used to reset the firmware firewall back to a state where all commands and command sub-functions are enabled. _fru_ _print_ Read all Field Replaceable Unit (FRU) inventory data and extract such infor‐ mation as serial number, part number, asset tags, and short strings describing the chassis, board, or product. _read_ <**fru** **id**> <**fru** **file**> **fru** **id** is the digit ID of the FRU (see output of 'fru print'). **fru** **file** is the absolute pathname of a file in which to dump the binary FRU data pertaining to the specified FRU entity. _write_ <**fru** **id**> <**fru** **file**> **fru** **id** is the digit ID of the FRU (see output of 'fru print'). **fru** **file** is the absolute pathname of a file from which to pull the binary FRU data before up‐ loading it to the specified FRU. _upgEkey_ <**fru** **id**> <**fru** **file**> Update a multirecord FRU location. **fru** **id** is the digit ID of the FRU (see out‐ put of 'fru print'). **fru** **file** is the absolute pathname of a file from which to pull the binary FRU data to upload into the specified multirecord FRU entity. _edit_ <**fru** **id**> This command provides interactive editing of some supported records, namely PICMG Carrier Activation Record. **fru** **id** is the digit ID of the FRU (see output of 'fru print'); default is 0. _edit_ <**fru** **id**> **field** <**section**> <**index**> <**string**> This command may be used to set a field string to a new value. It replaces the FRU data found at **index** in the specified **section** with the supplied **string**. **fru** **id** is the digit ID of the FRU (see output of 'fru print'). <**section**> is a string which refers to FRU Inventory Information Storage Areas and may be refer to: _c_ FRU Inventory Chassis Info Area _b_ FRU Inventory Board Info Area _p_ FRU Inventory Product Info Area <**index**> specifies the field number. Field numbering starts on the first 'eng‐ lish text' field type. For instance in the <**board**> info area field '0' is <**Board** **Manufacturer**> and field '2' is <**Board** **Serial** **Number**>; see IPMI Platform Management FRU Information Storage Definition v1.0 R1.1 for field locations. <**string**> must be the same length as the string being replaced and must be 8-bit ASCII (0xCx). _edit_ <**fru** **id**> **oem** **iana** <**record**> <**format**> [<**args**>] This command edits the data found in the multirecord area. Support for OEM spe‐ cific records is limited. _fwum_ Update IPMC using Kontron OEM Firmware Update Manager. _info_ Show information about current firmware. _status_ Show status of each firmware bank present in the hardware. _download_ <**filename**> Download specified firmware. _upgrade_ [**filename**] Install firmware upgrade. If the filename is specified, the file is downloaded first, otherwise the last firmware downloaded is used. _rollback_ Ask IPMC to rollback to previous version. _tracelog_ Show firmware upgrade log. _gendev_ _list_ List All Generic Device Locators. _read_ <**sdr** **name**> <**file**> Read to file eeprom specify by Generic Device Locators. _write_ <**sdr** **name**> <**file**> Write from file eeprom specify by Generic Device Locators _hpm_ PICMG HPM.1 Upgrade Agent _check_ Check the target information. _check_ <**filename**> Display both the existing target version and image version on the screen. _download_ <**filename**> Download specified firmware. _upgrade_ <**filename**> [**all**] [**component** ****] [**activate**] Upgrade the firmware using a valid HPM.1 image file. If no option is specified, the firmware versions are checked first and the firmware is upgraded only if they are different. _all_ Upgrade all components even if the firmware versions are the same (use this only after using "check" command). _component_ <**x**> Upgrade only given component from the given file. component 0 - BOOT component 1 - RTK _activate_ Activate new firmware right away. _activate_ Activate the newly uploaded firmware. _targetcap_ Get the target upgrade capabilities. _compprop_ <**id**> <**select**> Get the specified component properties. Valid component **id**: 0-7. **Select** can be one of following: 0 - General properties 1 - Current firmware version 2 - Description string 3 - Rollback firmware version 4 - Deferred firmware version _abort_ Abort the on-going firmware upgrade. _upgstatus_ Show status of the last long duration command. _rollback_ Perform manual rollback on the IPM Controller firmware. _rollbackstatus_ Show the rollback status. _selftestresult_ Query the self test results. _i2c_ <**i2caddr**> <**read** **bytes**> [<**write** **data**>] This command may be used to execute raw I2C commands with the Master Write-Read IPMI command. _ime_ _help_ Print usage information _info_ Displays information about the Manageability Engine (ME) _update_ <**file**> Upgrade the ME firmware with the specified image file **WARNING** You MUST use a supported image provided by your board vendor _rollback_ Perform manual rollback of the ME firmware _isol_ _info_ Retrieve information about the Intel IPMI v1.5 Serial-Over-LAN configuration. _set_ <**parameter**> <**value**> Configure parameters for Intel IPMI v1.5 Serial-over-LAN. Valid parameters and values are: _enabled_ true, false. _privilege-level_ user, operator, admin, oem. _bit-rate_ 9.6, 19.2, 38.4, 57.6, 115.2. _activate_ Causes ipmitool to enter Intel IPMI v1.5 Serial Over LAN mode. An RMCP+ connec‐ tion is made to the BMC, the terminal is set to raw mode, and user input is sent to the serial console on the remote server. On exit, the SOL payload mode is deactivated and the terminal is reset to its original settings. Special escape sequences are provided to control the SOL session: _~._ Terminate connection _~^Z_ Suspend ipmitool _~^X_ Suspend ipmitool, but don't restore tty on restart _~B_ Send break _~~_ Send the escape character by typing it twice _~?_ Print the supported escape sequences Note that escapes are only recognized immediately after newline. _kontronoem_ OEM commands specific to Kontron devices. _setsn_ Set FRU serial number. _setmfgdate_ Set FRU manufacturing date. _nextboot_ <**boot** **device**> Select the next boot order on the Kontron CP6012. _lan_ These commands will allow you to configure IPMI LAN channels with network information so they can be used with the ipmitool _lan_ and _lanplus_ interfaces. _NOTE_: To determine on which channel the LAN interface is located, issue the `channel info _number_' command until you come across a valid 802.3 LAN channel. For example: > ipmitool -I open channel info 1 Channel 0x1 info: Channel Medium Type : 802.3 LAN Channel Protocol Type : IPMB-1.0 Session Support : session-based Active Session Count : 8 Protocol Vendor ID : 7154 _print_ [<**channel**>] Print the current configuration for the given channel. The default will print information on the first found LAN channel. _set_ <**channel** **number**> <**command**> <**parameter**> Set the given command and parameter on the specified channel. Valid com‐ mand/parameter options are: _ipaddr_ <**x.x.x.x**> Set the IP address for this channel. _netmask_ <**x.x.x.x**> Set the netmask for this channel. _macaddr_ <**xx:xx:xx:xx:xx:xx**> Set the MAC address for this channel. _defgw_ _ipaddr_ <**x.x.x.x**> Set the default gateway IP address. _defgw_ _macaddr_ <**xx:xx:xx:xx:xx:xx**> Set the default gateway MAC address. _bakgw_ _ipaddr_ <**x.x.x.x**> Set the backup gateway IP address. _bakgw_ _macaddr_ <**xx:xx:xx:xx:xx:xx**> Set the backup gateway MAC address. _password_ <**pass**> Set the null user password. _snmp_ <**community** **string**> Set the SNMP community string. _user_ Enable user access mode for userid 1 (issue the `user' command to dis‐ play information about userids for a given channel). _access_ <**on|off**> Set LAN channel access mode. _alert_ <**on|off**> Enable or disable PEF alerting for this channel. _ipsrc_ <**source**> Set the IP address source: _none_ unspecified _static_ manually configured static IP address _dhcp_ address obtained by BMC running DHCP _bios_ address loaded by BIOS or system software _arp_ _respond_ <**on**|**off**> Set BMC generated ARP responses. _arp_ _generate_ <**on**|**off**> Set BMC generated gratuitous ARPs. _arp_ _interval_ <**seconds**> Set BMC generated gratuitous ARP interval. _vlan_ _id_ <**off**|**id**> Disable VLAN operation or enable VLAN and set the ID. ID: value of the virtual lan identifier between 1 and 4094 inclusive. _vlan_ _priority_ <**priority**> Set the priority associated with VLAN frames. ID: priority of the virtual lan frames between 0 and 7 inclusive. _auth_ <**level**,**...**> <**type**,**...**> Set the valid authtypes for a given auth level. Levels: callback, user, operator, admin Types: none, md2, md5, password, oem _cipher_privs_ <**privlist**> Correlates cipher suite numbers with the maximum privilege level that is allowed to use it. In this way, cipher suites can restricted to users with a given privilege level, so that, for example, administrators are required to use a stronger cipher suite than normal users. The format of _privlist_ is as follows. Each character represents a priv‐ ilege level and the character position identifies the cipher suite num‐ ber. For example, the first character represents cipher suite 0, the second represents cipher suite 1, and so on. _privlist_ must be 15 char‐ acters in length. Characters used in _privlist_ and their associated privilege levels are: _X_ Cipher Suite Unused _c_ CALLBACK _u_ USER _o_ OPERATOR _a_ ADMIN _O_ OEM So, to set the maximum privilege for cipher suite 0 to USER and suite 1 to ADMIN, issue the following command: > ipmitool -I _interface_ lan set _channel_ cipher_privs uaXXXXXXXXXXXXX _bad_pass_thresh_ <**thresh**___**num**> <**1|0**> <**reset**___**interval**> <**lockout**___**interval**> Sets the Bad Password Threshold. <**thresh**___**num**> If non-zero, this value determines the number of sequential bad passwords that will be allowed to be entered for the identified user before the user is automatically disabled from access on the channel. <**1|0**> 1 = generate a Session Audit sensor "Invalid password disable" event message. 0 = do not generate an event message when the user is disabled. <**reset**___**interval**> Attempt Count Reset Interval. The interval, in tens of seconds, for which the accumulated count of bad password attempts is re‐ tained before being automatically reset to zero. <**lockout**___**interval**> User Lockout Interval. The interval, in tens of sec‐ onds, that the user will remain disabled after being disabled because the Bad Password Threshold number was reached. _alert_ _print_ [<**channel**>] [<**alert** **destination**>] Print alert information for the specified channel and destination. The default will print all alerts for all alert destinations on the first found LAN chan‐ nel. _alert_ _set_ <**channel** **number**> <**alert** **destination**> <**command**> <**parameter**> Set an alert on the given LAN channel and destination. Alert Destinations are listed via the '_lan_ _alert_ _print_' command. Valid command/parameter options are: _ipaddr_ <**x.x.x.x**> Set alert IP address. _macaddr_ <**xx:xx:xx:xx:xx:xx**> Set alert MAC address. _gateway_ <**default** **|** **backup**> Set the channel gateway to use for alerts. _ack_ <**on** **|** **off**> Set Alert Acknowledge on or off. _type_ <**pet** **|** **oem1** **|** **oem2**> Set the destination type as PET or OEM. _time_ <**seconds**> Set ack timeout or unack retry interval. _retry_ <**number**> Set the number of alert retries. _stats_ _get_ [<**channel** **number**>] Retrieve information about the IP connections on the specified channel. The default will retrieve statistics on the first found LAN channel. _stats_ _clear_ [<**channel** **number**>] Clear all IP/UDP/RMCP Statistics to 0 on the specified channel. The default will clear statistics on the first found LAN channel. _mc_ _|_ _bmc_ _reset_ <**warm**|**cold**> Instructs the BMC to perform a warm or cold reset. _guid_ Display the Management Controller Globally Unique IDentifier. _info_ Displays information about the BMC hardware, including device revision, firmware revision, IPMI version supported, manufacturer ID, and information on additional device support. _watchdog_ These commands allow a user to view and change the current state of the watch‐ dog timer. _get_ Show current Watchdog Timer settings and countdown state. _reset_ Reset the Watchdog Timer to its most recent state and restart the count‐ down timer. _off_ Turn off a currently running Watchdog countdown timer. _selftest_ Check on the basic health of the BMC by executing the Get Self Test results command and report the results. _getenables_ Displays a list of the currently enabled options for the BMC. _setenables_ <**option**>=[_on_|_off_] Enables or disables the given _option_. This command is only supported over the system interface according to the IPMI specification. Currently supported val‐ ues for _option_ include: _recv_msg_intr_ Receive Message Queue Interrupt _event_msg_intr_ Event Message Buffer Full Interrupt _event_msg_ Event Message Buffer _system_event_log_ System Event Logging _oem0_ OEM-Defined option #0 _oem1_ OEM-Defined option #1 _oem2_ OEM-Defined option #2 _getsysinfo_ <**argument**> Retrieves system info from bmc for given argument. See _setsysinfo_ for argument definitions _setsysinfo_ <**argument**> <**string**> Stores system info string to bmc for given argument Possible arguments are: _primary_os_name_ Primary Operating System Name _os_name_ Operating System Name _system_name_ System Name of Server _delloem_os_version_ Running version of operating system _delloem_URL_ URL of BMC Webserver _chassis_ _status_ Displays information regarding the high-level status of the system chas‐ sis and main power subsystem. _poh_ This command will return the Power-On Hours counter. _identify_ <**interval**> Control the front panel identify light. Default interval is 15 sec‐ onds. Use 0 to turn off. Use "force" to turn on indefinitely. _restart_cause_ Query the chassis for the cause of the last system restart. _selftest_ Check on the basic health of the BMC by executing the Get Self Test re‐ sults command and report the results. _policy_ Set the chassis power policy in the event power failure. _list_ Return supported policies. _always-on_ Turn on when power is restored. _previous_ Returned to previous state when power is restored. _always-off_ Stay off after power is restored. _power_ Performs a chassis control command to view and change the power state. _status_ Show current chassis power status. _on_ Power up chassis. _off_ Power down chassis into soft off (S4/S5 state). **WARNING**: This command does not initiate a clean shutdown of the operating sys‐ tem prior to powering down the system. _cycle_ Provides a power off interval of at least 1 second. No action should occur if chassis power is in S4/S5 state, but it is recom‐ mended to check power state first and only issue a power cycle command if the system power is on or in lower sleep state than S4/S5. _reset_ This command will perform a hard reset. _diag_ Pulse a diagnostic interrupt (NMI) directly to the processor(s). _soft_ Initiate a soft-shutdown of OS via ACPI. This can be done in a number of ways, commonly by simulating an overtemperture or by simulating a power button press. It is necessary for there to be Operating System support for ACPI and some sort of daemon watch‐ ing for events for this soft power to work. _bootdev_ <**device**> [<_clear-cmos_=**yes**|**no**>] [<_options_=**help,...**>] Request the system to boot from an alternate boot device on next reboot. The _clear-cmos_ option, if supplied, will instruct the BIOS to clear its CMOS on the next reboot. Various options may be used to modify the boot device settings. Run _"bootdev_ _none_ _options=help"_ for a list of avail‐ able boot device modifiers/options. Currently supported values for are: _none_ Do not change boot device _pxe_ Force PXE boot _disk_ Force boot from BIOS default boot device _safe_ Force boot from BIOS default boot device, request Safe Mode _diag_ Force boot from diagnostic partition _cdrom_ Force boot from CD/DVD _bios_ Force boot into BIOS setup _floppy_ Force boot from Floppy/primary removable media _bootparam_ Get or set various system boot option parameters. _get_ <**param** **#**> Get boot parameter. Currently supported values for <**param** **#**> are: _0_ - Set In Progress _1_ - Service Partition Selector _2_ - Service Partition Scan _3_ - BMC Boot Flag Valid Bit Clearing _4_ - Boot Info Acknowledge _5_ - Boot Flags _6_ - Boot Initiator Info _7_ - Boot Initiator Mailbox _set_ <**device**> [<_options_=**help,...**>] Set boot device parameter used for next boot. Various options may be used to change when the the next boot device is cleared. Run _"options=help"_ for a list of available bootparam set device options. Currently supported bootparam **device** settings are: _force_pxe_ Force PXE boot _force_disk_ Force boot from default hard-drive _force_safe_ Force boot from default hard-drive, request Safe Mode _force_diag_ Force boot from diagnostic partition _force_cdrom_ Force boot from CD/DVD _force_bios_ Force boot into BIOS setup Currently supported bootparam **options** settings are associated with BMC Boot Valid Bit Clearing and are as follows: Any option can be prefixed with "no-" to invert the sense of the operation. _PEF_ Clear valid bit on reset/power cycle caused by PEF _timeout_ Automatically clear boot flag valid bit if Chassis Control command is not received within 60 seconds. _watchdog_ Clear valid bit on reset/power cycle caused by watchdog timeout _reset_ Clear valid bit on push button reset / soft-reset _power_ Clear valid bit on power up via power push button or wake event _nm_ _alert_ _clear_ _dest_ <**dest**> Clear the Node Manager Alert lan destination. _get_ Get the Node Manager Alert settings. _set_ _chan_ <**chan**> _dest_ <**dest**> _string_ <**string**> Set the Node Manager alert channel, lan destination, and alert string number. _capability_ Obtain the Node Manager power control capabilities and ranges. _control_ _enable_|_disable_ _global_ Enable/disable all policies for all domains. _per_domain_ Enable/disable all policies of the specified domain. _per_policy_ <0-7> Enable/disable the policy for the specified domain/policy combi‐ nation. _discover_ Discover Node Manager presence as well as the Node Manager version, revision, and patch number. _policy_ _add_ _power_ _policy_id_ <0-7> [_correction_ auto|soft|hard] _trig_lim_ _stats_ [_domain_ ] _enable_|_disable_ Add a new power policy, or overwrite an existing policy. The _correction_ parameter is the aggressiveness of frequency limiting, default is auto. The _trig_lim_ is the correction time limit and must be at least 6000 and not greater than 65535. The _stats_ set‐ ting is the averaging period in seconds and ranges from 1-65535. If domain is not supplied a default of platform is used. _inlet_ _policy_id_ <0-7> [_correction_ auto|soft|hard] _trig_lim_ _stats_ [_domain_ ] _enable_|_disable_ Add a new inlet temp policy, or overwrite an existing policy. The _correction_ parameter is the aggressiveness of frequency lim‐ iting, default is auto. The _trig_lim_ is the correction time limit and must be at least 6000 and not greater than 65535. The _stats_ setting is the averaging period in seconds and ranges from 1-65535. If domain is not supplied a default of platform is used. _get_ _policy_id_ <0-7> Get a previously stored policy. _limiting_ Report policy number if any policy is limiting power. _remove_ _policy_id_ <0-7> [_domain_ ] Remove a policy. If domain is not supplied a default of platform is used. _power_ _min_ _max_ [_domain_ ] Configure Node Manager power minimum and maximum power draw limits. The _min_ and _max_ values must be in the range of 0-65535. If domain is not supplied a default of platform is used. _reset_ _comm_ _policy_id_ <0-7> [_domain_ ] Reset Node Manager communication statistics. If domain is not supplied a default of platform is used. _global_ Reset Node Manager global statistics. _memory_ _policy_id_ <0-7> [_domain_ ] Reset Node Manager memory throttling statistics. If domain is not sup‐ plied a default of platform is used. _per_policy_ _policy_id_ <0-7> [_domain_ ] Reset Node Manager per policy statistics. If domain is not supplied a default of platform is used. _requests_ _policy_id_ <0-7> [_domain_ ] Reset Node Manager unhandled requests statistics. If domain is not sup‐ plied a default of platform is used. _response_ _policy_id_ <0-7> [_domain_ ] Reset Node Manager response time statistics. If domain is not supplied a default of platform is used. _throttling_ _policy_id_ <0-7> [_domain_ ] Reset Node Manager throttling statistics. If domain is not supplied a default of platform is used. _statistics_ _comm_fail_ Report Node Manager communication failure statistics. _cpu_throttling_ Report Node Manager cpu throttling statistics. _mem_throttling_ Report Node Manager memory throttling statistics. _policy_power_ _policy_id_ <0-7> [_domain_ ] Report Node Manager per policy power statistics (policy must be a power limit type policy). If domain is not supplied a default of platform is used. _policy_temps_ _policy_id_ <0-7> [_domain_ ] Report Node Manager per policy temp statistics (policy must be an inlet temp limit policy). If domain is not supplied a default of platform is used. _policy_throt_ _policy_id_ <0-7> [_domain_ ] Report Node Manager per policy throttling statistics. If domain is not supplied a default of platform is used. _requests_ Report Node Manager unhandled requests statistics. _response_ Report Node Manager response time statistics. _suspend_ _get_ _policy_id_ <0-7> [_domain_ ] Get Node Manager policy suspend periods. If domain is not supplied a default of platform is used. _set_ _policy_id_ <0-7> [_domain_ ] Set Node Manager policy suspend periods. If domain is not supplied a default of platform is used. The and values must be in the range of 0-239, which is the number of minutes past midnight divided by 6. The value is the daily recurrence pattern. Bit 0 is re‐ peat every Monday, bit 1 is repeat every Tuesday, on through bit 6 for Sunday. _threshold_ _get_ _policy_id_ <0-7> [_domain_ ] Get Node Manager policy Alert Threshold settings. If domain is not sup‐ plied a default of platform is used. _set_ _policy_id_ <0-7> [_domain_ ] _thresh_array_ Set Node Manager policy Alert Threshold values. If domain is not sup‐ plied a default of platform is used. The _thresh_array_ is 1, 2, or 3 in‐ tegers that set three alert threshold settings. The setting type is a power or temperature value which must match the type of policy. _pef_ _info_ This command will query the BMC and print information about the PEF supported features. _status_ This command prints the current PEF status (the last SEL entry processed by the BMC, etc). _policy_ This command lists the PEF policy table entries. Each policy entry describes an alert destination. A policy set is a collection of table entries. PEF alert actions reference policy sets. _list_ This command lists the PEF table entries. Each PEF entry relates a sensor event to an action. When PEF is active, each platform event causes the BMC to scan this table for entries matching the event, and possible actions to be taken. Actions are performed in priority order (higher criticality first). _picmg_ <**properties**> Run a PICMG/ATA extended command. Get PICMG properties may be used to obtain and print Extension major version information, PICMG identifier, FRU Device ID and Max FRU De‐ vice ID. _addrinfo_ Get address information. This command may return information on the Hardware address, IPMB-0 Address, FRU ID, Site/Entity ID, and Site/Entity Type. _frucontrol_ <**fru** **id**> <**options**> Set various control options: _0x00_ - Cold Reset _0x01_ - Warm Reset _0x02_ - Graceful Reboot _0x03_ - Issue Diagnostic Interrupt _0x04_ - Quiesce [AMC only] _0x05-0xFF_ - Cold Reset _activate_ <**fru** **id**> Activate the specified FRU. _deactivate_ <**fru** **id**> Deactivate the specified FRU. _policy_ _get_ <**fru** **id**> Get FRU activation policy. _policy_ _set_ <**fru** **id**> <**lockmask**> <**lock**> Set FRU activation policy. **lockmask** is 1 or 0 to indicate action on the deac‐ tivation or activation locked bit respectively. **lock** is 1 or 0 to set/clear locked bit. _portstate_ **set**|**getall**|**getgranted**|**getdenied** <**parameters**> Get or set various port states. See usage for parameter details. _power_ <**chassis** **power** **command**> Shortcut to the _chassis_ _power_ commands. See the _chassis_ _power_ commands for usage in‐ formation. _raw_ <**netfn**> <**cmd**> [<**data**>] This will allow you to execute raw IPMI commands. For example to query the POH counter with a raw command: > ipmitool -v raw 0x0 0xf RAW REQ (netfn=0x0 cmd=0xf data_len=0) RAW RSP (5 bytes) 3c 72 0c 00 00 **Note** that the OpenIPMI driver provided by the Linux kernel will reject the Get Mes‐ sage, Send Message and Read Event Message Buffer commands because it handles the mes‐ sage sequencing internally. _sdr_ _get_ <**id**> ... [<**id**>] Prints information for sensor data records specified by sensor id. _info_ This command will query the BMC for Sensor Data Record (SDR) Repository infor‐ mation. _type_ [<**sensor** **type**>] This command will display all records from the SDR Repository of a specific type. Run with type _list_ (or simply with no type) to see the list of available types. For example to query for all Temperature sensors: > ipmitool sdr type Temperature Baseboard Temp | 30h | ok | 7.1 | 28 degrees C FntPnl Amb Temp | 32h | ok | 12.1 | 24 degrees C Processor1 Temp | 98h | ok | 3.1 | 57 degrees C Processor2 Temp | 99h | ok | 3.2 | 53 degrees C _list_ | _elist_ [<**all**|**full**|**compact**|**event**|**mcloc**|**fru**|**generic**>] This command will read the Sensor Data Records (SDR) and extract sensor infor‐ mation of a given type, then query each sensor and print its name, reading, and status. If invoked as _elist_ then it will also print sensor number, entity id and instance, and asserted discrete states. The default output will only display _full_ and _compact_ sensor types, to see all sensors use the _all_ type with this command. Valid types are: _all_ All SDR records (Sensor and Locator) _full_ Full Sensor Record _compact_ Compact Sensor Record _event_ Event-Only Sensor Record _mcloc_ Management Controller Locator Record _fru_ FRU Locator Record _generic_ Generic SDR records _entity_ <**id**>[.<**instance**>] Displays all sensors associated with an entity. Get a list of valid entity ids on the target system by issuing the _sdr_ _elist_ command. A list of all entity ids can be found in the IPMI specifications. _dump_ <**file**> Dumps raw SDR data to a file. This data file can then be used as a local SDR cache of the remote managed system with the _-S_ __ option on the ipmitool command line. This can greatly improve performance over system interface or remote LAN. _fill_ _sensors_ Create the SDR Repository for the current configuration. Will perform a 'Clear SDR Repository' command so be careful. _fill_ _file_ <**filename**> Fill the SDR Repository using records stored in a binary data file. Will per‐ form a 'Clear SDR Repository' command so be careful. _sel_ NOTE: System Event Log (SEL) entry-times are displayed as `Pre-Init Time-stamp' if the SEL clock needs to be set. Ensure that the SEL clock is accurate by invoking the _sel_ _time_ _get_ and _sel_ _time_ _set_ __ commands. _info_ This command will query the BMC for information about the System Event Log (SEL) and its contents. _clear_ This command will clear the contents of the SEL. It cannot be undone so be careful. _list_ | _elist_ When this command is invoked without arguments, the entire contents of the Sys‐ tem Event Log are displayed. If invoked as _elist_ (extended list) it will also use the Sensor Data Record entries to display the sensor ID for the sensor that caused each event. **Note** this can take a long time over the system interface. <**count**> | _first_ <**count**> Displays the first _count_ (least-recent) entries in the SEL. If _count_ is zero, all entries are displayed. _last_ <**count**> Displays the last _count_ (most-recent) entries in the SEL. If _count_ is zero, all entries are displayed. _delete_ <**SEL** **Record** **ID**> ... <**SEL** **Record** **ID**> Delete one or more SEL event records. _add_ <**filename** **ID**> Read event entries from a file and add them to the SEL. New SEL entries area added onto the SEL after the last record in the SEL. Record added is of type 2 and is automatically timestamped. _get_ <**SEL** **Record** **ID**> Print information on the specified SEL Record entry. _save_ <**file**> Save SEL records to a text file that can be fed back into the _event_ _file_ ipmi‐ tool command. This can be useful for testing Event generation by building an appropriate Platform Event Message file based on existing events. Please see the available help for the 'event file ...' command for a description of the format of this file. _writeraw_ <**file**> Save SEL records to a file in raw, binary format. This file can be fed back to the _sel_ _readraw_ ipmitool command for viewing. _readraw_ <**file**> Read and display SEL records from a binary file. Such a file can be created using the _sel_ _writeraw_ ipmitool command. _time_ _get_ Displays the SEL clock's current time. _set_ <**time** **string**> Sets the SEL clock. Future SEL entries will use the time set by this command. <**time** **string**> is of the form "MM/DD/YYYY HH:MM:SS". Note that hours are in 24-hour form. It is recommended that the SEL be cleared before setting the time. _sensor_ _list_ Lists sensors and thresholds in a wide table format. _get_ <**id**> ... [<**id**>] Prints information for sensors specified by name. _thresh_ <**id**> <**threshold**> <**setting**> This allows you to set a particular sensor threshold value. The sensor is specified by name. Valid _thresholds_ are: _unr_ Upper Non-Recoverable _ucr_ Upper Critical _unc_ Upper Non-Critical _lnc_ Lower Non-Critical _lcr_ Lower Critical _lnr_ Lower Non-Recoverable _thresh_ <**id**> _lower_ <**lnr**> <**lcr**> <**lnc**> This allows you to set all lower thresholds for a sensor at the same time. The sensor is specified by name and the thresholds are listed in order of Lower Non-Recoverable, Lower Critical, and Lower Non-Critical. _thresh_ <**id**> _upper_ <**unc**> <**ucr**> <**unr**> This allows you to set all upper thresholds for a sensor at the same time. The sensor is specified by name and the thresholds are listed in order of Upper Non-Critical, Upper Critical, and Upper Non-Recoverable. _session_ _info_ <**active**|**all**|**id** **0xnnnnnnnn**|**handle** **0xnn**> Get information about the specified session(s). You may identify sessions by their id, by their handle number, by their active status, or by using the key‐ word `all' to specify all sessions. _set_ _hostname_ <**host**> Session hostname. _username_ <**user**> Session username. _password_ <**pass**> Session password. _privlvl_ <**level**> Session privilege level force. _authtype_ <**type**> Authentication type force. _localaddr_ <**addr**> Local IPMB address. _targetaddr_ <**addr**> Remote target IPMB address. _port_ <**port**> Remote RMCP port. _csv_ [**level**] Enable output in comma separated format. Affects following commands: _user_, _channel_, _isol_, _sunoem_, _sol_, _sensor_, _sdr_, _sel_, _session_. _verbose_ [**verbose**] Verbosity level. _shell_ This command will launch an interactive shell which you can use to send multiple ipmi‐ tool commands to a BMC and see the responses. This can be useful instead of running the full ipmitool command each time. Some commands will make use of a Sensor Data Record cache and you will see marked improvement in speed if these commands are able to reuse the same cache in a shell session. LAN sessions will send a periodic keepalive command to keep the IPMI session from timing out. _sol_ _info_ [<**channel** **number**>] Retrieve information about the Serial-Over-LAN configuration on the specified channel. If no channel is given, it will display SOL configuration data for the currently used channel. _payload_ <_enable_ | _disable_ | _status_> <**channel** **number**> <**userid**> Enable, disable or show status of SOL payload for the user on the specified channel. _set_ <**parameter**> <**value**> [<**channel**>] Configure parameters for Serial Over Lan. If no channel is given, it will dis‐ play SOL configuration data for the currently used channel. Configuration pa‐ rameter updates are automatically guarded with the updates to the set-in-progress parameter. Valid parameters and values are: _set-in-progress_ set-complete set-in-progress commit-write _enabled_ true false _force-encryption_ true false _force-authentication_ true false _privilege-level_ user operator admin oem _character-accumulate-level_ Decimal number given in 5 milliseconds increments _character-send-threshold_ Decimal number _retry-count_ Decimal number. 0 indicates no retries after packet is transmitted. _retry-interval_ Decimal number in 10 millisecond increments. 0 indicates that retries should be sent back to back. _non-volatile-bit-rate_ serial, 19.2, 38.4, 57.6, 115.2. Setting this value to serial indicates that the BMC should use the setting used by the IPMI over serial chan‐ nel. _volatile-bit-rate_ serial, 19.2, 38.4, 57.6, 115.2. Setting this value to serial indicates that the BMC should use the setting used by the IPMI over serial chan‐ nel. _activate_ [_usesolkeepalive_ | _nokeepalive_] [_instance=_] Causes ipmitool to enter Serial Over LAN mode, and is only available when using the lanplus interface. An RMCP+ connection is made to the BMC, the terminal is set to raw mode, and user input is sent to the serial console on the remote server. On exit, the the SOL payload mode is deactivated and the terminal is reset to its original settings. If the instance is given, it will activate using the given instance number. The default is 1. Special escape sequences are provided to control the SOL session: _~._ Terminate connection _~^Z_ Suspend ipmitool _~^X_ Suspend ipmitool, but don't restore tty on restart _~B_ Send break _~~_ Send the escape character by typing it twice _~?_ Print the supported escape sequences Note that escapes are only recognized immediately after newline. _deactivate_ [_instance=_] Deactivates Serial Over LAN mode on the BMC. Exiting Serial Over LAN mode should automatically cause this command to be sent to the BMC, but in the case of an unintentional exit from SOL mode, this command may be necessary to reset the state of the BMC. If the instance is given, it will deactivate the given instance number. The default is 1. _spd_ <**i2cbus**> <**i2caddr**> [<**channel**>] [] This command may be used to read SPD (Serial Presence Detect) data using the I2C Mas‐ ter Write-Read IPMI command. _sunoem_ _cli_ [<**command** **string**> ...] Execute the service processor command line interface commands. Without any command string, an interactive session is started in the service processor com‐ mand line environment. If a command string is specified, the command string is executed on the service processor and the connection is closed. _led_ These commands provide a way to get and set the status of LEDs on a Sun Mi‐ crosystems server. Use 'sdr list generic' to get a list of devices that are controllable LEDs. The _ledtype_ parameter is optional and not necessary to pro‐ vide on the command line unless it is required by hardware. _get_ <**sensorid**> [<**ledtype**>] Get status of a particular LED described by a Generic Device Locator record in the SDR. A sensorid of _all_ will get the status of all avail‐ able LEDS. _set_ <**sensorid**> <**ledmode**> [<**ledtype**>] Set status of a particular LED described by a Generic Device Locator record in the SDR. A sensorid of _all_ will set the status of all avail‐ able LEDS to the specified _ledmode_ and _ledtype_. LED Mode is required for set operations: _OFF_ Off _ON_ Steady On _STANDBY_ 100ms on 2900ms off blink rate _SLOW_ 1HZ blink rate _FAST_ 4HZ blink rate LED Type is optional: _OK2RM_ Ok to Remove _SERVICE_ Service Required _ACT_ Activity _LOCATE_ Locate _nacname_ <**ipmi** **name**> Return the full NAC name of a target identified by ipmi name. _ping_ <**count**> [<**q**>] Send and receive count packets. Each packet is 64 bytes. q - Quiet. Displays output only at the start and end of the process. _getval_ <**property** **name**> Returns value of specified ILOM property. _setval_ <**property** **name**> <**property** **value**> [<**timeout**>] Sets value of ILOM property. If timeout is not specified, the default value is 5 seconds. NOTE: setval must be executed locally on host! _sshkey_ _set_ <**userid**> <**keyfile**> This command will allow you to specify an SSH key to use for a particu‐ lar user on the Service Processor. This key will be used for CLI logins to the SP and not for IPMI sessions. View available users and their userids with the 'user list' command. _del_ <**userid**> This command will delete the SSH key for a specified userid. _version_ Display the version of ILOM firmware. _getfile_ <**file** **identifier**> <**destination** **file** **name**> This command will return various files from service processor and store them in specified destination file. Note that some files may not be present or be sup‐ ported by your SP. File identifiers: _SSH_PUBKEYS_ _DIAG_PASSED_ _DIAG_FAILED_ _DIAG_END_TIME_ _DIAG_INVENTORY_ _DIAG_TEST_LOG_ _DIAG_START_TIME_ _DIAG_UEFI_LOG_ _DIAG_TEST_LOG_ _DIAG_LAST_LOG_ _DIAG_LAST_CMD_ _getbehavior_ <**feature** **identifier**> This command will test if various ILOM features are enabled. Feature identifiers: _SUPPORTS_SIGNED_PACKAGES_ _REQUIRES_SIGNED_PACKAGES_ _tsol_ This command allows Serial-over-LAN sessions to be established with Tyan IPMIv1.5 SMDC such as the M3289 or M3290. The default command run with no arguments will establish default SOL session back to local IP address. Optional arguments may be supplied in any order. __ Send receiver IP address to SMDC which it will use to send serial traffic to. By default this detects the local IP address and establishes two-way session. Format of ipaddr is XX.XX.XX.XX _port=NUM_ Configure UDP port to receive serial traffic on. By default this is 6230. _ro|rw_ Confiure SOL session as read-only or read-write. Sessions are read-write by default. _user_ _summary_ Displays a summary of userid information, including maximum number of userids, the number of enabled users, and the number of fixed names defined. _list_ Displays a list of user information for all defined userids. _set_ _name_ <**userid**> <**username**> Sets the username associated with the given userid. _password_ <**userid**> [<**password**>] Sets the password for the given userid. If no password is given, the password is cleared (set to the NULL password). Be careful when remov‐ ing passwords from administrator-level accounts. _disable_ <**userid**> Disables access to the BMC by the given userid. _enable_ <**userid**> Enables access to the BMC by the given userid. _priv_ <**userid**> <**privilege** **level**> [<**channel** **number**>] Set user privilege level on the specified channel. If the channel is not spec‐ ified, the current channel will be used. _test_ <**userid**> <**16**|**20**> [<**password**>] Determine whether a password has been stored as 16 or 20 bytes. ## OPEN INTERFACE The ipmitool _open_ interface utilizes the OpenIPMI kernel device driver. This driver is present in all modern 2.4 and all 2.6 kernels and it should be present in recent Linux dis‐ tribution kernels. There are also IPMI driver kernel patches for different kernel versions available from the OpenIPMI homepage. The required kernel modules is different for 2.4 and 2.6 kernels. The following kernel mod‐ ules must be loaded on a 2.4-based kernel in order for ipmitool to work: **ipmi**___**msghandler** Incoming and outgoing message handler for IPMI interfaces. **ipmi**___**kcs**___**drv** An IPMI Keyboard Controller Style (KCS) interface driver for the message handler. **ipmi**___**devintf** Linux character device interface for the message handler. The following kernel modules must be loaded on a 2.6-based kernel in order for ipmitool to work: **ipmi**___**msghandler** Incoming and outgoing message handler for IPMI interfaces. **ipmi**___**si** An IPMI system interface driver for the message handler. This module supports various IPMI system interfaces such as KCS, BT, SMIC, and even SMBus in 2.6 kernels. **ipmi**___**devintf** Linux character device interface for the message handler. Once the required modules are loaded there will be a dynamic character device entry that must exist at **/dev/ipmi0**. For systems that use devfs or udev this will appear at **/dev/ipmi/0**. To create the device node first determine what dynamic major number it was assigned by the kernel by looking in **/proc/devices** and checking for the _ipmidev_ entry. Usually if this is the first dynamic device it will be major number **254** and the minor number for the first sys‐ tem interface is **0** so you would create the device entry with: _mknod_ _/dev/ipmi0_ _c_ _254_ _0_ ipmitool includes some sample initialization scripts that can perform this task automatically at start-up. In order to have ipmitool use the OpenIPMI device interface you can specify it on the command line: ipmitool **-I** _open_ <_command_> ## BMC INTERFACE The ipmitool bmc interface utilizes the _bmc_ device driver as provided by Solaris 10 and higher. In order to force ipmitool to make use of this interface you can specify it on the command line: ipmitool **-I** _bmc_ <_command_> The following files are associated with the bmc driver: ### /platform/i86pc/kernel/drv/bmc 32-bit **ELF** kernel module for the bmc driver. ### /platform/i86pc/kernel/drv/amd64/bmc 64-bit **ELF** kernel module for the bmc driver. ### /dev/bmc Character device node used to communicate with the bmc driver. ## LIPMI INTERFACE The ipmitool _lipmi_ interface uses the Solaris 9 IPMI kernel device driver. It has been su‐ perceeded by the _bmc_ interface on Solaris 10. You can tell ipmitool to use this interface by specifying it on the command line. ipmitool **-I** _lipmi_ <_expression_> ## LAN INTERFACE The ipmitool _lan_ interface communicates with the BMC over an Ethernet LAN connection using UDP under IPv4. UDP datagrams are formatted to contain IPMI request/response messages with a IPMI session headers and RMCP headers. IPMI-over-LAN uses version 1 of the Remote Management Control Protocol (RMCP) to support pre-OS and OS-absent management. RMCP is a request-response protocol delivered using UDP datagrams to port 623. The LAN interface is an authentication multi-session connection; messages delivered to the BMC can (and should) be authenticated with a challenge/response protocol with either straight password/key or MD5 message-digest algorithm. ipmitool will attempt to connect with adminis‐ trator privilege level as this is required to perform chassis power functions. You can tell ipmitool to use the lan interface with the **-I** _lan_ option: ipmitool **-I** _lan_ **-H** <_hostname_> [**-U** <_username_>] [**-P** <_password_>] <_command_> A hostname must be given on the command line in order to use the lan interface with ipmitool. The password field is optional; if you do not provide a password on the command line, ipmi‐ tool will attempt to connect without authentication. If you specify a password it will use MD5 authentication if supported by the BMC and straight password/key otherwise, unless over‐ ridden with a command line option. ## LANPLUS INTERFACE Like the _lan_ interface, the _lanplus_ interface communicates with the BMC over an Ethernet LAN connection using UDP under IPv4. The difference is that the _lanplus_ interface uses the RMCP+ protocol as described in the IPMI v2.0 specification. RMCP+ allows for improved authentica‐ tion and data integrity checks, as well as encryption and the ability to carry multiple types of payloads. Generic Serial Over LAN support requires RMCP+, so the ipmitool _sol_ _activate_ command requires the use of the _lanplus_ interface. RMCP+ session establishment uses a symmetric challenge-response protocol called RAKP (**Remote** **Authenticated** **Key-Exchange** **Protocol**) which allows the negotiation of many options. ipmitool does not yet allow the user to specify the value of every option, defaulting to the most ob‐ vious settings marked as required in the v2.0 specification. Authentication and integrity HMACS are produced with SHA1, and encryption is performed with AES-CBC-128. Role-level lo‐ gins are not yet supported. ipmitool must be linked with the _OpenSSL_ library in order to perform the encryption functions and support the _lanplus_ interface. If the required packages are not found it will not be compiled in and supported. You can tell ipmitool to use the lanplus interface with the **-I** _lanplus_ option: ipmitool **-I** _lanplus_ **-H** <_hostname_> [**-U** <_username_>] [**-P** <_password_>] <_command_> A hostname must be given on the command line in order to use the lan interface with ipmitool. With the exception of the **-A** and **-C** options the rest of the command line options are identi‐ cal to those available for the _lan_ interface. The **-C** option allows you specify the authentication, integrity, and encryption algorithms to use for for _lanplus_ session based on the cipher suite ID found in the IPMIv2.0 specification in table 22-19. The default cipher suite is _3_ which specifies RAKP-HMAC-SHA1 authentication, HMAC-SHA1-96 integrity, and AES-CBC-128 encryption algorithms. ## FREE INTERFACE The ipmitool _free_ interface utilizes the FreeIPMI libfreeipmi drivers. You can tell ipmitool to use the FreeIPMI interface with the -I option: ipmitool **-I** _free_ <_command_> ## IMB INTERFACE The ipmitool _imb_ interface supports the Intel IMB (Intel Inter-module Bus) Interface through the /dev/imb device. You can tell ipmitool to use the IMB interface with the -I option: ipmitool **-I** _imb_ <_command_> ## EXAMPLES _Example_ _1_: Listing remote sensors > ipmitool -I lan -H 1.2.3.4 -f passfile sdr list Baseboard 1.25V | 1.24 Volts | ok Baseboard 2.5V | 2.49 Volts | ok Baseboard 3.3V | 3.32 Volts | ok _Example_ _2_: Displaying status of a remote sensor > ipmitool -I lan -H 1.2.3.4 -f passfile sensor get "Baseboard 1.25V" Locating sensor record... Sensor ID : Baseboard 1.25V (0x10) Sensor Type (Analog) : Voltage Sensor Reading : 1.245 (+/- 0.039) Volts Status : ok Lower Non-Recoverable : na Lower Critical : 1.078 Lower Non-Critical : 1.107 Upper Non-Critical : 1.382 Upper Critical : 1.431 Upper Non-Recoverable : na _Example_ _3_: Displaying the power status of a remote chassis > ipmitool -I lan -H 1.2.3.4 -f passfile chassis power status Chassis Power is on _Example_ _4_: Controlling the power on a remote chassis > ipmitool -I lan -H 1.2.3.4 -f passfile chassis power on Chassis Power Control: Up/On ## AUTHOR Duncan Laurie <> ## SEE ALSO IPMItool Homepage Intelligent Platform Management Interface Specification OpenIPMI Homepage FreeIPMI Homepage Duncan Laurie [ipmitool(1)](https://www.chedong.com/phpMan.php/man/ipmitool/1/markdown)