1ipmi_ui(1)             Crude interface to an IPMI system            ipmi_ui(1)
2
3
4

NAME

6       ipmi_ui - Crude interface to an IPMI system
7
8

SYNOPSIS

10       ipmi_ui [-dmsg] [-dmem] [-c] connection-1[connection-2]
11
12       The connections are specified as either:
13
14       smi smi-num
15
16       or
17
18       lan IP-addr port [IP-addr-2 port-2] auth privilege username password
19
20

DESCRIPTION

22       The  ipmi_ui  program  connects to an IPMI system, and allows access to
23       IPMI entities and sensors and OpenIPMI controls.   It's  rather  crude,
24       and  primarily for testing OpenIPMI, but it has some use beyond that so
25       it is provided.
26
27       Normally, ipmi_ui starts up in a full-screen format.  The  left  window
28       shows  the  output  of  commands,  the right window shows the logs from
29       OpenIPMI.  Both windows are scrollable with page up and page down keys,
30       press the "F1" key to choose the left window to scroll, the "F2" key to
31       choose the right window to scroll.
32
33       Note that you must set your environment TERM variable properly for your
34       terminal, or ipmi_ui will display garbage on the screen.
35
36       Note  that  you  can  put  two connection specifications on the command
37       line, and ipmi_ui will make two connection.  You can only  do  this  if
38       the  connections  are to the same IPMI domain through different manage‐
39       ment controllers.  Also, each LAN connection may have two IP addresses.
40       These  are  two  different addresses to the same management controller.
41       So you may have a total of 4 IP addresses to an IPMI domain,  two  man‐
42       agement controllers and two IP addresses to each management controller.
43
44

OPTIONS

46       -dmsg  Turn  on  message  debugging, this will dump all messages to the
47              log window.
48
49       -dmem  Turn on memory debugging, this will cause memory allocation  and
50              deallocations  to  be  checked.  When the program terminates, it
51              will dump all memory that was not properly freed (leaked).
52
53       -snmp  Enable the SNMP trap handler.  ipmi_ui  must  be  compiled  with
54              SNMP code enabled for this option to be available.
55
56       -c     Run  the  program  in  command-line  mode.   This  is useful for
57              scripting.  All output goes to standard output, there is no win‐
58              dowing.
59
60
61       smi-num
62              The SMI number to connect to, for systems with more than on sys‐
63              tem interface.  Generally, this is '0'.
64
65
66       IP-addr
67              The IP address of the LAN interface.
68
69
70       port   The UDP port of the LAN interface, general 623.
71
72
73       IP-addr-2
74              Some systems support multiple IP connections, this specified the
75              second address and is optional.  If specified, OpenIPMI will use
76              both IP addresses and fail over to the working  one  if  one  of
77              them fails.
78
79
80       port-2 The port for the second IP connection, generally 623.
81
82
83       auth   The  authorization  to  use  for  the connection, either "none",
84              "straight", "md5", or "md2".
85
86
87       privilege
88              The privilege to use  for  the  connection,  either  "callback",
89              "user",  "operator", or "admin".  Note that some IPMI operations
90              will fail without the correct privilege.
91
92
93       username
94              The user name to use for the connection.  If using  this  anony‐
95              mous user, this should be the empty string "".
96
97
98       password
99              The password to use for the connection.
100
101

ENTITIES

103       Entities  are  listed  by their entity id (the type of entity they are)
104       and their entity instance.  Entities may be active or inactive  in  the
105       system, the standard IPMI algorithm for determining this is used.  Com‐
106       mands on entities are:
107
108
109       entities
110              List all the entities in the system.  The output is  the  entity
111              specifier,  followed  by an optional entity name in parenthesis,
112              followed by "present" or "not present".
113
114
115       check_presence
116              For the check of presence for all entities.
117
118
119       fru entity
120              List the FRU information associated with the entity.
121
122
123       dump_fru is_logical device_address device_id lun private_bus channel
124              Dump raw information from the specified FRU device.
125
126

SENSORS

