summaryrefslogtreecommitdiff
path: root/doc/ipmitool.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ipmitool.1')
-rw-r--r--doc/ipmitool.1126
1 files changed, 63 insertions, 63 deletions
diff --git a/doc/ipmitool.1 b/doc/ipmitool.1
index 10ccb74..2e39fad 100644
--- a/doc/ipmitool.1
+++ b/doc/ipmitool.1
@@ -10,47 +10,47 @@ ipmitool [ <options> ] <command> [ <sub-commands and sub-options> ]
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> |
+<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> ]
+<conditional\-opts> := [ <lan\-options> | <lanplus\-options> |
+ <command\-options> ]
.br
Bridging:
.br
-<bridge-options> := -t <target_address> [ -b <channel> |
- [ -T <address> | -B <channel> ] ]
+<bridge\-options> := \-t <target_address> [ \-b <channel> |
+ [ \-T <address> | \-B <channel> ] ]
.br
-Options used with -I lan:
+Options used with \-I lan:
.br
-<lan-options> := [ -A <authtype> ]
+<lan\-options> := [ \-A <authtype> ]
.br
-Options used with -I lanplus:
+Options used with \-I lanplus:
.br
-<lanplus-options> := [ -C <ciphersuite> | <key-option> ]
+<lanplus\-options> := [ \-C <ciphersuite> | <key\-option> ]
.br
Option groups setting same value:
.br
-<key-option> := [ -k <key> | -K | -y <hex_key> | -Y ]
+<key\-option> := [ \-k <key> | \-K | \-y <hex_key> | \-Y ]
.br
-<password-option> := [ -f <password_file> | -a | -P <password> | -E ]
+<password\-option> := [ \-f <password_file> | \-a | \-P <password> | \-E ]
.br
-<oem-option> := [ -o <oemtype> | -g | -s ]
+<oem\-option> := [ \-o <oemtype> | \-g | \-s ]
.br
Options used with specific command <command-options>:
.br
-<options-sdr> := [ -S <sdr_cache_file> ]
+<options\-sdr> := [ \-S <sdr_cache_file> ]
.br
-<options-sel> := [ -O <sel_oem> ]
+<options\-sel> := [ \-O <sel_oem> ]
.br
-<options-sol> := [ -e <sol_escape_char> ]
+<options\-sol> := [ \-e <sol_escape_char> ]
.SH "DESCRIPTION"
@@ -63,7 +63,7 @@ chassis power control.
IPMI management of a local system interface requires a compatible IPMI
kernel driver to be installed and configured. On Linux this driver is
called \fIOpenIPMI\fP and it is included in standard distributions.
-On Solaris this driver is called \fIBMC\fP and is inclued in Solaris 10.
+On Solaris this driver is called \fIBMC\fP and is included in Solaris 10.
Management of a remote station requires the IPMI\-over\-LAN interface to be
enabled and configured. Depending on the particular requirements of each
system it may be possible to enable the LAN interface using ipmitool over
@@ -120,7 +120,7 @@ option is absent, or if password_file is empty, the password
will default to NULL.
.TP
\fB\-g\fR
-Deprecated. Use: -o intelplus
+Deprecated. Use: \-o intelplus
.TP
\fB\-h\fR
Get basic usage help from the command line.
@@ -151,7 +151,7 @@ combined with \fI-t target address\fP.
.TP
\fB\-m\fR <\fIlocal_address\fP>
Set the local IPMB address. The local address defaults to 0x20
-or is auto discovered on PICMG platforms when -m is not specified.
+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.
.TP
\fB\-N\fR <\fIsec\fP>
@@ -185,7 +185,7 @@ 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
+Deprecated. Use: \-o supermicro
.TP
\fB\-S\fR <\fIsdr_cache_file\fP>
Use local file for remote SDR cache. Using a local SDR cache
@@ -223,7 +223,7 @@ Display version information.
\fB\-y\fR <\fIhex key\fP>
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 PASSWORD' and '-y 50415353574F5244' are
+characters. E.g. '\-k PASSWORD' and '\-y 50415353574F5244' are
equivalent.
The default is not to use any Kg key.
.TP
@@ -1052,7 +1052,7 @@ Display point to point physical connectivity between carriers and AMC modules.
\fIpower\fP <\fBxx=filename1\fR> <\fBxx=filename2\fR> \fB...\fr
.br
-Display power supply informations between carrier and AMC modules.
+Display power supply information between carrier and AMC modules.
.TP
\fIall\fP <\fBxx=filename\fR> <\fBxx=filename\fR> \fB...\fr
.br
@@ -1064,7 +1064,7 @@ modules.
.TP
\fIfrushow\fP <\fBxx=filename\fR>
.br
-Convert a binary FRU file into human readable text format. Use -v option to get
+Convert a binary FRU file into human readable text format. Use \-v option to get
more display information.
.RE
@@ -1082,56 +1082,56 @@ and an AMC module or between 2 AMC modules. Example:
AMC slot B1 port 0 ==> On-Carrier Device 0 port 16
Matching Result
- From On-Carrier Device ID 0
- -Channel ID 11 || Lane 0: enable
- -Link Type: AMC.2 Ethernet
- -Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link
- -Link Group ID: 0 || Link Asym. Match: exact match
+ \-Channel ID 11 || Lane 0: enable
+ \-Link Type: AMC.2 Ethernet
+ \-Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link
+ \-Link Group ID: 0 || Link Asym. Match: exact match
- To AMC slot B1
- -Channel ID 0 || Lane 0: enable
- -Link Type: AMC.2 Ethernet
- -Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link
- -Link Group ID: 0 || Link Asym. Match: exact match
+ \-Channel ID 0 || Lane 0: enable
+ \-Link Type: AMC.2 Ethernet
+ \-Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link
+ \-Link Group ID: 0 || Link Asym. Match: exact match
*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
AMC slot B1 port 1 ==> On-Carrier Device 0 port 12
Matching Result
- From On-Carrier Device ID 0
- -Channel ID 6 || Lane 0: enable
- -Link Type: AMC.2 Ethernet
- -Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link
- -Link Group ID: 0 || Link Asym. Match: exact match
+ \-Channel ID 6 || Lane 0: enable
+ \-Link Type: AMC.2 Ethernet
+ \-Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link
+ \-Link Group ID: 0 || Link Asym. Match: exact match
- To AMC slot B1
- -Channel ID 1 || Lane 0: enable
- -Link Type: AMC.2 Ethernet
- -Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link
- -Link Group ID: 0 || Link Asym. Match: exact match
+ \-Channel ID 1 || Lane 0: enable
+ \-Link Type: AMC.2 Ethernet
+ \-Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link
+ \-Link Group ID: 0 || Link Asym. Match: exact match
*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
On-Carrier Device vs AMC slot A2
AMC slot A2 port 0 ==> On-Carrier Device 0 port 3
Matching Result
- From On-Carrier Device ID 0
- -Channel ID 9 || Lane 0: enable
- -Link Type: AMC.2 Ethernet
- -Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link
- -Link Group ID: 0 || Link Asym. Match: exact match
+ \-Channel ID 9 || Lane 0: enable
+ \-Link Type: AMC.2 Ethernet
+ \-Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link
+ \-Link Group ID: 0 || Link Asym. Match: exact match
- To AMC slot A2
- -Channel ID 0 || Lane 0: enable
- -Link Type: AMC.2 Ethernet
- -Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link
- -Link Group ID: 0 || Link Asym. Match: exact match
+ \-Channel ID 0 || Lane 0: enable
+ \-Link Type: AMC.2 Ethernet
+ \-Link Type extension: 1000BASE-BX (SerDES Gigabit) Ethernet link
+ \-Link Group ID: 0 || Link Asym. Match: exact match
*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
AMC slot B1 vs AMC slot A2
AMC slot A2 port 2 ==> AMC slot B1 port 2
Matching Result
- From AMC slot B1
- -Channel ID 2 || Lane 0: enable
- -Link Type: AMC.3 Storage
- -Link Type extension: Serial Attached SCSI (SAS/SATA)
- -Link Group ID: 0 || Link Asym. Match: FC or SAS interface {exact match}
+ \-Channel ID 2 || Lane 0: enable
+ \-Link Type: AMC.3 Storage
+ \-Link Type extension: Serial Attached SCSI (SAS/SATA)
+ \-Link Group ID: 0 || Link Asym. Match: FC or SAS interface {exact match}
- To AMC slot A2
- -Channel ID 2 || Lane 0: enable
- -Link Type: AMC.3 Storage
- -Link Type extension: Serial Attached SCSI (SAS/SATA)
- -Link Group ID: 0 || Link Asym. Match: FC or SAS interface {exact match}
+ \-Channel ID 2 || Lane 0: enable
+ \-Link Type: AMC.3 Storage
+ \-Link Type extension: Serial Attached SCSI (SAS/SATA)
+ \-Link Group ID: 0 || Link Asym. Match: FC or SAS interface {exact match}
*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
.TP
\fIunmatch\fP <\fBxx=filename\fR> <\fBxx=filename\fR> \fB...\fr
@@ -2516,7 +2516,7 @@ Remove a policy. If domain is not supplied a default of platform is used.
\fIpower\fP \fImin\fP <minimum> \fImax\fP <maximum> [\fIdomain\fP <platform|CPU|Memory>]
.br
-Configure Node Manager power minumum and maximum power draw limits.
+Configure Node Manager power minimum and maximum power draw limits.
The \fImin\fP and \fImax\fP values must be in the range of 0-65535.
If domain is not supplied a default of platform is used.
@@ -3269,7 +3269,7 @@ I2C Master Write\-Read IPMI command.
Execute the service processor command line interface commands.
Without any command string, an interactive session is started
-in the service processor command line environ ment. If a
+in the service processor command line environment. If a
command string is specified, the command string is executed
on the service processor and the connection is closed.
.TP
@@ -3515,7 +3515,7 @@ a 2.4\-based kernel in order for ipmitool to work:
Incoming and outgoing message handler for IPMI interfaces.
.TP
.B ipmi_kcs_drv
-An IPMI Keyboard Controler Style (KCS) interface driver for the message handler.
+An IPMI Keyboard Controller Style (KCS) interface driver for the message handler.
.TP
.B ipmi_devintf
Linux character device interface for the message handler.
@@ -3553,7 +3553,7 @@ ipmitool includes some sample initialization scripts that
can perform this task automatically at start\-up.
In order to have ipmitool use the OpenIPMI device interface
-you can specifiy it on the command line:
+you can specify it on the command line:
.PP
ipmitool \fB\-I\fR \fIopen\fP <\fIcommand\fP>
.SH "BMC INTERFACE"
@@ -3664,7 +3664,7 @@ encryption algorightms.
The ipmitool \fIfree\fP interface utilizes the FreeIPMI libfreeipmi
drivers.
.LP
-You can tell ipmitool to use the FreeIPMI interface with the -I option:
+You can tell ipmitool to use the FreeIPMI interface with the \-I option:
.PP
ipmitool \fB\-I\fR \fIfree\fP <\fIcommand\fP>
@@ -3674,7 +3674,7 @@ ipmitool \fB\-I\fR \fIfree\fP <\fIcommand\fP>
The ipmitool \fIimb\fP interface supports the Intel IMB (Intel
Inter-module Bus) Interface through the /dev/imb device.
.LP
-You can tell ipmitool to use the IMB interface with the -I option:
+You can tell ipmitool to use the IMB interface with the \-I option:
.PP
ipmitool \fB\-I\fR \fIimb\fP <\fIcommand\fP>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-04 21:50:47 +0000