diff --git a/ipmitool/doc/ipmievd.8 b/ipmitool/doc/ipmievd.8 index 3e57ecb..e1eb3c9 100644 --- a/ipmitool/doc/ipmievd.8 +++ b/ipmitool/doc/ipmievd.8 @@ -99,6 +99,11 @@ If supported it will be obscured in the process list. \fBNote!\fR Specifying the password as a command line option is not recommended. .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 +knowledge of the entire SDR to perform their function. +.TP \fB\-t\fR <\fItarget_address\fP> Bridge IPMI requests to the remote target address. .TP diff --git a/ipmitool/doc/ipmitool.1 b/ipmitool/doc/ipmitool.1 index c876936..87d8086 100644 --- a/ipmitool/doc/ipmitool.1 +++ b/ipmitool/doc/ipmitool.1 @@ -101,6 +101,13 @@ If supported it will be obscured in the process list. \fBNote!\fR Specifying the password as a command line option is not recommended. .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 +knowledge of the entire SDR to perform their function. Local +SDR cache from a remote system can be created with the +\fIsdr dump\fP command. +.TP \fB\-t\fR <\fItarget_address\fP> Bridge IPMI requests to the remote target address. .TP @@ -177,6 +184,7 @@ Commands: channel Configure Management Controller channels session Print session information + sunoem Manage Sun OEM Extensions exec Run list of commands from file set Set runtime variable for shell and exec @@ -197,6 +205,10 @@ chassis power Commands: status, on, off, cycle, reset, diag, soft Instructs the BMC to perform a warm or cold reset. .TP +\fIguid\fP + +Display the Management Controller Globally Unique IDentifier. +.TP \fIinfo\fP .br @@ -284,7 +296,7 @@ selected channel. If no channel is given it will display information about the currently used channel: .RS .PP -ipmitool channel info +> ipmitool channel info .br Channel 0xf info: .br @@ -299,23 +311,20 @@ Channel 0xf info: Protocol Vendor ID : 7154 .RE .TP -\fIgetaccess\fP <\fBchannel number\fR> [\fBuserid\fR] +\fIgetaccess\fP <\fBchannel number\fR> [<\fBuserid\fR>] .br 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> [<\fBcallin\fR=\fBon\fR|\fBoff\fR>] +[<\fBipmi\fR=\fBon\fR|\fBoff\fR>] [<\fBlink\fR=\fBon\fR|\fBoff\fR>] [<\fBprivilege\fR=\fBlevel\fR>] .br Configure user access information on the given channel for the given userid. .TP -\fIgetciphers\fP <\fBall | supported\fR> <\fBipmi | sol\fR> [\fBchannel\fR] +\fIgetciphers\fP <\fBall\fR|\fBsupported\fR> <\fBipmi\fR|\fBsol\fR> [<\fBchannel\fR>] .br Displays the list of cipher suites supported for the given @@ -427,14 +436,21 @@ 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> +\fIbootdev\fP <\fBdevice\fR> [<\fBclear\-cmos\fR=\fByes\fR|\fBno\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. .RS .TP Currently supported values for are: .TP +\fInone\fP +.br + +Do not change boot device +.TP \fIpxe\fP .br @@ -556,6 +572,25 @@ Setup baud rate for IPMI v1.5 Serial\-over\-LAN. .TP \fIlan\fP .RS + +These commands will allow you to configure IPMI LAN channels +with network information so they can be used with the ipmitool +\fIlan\fP and \fIlanplus\fP interfaces. \fINOTE\fR: To +determine on which channel the LAN interface is located, issue +the `channel info \fInumber\fR' command until you come across +a valid 802.3 LAN channel. For example: + +.br +> ipmitool \-I open channel info 1 +.br +Channel 0x1 info: +.br + Channel Medium Type : 802.3 LAN + Channel Protocol Type : IPMB\-1.0 + Session Support : session\-based + Active Session Count : 8 + Protocol Vendor ID : 7154 + .TP \fIprint\fP <\fBchannel\fR> .br @@ -638,12 +673,12 @@ Set the IP address source: .br \fIbios\fP address loaded by BIOS or system software .TP -\fIarp respond\fP <\fBon|off\fR> +\fIarp respond\fP <\fBon\fR|\fBoff\fR> .br Set BMC generated ARP responses. .TP -\fIarp generate\fP <\fBon|off\fR> +\fIarp generate\fP <\fBon\fR|\fBoff\fR> .br Set BMC generated gratuitous ARPs. @@ -695,7 +730,7 @@ Characters used in \fIprivlist\fR and their associated privilege levels are: So, to set the maximum privilege for cipher suite 1 to USER and suite 2 to ADMIN, issue the following command: -ipmitool \-I \fIinterface\fR lan set \fIchannel\fR cipher_privs uaXXXXXXXXXXXXX +> ipmitool \-I \fIinterface\fR lan set \fIchannel\fR cipher_privs uaXXXXXXXXXXXXX .RE .RE @@ -732,13 +767,13 @@ entries matching the event, and possible actions to be taken. Actions are performed in priority order (higher criticality first). .RE .TP -\fIraw\fP <\fBnetfn\fR> <\fBcmd\fR> [\fBdata\fR] +\fIraw\fP <\fBnetfn\fR> <\fBcmd\fR> [<\fBdata\fR>] .br 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 +> ipmitool \-v raw 0x0 0xf .br RAW REQ (netfn=0x0 cmd=0xf data_len=0) .br @@ -754,12 +789,33 @@ RAW RSP (5 bytes) This command will query the BMC for SDR information. .TP -\fIlist\fP [\fBall\fR|\fBfull\fR|\fBcompact\fR|\fBevent\fR|\fBmcloc\fR|\fBfru\fR|\fBgeneric\fR] +\fItype\fP <\fBsensor type\fP> + +This command will display all records from the SDR of a specific type. +Run with type \fIlist\fP to see the list of available types. For +example to query for all Temperature sensors: + +> ipmitool sdr type Temperature +.br +Baseboard Temp | 30h | ok | 7.1 | 28 degrees C +.br +FntPnl Amb Temp | 32h | ok | 12.1 | 24 degrees C +.br +Processor1 Temp | 98h | ok | 3.1 | 57 degrees C +.br +Processor2 Temp | 99h | ok | 3.2 | 53 degrees C + +.TP +\fIlist\fP | \fIelist\fP [<\fBall\fR|\fBfull\fR|\fBcompact\fR|\fBevent\fR|\fBmcloc\fR|\fBfru\fR|\fBgeneric\fR>] .br -This command will read the Sensor Data Records (SDR) and -extract sensor information of a given type, then query each sensor and -print its name, reading, and status. +This command will read the Sensor Data Records (SDR) and extract sensor +information of a given type, then query each sensor and print its name, +reading, and status. If invoked as \fIelist\fP then it will also print +sensor number, entity id and instance, and asserted discrete states. + +The default output will only display \fIfull\fP and \fIcompact\fP sensor +types, to see all sensors use the \fIall\fP type with this command. .RS .TP Valid types are: @@ -806,14 +862,16 @@ Generic SDR records .br Displays all sensors associated with an entity. Get a list of -valid entity ids on the target system by issuing the `sdr list' command -with the verbose option (`\-v'). A list of all entity ids can be found -in the IPMI specifications. +valid entity ids on the target system by issuing the \fIsdr elist\fP command. +A list of all entity ids can be found in the IPMI specifications. .TP \fIdump\fP <\fBfile\fR> .br -Dumps raw SDR data to a 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 \fI\-S \fP +option on the ipmitool command line. This can greatly improve performance +over system interface or remote LAN. .RE .TP \fIsel\fP @@ -821,8 +879,9 @@ Dumps raw SDR data to a file. NOTE: 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