From a9fc0182f4d2cb49b2d8a75acb695022d434bb2a Mon Sep 17 00:00:00 2001 From: Ales Ledvinka Date: Tue, 4 Dec 2012 14:36:20 +0100 Subject: [PATCH] ipmitool documentation fix --- ipmitool-1.8.12f-toolman.patch | 2439 ++++++++++++++++++++++++++++++++ ipmitool.spec | 10 +- 2 files changed, 2448 insertions(+), 1 deletion(-) create mode 100644 ipmitool-1.8.12f-toolman.patch diff --git a/ipmitool-1.8.12f-toolman.patch b/ipmitool-1.8.12f-toolman.patch new file mode 100644 index 0000000..7367c43 --- /dev/null +++ b/ipmitool-1.8.12f-toolman.patch @@ -0,0 +1,2439 @@ +diff -up ./doc/ipmitool.1.manscan ./doc/ipmitool.1 +--- ./doc/ipmitool.1.manscan 2012-12-03 15:21:11.757888182 +0100 ++++ ./doc/ipmitool.1 2012-12-04 13:13:57.961402879 +0100 +@@ -58,30 +58,15 @@ Prompt for the remote server password. + Specify an authentication type to use during IPMIv1.5 \fIlan\fP + session activation. Supported types are NONE, PASSWORD, MD2, MD5, or OEM. + .TP ++\fB\-b\fR <\fIchannel\fP> ++Set destination channel for bridged request. ++.TP ++\fB\-B\fR <\fIchannel\fP> ++Set transit channel for bridged request. (dual bridge) ++.TP + \fB\-c\fR + Present output in CSV (comma separated variable) format. + This is not available with all commands. +-.TP +-\fB\-e\fR <\fIsol_escape_char\fP> +-Use supplied character for SOL session escape character. The default +-is to use \fI~\fP but this can conflict with ssh sessions. +-.TP +-\fB\-K\fR +-Read Kg key from IPMI_KGKEY environment variable. +-.TP +-\fB\-k\fR <\fIkey\fP> +-Use supplied Kg key for IPMIv2 authentication. The default is not to +-use any Kg key. +-.TP +-\fB\-y\fR <\fIhex key\fP> +-Use supplied Kg key for IPMIv2 authentication. The key is expected in +-hexadecimal format and can be used to specify keys with non-printable +-characters. E.g. '-k PASSWORD' and '-y 50415353574F5244' are +-equivalent. +-The default is not to use any Kg key. +-.TP +-\fB\-Y\fR +-Prompt for the Kg key for IPMIv2 authentication. + .TP + \fB\-C\fR <\fIciphersuite\fP> + The remote server authentication, integrity, and encryption algorithms +@@ -89,6 +74,17 @@ to use for IPMIv2 \fIlanplus\fP connecti + IPMIv2 specification. The default is 3 which specifies RAKP\-HMAC\-SHA1 + authentication, HMAC\-SHA1\-96 integrity, and AES\-CBC\-128 encryption algorightms. + .TP ++\fB\-d \fIN\fP\fR ++Use device number N to specify the /dev/ipmiN (or ++/dev/ipmi/N or /dev/ipmidev/N) device 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. ++.TP ++\fB\-e\fR <\fIsol_escape_char\fP> ++Use supplied character for SOL session escape character. The default ++is to use \fI~\fP but this can conflict with ssh sessions. ++.TP + \fB\-E\fR + The remote server password is specified by the environment + variable \fIIPMI_PASSWORD\fP. +@@ -98,6 +94,9 @@ Specifies a file containing the remote s + option is absent, or if password_file is empty, the password + will default to NULL. + .TP ++\fB\-g\fR ++Deprecated. Use: -o intelwv2 ++.TP + \fB\-h\fR + Get basic usage help from the command line. + .TP +@@ -109,6 +108,16 @@ option is required for \fIlan\fP and \fI + Selects IPMI interface to use. Supported interfaces that are + compiled in are visible in the usage help output. + .TP ++\fB\-k\fR <\fIkey\fP> ++Use supplied Kg key for IPMIv2 authentication. The default is not to ++use any Kg key. ++.TP ++\fB\-K\fR ++Read Kg key from IPMI_KGKEY environment variable. ++.TP ++\fB\-l\fR <\fIlun\fP> ++Set destination lun for raw commands. ++.TP + \fB\-L\fR <\fIprivlvl\fP> + Force session privilege level. Can be CALLBACK, USER, + OPERATOR, ADMINISTRATOR. Default is ADMINISTRATOR. +@@ -117,6 +126,9 @@ OPERATOR, ADMINISTRATOR. Default is ADMI + Set the local IPMB address. The default is 0x20 and there + should be no need to change it for normal operation. + .TP ++\fB\-M\fR <\fIaddress\fP> ++Set transit local address for bridge request. (dual bridge) ++.TP + \fB\-N\fR <\fIsec\fP> + Specify nr. of seconds between retransmissions of lan/lanplus messages. + Default are 2 seconds for lan and 1 second for lanplus interfaces. +@@ -130,7 +142,7 @@ current supported OEM types. + \fB\-O\fR <\fIsel oem\fP> + Open selected file and read OEM SEL event descriptions to be used + during SEL listings. See examples in contrib dir for file format. +-.TP ++.TP + \fB\-p\fR <\fIport\fP> + Remote server UDP port to connect to. Default is 623. + .TP +@@ -143,6 +155,9 @@ option is not recommended. + \fB\-R\fR <\fIcount\fP> + Set the number of retries for lan/lanplus interface (default=4). + .TP ++\fB\-s\fR ++Deprecated. Use: -o supermicro ++.TP + \fB\-S\fR <\fIsdr_cache_file\fP> + Use local file for remote SDR cache. Using a local SDR cache + can drastically increase performance for commands that require +@@ -153,15 +168,11 @@ SDR cache from a remote system can be cr + \fB\-t\fR <\fItarget_address\fP> + Bridge IPMI requests to the remote target address. + .TP ++\fB\-T\fR <\fItransmit_address\fP> ++Set transit address for bridge request. (dual bridge) ++.TP + \fB\-U\fR <\fIusername\fP> + Remote server username, default is NULL user. +-.TP +-\fB\-d \fIN\fP\fR +-Use device number N to specify the /dev/ipmiN (or +-/dev/ipmi/N or /dev/ipmidev/N) device 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. + .TP + \fB\-v\fR + Increase verbose output level. This option may be specified +@@ -171,6 +182,19 @@ outgoing packets. + .TP + \fB\-V\fR + Display version information. ++.TP ++\fB\-y\fR <\fIhex key\fP> ++Use supplied Kg key for IPMIv2 authentication. The key is expected in ++hexadecimal format and can be used to specify keys with non-printable ++characters. E.g. '-k PASSWORD' and '-y 50415353574F5244' are ++equivalent. ++The default is not to use any Kg key. ++.TP ++\fB\-Y\fR ++Prompt for the Kg key for IPMIv2 authentication. ++.TP ++\fB\-z\fR <\fIsize\fP> ++Change Size of Communication Channel. (OEM) + + .LP + If no password method is specified then ipmitool will prompt the +@@ -210,172 +234,42 @@ to get option usage help. + 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 ++ bmc Deprecated. Use mc ++ channel Configure Management Controller channels + chassis Get chassis status and set power state +- power Shortcut to chassis power commands ++ 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 ++ 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 +- sensor Print detailed sensor information +- fru Print built\-in FRU and scan for FRU locators + sel Print System Event Log (SEL) +- pef Configure Platform Event Filtering (PEF) ++ 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 +- isol Configure and connect Intel IPMIv1.5 Serial\-over\-LAN + user Configure Management Controller users +- channel Configure Management Controller channels +- dcmi Data Center Management Interface +- 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 +- delloem Manage Dell OEM Extensions. +- echo Used to echo lines to stdout in scripts +- ekanalyzer run FRU-Ekeying analyzer using FRU files +- ime Upgrade/Query Intel ME firmware +- hpm Update HPM components using PICMG HPM.1 file +- fwum Update IPMC using Kontron OEM Firmware Update Manager +- +- +-ipmitool chassis help +-.br +-Chassis Commands: status, power, identify, policy, restart_cause, poh, bootdev, bootparam, selftest +- +-ipmitool chassis power help +-.br +-chassis power Commands: status, on, off, cycle, reset, diag, soft +-.TP +-\fIbmc|mc\fP +-.RS +-.TP +-\fIreset\fP <\fBwarm\fR|\fBcold\fR> +-.br +- +-Instructs the BMC to perform a warm or cold reset. +-.TP +-\fIguid\fP +- +-Display the Management Controller Globally Unique IDentifier. +-.TP +-\fIinfo\fP +-.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 +-.br +- +-These commands allow a user to view and change the current +-state of the watchdog timer. +-.RS +-.TP +-\fIget\fP +-.br +- +-Show current Watchdog Timer settings and countdown state. +-.TP +-\fIreset\fP +-.br +- +-Reset the Watchdog Timer to its most recent state and restart the +-countdown timer. +-.TP +-\fIoff\fP +-.br +- +-Turn off a currently running Watchdog countdown timer. +-.RE +-.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 +-\fIgetenables\fP +-.br +- +-Displays a list of the currently enabled options for the BMC. +-.br +-.TP +-\fIsetenables\fP <\fBoption\fR>=[\fIon\fP|\fIoff\fP] +-.br +- +-Enables or disables the given \fIoption\fR. This command is +-only supported over the system interface according to the IPMI +-specification. Currently supported values for \fIoption\fR include: +-.RS +-.TP +-\fIrecv_msg_intr\fP +-.br +- +-Receive Message Queue Interrupt +-.TP +-\fIevent_msg_intr\fP +-.br +- +-Event Message Buffer Full Interrupt +-.TP +-\fIevent_msg\fP +-.br +- +-Event Message Buffer +-.TP +-\fIsystem_event_log\fP +-.br +- +-System Event Logging +-.TP +-\fIoem0\fP +-.br +- +-OEM\-Defined option #0 +-.TP +-\fIoem1\fP +-.br +- +-OEM\-Defined option #1 +-.TP +-\fIoem2\fP +-.br + +-OEM\-Defined option #2 +- +-.RE +-.TP +-\fIgetsysinfo\fP <\fBargument\fP> +-Retrieves system info from bmc for given argument. +-.br +-See \fIsetsysinfo\fP for argument definitions +-.TP +-\fIsetsysinfo\fP <\fBargument\fP> <\fBstring\fP> +-Stores system info string to bmc for given argument +-.RS +-.TP +-Possible arguments are: +-.RS +-.TP +-\fIprimary_os_name\fP Primary Operating System Name +-.TP +-\fIos_name\fP Operating System Name +-.TP +-\fIsystem_name\fP System Name of Server +-.TP +-\fIdelloem_os_version\fP Running versin of operating system +-.TP +-\fIdelloem_URL\fP URL of BMC Webserver +-.RE +-.RE + .TP + \fIchannel\fP + .RS +@@ -397,6 +291,8 @@ Possible privilege levels are: + \fI4\fP Administrator level + .br + \fI5\fP OEM Proprietary level ++.br ++\fI15\fP No access + .RE + .TP + \fIinfo\fP [\fBchannel number\fR] +@@ -421,7 +317,7 @@ Channel 0xf info: + .RE + .TP + \fIgetaccess\fP <\fBchannel number\fR> [<\fBuserid\fR>] +-.br ++.RS + + Configure the given userid as the default on the given channel number. + When the given channel is subsequently used, the user is identified +@@ -439,242 +335,192 @@ Configure user access information on the + Displays the list of cipher suites supported for the given + application (ipmi or sol) on the given channel. + .RE ++.RE + .TP + \fIchassis\fP + .RS + .TP + \fIstatus\fP +-.br + +-Displays information regarding the high\-level +-status of the system chassis and main power +-subsystem. ++Status information related to power, buttons, cooling, drives and faults. ++.RS ++.RE + .TP +-\fIpoh\fP +-.br +- +-This command will return the Power\-On Hours counter. +-.TP +-\fIidentify\fP <\fBinterval\fR> +- +-Control the front panel identify light. Default interval +-is 15 seconds. Use 0 to turn off. Use "force" to turn on +-indefinitely. ++\fIpower\fP ++.RS + .TP +-\fIrestart_cause\fP +-.br +- +-Query the chassis for the cause of the last system restart. ++\fIstatus\fP ++.RS ++.RE ++.TP ++\fIon\fP ++.RS ++.RE ++.TP ++\fIoff\fP ++.RS ++.RE ++.TP ++\fIcycle\fP ++.RS ++.RE ++.TP ++\fIreset\fP ++.RS ++.RE ++.TP ++\fIdiag\fP ++.RS ++.RE ++.TP ++\fIsoft\fP ++.RS ++.RE ++.RE + .TP +-\fIselftest\fP +-.br ++\fIidentify\fP [|force] + +-Check on the basic health of the BMC by executing the Get Self Test +-results command and report the results. ++Identify interval. ++.br ++Default is 15 seconds. ++.br ++0 - Off ++.br ++force - To turn on indefinitely ++.RS ++.RE + .TP + \fIpolicy\fP +-.br + +-Set the chassis power policy in the event power failure. ++What to do when power is restored. + .RS + .TP + \fIlist\fP +-.br + +-Return supported policies. ++Show available options. ++.RS ++.RE + .TP +-\fIalways\-on\fP +-.br +- +-Turn on when power is restored. ++\fIalways-on\fP ++.RS ++.RE + .TP + \fIprevious\fP +-.br +- +-Returned to previous state when power is restored. +-.TP +-\fIalways\-off\fP +-.br +- +-Stay off after power is restored. ++.RS + .RE + .TP +-\fIpower\fP +-.br +- +-Performs a chassis control command to view and +-change the power state. ++\fIalways-off\fP + .RS +-.TP +-\fIstatus\fP +-.br +- +-Show current chassis power status. +-.TP +-\fIon\fP +-.br +- +-Power up chassis. +-.TP +-\fIoff\fP +-.br +- +-Power down chassis into soft off (S4/S5 state). +-\fBWARNING\fR: This command does not initiate a clean +-shutdown of the operating system prior to powering down the system. +-.TP +-\fIcycle\fP +-.br +- +-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 +-recommended 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. +-.TP +-\fIreset\fP +-.br +- +-This command will perform a hard reset. +-.TP +-\fIdiag\fP +-.br ++.RE ++.RE + +-Pulse a diagnostic interrupt (NMI) directly to the processor(s). + .TP +-\fIsoft\fP +-.br ++\fIrestart_cause\fP + +-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 +-watching for events for this soft power to work. ++Last restart cause. ++.RS + .RE + .TP +-\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. 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. ++\fIpoh\fP + ++Get power on hours. + .RS ++.RE + .TP +-Currently supported values for are: ++\fIbootdev\fP ++.RS + .TP + \fInone\fP +-.br + +-Do not change boot device ++Do not change boot device order. ++.RS ++.RE + .TP + \fIpxe\fP +-.br + +-Force PXE boot ++Force PXE boot. ++.RS ++.RE + .TP + \fIdisk\fP +-.br + +-Force boot from BIOS default boot device ++Force boot from default Hard-drive. ++.RS ++.RE + .TP + \fIsafe\fP +-.br + +-Force boot from BIOS default boot device, request Safe Mode ++Force boot from default Hard-drive, request Safe Mode. ++.RS ++.RE + .TP + \fIdiag\fP +-.br + +-Force boot from diagnostic partition ++Force boot from Diagnostic Partition. ++.RS ++.RE + .TP + \fIcdrom\fP +-.br + +-Force boot from CD/DVD ++Force boot from CD/DVD. ++.RS ++.RE + .TP + \fIbios\fP +-.br + +-Force boot into BIOS setup ++Force boot into BIOS Setup. ++.RS ++.RE + .TP + \fIfloppy\fP +-.br + +-Force boot from Floppy/primary removable media ++Force boot from Floppy/primary removable media. ++.RS ++.RE + .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