1
.TH openipmigui 1 05/13/03 OpenIPMI "GUI interface to an IPMI system"
4
openipmigui \- GUI interface to an IPMI system
19
is a GUI interface using the OpenIPMI library. It provides a
20
tree-structured view of the IPMI domains it connected to.
24
starts up with no connections or anything of that nature. You must
25
open connection to domains yourself. However, you may save your
26
current configuration and the current domains and some GUI settings;
27
these will be automatically restored at startup.
29
The main window has a tree on the left and a log window on the right.
30
The log window captures informational and error logs from OpenIPMI.
31
Note that events are not reported in the log window, you must open an
32
SEL window for a domain to view the events.
37
Turn on message debugging, this will dump all messages to debug log output.
40
Turn on raw message debugging, this will dump all low-level messages to
41
debug log output. This differes from normal message debugging in that all
42
protocol messages are also dumped, not just IPMI messages.
45
Turn on memory debugging, this will cause memory allocation and
46
deallocations to be checked. When the program terminates, it will
47
dump all memory that was not properly freed (leaked), and overruns,
48
writing of freed memory, or other types of memory errors.
51
Send all logs to standard error output as well as the GUI console.
54
Turn on python tracing so that all python procedure calls entered and
55
exited will be printed out.
58
Turn off reading of the preferences file at startup.
61
Use preffile as the name of the preferences file instead of
62
$HOME/.openipmigui.startup
66
The main menu bar contains two pull-down menus: File and View.
68
The File menu contains Exit, Open Domain, and Save Prefs commands.
69
The Exit command does as described, and it does not prompt to be sure
70
you want to exit. The Open Domain command is how you establish a
71
connection to an IPMI system. The Save Prefs command will store the
72
current domains and the configuration of the main GUI window. These
73
settings will be restored at startup. The settings are stored in
74
$HOME/.openipmigui.startup; this file may be removed to clear all the
77
The View menu contains commands to expand and contract the entire
82
The tree window has a top-level list of all the domains for which
83
OpenIPMI has connections (or pending connection). Each domain
84
exapands into domain-specific information and a list of entities and
85
Management Controllers (MCs) for that domain.
87
Right click drives most of the operations in the tree window. Many
88
tree elements have pull-down menus driven by a right mouse button
89
click. When in doubt, click.
91
Color is used in the GUI to denote error status, and shading is used
92
to denote availability. If a sensor has an error, the tree entry for
93
that sensor will change colors. Black means no error, yellow means
94
warning, red means critical, and blue means non-recoverable. These
95
errors propigate up, so the entity containing that sensor will be the
96
same color as the most critical error for the sensors underneath it.
97
The same goes for domain, it will be the same color as the most
98
critical error for the entities underneath it. This way, if you watch
99
the domain, you can determine if a system is in trouble with just the
100
top-level view, and you can drill down to find the problem.
102
If a tree entry is shaded, it means that the entry has information
103
identifying it but does not exist. For instance, a domain with no
104
connection, an entity that is not present, or an MC that is not
107
Note that all information visible in the tree is polled. Only visible
108
information is polled, so if you expose something via expanding a tree
109
element or scrolling, it may be a few seconds before the data is
114
The domains contain various high-level information and an aggregation
115
of all the System Event Logs (SELs) contained within it. The SEL
116
Rescan Time and IPMB Rescan Time are settable via right-click; these
117
values are remembered when saved and restored. (Note that these
118
values in the MC-specific entries are not saved and restore, only the
119
domain level ones). Right clicking on the domain gives a set of
120
operations, including the ability to view the SEL.
124
The Entities element under the domain element contains a list of the
125
entities discovered for that domain. This is only the top-level
126
entities (ones not contained in other entities); entities contained in
127
other entities are listed under their parent entity. This keeps the
128
clutter down for very complicated systems, like ATCA.
130
If the entity is hot-swappable, hot-swap activation and deactivation
131
commands are available via right-click on the entity. If the entity
132
has FRU information, you can view that via a right-click command, too.
134
The information under an entity also contains a sensors and controls
139
Sensors are available under the entity they belong to. Sensor
140
information is beyond the scope of this document, as IPMI sensors are
141
very complex. See the IPMI document from OpenIPMI for information
144
As expected, right-clicking on a sensor gives operations available on
149
Controls are available under the entity they belong to. control
150
information is beyond the scope of this document, as IPMI controls are
151
very complex. See the IPMI document from OpenIPMI for information
154
As expected, right-clicking on a control gives operations available on
158
.SH MANAGEMENT CONTROLLERS (MCs)
160
An MC is the intelligent node in an IPMI system. It is not generally
161
required to know about MCs for normal IPMI sensor and control
162
operations. You do need access to MCs, though, for system
165
An MC contains a lot of information about itself and its capabilities;
166
this is generally automatically interpreted by OpenIPMI, but the
167
information is available for view. For instance, if an MC contains an
168
SEL device, OpenIPMI will automatically handle getting events from it,
169
but you can also view this setting under the MC information.
171
A number of operations are available under the right-click menu on the
172
MC; most of these are self-explanatory. The MC is generally
173
configured via the Channel Info command under this.
177
A set of connections for the domain is listed under the domain. Each
178
connection has one or more ports. The state of these ports may be
179
viewed by color; if a port is yellow (warning), it is down. If a
180
connection is red (severe), then all its ports are down. If all
181
connections are down, the "Connections" tree item turns blue
186
If you right click on an MC, it will show a Channel Info entry. This
187
is used to configure the LAN and channel information for the MC. If
188
you select this, it will pull up a list of channels in a tree view.
189
Note that unlike the main tree, this information is not dynamically
190
updated; it will not change if the underlying data changes.
192
To configure individual channels, expand them. The Info settings are
193
read only and cannot be changed. The User Access settings can be
194
changed by right-clicking on them. Note that the change is not
195
immediate, you must use the Save button at the bottom of the window to
196
save the changes you have made. Also, there are two versions of the
197
User Access settings. One is volatile, and will update the current
198
settings for the MC, but if the MC restart the non-volatile settings
199
will be restored. Setting the non-volatile settings will not cause an
200
immediate change, but those changes will be restored on the next MC
203
Some channels have user information; you can configure these by
204
selecting that command in the right-click menu of a channel.
206
LAN channels also have LAN configuration; you can configure these by
207
selecting that command in the right-click menu of a channel.
211
IPMI systems with remote access have users that can be used to log
212
in. These users are configured by the User Info command in the
213
channel listing. Note that some user setting (the name and password)
214
are global to all channels on the MC.
216
Due to the IPMI spec and some unfortunate implementation bugs, some
217
wierd issues exist with this information. The user has an Enabled
218
value that tells whether the user is enabled or not. When initially
219
displayed, this field shows as a "?" because this field is not
220
readable. It will displayed as the actual value when it is modified,
221
but will not be changed otherwise.
223
There is also a session limit field that gives the maximum number of
224
sessions a user is allowed to make. This field is also not readable
225
and displays as a "?" when first displayed. This field is marked as
226
optional in the IPMI spec, which means the field does not have to be
227
supplied. Some implementations, however, require this field to be
228
set. If you get a DataLenInv error back from your system when setting
229
something, you must set the field to something for any value to be
230
set. Generally, setting it to zero disables the field and is the
235
In the channel display on a 8023_LAN channel, a LANPARM configuration
236
command is available. This pulls up all the parameters for the LAN
237
and allows them to be set. Right-clicking on an item allows it to be
242
If an MC support PEF, it will have a "PEF Parms" menu item in the
243
pulldown menu for the MC. This pulls up all the parameters for the PEF
244
and allows them to be set. Right-clicking on an item allows it to be
249
In the channel display on a 8023_LAN channel, a LANPARM configuration
250
command is available if the MC supporte SOL (Serial Over LAN). This
251
pulls up all the parameters for the LAN and allows them to be set.
252
Right-clicking on an item allows it to be changed.
256
On a connection, an "Open SOL" menu item is present. If the BMC on
257
the far end of the connection has SOL (Serial Over LAN) support, then
258
you can establish a serial connection with the BMC, assuming it is
259
configured properly and you have the proper rights.
261
When you choose this, you will get a new connection with a VT100/ANSI
262
terminal emulator. The connection will not yet be opened, you must
263
open it (under the "File") to establish the connection. When the
264
status at the bottom right says "connected", you are ready to type.
265
If something goes wrong, the connection may drop and you will have to
266
reopen it. You can also close the connection from the file menu, or
269
The "Controls" menu for the SOL connection contains a large number of
270
settings for SOL. These allow you to manipulate various value on the
271
remote side of the connection. These are:
275
If disabled, this will cause data from the BMC to be refused,
276
effectively flow-controlling the data (assuming that the BMC actually
277
supports this properly, some don't)
281
Encrypt the data on the LAN using RMCP+ encryption negotiated for the
282
connection. Only available when the connection is closed, this cannot
283
be changed dynamically.
287
Authenticate the data on the LAN using RMCP+ authentication negotiated
288
for the connection. Only available when the connection is closed,
289
this cannot be changed dynamically.
292
Deassert CTS/DCD/DSR on connect
293
Don't raise the lines when a connection is made; this allows things
294
like baud rate to be set before the device on the far end of the
295
serial port knows there is a connection.
299
If set, the BMC has control over the CTS line. Otherwise, the CTS
304
Set the DCD and DSR lines.
308
Assert the Ring Indicator line, can be used for remote wakeup on some
309
systems (though, with IPMI, you have to wonder why you wouldn't use
314
Sets the timeout waiting for an ACK from the BMC.
318
Sets the number of times a packet is retried before the connection is
323
Send a 300ms break signal to the remote serial port.
327
Sets the bitrate on the serial port. Not all systems support this.
328
Some, in fact, completely ignore this setting and use 19.2K. Note
329
that this is only the volatile rate. The non-volatile rate setting is
333
Serial Alert Behavior
334
This sets what to do when an IPMI alert occurs and is going out the
335
serial port somehow. If set to "succeed", the SoL session will be
336
disconnected when an alert comes out.
340
Allows various queues to be flushed.
343
ipmish(1), IPMI document from OpenIPMI
346
Some of missing functionality. See the list in the
347
swig/python/openipmigui/TODO if you want to work on something.
351
Corey Minyard <cminyard@mvista.org>
added
removed
man/openipmigui.1
