File: ipmi-pet.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 (207 lines) | stat: -rw-r--r-- 11,019 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
.TH IPMI-PET 8 "@ISODATE@" "IPMI-PET version @PACKAGE_VERSION@" "System Commands"
.SH "NAME"
IPMI \- IPMI Platform Event Trap Interpreter
.SH "SYNOPSIS"
.B ipmi-pet
[\fIOPTION\fR...] [SPECIFIC TRAP] [VARIABLE BINDING HEX BYTES ...]
.SH "DESCRIPTION"
.B Ipmi-pet
interprets hex bytes from a platform event trap (PET) and outputs a
string representing its contents.  Hex values may be input on the
command line, a file via the \fB\-\-file\fR option, or via stdin if
neither of the previous are specified.

.B Ipmi-pet
is commonly used in conjunction with an SNMP trap daemon to intrepret
the results from an IPMI PET trap captured by the daemon.  While
.B ipmi-pet
could be called directly from such a daemon, typically a script is called
to parse the SNMP daemon's output and convert it into a form that can be input
into
.B ipmi-pet.
On some systems, you may wish to also send a PET acknowledge to a
remote system to inform it the trap was received and parsed.  One can
be sent using the \fB\-\-pet-acknowledge\fR option.

While an IPMI session is not required to interpret a PET, data from
the sensor data repository (SDR) is required to properly interpret
sensor names and other information in the PET.  IPMI session
configuration below, such as driver, hostname, username, etc. should
be configured to load the SDR of the host where the trap originated.
If this is difficult to perform, it may be wise to cache and load a
specific SDR cache using the \fB\-\-sdr\-cache\-file\fR option.
If the SDR is difficult to obtain, the \fB\-\-ignore\-sdr\-cache\fR
option can be specified so that an SDR will not be loaded, and an IPMI
session will not be required.  The PET will be interpreted as best as
possible given no SDR.  The \fB\-\-ignore\-sdr\-cache\fR option may
affect other options such as \fB\-\-interpret\-oem\-data\fR too.  Some
options, such as \fB\-\-manufacturer\-id\fR and \fB\-\-product\-id\fR
may alleviate some of these issues.

If the SNMP daemon does not output a SNMPv1 \fIspecific trap\fR on its
own, it is typically output as the last element of the OID in SNMPv2.
If for some reason a \fIspecific trap\fR cannot be determined, the
value of \fINA\fR may be input for the \fIspecific trap\fR to indicate
it is not available.
.B Ipmi-pet
will output as much as possible based on the variable bindings
information.  Some of the specific trap information may be obtained
via SDR information.

