ipmi_sim(1)

1ipmi_sim(1)                 IPMI LAN BMC Simulator                 ipmi_sim(1)
2
3
4

NAME

6       ipmi_sim - IPMI LAN BMC Simulator
7
8

SYNOPSIS

10       ipmi_sim [-c config-file] [-f command-file] [-x command] [-s state-dir]
11       [-d] [-n]
12
13

DESCRIPTION

15       The ipmi_sim daemon emulates an IPMI BMC simulator that may be accessed
16       using  the  IPMI  1.5 or 2.0 LAN protocol, or via various serial proto‐
17       cols.  It is useful stand-along for prototyping, it may be used with  a
18       virtual  machine  such  as QEMU to provide an IPMI BMC emulator, and it
19       may be used to implement an actual BMC (where it's not such a simulator
20       any more)
21
22       ipmi_sim  supports the full authentication capabilities of the IPMI LAN
23       protocol.
24
25       ipmi_sim supports multiple IP addresses for fault-tolerance.  Note that
26       messages  coming  in on an address are always sent back out on the same
27       address they came in.
28
29

OPTIONS

31       -c config-file
32              Set the configuration file to one  other  than  the  default  of
33              /etc/ipmi/lan.conf . See ipmi_lan(5) for details.
34
35       -f command-file
36              Specify  a  command  file  to execute when ipmi_sim is starting.
37              This is generally used to set  up  the  IPMI  environment.   See
38              ipmi_sim_cmd(5) for details.
39
40       -x  command
41              Execute a single command.
42
43       -s state-dir
44              Specify  a  state  directory  for ipmi_sim to use instead of the
45              default.  The state directory  must  exist,  and  ipmi_sim  will
46              store  information there for when it restarts.  For instance, if
47              someone changes user information, then it  will  store  the  new
48              user  information  there  and what is in the config file will no
49              longer be used.
50
51
52       -d     Turns on debugging to standard output (if -n is not spec‐
53              ified) and the debug output of syslog.
54
55       -n     Disables console and I/O on standard input and output.
56
57
58

CONFIGURATION

60       Configuration     is     accomplished     through    the    file
61       /etc/ipmi/lan.conf.  A file with another name  or  path  may  be
62       specified  using the -c option.  See the ipmi_lan(5) config file
63       man page for more details.
64
65

COMMANDS

67       When ipmi_sim starts up, it has an empty environment with no BMC
68       or  management controllers.  You have to execute commands to set
69       things up.  The commands can also be used to set sensor  states,
70       inject  events, and other things you might want to do when simu‐
71       lating a BMC.  See the ipmi_sim_cmd(5) man page for details.
72
73

SECURITY

75       ipmi_sim implements normal IPMI security.   The  default  is  no
76       access for anyone, so the default is pretty safe, but be careful
77       what you add, because  this  is  access  to  control  your  box.
78       straight and none authorizations are not recommended, you should
79       probably stick with md2 or md5 if you are not using RMCP+.
80
81

PERSISTENCE

83       Things that are supposed to be persistent in a BMC are  kept  in
84       files,  generall  in  /var/ipmi_sim/<name>,  where <name> is the
85       name of the BMC specified in the configuration file.   The  fol‐
86       lowing things are persistent:
87
88
89       SDRs   -  This  is  named  sdr.<mcnum>.main  and is the main SDR
90              repository.
91
92       SEL    - This is named sel.<mcnum>.
93
94       Users  - This is named users.mc<mcnum>.
95
96       LAN parameters
97              - This is named lanparm.mc<mcnum>.<channel>.
98
99       SOL parameters
100              - This is named sol.mc<mcnum>.
101
102
103       The <mcnum> is the hexadecimal number of the MC.
104
105

Serial Over LAN (SOL)

107       ipmi_sim implements Serial Over LAN for hooking an RMCP+ connec‐
108       tion  to a standard Unix serial port.  This is configured in the
109       ipmi_lan(5) configuration file.
110
111       A SOL interface is done on a per-MC basis.  So if the MC is  set
112       to  a  non-BMC, you can define a SOL interface on it and it will
113       work if you reroute the commands to  that  MC.   It's  a  little
114       weird,  but  it  works.   Only  interface  1 is supported at the
115       moment.
116
117       A SOL interface can also hold history that is kept even if noth‐
118       ing  is  connected to the SOL interface from the LAN.  So if you
119       want to see what has happened on the serial port, you  can  con‐
120       nect  to  interface 2 and it will dump the history.  The history
121       is optionally persistent, if the program terminates normally and
122       is  restarted, the history is restored if it is configured to do
123       so.
124
125       A SOL interface can create a FRU on the MC to let you fetch  the
126       history via the FRU interface.
127
128

SIGNALS

130       SIGHUP
131            ipmi_sim should handle SIGHUP and reread it's configuration
132            files.  However, it doesn't right now.   It  might  in  the
133            future,  for  now  you will have to kill it and restart it.
134            Clients should handle reconnecting in this case.   If  they
135            don't, they are broken.
136
137

ERROR OUTPUT

139       At  startup,  all  error output goes to stderr.  After that, all
140       error output goes to syslog.
141
142

FILES

144       /etc/ipmi_lan.conf
145
146

AUTHOR

152       Corey Minyard <cminyard@mvista.com>
153
154
155
156OpenIPMI                           06/26/12                        ipmi_sim(1)