{ "content": [ { "type": "text", "text": "# ipmitool (man)\n\n## NAME\n\nipmitool - utility for controlling IPMI-enabled devices\n\n## SYNOPSIS\n\nipmitool [ ] [ ]\n := [ | ]\nAny recognized option is accepted. Conditional options may be ignored or it's usage postponed\nuntil shell or exec processes relevant command.\n := [ -h | -V | -v | -I | -H
|\n-d | -p | -c | -U |\n-L | -l | -m |\n-N | -R | |\n | ]\n := [ | |\n ]\nBridging:\n := -t [ -b |\n[ -T
| -B ] ]\nOptions used with -I lan:\n := [ -A ]\nOptions used with -I lanplus:\n := [ -C | ]\nOption groups setting same value:\n := [ -k | -K | -y | -Y ]\n := [ -f | -a | -P | -E ]\n := [ -o | -g | -s ]\nOptions used with specific command :\n := [ -S ]\n := [ -O ]\n := [ -e ]\n\n## DESCRIPTION\n\nThis program lets you manage Intelligent Platform Management Interface (IPMI) functions of\neither the local system, via a kernel device driver, or a remote system, using IPMI v1.5 and\nIPMI v2.0. These functions include printing FRU information, LAN configuration, sensor read‐\nings, and remote chassis power control.\n\n## TLDR\n\n> Interface with the Intelligent Platform Management Interface (IPMI).\n\n- Open IPMI shell on the local hardware:\n `sudo ipmitool shell`\n- Open IPMI shell on a remote host:\n `ipmitool -H {{ip_address}} -U {{user_name}} shell`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (38 subsections)\n- **SECURITY**\n- **COMMANDS**\n- **OPEN INTERFACE**\n- **BMC INTERFACE** (3 subsections)\n- **LIPMI INTERFACE**\n- **LAN INTERFACE**\n- **LANPLUS INTERFACE**\n- **FREE INTERFACE**\n- **IMB INTERFACE**\n- **EXAMPLES**\n- **AUTHOR**\n- **SEE ALSO**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "ipmitool", "section": "", "mode": "man", "summary": "ipmitool - utility for controlling IPMI-enabled devices", "synopsis": "ipmitool [ ] [ ]\n := [ | ]\nAny recognized option is accepted. Conditional options may be ignored or it's usage postponed\nuntil shell or exec processes relevant command.\n := [ -h | -V | -v | -I | -H
|\n-d | -p | -c | -U |\n-L | -l | -m |\n-N | -R | |\n | ]\n := [ | |\n ]\nBridging:\n := -t [ -b |\n[ -T
| -B ] ]\nOptions used with -I lan:\n := [ -A ]\nOptions used with -I lanplus:\n := [ -C | ]\nOption groups setting same value:\n := [ -k | -K | -y | -Y ]\n := [ -f | -a | -P | -E ]\n := [ -o | -g | -s ]\nOptions used with specific command :\n := [ -S ]\n := [ -O ]\n := [ -e ]", "tldr_summary": "Interface with the Intelligent Platform Management Interface (IPMI).", "tldr_examples": [ { "description": "Open IPMI shell on the local hardware", "command": "sudo ipmitool shell" }, { "description": "Open IPMI shell on a remote host", "command": "ipmitool -H {{ip_address}} -U {{user_name}} shell" } ], "tldr_source": "official", "flags": [ { "flag": "-a", "long": null, "arg": null, "description": "" }, { "flag": "-A", "long": null, "arg": null, "description": "Specify an authentication type to use during IPMIv1.5 lan session activation. Sup‐ ported types are NONE, PASSWORD, MD2, MD5, or OEM." }, { "flag": "-b", "long": null, "arg": null, "description": "Set destination channel for bridged request." }, { "flag": "-B", "long": null, "arg": null, "description": "Set transit channel for bridged request (dual bridge)." }, { "flag": "-b", "long": null, "arg": null, "description": "Set destination channel for bridged request." }, { "flag": "-B", "long": null, "arg": null, "description": "Set transit channel for bridged request. (dual bridge)" }, { "flag": "-c", "long": null, "arg": null, "description": "all commands." }, { "flag": "-C", "long": null, "arg": null, "description": "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." }, { "flag": "-d", "long": null, "arg": null, "description": "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." }, { "flag": "-e", "long": null, "arg": null, "description": "Use supplied character for SOL session escape character. The default is to use ~ but this can conflict with ssh sessions." }, { "flag": "-E", "long": null, "arg": null, "description": "IPMITOOLPASSWORD. The IPMITOOLPASSWORD takes precedence." }, { "flag": "-f", "long": null, "arg": null, "description": "Specifies a file containing the remote server password. If this option is absent, or if passwordfile is empty, the password will default to NULL." }, { "flag": "-g", "long": null, "arg": null, "description": "" }, { "flag": "-h", "long": null, "arg": null, "description": "" }, { "flag": "-H", "long": null, "arg": null, "description": "Remote server address, can be IP address or hostname. This option is required for lan and lanplus interfaces." }, { "flag": "-I", "long": null, "arg": null, "description": "Selects IPMI interface to use. Supported interfaces that are compiled in are visible in the usage help output." }, { "flag": "-k", "long": null, "arg": null, "description": "Use supplied Kg key for IPMIv2.0 authentication. The default is not to use any Kg key." }, { "flag": "-K", "long": null, "arg": null, "description": "" }, { "flag": "-l", "long": null, "arg": null, "description": "Set destination lun for raw commands." }, { "flag": "-L", "long": null, "arg": null, "description": "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." }, { "flag": "-m", "long": null, "arg": null, "description": "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." }, { "flag": "-N", "long": null, "arg": null, "description": "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." }, { "flag": "-o", "long": null, "arg": null, "description": "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." }, { "flag": "-O", "long": null, "arg": null, "description": "Open selected file and read OEM SEL event descriptions to be used during SEL listings. See examples in contrib dir for file format." }, { "flag": "-p", "long": null, "arg": null, "description": "Remote server UDP port to connect to. Default is 623." }, { "flag": "-P", "long": null, "arg": null, "description": "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." }, { "flag": "-R", "long": null, "arg": null, "description": "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." }, { "flag": "-s", "long": null, "arg": null, "description": "" }, { "flag": "-S", "long": null, "arg": null, "description": "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." }, { "flag": "-t", "long": null, "arg": null, "description": "Bridge IPMI requests to the remote target address. Default is 32. The -L privlvl op‐ tion is always ignored and value set to ADMINISTRATOR." }, { "flag": "-T", "long": null, "arg": null, "description": "Set transit address for bridge request (dual bridge)." }, { "flag": "-T", "long": null, "arg": null, "description": "Set transit address for bridge request. (dual bridge)" }, { "flag": "-U", "long": null, "arg": null, "description": "Remote server username, default is NULL user." }, { "flag": "-v", "long": null, "arg": null, "description": "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" }, { "flag": "-V", "long": null, "arg": null, "description": "" }, { "flag": "-y", "long": null, "arg": null, "description": "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." }, { "flag": "-Y", "long": null, "arg": null, "description": "" }, { "flag": "-z", "long": null, "arg": null, "description": "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." } ], "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" ], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 36, "subsections": [] }, { "name": "DESCRIPTION", "lines": 12, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "-a", "lines": 1, "flag": "-a" }, { "name": "-A", "lines": 3, "flag": "-A" }, { "name": "-b", "lines": 2, "flag": "-b" }, { "name": "-B", "lines": 2, "flag": "-B" }, { "name": "-b", "lines": 2, "flag": "-b" }, { "name": "-B", "lines": 2, "flag": "-B" }, { "name": "-c", "lines": 2, "flag": "-c" }, { "name": "-C", "lines": 5, "flag": "-C" }, { "name": "-d", "lines": 3, "flag": "-d" }, { "name": "-e", "lines": 3, "flag": "-e" }, { "name": "-E", "lines": 2, "flag": "-E" }, { "name": "-f", "lines": 3, "flag": "-f" }, { "name": "-g", "lines": 1, "flag": "-g" }, { "name": "-h", "lines": 1, "flag": "-h" }, { "name": "-H", "lines": 3, "flag": "-H" }, { "name": "-I", "lines": 3, "flag": "-I" }, { "name": "-k", "lines": 3, "flag": "-k" }, { "name": "-K", "lines": 1, "flag": "-K" }, { "name": "-l", "lines": 2, "flag": "-l" }, { "name": "-L", "lines": 4, "flag": "-L" }, { "name": "-m", "lines": 4, "flag": "-m" }, { "name": "-N", "lines": 4, "flag": "-N" }, { "name": "-o", "lines": 4, "flag": "-o" }, { "name": "-O", "lines": 3, "flag": "-O" }, { "name": "-p", "lines": 2, "flag": "-p" }, { "name": "-P", "lines": 4, "flag": "-P" }, { "name": "-R", "lines": 3, "flag": "-R" }, { "name": "-s", "lines": 1, "flag": "-s" }, { "name": "-S", "lines": 5, "flag": "-S" }, { "name": "-t", "lines": 3, "flag": "-t" }, { "name": "-T", "lines": 2, "flag": "-T" }, { "name": "-T", "lines": 2, "flag": "-T" }, { "name": "-U", "lines": 2, "flag": "-U" }, { "name": "-v", "lines": 5, "flag": "-v" }, { "name": "-V", "lines": 1, "flag": "-V" }, { "name": "-y", "lines": 4, "flag": "-y" }, { "name": "-Y", "lines": 1, "flag": "-Y" }, { "name": "-z", "lines": 6, "flag": "-z" } ] }, { "name": "SECURITY", "lines": 20, "subsections": [] }, { "name": "COMMANDS", "lines": 2473, "subsections": [] }, { "name": "OPEN INTERFACE", "lines": 48, "subsections": [] }, { "name": "BMC INTERFACE", "lines": 9, "subsections": [ { "name": "/platform/i86pc/kernel/drv/bmc", "lines": 2 }, { "name": "/platform/i86pc/kernel/drv/amd64/bmc", "lines": 2 }, { "name": "/dev/bmc", "lines": 2 } ] }, { "name": "LIPMI INTERFACE", "lines": 6, "subsections": [] }, { "name": "LAN INTERFACE", "lines": 24, "subsections": [] }, { "name": "LANPLUS INTERFACE", "lines": 33, "subsections": [] }, { "name": "FREE INTERFACE", "lines": 8, "subsections": [] }, { "name": "IMB INTERFACE", "lines": 8, "subsections": [] }, { "name": "EXAMPLES", "lines": 32, "subsections": [] }, { "name": "AUTHOR", "lines": 2, "subsections": [] }, { "name": "SEE ALSO", "lines": 15, "subsections": [] } ], "sections": { "NAME": { "content": "ipmitool - utility for controlling IPMI-enabled devices\n", "subsections": [] }, "SYNOPSIS": { "content": "ipmitool [ ] [ ]\n\n := [ | ]\nAny recognized option is accepted. Conditional options may be ignored or it's usage postponed\nuntil shell or exec processes relevant command.\n\n := [ -h | -V | -v | -I | -H
|\n-d | -p | -c | -U |\n-L | -l | -m |\n-N | -R | |\n | ]\n\n := [ | |\n ]\nBridging:\n := -t [ -b |\n[ -T
| -B ] ]\n\nOptions used with -I lan:\n := [ -A ]\n\nOptions used with -I lanplus:\n := [ -C | ]\n\nOption groups setting same value:\n := [ -k | -K | -y | -Y ]\n := [ -f | -a | -P | -E ]\n := [ -o | -g | -s ]\n\nOptions used with specific command :\n := [ -S ]\n := [ -O ]\n := [ -e ]\n\n\n", "subsections": [] }, "DESCRIPTION": { "content": "This program lets you manage Intelligent Platform Management Interface (IPMI) functions of\neither the local system, via a kernel device driver, or a remote system, using IPMI v1.5 and\nIPMI v2.0. These functions include printing FRU information, LAN configuration, sensor read‐\nings, and remote chassis power control.\n\nIPMI management of a local system interface requires a compatible IPMI kernel driver to be\ninstalled and configured. On Linux this driver is called OpenIPMI and it is included in\nstandard distributions. On Solaris this driver is called BMC and is included in Solaris 10.\nManagement of a remote station requires the IPMI-over-LAN interface to be enabled and config‐\nured. Depending on the particular requirements of each system it may be possible to enable\nthe LAN interface using ipmitool over the system interface.\n", "subsections": [] }, "OPTIONS": { "content": "", "subsections": [ { "name": "-a", "content": "", "flag": "-a" }, { "name": "-A", "content": "Specify an authentication type to use during IPMIv1.5 lan session activation. Sup‐\nported types are NONE, PASSWORD, MD2, MD5, or OEM.\n", "flag": "-A" }, { "name": "-b", "content": "Set destination channel for bridged request.\n", "flag": "-b" }, { "name": "-B", "content": "Set transit channel for bridged request (dual bridge).\n", "flag": "-B" }, { "name": "-b", "content": "Set destination channel for bridged request.\n", "flag": "-b" }, { "name": "-B", "content": "Set transit channel for bridged request. (dual bridge)\n", "flag": "-B" }, { "name": "-c", "content": "all commands.\n", "flag": "-c" }, { "name": "-C", "content": "The remote server authentication, integrity, and encryption algorithms to use for IP‐\nMIv2.0 lanplus connections. See table 22-19 in the IPMIv2.0 specification. The de‐\nfault is 3 which specifies RAKP-HMAC-SHA1 authentication, HMAC-SHA1-96 integrity, and\nAES-CBC-128 encryption algorithms.\n", "flag": "-C" }, { "name": "-d", "content": "vice to use for in-band BMC communication. Used to target a specific BMC on a multi-\nnode, multi-BMC system through the ipmi device driver interface. Default is 0.\n", "flag": "-d" }, { "name": "-e", "content": "Use supplied character for SOL session escape character. The default is to use ~ but\nthis can conflict with ssh sessions.\n", "flag": "-e" }, { "name": "-E", "content": "IPMITOOLPASSWORD. The IPMITOOLPASSWORD takes precedence.\n", "flag": "-E" }, { "name": "-f", "content": "Specifies a file containing the remote server password. If this option is absent, or\nif passwordfile is empty, the password will default to NULL.\n", "flag": "-f" }, { "name": "-g", "content": "", "flag": "-g" }, { "name": "-h", "content": "", "flag": "-h" }, { "name": "-H", "content": "Remote server address, can be IP address or hostname. This option is required for lan\nand lanplus interfaces.\n", "flag": "-H" }, { "name": "-I", "content": "Selects IPMI interface to use. Supported interfaces that are compiled in are visible\nin the usage help output.\n", "flag": "-I" }, { "name": "-k", "content": "Use supplied Kg key for IPMIv2.0 authentication. The default is not to use any Kg\nkey.\n", "flag": "-k" }, { "name": "-K", "content": "", "flag": "-K" }, { "name": "-l", "content": "Set destination lun for raw commands.\n", "flag": "-l" }, { "name": "-L", "content": "Force session privilege level. Can be CALLBACK, USER, OPERATOR, ADMINISTRATOR. De‐\nfault is ADMINISTRATOR. This value is ignored and always set to ADMINISTRATOR when\ncombined with -t target address.\n", "flag": "-L" }, { "name": "-m", "content": "Set the local IPMB address. The local address defaults to 0x20 or is auto discovered\non PICMG platforms when -m is not specified. There should be no need to change the\nlocal address for normal operation.\n", "flag": "-m" }, { "name": "-N", "content": "Specify nr. of seconds between retransmissions of lan/lanplus messages. Defaults are\n2 seconds for lan and 1 second for lanplus interfaces. Command raw uses fixed value\nof 15 seconds. Command sol uses fixed value of 1 second.\n", "flag": "-N" }, { "name": "-o", "content": "Select OEM type to support. This usually involves minor hacks in place in the code to\nwork around quirks in various BMCs from various manufacturers. Use -o list to see a\nlist of current supported OEM types.\n", "flag": "-o" }, { "name": "-O", "content": "Open selected file and read OEM SEL event descriptions to be used during SEL listings.\nSee examples in contrib dir for file format.\n", "flag": "-O" }, { "name": "-p", "content": "Remote server UDP port to connect to. Default is 623.\n", "flag": "-p" }, { "name": "-P", "content": "Remote server password is specified on the command line. If supported it will be ob‐\nscured in the process list. Note! Specifying the password as a command line option is\nnot recommended.\n", "flag": "-P" }, { "name": "-R", "content": "Set the number of retries for lan/lanplus interface (default=4). Command raw uses\nfixed value of one try (no retries). Command hpm uses fixed value of 10 retries.\n", "flag": "-R" }, { "name": "-s", "content": "", "flag": "-s" }, { "name": "-S", "content": "Use local file for remote SDR cache. Using a local SDR cache can drastically increase\nperformance for commands that require knowledge of the entire SDR to perform their\nfunction. Local SDR cache from a remote system can be created with the sdr dump com‐\nmand.\n", "flag": "-S" }, { "name": "-t", "content": "Bridge IPMI requests to the remote target address. Default is 32. The -L privlvl op‐\ntion is always ignored and value set to ADMINISTRATOR.\n", "flag": "-t" }, { "name": "-T", "content": "Set transit address for bridge request (dual bridge).\n", "flag": "-T" }, { "name": "-T", "content": "Set transit address for bridge request. (dual bridge)\n", "flag": "-T" }, { "name": "-U", "content": "Remote server username, default is NULL user.\n", "flag": "-U" }, { "name": "-v", "content": "crease the level of debug output. If given three times you will get hexdumps of all\nincoming and outgoing packets. Using it five times provides details on request and ex‐\npected reply procesing. The hpm commands targetcap compprop abort upgstatus rollback\nrollbackstatus selftestresult increases the verbosity level\n", "flag": "-v" }, { "name": "-V", "content": "", "flag": "-V" }, { "name": "-y", "content": "Use supplied Kg key for IPMIv2.0 authentication. The key is expected in hexadecimal\nformat and can be used to specify keys with non-printable characters. E.g. '-k PASS‐\nWORD' and '-y 50415353574F5244' are equivalent. The default is not to use any Kg key.\n", "flag": "-y" }, { "name": "-Y", "content": "", "flag": "-Y" }, { "name": "-z", "content": "Change Size of Communication Channel. (OEM)\n\n\nIf no password method is specified then ipmitool will prompt the user for a password. If no\npassword is entered at the prompt, the remote server password will default to NULL.\n", "flag": "-z" } ] }, "SECURITY": { "content": "There are several security issues be be considered before enabling the IPMI LAN interface. A\nremote station has the ability to control a system's power state as well as being able to\ngather certain platform information. To reduce vulnerability it is strongly advised that the\nIPMI LAN interface only be enabled in 'trusted' environments where system security is not an\nissue or where there is a dedicated secure 'management network'.\n\nFurther it is strongly advised that you should not enable IPMI for remote access without set‐\nting a password, and that that password should not be the same as any other password on that\nsystem.\n\nWhen an IPMI password is changed on a remote machine with the IPMIv1.5 lan interface the new\npassword is sent across the network as clear text. This could be observed and then used to\nattack the remote system. It is thus recommended that IPMI password management only be done\nover IPMIv2.0 lanplus interface or the system interface on the local station.\n\nFor IPMI v1.5, the maximum password length is 16 characters. Passwords longer than 16 char‐\nacters will be truncated.\n\nFor IPMI v2.0, the maximum password length is 20 characters; longer passwords are truncated.\n", "subsections": [] }, "COMMANDS": { "content": "help This can be used to get command-line help on ipmitool commands. It may also be\nplaced at the end of commands to get option usage help.\n\nipmitool help\nCommands:\nbmc Deprecated. Use mc\nchannel Configure Management Controller channels\nchassis Get chassis status and set power state\ndcmi Data Center Management Interface\ndelloem Manage Dell OEM Extensions.\necho Used to echo lines to stdout in scripts\nekanalyzer run FRU-Ekeying analyzer using FRU files\nevent Send events to MC\nexec Run list of commands from file\nfirewall Configure Firmware Firewall\nfru Print built-in FRU and scan for FRU locators\nfwum Update IPMC using Kontron OEM Firmware Update Manager\ngendev Read/Write Device associated with Generic Device locators sdr\nhpm Update HPM components using PICMG HPM.1 file\ni2c Send an I2C Master Write-Read command and print response\nime Upgrade/Query Intel ME firmware\nisol Configure and connect Intel IPMIv1.5 Serial-over-LAN\nkontronoem Manage Kontron OEM Extensions\nlan Configure LAN Channels\nmc Management Controller status and global enables\nnm Node Manager\npef Configure Platform Event Filtering (PEF)\npicmg Run a PICMG/ATA extended command\npower Shortcut to chassis power commands\nraw Send a RAW IPMI request and print response\nsdr Print Sensor Data Repository entries and readings\nsel Print System Event Log (SEL)\nsensor Print detailed sensor information\nsession Print session information\nset Set runtime variable for shell and exec\nshell Launch interactive IPMI shell\nsol Configure and connect IPMIv2.0 Serial-over-LAN\nspd Print SPD info from remote I2C device\nsunoem Manage Sun OEM Extensions\ntsol Configure and connect Tyan IPMIv1.5 Serial-over-LAN\nuser Configure Management Controller users\n\n\nchannel\n\nauthcap \n\nDisplays information about the authentication capabilities of the selected\nchannel at the specified privilege level.\n\nPossible privilege levels are:\n1 Callback level\n2 User level\n3 Operator level\n4 Administrator level\n5 OEM Proprietary level\n15 No access\n\ninfo [channel number]\n\nDisplays information about the selected channel. If no channel is given it\nwill display information about the currently used channel.\n\n> ipmitool channel info\nChannel 0xf info:\nChannel Medium Type : System Interface\nChannel Protocol Type : KCS\nSession Support : session-less\nActive Session Count : 0\nProtocol Vendor ID : 7154\n\ngetaccess []\n\nConfigure the given userid as the default on the given channel number. When\nthe given channel is subsequently used, the user is identified implicitly by\nthe given userid.\n\nsetaccess []\n[] [] []\n\nConfigure user access information on the given channel for the given\nuserid.\n\ngetciphers []\n\nDisplays the list of cipher suites supported for the given application\n(ipmi or sol) on the given channel.\n\nchassis\n\nstatus\n\nStatus information related to power, buttons, cooling, drives and faults.\n\npower\n\nstatus\n\non\n\noff\n\ncycle\n\nreset\n\ndiag\n\nsoft\n\nidentify [|force]\n\nIdentify interval.\nDefault is 15 seconds.\n0 - Off\nforce - To turn on indefinitely\n\npolicy\n\nWhat to do when power is restored.\n\nlist\n\nShow available options.\n\nalways-on\n\nprevious\n\nalways-off\n\n\nrestartcause\n\nLast restart cause.\n\npoh\n\nGet power on hours.\n\nbootdev\n\nnone\n\nDo not change boot device order.\n\npxe\n\nForce PXE boot.\n\ndisk\n\nForce boot from default Hard-drive.\n\nsafe\n\nForce boot from default Hard-drive, request Safe Mode.\n\ndiag\n\nForce boot from Diagnostic Partition.\n\ncdrom\n\nForce boot from CD/DVD.\n\nbios\n\nForce boot into BIOS Setup.\n\nfloppy\n\nForce boot from Floppy/primary removable media.\n\nbootparam\n\nforcepxe\n\nForce PXE boot\n\nforcedisk\n\nForce boot from default Hard-drive\n\nforcesafe\n\nForce boot from default Hard-drive, request Safe Mode\n\nforcediag\n\nForce boot from Diagnostic Partition\n\nforcecdrom\n\nForce boot from CD/DVD\n\nforcebios\n\nForce boot into BIOS Setup\n\nselftest\n\ndcmi\n\ndiscover\n\nThis command is used to discover supported capabilities in DCMI.\n\n\npower \n\nPlatform power limit command options are:\n\n\nreading\n\nGet power related readings from the system.\n\ngetlimit\n\nGet the configured power limits.\n\nsetlimit \n\nSet a power limit option.\n\n\nPossible parameters/values are:\n\n\naction \n\nException Actions are taken as \"No Action\", \"Hard Power Off sys‐\ntem and log events to SEL\", or \"Log event to SEL only\".\n\nlimit \n\nPower Limit Requested in Watts.\n\ncorrection \n\nCorrection Time Limit in milliseconds.\n\nsample \n\nStatistics Sampling period in seconds.\n\n\nactivate\n\nActivate the set power limit.\n\ndeactivate\n\nDeactivate the set power limit.\n\nsensors\n\nPrints the available DCMI sensors.\n\nassettag\n\nPrints the platforms asset tag.\n\nsetassettag \n\nSets the platforms asset tag\n\ngetmcidstring\n\nGet management controller identifier string.\n\nsetmcidstring \n\nSet management controller identifier string. The maximum length is 64 bytes\nincluding a null terminator.\n\nthermalpolicy []\n\nThermal Limit policy get/set.\n\n\nThe commands are:\n\n\nGet \n\nGet Thermal Limit values.\n\nentityID is the physical entity that a sensor or device is associated\nwith. instanceID is a particular instance of an entity. Entity In‐\nstance can be in one of two ranges, system-relative or device-relative.\nFor example, a system with four processors could use an Entity Instance\nvalue of \"0\" to identify the first processor.\n\nSet \n\nSet Thermal Limit values.\n\nentityID is the physical entity that a sensor or device is associated\nwith. instanceID is a particular instance of an entity. Entity In‐\nstance can be in one of two ranges, system-relative or device-relative.\nFor example, a system with four processors could use an Entity Instance\nvalue of \"0\" to identify the first processor.\n\ngettempreading\n\nGet Temperature Sensor Readings.\n\ngetconfparam\n\nGet DCMI Configuration Parameters.\n\nsetconfparam \n\nSet DCMI Configuration Parameters.\n\nThe Configuration Parameters are:\n\nactivatedhcp\n\nActivate/restart DHCP\n\ndhcpconfig\n\nDiscover DHCP Configuration.\n\ninit\n\nSet DHCP Initial timeout interval, in seconds. The recommended default\nis four seconds.\n\ntimeout\n\nSet DHCP Server contact timeout interval, in seconds. The recommended\ndefault timeout is two minutes.\n\nretry\n\nSet DHCP Server contact retry interval, in seconds. The recommended de‐\nfault timeout is sixty-four seconds.\n\noobdiscover\n\nPing/Pong Message for DCMI Discovery.\n\n\ndelloem\n\nThe delloem commands provide information on Dell-specific features.\n\nsetled {b:d.f} {state..}\n\nSets the drive backplane LEDs for a device.\n{b:d.f} = PCI Address of device (eg. 06:00.0)\n{state} = one or more of the following:\nonline | present | hotspare | identify | rebuilding | fault | predict |\ncritical | failed\n\n\nlcd\nset {mode}|{lcdqualifier}|{errordisplay}\n\nAllows you to set the LCD mode and user-defined string.\n\nlcd set mode\n{none}|{modelname}|{ipv4address}|{macaddress}|\n{systemname}|{servicetag}|{ipv6address}|\n{ambienttemp}|{systemwatt}|{assettag}|\n{userdefined}\n\nAllows you to set the LCD display mode to any of the preceding parame‐\nters.\n\n\nlcd set lcdqualifier\n{watt}|{btuphr}|\n{celsius}|{fahrenheit}\n\nAllows you to set the unit for the system ambient temperature mode.\n\n\nlcd set errordisplay\n{sel}|{simple}\n\nAllows you to set the error display.\n\nlcd info\n\nDisplays the LCD screen information.\n\nlcd set vkvm\n{active}|{inactive}\n\nAllows you to set the vKVM status to active or inactive. When it is ac‐\ntive and session is in progress, a message appears on LCD.\n\nlcd status\n\nDisplays the LCD status for vKVM display active or inactive and Front\nPanel access mode (viewandmodify, view-only or disabled).\n\nmac\n\nDisplays the information about the system NICs.\n\nmac list\n\nDisplays the NIC MAC address and status of all NICs. It also displays\nthe DRAC/iDRAC MAC address.\n\n\nmac get\n\n\nDisplays the selected NICs MAC address and status.\n\nlan\nDisplays the information of Lan.\n\n\nlan set\n\n\nSets the NIC selection mode (dedicated, shared with lom1, shared with\nlom2,shared with lom3,shared with lom4,shared with failover lom1,shared\nwith failover lom2,shared with failover lom3,shared with failover\nlom4,shared with Failover all loms, shared with Failover None).\n\nlan get\n\nReturns the current NIC selection mode (dedicated, shared with lom1,\nshared with lom2, shared with lom3, shared with lom4,shared with\nfailover lom1, shared with failover lom2,shared with failover\nlom3,shared with failover lom4,shared with Failover all loms,shared with\nFailover None).\n\n\nlan get active\n\nReturns the current active NIC (dedicated, LOM1, LOM2, LOM3 or LOM4).\n\npowermonitor\n\nDisplays power tracking statistics.\n\n\npowermonitor clear cumulativepower\n\nReset cumulative power reading.\n\npowermonitor clear peakpower\n\nReset peak power reading.\n\npowermonitor powerconsumption\n|\nDisplays the power consumption in watt or btuphr.\n\npowermonitor powerconsumptionhistory\n|\nDisplays the power consumption history in watt or btuphr.\n\npowermonitor getpowerbudget\n|\nDisplays the power cap in watt or btuphr.\n\npowermonitor setpowerbudget\n\nAllows you to set the power cap in watt, BTU/hr or percentage.\n\npowermonitor enablepowercap\nEnables set power cap.\n\npowermonitor disablepowercap\n\nDisables set power cap.\n\n\nvFlash info Card\n\nShows Extended SD Card information.\n\necho\n\nFor echoing lines to stdout in scripts.\n\nekanalyzer [] ...\n\nNOTE : This command can support a maximum of 8 files per command line\n\nfilename1 : binary file that stores FRU data of a Carrier or an AMC module\n\nfilename2 : binary file that stores FRU data of an AMC module.\nThese binary files can be generated from command:\nipmitool fru read \n\nfilename3 : configuration file used for configuring On-Carrier Device ID\nor OEM GUID. This file is optional.\n\nxx : indicates the type of the file. It can take the following value:\n\noc : On-Carrier device\n\na1 : AMC slot A1\n\na2 : AMC slot A2\n\na3 : AMC slot A3\n\na4 : AMC slot A4\n\nb1 : AMC slot B1\n\nb2 : AMC slot B2\n\nb3 : AMC slot B3\n\nb4 : AMC slot B4\n\nsm : Shelf Manager\n\n\nThe available commands for ekanalyzer are:\n\n\nprint []\n\ncarrier (default) ...\n\nDisplay point to point physical connectivity between carriers and AMC\nmodules.\nExample:\n> ipmitool ekanalyzer print carrier oc=fru oc=carrierfru\nFrom Carrier file: fru\nNumber of AMC bays supported by Carrier: 2\nAMC slot B1 topology:\nPort 0 =====> On Carrier Device ID 0, Port 16\nPort 1 =====> On Carrier Device ID 0, Port 12\nPort 2 =====> AMC slot B2, Port 2\nAMC slot B2 topology:\nPort 0 =====> On Carrier Device ID 0, Port 3\nPort 2 =====> AMC slot B1, Port 2\n*-*-*-* *-*-* *-*-* *-*-* *-*-* *-*-* *-*-*\nFrom Carrier file: carrierfru\nOn Carrier Device ID 0 topology:\nPort 0 =====> AMC slot B1, Port 4\nPort 1 =====> AMC slot B1, Port 5\nPort 2 =====> AMC slot B2, Port 6\nPort 3 =====> AMC slot B2, Port 7\nAMC slot B1 topology:\nPort 0 =====> AMC slot B2, Port 0\nAMC slot B1 topology:\nPort 1 =====> AMC slot B2, Port 1\nNumber of AMC bays supported by Carrier: 2\n\n\npower ...\n\nDisplay power supply information between carrier and AMC modules.\n\nall ...\n\nDisplay both physical connectivity and power supply of each carrier and\nAMC modules.\n\n\nfrushow \nConvert a binary FRU file into human readable text format. Use -v option to get\nmore display information.\n\n\nsummary []\n\nmatch (default) ...\nDisplay only matched results of Ekeying match between an On-Carrier de‐\nvice and an AMC module or between 2 AMC modules. Example:\n> ipmitool ekanalyzer summary match oc=fru b1=amcB1 a2=amcA2\nOn-Carrier Device vs AMC slot B1\nAMC slot B1 port 0 ==> On-Carrier Device 0 port 16\nMatching Result\n- From On-Carrier Device ID 0\n-Channel ID 11 || Lane 0: enable\n-Link Type: AMC.2 Ethernet\n-Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link\n-Link Group ID: 0 || Link Asym. Match: exact match\n- To AMC slot B1\n-Channel ID 0 || Lane 0: enable\n-Link Type: AMC.2 Ethernet\n-Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link\n-Link Group ID: 0 || Link Asym. Match: exact match\n*-*-*-* *-*-* *-*-* *-*-* *-*-* *-*-* *-*-*\nAMC slot B1 port 1 ==> On-Carrier Device 0 port 12\nMatching Result\n- From On-Carrier Device ID 0\n-Channel ID 6 || Lane 0: enable\n-Link Type: AMC.2 Ethernet\n-Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link\n-Link Group ID: 0 || Link Asym. Match: exact match\n- To AMC slot B1\n-Channel ID 1 || Lane 0: enable\n-Link Type: AMC.2 Ethernet\n-Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link\n-Link Group ID: 0 || Link Asym. Match: exact match\n*-*-*-* *-*-* *-*-* *-*-* *-*-* *-*-* *-*-*\nOn-Carrier Device vs AMC slot A2\nAMC slot A2 port 0 ==> On-Carrier Device 0 port 3\nMatching Result\n- From On-Carrier Device ID 0\n-Channel ID 9 || Lane 0: enable\n-Link Type: AMC.2 Ethernet\n-Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link\n-Link Group ID: 0 || Link Asym. Match: exact match\n- To AMC slot A2\n-Channel ID 0 || Lane 0: enable\n-Link Type: AMC.2 Ethernet\n-Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link\n-Link Group ID: 0 || Link Asym. Match: exact match\n*-*-*-* *-*-* *-*-* *-*-* *-*-* *-*-* *-*-*\nAMC slot B1 vs AMC slot A2\nAMC slot A2 port 2 ==> AMC slot B1 port 2\nMatching Result\n- From AMC slot B1\n-Channel ID 2 || Lane 0: enable\n-Link Type: AMC.3 Storage\n-Link Type extension: Serial Attached SCSI (SAS/SATA)\n-Link Group ID: 0 || Link Asym. Match: FC or SAS interface {exact\nmatch}\n- To AMC slot A2\n-Channel ID 2 || Lane 0: enable\n-Link Type: AMC.3 Storage\n-Link Type extension: Serial Attached SCSI (SAS/SATA)\n-Link Group ID: 0 || Link Asym. Match: FC or SAS interface {exact\nmatch}\n*-*-*-* *-*-* *-*-* *-*-* *-*-* *-*-* *-*-*\n\nunmatch ...\n\nDisplay the unmatched results of Ekeying match between an On-Carrier de‐\nvice and an AMC module or between 2 AMC modules\n\nall ...\n\nDisplay both matched result and unmatched results of Ekeying match be‐\ntween two cards or two modules.\n\nevent\n\n\n\nSend a pre-defined test event to the System Event Log. The following events\nare included as a means to test the functionality of the System Event Log com‐\nponent of the BMC (an entry will be added each time the event N command is exe‐\ncuted).\n\nCurrently supported values for N are:\n1 Temperature: Upper Critical: Going High\n2 Voltage Threshold: Lower Critical: Going Low\n3 Memory: Correctable ECC\n\nNOTE: These pre-defined events will likely not produce \"accurate\" SEL records\nfor a particular system because they will not be correctly tied to a valid sen‐\nsor number, but they are sufficient to verify correct operation of the SEL.\n\n\nfile \n\nEvent log records specified in will be added to the System Event\nLog.\n\nThe format of each line in the file is as follows:\n\n<{EvM Revision} {Sensor Type} {Sensor Num} {Event Dir/Type} {Event Data 0}\n{Event Data 1} {Event Data 2}>[# COMMENT]\n\ne.g.: 0x4 0x2 0x60 0x1 0x52 0x0 0x0 # Voltage threshold: Lower Critical: Going\nLow\n\nEvM Revision - The \"Event Message Revision\" is 0x04 for messages that comply\nwith the IPMI 2.0 Specification and 0x03 for messages that comply with the IPMI\n1.0 Specification.\n\nSensor Type - Indicates the Event Type or Class.\n\nSensor Num - Represents the 'sensor' within the management controller that gen‐\nerated the Event Message.\n\nEvent Dir/Type - This field is encoded with the event direction as the high bit\n(bit 7) and the event type as the low 7 bits. Event direction is 0 for an as‐\nsertion event and 1 for a deassertion event.\n\nSee the IPMI 2.0 specification for further details on the definitions for each\nfield.\n\n\n \n\nGet a list of all the possible Sensor States and pre-defined Sensor State\nShortcuts available for a particular sensor. sensorid is the character string\nrepresentation of the sensor and must be enclosed in double quotes if it in‐\ncludes white space. Several different commands including ipmitool sensor list\nmay be used to obtain a list that includes the sensorid strings representing\nthe sensors on a given system.\n\n> ipmitool -I open event \"PS 2T Fan Fault\" list\nFinding sensor PS 2T Fan Fault... ok\nSensor States:\nState Deasserted\nState Asserted\nSensor State Shortcuts:\npresent absent\nassert deassert\nlimit nolimit\nfail nofail\nyes no\non off\nup down\n\n\n []\n\nGenerate a custom event based on existing sensor information. The optional\nevent direction can be either assert (the default) or deassert.\n\n\n> ipmitool event \"PS 2T Fan Fault\" \"State Asserted\"\nFinding sensor PS 2T Fan Fault... ok\n0 | Pre-Init Time-stamp | Fan PS 2T Fan Fault | State Asserted\n\n> ipmitool event \"PS 2T Fan Fault\" \"State Deasserted\"\nFinding sensor PS 2T Fan Fault... ok\n0 | Pre-Init Time-stamp | Fan PS 2T Fan Fault | State Desserted\n\nexec \n\nExecute ipmitool commands from filename. Each line is a complete command. The syntax\nof the commands are defined by the COMMANDS section in this manpage. Each line may\nhave an optional comment at the end of the line, delimited with a `#' symbol.\n\ne.g., a command file with two lines:\n\nsdr list # get a list of sdr records\nsel list # get a list of sel records\n\nfirewall\n\nThis command supports the Firmware Firewall capability. It may be used to add or re‐\nmove security-based restrictions on certain commands/command sub-functions or to list\nthe current firmware firewall restrictions set on any commands. For each firmware\nfirewall command listed below, parameters may be included to cause the command to be\nexecuted with increasing granularity on a specific LUN, for a specific NetFn, for a\nspecific IPMI Command, and finally for a specific command's sub-function (see Appendix\nH in the IPMI 2.0 Specification for a listing of any sub-function numbers that may be\nassociated with a particular command).\n\nParameter syntax and dependencies are as follows:\n\n[] [ [ []]]]\n\nNote that if \"netfn \" is specified, then \"lun \" must also be specified; if\n\"command \" is specified, then \"netfn \" (and therefore \"lun \") must also be\nspecified, and so forth.\n\n\"channel \" is an optional and standalone parameter. If not specified, the re‐\nquested operation will be performed on the current channel. Note that command support\nmay vary from channel to channel.\n\nFirmware firewall commands:\n\ninfo []\n\nList firmware firewall information for the specified LUN, NetFn, and Command\n(if supplied) on the current or specified channel. Listed information includes\nthe support, configurable, and enabled bits for the specified command or com‐\nmands.\n\nSome usage examples:\n\ninfo [] []\n\nThis command will list firmware firewall information for all NetFns for\nthe specified LUN on either the current or the specified channel.\n\ninfo [] [ [ ]\n\nThis command will print out all command information for a single\nLUN/NetFn pair.\n\ninfo [] [ [ [] [ [ []]]]\n\nPrint out information for a specific sub-function.\n\nenable []\n\nThis command is used to enable commands for a given NetFn/LUN combination on\nthe specified channel.\n\ndisable [] [force]\n\nThis command is used to disable commands for a given NetFn/LUN combination on\nthe specified channel. Great care should be taken if using the \"force\" option\nso as not to disable the \"Set Command Enables\" command.\n\nreset []\n\nThis command may be used to reset the firmware firewall back to a state where\nall commands and command sub-functions are enabled.\n\nfru\n\nprint\n\nRead all Field Replaceable Unit (FRU) inventory data and extract such infor‐\nmation as serial number, part number, asset tags, and short strings describing\nthe chassis, board, or product.\n\nread \n\nfru id is the digit ID of the FRU (see output of 'fru print'). fru file is the\nabsolute pathname of a file in which to dump the binary FRU data pertaining to\nthe specified FRU entity.\n\nwrite \n\nfru id is the digit ID of the FRU (see output of 'fru print'). fru file is the\nabsolute pathname of a file from which to pull the binary FRU data before up‐\nloading it to the specified FRU.\n\nupgEkey \n\nUpdate a multirecord FRU location. fru id is the digit ID of the FRU (see out‐\nput of 'fru print'). fru file is the absolute pathname of a file from which to\npull the binary FRU data to upload into the specified multirecord FRU entity.\n\n\nedit \n\nThis command provides interactive editing of some supported records, namely\nPICMG Carrier Activation Record. fru id is the digit ID of the FRU (see output\nof 'fru print'); default is 0.\n\n\nedit field
\n\nThis command may be used to set a field string to a new value. It replaces the\nFRU data found at index in the specified section with the supplied string.\n\n\nfru id is the digit ID of the FRU (see output of 'fru print').\n\n\n
is a string which refers to FRU Inventory Information\nStorage Areas and may be refer to:\n\nc FRU Inventory Chassis Info Area\n\nb FRU Inventory Board Info Area\n\np FRU Inventory Product Info Area\n\n\n specifies the field number. Field numbering starts on the first 'eng‐\nlish text' field type. For instance in the info area field '0' is\n and field '2' is ; see IPMI Platform\nManagement FRU Information Storage Definition v1.0 R1.1 for field locations.\n\n\n must be the same length as the string being replaced and must be 8-bit\nASCII (0xCx).\n\n\n\nedit oem iana []\n\nThis command edits the data found in the multirecord area. Support for OEM spe‐\ncific records is limited.\n\nfwum\nUpdate IPMC using Kontron OEM Firmware Update Manager.\n\ninfo\nShow information about current firmware.\n\n\nstatus\nShow status of each firmware bank present in the hardware.\n\n\ndownload \n\nDownload specified firmware.\n\n\nupgrade [filename]\n\nInstall firmware upgrade. If the filename is specified, the file is downloaded\nfirst, otherwise the last firmware downloaded is used.\n\n\nrollback\n\nAsk IPMC to rollback to previous version.\n\n\ntracelog\n\nShow firmware upgrade log.\n\n\ngendev\n\nlist\n\nList All Generic Device Locators.\n\nread \n\nRead to file eeprom specify by Generic Device Locators.\n\nwrite \n\nWrite from file eeprom specify by Generic Device Locators\n\nhpm\nPICMG HPM.1 Upgrade Agent\n\ncheck\nCheck the target information.\n\n\ncheck \nDisplay both the existing target version and image version on the screen.\n\n\ndownload \n\nDownload specified firmware.\n\n\nupgrade [all] [component ] [activate]\nUpgrade the firmware using a valid HPM.1 image file. If no option is specified,\nthe firmware versions are checked first and the firmware is upgraded only if\nthey are different.\n\n\nall\nUpgrade all components even if the firmware versions are the same (use\nthis only after using \"check\" command).\n\n\ncomponent \nUpgrade only given component from the given file.\ncomponent 0 - BOOT\ncomponent 1 - RTK\n\n\nactivate\nActivate new firmware right away.\n\n\n\nactivate\n\nActivate the newly uploaded firmware.\n\n\ntargetcap\n\nGet the target upgrade capabilities.\n\n\ncompprop