#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.man>
#include <@top_srcdir@/man/manpage-common-outofband-username-operator.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-PET OPTIONS"
The following options are specific to
.B Ipmi-pet.
.TP
\fB\-v\fR
Output verbose output.  This option will output event direction and
OEM custom messages from the trap.
.TP
\fB\-vv\fR
Output very verbose output.  This option will output additional
information available in the trap, such as GUID, manufacturer ID,
and system ID.
.TP
\fB\-vvv\fR
Output very 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 events.  For
example, it will output Generator ID hex codes for sensors without
names.
.TP
\fB\-\-pet-acknowledge\fR
Send PET acknowledge using inputted trap data instead of outputting
data.  In some circumstances, this may be useful to inform a remote
system that a trap was received and parsed.  If specified, a hostname
must be specified via \fI\-h\fR or \fI\-\-hostname\fR to inform
.B ipmi-pet
where to send the acknowledge to.  When this option is specified, the
SDR cache is not loaded and is not required.
.TP
\fB\-\-file\fR=\fICMD\-FILE\fR
Specify a file to read PET specific trap and variable bindings hex
from instead of command line.
.TP
\fB\-\-output\-event\-severity\fR
Output event severity in output.  This will add an additional output
of an event severity.  The outputs may be Monitor, Information, OK,
Non-critical condition, Critical condition, or Non-recoverable
condition.  This differs from the output of
\fB\-\-output\-event\-state\fR, as event severity is not interpreted,
it is a value reported in the SNMP trap.  However, not all events may
report a severity, or some manufacturers may not support the report of
a severity.  Event severity will automatically be output under 
verbose output.
.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.  This differs from the output of
\fB\-\-output\-event\-severity\fR, as this output is an interpreted
value that will be interpreted identically to the
\fB\-\-output\-event\-state\fR output in
.B ipmi-sel(8).
As long as an event interpretation is supported, all events will have
outputted state.  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\-\-manufacturer\-id\fR=\fINUMBER\FR
Specify a specific manufacturer id to assume.  Useful if you wish to
specify \fB\-\-interpret\-oem\-data\fR, but the manufacturer id cannot
be determined by IPMI access or is not available in the SNMP trap.
The manufacturer id of a motherboard can be determined with
.B bmc-info(8).
If this option is specified, so must \fB\-\-product\-id\fR.
.TP
\fB\-\-product\-id\fR=\fINUMBER\FR
Specify a specific product id to assume.  Useful if you wish to
specify \fB\-\-interpret\-oem\-data\fR, but the product id cannot
be determined by IPMI access or is not available in the SNMP trap.
The product id of a motherboard can be determined with
.B bmc-info(8).
If this option is specified, so must \fB\-\-manufacturer\-id\fR.
#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-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-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-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>
#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
\fImalformedack\fR - This workaround flag will ignore malformed PET
acknowledge responses and assume any PET acknowledge response from the
remote machine is valid.  It works around remote systems that respond
with PET acknowledge requests with invalid/malformed IPMI payloads.
Those hitting this issue may see "session timeout" errors when
executing a PET acknowledge.  Issue observed on Dell Poweredge R610.
#include <@top_srcdir@/man/manpage-common-workaround-extra-text.man>
#include <@top_srcdir@/man/manpage-common-oem-interpretation.man>
.LP
Currently None
.SH "EXAMPLES"
.PP
Interpret a PET using the local SDR cache.
.PP
.B # ipmi-pet 356224 0x44 0x45 0x4c 0x4c 0x50 0x00 0x10 0x59 0x80 0x43 0xb2 0xc0 0x4f 0x33 0x33 0x58 0x00 0x02 0x19 0xe8 0x7e 0x26 0xff 0xff 0x20 0x20 0x04 0x20 0x73 0x18 0x00 0x80 0x01 0xff 0x00 0x00 0x00 0x00 0x00 0x19 0x00 0x00 0x02 0xa2 0x01 0x00 0xc1
.PP
Interpret a PET using a remote SDR cache.
.PP
.B # ipmi-pet -h ahost -u myusername -p mypassword 356224 0x44 0x45 0x4c 0x4c 0x50 0x00 0x10 0x59 0x80 0x43 0xb2 0xc0 0x4f 0x33 0x33 0x58 0x00 0x02 0x19 0xe8 0x7e 0x26 0xff 0xff 0x20 0x20 0x04 0x20 0x73 0x18 0x00 0x80 0x01 0xff 0x00 0x00 0x00 0x00 0x00 0x19 0x00 0x00 0x02 0xa2 0x01 0x00 0xc1
.PP
Interpret a PET using a previously stored SDR cache.
.PP
.B # ipmi-pet 356224 0x44 0x45 0x4c 0x4c 0x50 0x00 0x10 0x59 0x80 0x43 0xb2 0xc0 0x4f 0x33 0x33 0x58 0x00 0x02 0x19 0xe8 0x7e 0x26 0xff 0xff 0x20 0x20 0x04 0x20 0x73 0x18 0x00 0x80 0x01 0xff 0x00 0x00 0x00 0x00 0x00 0x19 0x00 0x00 0x02 0xa2 0x01 0x00 0xc1 --sdr-cache-file=/tmp/mysdrcache
.PP
Instead of outputting trap interpretation, send a PET acknowledge using the trap data.
.PP
.B # ipmi-pet -h ahost --pet-acknowledge 356224 0x44 0x45 0x4c 0x4c 0x50 0x00 0x10 0x59 0x80 0x43 0xb2 0xc0 0x4f 0x33 0x33 0x58 0x00 0x02 0x19 0xe8 0x7e 0x26 0xff 0xff 0x20 0x20 0x04 0x20 0x73 0x18 0x00 0x80 0x01 0xff 0x00 0x00 0x00 0x00 0x00 0x19 0x00 0x00 0x02 0xa2 0x01 0x00 0xc1
#include <@top_srcdir@/man/manpage-common-diagnostics.man>
#include <@top_srcdir@/man/manpage-common-known-issues.man>
#include <@top_srcdir@/man/manpage-common-reporting-bugs.man>
.SH "COPYRIGHT"
Copyright \(co 2011-2014 FreeIPMI Core Team
#include <@top_srcdir@/man/manpage-common-gpl-program-text.man>
.SH "SEE ALSO"
freeipmi(7), bmc-info(8), ipmi-config(8), ipmi-sel(8),
freeipmi_interpret_sel.conf(5)
#include <@top_srcdir@/man/manpage-common-homepage.man>