Linux Certif

Toute la documentation sur la certification Linux LPI

bmc-config

NAME

bmc-config - manual page for bmc-config. BMC Config version 0.5.1

DESCRIPTION

Bmc-config is used to get and set BMC configuration parameters, such as the IP Address, Username, and Password. This configuration is required before most IPMI tools can be used to access a machine remotely.

The majority of configuration operations require ADMIN privilege when using bmc-config out-of-band. Although connecting via a user with ADMIN privileges is not required for out-of-band use, the vast majority of configuration options will not be retrieved or set.

See GENERAL USE below for a description on how most will want to use Bmc-config.

OPTIONS

-D, --driver-type=IPMIDRIVER

Specify the driver type to use instead of doing an auto selection. The currently available outofband drivers are LAN and LAN_2_0, which perform IPMI 1.5 and IPMI 2.0 respectively. The currently available inband drivers are KCS, SSIF, and OPENIPMI.

--no-probing

Do not probe IPMI devices for default settings.

--driver-address=DRIVER-ADDRESS

Specify the in-band driver address to be used instead of the probed value.

--driver-device=DEVICE

Specify the in-band driver device path to be used instead of the probed path.

--register-spacing=REGISTER-SPACING

Specify the in-band driver register spacing instead of the probed value.

-h, --hostname=IPMIHOST

Specify the remote host to communicate with.

-u, --username=USERNAME

Specify the username to use when authenticating with the remote host. If not specified, a null (i.e. anonymous) username is assumed. The user must have atleast ADMIN privileges in order for this tool to operate fully.

-p, --password=PASSWORD

Specify the password to use when authenticationg with the remote host. If not specified, a null password is assumed. Maximum password length is 16 for IPMI 1.5 and 20 for IPMI 2.0.

-P, --password-prompt

Prompt for password to avoid possibility of listing it in process lists.

-k, --k-g=K_G

Specify the K_g BMC key to use when authenticating with the remote host for IPMI 2.0. If not specified, a null key is assumed. To input the key in hexadecimal form, prefix the string with '0x'. E.g., the key 'abc' can be entered with the either the string 'abc' or the string '0x616263'

-K, --k-g-prompt

Prompt for k-g to avoid possibility of listing it in process lists.

--retry-timeout=MILLISECONDS

Specify the packet retransmission timeout in milliseconds. Defaults to 20000 milliseconds (20 seconds) if not specified.

--retry-timeout=MILLISECONDS

Specify the session timeout in milliseconds. Defaults to 1000 milliseconds (1 second) if not specified.

-a, --authentication-type=AUTHENTICATION-TYPE

Specify the IPMI 1.5 authentication type to use. The currently available authentication types are NONE, STRAIGHT_PASSWORD_KEY, MD2, and MD5. Defaults to MD5 if not specified.

-I, --cipher-suite-id=CIPHER-SUITE-ID

Specify the IPMI 2.0 cipher suite ID to use. The Cipher Suite ID identifies a set of authentication, integrity, and confidentiality algorithms to use for IPMI 2.0 communication. The authentication algorithm identifies the algorithm to use for session setup, the integrity algorithm identifies the algorithm to use for session packet signatures, and the confidentiality algorithm identifies the algorithm to use for payload encryption. Defaults to cipher suite ID 3 if not specified. The following cipher suite ids are currently supported:

0 - Authentication Algorithm = None; Integrity Algorithm = None; Confidentiality Algorithm = None

1 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm = None; Confidentiality Algorithm = None

2 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm = HMAC-SHA1-96; Confidentiality Algorithm = None

3 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm = HMAC-SHA1-96; Confidentiality Algorithm = AES-CBC-128 ." .sp ." 4 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm = HMAC-SHA1-96; Confidentiality Algorithm = xRC4-128 ." .sp ." 5 - Authentication Algorithm = HMAC-SHA1; Integrity Algorithm = HMAC-SHA1-96; Confidentiality Algorithm = xRC4-40

6 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm = None; Confidentiality Algorithm = None

7 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm = HMAC-MD5-128; Confidentiality Algorithm = None

8 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm = HMAC-MD5-128; Confidentiality Algorithm = AES-CBC-128 ." .sp ." 9 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm = HMAC-MD5-128; Confidentiality Algorithm = xRC4-128 ." .sp ." 10 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm = HMAC-MD5-128; Confidentiality Algorithm = xRC4-40

11 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm = MD5-128; Confidentiality Algorithm = None

