1FREEIPMI(5)                      Configuration                     FREEIPMI(5)
2
3
4

NAME

6       freeipmi.conf - specify default values to FreeIPMI
7

DESCRIPTION

9       The  FreeIPMI  configuration  file can be used to set alternate default
10       values to many FreeIPMI tools so values don't have to be configured  on
11       the  command line.  This allows users to avoid typing in a long list of
12       command line options every time a command is executed. It can  also  be
13       used to hide usernames, passwords, and other sensitive information from
14       the ps(1) command.
15
16       Currently, the tools that can be configured with the configuration file
17       are:   bmc-device(8),  bmc-info(8),  bmc-watchdog(8),  ipmi-chassis(8),
18       ipmi-config(8),  ipmi-fru(8),  ipmi-oem(8),  ipmi-pet(8),  ipmi-raw(8),
19       ipmi-sel(8), ipmi-sensors(8), ipmiconsole(8), and ipmipower(8).
20
21       By     default,     the     configuration    file    is    stored    at
22       /etc/freeipmi//freeipmi.conf.  But users may select a different config‐
23       uration file at the command line with the --config-file option.
24
25       Values  specified on the command line override the configuration values
26       specified in the configuration file.
27

FORMAT

29       The configuration options that can be specified  in  the  configuration
30       file  are  listed  below. Each configuration option must be listed on a
31       separate line. Arguments for an option are separated by any  amount  of
32       whitespace.  Multiple arguments are also separated by whitespace.  Com‐
33       ments can be marked by using the pound sign ("#") character, and  lines
34       can be continued on the next using backslash ("\").
35
36       Note  that  it is possible to list the username, password and other po‐
37       tentially sensitive information in the configuration file. If this data
38       is  stored  in a configuration file, system administrators should limit
39       access to this file.
40

GENERAL OPTIONS

42       The following options are options generally available to all tools, al‐
43       though  specific options may be ignored by some. (For example, ipmicon‐
44       sole(8) and ipmipower(8) do not perform in-band  communication,  there‐
45       fore  they  would  ignore in-band communication options. Similarly bmc-
46       watchdog(8) does not perform out-of-band  communication,  therefore  it
47       would ignore all out-of-band options).
48
49       driver-type IPMIDRIVER
50              Specify the default driver type to use.
51
52       disable-auto-probe ENABLE|DISABLE
53              Specify if IPMI devices should be probed for default settings.
54
55       driver-address DRIVER-ADDRESS
56              Specify the default in-band driver address to use.
57
58       driver-device DEVICE
59              Specify the default in-band driver device path to use.
60
61       register-spacing REGISTER-SPACING
62              Specify the default in-band driver register spacing to use.
63
64       target-channel-number CHANNEL-NUMBER
65              Specify the default in-band driver target channel number.
66
67       target-slave-address SLAVE-ADDRESS
68              Specify the default in-band driver target slave address.
69
70       username USERNAME
71              Specify the default username to use.
72
73       password PASSWORD
74              Specify the default password to use.
75
76       k_g str
77              Specify  the  default  BMC key (K_g) to use. Prefix with '0x' to
78              enter the key in hex.
79
80       session-timeout MILLISECONDS
81              Specify the default session timeout length to use  in  millisec‐
82              onds.
83
84       retransmission-timeout MILLISECONDS
85              Specify the default retransmission timeout length to use in mil‐
86              liseconds.
87
88       authentication-type AUTHENTICATION-TYPE
89              Specify the default authentication type to  use.  The  following
90              authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY,
91              MD2, and MD5.
92
93       cipher-suite-id CIPHER-SUITE-ID
94              Specify the default cipher suite id to use. The following cipher
95              suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.
96
97       privilege-level PRIVILEGE-LEVEL
98              Specify  the default privilege type to use. The following privi‐
99              lege levels are supported: USER, OPERATOR, ADMIN.
100
101       workaround-flags WORKAROUNDS
102              Specify default workaround flags to  use.  Multiple  workarounds
103              can  be  specified separated by whitespace. Please see tool man‐
104              pages for details about available workarounds for each tool. The
105              following workarounds are supported: assumeio, spinpoll, idzero,
106              forcepermsg, unexpectedauth, endianseq,  noauthcodecheck,  auth‐
107              cap,   nochecksumcheck,  intel20,  supermicro20,  sun20,  opens‐
108              esspriv, integritycheckvalue,  assumemaxsdrrecordcount,  solpay‐
109              loadsize, solport, solstatus, solchannelsupport, serialalertsde‐
110              ferred,  solpacketseq,   skipchecks,   assumesystemevent,   dis‐
111              cretereading,  ignorescanningdisabled, assumebmcowner, ignoreau‐
112              thcode, slowcommit, veryslowcommit,  solchannelassumelanchannel,
113              ignorestateflag, malformedack, guidformat, ipmiping.
114

SDR OPTIONS

116       The  following  options  are specific to tools that use the sensor data
117       repository (SDR). They will be ignored by all other tools.
118
119       quiet-cache ENABLE|DISABLE
120              Specify if cache creation/deletion  information  should  not  be
121              output by default.
122
123       sdr-cache-directory DIRECTORY
124              Specify the default sdr cache directory to use.
125

TIME OPTIONS

127       The  following  options are specific to tools that may output time val‐
128       ues. They will be ignored by all other tools.
129
130       utc-to-localtime ENABLE|DISABLE
131              Specify if time should be converted from assumed UTC  to  local‐
132              time by default.
133
134       localtime-to-utc ENABLE|DISABLE
135              Specify if time should be converted from localtime to UTC by de‐
136              fault.
137
138       utc-offset SECONDS
139              Specify a default UTC offset to be added to timestamps.
140

HOSTRANGED OPTIONS

142       The following options are specific to  tools  that  support  hostranged
143       output. They will be ignored by all other tools.
144
145       buffer-output ENABLE|DISABLE
146              Specify if hostranged output should be buffered by default.
147
148       consolidate-output ENABLE|DISABLE
149              Specify if hostranged output should be consolidated by default.
150
151       fanout COUNT
152              Specify the default multiple host fanout to use.
153
154       eliminate ENABLE|DISABLE
155              Specify if undetected hosts should be eliminated by default.
156
157       always-prefix ENABLE|DISABLE
158              Specify if output should be always prefixed by default.
159

BMC-DEVICE OPTIONS

161       The  following options are specific to bmc-device(8).  They will be ig‐
162       nored by other tools.
163
164       bmc-device-username USERNAME
165              Specify the default username to use for bmc-device(8).  If spec‐
166              ified, will override the general option username above.
167
168       bmc-device-password PASSWORD
169              Specify the default password to use for bmc-device(8).  If spec‐
170              ified, will override the general option password above.
171
172       bmc-device-k_g str
173              Specify the default BMC key (K_g) to use for bmc-device(8).   If
174              specified,  will  override  the general option k_g above. Prefix
175              with '0x' to enter the key in hex.
176
177       bmc-device-authentication-type AUTHENTICATION-TYPE
178              Specify the default  authentication  type  to  use  for  bmc-de‐
179              vice(8).  If specified, will override the general option authen‐
180              tication-type above. The following authentication types are sup‐
181              ported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
182
183       bmc-device-cipher-suite-id CIPHER-SUITE-ID
184              Specify  the  default  cipher suite id to use for bmc-device(8).
185              If specified, will override the general  option  cipher-suite-id
186              above. The following cipher suite ids are supported: 0, 1, 2, 3,
187              6, 7, 8, 11, 12.
188
189       bmc-device-privilege-level PRIVILEGE-LEVEL
190              Specify the default privilege type to use for bmc-device(8).  If
191              specified,  will  override  the  general  option privilege-level
192              above. The following privilege levels are supported: USER, OPER‐
193              ATOR, ADMIN.
194
195       bmc-device-workaround-flags WORKAROUNDS
196              Specify  default  workaround flags to use for bmc-device(8).  If
197              specified, will override the  general  options  workaround-flags
198              above. Multiple workarounds can be specified separated by white‐
199              space.  Please see bmc-device(8)  manpage  for  available  work‐
200              arounds.
201

BMC-INFO OPTIONS

203       The  following  options  are specific to bmc-info(8).  They will be ig‐
204       nored by other tools.
205
206       bmc-info-username USERNAME
207              Specify the default username to use for bmc-info(8).  If  speci‐
208              fied, will override the general option username above.
209
210       bmc-info-password PASSWORD
211              Specify  the default password to use for bmc-info(8).  If speci‐
212              fied, will override the general option password above.
213
214       bmc-info-k_g str
215              Specify the default BMC key (K_g) to use  for  bmc-info(8).   If
216              specified,  will  override  the general option k_g above. Prefix
217              with '0x' to enter the key in hex.
218
219       bmc-info-authentication-type AUTHENTICATION-TYPE
220              Specify the default authentication type to use for  bmc-info(8).
221              If  specified,  will override the general option authentication-
222              type above. The following authentication  types  are  supported:
223              NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
224
225       bmc-info-cipher-suite-id CIPHER-SUITE-ID
226              Specify  the default cipher suite id to use for bmc-info(8).  If
227              specified, will  override  the  general  option  cipher-suite-id
228              above. The following cipher suite ids are supported: 0, 1, 2, 3,
229              6, 7, 8, 11, 12.
230
231       bmc-info-privilege-level PRIVILEGE-LEVEL
232              Specify the default privilege type to use for  bmc-info(8).   If
233              specified,  will  override  the  general  option privilege-level
234              above. The following privilege levels are supported: USER, OPER‐
235              ATOR, ADMIN.
236
237       bmc-info-workaround-flags WORKAROUNDS
238              Specify  default  workaround  flags  to use for bmc-info(8).  If
239              specified, will override the  general  options  workaround-flags
240              above. Multiple workarounds can be specified separated by white‐
241              space.  Please  see  bmc-info(8)  manpage  for  available  work‐
242              arounds.
243
244       bmc-info-interpret-oem-data ENABLE|DISABLE
245              Specify  if bmc-info should attempt to interpret OEM data by de‐
246              fault or not.
247

BMC-WATCHDOG OPTIONS

249       The following options are specific to bmc-watchdog(8).   They  will  be
250       ignored by other tools.
251
252       bmc-watchdog-workaround-flags WORKAROUNDS
253              Specify default workaround flags to use for bmc-watchdog(8).  If
254              specified, will override the  general  options  workaround-flags
255              above. Multiple workarounds can be specified separated by white‐
256              space.  Please see bmc-watchdog(8) manpage for  available  work‐
257              arounds.
258
259       bmc-watchdog-verbose-logging ENABLE|DISABLE
260              Specify if logging will be verbose by default.
261
262       bmc-watchdog-no-logging ENABLE|DISABLE
263              Specify if logging will be disabled by default.
264

IPMI-CHASSIS OPTIONS

266       The  following  options  are specific to ipmi-chassis(8).  They will be
267       ignored by other tools.
268
269       ipmi-chassis-username USERNAME
270              Specify the default username to  use  for  ipmi-chassis(8).   If
271              specified, will override the general option username above.
272
273       ipmi-chassis-password PASSWORD
274              Specify  the  default  password  to use for ipmi-chassis(8).  If
275              specified, will override the general option password above.
276
277       ipmi-chassis-k_g str
278              Specify the default BMC key (K_g) to  use  for  ipmi-chassis(8).
279              If specified, will override the general option k_g above. Prefix
280              with '0x' to enter the key in hex.
281
282       ipmi-chassis-authentication-type AUTHENTICATION-TYPE
283              Specify the default authentication type to  use  for  ipmi-chas‐
284              sis(8).   If specified, will override the general option authen‐
285              tication-type above. The following authentication types are sup‐
286              ported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
287
288       ipmi-chassis-cipher-suite-id CIPHER-SUITE-ID
289              Specify  the default cipher suite id to use for ipmi-chassis(8).
290              If specified, will override the general  option  cipher-suite-id
291              above. The following cipher suite ids are supported: 0, 1, 2, 3,
292              6, 7, 8, 11, 12.
293
294       ipmi-chassis-privilege-level PRIVILEGE-LEVEL
295              Specify the default privilege type to use  for  ipmi-chassis(8).
296              If  specified,  will override the general option privilege-level
297              above. The following privilege levels are supported: USER, OPER‐
298              ATOR, ADMIN.
299
300       ipmi-chassis-workaround-flags WORKAROUNDS
301              Specify default workaround flags to use for ipmi-chassis(8).  If
302              specified, will override the  general  options  workaround-flags
303              above. Multiple workarounds can be specified separated by white‐
304              space.  Please see ipmi-chassis(8) manpage for  available  work‐
305              arounds.
306

IPMI-CONFIG OPTIONS

308       The following options are specific to ipmi-config(8).  They will be ig‐
309       nored by other tools.
310
311       ipmi-config-username USERNAME
312              Specify the default username  to  use  for  ipmi-config(8).   If
313              specified, will override the general option username above.
314
315       ipmi-config-password PASSWORD
316              Specify  the  default  password  to  use for ipmi-config(8).  If
317              specified, will override the general option password above.
318
319       ipmi-config-k_g str
320              Specify the default IPMI key (K_g) to  use  for  ipmi-config(8).
321              If specified, will override the general option k_g above. Prefix
322              with '0x' to enter the key in hex.
323
324       ipmi-config-authentication-type AUTHENTICATION-TYPE
325              Specify the default authentication type  to  use  for  ipmi-con‐
326              fig(8).   If specified, will override the general option authen‐
327              tication-type above. The following authentication types are sup‐
328              ported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
329
330       ipmi-config-cipher-suite-id CIPHER-SUITE-ID
331              Specify  the  default cipher suite id to use for ipmi-config(8).
332              If specified, will override the general  option  cipher-suite-id
333              above. The following cipher suite ids are supported: 0, 1, 2, 3,
334              6, 7, 8, 11, 12.
335
336       ipmi-config-privilege-level PRIVILEGE-LEVEL
337              Specify the default privilege type to  use  for  ipmi-config(8).
338              If  specified,  will override the general option privilege-level
339              above. The following privilege levels are supported: USER, OPER‐
340              ATOR, ADMIN.
341
342       ipmi-config-workaround-flags WORKAROUNDS
343              Specify  default workaround flags to use for ipmi-config(8).  If
344              specified, will override the  general  options  workaround-flags
345              above. Multiple workarounds can be specified separated by white‐
346              space.  Please see ipmi-config(8) manpage  for  available  work‐
347              arounds.
348
349       ipmi-config-verbose-count COUNT
350              Specify default verbose count to use for ipmi-config(8).
351

IPMI-DCMI OPTIONS

353       The  following  options are specific to ipmi-dcmi(8).  They will be ig‐
354       nored by other tools.
355
356       ipmi-dcmi-username USERNAME
357              Specify the default username to use for ipmi-dcmi(8).  If speci‐
358              fied, will override the general option username above.
359
360       ipmi-dcmi-password PASSWORD
361              Specify the default password to use for ipmi-dcmi(8).  If speci‐
362              fied, will override the general option password above.
363
364       ipmi-dcmi-k_g str
365              Specify the default BMC key (K_g) to use for  ipmi-dcmi(8).   If
366              specified,  will  override  the general option k_g above. Prefix
367              with '0x' to enter the key in hex.
368
369       ipmi-dcmi-authentication-type AUTHENTICATION-TYPE
370              Specify the default authentication type to use for ipmi-dcmi(8).
371              If  specified,  will override the general option authentication-
372              type above. The following authentication  types  are  supported:
373              NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
374
375       ipmi-dcmi-cipher-suite-id CIPHER-SUITE-ID
376              Specify the default cipher suite id to use for ipmi-dcmi(8).  If
377              specified, will  override  the  general  option  cipher-suite-id
378              above. The following cipher suite ids are supported: 0, 1, 2, 3,
379              6, 7, 8, 11, 12.
380
381       ipmi-dcmi-privilege-level PRIVILEGE-LEVEL
382              Specify the default privilege type to use for ipmi-dcmi(8).   If
383              specified,  will  override  the  general  option privilege-level
384              above. The following privilege levels are supported: USER, OPER‐
385              ATOR, ADMIN.
386
387       ipmi-dcmi-workaround-flags WORKAROUNDS
388              Specify  default  workaround  flags to use for ipmi-dcmi(8).  If
389              specified, will override the  general  options  workaround-flags
390              above. Multiple workarounds can be specified separated by white‐
391              space.  Please see  ipmi-dcmi(8)  manpage  for  available  work‐
392              arounds.
393
394       ipmi-dcmi-interpret-oem-data ENABLE|DISABLE
395              Specify if ipmi-dcmi should attempt to interpret OEM data by de‐
396              fault or not.
397

IPMI-FRU OPTIONS

399       The following options are specific to ipmi-fru(8).  They  will  be  ig‐
400       nored by other tools.
401
402       ipmi-fru-username USERNAME
403              Specify  the default username to use for ipmi-fru(8).  If speci‐
404              fied, will override the general option username above.
405
406       ipmi-fru-password PASSWORD
407              Specify the default password to use for ipmi-fru(8).  If  speci‐
408              fied, will override the general option password above.
409
410       ipmi-fru-k_g str
411              Specify  the  default  BMC key (K_g) to use for ipmi-fru(8).  If
412              specified, will override the general option  k_g  above.  Prefix
413              with '0x' to enter the key in hex.
414
415       ipmi-fru-authentication-type AUTHENTICATION-TYPE
416              Specify  the default authentication type to use for ipmi-fru(8).
417              If specified, will override the general  option  authentication-
418              type  above.  The  following authentication types are supported:
419              NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
420
421       ipmi-fru-cipher-suite-id CIPHER-SUITE-ID
422              Specify the default cipher suite id to use for ipmi-fru(8).   If
423              specified,  will  override  the  general  option cipher-suite-id
424              above. The following cipher suite ids are supported: 0, 1, 2, 3,
425              6, 7, 8, 11, 12.
426
427       ipmi-fru-privilege-level PRIVILEGE-LEVEL
428              Specify  the  default privilege type to use for ipmi-fru(8).  If
429              specified, will  override  the  general  option  privilege-level
430              above. The following privilege levels are supported: USER, OPER‐
431              ATOR, ADMIN.
432
433       ipmi-fru-workaround-flags WORKAROUNDS
434              Specify default workaround flags to  use  for  ipmi-fru(8).   If
435              specified,  will  override  the general options workaround-flags
436              above. Multiple workarounds can be specified separated by white‐
437              space.   Please  see  ipmi-fru(8)  manpage  for  available work‐
438              arounds.
439
440       ipmi-fru-verbose-count COUNT
441              Specify default verbose count to use for ipmi-fru(8).
442
443       ipmi-fru-bridge-fru ENABLE|DISABLE
444              Specify if FRU entries on other controllers should  be  read  by
445              default or not.
446
447       ipmi-fru-interpret-oem-data ENABLE|DISABLE
448              Specify  if ipmi-fru should attempt to interpret OEM data by de‐
449              fault or not.
450

IPMI-OEM OPTIONS

452       The following options are specific to ipmi-oem(8).  They  will  be  ig‐
453       nored by other tools.
454
455       ipmi-oem-username USERNAME
456              Specify  the default username to use for ipmi-oem(8).  If speci‐
457              fied, will override the general option username above.
458
459       ipmi-oem-password PASSWORD
460              Specify the default password to use for ipmi-oem(8).  If  speci‐
461              fied, will override the general option password above.
462
463       ipmi-oem-k_g str
464              Specify  the  default  BMC key (K_g) to use for ipmi-oem(8).  If
465              specified, will override the general option  k_g  above.  Prefix
466              with '0x' to enter the key in hex.
467
468       ipmi-oem-authentication-type AUTHENTICATION-TYPE
469              Specify  the default authentication type to use for ipmi-oem(8).
470              If specified, will override the general  option  authentication-
471              type  above.  The  following authentication types are supported:
472              NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
473
474       ipmi-oem-cipher-suite-id CIPHER-SUITE-ID
475              Specify the default cipher suite id to use for ipmi-oem(8).   If
476              specified,  will  override  the  general  option cipher-suite-id
477              above. The following cipher suite ids are supported: 0, 1, 2, 3,
478              6, 7, 8, 11, 12.
479
480       ipmi-oem-privilege-level PRIVILEGE-LEVEL
481              Specify  the  default privilege type to use for ipmi-oem(8).  If
482              specified, will  override  the  general  option  privilege-level
483              above. The following privilege levels are supported: USER, OPER‐
484              ATOR, ADMIN.
485
486       ipmi-oem-workaround-flags WORKAROUNDS
487              Specify default workaround flags to  use  for  ipmi-oem(8).   If
488              specified,  will  override  the general options workaround-flags
489              above. Multiple workarounds can be specified separated by white‐
490              space.   Please  see  ipmi-oem(8)  manpage  for  available work‐
491              arounds.
492
493       ipmi-oem-verbose-count COUNT
494              Specify default verbose count to use for ipmi-oem(8).
495

IPMI-PET OPTIONS

497       The following options are specific to ipmi-pet(8).  They  will  be  ig‐
498       nored by other tools.
499
500       ipmi-pet-username USERNAME
501              Specify  the default username to use for ipmi-pet(8).  If speci‐
502              fied, will override the general option username above.
503
504       ipmi-pet-password PASSWORD
505              Specify the default password to use for ipmi-pet(8).  If  speci‐
506              fied, will override the general option password above.
507
508       ipmi-pet-k_g str
509              Specify  the  default  BMC key (K_g) to use for ipmi-pet(8).  If
510              specified, will override the general option  k_g  above.  Prefix
511              with '0x' to enter the key in hex.
512
513       ipmi-pet-authentication-type AUTHENTICATION-TYPE
514              Specify  the default authentication type to use for ipmi-pet(8).
515              If specified, will override the general  option  authentication-
516              type  above.  The  following authentication types are supported:
517              NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
518
519       ipmi-pet-cipher-suite-id CIPHER-SUITE-ID
520              Specify the default cipher suite id to use for ipmi-pet(8).   If
521              specified,  will  override  the  general  option cipher-suite-id
522              above. The following cipher suite ids are supported: 0, 1, 2, 3,
523              6, 7, 8, 11, 12.
524
525       ipmi-pet-privilege-level PRIVILEGE-LEVEL
526              Specify  the  default privilege type to use for ipmi-pet(8).  If
527              specified, will  override  the  general  option  privilege-level
528              above. The following privilege levels are supported: USER, OPER‐
529              ATOR, ADMIN.
530
531       ipmi-pet-workaround-flags WORKAROUNDS
532              Specify default workaround flags to  use  for  ipmi-pet(8).   If
533              specified,  will  override  the general options workaround-flags
534              above. Multiple workarounds can be specified separated by white‐
535              space.   Please  see  ipmi-pet(8)  manpage  for  available work‐
536              arounds.
537
538       ipmi-pet-verbose-count COUNT
539              Specify default verbose count to use for ipmi-pet(8).
540
541       ipmi-pet-output-event-severity ENABLE|DISABLE
542              Specify if ipmi-pet should output the event  severity  state  by
543              default.
544
545       ipmi-pet-output-event-state ENABLE|DISABLE
546              Specify  if  ipmi-pet should output the event state state by de‐
547              fault.
548
549       ipmi-pet-event-state-config-file FILE
550              Specify the default event state configuration file.
551
552       ipmi-pet-interpret-oem-data ENABLE|DISABLE
553              Specify if ipmi-pet should attempt to interpret OEM data by  de‐
554              fault or not.
555
556       ipmi-pet-entity-sensor-names ENABLE|DISABLE
557              Specify  if output of sensor names should include entity ids and
558              instances by default or not.
559
560       ipmi-pet-no-sensor-type-output ENABLE|DISABLE
561              Specify if output of the sensor type should be output by default
562              or not.
563
564       ipmi-pet-comma-separated-output ENABLE|DISABLE
565              Specify if output should be comma separated by default or not.
566
567       ipmi-pet-no-header-output ENABLE|DISABLE
568              Specify if column headers should be output by default or not.
569
570       ipmi-pet-non-abbreviated-units ENABLE|DISABLE
571              Specify  if  output  should have units abbreviated by default or
572              not.
573

IPMI-RAW OPTIONS

575       The following options are specific to ipmi-raw(8).  They  will  be  ig‐
576       nored by other tools.
577
578       ipmi-raw-username USERNAME
579              Specify  the default username to use for ipmi-raw(8).  If speci‐
580              fied, will override the general option username above.
581
582       ipmi-raw-password PASSWORD
583              Specify the default password to use for ipmi-raw(8).  If  speci‐
584              fied, will override the general option password above.
585
586       ipmi-raw-k_g str
587              Specify  the  default  BMC key (K_g) to use for ipmi-raw(8).  If
588              specified, will override the general option  k_g  above.  Prefix
589              with '0x' to enter the key in hex.
590
591       ipmi-raw-authentication-type AUTHENTICATION-TYPE
592              Specify  the default authentication type to use for ipmi-raw(8).
593              If specified, will override the general  option  authentication-
594              type  above.  The  following authentication types are supported:
595              NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
596
597       ipmi-raw-cipher-suite-id CIPHER-SUITE-ID
598              Specify the default cipher suite id to use for ipmi-raw(8).   If
599              specified,  will  override  the  general  option cipher-suite-id
600              above. The following cipher suite ids are supported: 0, 1, 2, 3,
601              6, 7, 8, 11, 12.
602
603       ipmi-raw-privilege-level PRIVILEGE-LEVEL
604              Specify  the  default privilege type to use for ipmi-raw(8).  If
605              specified, will  override  the  general  option  privilege-level
606              above. The following privilege levels are supported: USER, OPER‐
607              ATOR, ADMIN.
608
609       ipmi-raw-workaround-flags WORKAROUNDS
610              Specify default workaround flags to  use  for  ipmi-raw(8).   If
611              specified,  will  override  the general options workaround-flags
612              above. Multiple workarounds can be specified separated by white‐
613              space.   Please  see  ipmi-raw(8)  manpage  for  available work‐
614              arounds.
615

IPMI-SEL OPTIONS

617       The following options are specific to ipmi-sel(8).  They  will  be  ig‐
618       nored by other tools.
619
620       ipmi-sel-username USERNAME
621              Specify  the default username to use for ipmi-sel(8).  If speci‐
622              fied, will override the general option username above.
623
624       ipmi-sel-password PASSWORD
625              Specify the default password to use for ipmi-sel(8).  If  speci‐
626              fied, will override the general option password above.
627
628       ipmi-sel-k_g str
629              Specify  the  default  BMC key (K_g) to use for ipmi-sel(8).  If
630              specified, will override the general option  k_g  above.  Prefix
631              with '0x' to enter the key in hex.
632
633       ipmi-sel-authentication-type AUTHENTICATION-TYPE
634              Specify  the default authentication type to use for ipmi-sel(8).
635              If specified, will override the general  option  authentication-
636              type  above.  The  following authentication types are supported:
637              NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
638
639       ipmi-sel-cipher-suite-id CIPHER-SUITE-ID
640              Specify the default cipher suite id to use for ipmi-sel(8).   If
641              specified,  will  override  the  general  option cipher-suite-id
642              above. The following cipher suite ids are supported: 0, 1, 2, 3,
643              6, 7, 8, 11, 12.
644
645       ipmi-sel-privilege-level PRIVILEGE-LEVEL
646              Specify  the  default privilege type to use for ipmi-sel(8).  If
647              specified, will  override  the  general  option  privilege-level
648              above. The following privilege levels are supported: USER, OPER‐
649              ATOR, ADMIN.
650
651       ipmi-sel-workaround-flags WORKAROUNDS
652              Specify default workaround flags to  use  for  ipmi-sel(8).   If
653              specified,  will  override  the general options workaround-flags
654              above. Multiple workarounds can be specified separated by white‐
655              space.   Please  see  ipmi-sel(8)  manpage  for  available work‐
656              arounds.
657
658       ipmi-sel-verbose-count COUNT
659              Specify default verbose count to use for ipmi-sel(8).
660
661       ipmi-sel-types TYPE-LIST
662              Specify default types to show SEL events for. Multiple types can
663              be  specified  separated by whitespace. Users may specify sensor
664              types by string or by number (decimal or hex). Please see  ipmi-
665              sel(8) --list-types option to see possible string input types.
666
667       ipmi-sel-exclude-types ENSOR-TYPES-LIST Specify
668              default sensor types to not show SEL events for. Multiple sensor
669              types can be specified separated by whitespace. Users may  spec‐
670              ify  sensor types by string or by number. Please see ipmi-sel(8)
671              --list-types option to see possible string input types.
672
673       ipmi-sel-system-event-only ENABLE|DISABLE
674              Specify if output should only include system event records.
675
676       ipmi-sel-oem-event-only ENABLE|DISABLE
677              Specify if output should only include OEM event records.
678
679       ipmi-sel-output-manufacturer-id ENABLE|DISABLE
680              Specify if output of OEM event records should  include  manufac‐
681              turer ID by default or not.
682
683       ipmi-sel-output-event-state ENABLE|DISABLE
684              Specify  if  ipmi-sel should output the event state state by de‐
685              fault.
686
687       ipmi-sel-event-state-config-file FILE
688              Specify the default event state configuration file.
689
690       ipmi-sel-interpret-oem-data ENABLE|DISABLE
691              Specify if ipmi-sel should attempt to interpret OEM data by  de‐
692              fault or not.
693
694       ipmi-sel-output-oem-event-strings ENABLE|DISABLE
695              Specify  if  ipmi-sel should output OEM event strings by default
696              or not.
697
698       ipmi-sel-entity-sensor-names ENABLE|DISABLE
699              Specify if output of sensor names should include entity ids  and
700              instances by default or not.
701
702       ipmi-sel-no-sensor-type-output ENABLE|DISABLE
703              Specify if output of the sensor type should be output by default
704              or not.
705
706       ipmi-sel-comma-separated-output ENABLE|DISABLE
707              Specify if output should be comma separated by default or not.
708
709       ipmi-sel-no-header-output ENABLE|DISABLE
710              Specify if column headers should be output by default or not.
711
712       ipmi-sel-non-abbreviated-units ENABLE|DISABLE
713              Specify if output should have units abbreviated  by  default  or
714              not.
715
716       ipmi-sel-legacy-output ENABLE|DISABLE
717              Specify if output should be in legacy format by default or not.
718

IPMI-SENSORS OPTIONS

720       The  following  options  are specific to ipmi-sensors(8).  They will be
721       ignored by other tools.
722
723       ipmi-sensors-username USERNAME
724              Specify the default username to  use  for  ipmi-sensors(8).   If
725              specified, will override the general option username above.
726
727       ipmi-sensors-password PASSWORD
728              Specify  the  default  password  to use for ipmi-sensors(8).  If
729              specified, will override the general option password above.
730
731       ipmi-sensors-k_g str
732              Specify the default BMC key (K_g) to  use  for  ipmi-sensors(8).
733              If specified, will override the general option k_g above. Prefix
734              with '0x' to enter the key in hex.
735
736       ipmi-sensors-authentication-type AUTHENTICATION-TYPE
737              Specify the default authentication type  to  use  for  ipmi-sen‐
738              sors(8).  If specified, will override the general option authen‐
739              tication-type above. The following authentication types are sup‐
740              ported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
741
742       ipmi-sensors-cipher-suite-id CIPHER-SUITE-ID
743              Specify  the default cipher suite id to use for ipmi-sensors(8).
744              If specified, will override the general  option  cipher-suite-id
745              above. The following cipher suite ids are supported: 0, 1, 2, 3,
746              6, 7, 8, 11, 12.
747
748       ipmi-sensors-privilege-level PRIVILEGE-LEVEL
749              Specify the default privilege type to use  for  ipmi-sensors(8).
750              If  specified,  will override the general option privilege-level
751              above. The following privilege levels are supported: USER, OPER‐
752              ATOR, ADMIN.
753
754       ipmi-sensors-workaround-flags WORKAROUNDS
755              Specify default workaround flags to use for ipmi-sensors(8).  If
756              specified, will override the  general  options  workaround-flags
757              above. Multiple workarounds can be specified separated by white‐
758              space.  Please see ipmi-sensors(8) manpage for  available  work‐
759              arounds.
760
761       ipmi-sensors-verbose-count COUNT
762              Specify default verbose count to use for ipmi-sensors(8).
763
764       ipmi-sensors-quiet-readings ENABLE|DISABLE
765              Specify  if  sensor  reading values and thresholds should not be
766              output by default.
767
768       ipmi-sensors-record-ids ECORD-IDS-LIST
769              Specify default record ids to show sensor outputs for.  Multiple
770              record ids can be specified separated by whitespace.
771
772       ipmi-sensors-exclude-record-ids ECORD-IDS-LIST
773              Specify  default record ids to not show sensor outputs for. Mul‐
774              tiple record ids can be specified separated by whitespace.
775
776       ipmi-sensors-types TYPE-LIST
777              Specify default types to show sensor outputs for. Multiple types
778              can be specified separated by whitespace. Users may specify sen‐
779              sor types by string or by number (decimal or  hex).  Please  see
780              ipmi-sensors(8) --list-types option to see possible string input
781              types.
782
783       ipmi-sensors-exclude-types ENSOR-TYPES-LIST Specify
784              default sensor types to not show sensor  outputs  for.  Multiple
785              sensor types can be specified separated by whitespace. Users may
786              specify sensor types by string or by number.  Please  see  ipmi-
787              sensors(8)  --list-types  option  to  see  possible string input
788              types.
789
790       ipmi-sensors-bridge-sensors ENABLE|DISABLE
791              Specify if non-BMC sensors should be bridged by default or not.
792
793       ipmi-sensors-shared-sensors ENABLE|DISABLE
794              Specify if shared sensors should be output by default or not.
795
796       ipmi-sensors-interpret-oem-data ENABLE|DISABLE
797              Specify if ipmi-sensors should attempt to interpret OEM data  by
798              default or not.
799
800       ipmi-sensors-ignore-not-available-sensors ENABLE|DISABLE
801              Specify  if  ipmi-sensors should ignore not-available (i.e. N/A)
802              sensors by default.
803
804       ipmi-sensors-ignore-unrecognized-events ENABLE|DISABLE
805              Specify if ipmi-sensors should ignore unrecognized events  (i.e.
806              'Unrecognized Event') in sensors output by default.
807
808       ipmi-sensors-output-event-bitmask ENABLE|DISABLE
809              Specify  if ipmi-sensors should output event bitmasks instead of
810              string representations by default.
811
812       ipmi-sensors-output-sensor-state ENABLE|DISABLE
813              Specify if ipmi-sensors should output the sensor  state  by  de‐
814              fault.
815
816       ipmi-sensors-sensor-state-config-file FILE
817              Specify the default sensor state configuration file.
818
819       ipmi-sensors-entity-sensor-names ENABLE|DISABLE
820              Specify  if output of sensor names should include entity ids and
821              instances by default or not.
822
823       ipmi-sensors-output-sensor-thresholds ENABLE|DISABLE
824              Specify if ipmi-sensors should output sensor thresholds  by  de‐
825              fault.
826
827       ipmi-sensors-no-sensor-type-output ENABLE|DISABLE
828              Specify if output of the sensor type should be output by default
829              or not.
830
831       ipmi-sensors-comma-separated-output ENABLE|DISABLE
832              Specify if output should be comma separated by default or not.
833
834       ipmi-sensors-no-header-output ENABLE|DISABLE
835              Specify if column headers should be output by default or not.
836
837       ipmi-sensors-non-abbreviated-units ENABLE|DISABLE
838              Specify if output should have units abbreviated  by  default  or
839              not.
840
841       ipmi-sensors-legacy-output ENABLE|DISABLE
842              Specify if output should be in legacy format by default or not.
843
844       ipmi-sensors-ipmimonitoring-legacy-output ENABLE|DISABLE
845              Specify  if  output should be in ipmimonitoring legacy format by
846              default or not.
847

IPMICONSOLE OPTIONS

849       The following options are specific to ipmiconsole(8).  They will be ig‐
850       nored by other tools.
851
852       ipmiconsole-username USERNAME
853              Specify  the  default  username  to  use for ipmiconsole(8).  If
854              specified, will override the general option username above.
855
856       ipmiconsole-password PASSWORD
857              Specify the default password  to  use  for  ipmiconsole(8).   If
858              specified, will override the general option password above.
859
860       ipmiconsole-k_g str
861              Specify the default BMC key (K_g) to use for ipmiconsole(8).  If
862              specified, will override the general option  k_g  above.  Prefix
863              with '0x' to enter the key in hex.
864
865       ipmiconsole-authentication-type AUTHENTICATION-TYPE
866              Specify  the  default  authentication  type  to use for ipmicon‐
867              sole(8).  If specified, will override the general option authen‐
868              tication-type above. The following authentication types are sup‐
869              ported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
870
871       ipmiconsole-cipher-suite-id CIPHER-SUITE-ID
872              Specify the default cipher suite id to use  for  ipmiconsole(8).
873              If  specified,  will override the general option cipher-suite-id
874              above. The following cipher suite ids are supported: 0, 1, 2, 3,
875              6, 7, 8, 11, 12.
876
877       ipmiconsole-privilege-level PRIVILEGE-LEVEL
878              Specify  the  default  privilege type to use for ipmiconsole(8).
879              If specified, will override the general  option  privilege-level
880              above. The following privilege levels are supported: USER, OPER‐
881              ATOR, ADMIN.
882
883       ipmiconsole-workaround-flags WORKAROUNDS
884              Specify default workaround flags to use for ipmiconsole(8).   If
885              specified,  will  override  the general options workaround-flags
886              above. Multiple workarounds can be specified separated by white‐
887              space.   Please  see  ipmiconsole(8) manpage for available work‐
888              arounds.
889
890       ipmiconsole-escape-char CHAR
891              Specify the default escape character.
892
893       ipmiconsole-dont-steal ENABLE|DISABLE
894              Specify if in use SOL sessions should not be stolen by default.
895
896       ipmiconsole-serial-keepalive ENABLE|DISABLE
897              Specify if serial keepalive should be enabled by default.
898
899       ipmiconsole-serial-keepalive-empty ENABLE|DISABLE
900              Specify if serial keepalive empty should be enabled by default.
901
902       ipmiconsole-sol-payload-instance NUM
903              Specify the default SOL payload instance.
904
905       ipmiconsole-deactivate-all-instances ENABLE|DISABLE
906              Specify if SOL deactivate should deactivate all instances by de‐
907              fault.
908
909       ipmiconsole-lock-memory ENABLE|DISABLE
910              Specify if memory should be locked by default.
911

IPMIPOWER OPTIONS

913       The  following  options are specific to ipmipower(8).  They will be ig‐
914       nored by other tools.
915
916       ipmipower-username USERNAME
917              Specify the default username to use for ipmipower(8).  If speci‐
918              fied, will override the general option username above.
919
920       ipmipower-password PASSWORD
921              Specify the default password to use for ipmipower(8).  If speci‐
922              fied, will override the general option password above.
923
924       ipmipower-k_g str
925              Specify the default BMC key (K_g) to use for  ipmipower(8).   If
926              specified,  will  override  the general option k_g above. Prefix
927              with '0x' to enter the key in hex.
928
929       ipmipower-authentication-type AUTHENTICATION-TYPE
930              Specify the default authentication type to use for ipmipower(8).
931              If  specified,  will override the general option authentication-
932              type above. The following authentication  types  are  supported:
933              NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
934
935       ipmipower-cipher-suite-id CIPHER-SUITE-ID
936              Specify the default cipher suite id to use for ipmipower(8).  If
937              specified, will  override  the  general  option  cipher-suite-id
938              above. The following cipher suite ids are supported: 0, 1, 2, 3,
939              6, 7, 8, 11, 12.
940
941       ipmipower-privilege-level PRIVILEGE-LEVEL
942              Specify the default privilege type to use for ipmipower(8).   If
943              specified,  will  override  the  general  option privilege-level
944              above. The following privilege levels are supported: USER, OPER‐
945              ATOR, ADMIN.
946
947       ipmipower-workaround-flags WORKAROUNDS
948              Specify  default  workaround  flags to use for ipmipower(8).  If
949              specified, will override the  general  options  workaround-flags
950              above. Multiple workarounds can be specified separated by white‐
951              space.  Please see  ipmipower(8)  manpage  for  available  work‐
952              arounds.
953
954       ipmipower-on-if-off ENABLE|DISABLE
955              Specify if on-if-off functionality is enabled or disabled by de‐
956              fault.
957
958       ipmipower-wait-until-on ENABLE|DISABLE
959              Specify if wait-until-on functionality is enabled or disabled by
960              default.
961
962       ipmipower-wait-until-off ENABLE|DISABLE
963              Specify  if  wait-until-off functionality is enabled or disabled
964              by default.
965
966       ipmipower-oem-power-type OEM-POWER-TYPE
967              Specify OEM power type to be used.
968
969       ipmipower-retransmission-wait-timeout MILLISECONDS
970              Specify the default retransmission wait timeout length to use in
971              milliseconds.
972
973       ipmipower-retransmission-backoff-count COUNT
974              Specify  the default retransmission backoff count to use for re‐
975              transmissions.
976
977       ipmipower-ping-interval MILLISECONDS
978              Specify the default ping interval length to use in milliseconds.
979
980       ipmipower-ping-timeout MILLISECONDS
981              Specify the default ping timeout length to use in milliseconds.
982
983       ipmipower-ping-packet-count COUNT
984              Specify the default ping packet count size to use.
985
986       ipmipower-ping-percent PERCENT
987              Specify the default ping percent value to use.
988
989       ipmipower-ping-consec-count COUNT
990              Specify the default ping consecutive count value to use.
991

FILES

993       /etc/freeipmi//freeipmi.conf
994

REPORTING BUGS

996       Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.
997
999       Copyright © 2003-2015 FreeIPMI Core Team.
1000
1001       FreeIPMI is free software; you can redistribute it and/or modify it un‐
1002       der  the  terms  of  the GNU General Public License as published by the
1003       Free Software Foundation; either version 3 of the License, or (at  your
1004       option) any later version.
1005

SEE ALSO

1007       freeipmi(7),  bmc-device(8),  bmc-info(8),  bmc-watchdog(8), ipmi-chas‐
1008       sis(8), ipmi-config(8), ipmi-fru(8),  ipmi-oem(8),  ipmi-raw(8),  ipmi-
1009       sel(8), ipmi-sensors(8), ipmiconsole(8), ipmipower(8)
1010
1011       http://www.gnu.org/software/freeipmi/
1012
1013
1014
1015FreeIPMI 1.6.11                   2023-06-07                       FREEIPMI(5)
Impressum