1openipmigui(1)          GUI interface to an IPMI system         openipmigui(1)
2
3
4

NAME

6       openipmigui - GUI interface to an IPMI system
7
8

SYNOPSIS

10       openipmigui  [--dmsg]  [--drawmsg]  [--glib12]  [--trace] [--logstderr]
11       [-n] [-p preffile]
12
13

DESCRIPTION

15       openipmigui is a GUI interface using the OpenIPMI library.  It provides
16       a tree-structured view of the IPMI domains it connected to.
17
18       By  default  openipmigui  starts  up with no connections or anything of
19       that nature.  You must open connection to domains  yourself.   However,
20       you  may  save  your  current configuration and the current domains and
21       some GUI settings; these will be automatically restored at startup.
22
23       The main window has a tree on the left and a log window on  the  right.
24       The  log  window  captures  informational and error logs from OpenIPMI.
25       Note that events are not reported in the log window, you must  open  an
26       SEL window for a domain to view the events.
27
28

OPTIONS

30       --dmsg Turn  on message debugging, this will dump all messages to debug
31              log output.
32
33       --drawmsg
34              Turn on raw message debugging, this will dump all low-level mes‐
35              sages  to  debug  log output.  This differes from normal message
36              debugging in that all protocol messages  are  also  dumped,  not
37              just IPMI messages.
38
39       --dmem Turn  on memory debugging, this will cause memory allocation and
40              deallocations to be checked.  When the  program  terminates,  it
41              will  dump  all memory that was not properly freed (leaked), and
42              overruns, writing of freed memory,  or  other  types  of  memory
43              errors.
44
45       --logstderr
46              Send  all  logs to standard error output as well as the GUI con‐
47              sole.
48
49       --trace
50              Turn on python  tracing  so  that  all  python  procedure  calls
51              entered and exited will be printed out.
52
53       -n     Turn off reading of the preferences file at startup.
54
55       -p preffile
56              Use  preffile  as  the  name  of the preferences file instead of
57              $HOME/.openipmigui.startup.
58
59
61       The main menu bar contains two pull-down menus: File and View.
62
63       The File menu contains Exit, Open Domain, and Save Prefs commands.  The
64       Exit  command  does as described, and it does not prompt to be sure you
65       want to exit.  The Open Domain command is how you establish  a  connec‐
66       tion  to an IPMI system.  The Save Prefs command will store the current
67       domains and the configuration of the main GUI window.   These  settings
68       will be restored at startup.  The settings are stored in $HOME/.openip‐
69       migui.startup; this file may be removed to clear all the settings.
70
71       The View menu contains commands to expand and contract the entire tree.
72
73

TREE VIEW

75       The tree window has a top-level list  of  all  the  domains  for  which
76       OpenIPMI has connections (or pending connection).  Each domain exapands
77       into domain-specific information and a list of entities and  Management
78       Controllers (MCs) for that domain.
79
80       Right  click  drives  most  of the operations in the tree window.  Many
81       tree elements have pull-down menus  driven  by  a  right  mouse  button
82       click.  When in doubt, click.
83
84       Color is used in the GUI to denote error status, and shading is used to
85       denote availability.  If a sensor has an error, the tree entry for that
86       sensor will change colors.  Black means no error, yellow means warning,
87       red means critical,  and  blue  means  non-recoverable.   These  errors
88       propigate  up,  so  the  entity containing that sensor will be the same
89       color as the most critical error for the sensors  underneath  it.   The
90       same  goes  for  domain, it will be the same color as the most critical
91       error for the entities underneath it.   This  way,  if  you  watch  the
92       domain,  you can determine if a system is in trouble with just the top-
93       level view, and you can drill down to find the problem.
94
95       If a tree entry is shaded, it means  that  the  entry  has  information
96       identifying it but does not exist.  For instance, a domain with no con‐
97       nection, an entity that is not present, or an MC that is not present.
98
99       Note that all information visible in the tree is polled.  Only  visible
100       information  is polled, so if you expose something via expanding a tree
101       element or scrolling, it may be  a  few  seconds  before  the  data  is
102       updated.
103
104

DOMAINS

106       The  domains  contain various high-level information and an aggregation
107       of all the System Event Logs (SELs) contained within it.  The SEL  Res‐
108       can  Time and IPMB Rescan Time are settable via right-click; these val‐
109       ues are remembered when saved and restored.  (Note that these values in
110       the  MC-specific  entries  are  not  saved and restore, only the domain
111       level ones).  Right clicking on the domain gives a set  of  operations,
112       including the ability to view the SEL.
113
114

