{
    "mode": "man",
    "parameter": "ipmi_ui",
    "section": "1",
    "url": "https://www.chedong.com/phpMan.php/man/ipmi_ui/1/json",
    "generated": "2026-05-30T05:11:43Z",
    "synopsis": "ipmiui [-dmsg] [-dmem] [-c] connection-1[connection-2]\nThe connections are specified as either:\nsmi smi-num\nor\nlan IP-addr port [IP-addr-2 port-2] auth privilege username password",
    "sections": {
        "NAME": {
            "content": "ipmiui - Crude interface to an IPMI system\n\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "ipmiui [-dmsg] [-dmem] [-c] connection-1[connection-2]\n\nThe connections are specified as either:\n\nsmi smi-num\n\nor\n\nlan IP-addr port [IP-addr-2 port-2] auth privilege username password\n\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "The  ipmiui  program connects to an IPMI system, and allows access to IPMI entities and sen‐\nsors and OpenIPMI controls.  It's rather crude, and primarily for testing  OpenIPMI,  but  it\nhas some use beyond that so it is provided.\n\nNormally,  ipmiui  starts  up  in a full-screen format.  The left window shows the output of\ncommands, the right window shows the logs from OpenIPMI.  Both windows  are  scrollable  with\npage  up  and page down keys, press the \"F1\" key to choose the the left window to scroll, the\n\"F2\" key to choose the right window to scroll.\n\nNote that you must set your environment TERM variable properly for your terminal, or  ipmiui\nwill display garbage on the screen.\n\nNote  that  you  can  put two connection specifications on the command line, and ipmiui will\nmake two connection.  You can only do this if the connections are to  the  same  IPMI  domain\nthrough  different  management  controllers.   Also,  each LAN connection may have two IP ad‐\ndresses.  These are two different addresses to the same management controller.   So  you  may\nhave  a  total  of  4  IP  addresses to an IPMI domain, two management controllers and two IP\nadresses to each management controller.\n\n",
            "subsections": []
        },
        "OPTIONS": {
            "content": "",
            "subsections": [
                {
                    "name": "-dmsg",
                    "content": ""
                },
                {
                    "name": "-dmem",
                    "content": "checked.   When  the program terminates, it will dump all memory that was not properly\nfreed (leaked).\n"
                },
                {
                    "name": "-snmp",
                    "content": "this option to be available.\n"
                },
                {
                    "name": "-c",
                    "content": "to standard output, there is no windowing.\n\n\nsmi-num\nThe SMI number to connect to, for systems with more than on system interface.   Gener‐\nally, this is '0'.\n\n\nIP-addr\nThe IP address of the LAN interface.\n\n\nport   The UDP port of the LAN interface, general 623.\n\n\nIP-addr-2\nSome systems support multiple IP connections, this specified the second address and is\noptional.  If specified, OpenIPMI will use both IP addresses  and  fail  over  to  the\nworking one if one of them fails.\n\n\nport-2 The port for the second IP connection, generally 623.\n\n\nauth   The  authorization  to  use  for  the connection, either \"none\", \"straight\", \"md5\", or\n\"md2\".\n\n\nprivilege\nThe privilege to use for the connection, either  \"callback\",  \"user\",  \"operator\",  or\n\"admin\".  Note that some IPMI operations will fail without the correct privilege.\n\n\nusername\nThe user name to use for the connection.  If using this anonymous user, this should be\nthe empty string \"\".\n\n\npassword\nThe password to use for the connection.\n\n",
                    "flag": "-c"
                }
            ]
        },
        "ENTITIES": {
            "content": "Entities are listed by their entity id (the type of entity they are)  and  their  entity  in‐\nstance.   Entities  may  be active or inactive in the system, the standard IPMI algorithm for\ndetermining this is used.  Commands on entities are:\n\n",
            "subsections": [
                {
                    "name": "entities",
                    "content": "List all the entities in the system.  The output is the entity specifier, followed  by\nan optional entity name in parenthesis, followed by \"present\" or \"not present\".\n\n\ncheckpresence\nFor the check of presence for all entities.\n\n\nfru entity\nList the FRU information associated with the entity.\n\n\ndumpfru islogical deviceaddress deviceid lun privatebus channel\nDump raw information from the specified FRU device.\n\n"
                }
            ]
        },
        "SENSORS": {
            "content": "Sensors define input devices that OpenIPMI can monitor.\n\n\nsensors entity\nList  all  the sensors that monitor the given entity.  The output is the sensor speci‐\nfier (the entity specifier followed by the sensor name, with spaces converted  to  ~).\nfollowed by the sensor name.\n\n\nsensor sensor\nPull  up  the  given sensor and display all its information.  In full-screen mode, the\nsensor will be re-queried every second.\n\n\nrearm global [assertion-mask deassertion-mask]\nRearm the given sensor.  If global is 1, then the whole sensor is rearmed.  If  global\nis  0,  then  the  assertion-mask and deassertion-mask must be specified telling which\nthresholds or states to rearm.\n\n\neventsenable events scanning assertion-bitmask deassertion-bitmask\nEnable or disable events for the given sensor.  events turns events on or off from the\nsensor  (0  or 1).  scanning turns scanning on or off for the sensor (0 or 1).  asser‐\ntion-bitmask specifies the bitmask of thresholds or states that should be  enabled  or\ndisabled  when  a  thrshold or state is asserted.  It is a bunch of 0's and 1's, where\nthe first one is for threshold/state 0, the second for threshold/state  1,  etc.   de‐\nassertion-bitmask specifies the bitmask of thresholds or states that should be enabled\nor disabled when a thrshold or state is deasserted.\n\n",
            "subsections": []
        },
        "CONTROLS": {
            "content": "Controls are output devices that can control things like LEDs, power, reset lines and such.\n\n\ncontrols entity\nList all the controls that control the given entity.  The output is the control speci‐\nfier  (the entity specifier followed by the control name, with spaces converted to ~).\nfollowed by the control name.\n\n\ncontrol control\nPull up the given control and display it's current state.\n\n\nsetcontrol val1 [val2 ...]\nChange the value of a control.  Note that for controls  with  multiple  values,  every\nvalue must be specified.\n\n\n",
            "subsections": []
        },
        "EVENTS": {
            "content": "Events are asynchronous messages from sensors that tell the user that a sensor has done some‐\nthing.  Events are generally stored in a system event log  (SEL);  OpenIPMI  will  fetch  the\nevents from the SELs in the system.\n\nSince  multiple  SELs  may  exist, an event is specified by the MC it came from in the format\n\"(channel addr)\" and a log number.  The same log number may exist in multiple MCs.\n\nEvents are displayed in the log window as they come in.  If they can  be  correlated  with  a\nsensor, they will be display with as much information as possible.\n\n\ndelevent channel mc-addr log-num\nDelete  the  given  event.   Note that many SELs do not support individual deletes, so\nthis may only delete the local copy of the event, not the one in  the  SEL.   In  this\ncase,  to delete events in the SEL, you must delete all the events in the SEL and wait\nabout 10 seconds for OpenIPMI to do a full SEL clear.\n\n\nclearsel\nDelete all events in the SEL.  This process may take some time, so if you do this  and\nquit immediately it may not be complete.\n\n\nlistsel\nList  all  events  in the local copy of the SELs.  This is only the local copy, if the\ncopies in the actual have change, this won't be reflected.\n\n\ngetseltime channel mc-num\nGet the time in the SEL for the given MC.\n\n\n",
            "subsections": [
                {
                    "name": "MANAGMENT CONTROLLERS (MCs)",
                    "content": "In OpenIPMI, you normally don't deal with management controllers.  They are considered inter‐\nnal to the system.  However, for debugging, information about them is provided.\n\n\nmcs    List  all the MCs in the system and whether they are active.  MCs are displayed in the\nformat \"(channel address)\".\n\n\nmc channel mc-addr\nDisplay a boatload of information about the MC, mostly coming from the get  device  id\ncommand.\n\n\nmccmd channel mc-addr LUN NetFN Cmd [data ...]\nSend an IPMI command to the given MC.  The MC must exist and be active to do this.\n\n\nmcreset channel mc-addr [warm | cold]\nSend a warm or cold reset command to the given MC.  The action the MC takes is system-\nspecific.\n\n\nscan channel mc-addr\nScan for an MC at the given address.  If the MC exists but OpenIPMI didn't know  about\nit, it will be added.  If the MC no longer exists, then it will be removed.\n\n\nmceventsenable channel mc-num enabled\nEnable or disable event generation for the given MC.\n\n\nmceventsenabled channel mc-num\nPrints out if the events are enabled for the given MC.\n\n\n"
                },
                {
                    "name": "LAN Parameter Configuration",
                    "content": "OpenIPMI  has  functions that make it easier to configure the LAN parameters of a LAN connec‐\ntion.  Note that the LAN parameters have a lock that OpenIPMI attempts to use.  If  you  read\nthe LAN parameters, they will be locked until you either write them or clear the lock.\n\n\nreadlanparm channel mc-num channel\nRead lanparm information from an MC and display it in the display window.\n\n"
                },
                {
                    "name": "viewlanparm",
                    "content": "Show current lanparm information in the display window.\n\n\nwritelanparm channel mc-num channel\nWrite  the  current  LANPARM information to an MC.  Note that this must be the MC that\nthe parameters were read from.\n\n\nclearlanparmlock [channel mc-num channel]\nClear a LANPARM lock.  If the MC is given, then the LANPARM lock is directly  cleared.\nIf not given, then the LANPARM lock for the current parms is cleared.\n\n\nsetlanparm config [selector] value\nSet  the given config item to the value.  The optional selector is used for items that\ntake a selector, like \"auth\" or any of the items in \"destination\".\n\n"
                },
                {
                    "name": "Platform Event Filter (PEF)",
                    "content": "OpenIPMI contains function to help manage the PEF settings on a BMC.  Note that the  PEF  pa‐\nrameters  have  a  lock  that OpenIPMI attempts to use.  If you read the PEF parameters, they\nwill be locked until you either write them or clear the lock.\n\n\nreadpef channel mc-num\nRead the PEF information from an MC.\n\n\nclearpeflock [channel mc-num]\nClear a PEF lock.  If the MC is given, then the  PEF  lock  on  that  MC  is  directly\ncleared.  If no MC is given, then the current PEF's lock is cleared.\n\n"
                },
                {
                    "name": "viewpef",
                    "content": "Show current pef information in the display window.\n\n\nwritepef channel mc-num\nWrite the current PEF information to an MC.\n\n\nsetpef config [selector] value\nSet  the given config item to the value.  The optional selector is used for items that\ntake a selector, like anything in the event filters, alert policies, or alert strings.\n\n\npet connection channel ip-addr macaddr eft-selector policy-num apt-selector  lan-dest-selec‐\ntor\nSet  up  the  connection for the domain to send PET traps from the given connection to\nthe given IP/MAC address over the given channel.  This does all the LAN and  PEF  con‐\nfiguration required to configure a system to send event traps.\n\n\n"
                }
            ]
        },
        "CONNECTIONS": {
            "content": "OpenIPMI  can  maintain  multiple connections to a single domain.  It will generally only use\none of these at a time (although the other will constantly be under test).  This is the  \"ac‐\ntive\" connection.  You can query and set which connection is active.\n\nThe  connection  number is the connection from the command line.  You can specify two connec‐\ntions on the command line (the part beginning with \"lan\", \"smi\", etc.).  The first connection\nyou specify is connection zero, the second is connection 1.\n\n\nisconactive connection\nPrint out if the given connection is active or not.\n\n\nactivatecon connection\nActivate the given connection.\n\n\n",
            "subsections": []
        },
        "OTHER COMMANDS": {
            "content": "msg channel IPMB-addr LUN NetFN Cmd [data ...]\nSend  an  IPMI command to the given IPMB address.  This is available in case the given\nMC cannot be found or enabled.\n\n\nsdrs channel mc-addr do-sensors\nDump all the sdrs from the given MC.  If do-sensors is true, then dump the device SDR.\nIf it is false, dump the main SDR repository on the MC.\n\n\nscan channel IPMB-addr\nPerform  an  IPMB bus scan for the given IPMB, to try to detect an MC at the given ad‐\ndress.  IPMB bus scanning can be slow, this can help speed things up  if  you  already\nknow the address.\n\n\nquit   Leave the program.\n\n",
            "subsections": [
                {
                    "name": "reconnect",
                    "content": "Attempt  to  disconnect  and  reconnect to the IPMI controller.  This is primarily for\ntesting.\n\n\ndisplaywin\nSet the display window (left window) for scrolling, just in case the \"F1\" key  doesn't\nwork.\n\n\nlogwin\nSet  the  log  window  (right window) for scrolling, just in case the \"F2\" key doesn't\nwork.\n\n\nhelp   Dump some terse help output about all the commands.\n\n\n"
                }
            ]
        },
        "ERROR OUTPUT": {
            "content": "All error output goes to the log window.\n\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "ipmilan(8)\n\n",
            "subsections": []
        },
        "KNOWN PROBLEMS": {
            "content": "Our name is legion.\n\n",
            "subsections": []
        },
        "AUTHOR": {
            "content": "Corey Minyard <cminyard@mvista.com>\n\n\n\nOpenIPMI                                      05/13/03                                    ipmiui(1)",
            "subsections": []
        }
    },
    "summary": "ipmiui - Crude interface to an IPMI system",
    "flags": [
        {
            "flag": "",
            "long": null,
            "arg": null,
            "description": ""
        },
        {
            "flag": "",
            "long": null,
            "arg": null,
            "description": "checked. When the program terminates, it will dump all memory that was not properly freed (leaked)."
        },
        {
            "flag": "",
            "long": null,
            "arg": null,
            "description": "this option to be available."
        },
        {
            "flag": "-c",
            "long": null,
            "arg": null,
            "description": "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."
        }
    ],
    "examples": [],
    "see_also": [
        {
            "name": "ipmilan",
            "section": "8",
            "url": "https://www.chedong.com/phpMan.php/man/ipmilan/8/json"
        }
    ]
}