[Go to CFHT Home Page] Man Pages
Back to Software Index  BORDER=0Manpage Top Level
   /* Copyright (C) 1991-2014 Free Software Foundation, Inc. This file is part of the GNU C Library.

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

The GNU C Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with the GNU C Library; if not, see
<http://www.gnu.org/licenses/ >. */
/* This header is separate from features.h so that the compiler can include it implicitly at the start of every compilation. It must
not itself include <features.h> or any other header that includes
<features.h> because the implicit include comes before any feature
test macros that may be defined in a source file before it first
explicitly includes a system header. GCC knows the name of this
header in order to preinclude it. */
/* glibc’s intent is to support the IEC 559 math functionality, real and complex. If the GCC (4.9 and later) predefined macros
specifying compiler intent are available, use them to determine
whether the overall intent is to support these features; otherwise,
presume an older compiler has intent to support these features and
define these macros by default. */
/* wchar_t uses ISO/IEC 10646 (2nd ed., published 2011-03-15) / Unicode 6.0. */
/* We do not support C11 <threads.h>. */ FREEIPMI(5) manual page Table of Contents

Name

freeipmi.conf - specify default values to FreeIPMI

Description

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-config(8) , bmc-device(8) , bmc-info(8) , bmc-watchdog(8) , ipmi-chassis(8) , ipmi-chassis-config(8) , ipmi-fru(8) , ipmi-oem(8) , ipmi-pef-config(8) , ipmi-pet(8) , ipmi-raw(8) , ipmi-sel(8) , ipmi-sensors(8) , ipmi-sensors-config(8) , ipmiconsole(8) , and ipmipower(8) .

By default, the configuration file is stored at /usr/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.

Format

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.

General Options

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).
driver-type IPMIDRIVER
Specify the default driver type to use.
disable-auto-probe ENABLE|DISABLE
Specify if IPMI devices should be probed for default settings.
driver-address DRIVER-ADDRESS
Specify the default in-band driver address to use.
driver-device DEVICE
Specify the default in-band driver device path to use.
register-spacing REGISTER-SPACING
Specify the default in-band driver register spacing to use.
target-channel-number CHANNEL-NUMBERFR
Specify the default in-band driver target channel number.
target-slave-address SLAVE-ADDRESSFR
Specify the default in-band driver target slave address.
username USERNAME
Specify the default username to use.
password PASSWORD
Specify the default password to use.
k_g str
Specify the default BMC key (K_g) to use. Prefix with ’0x’ to enter the key in hex.
session-timeout MILLISECONDS
Specify the default session timeout length to use in milliseconds.
retransmission-timeout MILLISECONDS
Specify the default retransmission timeout length to use in milliseconds.
authentication-type AUTHENTICATION-TYPE
Specify the default authentication type to use. The following authentication types are supported: NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5.
cipher-suite-id CIPHER-SUITE-ID
Specify the default cipher suite id to use. The following cipher suite ids are supported: 0, 1, 2, 3, 6, 7, 8, 11, 12.
privilege-level PRIVILEGE-LEVEL
Specify the default privilege type to use. The following privilege levels are supported: USER, OPERATOR, ADMIN.
workaround-flags WORKAROUNDS
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, skipchecks, assumesystemevent, discretereading, ignorescanningdisabled, assumebmcowner, ignoreauthcode, slowcommit, veryslowcommit, solchannelassumelanchannel, ignorestateflag, malformedack.

Sdr Options

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

Hostranged Options

The following options are specific to tools that support hostranged output. They will be ignored by all other tools.
buffer-output ENABLE|DISABLE
Specify if hostranged output should be buffered by default.
consolidate-output ENABLE|DISABLE
Specify if hostranged output should be consolidated by default.
fanout COUNT
Specify the default multiple host fanout to use.
eliminate ENABLE|DISABLE
Specify if undetected hosts should be eliminated by default.
always-prefix ENABLE|DISABLE
Specify if output should be always prefixed by default.

Bmc-config Options

The following options are specific to bmc-config(8) . They will be ignored by other tools.
bmc-config-username USERNAME
Specify the default username to use for bmc-config(8) . If specified, will override the general option username above.
bmc-config-password PASSWORD
Specify the default password to use for bmc-config(8) . If specified, will override the general option password above.
bmc-config-k_g str
Specify the default BMC key (K_g) to use for bmc-config(8) . If specified, will override the general option k_g above. Prefix with ’0x’ to enter the key in hex.
bmc-config-authentication-type AUTHENTICATION-TYPE
Specify the default authentication type to use for bmc-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.
bmc-config-cipher-suite-id CIPHER-SUITE-ID
Specify the default cipher suite id to use for bmc-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.
bmc-config-privilege-level PRIVILEGE-LEVEL
Specify the default privilege type to use for bmc-config(8) . If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.
bmc-config-workaround-flags WORKAROUNDS
Specify default workaround flags to use for bmc-config(8) . If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see bmc-config(8) manpage for available workarounds.
bmc-config-verbose-count COUNT
Specify default verbose count to use for bmc-config(8) .

Bmc-device Options

The following options are specific to bmc-device(8) . They will be ignored by other tools.
bmc-device-username USERNAME
Specify the default username to use for bmc-device(8) . If specified, will override the general option username above.
bmc-device-password PASSWORD
Specify the default password to use for bmc-device(8) . If specified, will override the general option password above.
bmc-device-k_g str
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.
bmc-device-authentication-type AUTHENTICATION-TYPE
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.
bmc-device-cipher-suite-id CIPHER-SUITE-ID
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.
bmc-device-privilege-level PRIVILEGE-LEVEL
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.
bmc-device-workaround-flags WORKAROUNDS
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.