128       Sensors define input devices that OpenIPMI can monitor.
129
130
131       sensors entity
132              List all the sensors that monitor the given entity.  The  output
133              is  the  sensor  specifier (the entity specifier followed by the
134              sensor name, with spaces converted to ~). followed by the sensor
135              name.
136
137
138       sensor sensor
139              Pull  up  the  given sensor and display all its information.  In
140              full-screen mode, the sensor will be re-queried every second.
141
142
143       rearm global [assertion-mask deassertion-mask]
144              Rearm the given sensor.  If global is 1, then the  whole  sensor
145              is  rearmed.   If  global  is  0,  then  the  assertion-mask and
146              deassertion-mask must be specified telling which  thresholds  or
147              states to rearm.
148
149
150       events_enable events scanning assertion-bitmask deassertion-bitmask
151              Enable  or  disable  events  for the given sensor.  events turns
152              events on or off from the sensor (0 or 1).  scanning turns scan‐
153              ning on or off for the sensor (0 or 1).  assertion-bitmask spec‐
154              ifies the bitmask of thresholds or states that should be enabled
155              or  disabled  when  a  threshold  or state is asserted.  It is a
156              bunch of 0's and 1's, where the first one is for threshold/state
157              0,  the  second for threshold/state 1, etc.  deassertion-bitmask
158              specifies the bitmask of thresholds or  states  that  should  be
159              enabled or disabled when a threshold or state is deasserted.
160
161

CONTROLS

163       Controls  are  output devices that can control things like LEDs, power,
164       reset lines and such.
165
166
167       controls entity
168              List all the controls that control the given entity.  The output
169              is  the  control specifier (the entity specifier followed by the
170              control name, with spaces converted to ~). followed by the  con‐
171              trol name.
172
173
174       control control
175              Pull up the given control and display it's current state.
176
177
178       set_control val1 [val2 ...]
179              Change the value of a control.  Note that for controls with mul‐
180              tiple values, every value must be specified.
181
182
183

EVENTS

185       Events are asynchronous messages from sensors that tell the user that a
186       sensor  has  done  something.   Events are generally stored in a system
187       event log (SEL); OpenIPMI will fetch the events from the  SELs  in  the
188       system.
189
190       Since  multiple SELs may exist, an event is specified by the MC it came
191       from in the format "(channel addr)" and a log  number.   The  same  log
192       number may exist in multiple MCs.
193
194       Events are displayed in the log window as they come in.  If they can be
195       correlated with a sensor, they will be display with as much information
196       as possible.
197
198
199       delevent channel mc-addr log-num
200              Delete  the  given  event.   Note  that many SELs do not support
201              individual deletes, so this may only delete the  local  copy  of
202              the  event,  not  the  one  in the SEL.  In this case, to delete
203              events in the SEL, you must delete all the events in the SEL and
204              wait about 10 seconds for OpenIPMI to do a full SEL clear.
205
206
207       clear_sel
208              Delete  all events in the SEL.  This process may take some time,
209              so if you do this and quit immediately it may not be complete.
210
211
212       list_sel
213              List all events in the local copy of the SELs.  This is only the
214              local  copy, if the copies in the actual have change, this won't
215              be reflected.
216
217
218       get_sel_time channel mc-num
219              Get the time in the SEL for the given MC.
220
221
222

MANAGMENT CONTROLLERS (MCs)

224       In OpenIPMI, you normally don't deal with management controllers.  They
225       are  considered internal to the system.  However, for debugging, infor‐
226       mation about them is provided.
227
228
229       mcs    List all the MCs in the system and whether they are active.  MCs
230              are displayed in the format "(channel address)".
231
232
233       mc channel mc-addr
234              Display  a  boatload  of information about the MC, mostly coming
235              from the get device id command.
236
237
238       mccmd channel mc-addr LUN NetFN Cmd [data ...]
239              Send an IPMI command to the given MC.  The MC must exist and  be
240              active to do this.
241
242
243       mc_reset channel mc-addr [warm | cold]
244              Send  a  warm or cold reset command to the given MC.  The action
245              the MC takes is system-specific.
246
247
248       scan channel mc-addr
249              Scan for an MC at the given  address.   If  the  MC  exists  but
250              OpenIPMI  didn't  know about it, it will be added.  If the MC no
251              longer exists, then it will be removed.
252
253
254       mc_events_enable channel mc-num enabled
255              Enable or disable event generation for the given MC.
256
257
258       mc_events_enabled channel mc-num
259              Prints out if the events are enabled for the given MC.
260
261
262

LAN Parameter Configuration

