ipmievd(8)

1ipmievd(8)                                                          ipmievd(8)
2
3
4

NAME

6       ipmievd - IPMI event daemon for sending events to syslog
7

SYNOPSIS

9       ipmievd [-c|-h|-d N|-v|-V] -I open <open | sel> [<option>]
10
11       ipmievd [-c|-h|-v|-V] -I lan -H <hostname>
12               [-p <port>]
13               [-U <username>]
14               [-A <authtype>]
15               [-L <privlvl>]
16               [-a|-E|-P|-f <password>]
17               [-o <oemtype>]
18               [-O <sel oem>]
19               sel [<option>]
20
21       ipmievd [-c|-h|-v|-V] -I lanplus -H <hostname>
22               [-p <port>]
23               [-U <username>]
24               [-L <privlvl>]
25               [-a|-E|-P|-f <password>]
26               [-o <oemtype>]
27               [-O <sel oem>]
28               [-C <ciphersuite>]
29               sel [<option>]
30

DESCRIPTION

32       ipmievd  is a daemon which will listen for events from the BMC that are
33       being sent to the SEL and also log those messages  to  syslog.   It  is
34       able  to run in one of two modes: either using the Event Message Buffer
35       and asynchronous event notification from the OpenIPMI kernel driver  or
36       actively  polling the contents of the SEL for new events.  Upon receipt
37       of an event via either mechanism it will be logged to syslog  with  the
38       LOG_LOCAL4 facility.
39
40       It  is based on the ipmitool utility and shares the same IPMI interface
41       support and session setup options.  Please see the ipmitool manpage for
42       more information on supported IPMI interfaces.
43

OPTIONS

45       -a     Prompt for the remote server password.
46
47       -A <authtype>
48              Specify  an  authentication type to use during IPMIv1.5 lan ses‐
49              sion activation.  Supported types are NONE, PASSWORD, MD2,  MD5,
50              or OEM.
51
52       -c     Present  output  in CSV (comma separated variable) format.  This
53              is not available with all commands.
54
55       -C <ciphersuite>
56              The remote  server  authentication,  integrity,  and  encryption
57              algorithms  to  use  for  IPMIv2 lanplus connections.  See table
58              22-19 in the IPMIv2 specification.  The default is 3 which spec‐
59              ifies RAKP-HMAC-SHA1 authentication, HMAC-SHA1-96 integrity, and
60              AES-CBC-128 encryption algorightms.
61
62       -E     The remote server password is specified by the environment vari‐
63              able IPMI_PASSWORD.
64
65       -f <password_file>
66              Specifies  a file containing the remote server password. If this
67              option is absent, or if password_file  is  empty,  the  password
68              will default to NULL.
69
70       -h     Get basic usage help from the command line.
71
72       -H <address>
73              Remote  server  address,  can  be  IP address or hostname.  This
74              option is required for lan and lanplus interfaces.
75
76       -I <interface>
77              Selects IPMI interface to use.  Supported  interfaces  that  are
78              compiled in are visible in the usage help output.
79
80       -L <privlvl>
81              Force session privilege level.  Can be CALLBACK, USER, OPERATOR,
82              ADMIN. Default is ADMIN.
83
84       -m <local_address>
85              Set the local IPMB address.   The  default  is  0x20  and  there
86              should be no need to change it for normal operation.
87
88       -o <oemtype>
89              Select  OEM  type to support.  This usually involves minor hacks
90              in place in the code to work around quirks in various BMCs  from
91              various  manufacturers.   Use  -o  list to see a list of current
92              supported OEM types.
93
94       -O <sel oem>
95              Open selected file and read OEM SEL  event  descriptions  to  be
96              used  during SEL listings.  See examples in contrib dir for file
97              format.
98
99       -p <port>
100              Remote server UDP port to connect to.  Default is 623.
101
102       -P <password>
103              Remote server password is specified on  the  command  line.   If
104              supported it will be obscured in the process list.  Note! Speci‐
105              fying the password as a command line option is not recommended.
106
107       -S <sdr_cache_file>
108              Use local file for remote SDR cache.  Using a  local  SDR  cache
109              can  drastically  increase performance for commands that require
110              knowledge of the entire SDR to perform their function.
111
112       -t <target_address>
113              Bridge IPMI requests to the remote target address.
114
115       -U <username>
116              Remote server username, default is NULL user.
117
118       -d N   Use device number N to specify the /dev/ipmiN (or /dev/ipmi/N or
119              /dev/ipmidev/N)  device  to  use  for in-band BMC communication.
120              Used to target a specific BMC on a multi-node, multi-BMC  system
121              through the ipmi device driver interface.  Default is 0.
122
123       -v     Increase  verbose  output  level.   This option may be specified
124              multiple times to increase the level of debug output.  If  given
125              three  times  you will get hexdumps of all incoming and outgoing
126              packets.
127
128       -V     Display version information.
129
130
131       If no password method is specified then ipmievd will  prompt  the  user
132       for  a  password.  If  no password is entered at the prompt, the remote
133       server password will default to NULL.
134