ENTITIES

116       The  Entities  element  under the domain element contains a list of the
117       entities discovered for that domain.  This is only the top-level  enti‐
118       ties  (ones  not  contained  in  other entities); entities contained in
119       other entities are listed under their parent entity.   This  keeps  the
120       clutter down for very complicated systems, like ATCA.
121
122       If  the  entity  is hot-swappable, hot-swap activation and deactivation
123       commands are available via right-click on the entity. If the entity has
124       FRU information, you can view that via a right-click command, too.
125
126       The  information  under  an entity also contains a sensors and controls
127       list for the entity.
128
129

SENSORS

131       Sensors are available under the entity they belong to.  Sensor informa‐
132       tion  is  beyond  the  scope of this document, as IPMI sensors are very
133       complex.  See the IPMI document from  OpenIPMI  for  information  about
134       sensors.
135
136       As  expected,  right-clicking on a sensor gives operations available on
137       that sensor.
138
139

CONTROLS

141       Controls are available under the entity they belong to.  control infor‐
142       mation  is beyond the scope of this document, as IPMI controls are very
143       complex.  See the IPMI document from  OpenIPMI  for  information  about
144       controls.
145
146       As  expected, right-clicking on a control gives operations available on
147       that control.
148
149
150

MANAGEMENT CONTROLLERS (MCs)

152       An MC is the intelligent node in an IPMI system.  It is  not  generally
153       required  to  know  about MCs for normal IPMI sensor and control opera‐
154       tions.  You do need access to MCs, though, for system configuration.
155
156       An MC contains a lot of information about itself and its  capabilities;
157       this is generally automatically interpreted by OpenIPMI, but the infor‐
158       mation is available for view.  For instance, if an MC contains  an  SEL
159       device,  OpenIPMI will automatically handle getting events from it, but
160       you can also view this setting under the MC information.
161
162       A number of operations are available under the right-click menu on  the
163       MC; most of these are self-explanatory.  The MC is generally configured
164       via the Channel Info command under this.
165
166

CONNECTIONS

168       A set of connections for the domain is listed under the  domain.   Each
169       connection  has  one  or  more  ports.  The state of these ports may be
170       viewed by color; if a port is yellow (warning), it is down.  If a  con‐
171       nection  is  red (severe), then all its ports are down.  If all connec‐
172       tions are down, the "Connections" tree item turns blue (critical).
173
174

CHANNEL INFO

176       If you right click on an MC, it will show a Channel Info  entry.   This
177       is  used  to  configure the LAN and channel information for the MC.  If
178       you select this, it will pull up a list of channels  in  a  tree  view.
179       Note  that  unlike  the  main tree, this information is not dynamically
180       updated; it will not change if the underlying data changes.
181
182       To configure individual channels, expand them.  The Info  settings  are
183       read  only  and  cannot  be  changed.   The User Access settings can be
184       changed by right-clicking on them.  Note that the change is not immedi‐
185       ate,  you  must use the Save button at the bottom of the window to save
186       the changes you have made.  Also, there are two versions  of  the  User
187       Access settings.  One is volatile, and will update the current settings
188       for the MC, but if the MC restart the  non-volatile  settings  will  be
189       restored.   Setting the non-volatile settings will not cause an immedi‐
190       ate change, but those changes will be restored on the next MC restart.
191
192       Some channels have user information; you can configure these by select‐
193       ing that command in the right-click menu of a channel.
194
195       LAN  channels  also  have LAN configuration; you can configure these by
196       selecting that command in the right-click menu of a channel.
197
198

USER INFO

200       IPMI systems with remote access have users that can be used to log  in.
201       These  users  are  configured  by  the User Info command in the channel
202       listing.  Note that some user  setting  (the  name  and  password)  are
203       global to all channels on the MC.
204
205       Due  to  the  IPMI  spec and some unfortunate implementation bugs, some
206       wierd issues exist with this information.   The  user  has  an  Enabled
207       value  that  tells  whether the user is enabled or not.  When initially
208       displayed, this field shows as a "?" because this field  is  not  read‐
209       able.  It  will  displayed as the actual value when it is modified, but
210       will not be changed otherwise.
211
212       There is also a session limit field that gives the  maximum  number  of
213       sessions  a  user  is allowed to make.  This field is also not readable
214       and displays as a "?" when first displayed.  This field  is  marked  as
215       optional  in  the  IPMI spec, which means the field does not have to be
216       supplied.  Some implementations, however, require this field to be set.
217       If  you get a DataLenInv error back from your system when setting some‐
218       thing, you must set the field to something for any  value  to  be  set.
219       Generally, setting it to zero disables the field and is the right thing
220       to do.
221
222

