File: freeipmi.7.pre.in

package info (click to toggle)
freeipmi 1.4.11-1.1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 21,952 kB
  • ctags: 18,990
  • sloc: ansic: 299,490; sh: 11,087; makefile: 1,958; perl: 1,078
file content (292 lines) | stat: -rw-r--r-- 9,418 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
.TH FREEIPMI 7 "@ISODATE@" "FreeIPMI @PACKAGE_VERSION@" "Overview"
.SH "NAME"
FreeIPMI - FreeIPMI overview
.SH "Introduction"
FreeIPMI provides in-band and out-of-band IPMI software based on the
IPMI v1.5/2.0 specification.
.SH "What is IPMI?"
The IPMI specification defines a set of interfaces for platform
management and is implemented by a number vendors for system
management.  The features of IPMI that most users will be interested
in are sensor monitoring, system event monitoring, power control, and
serial-over-LAN (SOL).  The FreeIPMI tools and libraries listed below
should provide users with the ability to access and utilize these
and many other features of IPMI.
.PP
.SH "Getting Started with IPMI"
IPMI can be used in-band (i.e. running on a machine locally) or
out-of-band (i.e. connecting remotely).
.PP
Most FreeIPMI tools can operate in-band by using one of the in-band
drivers included.  These in-band drivers include a userspace KCS
interface driver, a SSIF driver through the Linux SSIF device
(i.e. /dev/i2c-0), the OpenIPMI Linux kernel driver (i.e. /dev/ipmi0),
the Sun/Solaris BMC driver (i.e. /dev/bmc), and the Intel DCMI/MEI
driver (i.e. /dev/dcmi).  If your system requires the use of installed
drivers, those appropriate modules must be installed ahead of time.
However, most systems should automatically load these drivers when
appropriate.
.PP
Under most scenarios, the FreeIPMI tools should automatically discover
which in-band interface to use and the proper settings to use.  Users
may execute the tools on the command line to begin using them.  Some
motherboards may require you to determine driver type, addresses,
paths, etc. on your own and pass them as command line options to the
tools.  You may use
.B ipmi-locate(8) 
to help determine
this information.  Other tools such as 
.B dmidecode(8)
may also provide
this information.
.PP
To use IPMI out-of-band with tools such as 
.B ipmipower(8) 
or
.B ipmi-sensors(8), 
the remote machine's BMC must first be configured for out of band
communication.  Typically, this involves setting a username, password,
IP address, MAC address, and a few other parameters.  This can be done
using the tool
.B ipmi-config(8).  
Additional information on how to configure with
.B ipmi-config(8) 
can be found
in the
.B ipmi-config.conf(5) 
manpage.  Some vendors may pre-configure their motherboards with
default values so that 
.B ipmi-config(8)
can be used remotely to configure the machine.  However, most of the
time, the BMC must be configured in-band before out-of-band access can
be allowed (for example, the correct IP address and MAC address must
be configured).

.PP
In order to remotely connect to a machine, you typically must specify
the host, username, and password for the tool in order to connect.
Depending on configuration settings, a K_g key, privilege level,
authentication type, cipher suite id, or protocol version may need to
be specified.

.PP
Some vendors may have not implemented IPMI properly and a workaround
must be specified into FreeIPMI to ensure the tool can execute
properly.  For example, a fair number of vendors have populated their
FRU records with invalid checksums.  To properly ignore these set of
checksums a \fIskipchecks\fR workaround has been added to
.B ipmi-fru(8).
Please see each of the tool manpages to see a list of available
workarounds.

.PP
Additional information, examples, and general trouble-shooting can be
found in each of the tool manpages.

.SH "General Use"
The primary tools that most users of FreeIPMI will be interested in
for system management are the following:
.PP
.B Ipmi-sensors
.PP
A tool to read IPMI sensor readings to aid in system monitoring.
.PP
.B Ipmi-sel
.PP
A tool to read and manage IPMI System Event Log (SEL) records to aid
in system debugging.
.PP
.B Ipmipower
.PP
A tool for remote power control.
.PP
.B Ipmiconsole
.PP
A tool for Serial-over-Lan (SOL) console access.
.PP
Many other tools and libraries are listed below that cover additional
features and areas of IPMI.
.PP
Additional information, examples, and general trouble-shooting can be
found in each of the tool manpages.

.SH "Configuration"
In order to avoid typing in a long list of command line options to
specify IPMI communication requirements everytime a command is
executed (e.g. driver paths, usernames, passwords, etc.), an
alternate set of default values can be set for most FreeIPMI
tools in the FreeIPMI configuration file.  See 
.B freeipmi.conf(5)
for more information.

.SH "HPC Support"
Much of FreeIPMI was written with HPC support in mind.  
.B Ipmi-config(8)
comes with file input/output support so that configuration can be
copied and verified across nodes in a cluster.  Most tools (like
.B ipmipower(8) 
and 
.B ipmi-sensors(8)
) come with hostrange support so multiple hosts can be specified on
the command line at the same time and IPMI can be executed against
the hosts in parallel.  See tool manpages for more information.
Also see the document 
\fIfreeipmi-hostrange.txt\fR 
for detailed usage and explanation.
.B Ipmi-sensors(8)
and the
.B libipmimonitoring(3)
library support the ability to interpret sensor readings as well as
just reporting them.  By mapping sensor readings into NOMINAL,
WARNING, or CRITICAL states, it makes monitoring sensors easier across
large numbers of nodes.