COMMANDS

136       help   This can be used to get  command-line  help.   It  may  also  be
137              placed at the end of commands to get option usage help.
138
139              > ipmievd help
140              Commands:
141                  open    Use OpenIPMI for asyncronous notification of events
142                  sel     Poll SEL for notification of events
143
144
145       open   This  command  starts  ipmievd  with the OpenIPMI event watching
146              mechanism which relies on the Event Message  Buffer  feature  of
147              IPMI.    This  requires  a  properly  installed  and  configured
148              OpenIPMI driver on Linux and is only valid to be run through the
149              open  interface.   See the ipmitool manpage and associated docu‐
150              mentation for  more  information  on  setting  up  the  OpenIPMI
151              driver.
152
153              Note:  Some BMC do not support the Event Message Buffer required
154              for this command.  Other BMCs claim to support  it  but  do  not
155              actually  deliver  events to it.  If this is the case please use
156              the sel method.
157
158
159              daemon Launch process as a daemon and reparent to init  process.
160                     All messages will be sent to syslog.  This is the default
161                     action.
162
163              nodaemon
164                     Do NOT become a  daemon,  instead  log  all  messages  to
165                     stderr.
166
167              pidfile=<filename>
168                     Save  process  ID  to  this  file  when  in  daemon mode.
169                     Defaults to /var/run/ipmievd.pidN (where N  is  the  ipmi
170                     device number -- defaults to 0).
171
172
173       sel    This  command starts ipmievd with the SEL Polling event watching
174              mechanism.  This will poll the SEL periodically to determine  if
175              new  events have been logged.  This command should work with all
176              BMCs and is capable of using the LAN interface as well to  moni‐
177              tor a remote system and log its events to a local syslog.
178
179
180              daemon Launch  process as a daemon and reparent to init process.
181                     All messages will be sent to syslog.  This is the default
182                     action.
183
184              nodaemon
185                     Do  NOT  become  a  daemon,  instead  log all messages to
186                     stderr.
187
188              pidfile=<filename>
189                     Save process  ID  to  this  file  when  in  daemon  mode.
190                     Defaults  to  /var/run/ipmievd.pidN  (where N is the ipmi
191                     device number -- defaults to 0).
192
193              timeout=<seconds>
194                     Time between checks for SEL polling method.   Default  is
195                     10 seconds.
196

EXAMPLES

198       Example 1: Daemon process watching OpenIPMI for events
199
200              > ipmievd -I open open daemon
201
202       Example  2:  Local non-daemon process checking remote SEL every 30 sec‐
203       onds
204
205              > ipmievd -I lan -H 1.2.3.4 -f passfile sel nodaemon timeout=30
206              Reading Sensors...
207              Waiting for Events...
208

AUTHOR

210       Duncan Laurie <duncan@iceblink.org>
211