DOKK / manpages / debian 11 / freeipmi-common / freeipmi.conf.5.en
FREEIPMI(5) Configuration FREEIPMI(5)

freeipmi.conf - specify default values to FreeIPMI

The FreeIPMI configuration file can be used to set alternate default values to many FreeIPMI tools so values don't have to be configured on the command line. This allows users to avoid typing in a long list of command line options everytime a command is executed. It can also be used to hide usernames, passwords, and other sensitive information from the ps(1) command.

Currently, the tools that can be configured with the configuration file are: bmc-device(8), bmc-info(8), bmc-watchdog(8), ipmi-chassis(8), ipmi-config(8), ipmi-fru(8), ipmi-oem(8), ipmi-pet(8), ipmi-raw(8), ipmi-sel(8), ipmi-sensors(8), ipmiconsole(8), and ipmipower(8).

By default, the configuration file is stored at /etc/freeipmi//freeipmi.conf. But users may select a different configuration file at the command line with the --config-file option.

Values specified on the command line override the configuration values specified in the configuration file.

The configuration options that can be specified in the configuration file are listed below. Each configuration option must be listed on a separate line. Arguments for an option are separated by any amount of whitespace. Multiple arguments are also separated by whitespace. Comments can be marked by using the pound sign ("#") character, and lines can be continued on the next using backslash ("\").

Note that it is possible to list the username, password and other potentially sensitive information in the configuration file. If this data is stored in a configuration file, system administrators should limit access to this file.

The following options are options generally available to all tools, although specific options may be ignored by some. (For example, ipmiconsole(8) and ipmipower(8) do not perform in-band communication, therefore they would ignore in-band communication options. Similarly bmc-watchdog(8) does not perform out-of-band communication, therefore it would ignore all out-of-band options).

Specify the default driver type to use.
Specify if IPMI devices should be probed for default settings.
Specify the default in-band driver address to use.
Specify the default in-band driver device path to use.
Specify the default in-band driver register spacing to use.
Specify the default in-band driver target channel number.
Specify the default in-band driver target slave address.
Specify the default username to use.
Specify the default password to use.
Specify the default BMC key (K_g) to use. Prefix with '0x' to enter the key in hex.
Specify the default session timeout length to use in milliseconds.
Specify the default retransmission timeout length to use in milliseconds.
Specify the default authentication type to use. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
Specify the default cipher suite id to use. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.
Specify the default privilege type to use. The following privilege levels are supported: USER, OPERATOR, ADMIN.
Specify default workaround flags to use. Multiple workarounds can be specified separated by whitespace. Please see tool manpages for details about available workarounds for each tool. The following workarounds are supported: assumeio, spinpoll, idzero, forcepermsg, unexpectedauth, endianseq, noauthcodecheck, authcap, nochecksumcheck, intel20, supermicro20, sun20, opensesspriv, integritycheckvalue, assumemaxsdrrecordcount, solpayloadsize, solport, solstatus, solchannelsupport, serialalertsdeferred, solpacketseq, skipchecks, assumesystemevent, discretereading, ignorescanningdisabled, assumebmcowner, ignoreauthcode, slowcommit, veryslowcommit, solchannelassumelanchannel, ignorestateflag, malformedack, guidformat, ipmiping.

The following options are specific to tools that use the sensor data repository (SDR). They will be ignored by all other tools.

Specify if cache creation/deletion information should not be output by default.
Specify the default sdr cache directory to use.

The following options are specific to tools that may output time values. They will be ignored by all other tools.

Specify if time should be converted from assumed UTC to localtime by default.
Specify if time should be converted from localtime to UTC by default.
Specify a default UTC offset to be added to timestamps.

The following options are specific to tools that support hostranged output. They will be ignored by all other tools.

Specify if hostranged output should be buffered by default.
Specify if hostranged output should be consolidated by default.
Specify the default multiple host fanout to use.
Specify if undetected hosts should be eliminated by default.
Specify if output should be always prefixed by default.

The following options are specific to bmc-device(8). They will be ignored by other tools.

Specify the default username to use for bmc-device(8). If specified, will override the general option username above.
Specify the default password to use for bmc-device(8). If specified, will override the general option password above.
Specify the default BMC key (K_g) to use for bmc-device(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.
Specify the default authentication type to use for bmc-device(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
Specify the default cipher suite id to use for bmc-device(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.
Specify the default privilege type to use for bmc-device(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.
Specify default workaround flags to use for bmc-device(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see bmc-device(8) manpage for available workarounds.

The following options are specific to bmc-info(8). They will be ignored by other tools.

Specify the default username to use for bmc-info(8). If specified, will override the general option username above.
Specify the default password to use for bmc-info(8). If specified, will override the general option password above.
Specify the default BMC key (K_g) to use for bmc-info(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.
Specify the default authentication type to use for bmc-info(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
Specify the default cipher suite id to use for bmc-info(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.
Specify the default privilege type to use for bmc-info(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.
Specify default workaround flags to use for bmc-info(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see bmc-info(8) manpage for available workarounds.
Specify if bmc-info should attempt to interpret OEM data by default or not.

The following options are specific to bmc-watchdog(8). They will be ignored by other tools.

Specify default workaround flags to use for bmc-watchdog(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see bmc-watchdog(8) manpage for available workarounds.
Specify if logging will be verbose by default.
Specify if logging will be disabled by default.

The following options are specific to ipmi-chassis(8). They will be ignored by other tools.

Specify the default username to use for ipmi-chassis(8). If specified, will override the general option username above.
Specify the default password to use for ipmi-chassis(8). If specified, will override the general option password above.
Specify the default BMC key (K_g) to use for ipmi-chassis(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.
Specify the default authentication type to use for ipmi-chassis(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
Specify the default cipher suite id to use for ipmi-chassis(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.
Specify the default privilege type to use for ipmi-chassis(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.
Specify default workaround flags to use for ipmi-chassis(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmi-chassis(8) manpage for available workarounds.

The following options are specific to ipmi-config(8). They will be ignored by other tools.

Specify the default username to use for ipmi-config(8). If specified, will override the general option username above.
Specify the default password to use for ipmi-config(8). If specified, will override the general option password above.
Specify the default IPMI key (K_g) to use for ipmi-config(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.
Specify the default authentication type to use for ipmi-config(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
Specify the default cipher suite id to use for ipmi-config(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.
Specify the default privilege type to use for ipmi-config(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.
Specify default workaround flags to use for ipmi-config(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmi-config(8) manpage for available workarounds.
Specify default verbose count to use for ipmi-config(8).

The following options are specific to ipmi-dcmi(8). They will be ignored by other tools.

Specify the default username to use for ipmi-dcmi(8). If specified, will override the general option username above.
Specify the default password to use for ipmi-dcmi(8). If specified, will override the general option password above.
Specify the default BMC key (K_g) to use for ipmi-dcmi(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.
Specify the default authentication type to use for ipmi-dcmi(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
Specify the default cipher suite id to use for ipmi-dcmi(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.
Specify the default privilege type to use for ipmi-dcmi(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.
Specify default workaround flags to use for ipmi-dcmi(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmi-dcmi(8) manpage for available workarounds.
Specify if ipmi-dcmi should attempt to interpret OEM data by default or not.

The following options are specific to ipmi-fru(8). They will be ignored by other tools.

Specify the default username to use for ipmi-fru(8). If specified, will override the general option username above.
Specify the default password to use for ipmi-fru(8). If specified, will override the general option password above.
Specify the default BMC key (K_g) to use for ipmi-fru(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.
Specify the default authentication type to use for ipmi-fru(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
Specify the default cipher suite id to use for ipmi-fru(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.
Specify the default privilege type to use for ipmi-fru(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.
Specify default workaround flags to use for ipmi-fru(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmi-fru(8) manpage for available workarounds.
Specify default verbose count to use for ipmi-fru(8).
Specify if FRU entries on other controllers should be read by default or not.
Specify if ipmi-fru should attempt to interpret OEM data by default or not.

The following options are specific to ipmi-oem(8). They will be ignored by other tools.

Specify the default username to use for ipmi-oem(8). If specified, will override the general option username above.
Specify the default password to use for ipmi-oem(8). If specified, will override the general option password above.
Specify the default BMC key (K_g) to use for ipmi-oem(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.
Specify the default authentication type to use for ipmi-oem(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
Specify the default cipher suite id to use for ipmi-oem(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.
Specify the default privilege type to use for ipmi-oem(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.
Specify default workaround flags to use for ipmi-oem(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmi-oem(8) manpage for available workarounds.
Specify default verbose count to use for ipmi-oem(8).

The following options are specific to ipmi-pet(8). They will be ignored by other tools.

Specify the default username to use for ipmi-pet(8). If specified, will override the general option username above.
Specify the default password to use for ipmi-pet(8). If specified, will override the general option password above.
Specify the default BMC key (K_g) to use for ipmi-pet(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.
Specify the default authentication type to use for ipmi-pet(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
Specify the default cipher suite id to use for ipmi-pet(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.
Specify the default privilege type to use for ipmi-pet(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.
Specify default workaround flags to use for ipmi-pet(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmi-pet(8) manpage for available workarounds.
Specify default verbose count to use for ipmi-pet(8).
Specify if ipmi-pet should output the event severity state by default.
Specify if ipmi-pet should output the event state state by default.
Specify the default event state configuration file.
Specify if ipmi-pet should attempt to interpret OEM data by default or not.
Specify if output of sensor names should include entity ids and instances by default or not.
Specify if output of the sensor type should be output by default or not.
Specify if output should be comma separated by default or not.
Specify if column headers should be output by default or not.
Specify if output should have units abbreviated by default or not.

The following options are specific to ipmi-raw(8). They will be ignored by other tools.

Specify the default username to use for ipmi-raw(8). If specified, will override the general option username above.
Specify the default password to use for ipmi-raw(8). If specified, will override the general option password above.
Specify the default BMC key (K_g) to use for ipmi-raw(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.
Specify the default authentication type to use for ipmi-raw(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
Specify the default cipher suite id to use for ipmi-raw(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.
Specify the default privilege type to use for ipmi-raw(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.
Specify default workaround flags to use for ipmi-raw(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmi-raw(8) manpage for available workarounds.

The following options are specific to ipmi-sel(8). They will be ignored by other tools.

Specify the default username to use for ipmi-sel(8). If specified, will override the general option username above.
Specify the default password to use for ipmi-sel(8). If specified, will override the general option password above.
Specify the default BMC key (K_g) to use for ipmi-sel(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.
Specify the default authentication type to use for ipmi-sel(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
Specify the default cipher suite id to use for ipmi-sel(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.
Specify the default privilege type to use for ipmi-sel(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.
Specify default workaround flags to use for ipmi-sel(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmi-sel(8) manpage for available workarounds.
Specify default verbose count to use for ipmi-sel(8).
Specify default types to show SEL events for. Multiple types can be specified separated by whitespace. Users may specify sensor types by string or by number (decimal or hex). Please see ipmi-sel(8) --list-types option to see possible string input types.
default sensor types to not show SEL events for. Multiple sensor types can be specified separated by whitespace. Users may specify sensor types by string or by number. Please see ipmi-sel(8) --list-types option to see possible string input types.
Specify if output should only include system event records.
Specify if output should only include OEM event records.
Specify if output of OEM event records should include manufacturer ID by default or not.
Specify if ipmi-sel should output the event state state by default.
Specify the default event state configuration file.
Specify if ipmi-sel should attempt to interpret OEM data by default or not.
Specify if ipmi-sel should output OEM event strings by default or not.
Specify if output of sensor names should include entity ids and instances by default or not.
Specify if output of the sensor type should be output by default or not.
Specify if output should be comma separated by default or not.
Specify if column headers should be output by default or not.
Specify if output should have units abbreviated by default or not.
Specify if output should be in legacy format by default or not.

The following options are specific to ipmi-sensors(8). They will be ignored by other tools.

Specify the default username to use for ipmi-sensors(8). If specified, will override the general option username above.
Specify the default password to use for ipmi-sensors(8). If specified, will override the general option password above.
Specify the default BMC key (K_g) to use for ipmi-sensors(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.
Specify the default authentication type to use for ipmi-sensors(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
Specify the default cipher suite id to use for ipmi-sensors(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.
Specify the default privilege type to use for ipmi-sensors(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.
Specify default workaround flags to use for ipmi-sensors(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmi-sensors(8) manpage for available workarounds.
Specify default verbose count to use for ipmi-sensors(8).
Specify if sensor reading values and thresholds should not be output by default.
Specify default record ids to show sensor outputs for. Multiple record ids can be specified separated by whitespace.
Specify default record ids to not show sensor outputs for. Multiple record ids can be specified separated by whitespace.
Specify default types to show sensor outputs for. Multiple types can be specified separated by whitespace. Users may specify sensor types by string or by number (decimal or hex). Please see ipmi-sensors(8) --list-types option to see possible string input types.
default sensor types to not show sensor outputs for. Multiple sensor types can be specified separated by whitespace. Users may specify sensor types by string or by number. Please see ipmi-sensors(8) --list-types option to see possible string input types.
Specify if non-BMC sensors should be bridged by default or not.
Specify if shared sensors should be output by default or not.
Specify if ipmi-sensors should attempt to interpret OEM data by default or not.
Specify if ipmi-sensors should ignore not-available (i.e. N/A) sensors by default.
Specify if ipmi-sensors should ignore unrecognized events (i.e. 'Unrecognized Event') in sensors output by default.
Specify if ipmi-sensors should output event bitmasks instead of string representations by default.
Specify if ipmi-sensors should output the sensor state by default.
Specify the default sensor state configuration file.
Specify if output of sensor names should include entity ids and instances by default or not.
Specify if ipmi-sensors should output sensor thresholds by default.
Specify if output of the sensor type should be output by default or not.
Specify if output should be comma separated by default or not.
Specify if column headers should be output by default or not.
Specify if output should have units abbreviated by default or not.
Specify if output should be in legacy format by default or not.
Specify if output should be in ipmimonitoring legacy format by default or not.

The following options are specific to ipmiconsole(8). They will be ignored by other tools.

Specify the default username to use for ipmiconsole(8). If specified, will override the general option username above.
Specify the default password to use for ipmiconsole(8). If specified, will override the general option password above.
Specify the default BMC key (K_g) to use for ipmiconsole(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.
Specify the default authentication type to use for ipmiconsole(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
Specify the default cipher suite id to use for ipmiconsole(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.
Specify the default privilege type to use for ipmiconsole(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.
Specify default workaround flags to use for ipmiconsole(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmiconsole(8) manpage for available workarounds.
Specify the default escape character.
Specify if in use SOL sessions should not be stolen by default.
Specify if serial keepalive should be enabled by default.
Specify if serial keepalive empty should be enabled by default.
Specify the default SOL payload instance.
Specify if SOL deactivate should deactivate all instances by default.
Specify if memory should be locked by default.

The following options are specific to ipmipower(8). They will be ignored by other tools.

Specify the default username to use for ipmipower(8). If specified, will override the general option username above.
Specify the default password to use for ipmipower(8). If specified, will override the general option password above.
Specify the default BMC key (K_g) to use for ipmipower(8). If specified, will override the general option k_g above. Prefix with '0x' to enter the key in hex.
Specify the default authentication type to use for ipmipower(8). If specified, will override the general option authentication-type above. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
Specify the default cipher suite id to use for ipmipower(8). If specified, will override the general option cipher-suite-id above. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.
Specify the default privilege type to use for ipmipower(8). If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.
Specify default workaround flags to use for ipmipower(8). If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmipower(8) manpage for available workarounds.
Specify if on-if-off functionality is enabled or disabled by default.
Specify if wait-until-on functionality is enabled or disabled by default.
Specify if wait-until-off functionality is enabled or disabled by default.
Specify OEM power type to be used.
Specify the default retransmission wait timeout length to use in milliseconds.
Specify the default retransmission backoff count to use for retransmissions.
Specify the default ping interval length to use in milliseconds.
Specify the default ping timeout length to use in milliseconds.
Specify the default ping packet count size to use.
Specify the default ping percent value to use.
Specify the default ping consecutive count value to use.

/etc/freeipmi//freeipmi.conf

Report bugs to <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.

Copyright © 2003-2015 FreeIPMI Core Team.

FreeIPMI is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

freeipmi(7), bmc-device(8), bmc-info(8), bmc-watchdog(8), ipmi-chassis(8), ipmi-config(8), ipmi-fru(8), ipmi-oem(8), ipmi-raw(8), ipmi-sel(8), ipmi-sensors(8), ipmiconsole(8), ipmipower(8)

http://www.gnu.org/software/freeipmi/

2021-10-31 FreeIPMI 1.6.6