264       OpenIPMI has functions that make it easier to configure the LAN parame‐
265       ters  of  a  LAN  connection.  Note that the LAN parameters have a lock
266       that OpenIPMI attempts to use.  If you read the  LAN  parameters,  they
267       will be locked until you either write them or clear the lock.
268
269
270       readlanparm channel mc-num channel
271              Read  lanparm  information from an MC and display it in the dis‐
272              play window.
273
274
275       viewlanparm
276              Show current lanparm information in the display window.
277
278
279       writelanparm channel mc-num channel
280              Write the current LANPARM information to an MC.  Note that  this
281              must be the MC that the parameters were read from.
282
283
284       clearlanparmlock [channel mc-num channel]
285              Clear a LANPARM lock.  If the MC is given, then the LANPARM lock
286              is directly cleared.  If not given, then the  LANPARM  lock  for
287              the current parms is cleared.
288
289
290       setlanparm config [selector] value
291              Set  the  given config item to the value.  The optional selector
292              is used for items that take a selector, like "auth"  or  any  of
293              the items in "destination".
294
295

Platform Event Filter (PEF)

297       OpenIPMI  contains  function  to help manage the PEF settings on a BMC.
298       Note that the PEF parameters have a lock that OpenIPMI attempts to use.
299       If  you  read  the PEF parameters, they will be locked until you either
300       write them or clear the lock.
301
302
303       readpef channel mc-num
304              Read the PEF information from an MC.
305
306
307       clearpeflock [channel mc-num]
308              Clear a PEF lock.  If the MC is given, then the PEF lock on that
309              MC  is  directly  cleared.   If no MC is given, then the current
310              PEF's lock is cleared.
311
312
313       viewpef
314              Show current pef information in the display window.
315
316
317       writepef channel mc-num
318              Write the current PEF information to an MC.
319
320
321       setpef config [selector] value
322              Set the given config item to the value.  The  optional  selector
323              is  used  for  items  that take a selector, like anything in the
324              event filters, alert policies, or alert strings.
325
326
327       pet connection channel ip-addr mac_addr  eft-selector  policy-num  apt-
328       selector lan-dest-selector
329              Set  up the connection for the domain to send PET traps from the
330              given connection to the given  IP/MAC  address  over  the  given
331              channel.   This  does all the LAN and PEF configuration required
332              to configure a system to send event traps.
333
334
335

CONNECTIONS

337       OpenIPMI can maintain multiple connections to a single domain.  It will
338       generally only use one of these at a time (although the other will con‐
339       stantly be under test).  This is  the  "active"  connection.   You  can
340       query and set which connection is active.
341
342       The connection number is the connection from the command line.  You can
343       specify two connections on the command line (the  part  beginning  with
344       "lan",  "smi",  etc.).   The first connection you specify is connection
345       zero, the second is connection 1.
346
347
348       is_con_active connection
349              Print out if the given connection is active or not.
350
351
352       activate_con connection
353              Activate the given connection.
354
355
356

OTHER COMMANDS

358       msg channel IPMB-addr LUN NetFN Cmd [data ...]
359              Send an IPMI command to the given IPMB address.  This is  avail‐
360              able in case the given MC cannot be found or enabled.
361
362
363       sdrs channel mc-addr do-sensors
364              Dump  all  the  sdrs  from the given MC.  If do-sensors is true,
365              then dump the device SDR.  If it is false,  dump  the  main  SDR
366              repository on the MC.
367
368
369       scan channel IPMB-addr
370              Perform an IPMB bus scan for the given IPMB, to try to detect an
371              MC at the given address.  IPMB bus scanning can  be  slow,  this
372              can help speed things up if you already know the address.
373
374
375       quit   Leave the program.
376
377
378       reconnect
379              Attempt  to  disconnect  and  reconnect  to the IPMI controller.
380              This is primarily for testing.
381
382
383       display_win
384              Set the display window (left window) for scrolling, just in case
385              the "F1" key doesn't work.
386
387
388       log_win
389              Set  the  log  window (right window) for scrolling, just in case
390              the "F2" key doesn't work.
391
392
393       help   Dump some terse help output about all the commands.
394
395
396

ERROR OUTPUT

398       All error output goes to the log window.
399
400

SEE ALSO

402       ipmilan(8)
403
404

KNOWN PROBLEMS

406       Our name is legion.
407
408

AUTHOR

410       Corey Minyard <cminyard@mvista.com>
411
412
413
414OpenIPMI                           05/13/03                         ipmi_ui(1)
Impressum