LANPARMS

224       In the channel display on a 8023_LAN channel, a  LANPARM  configuration
225       command is available.  This pulls up all the parameters for the LAN and
226       allows them to be set.  Right-clicking on  an  item  allows  it  to  be
227       changed.
228
229

PEFPARMS

231       If an MC support PEF, it will have a "PEF Parms" menu item in the pull‐
232       down menu for the MC.  This pulls up all the parameters for the PEF and
233       allows  them  to  be  set.   Right-clicking  on an item allows it to be
234       changed.
235
236

SOLPARMS

238       In the channel display on a 8023_LAN channel, a  LANPARM  configuration
239       command  is  available  if the MC supporte SOL (Serial Over LAN).  This
240       pulls up all the parameters for the LAN and  allows  them  to  be  set.
241       Right-clicking on an item allows it to be changed.
242
243

SOL

245       On a connection, an "Open SOL" menu item is present.  If the BMC on the
246       far end of the connection has SOL (Serial Over LAN) support,  then  you
247       can  establish a serial connection with the BMC, assuming it is config‐
248       ured properly and you have the proper rights.
249
250       When you choose this, you will get a new connection with  a  VT100/ANSI
251       terminal  emulator.   The  connection  will not yet be opened, you must
252       open it (under the "File") to establish the connection.  When the  sta‐
253       tus  at  the  bottom right says "connected", you are ready to type.  If
254       something goes wrong, the connection may drop  and  you  will  have  to
255       reopen  it.   You  can also close the connection from the file menu, or
256       quit the emulator.
257
258       The "Controls" menu for the SOL connection contains a large  number  of
259       settings  for  SOL.  These allow you to manipulate various value on the
260       remote side of the connection.  These are:
261
262
263       Accept Input
264              If disabled, this will cause data from the BMC  to  be  refused,
265              effectively  flow-controlling  the  data  (assuming that the BMC
266              actually supports this properly, some don't)
267
268
269       Use Encryption
270              Encrypt the data on the LAN using  RMCP+  encryption  negotiated
271              for  the  connection.   Only  available  when  the connection is
272              closed, this cannot be changed dynamically.
273
274
275       Use Authentication
276              Authenticate the data on  the  LAN  using  RMCP+  authentication
277              negotiated  for the connection.  Only available when the connec‐
278              tion is closed, this cannot be changed dynamically.
279
280
281       Deassert CTS/DCD/DSR on connect
282              Don't raise the lines when a connection  is  made;  this  allows
283              things like baud rate to be set before the device on the far end
284              of the serial port knows there is a connection.
285
286
287       CTS Assertable
288              If set, the BMC has control over the CTS line.   Otherwise,  the
289              CTS line is deasserted.
290
291
292       DCD/DSR Asserted
293              Set the DCD and DSR lines.
294
295
296       RI Asserted
297              Assert the Ring Indicator line, can be used for remote wakeup on
298              some systems (though, with IPMI, you  have  to  wonder  why  you
299              wouldn't use IPMI for this).
300
301
302       Set Ack Timeout
303              Sets the timeout waiting for an ACK from the BMC.
304
305
306       Set Ack Retries
307              Sets  the number of times a packet is retried before the connec‐
308              tion is closed.
309
310
311       Send Break
312              Send a 300ms break signal to the remote serial port.
313
314
315       Serial Rate
316              Sets the bitrate on the serial port.  Not  all  systems  support
317              this.   Some,  in  fact,  completely ignore this setting and use
318              19.2K.  Note that this is only  the  volatile  rate.   The  non-
319              volatile rate setting is done with SOLPARM.
320
321
322       Serial Alert Behavior
323              This  sets what to do when an IPMI alert occurs and is going out
324              the serial port somehow.  If set to "succeed", the  SoL  session
325              will be disconnected when an alert comes out.
326
327
328       Queue Flush
329              Allows various queues to be flushed.
330
331

SEE ALSO

333       ipmish(1), IPMI document from OpenIPMI
334
335

KNOWN PROBLEMS

337       Some of missing functionality.  See the list in the swig/python/openip‐
338       migui/TODO if you want to work on something.
339
340

AUTHOR

342       Corey Minyard <cminyard@mvista.org>
343
344
345
346OpenIPMI                           05/13/03                     openipmigui(1)
Impressum