diff --git a/ipmitool/doc/ipmitool.1 b/ipmitool/doc/ipmitool.1 index 1460be1..fc80390 100644 --- a/ipmitool/doc/ipmitool.1 +++ b/ipmitool/doc/ipmitool.1 @@ -186,8 +186,11 @@ ipmitool help .br Commands: raw Send a RAW IPMI request and print response + i2c Send an I2C Master Write-Read command and print response + spd Print SPD info from remote I2C device lan Configure LAN Channels chassis Get chassis status and set power state + power Shortcut to chassis power commands event Send events to MC mc Management Controller status and global enables sdr Print Sensor Data Repository entries and readings @@ -202,13 +205,18 @@ Commands: channel Configure Management Controller channels session Print session information sunoem Manage Sun OEM Extensions + kontronoem Manage Kontron OEM Extensions + picmg Run a PICMG/ATA extended command + firewall Configure Firmware Firewall + shell Launch interactive IPMI shell exec Run list of commands from file set Set runtime variable for shell and exec + echo Used to echo lines to stdout in scripts ekanalyzer run FRU-Ekeying analyzer using FRU files ipmitool chassis help .br -Chassis Commands: status, power, identify, policy, restart_cause, poh, bootdev +Chassis Commands: status, power, identify, policy, restart_cause, poh, bootdev, bootparam, selftest ipmitool chassis power help .br @@ -227,32 +235,32 @@ Instructs the BMC to perform a warm or cold reset. Display the Management Controller Globally Unique IDentifier. .TP \fIinfo\fP -.br +.br Displays information about the BMC hardware, including device revision, firmware revision, IPMI version supported, manufacturer ID, and information on additional device support. .TP -\fIwatchdog\fP <\fBcommand\fR> +\fIwatchdog\fP .br -Perform various watchdog timer setting commands to view and -change the current state of the timer. +These commands allow a user to view and change the current +state of the watchdog timer. .RS .TP \fIget\fP -.br +.br Show current Watchdog Timer settings and countdown state. .TP \fIreset\fP -.br +.br Reset the Watchdog Timer to its most recent state and restart the countdown timer. .TP \fIoff\fP -.br +.br Turn off a currently running Watchdog countdown timer. .RE @@ -269,7 +277,7 @@ results command and report the results. Displays a list of the currently enabled options for the BMC. .br .TP -\fIsetenables\fP <\fBoption\fR>=[\fBon\fR|\fBoff\fR] +\fIsetenables\fP <\fBoption\fR>=[\fIon\fP|\fIoff\fP] .br Enables or disables the given \fIoption\fR. This command is @@ -338,9 +346,8 @@ Possible privilege levels are: .TP \fIinfo\fP [\fBchannel number\fR] -Displays information about the -selected channel. If no channel is given it will -display information about the currently used channel: +Displays information about the selected channel. If no channel +is given it will display information about the currently used channel. .RS .PP > ipmitool channel info @@ -365,13 +372,13 @@ 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. .TP -\fIsetaccess\fP <\fBchannel number\fR> <\fBuserid\fR> [<\fBcallin\fR=\fBon\fR|\fBoff\fR>] -[<\fBipmi\fR=\fBon\fR|\fBoff\fR>] [<\fBlink\fR=\fBon\fR|\fBoff\fR>] [<\fBprivilege\fR=\fBlevel\fR>] +\fIsetaccess\fP <\fBchannel number\fR> <\fBuserid\fR> [<\fIcallin\fP=\fBon\fR|\fBoff\fR>] +[<\fIipmi\fP=\fBon\fR|\fBoff\fR>] [<\fIlink\fP=\fBon\fR|\fBoff\fR>] [<\fIprivilege\fP=\fBlevel\fR>] .br Configure user access information on the given channel for the given userid. .TP -\fIgetciphers\fP <\fBipmi\fR|\fBsol\fR> [<\fBchannel\fR>] +\fIgetciphers\fP <\fIipmi\fP|\fIsol\fP> [<\fBchannel\fR>] .br Displays the list of cipher suites supported for the given @@ -395,14 +402,21 @@ This command will return the Power\-On Hours counter. .TP \fIidentify\fP <\fBinterval\fR> -Control the front panel identify light. Default -is 15. Use 0 to turn off. +Control the front panel identify light. Default interval +is 15 seconds. Use 0 to turn off. Use "force" to turn on +indefinitely. .TP \fIrestart_cause\fP .br Query the chassis for the cause of the last system restart. .TP +\fIselftest\fP +.br + +Check on the basic health of the BMC by executing the Get Self Test +results command and report the results. +.TP \fIpolicy\fP .br @@ -483,12 +497,15 @@ be Operating System support for ACPI and some sort of daemon watching for events for this soft power to work. .RE .TP -\fIbootdev\fP <\fBdevice\fR> [<\fBclear\-cmos\fR=\fByes\fR|\fBno\fR>] +\fIbootdev\fP <\fBdevice\fR> [<\fIclear\-cmos\fP=\fByes\fR|\fBno\fR>] [<\fIoptions\fP=\fBhelp,...\fR>] .br Request the system to boot from an alternate boot device on next reboot. The \fIclear\-cmos\fP option, if supplied, will instruct the BIOS to -clear its CMOS on the next reboot. +clear its CMOS on the next reboot. Various options may be used to modify +the boot device settings. Run \fI"bootdev none options=help"\fP for a list of +available boot device modifiers/options. + .RS .TP Currently supported values for are: @@ -527,27 +544,294 @@ Force boot from CD/DVD .br Force boot into BIOS setup +.TP +\fIfloppy\fP +.br + +Force boot from Floppy/primary removable media +.RE +.TP +\fIbootparam\fP +.br + +Get or set various system boot option parameters. +.RS +.TP +\fIget\fP <\fBparam #\fR> +.br + +Get boot parameter. Currently supported values for <\fBparam #\fR> are: + +\fI0\fP - Set In Progress + +\fI1\fP - Service Partition Selector + +\fI2\fP - Service Partition Scan + +\fI3\fP - BMC Boot Flag Valid Bit Clearing + +\fI4\fP - Boot Info Acknowledge + +\fI5\fP - Boot Flags + +\fI6\fP - Boot Initiator Info + +\fI7\fP - Boot Initiator Mailbox +.br + +.TP +\fIset\fP <\fBoption\fR> [\fBvalue ...\fR] +.br + +Set boot parameter. + +.RS +.TP +Currently supported values for \fB