File: ipmiseld.8.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 (317 lines) | stat: -rw-r--r-- 14,097 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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
.\"#############################################################################
.\"$Id: ipmiseld.8.pre.in,v 1.15 2010-06-30 21:56:36 chu11 Exp $
.\"#############################################################################
.\"  Copyright (C) 2012-2014 Lawrence Livermore National Security, LLC.
.\"  Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
.\"  Written by Albert Chu <chu11@llnl.gov>
.\"  LLNL-CODE-559172
.\"  
.\"  This file is part of Ipmiseld, an IPMI SEL syslog logging daemon.
.\"  For details, see http://www.llnl.gov/linux/.
.\"
.\"  Ipmiseld is free software; you can redistribute it and/or modify it under
.\"  the terms of the GNU General Public License as published by the Free
.\"  Software Foundation; either version 3 of the License, or (at your option)
.\"  any later version.
.\"  
.\"  Ipmiseld is distributed in the hope that it will be useful, but WITHOUT 
.\"  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
.\"  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License 
.\"  for more details.
.\"  
.\"  You should have received a copy of the GNU General Public License along
.\"  with Ipmiseld.  If not, see <http://www.gnu.org/licenses/>.
.\"#############################################################################
.TH ipmiseld 8 "@ISODATE@" "ipmiseld @VERSION@" ipmiseld
.SH "NAME"
ipmiseld \- IPMI SEL logging daemon
.SH "SYNOPSIS"
.B ipmiseld 
[\fIOPTION\fR...]
.br
.SH "DESCRIPTION"
The
.B ipmiseld
daemon polls the system event log (SEL) of specified hosts and stores
the logs into the local syslog.  By default, the daemon can also make
best efforts to manage the remote SEL's buffer to ensure events are
never lost.  Recent logging data will be cached to disk to ensure that
SEL events are not missed in the event the client or server is
rebooted.
.LP
Many of the options for this daemon are very similar to the
.B ipmi-sel(8)
tool.  It can be configured to log the local host, a remote host, or a
range of hosts to the local syslog.  It can be configured via the command line
arguments listed below or via the
@IPMISELD_CONFIG_FILE_DEFAULT@
configuration file.
#include <@top_srcdir@/man/manpage-common-table-of-contents.man>
#include <@top_srcdir@/man/manpage-common-general-options-header.man>
#include <@top_srcdir@/man/manpage-common-driver.man>
#include <@top_srcdir@/man/manpage-common-inband.man>
#include <@top_srcdir@/man/manpage-common-outofband-hostname-hostranged.man>
#include <@top_srcdir@/man/manpage-common-outofband-username-user.man>
#include <@top_srcdir@/man/manpage-common-outofband-password.man>
#include <@top_srcdir@/man/manpage-common-outofband-k-g.man>
#include <@top_srcdir@/man/manpage-common-outofband-session-timeout.man>
#include <@top_srcdir@/man/manpage-common-outofband-retransmission-timeout.man>
#include <@top_srcdir@/man/manpage-common-authentication-type.man>
#include <@top_srcdir@/man/manpage-common-cipher-suite-id-main.man>
#include <@top_srcdir@/man/manpage-common-cipher-suite-id-details.man>
#include <@top_srcdir@/man/manpage-common-privilege-level-operator.man>
#include <@top_srcdir@/man/manpage-common-config-file.man>
#include <@top_srcdir@/man/manpage-common-workaround-flags.man>
#include <@top_srcdir@/man/manpage-common-debug.man>
#include <@top_srcdir@/man/manpage-common-misc.man>
.SH "IPMISELD OPTIONS"
The following options are specific to
.B Ipmiseld.
.TP
\fB\-v\fR
Log verbose information.  This option will log additional information.
Most notably it will output additional hex codes to given information
on ambiguous SEL entries or SEL records.  For example, it will output
Generator ID hex codes for sensors without names.  Additional
non-critical SEL errors or issues will also be logged.  Somewhat
common errors, such as timeouts or invalid hostnames, will output with
increased verbosity.
.TP
\fB\-t\fR \fISENSOR\-TYPE\-LIST\fR, \fB\-\-sensor\-types\fR=\fISENSOR\-TYPE\-LIST\fR
Specify sensor types of SEL events to log.  By default, all sensor
types are logged.  A special command line type of "all", will indicate
all types should be shown (may be useful for overriding configured
defaults).  Multiple types can be separated by commas or spaces.
Users may specify sensor types by string (see
\fB\-\-list\-sensor\-types\fR in
.B ipmi-sel(8))
or by number (decimal or hex).
.TP
\fB\-T\fR \fISENSOR\-TYPE\-LIST\fR, \fB\-\-exclude\-sensor\-types\fR=\fISENSOR\-TYPE\-LIST\fR
Specify sensor types of SEL events to not log.  By default, no sensor
types are filtered.  A special command line type of "none", will
indicate no types should be excluded (may be useful for overriding
configured defaults).  Multiple types can be separated by commas or
spaces.  Users may specify sensor types by string (see
\fB\-\-list\-sensor\-types\fR in
.B ipmi-sel(8))
or by number (decimal or hex).
.TP
\fB\-\-system\-event\-only\fR
Log only system event records (i.e. don't log OEM records).
.TP
\fB\-\-oem\-event\-only\fR
Log only OEM event records (i.e. don't log system event records).
.TP
\fB\-\-event\-state\-config\-file\fR=\fIFILE\fR
Specify an alternate event state configuration file.
#include <@top_srcdir@/man/manpage-common-interpret-oem-data.man>
#include <@top_srcdir@/man/manpage-common-entity-sensor-names.man>
#include <@top_srcdir@/man/manpage-common-non-abbreviated-units.man>
.TP
\fB\-\-event\-state\-filter\fR=\fIFILTERSTRING\fR
Specify event states to be filtered out and not logged.  Possible
inputs are NOMINAL, WARNING, CRITICAL, and NA.  Multiple states can be
listed separted by comma.  The special case string of "none" will
indicate no event states should be excluded (may be useful for
overriding configured defaults).
.TP
\fB\-\-warning\-threshold\fR=\fIPERCENTINT\fR
Specify SEL fullness warning threshold as an integer percentage.  When
the SEL is past this percentage full, a warning will be output
indicating that SEL is nearly full.  Specify 0 to disable warning
logs.  Defaults to 80.
.TP
\fB\-\-clear\-threshold\fR=\fIPERCENTINT\fR
Specify SEL fullness clear threshold as an integer percentage.  When
the SEL is past this percentage full,
.B ipmiseld
will attempt to clear the SEL.  Specify 0 to disable clearing.  When
the SEL is full, it will be the responsibility of the user to clear
the SEL manually if clearing is disabled.  Defaults to 0.  If
specified to a non-zero value, be careful that the clearing of the SEL
could affect other applications that monitor the SEL, such as
monitoring applications that use
.B ipmi-sel(8)
or  
.B libipmimonitoring(3).
.TP
\fB\-\-system\-event\-format\fR=\fIFORMATSTRING\fR
Specify the format of the log output when a SEL system event is
encountered.  Defaults to "SEL System Event: %d, %t, %s, %I, %E" if
logging locally, "SEL System Event(%h): %d, %t, %s, %I, %E" if logging
outofband or with hostranges.  See SEL LOG FORMAT STRING below for
formatting details.
.TP
\fB\-\-oem\-timestamped\-event\-format\fR=\fIFORMATSTRING\fR
Specify the format of the log output when a SEL OEM timestamped event
is encountered.  Defaults to "SEL OEM Event: %d, %t, %I, %o" if
logging locally, "SEL OEM Event(%h): %d, %t, %I, %o" if logging
outofband or with hostranges..  See SEL LOG FORMAT STRING below for
formatting details.
.TP
\fB\-\-oem\-non\-timestamped\-event\-format\fR=\fIFORMATSTRING\fR
Specify the format of the log output when a SEL OEM non-timestamped
event is encountered.  Defaults to "SEL OEM Event: %I, %o" if logging
locally, "SEL OEM Event(%h): %I, %o" if logging outofband or with
hostranges..  See SEL LOG FORMAT STRING below for formatting details.
.TP
\fB\-\-poll\-interval\fR=\fISECONDS\fR
Specify the poll interval to check the SEL for new events.  Defaults
to 300 seconds (i.e. 5 minutes).
.TP
\fB\-\-log\-facility\fR=\fISTRING\fR
Specify the log facility to use.  Defaults to LOG_DAEMON.  Legal
inputs are LOG_DAEMON, LOG_USER, LOG_LOCAL0, LOG_LOCAL1, LOG_LOCAL2,
LOG_LOCAL3, LOG_LOCAL4, LOG_LOCAL5, LOG_LOCAL6, LOG_LOCAL7.
.TP
\fB\-\-log\-priority\fR=\fISTRING\fR
Specify the log priority to use.  Defaults to LOG_ERR.  Legal inputs
are LOG_EMERG, LOG_ALERT, LOG_CRIT, LOG_ERR, LOG_WARNING, LOG_NOTICE,
LOG_INFO, LOG_DEBUG.
.TP
\fB\-\-cache\-directory\fR=\fIDIRECTORY\fR
Specify an alternate cache directory location for
.B ipmiseld
to use.  The cache directory will be used to cache a wide variety of
data, including the SDR and recent logging information to ensure log
entries are not missed on reboots and other system failures.
.TP
\fB\-\-ignore\-sdr\fR
Ignore SDR related processing.  May lead to incomplete or less useful
information being output, however it will allow functionality for
systems without SDRs or when the correct SDR cannot be loaded.
.TP
\fB\-\-re\-download\-sdr\fR
Re-download the SDR on start even if it is not out of date.  This may
help work around systems that do not properly timestamp SDR
modification times.
.TP
\fB\-\-clear\-sel\fR
On startup, clear any SEL being monitored.  May be useful the first
time running
.B ipmiseld
to avoid warning messages or SEL clears until a long time in the
future.
.TP
\fB\-\-threadpool\-count\fR=\fINUM\fR
Specify the number of threads for parallel SEL polling.  This option
is very similar to the \fB\-\-fanout\fR option in
.B ipmi-sel(8)
but the threads are created only once on initialization for faster
processing.  Defaults to 8, however the threadpool count will always
be decreased if the number of nodes specified is less than the number
of threads.
.TP
\fB\-\-test\-run\fR
Do not daemonize, output the current SEL of configured hosts as a test
of current settings and configuration.
.TP
\fB\-\-foreground\fR
Run daemon in the foreground.
.SH "SEL LOG FORMAT STRING"
The output format of log messages can be adjusted via the
\fB\-\-system\-event\-format\fR,
\fB\-\-oem\-timestamped\-event\-format\fR and
\fB\-\-oem\-non\-timestamped\-event\-format\fR options.  Options such
as \fB\-\-interpret\-oem\-data\fR, \fB\-\-entity\-sensor\-names\fR,
and \fB\-\-non\-abbreviated\-units\fR can further adjust the output
format.  The following conversion directives will allow the user to
output specifics of each SEL event that occurs.
.sp
\fIFor System, OEM timestamped, and OEM non-timestamped events\fR
.sp
%h - target host, useful if logging from multiple hosts 
.sp
%i - record ID in decimal 
.sp
%I - event state interpretation (NOMINAL, WARNING, or CRITICAL)
.sp
\fIFor System and OEM timestamped events\fR
.sp
%t - time in format H:M:S using 24 hour clock
.sp
%d - date in format D-M-YEAR
.sp
\fIFor System events\fR
.sp
%T - sensor type
.sp
%s - sensor name
.sp
%e - event data 1 string
.sp
%f - event data 2 string [2]
.sp
%h - event data 3 string
.sp
%c - combined event data 2 and event data 3 string
.sp
%p - event data 2 previous state string
.sp
%S - event data 2 severity string
.sp
%E - combined event data 1, 2, and 3 string
.sp
%k - event direction
.sp
\fIFor OEM timestamped events\fR
.sp
%m - manufacturer id
.sp
\fIFor OEM timestamped and OEM non-timestamped events\fR
.sp
%o - oem data in hex
.sp
%O - OEM supplied string describing the event (depends on manufacturer)
#include <@top_srcdir@/man/manpage-common-hostranged-text-main.man>
#include <@top_srcdir@/man/manpage-common-hostranged-text-localhost.man>
#include <@top_srcdir@/man/manpage-common-troubleshooting-heading-start.man>
#include <@top_srcdir@/man/manpage-common-troubleshooting-heading-outofband.man>
#include <@top_srcdir@/man/manpage-common-troubleshooting-heading-inband.man>
#include <@top_srcdir@/man/manpage-common-troubleshooting-heading-end.man>
#include <@top_srcdir@/man/manpage-common-troubleshooting-outofband.man>
#include <@top_srcdir@/man/manpage-common-troubleshooting-inband.man>
#include <@top_srcdir@/man/manpage-common-troubleshooting-inband-outofband.man>
.SH "IPMISELD TROUBLESHOOTING"
#include <@top_srcdir@/man/manpage-common-troubleshooting-sel.man>
#include <@top_srcdir@/man/manpage-common-workaround-heading-text.man>
#include <@top_srcdir@/man/manpage-common-workaround-inband-text.man>
#include <@top_srcdir@/man/manpage-common-workaround-outofband-common-text.man>
#include <@top_srcdir@/man/manpage-common-workaround-outofband-15-text.man>
#include <@top_srcdir@/man/manpage-common-workaround-outofband-20-text.man>
.LP
\fIassumesystemevent\fR - This workaround option will assume invalid SEL
record types are system event records.  Records may be formatted
correctly but report invalid record types.  Those hitting this issue
may see "Unknown SEL Record Type" errors.  Output may be unknown, pray
for the best.  This option is confirmed to work around compliances
issues on HP DL 380 G5 motherboards.
#include <@top_srcdir@/man/manpage-common-workaround-extra-text.man>
#include <@top_srcdir@/man/manpage-common-oem-interpretation.man>
.LP
Dell Poweredge 2900, Dell Poweredge 2950, Dell Poweredge R610, Dell
Poweredge R710, Fujitsu iRMC S1 and iRMC S2 systems, Intel
S5500WB/Penguin Computing Relion 700, Intel S2600JF/Appro 512X, Intel
S5000PAL, Inventec 5441/Dell Xanadu II, Inventec 5442/Dell Xanadu III,
Quanta S99Q/Dell FS12-TY, Quanta QSSC-S4R/Appro GB812X-CN, Sun X4140
Supermicro X7DBR-3, Supermicro X7DB8, Supermicro X8DTN, Supermicro
X7SBI-LN4, Supermicro X8DTH, Supermicro X8DTG, Supermicro X8DTU,
Supermicro X8DT3-LN4F, Supermicro X8DTU-6+, Supermicro X8DTL,
Supermicro X8DTL-3F, Supermicro X8SIL-F, Supermicro X9SCL, Supermicro
X9SCM, Supermicro X8DTN+-F, Supermicro X8SIE, Supermicro X9SCA-F-O,
Supermicro H8DGU-F, Supermicro X9DRi-F, Supermicro X9DRI-LN4F+,
Supermicro X9SPU-F-O, Supermicro X9SCM-iiF, Wistron/Dell Poweredge
C6220.
#include <@top_srcdir@/man/manpage-common-known-issues.man>
.SH "FILES"
@IPMISELD_CONFIG_FILE_DEFAULT@
@IPMISELD_CACHE_DIRECTORY@
#include <@top_srcdir@/man/manpage-common-reporting-bugs.man>
.SH COPYRIGHT
Copyright (C) 2012-2014 Lawrence Livermore National Security, LLC.
#include <@top_srcdir@/man/manpage-common-gpl-program-text.man>
.SH "SEE ALSO"
freeipmi(7), ipmi-sel(8), ipmiseld.conf(5), bmc-device(8),
ipmi-config(8), freeipmi_interpret_sel.conf(5)
#include <@top_srcdir@/man/manpage-common-homepage.man>