164 lines
5.9 KiB
Diff
164 lines
5.9 KiB
Diff
diff -up ./ipmitool.1.manover ./ipmitool.1
|
|
--- doc/ipmitool.1.manover 2012-12-12 02:04:40.870399182 +0100
|
|
+++ doc/ipmitool.1 2012-12-12 02:25:08.368992981 +0100
|
|
@@ -2,38 +2,57 @@
|
|
.SH "NAME"
|
|
ipmitool \- utility for controlling IPMI\-enabled devices
|
|
.SH "SYNOPSIS"
|
|
-ipmitool [\fB\-c\fR|\fB\-h\fR|\fB\-d \fIN\fP\fR|\fB\-v\fR|\fB\-V\fR]
|
|
-\fB\-I\fR \fIopen\fP <\fIcommand\fP>
|
|
|
|
-ipmitool [\fB\-c\fR|\fB\-h\fR|\fB\-v\fR|\fB\-V\fR]
|
|
-\fB\-I\fR \fIlan\fP \fB\-H\fR <\fIhostname\fP>
|
|
- [\fB\-p\fR <\fIport\fP>]
|
|
- [\fB\-U\fR <\fIusername\fP>]
|
|
- [\fB\-A\fR <\fIauthtype\fP>]
|
|
- [\fB\-L\fR <\fIprivlvl\fP>]
|
|
- [\fB\-a\fR|\fB\-E\fR|\fB\-P\fR|\fB\-f\fR <\fIpassword\fP>]
|
|
- [\fB\-o\fR <\fIoemtype\fP>]
|
|
- [\fB\-O\fR <\fIsel oem\fP>]
|
|
- [\fB\-e\fR <\fIesc_char\fP>]
|
|
- [\fB\-N\fR <\fIsec\fP>]
|
|
- [\fB\-R\fR <\fIcount\fP>]
|
|
- <\fIcommand\fP>
|
|
-
|
|
-ipmitool [\fB\-c\fR|\fB\-h\fR|\fB\-v\fR|\fB\-V\fR]
|
|
-\fB\-I\fR \fIlanplus\fP \fB\-H\fR <\fIhostname\fP>
|
|
- [\fB\-p\fR <\fIport\fP>]
|
|
- [\fB\-U\fR <\fIusername\fP>]
|
|
- [\fB\-L\fR <\fIprivlvl\fP>]
|
|
- [\fB\-a\fR|\fB\-E\fR|\fB\-P\fR|\fB\-f\fR <\fIpassword\fP>]
|
|
- [\fB\-o\fR <\fIoemtype\fP>]
|
|
- [\fB\-O\fR <\fIsel oem\fP>]
|
|
- [\fB\-C\fR <\fIciphersuite\fP>]
|
|
- [\fB\-Y\fR|[\fB\-K\fR|\fB\-k\fR <\fIkg_key\fP>]
|
|
- [\fB\-y\fR <\fIhex_kg_key\fP>]
|
|
- [\fB\-e\fR <\fIesc_char\fP>]
|
|
- [\fB\-N\fR <\fIsec\fP>]
|
|
- [\fB\-R\fR <\fIcount\fP>]
|
|
- <\fIcommand\fP>
|
|
+ipmitool [ <options> ] <command> [ <sub-commands and sub-options> ]
|
|
+
|
|
+<options> := [ <general-options> | <conditional-opts> ]
|
|
+.br
|
|
+Any recognized option is accepted. Conditional options may be ignored or it's usage postponed until shell or exec processes relevant command.
|
|
+.br
|
|
+
|
|
+<general-options> := [ -h | -V | -v | -I <interface> | -H <address> |
|
|
+ -d <N> | -p <port> | -c | -U <username> |
|
|
+ -L <privlvl> | -l <lun> | -m <local_address> |
|
|
+ -N <sec> | -R <count> | <password-option> |
|
|
+ <oem-option> | <bridge-options> ]
|
|
+
|
|
+<conditional-opts> := [ <lan-options> | <lanplus-options> |
|
|
+ <command-options> ]
|
|
+.br
|
|
+Bridging:
|
|
+.br
|
|
+<bridge-options> := -t <target_address> [ -b <channel> |
|
|
+ [ -T <address> | -B <channel> ] ]
|
|
+.br
|
|
+
|
|
+Options used with -I lan:
|
|
+.br
|
|
+<lan-options> := [ -A <authtype> ]
|
|
+.br
|
|
+
|
|
+Options used with -I lanplus:
|
|
+.br
|
|
+<lanplus-options> := [ -C <ciphersuite> | <key-option> ]
|
|
+.br
|
|
+
|
|
+Option groups setting same value:
|
|
+.br
|
|
+<key-option> := [ -k <key> | -K | -y <hex_key> | -Y ]
|
|
+.br
|
|
+<password-option> := [ -f <password_file> | -a | -P <password> | -E ]
|
|
+.br
|
|
+<oem-option> := [ -o <oemtype> | -g | -s ]
|
|
+.br
|
|
+
|
|
+Options used with specific command <command-options>:
|
|
+.br
|
|
+<options-sdr> := [ -S <sdr_cache_file> ]
|
|
+.br
|
|
+<options-sel> := [ -O <sel_oem> ]
|
|
+.br
|
|
+<options-sol> := [ -e <sol_escape_char> ]
|
|
+
|
|
+
|
|
.SH "DESCRIPTION"
|
|
This program lets you manage Intelligent Platform Management Interface
|
|
(IPMI) functions of either the local system, via a kernel device driver,
|
|
@@ -87,7 +106,7 @@ is to use \fI~\fP but this can conflict
|
|
.TP
|
|
\fB\-E\fR
|
|
The remote server password is specified by the environment
|
|
-variable \fIIPMI_PASSWORD\fP.
|
|
+variable \fIIPMI_PASSWORD\fP or \fIIPMITOOL_PASSWORD\fP. The \fIIPMITOOL_PASSWORD\fP takes precedence.
|
|
.TP
|
|
\fB\-f\fR <\fIpassword_file\fP>
|
|
Specifies a file containing the remote server password. If this
|
|
@@ -121,6 +140,8 @@ Set destination lun for raw commands.
|
|
\fB\-L\fR <\fIprivlvl\fP>
|
|
Force session privilege level. Can be CALLBACK, USER,
|
|
OPERATOR, ADMINISTRATOR. Default is ADMINISTRATOR.
|
|
+This value is ignored and always set to ADMINISTRATOR when
|
|
+combined with \fI-t target address\fP.
|
|
.TP
|
|
\fB\-m\fR <\fIlocal_address\fP>
|
|
Set the local IPMB address. The default is 0x20 and there
|
|
@@ -131,7 +152,9 @@ Set transit local address for bridge req
|
|
.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.
|
|
+Defaults are 2 seconds for lan and 1 second for lanplus interfaces.
|
|
+Command \fIraw\fP uses fixed value of 15 seconds.
|
|
+Command \fIsol\fP uses fixed value of 1 second.
|
|
.TP
|
|
\fB\-o\fR <\fIoemtype\fP>
|
|
Select OEM type to support. This usually involves minor hacks
|
|
@@ -154,6 +177,8 @@ option is not recommended.
|
|
.TP
|
|
\fB\-R\fR <\fIcount\fP>
|
|
Set the number of retries for lan/lanplus interface (default=4).
|
|
+Command \fIraw\fP uses fixed value of one try (no retries).
|
|
+Command \fIhpm\fP uses fixed value of 10 retries.
|
|
.TP
|
|
\fB\-s\fR
|
|
Deprecated. Use: -o supermicro
|
|
@@ -166,7 +191,8 @@ SDR cache from a remote system can be cr
|
|
\fIsdr dump\fP command.
|
|
.TP
|
|
\fB\-t\fR <\fItarget_address\fP>
|
|
-Bridge IPMI requests to the remote target address.
|
|
+Bridge IPMI requests to the remote target address. Default is 32.
|
|
+The \fI-L privlvl\fP option is always ignored and value set to ADMINISTRATOR.
|
|
.TP
|
|
\fB\-T\fR <\fItransmit_address\fP>
|
|
Set transit address for bridge request. (dual bridge)
|
|
@@ -178,7 +204,11 @@ Remote server username, default is NULL
|
|
Increase verbose output level. This option may be specified
|
|
multiple times to increase the level of debug output. If given
|
|
three times you will get hexdumps of all incoming and
|
|
-outgoing packets.
|
|
+outgoing packets. Using it five times provides details
|
|
+on request and expected reply procesing. The \fIhpm\fP commands
|
|
+\fItargetcap\fP \fIcompprop\fP \fIabort\fP \fIupgstatus\fP
|
|
+\fIrollback\fP \fIrollbackstatus\fP \fIselftestresult\fP increases
|
|
+the verbosity level
|
|
.TP
|
|
\fB\-V\fR
|
|
Display version information.
|
|
@@ -2758,6 +2788,9 @@ Remote RMCP port.
|
|
\fIcsv\fP [\fBlevel\fR]
|
|
|
|
Enable output in comma separated format.
|
|
+Affects following commands:
|
|
+\fIuser\fP, \fIchannel\fP, \fIisol\fP, \fIsunoem\fP,
|
|
+\fIsol\fP, \fIsensor\fP, \fIsdr\fP, \fIsel\fP, \fIsession\fP.
|
|
.RS
|
|
.RE
|
|
.TP
|