# ipmi_ui(1) - man - phpMan [ipmi_ui(1)](https://www.chedong.com/phpMan.php/man/ipmiui/1/markdown) Crude interface to an IPMI system [ipmi_ui(1)](https://www.chedong.com/phpMan.php/man/ipmiui/1/markdown) ## NAME ipmi_ui - Crude interface to an IPMI system ## SYNOPSIS **ipmiui** [**-dmsg**] [**-dmem**] [**-c**] _connection-1_[_connection-2_] The connections are specified as either: **smi** _smi-num_ or **lan** _IP-addr_ _port_ [_IP-addr-2_ _port-2_] _auth_ _privilege_ _username_ _password_ ## DESCRIPTION The **ipmi**___**ui** program connects to an IPMI system, and allows access to IPMI entities and sen‐ sors and OpenIPMI controls. It's rather crude, and primarily for testing OpenIPMI, but it has some use beyond that so it is provided. Normally, **ipmi**___**ui** starts up in a full-screen format. The left window shows the output of commands, the right window shows the logs from OpenIPMI. Both windows are scrollable with page up and page down keys, press the "**F1**" key to choose the the left window to scroll, the "**F2**" key to choose the right window to scroll. Note that you must set your environment **TERM** variable properly for your terminal, or **ipmi**___**ui** will display garbage on the screen. Note that you can put two connection specifications on the command line, and ipmi_ui will make two connection. You can only do this if the connections are to the same IPMI domain through different management controllers. Also, each LAN connection may have two IP ad‐ dresses. These are two different addresses to the same management controller. So you may have a total of 4 IP addresses to an IPMI domain, two management controllers and two IP adresses to each management controller. ## OPTIONS ### -dmsg ### -dmem checked. When the program terminates, it will dump all memory that was not properly freed (leaked). ### -snmp this option to be available. ### -c to standard output, there is no windowing. _smi-num_ The SMI number to connect to, for systems with more than on system interface. Gener‐ ally, this is '**0**'. _IP-addr_ The IP address of the LAN interface. _port_ The UDP port of the LAN interface, general **623**. _IP-addr-2_ Some systems support multiple IP connections, this specified the second address and is optional. If specified, OpenIPMI will use both IP addresses and fail over to the working one if one of them fails. _port-2_ The port for the second IP connection, generally **623**. _auth_ The authorization to use for the connection, either "**none**", "**straight**", "**md5**", or "**md2**". _privilege_ The privilege to use for the connection, either "**callback**", "**user**", "**operator**", or "**admin**". Note that some IPMI operations will fail without the correct privilege. _username_ The user name to use for the connection. If using this anonymous user, this should be the empty string "". _password_ The password to use for the connection. ## ENTITIES Entities are listed by their entity id (the type of entity they are) and their entity in‐ stance. Entities may be active or inactive in the system, the standard IPMI algorithm for determining this is used. Commands on entities are: ### entities List all the entities in the system. The output is the entity specifier, followed by an optional entity name in parenthesis, followed by "present" or "not present". **check**___**presence** For the check of presence for all entities. **fru** _entity_ List the FRU information associated with the entity. **dump**___**fru** _is_logical_ _device_address_ _device_id_ _lun_ _private_bus_ _channel_ Dump raw information from the specified FRU device. ## SENSORS Sensors define input devices that OpenIPMI can monitor. **sensors** _entity_ List all the sensors that monitor the given entity. The output is the sensor speci‐ fier (the entity specifier followed by the sensor name, with spaces converted to ~). followed by the sensor name. **sensor** _sensor_ Pull up the given sensor and display all its information. In full-screen mode, the sensor will be re-queried every second. **rearm** _global_ [_assertion-mask_ _deassertion-mask_] Rearm the given sensor. If _global_ is **1**, then the whole sensor is rearmed. If _global_ is **0**, then the _assertion-mask_ and _deassertion-mask_ must be specified telling which thresholds or states to rearm. **events**___**enable** _events_ _scanning_ _assertion-bitmask_ _deassertion-bitmask_ Enable or disable events for the given sensor. _events_ turns events on or off from the sensor (**0** or **1**). _scanning_ turns scanning on or off for the sensor (**0** or **1**). _asser__‐ _tion-bitmask_ specifies the bitmask of thresholds or states that should be enabled or disabled when a thrshold or state is asserted. It is a bunch of 0's and 1's, where the first one is for threshold/state 0, the second for threshold/state 1, etc. _de__‐ _assertion-bitmask_ specifies the bitmask of thresholds or states that should be enabled or disabled when a thrshold or state is deasserted. ## CONTROLS Controls are output devices that can control things like LEDs, power, reset lines and such. **controls** _entity_ List all the controls that control the given entity. The output is the control speci‐ fier (the entity specifier followed by the control name, with spaces converted to ~). followed by the control name. **control** _control_ Pull up the given control and display it's current state. **set**___**control** _val1_ [_val2_ ...] Change the value of a control. Note that for controls with multiple values, **every** value must be specified. ## EVENTS Events are asynchronous messages from sensors that tell the user that a sensor has done some‐ thing. Events are generally stored in a system event log (SEL); OpenIPMI will fetch the events from the SELs in the system. Since multiple SELs may exist, an event is specified by the MC it came from in the format "(channel addr)" and a log number. The same log number may exist in multiple MCs. Events are displayed in the log window as they come in. If they can be correlated with a sensor, they will be display with as much information as possible. **delevent** _channel_ _mc-addr_ _log-num_ Delete the given event. Note that many SELs do not support individual deletes, so this may only delete the local copy of the event, not the one in the SEL. In this case, to delete events in the SEL, you must delete **all** the events in the SEL and wait about 10 seconds for OpenIPMI to do a full SEL clear. **clear**___**sel** Delete all events in the SEL. This process may take some time, so if you do this and quit immediately it may not be complete. **list**___**sel** List all events in the local copy of the SELs. This is only the local copy, if the copies in the actual have change, this won't be reflected. **get**___**sel**___**time** _channel_ _mc-num_ Get the time in the SEL for the given MC. ### MANAGMENT CONTROLLERS (MCs) In OpenIPMI, you normally don't deal with management controllers. They are considered inter‐ nal to the system. However, for debugging, information about them is provided. **mcs** List all the MCs in the system and whether they are active. MCs are displayed in the format "(channel address)". **mc** _channel_ _mc-addr_ Display a boatload of information about the MC, mostly coming from the get device id command. **mccmd** _channel_ _mc-addr_ _LUN_ _NetFN_ _Cmd_ [_data_ ...] Send an IPMI command to the given MC. The MC must exist and be active to do this. **mc**___**reset** _channel_ _mc-addr_ [**warm** | **cold**] Send a warm or cold reset command to the given MC. The action the MC takes is system- specific. **scan** _channel_ _mc-addr_ Scan for an MC at the given address. If the MC exists but OpenIPMI didn't know about it, it will be added. If the MC no longer exists, then it will be removed. **mc**___**events**___**enable** _channel_ _mc-num_ _enabled_ Enable or disable event generation for the given MC. **mc**___**events**___**enabled** _channel_ _mc-num_ Prints out if the events are enabled for the given MC. ### LAN Parameter Configuration OpenIPMI has functions that make it easier to configure the LAN parameters of a LAN connec‐ tion. Note that the LAN parameters have a lock that OpenIPMI attempts to use. If you read the LAN parameters, they will be locked until you either write them or clear the lock. **readlanparm** _channel_ _mc-num_ _channel_ Read lanparm information from an MC and display it in the display window. ### viewlanparm Show current lanparm information in the display window. **writelanparm** _channel_ _mc-num_ _channel_ Write the current LANPARM information to an MC. Note that this must be the MC that the parameters were read from. **clearlanparmlock** [_channel_ _mc-num_ _channel_] Clear a LANPARM lock. If the MC is given, then the LANPARM lock is directly cleared. If not given, then the LANPARM lock for the current parms is cleared. **setlanparm** _config_ [_selector_] _value_ Set the given config item to the value. The optional selector is used for items that take a selector, like "auth" or any of the items in "destination". ### Platform Event Filter (PEF) OpenIPMI contains function to help manage the PEF settings on a BMC. Note that the PEF pa‐ rameters have a lock that OpenIPMI attempts to use. If you read the PEF parameters, they will be locked until you either write them or clear the lock. **readpef** _channel_ _mc-num_ Read the PEF information from an MC. **clearpeflock** [_channel_ _mc-num_] Clear a PEF lock. If the MC is given, then the PEF lock on that MC is directly cleared. If no MC is given, then the current PEF's lock is cleared. ### viewpef Show current pef information in the display window. **writepef** _channel_ _mc-num_ Write the current PEF information to an MC. **setpef** _config_ [_selector_] _value_ Set the given config item to the value. The optional selector is used for items that take a selector, like anything in the event filters, alert policies, or alert strings. **pet** _connection_ _channel_ _ip-addr_ _mac_addr_ _eft-selector_ _policy-num_ _apt-selector_ _lan-dest-selec__‐ _tor_ Set up the connection for the domain to send PET traps from the given connection to the given IP/MAC address over the given channel. This does all the LAN and PEF con‐ figuration required to configure a system to send event traps. ## CONNECTIONS OpenIPMI can maintain multiple connections to a single domain. It will generally only use one of these at a time (although the other will constantly be under test). This is the "ac‐ tive" connection. You can query and set which connection is active. The connection number is the connection from the command line. You can specify two connec‐ tions on the command line (the part beginning with "**lan**_",_ _"_**smi**_",_ _etc.)._ _The_ _first_ _connection_ _you_ _specify_ _is_ _connection_ _zero,_ _the_ _second_ _is_ _connection_ _1._ **is**___**con**___**active** _connection_ Print out if the given connection is active or not. **activate**___**con** _connection_ Activate the given connection. ## OTHER COMMANDS **msg** _channel_ _IPMB-addr_ _LUN_ _NetFN_ _Cmd_ [_data_ ...] Send an IPMI command to the given IPMB address. This is available in case the given MC cannot be found or enabled. **sdrs** _channel_ _mc-addr_ _do-sensors_ Dump all the sdrs from the given MC. If _do-sensors_ is **true**, then dump the device SDR. If it is **false**, dump the main SDR repository on the MC. **scan** _channel_ _IPMB-addr_ Perform an IPMB bus scan for the given IPMB, to try to detect an MC at the given ad‐ dress. IPMB bus scanning can be slow, this can help speed things up if you already know the address. **quit** Leave the program. ### reconnect Attempt to disconnect and reconnect to the IPMI controller. This is primarily for testing. **display**___**win** Set the display window (left window) for scrolling, just in case the "**F1**" key doesn't work. **log**___**win** Set the log window (right window) for scrolling, just in case the "**F2**" key doesn't work. **help** Dump some terse help output about all the commands. ## ERROR OUTPUT All error output goes to the log window. ## SEE ALSO [**ipmilan**(8)](https://www.chedong.com/phpMan.php/man/ipmilan/8/markdown) ## KNOWN PROBLEMS Our name is legion. ## AUTHOR Corey Minyard <> OpenIPMI 05/13/03 [ipmi_ui(1)](https://www.chedong.com/phpMan.php/man/ipmiui/1/markdown)