1ipmi_lan(5) IPMI LAN Interface config file ipmi_lan(5)
2
6 ipmi/lan.conf - IPMI LAN Interface config file
7
10 /etc/ipmi/lan.conf
11
14 The ipmi_sim and ipmilan commands are configured using this configura‐
15 tion file.
16
19 The following fields are used in many commands:
20 boolean May be "true", "false", "on" or "off".
22 priv An IPMI privilege level. This may be "callback", "user", "opera‐
24 tor", or "admin".
25 auth An IPMI authorization type. This may be "none" for no authentica‐
27 tion, "straight" for straight, in-the-clear password authentication,
28 "md2" for use MD2 message digest authentication, or "md5" for using MD5
29 message digest authentication.
30
33 Blank lines and lines starting with `#' are ignored.
34 The following commands are allowed the configuration file:
37 name "name"
40 Set a name for the BMC. This will control other things, like
41 the default value of the ipmi_sim startup command file and the
42 place where persistent data is stored.
43 user usernum enabled username password max-priv max-session
46 usernum specifies the user number for the user. Note that user
47 number 0 is invalid, and user number 1 is the special "anony‐
48 mous" user, whose username is ignored. This value may be up to
49 63, the maximum possible IPMI user. If you want anonymous
50 access, you must have a user number 1.
51 enabled is a boolean that specified whether the user is enabled
53 or not.
54 username specifies the name of the user, specified as a name.
56 password specifies the password of the user, specified as a
58 name.
59 max-priv specifies the maximum privilege level allowed for the
61 user.
62 max.sessions specifies the maximum number of session the user
64 may open.
65 startcmd "cmd"
68 specifies a command to execute when a power on is requested.
69 This lets a virtual machine be started that can then connect
70 back to the simulator. The simulator does management of the
71 process here, and the power on state of the process depends on
72 if the process exists or not. If a poweroff is requested, if
73 the process is connected to a VM serial interface, a graceful
74 shutdown is first requested. If the process does not terminate
75 in a specified amount of time, a SIGTERM is sent to the process.
76 The SIGTERM is sent immediately if there is no connection. If
77 the process doesn't go way in another specified amount of time,
78 a SIGKILL is sent.
79 startnowtrue|false
82 If true, start the startcmd at the startup of the simulator.
83 Otherwise wait until a poweron is issued.
84 poweroff_wait seconds
87 specifies the amount of time to wait for the startcmd to do a
88 graceful shutdown on a powerdown request. The simulator will
89 send a request to the target, wait this amount of time, and then
90 do a SIGTERM kill on the process. If this is zero, a SIGTERM
91 will not be done (nor will a SIGKILL). Note that if the simula‐
92 tor does not have a connection to the VM, the graceful shutdown
93 is skipped and a SIGTERM is done immediately. Default time is
94 60 seconds.
95 kill_wait seconds
98 specifies the amount of time to wait for SIGTERM to kill the
99 process. If the process does not terminate in this period of
100 time, send a SIGKILL kill. If this is zero, don't send the
101 SIGKILL. Default time is 20 seconds.
102 console address port
105 specifies that a console port be opened at the given address and
106 port. You can telnet to the console and execute emulation com‐
107 mands. Note that this is a pretty huge security hole, it should
108 only be used for debugging in a captive environment.
109 serial channel addr port [option [option [...]]]
112 channel specifies the channel number or type. This may be kcs,
113 smic, or bt or it may be 15. Currently, only the system inter‐
114 face channel (channel 15) is supported for serial interfaces, if
115 the others are specified it is channel 15 and the given inter‐
116 face is reported in channel configuration commands.
117 addr specifies the IP address to listen on for connections.
119 port specifies the port to listen on for connections.
121 Valid options are:
123 codec name specifies which codec to use on the serial port.
125 Valid options are: TerminalMode, Direct, RadisysAscii, and VM.
126 The first three are implementations of IPMI serial interfaces on
127 certain systems and might be used for simulations of that sys‐
128 tem. The VM is probably the most interesting; it is designed to
129 be used with a virtual machine like qemu.
130 oem name specified implementation of some OEM custom commands
132 and options on the interface. Valid options oare PigeonPoint
133 and Radisys.
134 attn c1[,c2[...]] specifies a list of characters, separated by
136 commas, to use as the attention character on the interface.
137 Generally the default is correct. The characters are specified
138 as decimal, octal, or hex digits in C style.
139 ipmb addr specifies the IPMI address of the interface. The
141 default, 0x20, is usually correct, but when emulating ATCA sys‐
142 tems this might be required.
143 sol device default_baud [history=size[,backupfile=filename]] [histo‐
146 ryfru=frunum]
147 Allow a Serial Over LAN (SOL) connection to the given device.
149 This will be over interface 1 for the MC.
150 device is the full path to the device name. It can also be in
152 the form "tcp:address:port" or "telnet:address:port" to do con‐
153 nections over tcp (without or with telnet processing). This is
154 useful for providing SOL access to qemu ports.
155 default_baud sets the initial default baud rate to use. This is
157 overriden by the persistent SOL settings.
158 history creates a history device on SOL interface 2. The size
160 is the size of the buffer. Data from the device is stored in
161 the history buffer all the time. Connecting to SOL interface 2
162 will cause the full history buffer to be dumped. If backupfile
163 is specified, then the history is made persistent. However, it
164 is only stored when a catchable signal or normal shutdown is
165 done, so a poweroff or fatal signal will cause the data to be
166 lost.
167 historyfru makes the history available via the given FRU number
169 on the MC.
170 Note that if the connection fails to come up, the simulator will
172 continue to try to connect. This way you can fix UDP serial
173 ports or qemu sessions and it will automatically reconnect.
174 loadlib "module" ["options"]
177 Load the given shared object into the program.
179 module is the full path to the module. It must be in quotes.
181 options is an optional string in quotes that passes options to
183 the module. The contents of the string are not specified, the
184 module defines that.
185 The module may have a number of functions that are called:
187 ipmi_sim_module_print_version(sys_data_t *sys, char *options) is
189 called when ipmi_sim is started with the version print option.
190 This way the versions of all loaded modules may be printed. The
191 module should print it's version. You must provide this func‐
192 tion.
193 ipmi_sim_module_init(sys_data_t *sys, char *options) is called
195 after the configuration file is read and before any other ini‐
196 tialization is done. The module should do most of its initial‐
197 ization here. You must provide this function.
198 ipmi_sim_module_post_init(sys_data_t *sys) is called after
200 ipmi_sim has finished initializing. This function is optional.
201 sys parameter is used for most functions interfacing to the main
204 ipmi_sim code, like logging, timers, and a few of the MC calls. The
205 contents are opaque to the module.
206 startlan channel
210 Starts a LAN configuration area. This specifies the settings
211 for a LAN connection using the given channel. This may be spec‐
212 ified more than once in a file to support multiple LAN connec‐
213 tions. Commands following this, up to endlan, are LAN-specific
214 commands listed below. channel specifies the channel to set the
215 LAN configuration for.
216
219 The following commands are only valid inside a startlen area.
220 addr IP-address [UDP-port]
223 IP-address specifies the IP address to use for an IP port. Up to
224 4 addresses may be specified. If no address is specified, it
225 defaults to one port at 0.0.0.0 (for every address on the
226 machine) at port 623.
227 UDP-port specifies an optional port to listen on. It defaults to
229 623 (the standard port).
230 PEF_alerting boolean
233 Turn PEF alerting on or off (not currently supported).
234 per_msg_auth boolean
237 Turn per-message authentication on or off.
238 priv_limit priv
241 The maximum privilege allowed on this interface.
242 allowed_auths_callback [auth [auth [...]]]
245 auth specifies allowed authorization levels for the callback
246 privilege level. Only the levels specified on this line are
247 allowed for the authorization level. If this line is not
248 present, callback authorization cannot be used.
249 allowed_auths_user [auth [auth [...]]]
252 auth specifies allowed authorization levels for the user privi‐
253 lege level. Only the levels specified on this line are allowed
254 for the authorization level. If this line is not present, user
255 authorization cannot be used.
256 allowed_auths_operator [auth [auth [...]]]
259 auth specifies allowed authorization levels for the operator
260 privilege level. Only the levels specified on this line are
261 allowed for the authorization level. If this line is not
262 present, operator authorization cannot be used.
263 allowed_auths_admin [auth [auth [...]]]
266 auth specifies allowed authorization levels for the admin privi‐
267 lege level. Only the levels specified on this line are allowed
268 for the authorization level. If this line is not present, user
269 authorization cannot be used.
270 guid name
273 Allows the 16-byte GUID for the IPMI LAN connection to be speci‐
274 fied. If this is not specified, then the GUID command is not
275 supported.
276
279 /etc/ipmi_lan.conf
280
283 ipmilan(8),ipmi_sim(1)
284
287 IPMI is unnecessarily complicated.
288
291 Corey Minyard <cminyard@mvista.com>
292OpenIPMI 06/26/12 ipmi_lan(5)