File: ipmi-sel.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 (286 lines) | stat: -rw-r--r-- 13,430 bytes parent folder | download
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
.TH IPMI-SEL 8 "@ISODATE@" "ipmi-sel @PACKAGE_VERSION@" "System Commands"
.SH "NAME"
ipmi-sel \- display SEL entries
.SH "SYNOPSIS"
.B ipmi-sel
[\fIOPTION\fR...]
.SH "DESCRIPTION"
.B Ipmi-sel
is used to view and manage System Event Log (SEL) entries.  SEL
records store system event information and may be useful for debugging
problems.

.B Ipmi-sel
does not inform the user if an event is particularly good or bad, just
that the event occurred.  Users may wish to use the
\fB\-\-output\-event\-state\fR option to output the analyzed state.

#include <@top_srcdir@/man/manpage-common-table-of-contents.man>
To perform some advanced SEL management, please see
.B bmc-device(8).

#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 "IPMI-SEL OPTIONS"
The following options are specific to
.B Ipmi-sel.
.TP
\fB\-v\fR
Output verbose output.  This option will output event direction.
Event direction may be useful to differentiate severity between some
events.  For example, some motherboards may issue an event both when a
temperature exceeds a threshold and when it goes back down below it.
.TP
\fB\-vv\fR
Output very verbose output.  This option will output additional
information than verbose output.  Most notably it will output
additional hex codes to given information on ambiguous SEL entries,
such as OEM codes.  For example, it will output Generator ID hex codes
for sensors without names, event type codes for OEM events, and record
types for OEM records.  This information may be useful if you are
writing a parser outside of
.B ipmi-sel
to interpret OEM information.
.TP
\fB\-i\fR, \fB\-\-info\fR
Show general information about the SEL.
.TP
\fB\-\-display\fR=\fIRECORD\-IDS\-LIST\fR
Display SEL records by record id.  Accepts space or comma separated lists.
.TP
\fB\-\-exclude\-display\fR=\fIRECORD\-IDS\-LIST\fR
Exclude display of SEL records by record id.  Accepts space or comma
separated lists.
.TP
\fB\-\-display-range\fR=\fISTART\-END\fR
Display SEL records from record id START to END.
.TP
\fB\-\-exclude\-display-range\fR=\fISTART\-END\fR
Exclude display of SEL records from record id START to END.
.TP
\fB\-\-date\-range\fR=\fIDATE\-DATE\fR
Display SEL records with events occurring in the specified date range.
Dates may be specified in MM/DD/YYYY or MM-DD-YYYY format.  The month
may be specified as a numeral or its abbreviated string name.  The
current local system time can be specified with "now".  Note that
non-timestamped records will not be displayed automatically because
they do not possess a timestamp.
.TP
\fB\-\-exclude\-date\-range\fR=\fIDATE\-DATE\fR
Exclude display of SEL records with events occurring in the specified
date range.  Dates may be specified in MM/DD/YYYY or MM-DD-YYYY
format.  The month may be specified as a numeral or its abbreviated
string name.  The current local system time can be specified with
"now".  Note that non-timestamped records will be displayed
automatically because they do not possess a timestamp.
.TP
\fB\-t\fR \fISENSOR\-TYPE\-LIST\fR, \fB\-\-sensor\-types\fR=\fISENSOR\-TYPE\-LIST\fR
Specify sensor types to show SEL events for.  Multiple types can be
separated by commas or spaces.  A special command line type of "all",
will indicate all types should be shown (may be useful for overriding
configured defaults).  Users may specify sensor types by string (see
\fB\-\-list\-sensor\-types\fR below) 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 to not show SEL events for.  Multiple types can
be separated by commas or spaces.  A special command line type of "none",
will indicate no types should be excluded (may be useful for
overriding configured defaults).  Users may specify sensor types by
string (see \fB\-\-list\-sensor\-types\fR below) or by number (decimal
or hex).
.TP
\fB\-L\fR, \fB\-\-list\-sensor\-types\fR
List sensor types.
.TP
\fB\-\-tail\fR=\fIcount\fR
Display approximately the last \fIcount\fR SEL records.  The display
count is calculated by approximating the record ids of the last SEL
records.  It's correctness depends highly on the SEL implementation by
the vendor.
.TP
\fB\-\-clear\fR
Clear SEL.
.TP
\fB\-\-post\-clear\fR
Identical to \fB\-\-clear\fR, except the SEL clearning will be
performed after SEL event records are displayed.  This option is
useful for scripting if users intend to log SEL events to another log,
then immediately clear SEL.  Unlike calling \fB\-\-clear\fR in another
execution of
.B ipmi-sel,
this option will use SEL reservations to notify the user if a SEL
change has occurred while displaying and clearing the SEL.  This can
protect users from a race, where a new SEL event is unknowingly
generated before clearing the SEL.  Note that SEL reservations are
optionally implemented by vendors and may not be available on all
machines.
.TP
\fB\-\-delete\fR=\fIRECORD\-IDS\-LIST\fR
Delete records by record id in the SEL.  Accepts space or comma
separated lists.
.TP
\fB\-\-delete-range\fR=\fISTART\-END\fR
Delete record ids from START to END in the SEL.
.TP
\fB\-\-system\-event\-only\fR
Output only system event records (i.e. don't output OEM records).
.TP
\fB\-\-oem\-event\-only\fR
Output only OEM event records (i.e. don't output system event records).
.TP
\fB\-\-output\-manufacturer\-id\fR
For OEM SEL record types, output the manufacturer ID along with event
data when available.
.TP
\fB\-\-output\-event\-state\fR
Output event state in output.  This will add an additional output
reporting if an event should be viewed as NOMINAL, WARNING, or CRITICAL.
The event state is an interpreted value based on the configuration
file @INTERPRET_SEL_CONFIG_FILE_DEFAULT@ and the event direction.
See
.B freeipmi_interpret_sel.conf(5)
for more information.
.TP
\fB\-\-event\-state\-config\-file\fR=\fIFILE\fR
Specify an alternate event state configuration file.  Option ignored
if \fB\-\-output\-event\-state\fR not specified.
.TP
\fB\-\-hex\-dump\fR
Hex-dump SEL entries.
.if 0 \{
.TP
\fB\-\-assume\-system\-event\-records\fR
Some motherboards have invalid SEL record types listed, leading to
errors such as 'Unknown SEL Record Type'.  The records may actually be
formatted correctly.  Use this option to assume these invalid record
types are system event records and 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-interpret-oem-data.man>
.TP
\fB\-\-output\-oem\-event\-strings\fR
Some motherboards support an IPMI OEM extension that returns the
string output for a system event.  Such string output may be
beneficial for determining the meaning behind OEM specific events.  This option
will use the OEM event string to describe all system events in the
.B ipmi-sel
output.  This option differs from \fI\-\-interpret\-oem\-data\fR
option in that all system events will output the vendor supplied event
string, not just events that are OEM specific.  The event string may
be very different from the normal FreeIPMI event string output.  If an
OEM event strings is not available, the default output will be output.
This option is confirmed to work for Fujitsu iRMC S1 and iRMC S2
systems.
#include <@top_srcdir@/man/manpage-common-entity-sensor-names.man>
#include <@top_srcdir@/man/manpage-common-no-sensor-type-output.man>
#include <@top_srcdir@/man/manpage-common-comma-separated-output.man>
#include <@top_srcdir@/man/manpage-common-no-header-output.man>
#include <@top_srcdir@/man/manpage-common-non-abbreviated-units.man>
#include <@top_srcdir@/man/manpage-common-legacy-output.man>
#include <@top_srcdir@/man/manpage-common-sdr-cache-options-heading.man>
#include <@top_srcdir@/man/manpage-common-sdr-cache-options.man>
#include <@top_srcdir@/man/manpage-common-sdr-cache-file-directory.man>
#include <@top_srcdir@/man/manpage-common-sdr-cache-ignore.man>
#include <@top_srcdir@/man/manpage-common-time-options-heading.man>
#include <@top_srcdir@/man/manpage-common-time-options.man>
#include <@top_srcdir@/man/manpage-common-hostranged-options-header.man>
#include <@top_srcdir@/man/manpage-common-hostranged-buffer.man>
#include <@top_srcdir@/man/manpage-common-hostranged-consolidate.man>
#include <@top_srcdir@/man/manpage-common-hostranged-fanout.man>
#include <@top_srcdir@/man/manpage-common-hostranged-eliminate.man>
#include <@top_srcdir@/man/manpage-common-hostranged-always-prefix.man>
#include <@top_srcdir@/man/manpage-common-hostranged-text-main.man>
#include <@top_srcdir@/man/manpage-common-hostranged-text-threads.man>
#include <@top_srcdir@/man/manpage-common-hostranged-text-options.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 "IPMI-SEL 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>
#include <@top_srcdir@/man/manpage-common-workaround-sdr-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, Intel Windmill, Intel S2600KP, Intel S2600WT2, Intel
S2600WTT, Inventec 5441/Dell Xanadu II, Inventec 5442/Dell Xanadu III,
Quanta S99Q/Dell FS12-TY, Quanta QSSC-S4R/Appro GB812X-CN, Quanta
Winterfell, 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,
Wiwynn Windmill, Wistron/Dell Poweredge C6220.
.SH "EXAMPLES"
.B # ipmi-sel 
.PP
Show all SEL records on the local machine.
.PP
.B # ipmi-sel -h ahost -u myusername -p mypassword
.PP
Show all SEL records of a remote machine using IPMI over LAN.
.PP
.B # ipmi-sel -h mycluster[0-127] -u myusername -p mypassword
.PP
Show all SEL records across a cluster using IPMI over LAN.
.PP
.B # ipmi-sel --delete=44,82
.PP
Delete SEL records 44 and 82 on the local machine.
.PP
.B # ipmi-sel --delete-all
.PP
Delete all SEL entries on the local machine.
.PP
.B # ipmi-sel --delete-range=12-42
.PP
Delete SEL entries in the range 12 to 42 on the local machine.
.PP
#include <@top_srcdir@/man/manpage-common-diagnostics.man>
#include <@top_srcdir@/man/manpage-common-diagnostics-hostranged-text.man>
#include <@top_srcdir@/man/manpage-common-known-issues.man>
#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-program-text.man>
.SH "SEE ALSO"
freeipmi(7), bmc-device(8), ipmiseld(8), ipmi-config(8),
freeipmi_interpret_sel.conf(5)
#include <@top_srcdir@/man/manpage-common-homepage.man>