.SH "Development"

For information on the libraries that can be used to program IPMI
applications with, please see 
.B libfreeipmi(3), 
.B libipmiconsole(3),
.B libipmimonitoring(3), 
.B and libipmidetect(3).
Or see the document 
\fIfreeipmi-libraries.txt\fR.

.SH "Project Tools"
The following tools are distributed and supported by FreeIPMI.
.PP
.B Bmc-info
.PP
A tool to read information about a BMC such as device version numbers,
device support, and globally unique IDs (guids).
.PP
.B Bmc-watchdog
.PP
A tool/daemon to manage a BMC Watchdog. This tool is typically used
for system timeout management and automatic system restarts in the
event of a system crash.
.PP
.B Ipmi-chassis
.PP
A tool to manage/monitor a chassis, such as chassis power,
identification (i.e. LED control), and status.
.PP
.B Ipmi-fru
.PP
A tool to read field replaceable unit (FRU) information from a
motherboard/machine.
.PP
.B Ipmi-sel
.PP
A tool to read and manage IPMI System Event Log (SEL) records.  SEL
records store system event information and may be useful for debugging
problems.
.PP
.B Ipmi-sensors
.PP
A tool to read IPMI sensor readings and sensor data repository (SDR)
information.
.PP
.B Ipmipower
.PP
A tool for remote power control.
.PP
.B Ipmiconsole
.PP
A tool for Serial-over-Lan (SOL) console access.
.PP
.B Ipmi-config
.PP
A tool to configure BMC and IPMI information.  In can be used to
configured usernames, passwords, networking information, security,
Serial-over-LAN (SOL), Platform Event Filtering (PEF), boot devices,
power restoration policy, sensor thresholds, sensor events, and many
more configuration options.
.PP
.B Ipmi-raw
.PP
A tool that provides hex input/output of IPMI commands.
.PP
.B Ipmi-locate
.PP
A tool that can probe for information about the location of a BMC
device, such as device addresses.
.PP
.B Ipmi-pet
.PP
A tool to parse and interpret Platform Event Traps (PET).
.PP
.B Ipmi-dcmi
.PP
A tool to perform Data Center Manageability Interface (DCMI) IPMI
extension commands.  Supports extensions for asset management and
power usage management.
.PP
.B Bmc-device
.PP
A tool to perform advanced BMC commands, such as resetting the BMC,
configuring ACPI, configuring SDR/SEL time, manually generating
events, re-arming sensors, and configuring manufacturer settings.
.PP
.B Ipmiping
.PP
An IPMI ping tool for debugging.
.PP
.B Rmcpping
.PP
A RMCP ping tool for debugging.
.PP
.B Ipmi-oem
.PP
An IPMI tool for OEM specific commands.
.PP
.B Ipmidetect/Ipmidetectd
.PP
A tool and daemon for IPMI node detection.
.PP
.B Ipmiseld
.PP
A daemon that regularly polls the SEL and stores the events to the
local syslog.
.PP
Additional information, examples, and general trouble-shooting can be
found in each of the tool manpages.

.SH "Project Libraries"
The following libraries are distributed and supported by FreeIPMI.
.PP
.B Libfreeipmi
.PP
A C library that includes KCS, SSIF, OpenIPMI Linux, and Solaris BMC
drivers, IPMI 1.5 and IPMI 2.0 LAN communication interfaces, IPMI
packet building utilities, IPMI command utilities, and utilities for
reading/interpreting/managing IPMI.
.PP
.B Libipmiconsole
.PP
A library for Serial-over-Lan (SOL) console access.  SOL console
access is abstracted into a file descriptor interface, so users may
read and write console data through a file descriptor.
.PP
.B Libipmimonitoring
.PP
A library for sensor monitoring that abstracts away most IPMI details.
.PP
.B Libipmidetect
.PP
A library for IPMI node detection.

#include <@top_srcdir@/man/manpage-common-reporting-bugs.man>

.SH "COPYRIGHT"
Copyright \(co 2003-2014 FreeIPMI Core Team.  
#include <@top_srcdir@/man/manpage-common-gpl-freeipmi-text.man>

.SH "SEE ALSO"
libfreeipmi(3), libipmiconsole(3), libipmidetect(3),
libipmimonitoring(3), freeipmi.conf(5), bmc-device(8), bmc-info(8),
bmc-watchdog(8), ipmi-chassis(8), ipmi-config(8), ipmi-fru(8),
ipmi-locate(8), ipmi-oem(8), ipmi-pet(8), ipmi-raw(8), ipmi-sel(8),
ipmi-sensors(8), ipmiconsole(8), ipmidetect(8), ipmiping(8),
ipmipower(8), rmcpping(8)
#include <@top_srcdir@/man/manpage-common-homepage.man>