12 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm = MD5-128; Confidentiality Algorithm = AES-CBC-128 ." .sp ." 13 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm = MD5-128; Confidentiality Algorithm = xRC4-128 ." .sp ." 14 - Authentication Algorithm = HMAC-MD5; Integrity Algorithm = MD5-128; Confidentiality Algorithm = xRC4-40

-l, --privilege-level=PRIVILEGE-LEVEL

Specify the privilege level to be used. The currently available privilege levels are USER, OPERATOR, and ADMIN. Defaults to ADMIN if not specified.

-W, --workaround-flags=WORKAROUNDS

Specify workarounds to vendor compliance issues. Multiple workarounds can be specified separated by commas. See WORKAROUNDS below for a list of available workarounds.

--debug

Turn on debugging.

-?, --help

Output a help list and exit.

--usage

Output a usage message and exit.

-V, --version

Output the program version and exit.

-o, --checkout

Fetch configuration information from the BMC.

-c, --commit

Update configuration information to the BMC from a config file or key pairs.

-d, --diff

Show differences between the BMC and a config file or key pairs.

-f FILENAME, --filename=FILENAME

Specify a BMC config file for BMC checkout/commit/diff.

-e "KEY=VALUE", --key-pair="KEY=VALUE"

Specify KEY=VALUE pairs for checkout/commit/diff. This option can be used multiple times. On commit, any KEY=VALUE pairs will overwrite any pairs specified in a file with --filename.

-S "SECTION", --section="SECTION"

Specify a SECTION for checkout. This option can be used multiple times.

-L, --listsections

List available sections for checkout.

-v, --verbose

Print additional detailed information.

GENERAL USE

Most users of bmc-config will want to:

A) Run bmc-config with --checkout to get a copy of the current BMC configuration and store it in a file. The standard output can be redirected to a file or a file can be specified with the --filename option.

B) Edit the configuration file with an editor. Comments throughout the file will give instructions on how to configure the fields. The bmc-config.conf(5) provides additional information on the meaning of different fields.

C) Commit the configuration back to the BMC using the --commit option and specifying the configuration file with the --filename option.

For users with large clusters or sets of nodes, you may wish to use the same configuration file for all nodes. The one problem with this is that the IP address and MAC address will be different on each node in your cluster and thus can't be configured through the same config file. The IP address and MAC address in your config file may be overwritten on the command line using --key-pair option. The following example could be used in a script to configure each node in a cluster with the same BMC config file. The script only needs to determine the correct IP address and MAC address to use.

# bmc-config --commit -k Lan_Conf:Ip_Address=$MY_IP -k Lan_Conf:Mac_Address=$MY_MAC -f my_bmc.conf

GENERAL TROUBLESHOOTING

Most often, IPMI over LAN problems involve a misconfiguration of the remote machine's BMC. Double check to make sure the following are configured properly in the remote machine's BMC: IP address, MAC address, subnet mask, username, user enablement, user privilege, password, LAN privilege, LAN enablement, and allowed authentication type(s). For IPMI 2.0 connections, double check to make sure the cipher suite privilege(s) and K_g key are configured properly. The bmc-config(8) tool can be used to check and/or change these configuration settings.

The following are common issues for given error messages:

"username invalid" - The username entered (or a NULL username if none was entered) is not available on the remote machine. Please try a different username. It may also be possible the remote BMC's username configuration is incorrect.

"password invalid" - The password entered (or a NULL password if none was entered) is not correct. Please try a different password. It may also be possible the password for the user is not correctly configured on the remote BMC.

"password verification timeout" - The password entered is likely not correct. Please try a different password. It may also be possible the password for the user is not correctly configured on the remote BMC.

"k_g invalid" - The K_g key entered (or a NULL K_g key if none was entered) is not correct. Please try a different K_g key. It may also be possible the K_g key is not correctly configured on the remote BMC.

"privilege level insufficient" - An IPMI command requires a higher user privilege than the one authenticated with. Please try to authenticate with a higher privilege. This may require authenticating to a different user which has a higher maximum privilege.

"privilege level cannot be obtained for this user" - The privilege level you are attempting to authenticate with is higher than the maximum allowed for this user. Please try again with a lower privilege. It may also be possible the maximum privilege level allowed for a user is not configured properly on the remote BMC.

"authentication type unavailable for attempted privilege level" - The authentication type you wish to authenticate with is not available for this privilege level. Please try again with an alternate authentication type or alternate privilege level. It may also be possible the available authentication types you can authenticate with are not correctly configured on the remote BMC.

"cipher suite id unavailable" - The cipher suite id you wish to authenticate with is not available on the remote BMC. Please try again with an alternate cipher suite id. It may also be possible the available cipher suite ids are not correctly configured on the remote BMC.