Bmc-info Options

The following options are specific to bmc-info(8) . They will be ignored by other tools.
bmc-info-username USERNAME
Specify the default username to use for bmc-info(8) . If specified, will override the general option username above.
bmc-info-password PASSWORD
Specify the default password to use for bmc-info(8) . If specified, will override the general option password above.
bmc-info-k_g str
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.
bmc-info-authentication-type AUTHENTICATION-TYPE
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.
bmc-info-cipher-suite-id CIPHER-SUITE-ID
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.
bmc-info-privilege-level PRIVILEGE-LEVEL
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.
bmc-info-workaround-flags WORKAROUNDS
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.
bmc-info-interpret-oem-data ENABLE|DISABLE
Specify if bmc-info should attempt to interpret OEM data by default or not.

Bmc-watchdog Options

The following options are specific to bmc-watchdog(8) . They will be ignored by other tools.
bmc-watchdog-workaround-flags WORKAROUNDS
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.
bmc-watchdog-verbose-logging ENABLE|DISABLE
Specify if logging will be verbose by default.
bmc-watchdog-no-logging ENABLE|DISABLE
Specify if logging will be disabled by default.

Ipmi-chassis Options

The following options are specific to ipmi-chassis(8) . They will be ignored by other tools.
ipmi-chassis-username USERNAME
Specify the default username to use for ipmi-chassis(8) . If specified, will override the general option username above.
ipmi-chassis-password PASSWORD
Specify the default password to use for ipmi-chassis(8) . If specified, will override the general option password above.
ipmi-chassis-k_g str
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.
ipmi-chassis-authentication-type AUTHENTICATION-TYPE
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.
ipmi-chassis-cipher-suite-id CIPHER-SUITE-ID
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.
ipmi-chassis-privilege-level PRIVILEGE-LEVEL
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.
ipmi-chassis-workaround-flags WORKAROUNDS
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.

Ipmi-chassis-config Options

The following options are specific to ipmi-chassis-config(8) . They will be ignored by other tools.
ipmi-chassis-config-username USERNAME
Specify the default username to use for ipmi-chassis-config(8) . If specified, will override the general option username above.
ipmi-chassis-config-password PASSWORD
Specify the default password to use for ipmi-chassis-config(8) . If specified, will override the general option password above.
ipmi-chassis-config-k_g str
Specify the default BMC key (K_g) to use for ipmi-chassis-config(8) . If specified, will override the general option k_g above. Prefix with ’0x’ to enter the key in hex.
ipmi-chassis-config-authentication-type AUTHENTICATION-TYPE
Specify the default authentication type to use for ipmi-chassis-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.
ipmi-chassis-config-cipher-suite-id CIPHER-SUITE-ID
Specify the default cipher suite id to use for ipmi-chassis-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.
ipmi-chassis-config-privilege-level PRIVILEGE-LEVEL
Specify the default privilege type to use for ipmi-chassis-config(8) . If specified, will override the general option privilege-level above. The following privilege levels are supported: USER, OPERATOR, ADMIN.
ipmi-chassis-config-workaround-flags WORKAROUNDS
Specify default workaround flags to use for ipmi-chassis-config(8) . If specified, will override the general options workaround-flags above. Multiple workarounds can be specified separated by whitespace. Please see ipmi-chassis-config(8) manpage for available workarounds.
ipmi-chassis-config-verbose-count COUNT
Specify default verbose count to use for ipmi-chassis-config(8) .

Ipmi-dcmi Options

The following options are specific to ipmi-dcmi(8) . They will be ignored by other tools.
ipmi-dcmi-username USERNAME
Specify the default username to use for ipmi-dcmi(8) . If specified, will override the general option username above.
ipmi-dcmi-password PASSWORD
Specify the default password to use for ipmi-dcmi(8) . If specified, will override the general option password above.
ipmi-dcmi-k_g str
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.
ipmi-dcmi-authentication-type AUTHENTICATION-TYPE
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.
ipmi-dcmi-cipher-suite-id CIPHER-SUITE-ID
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.
ipmi-dcmi-privilege-level PRIVILEGE-LEVEL
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.
ipmi-dcmi-workaround-flags WORKAROUNDS
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.
ipmi-dcmi-interpret-oem-data ENABLE|DISABLE
Specify if ipmi-dcmi should attempt to interpret OEM data by default or not.

Ipmi-fru Options

The following options are specific to ipmi-fru(8) . They will be ignored by other tools.
ipmi-fru-username USERNAME
Specify the default username to use for ipmi-fru(8) . If specified, will override the general option username above.
ipmi-fru-password PASSWORD
Specify the default password to use for ipmi-fru(8) . If specified, will override the general option password above.
ipmi-fru-k_g str
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.
ipmi-fru-authentication-type AUTHENTICATION-TYPE
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.
ipmi-fru-cipher-suite-id CIPHER-SUITE-ID
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.
ipmi-fru-privilege-level PRIVILEGE-LEVEL
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.
ipmi-fru-workaround-flags WORKAROUNDS
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.
ipmi-fru-verbose-count COUNT
Specify default verbose count to use for ipmi-fru(8) .

Table of Contents