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|-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       -v     Increase verbose output level.  This  option  may  be  specified
119              multiple  times to increase the level of debug output.  If given
120              three times you will get hexdumps of all incoming  and  outgoing
121              packets.
122
123       -V     Display version information.
124
125
126       If  no  password  method is specified then ipmievd will prompt the user
127       for a password. If no password is entered at  the  prompt,  the  remote
128       server password will default to NULL.
129

COMMANDS

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

EXAMPLES

191       Example 1: Daemon process watching OpenIPMI for events
192
193              > ipmievd -I open open daemon
194
195       Example 2: Local non-daemon process checking remote SEL every  30  sec‐
196       onds
197
198              > ipmievd -I lan -H 1.2.3.4 -f passfile sel nodaemon timeout=30
199              Reading Sensors...
200              Waiting for Events...
201

AUTHOR

203       Duncan Laurie <duncan@iceblink.org>
204