"ipmi 2.0 unavailable" - IPMI 2.0 was not discovered on the remote machine. Please try to use IPMI 1.5 instead.

"session timeout" - The IPMI session has timed out. Please reconnect.

If IPMI over LAN continually times out, you may wish to increase the retransmission timeout. Some remote BMCs are considerably slower than others.

Please see WORKAROUNDS below to also if there are any vendor specific bugs that have been discovered and worked around.

WORKAROUNDS

With so many different vendors implementing their own IPMI solutions, different vendors may implement their IPMI protocols incorrectly. The following lists the handful of compliance issues discovered and the workarounds currently supported.

When possible, workarounds have been implemented so they will be transparent to the user. However, some will require the user to specify a workaround be used via the -W option. The workarounds listed below are listed in the order of their implementation. Therefore, workarounds implemented earlier may work for other vendors.

The hardware listed below only indicates the hardware that a problem was discovered on. Newer versions hardware may fix the problems indicated below. Similar machines from vendors may or may not exhibit the same problems.

Intel SR870BN4: BMCs would not respond to retransmissions of a Get Session Challenge Request if a previous Get Session Challenge response was lost. Resolved by sending retransmitted Get Session Challenge requests from a different source port. Automatically handled.

Tyan S2882 with m3289 BMC: After the IPMI session is brought up, packet responses return empty session IDs to the client. In order to work around this issue, the "idzero" workaround must be specified. The option will allow empty session IDs to be accepted by the client. This problem is apparently fixed in later firmware releases.

Dell PowerEdge 2850,SC1425: When Per-Message Authentication is disabled, packet responses contain non-null authentication data (when it should in fact be null). In order to work around this issue, the "unexpectedauth" workaround must be specified. The option will allow unexpected non-null authcodes to be checked as though they were expected. This compliance bug is confirmed to be fixed on newer firmware.

IBM eServer 325: The remote BMC will advertise that Per Message Authentication is disabled, but actually require it for the protocol. In order to work around this issue, the "forcepermsg" workaround must be specified. The option will force Per Message Authentication to be used no matter what is advertised by the remote BMC.

Supermicro H8QME with SIMSO daughter card: The remote BMC will advertise that Per Message Authentication is disabled, but actually require it for the protocol. Automatically handled.

Asus P5M2/P5MT-R: The motherboard does not properly report username capabilities and or K_g status, leading to invalid username or K_g errors. In order to work around this issue, the "authcap" workaround must be specified.

Intel SE7520AF2 with Intel Server Management Module (Professional Edition): There are a number of Intel IPMI 2.0 bugs which can be worked around by specifying the "intel20" workaround. The workarounds include padding of usernames, automatic acceptance of a RAKP 4 response integrity check when using the integrity algorithm MD5-128, and password truncation if the authentication algorithm is HMAC-MD5-128.

Supermicro H8QME with SIMSO daughter card: There are several Supermicro IPMI 2.0 bugs on early firmware revisions which can be worked around using the "supermicro20" workaround. These compliance bugs are confirmed to be fixed on newer firmware.

Sun Fire 4100: There are several IPMI 2.0 bugs which can be worked around by specifying the "sun20" workaround. The workarounds include handling invalid lengthed hash keys and invalid cipher suite records.

EXAMPLES

# bmc-config --checkout

Output all BMC configuration information to the console.

# bmc-config --checkout --filename=bmc-data1.conf

Store all BMC configuration information in bmc-data1.conf.

# bmc-config --diff -f bmc-data2.conf

Show all difference between the current BMC configuration and the bmc-data2.conf file.

# bmc-config --diff --key-pair=lan_conf_misc:gratuitous_arp_interval=8

Show difference with the current BMC and the 'lan_conf_misc:gratuitous_arp_interval' of value '8'.

# bmc-config --commit -f bmc-data1.conf

Commit all configuration values from bmc-data1.conf file to the BMC.

# bmc-config --commit --key-pair=lan_conf_misc:gratuitous_arp_interval=4

Commit key 'lan_conf_misc:gratuitous_arp_interval' of value '4' to the BMC.

# bmc-config --commit -f bmc-data-updt.conf --key-pair=lan_conf_misc:gratuitous_arp_interval=4

Commit all configuration values from bmc-data-updt.conf and key 'lan_conf_misc:gratuitous_arp_interval' of value '4' to the BMC.

REPORTING BUGS

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

COPYRIGHT

Copyright © 2003,04,05 FreeIPMI Core Team. This program is free software; you may redistribute it under the terms of the GNU General Public License. This program has absolutely no warranty.

SEE ALSO

bmc-config.conf(5)