ipmipower

title: ipmipower(8)

summary: IPMI power control utility

text:
# ipmipower(8)

## NAME
ipmipower - IPMI power control utility

## SYNOPSIS
ipmipower [OPTION...]

## DESCRIPTION
Ipmipower allows users to remotely power on, off, cycle, hard reset, get a power status query, perform a pulse diagnostic interrupt, or initiate a soft-shutdown of the OS via ACPI through the IPMI over LAN protocol.

When a power command (--on, --off, --cycle, --reset, --stat, --pulse, or --soft) is specified on the command line, Ipmipower will attempt to run the power command on all hostnames listed on the command line then exit.

If no power commands are specified on the command line, ipmipower will run in interactive mode. Interactive mode gives the user a command line interface to enter various commands. Details of the interactive command line interface can be found below under INTERACTIVE COMMANDS.

Listed below are general IPMI options, tool specific options, trouble shooting information, workaround information, examples, and known issues. For a general introduction to FreeIPMI please see freeipmi(7).

## GENERAL OPTIONS
The following options are general options for configuring IPMI communication and executing general tool commands.

-D IPMIDRIVER, --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.

-h IPMIHOST1,IPMIHOST2,..., --hostname=IPMIHOST1[:PORT],IPMIHOST2[:PORT],...

Specify the remote host(s) to communicate with. Multiple hostnames may be separated by comma or may be specified in a range format; see HOSTRANGED SUPPORT below. An optional port can be specified with each host, which may be useful in port forwarding or similar situations. If specifying an IPv6 address and port, use the format [ADDRESS]:PORT.

-u USERNAME, --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 OPERATOR privileges to run the --on, --off, --reset, --cycle, --pulse, or --soft power control commands. The user must have atleast USER privileges to determine the power status of the machine through --stat.

-p PASSWORD, --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=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.

--session-timeout=MILLISECONDS

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

--retransmission-timeout=MILLISECONDS

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

-a AUTHENTICATION-TYPE, --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=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

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

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

15 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm = None; Confidentiality Algorithm = None

16 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm = HMAC_SHA256_128; Confidentiality Algorithm = None

17 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm = HMAC_SHA256_128; Confidentiality Algorithm = AES-CBC-128

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

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

--config-file=FILE

Specify an alternate configuration file.

-W WORKAROUNDS, --workaround-flags=WORKAROUNDS

Specify workarounds to vendor compliance issues. Multiple workarounds can be specified separated by commas. A special command line flag of "none", will indicate no workarounds (may be useful for overriding configured defaults). 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.

## IPMIPOWER OPTIONS
The following options are specific to ipmipower.

-n, --on

Power on the target hosts.

-f, --off

Power off the target hosts.

-c, --cycle

Power cycle the target hosts.

-r, --reset

Reset the target hosts.

-s, --stat

Get power status of the target hosts.

--pulse

Send power diagnostic interrupt to target hosts.

--soft

Initiate a soft-shutdown of the OS via ACPI.

--on-if-off

The IPMI specification does not require the power cycle or hard reset commands to turn on a machine that is currently powered off. This option will force ipmipower to issue a power on command instead of a power cycle or hard reset command if the remote machine's power is currently off.

--wait-until-on

The IPMI specification allows power on commands to return prior to the power on actually taking place. This option will force ipmipower to regularly query the remote BMC and return only after the machine has powered on.

--wait-until-off

The IPMI specification allows power off commands to return prior the power off actually taking place. This option will force ipmipower to regularly query the remote BMC and return only after the machine has powered off.

--oem-power-type=OEM-POWER-TYPE

This option informs ipmipower to initiate power control operations via an IPMI OEM specific power control extension. The currently available POWERTYPEs are NONE and C410X. Please see OEM POWER EXTENSIONS below for additional information.

## IPMIPOWER ADVANCED NETWORK OPTIONS
The following options are used to change the networking behavior of ipmipower.

--retransmission-wait-timeout=MILLISECONDS

Specify the retransmission wait timeout length in milliseconds. The retransmission wait timeout is similar to the retransmission timeout above, but is used specifically for power completion verification with the --wait-until-on and --wait-until-off options. Defaults to 500 milliseconds (0.5 seconds).

--retransmission-backoff-count=COUNT

Specify the retransmission backoff count for retransmissions. After ever COUNT retransmissions, the retransmission timeout length will be increased by another factor. Defaults to 8.

--ping-interval=MILLISECONDS

Specify the ping interval length in milliseconds. When running in interactive mode, RMCP (Remote Management Control Protocol) discovery messages will be sent to all configured remote hosts every MILLISECONDS to confirm their support of IPMI. Power commands cannot be sent to a host until it is discovered (or re-discovered if previously lost). Defaults to 5000 milliseconds (5 seconds). Ping discovery messages can be disabled by setting this value to 0. RMCP ping discovery messages are automatically disabled in non-interactive mode.

--ping-timeout=MILLISECONDS

Specify the ping timeout length in milliseconds. When running in interactive mode, RMCP (Remote Management Control Protocol) messages discovery will be sent to all configured remote hosts to confirm their support of IPMI. A remote host is considered undiscovered if the host does not respond in MILLISECONDS time. Defaults to 30000 milliseconds (30 seconds). The ping timeout cannot be larger than the ping interval.

--ping-packet-count=COUNT

Specify the ping packet count size. Defaults to 10. See the --ping-percent-fR option below for more information on this option.

--ping-percent=PERCENT

Specify the ping percent value. Defaults to 50. Since IPMI is based on UDP, it is difficult for ipmipower to distinguish between a missing machine and a bad (or heavily loaded) network connection in interactive mode. when running in interactive mode. For example, suppose a link consistently drops 80% of the packets to a particular machine. The power control operation may have difficulty completing, although a recent pong response from RMCP makes ipmipower believe the machine is up and functioning properly. The ping packet count and percent options are used to alleviate this problem. Ipmipower will monitor RMCP ping packets in packet count chunks. If ipmipower does not receive a response to greater than ping percent of those packets, ipmipower will assume the link to this node is bad and will not send power control operations to that node until the connection is determined to be reliable. This heuristic can be disabled by setting either the ping packet count or ping percent to 0. This feature is not used if ping interval is set to 0.

--ping-consec-count=COUNT

Specify the ping consecutive count. This is another heuristic used to determine if a node should be considered discovered, undiscovered, or with a bad connection. If a valid RMCP pong response was received for the last COUNT ping packets, a node will be considered discovered, regardless of other heuristics listed above. Defaults to 5. This heuristic can be disabled by setting this value to 0. This feature is not used if other ping features described above are disabled.

## HOSTRANGED OPTIONS
The following options manipulate hostranged output. See HOSTRANGED SUPPORT below for additional information on hostranges.

-B, --buffer-output

Buffer hostranged output. For each node, buffer standard output until the node has completed its IPMI operation. When specifying this option, data may appear to output slower to the user since the the entire IPMI operation must complete before any data can be output. See HOSTRANGED SUPPORT below for additional information.

-C, --consolidate-output

Consolidate hostranged output. The complete standard output from every node specified will be consolidated so that nodes with identical output are not output twice. A header will list those nodes with the consolidated output. When this option is specified, no output can be seen until the IPMI operations to all nodes has completed. If the user breaks out of the program early, all currently consolidated output will be dumped. See HOSTRANGED SUPPORT below for additional information.

-F NUM, --fanout=NUM

Specify multiple host fanout. Indicates the maximum number of power control operations that can be executed in parallel.

-E, --eliminate

Eliminate hosts determined as undetected by ipmidetect. This attempts to remove the common issue of hostranged execution timing out due to several nodes being removed from service in a large cluster. The ipmidetectd daemon must be running on the node executing the command.

--always-prefix

Always prefix output, even if only one host is specified or communicating in-band. This option is primarily useful for scripting purposes. Option will be ignored if specified with the -C option.

## INTERACTIVE COMMANDS
Ipmipower provides the following interactive commands at the ipmipower> prompt. Before any power commands (on, off, cycle, reset, stat, pulse, or soft) can be used, hostnames must be configured into ipmipower, either through the command prompt or the hostname command below. The parameters and options to the commands below mirror their appropriate command line options.

hostname [IPMIHOST(s)]

Specify a new set of hosts. No input to unconfigure all hosts.

username [USERNAME]

Specify a new username. No input for null username.

password [PASSWORD]

Specify a new password. No input for null password.

k_g [K_G]

Specify a new K_g BMC Key. No input for null key. Prefix with '0x' to enter a key in hexadecimal

ipmi-version IPMIVERSION

Specify the ipmi version to use.

session-timeout MILLISECONDS

Specify a new session timeout length.

retransmission-timeout MILLISECONDS

Specify a new retransmiision timeout length.

authentication-type AUTHENTICATION-TYPE

Specify the authentication type to use.

cipher-suite-id CIPHER-SUITE-ID

Specify the cipher suite id to use.

privilege-level PRIVILEGE-LEVEL

Specify the privilege level to use.

workaround-flags WORKAROUNDS

Specify workaround flags.

debug [on|off]

Toggle debug output.

on [IPMIHOST(s)]

Turn on all configured hosts or specified hosts.

off [IPMIHOST(s)]

Turn off all configured hosts or specified hosts.

cycle [IPMIHOST(s)]

Power cycle all configured hosts or specified hosts.

reset [IPMIHOST(s)]

Reset all configured hosts or specified hosts.

stat [IPMIHOST(s)]

Query power status for all configured hosts or specified hosts.

pulse [IPMIHOST(s)]

Pulse diagnostic interrupt all configured hosts or specified hosts.

soft [IPMIHOST(s)]

Initiate a soft-shutdown for all configured hosts or specified hosts.

identify-on [IPMIHOST(s)]

Turn on physical system identification.

identify-off [IPMIHOST(s)]

Turn off physical system identification.

identify-status [IPMIHOST(s)]

Query physical system identification status.

on-if-off [on|off]

Toggle on-if-off functionality.

wait-until-on [on|off]

Toggle wait-until-on functionality.

wait-until-off [on|off]

Toggle wait-until-off functionality.

retransmission-wait-timeout MILLISECONDS

Specify a new retransmission wait timeout length.

retransmission-backoff-count COUNT

Specify a new retransmission backoff count.

ping-interval MILLISECONDS

Specify a new ping interval length.

ping-timeout MILLISECONDS

Specify a new ping timeout length.

ping-packet-count COUNT

Specify a new ping packet count.

ping-percent PERCENT

Specify a new ping percent.

ping-consec-count COUNT

Specify a new ping consec count.

buffer-output [on|off]

Toggle buffer-output functionality.

consolidate-output [on|off]

Toggle consolidate-output functionality.

fanout COUNT

Specify a fanout.

always-prefix [on|off]

Toggle always-prefix functionality.

help

Output help menu.

version

Output version.

config

Output the current configuration.

quit

Quit program.

## OEM POWER EXTENSIONS
Some motherboards include IPMI OEM extensions for alternate power control mechanisms. For example, these power control mechanisms may allow you to power control a sub-device within the system rather than the entire system itself.

By specifying an OEM power type via --oem-power-type on the command line or freeipmi.conf(5), you can instruct ipmipower to execute alternate power control implementations over the standard ones. Depending on the OEM extension, some power control commands may no longer be available. For example, an OEM extension may allow on but not cycle. Specific ipmipower options may not longer function either.

Some OEM extensions may require additional arguments for their power control action, such as a sub-device identifier. Additional arguments can be provided by appending a plus sign ('+') and the extra information to the end of the hostname. This can be done on the command line or in interactive mode. For example, the hostname mynode+18 would indicate the power control operation should be sent to the host mynode, and 18 is the identifier of a possible sub-device to be power controlled. The --consolidate-output option is commonly disabled when using an OEM power control that requires extra arguments.

Because OEM power control may involve subtypes, it is possible a user may wish to power control multiple sub-devices on the same host. For example, you might specify the hosts mynode+1,mynode+2, indicating to power control subdevice 1 and 2 on mynode. Because many BMCs cannot handle multiple IPMI sessions, power control operations to the same host will be serialized internally by ipmipower.

The following are the current OEM power types available, along with information on the systems they work with and the power control operations available.

C410X

This OEM power type supports the power control of PCIe slots on Dell Poweredge C410x systems. It supports on, off, and stat. The PCIe slot number ranges from 1-16 and must always be specified when attempting to power control with this extension. For example, the hostname mynode+2 would inform ipmipower to operate on slot number 2 on mynode. The C410x appears to have difficulty handling new slot power control requests until prior ones have completed. Users may wish to strongly consider using the --wait-until-on and --wait-until-off options if multiple slots will be power controlled in short succession.

NONE

This informs ipmipower that no OEM power type extension is to be used and standard IPMI power control is used. This is the default.

## HOSTRANGED SUPPORT
Multiple hosts can be input either as an explicit comma separated lists of hosts or a range of hostnames in the general form: prefix[n-m,l-k,...], where n < m and l < k, etc. The later form should not be confused with regular expression character classes (also denoted by []). For example, foo[19] does not represent foo1 or foo9, but rather represents a degenerate range: foo19.

This range syntax is meant only as a convenience on clusters with a prefixNN naming convention and specification of ranges should not be considered necessary -- the list foo1,foo9 could be specified as such, or by the range foo[1,9].

Some examples of range usage follow:

```
    foo[01-05] instead of foo01,foo02,foo03,foo04,foo05

    foo[7,9-10] instead of foo7,foo9,foo10

    foo[0-3] instead of foo0,foo1,foo2,foo3
```

As a reminder to the reader, some shells will interpret brackets ([ and ]) for pattern matching. Depending on your shell, it may be necessary to enclose ranged lists within quotes.

When multiple hosts are specified by the user, a socket will be created for each host and polled on, effectively allowing communication to all hosts in parallel. This will allow communication to large numbers of nodes far more quickly than if done in serial. The -F option can configure the number of nodes that can be communicated with in parallel at the same time.

By default, standard output from each node specified will be output with the hostname prepended to each line. Although this output is readable in many situations, it may be difficult to read in other situations. For example, output from multiple nodes may be mixed together. The -B and -C options can be used to change this default.

## EXAMPLES
Determine the power status of foo[0-2] with null username and password

ipmipower -h foo[0-2] --stat

Determine the power status of foo[0-2] with non-null username and password

ipmipower -h foo[0-2] -u foo -p bar --stat

Hard reset nodes foo[0-2] with non-null username and password

ipmipower -h foo[0-2] -u foo -p bar --reset

## GENERAL TROUBLESHOOTING
Most often, IPMI problems are due to configuration problems.

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 ipmi-config(8) tool can be used to check and/or change these configuration settings.

In addition to the troubleshooting tips below, please see WORKAROUNDS below to also if there are any vendor specific bugs that have been discovered and worked around.

Listed below are many of the common issues for error messages. For additional support, please e-mail the <freeipmi-users@gnu.org> mailing list.

"username invalid" - The username entered (or a NULL username if none was entered) is not available on the remote machine. 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. It may also be possible the password for the user is not correctly configured on the remote BMC.

"password verification timeout" - Password verification has timed out. A "password invalid" error (described above) or a generic "session timeout" (described below) occurred. During this point in the protocol it cannot be differentiated which occurred.

"k_g invalid" - The K_g key entered (or a NULL K_g key if none was entered) is not correct. 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.

"connection timeout" - Initial IPMI communication failed. A number of potential errors are possible, including an invalid hostname specified, an IPMI IP address cannot be resolved, IPMI is not enabled on the remote server, the network connection is bad, etc. Please verify configuration and connectivity.

"session timeout" - The IPMI session has timed out. Please reconnect. If this error occurs often, you may wish to increase the retransmission timeout. Some remote BMCs are considerably slower than others.

"internal IPMI error" - An IPMI error has occurred that FreeIPMI does not know how to handle. Please e-mail <freeipmi-users@gnu.org> to report the issue.

## IPMIPOWER TROUBLESHOOTING
When powering on a powered off machine, the client must have a means by which to resolve the MAC address of the remote machine's ethernet card. While most modern IPMI solutions support the ability to ARP and resolve addresses when the machine is powered off, some older machines do not. This is typically solved in one of two ways:

1) Enable gratuitous ARPs on the remote machine. The remote machine will send out a gratuitous ARP, which advertises the ethernet IP and MAC address so that other machines on the network this information their local ARP cache. For large clusters, this method is not recommended since gratuitous ARPs can flood the network with unnecessary traffic.

2) Permanently store the remote machine's MAC address in the local ARP cache. This is the more common approach on large clusters.

Other methods are listed in the IPMI specification.

## WORKAROUNDS
With so many different vendors implementing their own IPMI solutions, different vendors may implement their IPMI protocols incorrectly. The following describes a number of workarounds currently available to handle discovered compliance issues. 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 hardware listed below may only indicate the hardware that a problem was discovered on. Newer versions of hardware may fix the problems indicated below. Similar machines from vendors may or may not exhibit the same problems. Different vendors may license their firmware from the same IPMI firmware developer, so it may be worthwhile to try workarounds listed below even if your motherboard is not listed.

If you believe your hardware has an additional compliance issue that needs a workaround to be implemented, please contact the FreeIPMI maintainers on <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.

authcap - This workaround flag will skip early checks for username capabilities, authentication capabilities, and K_g support and allow IPMI authentication to succeed. It works around multiple issues in which the remote system does not properly report username capabilities, authentication capabilities, or K_g status. Those hitting this issue may see "username invalid", "authentication type unavailable for attempted privilege level", or "k_g invalid" errors. Issue observed on Asus P5M2/P5MT-R/RS162-E4/RX4, Intel SR1520ML/X38ML, and Sun Fire 2200/4150/4450 with ELOM.

nochecksumcheck - This workaround flag will tell FreeIPMI to not check the checksums returned from IPMI command responses. It works around systems that return invalid checksums due to implementation errors, but the packet is otherwise valid. Users are cautioned on the use of this option, as it removes validation of packet integrity in a number of circumstances. However, it is unlikely to be an issue in most situations. Those hitting this issue may see "connection timeout", "session timeout", or "password verification timeout" errors. On IPMI 1.5 connections, the "noauthcodecheck" workaround may also needed too. Issue observed on Supermicro X9SCM-iiF, Supermicro X9DRi-F, and Supermicro X9DRFR.

idzero - This workaround flag will allow empty session IDs to be accepted by the client. It works around IPMI sessions that report empty session IDs to the client. Those hitting this issue may see "session timeout" errors. Issue observed on Tyan S2882 with M3289 BMC.

unexpectedauth - This workaround flag will allow unexpected non-null authcodes to be checked as though they were expected. It works around an issue when packets contain non-null authentication data when they should be null due to disabled per-message authentication. Those hitting this issue may see "session timeout" errors. Issue observed on Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.

forcepermsg - This workaround flag will force per-message authentication to be used no matter what is advertised by the remote system. It works around an issue when per-message authentication is advertised as disabled on the remote system, but it is actually required for the protocol. Those hitting this issue may see "session timeout" errors. Issue observed on IBM eServer 325.

endianseq - This workaround flag will flip the endian of the session sequence numbers to allow the session to continue properly. It works around IPMI 1.5 session sequence numbers that are the wrong endian. Those hitting this issue may see "session timeout" errors. Issue observed on some Sun ILOM 1.0/2.0 (depends on service processor endian).

noauthcodecheck - This workaround flag will tell FreeIPMI to not check the authentication codes returned from IPMI 1.5 command responses. It works around systems that return invalid authentication codes due to hashing or implementation errors. Users are cautioned on the use of this option, as it removes an authentication check verifying the validity of a packet. However, in most organizations, this is unlikely to be a security issue. Those hitting this issue may see "connection timeout", "session timeout", or "password verification timeout" errors. Issue observed on Xyratex FB-H8-SRAY, Intel Windmill, Quanta Winterfell, and Wiwynn Windmill.

intel20 - This workaround flag will work around several Intel IPMI 2.0 authentication issues. The issues covered include padding of usernames, and password truncation if the authentication algorithm is HMAC-MD5-128. Those hitting this issue may see "username invalid", "password invalid", or "k_g invalid" errors. Issue observed on Intel SE7520AF2 with Intel Server Management Module (Professional Edition).

supermicro20 - This workaround flag will work around several Supermicro IPMI 2.0 authentication issues on motherboards w/ Peppercon IPMI firmware. The issues covered include handling invalid length authentication codes. Those hitting this issue may see "password invalid" errors. Issue observed on Supermicro H8QME with SIMSO daughter card. Confirmed fixed on newerver firmware.

sun20 - This workaround flag will work work around several Sun IPMI 2.0 authentication issues. The issues covered include invalid lengthed hash keys, improperly hashed keys, and invalid cipher suite records. Those hitting this issue may see "password invalid" or "bmc error" errors. Issue observed on Sun Fire 4100/4200/4500 with ILOM. This workaround automatically includes the "opensesspriv" workaround.

opensesspriv - This workaround flag will slightly alter FreeIPMI's IPMI 2.0 connection protocol to workaround an invalid hashing algorithm used by the remote system. The privilege level sent during the Open Session stage of an IPMI 2.0 connection is used for hashing keys instead of the privilege level sent during the RAKP1 connection stage. Those hitting this issue may see "password invalid", "k_g invalid", "bad rmcpplus status code", or "privilege level cannot be obtained for this user" errors. Issue observed on Sun Fire 4100/4200/4500 with ILOM, Inventec 5441/Dell Xanadu II, Supermicro X8DTH, Supermicro X8DTG, Intel S5500WBV/Penguin Relion 700, Intel S2600JF/Appro 512X, Quanta QSSC-S4R/Appro GB812X-CN, Dell C5220, and the OpenIPMI software BMC. This workaround is automatically triggered with the "sun20" workaround.

integritycheckvalue - This workaround flag will work around an invalid integrity check value during an IPMI 2.0 session establishment when using Cipher Suite ID 0. The integrity check value should be 0 length, however the remote motherboard responds with a non-empty field. Those hitting this issue may see "k_g invalid" errors. Issue observed on Supermicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin Relion 700, and Intel S2600JF/Appro 512X.

ipmiping - This workaround option will inform ipmipower to use IPMI based ping packets instead of RMCP ping packets. Some motherboards have been observed to not implement RMCP ping/pong support despite being required by the IPMI specification. Those hitting this issue may see "not discovered" errors in shell mode. Issue observed on Intel M50FCP, Intel Windmill, Quanta Winterfell, and Wiwynn Windmill.

No IPMI 1.5 Support - Some motherboards that support IPMI 2.0 have been found to not support IPMI 1.5. Those hitting this issue may see "ipmi 2.0 unavailable" or "connection timeout" errors. This issue can be worked around by using IPMI 2.0 instead of IPMI 1.5 by specifying --driver-type=LAN_2_0. Issue observed on a number of HP and Supermicro motherboards.

## DIAGNOSTICS
Upon successful execution, exit status is 0. On error, exit status is 1.

If multiple hosts are specified for communication, the exit status is 0 if and only if all targets successfully execute. Otherwise the exit status is 1.

When operating in interactive mode, the exit value will be based on the last power operation executed.

## KNOWN ISSUES
On older operating systems, if you input your username, password, and other potentially security relevant information on the command line, this information may be discovered by other users when using tools like the ps(1) command or looking in the /proc file system. It is generally more secure to input password information with options like the -P or -K options. Configuring security relevant information in the FreeIPMI configuration file would also be an appropriate way to hide this information.

In order to prevent brute force attacks, some BMCs will temporarily "lock up" after a number of remote authentication errors. You may need to wait awhile in order to this temporary "lock up" to pass before you may authenticate again.

IPMI specifications do not require BMCs to perform a power control operation before returning a completion code to the caller. Therefore, it is possible for ipmipower to return power status queries opposite of what you are expecting. For example, if a "power off" operation is performed, a BMC may return a successful completion code to ipmipower before the "power off" operation is actually performed. Subsequent power status queries may return "on" for several seconds, until the BMC actually performs the "power off" operation.

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

## COPYRIGHT
Copyright (C) 2007-2015 Lawrence Livermore National Security, LLC.

Copyright (C) 2003-2007 The Regents of the University of California.

This program 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.

## SEE ALSO
freeipmi.conf(5), freeipmi(7), ipmi-config(8), ipmi-oem(8)

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


rmcpping

package: freeipmi

title: rmcpping(8)

summary: send RMCP Ping to network hosts

text:
# rmcpping(8)

## NAME
rmcpping - send RMCP Ping to network hosts

## SYNOPSIS
rmcpping [OPTION...] destination

## DESCRIPTION
rmcpping uses the RMCP Ping request datagram to elicit an RMCP Pong response from a remote host. The utility can be used to verify if a remote host supports RMCP or IPMI. The initial starting sequence number will be randomized. rmcpping will return 0 to the environment if it receives atleast 1 response from the remote host. Otherwise, it exits with a value of 1.

## OPTIONS
The following options are available

-h

Output help menu.

-V

Output version.

-c count

Stop after sending count packets.

-i interval

Wait interval seconds between sending each packet. The default is to wait for one second between each packet.

-I interface address

Set source address to specified interface address. Argument may be numeric IP address or name of device.

-t timeout

Time to wait for a response, in seconds. Default is five seconds.

-v

Verbose output.

-s num

Specify an initial starting sequence number. The default is to use a random initial sequence number.

-d

Turn on debugging.

## KNOWN ISSUES
It has been observed that some remote BMCs can get "confused" and delay packet responses if duplicate packets (with duplicate sequence numbers) are sent in succession very quickly. There is no known way to cleanly deal with a "confused" BMC other than the wait awhile.

Unlike ping(8), local network devices (e.g. 127.0.0.1) cannot be "pinged".

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

## COPYRIGHT
Copyright (C) 2007-2015 Lawrence Livermore National Security, LLC.

Copyright (C) 2003-2007 The Regents of the University of California.

This program 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.

## ORIGIN
Command and manpage based off ping(8).

## SEE ALSO
freeipmi(7), ping(8), ipmiping(8)

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


bmc-watchdog

package: freeipmi-bmc-watchdog

title: bmc-watchdog(8)

text:
# bmc-watchdog(8)

## NAME
bmc-watchdog - BMC watchdog timer daemon and control utility

## SYNOPSIS
bmc-watchdog command [OPTION...] [COMMAND_OPTIONS...]

## DESCRIPTION
Bmc-watchdog controls a Baseboard Management Controller (BMC) watchdog timer. The bmc-watchdog tool typically executes as a cronjob or daemon to manage the watchdog timer. A user must be root in order to run bmc-watchdog.

Listed below are bmc-watchdog details, option details, examples, and known issues. For a general introduction to FreeIPMI please see freeipmi(7).

## BMC WATCHDOG DETAILS
A BMC watchdog timer is part of the Intelligent Platform Management Interface (IPMI) specification and is only available to BMCs that are compliant with IPMI. When a BMC watchdog timer is started, it begins counting down to zero from some positive number of seconds. When the timer hits zero, the timer will execute a pre-configured pre-timeout interrupt and/or timeout action.

In order to stop the pre-timeout interrupt or timeout action from being executed, the watchdog timer must be periodically reset back to its initial beginning value.

The BMC watchdog timer automatically stops itself when the machine is rebooted. Therefore, when a machine is brought up, the BMC watchdog timer must be setup again before it can be used.

Typically, a BMC watchdog timer is used to automatically reset a machine that has crashed. When the operating system first starts up, the BMC timer is set to its initial countdown value. At periodic intervals, when the operating system is functioning properly, the watchdog timer can be reset by the OS or a userspace program. Thus, the timer never counts down to zero. When the system crashes, the timer cannot be reset by the OS or userspace program. Eventually, the timer will countdown to zero and reset the machine.

See EXAMPLES below for examples of how bmc-watchdog is commonly used.

## COMMANDS
The following commands are available to bmc-watchdog.

-s, --set

Set BMC Watchdog Configuration. BMC watchdog timer configuration values can be set using the set command options listed below under SET OPTIONS. If a particular configuration parameter is not specified on the command line, the current configuration of that parameter will not be changed.

-g, --get

Get BMC Watchdog Configuration and State. The current configuration and state is printed to standard output.

-r, --reset

Reset BMC Watchdog Timer.

-t, --start

Start BMC Watchdog Timer. Does nothing if the timer is currently running. Identical to --reset command when the timer is stopped with the exception of the start command options listed below under START OPTIONS.

-y, --stop

Stop BMC Watchdog Timer. Stops the current timer.

-c, --clear

Clear BMC Watchdog Configuration. Clears all configuration values for the watchdog timer, except for timer use, which is kept at its current value.

-d, --daemon

Run bmc-watchdog as a daemon. Configurable BMC watchdog timer options are listed below under DAEMON OPTIONS. The configuration values are set once, then the daemon will reset the timer at specified periodic intervals. The daemon can be stopped using the --stop command, --clear command, or by setting the stop_timer flag on the --set command.

## GENERAL OPTIONS
The following options are general options for configuring IPMI communication and executing general tool commands. These options are generic and can be used by any command.

-D IPMIDRIVER, --driver-type=IPMIDRIVER

Specify the driver type to use instead of doing an auto selection. The currently available inband drivers are KCS, SSIF, OPENIPMI, SUNBMC, and INTELDCMI.

--disable-auto-probe

Do not probe in-band IPMI devices for default settings.

--driver-address=DRIVER-ADDRESS

Specify the in-band driver address to be used instead of the probed value. DRIVER-ADDRESS should be prefixed with "0x" for a hex value and '0' for an octal 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. Argument is in bytes (i.e. 32bit register spacing = 4)

--target-channel-number=CHANNEL-NUMBER

Specify the in-band driver target channel number to send IPMI requests to.

--target-slave-address=SLAVE-ADDRESS

Specify the in-band driver target slave number to send IPMI requests to.

-v, --verbose-logging

Increase verbosity of logging.

-n, --no-logging

Turns off all logging done by bmc-watchdog.

--config-file=FILE

Specify an alternate configuration file.

-W WORKAROUNDS, --workaround-flags=WORKAROUNDS

Specify workarounds to vendor compliance issues. Multiple workarounds can be specified separated by commas. A special command line flag of "none", will indicate no workarounds (may be useful for overriding configured defaults). 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.

## SET OPTIONS
The following options can be used by the set command to set or clear various BMC watchdog configuration parameters.

-u INT, --timer-use=INT

Set timer use. The timer use value can be set to one of the following: 1 = BIOS FRB2, 2 = BIOS POST, 3 = OS_LOAD, 4 = SMS OS, 5 = OEM.

-m INT, --stop-timer=INT

Set Stop Timer Flag. A flag value of 0 stops the current BMC watchdog timer. A value of 1 doesn't turn off the current watchdog timer.

-l INT, --log=INT

Set Log Flag. A flag value of 0 turns logging on. A value of 1 turns logging off.

-a INT, --timeout-action=INT

Set timeout action. The timeout action can be set to one of the following: 0 = No action, 1 = Hard Reset, 2 = Power Down, 3 = Power Cycle.

-p INT, --pre-timeout-interrupt=INT

Set pre-timeout interrupt. The pre timeout interrupt can be set to one of the following: 0 = None, 1 = SMI, 2 = NMI, 3 = Messaging Interrupt.

-z SECONDS, --pre-timeout-interval=SECONDS

Set pre-timeout interval in seconds.

-F, --clear-bios-frb2

Clear BIOS FRB2 Timer Use Flag.

-P, --clear-bios-post

Clear BIOS POST Timer Use Flag.

-L, --clear-os-load

Clear OS Load Timer Use Flag.

-S, --clear-sms-os

Clear SMS/OS Timer Use Flag.

-O, --clear-oem

Clear OEM Timer Use Flag.

-i SECONDS, --initial-countdown=SECONDS

Set initial countdown in seconds.

-w, --start-after-set

Start timer after set command if timer is stopped. This is typically used when bmc-watchdog is used as a cronjob. This can be used to automatically start the timer after it has been set the first time.

-x, --reset-after-set

Reset timer after set command if timer is running.

-j, --start-if-stopped

Don't execute set command if timer is stopped, just start timer.

-k, --reset-if-running

Don't execute set command if timer is running, just reset timer. This is typically used when bmc-watchdog is used as a cronjob. This can be used to reset the timer after it has been initially started.

## START OPTIONS
The following options can be used by the start command.

-G INT, --gratuitous-arp=INT

Suspend or don't suspend gratuitous ARPs while the BMC timer is running. A flag value of 1 suspends gratuitous ARPs. A value of 0 will not suspend gratuitous ARPs. If this option is not specified, gratuitous ARPs will not be suspended.

-A INT, --arp-response=INT

Suspend or don't suspend BMC-generated ARP responses while the BMC timer is running. A flag value of 1 suspends ARP responses. A value of 0 will not suspend ARP responses. If this option is not specified, ARP responses will not be suspended.

## DAEMON OPTIONS
The following options can be used by the daemon command to set the initial BMC watchdog configuration parameters.

-u INT, --timer-use=INT

Set timer use. The timer use value can be set to one of the following: 1 = BIOS FRB2, 2 = BIOS POST, 3 = OS_LOAD, 4 = SMS OS, 5 = OEM.

-l INT, --log=INT

Set Log Flag. A flag value of 0 turns logging on. A value of 1 turns logging off.

-a INT, --timeout-action=INT

Set timeout action. The timeout action can be set to one of the following: 0 = No action, 1 = Hard Reset, 2 = Power Down, 3 = Power Cycle.

-p INT, --pre-timeout-interrupt=INT

Set pre-timeout interrupt. The pre timeout interrupt can be set to one of the following: 0 = None, 1 = SMI, 2 = NMI, 3 = Messaging Interrupt.

-z SECONDS, --pre-timeout-interval=SECONDS

Set pre-timeout interval in seconds.

-F, --clear-bios-frb2

Clear BIOS FRB2 Timer Use Flag.

-P, --clear-bios-post

Clear BIOS POST Timer Use Flag.

-L, --clear-os-load

Clear OS Load Timer Use Flag.

-S, --clear-sms-os

Clear SMS/OS Timer Use Flag.

-O, --clear-oem

Clear OEM Timer Use Flag.

-i SECONDS, --initial-countdown=SECONDS

Set initial countdown in seconds.

-G INT, --gratuitous-arp=INT

Suspend or don't suspend gratuitous ARPs while the BMC timer is running. A flag value of 1 suspends gratuitous ARPs. A value of 0 will not suspend gratuitous ARPs. If this option is not specified, gratuitous ARPs will not be suspended.

-A INT, --arp-response=INT

Suspend or don't suspend BMC-generated ARP responses while the BMC timer is running. A flag value of 1 suspends ARP responses. A value of 0 will not suspend ARP responses. If this option is not specified, ARP responses will not be suspended.

-e, --reset-period

Time interval to wait before resetting timer. The default is 60 seconds.

## ERRORS
Errors are logged to syslog.

## WORKAROUNDS
With so many different vendors implementing their own IPMI solutions, different vendors may implement their IPMI protocols incorrectly. The following describes a number of workarounds currently available to handle discovered compliance issues. 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 hardware listed below may only indicate the hardware that a problem was discovered on. Newer versions of hardware may fix the problems indicated below. Similar machines from vendors may or may not exhibit the same problems. Different vendors may license their firmware from the same IPMI firmware developer, so it may be worthwhile to try workarounds listed below even if your motherboard is not listed.

If you believe your hardware has an additional compliance issue that needs a workaround to be implemented, please contact the FreeIPMI maintainers on <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.

assumeio - This workaround flag will assume inband interfaces communicate with system I/O rather than being memory-mapped. This will work around systems that report invalid base addresses. Those hitting this issue may see "device not supported" or "could not find inband device" errors. Issue observed on HP ProLiant DL145 G1.

spinpoll - This workaround flag will inform some inband drivers (most notably the KCS driver) to spin while polling rather than putting the process to sleep. This may significantly improve the wall clock running time of tools because an operating system scheduler's granularity may be much larger than the time it takes to perform a single IPMI message transaction. However, by spinning, your system may be performing less useful work by not contexting out the tool for a more useful task.

ignorestateflag - This workaround option will ignore the BMC timer state flag (indicating if the timer is running or stopped) when running in daemon mode. On some BMCs, the flag is broken and will never report that a BMC timer is running, even if it is. The workaround will take notice of changes in the countdown seconds to determine if a timer is running or stopped. With this type of implementation, the reset-period must be large enough to ensure minor fluctuations in the countdown will not affect the workaround. Due to the implementation of this workaround, if another process stops the watchdog timer, it may be detectable. This option is confirmed to work around compliances issues on Sun x4100, x4200, and x4500.

## EXAMPLES
Setup a bmc-watchdog daemon that resets the machine after 15 minutes (900 seconds) if the OS has crashed:

bmc-watchdog -d -u 4 -p 0 -a 1 -i 900

## DIAGNOSTICS
Upon successful execution, exit status is 0. On error, exit status is 1.

## KNOWN ISSUES
Bmc-watchdog may fail to reset the watchdog timer if it is not scheduled properly. It is always recommended that bmc-watchdog be executed with a high scheduling priority.

On some machines, the hardware based SMI Handler may disable a processor after a watchdog timer timeout if the timer use is set to something other than SMS/OS.

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

## COPYRIGHT
Copyright (C) 2007-2015 Lawrence Livermore National Security, LLC.

Copyright (C) 2004-2007 The Regents of the University of California.

This program 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.

## SEE ALSO
freeipmi(7)

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


ipmidetectd

package: freeipmi-ipmidetectd

title: ipmidetectd(8)

summary: IPMI node detection monitoring daemon

text:
# ipmidetectd(8)

## NAME
ipmidetectd - IPMI node detection monitoring daemon

## SYNOPSIS
ipmidetectd [OPTION...]

## DESCRIPTION
The ipmidetectd daemon regularly sends out IPMI pings to determine if nodes have functioning IPMI interfaces or not. It is primarily used to determine those nodes in the cluster that are not functioning properly, allowing IPMI commands to be executed across the cluster faster by skipping those nodes that would automatically timeout.

The ipmidetectd daemon must be configured using the ipmidetectd configuration file. Until hosts to be pinged are configured, ipmidetectd will not function properly.

See the ipmidetectd.conf(5) manpage for additional information.

## OPTIONS
-c FILE, --config-file

Specify alternate configuration file

-d, --debug

Turn on debugging and run daemon in foreground

-V, --version

Output version

## ERRORS
Errors are logged to syslog.

## FILES
/etc/freeipmi//ipmidetectd.conf

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

## COPYRIGHT
Copyright (C) 2007-2015 Lawrence Livermore National Security, LLC.

Copyright (C) 2007 The Regents of the University of California.

This program 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.

## SEE ALSO
ipmidetectd.conf(5)

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


ipmiseld

package: freeipmi-ipmiseld

title: ipmiseld(8)

summary: IPMI SEL logging daemon

text:
# ipmiseld(8)

## NAME
ipmiseld - IPMI SEL logging daemon

## SYNOPSIS
ipmiseld [OPTION...]

## DESCRIPTION
The ipmiseld daemon polls the system event log (SEL) of specified hosts and stores the logs into the local syslog. By default, the daemon can also make best efforts to manage the remote SEL's buffer to ensure events are never lost. Recent logging data will be cached to disk to ensure that SEL events are not missed in the event the client or server is rebooted.

Many of the options for this daemon are very similar to the ipmi-sel(8) tool. It can be configured to log the local host, a remote host, or a range of hosts to the local syslog. It can be configured via the command line arguments listed below or via the /etc/freeipmi//ipmiseld.conf configuration file.

Listed below are general IPMI options, tool specific options, trouble shooting information, workaround information, examples, and known issues. For a general introduction to FreeIPMI please see freeipmi(7).

## GENERAL OPTIONS
The following options are general options for configuring IPMI communication and executing general tool commands.

-D IPMIDRIVER, --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, OPENIPMI, SUNBMC, and INTELDCMI.

--disable-auto-probe

Do not probe in-band IPMI devices for default settings.

--driver-address=DRIVER-ADDRESS

Specify the in-band driver address to be used instead of the probed value. DRIVER-ADDRESS should be prefixed with "0x" for a hex value and '0' for an octal 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. Argument is in bytes (i.e. 32bit register spacing = 4)

--target-channel-number=CHANNEL-NUMBER

Specify the in-band driver target channel number to send IPMI requests to.

--target-slave-address=SLAVE-ADDRESS

Specify the in-band driver target slave number to send IPMI requests to.

-h IPMIHOST1,IPMIHOST2,..., --hostname=IPMIHOST1[:PORT],IPMIHOST2[:PORT],...

Specify the remote host(s) to communicate with. Multiple hostnames may be separated by comma or may be specified in a range format; see HOSTRANGED SUPPORT below. An optional port can be specified with each host, which may be useful in port forwarding or similar situations. If specifying an IPv6 address and port, use the format [ADDRESS]:PORT.

-u USERNAME, --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 USER privileges in order for this tool to operate fully.

-p PASSWORD, --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=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.

--session-timeout=MILLISECONDS

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

--retransmission-timeout=MILLISECONDS

Specify the packet retransmission timeout in milliseconds. Defaults to 1000 milliseconds (1 second) if not specified. The retransmission timeout cannot be larger than the session timeout.

-a AUTHENTICATION-TYPE, --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=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

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

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

15 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm = None; Confidentiality Algorithm = None

16 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm = HMAC_SHA256_128; Confidentiality Algorithm = None

17 - Authentication Algorithm = HMAC-SHA256; Integrity Algorithm = HMAC_SHA256_128; Confidentiality Algorithm = AES-CBC-128

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

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

--config-file=FILE

Specify an alternate configuration file.

-W WORKAROUNDS, --workaround-flags=WORKAROUNDS

Specify workarounds to vendor compliance issues. Multiple workarounds can be specified separated by commas. A special command line flag of "none", will indicate no workarounds (may be useful for overriding configured defaults). 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.

## IPMISELD OPTIONS
The following options are specific to ipmiseld.

-v

Log verbose information. This option will log additional information. Most notably it will output additional hex codes to given information on ambiguous SEL entries or SEL records. For example, it will output Generator ID hex codes for sensors without names. Additional non-critical SEL errors or issues will also be logged. Somewhat common errors, such as timeouts or invalid hostnames, will output with increased verbosity.

-t SENSOR-TYPE-LIST, --sensor-types=SENSOR-TYPE-LIST

Specify sensor types of SEL events to log. By default, all sensor types are logged. A special command line type of "all", will indicate all types should be shown (may be useful for overriding configured defaults). Multiple types can be separated by commas or spaces. Users may specify sensor types by string (see --list-sensor-types in ipmi-sel(8)) or by number (decimal or hex).

-T SENSOR-TYPE-LIST, --exclude-sensor-types=SENSOR-TYPE-LIST

Specify sensor types of SEL events to not log. By default, no sensor types are filtered. A special command line type of "none", will indicate no types should be excluded (may be useful for overriding configured defaults). Multiple types can be separated by commas or spaces. Users may specify sensor types by string (see --list-sensor-types in ipmi-sel(8)) or by number (decimal or hex).

--system-event-only

Log only system event records (i.e. don't log OEM records).

--oem-event-only

Log only OEM event records (i.e. don't log system event records).

--event-state-config-file=FILE

Specify an alternate event state configuration file.

--interpret-oem-data

Attempt to interpret OEM data, such as event data, sensor readings, or general extra info, etc. If an OEM interpretation is not available, the default output will be generated. Correctness of OEM interpretations cannot be guaranteed due to potential changes OEM vendors may make in products, firmware, etc. See OEM INTERPRETATION below for confirmed supported motherboard interpretations.

--entity-sensor-names

Output sensor names prefixed with their entity id and instance number when appropriate. This may be necessary on some motherboards to help identify what sensors are referencing. For example, a motherboard may have multiple sensors named 'TEMP'. The entity id and instance number may help clarify which sensor refers to "Processor 1" vs. "Processor 2".

--non-abbreviated-units

Output non-abbreviated units (e.g. 'Amps' instead of 'A'). May aid in disambiguation of units (e.g. 'C' for Celsius or Coulombs).

--event-state-filter=FILTERSTRING

Specify event states to be filtered out and not logged. Possible inputs are NOMINAL, WARNING, CRITICAL, and NA. Multiple states can be listed separated by comma. The special case string of "none" will indicate no event states should be excluded (may be useful for overriding configured defaults).

--warning-threshold=PERCENTINT

Specify SEL fullness warning threshold as an integer percentage. When the SEL is past this percentage full, a warning will be output indicating that SEL is nearly full. Specify 0 to disable warning logs. Defaults to 80.

--clear-threshold=PERCENTINT

Specify SEL fullness clear threshold as an integer percentage. When the SEL is past this percentage full, ipmiseld will attempt to clear the SEL. Specify 0 to disable clearing. When the SEL is full, it will be the responsibility of the user to clear the SEL manually if clearing is disabled. Defaults to 0. If specified to a non-zero value, be careful that the clearing of the SEL could affect other applications that monitor the SEL, such as monitoring applications that use ipmi-sel(8) or libipmimonitoring(3).

--system-event-format=FORMATSTRING

Specify the format of the log output when a SEL system event is encountered. Defaults to "SEL System Event: %d, %t, %s, %I, %E" if logging locally, "SEL System Event(%h): %d, %t, %s, %I, %E" if logging outofband or with hostranges. See SEL LOG FORMAT STRING below for formatting details.

--oem-timestamped-event-format=FORMATSTRING

Specify the format of the log output when a SEL OEM timestamped event is encountered. Defaults to "SEL OEM Event: %d, %t, %I, %o" if logging locally, "SEL OEM Event(%h): %d, %t, %I, %o" if logging outofband or with hostranges.. See SEL LOG FORMAT STRING below for formatting details.

--oem-non-timestamped-event-format=FORMATSTRING

Specify the format of the log output when a SEL OEM non-timestamped event is encountered. Defaults to "SEL OEM Event: %I, %o" if logging locally, "SEL OEM Event(%h): %I, %o" if logging outofband or with hostranges.. See SEL LOG FORMAT STRING below for formatting details.

--poll-interval=SECONDS

Specify the poll interval to check the SEL for new events. Defaults to 300 seconds (i.e. 5 minutes).

--log-facility=STRING

Specify the log facility to use. Defaults to LOG_DAEMON. Legal inputs are LOG_DAEMON, LOG_USER, LOG_LOCAL0, LOG_LOCAL1, LOG_LOCAL2, LOG_LOCAL3, LOG_LOCAL4, LOG_LOCAL5, LOG_LOCAL6, LOG_LOCAL7.

--log-priority=STRING

Specify the log priority to use. Defaults to LOG_ERR. Legal inputs are LOG_EMERG, LOG_ALERT, LOG_CRIT, LOG_ERR, LOG_WARNING, LOG_NOTICE, LOG_INFO, LOG_DEBUG.

--cache-directory=DIRECTORY

Specify an alternate cache directory location for ipmiseld to use. The cache directory will be used to cache a wide variety of data, including the SDR and recent logging information to ensure log entries are not missed on reboots and other system failures.

--ignore-sdr

Ignore SDR related processing. May lead to incomplete or less useful information being output, however it will allow functionality for systems without SDRs or when the correct SDR cannot be loaded.

--re-download-sdr

Re-download the SDR on start even if it is not out of date. This may help work around systems that do not properly timestamp SDR modification times.

--clear-sel

On startup, clear any SEL being monitored. May be useful the first time running ipmiseld to avoid warning messages or SEL clears until a long time in the future.

--threadpool-count=NUM

Specify the number of threads for parallel SEL polling. This option is very similar to the --fanout option in ipmi-sel(8) but the threads are created only once on initialization for faster processing. Defaults to 8, however the threadpool count will always be decreased if the number of nodes specified is less than the number of threads.

--test-run

Do not daemonize, output the current SEL of configured hosts as a test of current settings and configuration. SEL entries will be output to stdout instead of syslog.

--foreground

Run daemon in the foreground. SEL entries will be output to stdout instead of syslog.

## SEL LOG FORMAT STRING
The output format of log messages can be adjusted via the --system-event-format, --oem-timestamped-event-format and --oem-non-timestamped-event-format options. Options such as --interpret-oem-data, --entity-sensor-names, and --non-abbreviated-units can further adjust the output format. The following conversion directives will allow the user to output specifics of each SEL event that occurs.

For System, OEM timestamped, and OEM non-timestamped events

%h - target host, useful if logging from multiple hosts

%i - record ID in decimal

%I - event state interpretation (NOMINAL, WARNING, or CRITICAL)

For System and OEM timestamped events

%t - time in format H:M:S using 24 hour clock

%d - date in format D-M-YEAR

For System events

%T - sensor type

%s - sensor name

%e - event data 1 string

%f - event data 2 string [2]

%h - event data 3 string

%c - combined event data 2 and event data 3 string

%p - event data 2 previous state string

%S - event data 2 severity string

%E - combined event data 1, 2, and 3 string

%k - event direction

For OEM timestamped events

%m - manufacturer id

For OEM timestamped and OEM non-timestamped events

%o - oem data in hex

%O - OEM supplied string describing the event (depends on manufacturer)

## HOSTRANGED SUPPORT
Multiple hosts can be input either as an explicit comma separated lists of hosts or a range of hostnames in the general form: prefix[n-m,l-k,...], where n < m and l < k, etc. The later form should not be confused with regular expression character classes (also denoted by []). For example, foo[19] does not represent foo1 or foo9, but rather represents a degenerate range: foo19.

This range syntax is meant only as a convenience on clusters with a prefixNN naming convention and specification of ranges should not be considered necessary -- the list foo1,foo9 could be specified as such, or by the range foo[1,9].

Some examples of range usage follow:

```
    foo[01-05] instead of foo01,foo02,foo03,foo04,foo05

    foo[7,9-10] instead of foo7,foo9,foo10

    foo[0-3] instead of foo0,foo1,foo2,foo3
```

As a reminder to the reader, some shells will interpret brackets ([ and ]) for pattern matching. Depending on your shell, it may be necessary to enclose ranged lists within quotes.

In-band IPMI Communication will be used when the host "localhost" is specified. This allows the user to add the localhost into the hostranged output.

## GENERAL TROUBLESHOOTING
Most often, IPMI problems are due to configuration problems.

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 ipmi-config(8) tool can be used to check and/or change these configuration settings.

Inband IPMI problems are typically caused by improperly configured drivers or non-standard BMCs.

In addition to the troubleshooting tips below, please see WORKAROUNDS below to also if there are any vendor specific bugs that have been discovered and worked around.

Listed below are many of the common issues for error messages. For additional support, please e-mail the <freeipmi-users@gnu.org> mailing list.

"username invalid" - The username entered (or a NULL username if none was entered) is not available on the remote machine. 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. It may also be possible the password for the user is not correctly configured on the remote BMC.

"password verification timeout" - Password verification has timed out. A "password invalid" error (described above) or a generic "session timeout" (described below) occurred. During this point in the protocol it cannot be differentiated which occurred.

"k_g invalid" - The K_g key entered (or a NULL K_g key if none was entered) is not correct. 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.

"connection timeout" - Initial IPMI communication failed. A number of potential errors are possible, including an invalid hostname specified, an IPMI IP address cannot be resolved, IPMI is not enabled on the remote server, the network connection is bad, etc. Please verify configuration and connectivity.

"session timeout" - The IPMI session has timed out. Please reconnect. If this error occurs often, you may wish to increase the retransmission timeout. Some remote BMCs are considerably slower than others.

"device not found" - The specified device could not be found. Please check configuration or inputs and try again.

"driver timeout" - Communication with the driver or device has timed out. Please try again.

"message timeout" - Communication with the driver or device has timed out. Please try again.

"BMC busy" - The BMC is currently busy. It may be processing information or have too many simultaneous sessions to manage. Please wait and try again.

"could not find inband device" - An inband device could not be found. Please check configuration or specify specific device or driver on the command line.

"driver timeout" - The inband driver has timed out communicating to the local BMC or service processor. The BMC or service processor may be busy or (worst case) possibly non-functioning.

"internal IPMI error" - An IPMI error has occurred that FreeIPMI does not know how to handle. Please e-mail <freeipmi-users@gnu.org> to report the issue.

## IPMISELD TROUBLESHOOTING
Some timestamps in the SEL may report a date of 1-Jan-1970, the epoch for SEL timestamps. This timestamp is not necessarily incorrect. It usually indicates a hardware event that occurred before a timestamp in firmware has been initialized. For example, certain hardware components will have their internal clocks reset during a power cycle.

However, if the internal clock of the SEL appears to be regularly incorrect, you may need to set the SEL time. This can be done using bmc-device(8).

The following are common SEL related messages.

"sel config file parse error" - A parse error was found in the sel event interpretation configuration file. Please see freeipmi_interpret_sel.conf(5).

## WORKAROUNDS
With so many different vendors implementing their own IPMI solutions, different vendors may implement their IPMI protocols incorrectly. The following describes a number of workarounds currently available to handle discovered compliance issues. 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 hardware listed below may only indicate the hardware that a problem was discovered on. Newer versions of hardware may fix the problems indicated below. Similar machines from vendors may or may not exhibit the same problems. Different vendors may license their firmware from the same IPMI firmware developer, so it may be worthwhile to try workarounds listed below even if your motherboard is not listed.

If you believe your hardware has an additional compliance issue that needs a workaround to be implemented, please contact the FreeIPMI maintainers on <freeipmi-users@gnu.org> or <freeipmi-devel@gnu.org>.

assumeio - This workaround flag will assume inband interfaces communicate with system I/O rather than being memory-mapped. This will work around systems that report invalid base addresses. Those hitting this issue may see "device not supported" or "could not find inband device" errors. Issue observed on HP ProLiant DL145 G1.

spinpoll - This workaround flag will inform some inband drivers (most notably the KCS driver) to spin while polling rather than putting the process to sleep. This may significantly improve the wall clock running time of tools because an operating system scheduler's granularity may be much larger than the time it takes to perform a single IPMI message transaction. However, by spinning, your system may be performing less useful work by not contexting out the tool for a more useful task.

authcap - This workaround flag will skip early checks for username capabilities, authentication capabilities, and K_g support and allow IPMI authentication to succeed. It works around multiple issues in which the remote system does not properly report username capabilities, authentication capabilities, or K_g status. Those hitting this issue may see "username invalid", "authentication type unavailable for attempted privilege level", or "k_g invalid" errors. Issue observed on Asus P5M2/P5MT-R/RS162-E4/RX4, Intel SR1520ML/X38ML, and Sun Fire 2200/4150/4450 with ELOM.

nochecksumcheck - This workaround flag will tell FreeIPMI to not check the checksums returned from IPMI command responses. It works around systems that return invalid checksums due to implementation errors, but the packet is otherwise valid. Users are cautioned on the use of this option, as it removes validation of packet integrity in a number of circumstances. However, it is unlikely to be an issue in most situations. Those hitting this issue may see "connection timeout", "session timeout", or "password verification timeout" errors. On IPMI 1.5 connections, the "noauthcodecheck" workaround may also needed too. Issue observed on Supermicro X9SCM-iiF, Supermicro X9DRi-F, and Supermicro X9DRFR.

idzero - This workaround flag will allow empty session IDs to be accepted by the client. It works around IPMI sessions that report empty session IDs to the client. Those hitting this issue may see "session timeout" errors. Issue observed on Tyan S2882 with M3289 BMC.

unexpectedauth - This workaround flag will allow unexpected non-null authcodes to be checked as though they were expected. It works around an issue when packets contain non-null authentication data when they should be null due to disabled per-message authentication. Those hitting this issue may see "session timeout" errors. Issue observed on Dell PowerEdge 2850,SC1425. Confirmed fixed on newer firmware.

forcepermsg - This workaround flag will force per-message authentication to be used no matter what is advertised by the remote system. It works around an issue when per-message authentication is advertised as disabled on the remote system, but it is actually required for the protocol. Those hitting this issue may see "session timeout" errors. Issue observed on IBM eServer 325.

endianseq - This workaround flag will flip the endian of the session sequence numbers to allow the session to continue properly. It works around IPMI 1.5 session sequence numbers that are the wrong endian. Those hitting this issue may see "session timeout" errors. Issue observed on some Sun ILOM 1.0/2.0 (depends on service processor endian).

noauthcodecheck - This workaround flag will tell FreeIPMI to not check the authentication codes returned from IPMI 1.5 command responses. It works around systems that return invalid authentication codes due to hashing or implementation errors. Users are cautioned on the use of this option, as it removes an authentication check verifying the validity of a packet. However, in most organizations, this is unlikely to be a security issue. Those hitting this issue may see "connection timeout", "session timeout", or "password verification timeout" errors. Issue observed on Xyratex FB-H8-SRAY, Intel Windmill, Quanta Winterfell, and Wiwynn Windmill.

intel20 - This workaround flag will work around several Intel IPMI 2.0 authentication issues. The issues covered include padding of usernames, and password truncation if the authentication algorithm is HMAC-MD5-128. Those hitting this issue may see "username invalid", "password invalid", or "k_g invalid" errors. Issue observed on Intel SE7520AF2 with Intel Server Management Module (Professional Edition).

supermicro20 - This workaround flag will work around several Supermicro IPMI 2.0 authentication issues on motherboards w/ Peppercon IPMI firmware. The issues covered include handling invalid length authentication codes. Those hitting this issue may see "password invalid" errors. Issue observed on Supermicro H8QME with SIMSO daughter card. Confirmed fixed on newerver firmware.

sun20 - This workaround flag will work work around several Sun IPMI 2.0 authentication issues. The issues covered include invalid lengthed hash keys, improperly hashed keys, and invalid cipher suite records. Those hitting this issue may see "password invalid" or "bmc error" errors. Issue observed on Sun Fire 4100/4200/4500 with ILOM. This workaround automatically includes the "opensesspriv" workaround.

opensesspriv - This workaround flag will slightly alter FreeIPMI's IPMI 2.0 connection protocol to workaround an invalid hashing algorithm used by the remote system. The privilege level sent during the Open Session stage of an IPMI 2.0 connection is used for hashing keys instead of the privilege level sent during the RAKP1 connection stage. Those hitting this issue may see "password invalid", "k_g invalid", "bad rmcpplus status code", or "privilege level cannot be obtained for this user" errors. Issue observed on Sun Fire 4100/4200/4500 with ILOM, Inventec 5441/Dell Xanadu II, Supermicro X8DTH, Supermicro X8DTG, Intel S5500WBV/Penguin Relion 700, Intel S2600JF/Appro 512X, Quanta QSSC-S4R/Appro GB812X-CN, Dell C5220, and the OpenIPMI software BMC. This workaround is automatically triggered with the "sun20" workaround.

integritycheckvalue - This workaround flag will work around an invalid integrity check value during an IPMI 2.0 session establishment when using Cipher Suite ID 0. The integrity check value should be 0 length, however the remote motherboard responds with a non-empty field. Those hitting this issue may see "k_g invalid" errors. Issue observed on Supermicro X8DTG, Supermicro X8DTU, and Intel S5500WBV/Penguin Relion 700, and Intel S2600JF/Appro 512X.

assumesystemevent - This workaround option will assume invalid SEL record types are system event records. Records may be formatted correctly but report invalid record types. Those hitting this issue may see "Unknown SEL Record Type" errors. Output may be unknown, pray for the best. This option is confirmed to work around compliances issues on HP DL 380 G5 motherboards.

No IPMI 1.5 Support - Some motherboards that support IPMI 2.0 have been found to not support IPMI 1.5. Those hitting this issue may see "ipmi 2.0 unavailable" or "connection timeout" errors. This issue can be worked around by using IPMI 2.0 instead of IPMI 1.5 by specifying --driver-type=LAN_2_0. Issue observed on a number of HP and Supermicro motherboards.

## OEM INTERPRETATION
The following motherboards are confirmed to have atleast some support by the --interpret-oem-data option. While highly probable the OEM data interpretations would work across other motherboards by the same manufacturer, there are no guarantees. Some of the motherboards below may be rebranded by vendors/distributors.

Dell Poweredge 2900, Dell Poweredge 2950, Dell Poweredge R610, Dell Poweredge R710, Fujitsu iRMC S1 and iRMC S2 systems, Intel S5500WB/Penguin Computing Relion 700, Intel S2600JF/Appro 512X, Intel S5000PAL, Inventec 5441/Dell Xanadu II, Inventec 5442/Dell Xanadu III, Quanta S99Q/Dell FS12-TY, Quanta QSSC-S4R/Appro GB812X-CN, Sun X4140 Supermicro X7DBR-3, Supermicro X7DB8, Supermicro X8DTN, Supermicro X7SBI-LN4, Supermicro X8DTH, Supermicro X8DTG, Supermicro X8DTU, Supermicro X8DT3-LN4F, Supermicro X8DTU-6+, Supermicro X8DTL, Supermicro X8DTL-3F, Supermicro X8SIL-F, Supermicro X9SCL, Supermicro X9SCM, Supermicro X8DTN+-F, Supermicro X8SIE, Supermicro X9SCA-F-O, Supermicro H8DGU-F, Supermicro X9DRi-F, Supermicro X9DRI-LN4F+, Supermicro X9SPU-F-O, Supermicro X9SCM-iiF, Wistron/Dell Poweredge C6220.

## KNOWN ISSUES
On older operating systems, if you input your username, password, and other potentially security relevant information on the command line, this information may be discovered by other users when using tools like the ps(1) command or looking in the /proc file system. It is generally more secure to input password information with options like the -P or -K options. Configuring security relevant information in the FreeIPMI configuration file would also be an appropriate way to hide this information.

In order to prevent brute force attacks, some BMCs will temporarily "lock up" after a number of remote authentication errors. You may need to wait awhile in order to this temporary "lock up" to pass before you may authenticate again.

## FILES
/etc/freeipmi//ipmiseld.conf /var/cache/ipmiseld/

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

## COPYRIGHT
Copyright (C) 2012-2015 Lawrence Livermore National Security, LLC.

This program 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.

## SEE ALSO
freeipmi(7), ipmi-sel(8), ipmiseld.conf(5), bmc-device(8), ipmi-config(8), freeipmi_interpret_sel.conf(5)

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


radcrypt

package: freeradius

title: radcrypt(8)

text:
# radcrypt(8)

## NAME
radcrypt - generate password hash for use with radius, or validates a password hash

## SYNOPSIS
radcrypt [-d|--des] [-m|--md5] [-c|--check] plaintext_password [hashed_password]

## DESCRIPTION
radcrypt generates a hashed digest of a plaintext password, or can validate if a password hash matches a plaintext password. DES and MD5 hashes are currently supported. When generating a password hash a random salt is generated and applied.

A hashed password can be validated by specifying -c or --check and passing hashed_password after plaintext_password on the command line. In this case hashed_password will be checked to see if it matches plaintext_password. If so "Password OK" will be printed and the exit status will be 1, otherwise "Password BAD" will be printed and exit status will be 0 (Note this is the opposite of a normal successful shell status).

## OPTIONS
-d --des

Use a DES (Data Encryption Standard) hash (default). Ignored if performing a password check.

-m --md5

Use a MD5 (Message Digest 5) hash. Ignored if performing a password check.

-c --check

Perform a validation check on a password hash to verify if it matches the plantext password.

## EXAMPLES

```
$ radcrypt foobar
HaX0xn7Qy650Q
$ radcrypt -c foobar HaX0xn7Qy650Q
Password OK
```

## SEE ALSO
radiusd(8), crypt(3)

## AUTHORS
Miquel van Smoorenburg <miquels@cistron-office.nl>


raddebug

title: raddebug(8)

text:
# raddebug(8)

## NAME
raddebug - Display debugging output from a running server.

## SYNOPSIS
raddebug [-c condition] [-d config_directory] [-D dictionary_directory] [-n name] [-i ipv4-address] [-I ipv6-address] [-f socket_file] [-t timeout] [-u user-name]

## DESCRIPTION
raddebug is a shell script wrapper around radmin that automates the process of obtaining debugging output from a running server. It does this without impacting service availability, unlike using radiusd -X. There are a number of prerequisites that are required for its proper operation:

* radmin must be available in the PATH.

* The user running raddebug must have permission to connect to

the server control socket.

* The control socket must be configured. For instructions, see

raddb/sites-available/control-socket

* The control socket must be marked as "mode = rw".

* The user running raddebug must have permission to read and

write files in the "logdir" directory. This is usually

/var/log/radiusd.

For a number of reasons, the debugging output is placed in an intermediate file, rather than being sent directly to standard output. In order to prevent this file from growing too large, the raddebug program is automatically terminated after 10 seconds. This timeout can be changed via the "-t" parameter.

When the script exits, debug mode in the server is disabled, and the intermediate file is deleted.

Debug output from a live server can be redirected to only one location. If a second instance of raddebug is started while the first one is still running, the later one will over-ride the first one, and the first will stop producing output.

## OPTIONS
-c condition

Set a specific debug condition. The format of the condition is as specified in the CONDITIONS section of the unlang manual page.

-f socket_file

The path to the control socket. See the radmin manual page for more description of this option.

-i ipv4-address

Show debug output for the client having the given IPv4 address. This option is equivalent to using:

-c '(Packet-Src-IP-Address == ipv4-address)'

-d config directory

The radius configuration directory, usually /etc/raddb. See the radmin manual page for more description of this option.

-D dictionary directory

Set main dictionary directory. Defaults to /usr/share/freeradius.

-n mname

Read raddb/name.conf instead of raddb/radiusd.conf.

-I ipv6-address

Show debug output for the client having the given IPv6 address. This option is equivalent to using:

-c '(Packet-Src-IPv6-Address == ipv6-address)'

-t timeout

Stop printing debug output after "timeout" seconds. The default timeout is sixty (60) seconds. Use "-t 0" to print debugging output forever, or until the script exits.

-u name

Show debug output for users having the given name. This option is equivalent to using:

-c '(User-Name == name)'

## SEE ALSO
radmin(8), raddb/sites-available/control-socket, unlang(5), radiusd.conf(5)

## AUTHORS
Alan DeKok <aland@freeradius.org>


radiusd

title: radiusd(8)

text:
# radiusd(8)

## NAME
radiusd - Authentication, Authorization and Accounting server

## SYNOPSIS
radiusd [-C] [-d config_directory] [-D dictionary_directory] [-f] [-h] [-i ip-address] [-l log_file] [-m] [-n name] [-p port] [-P] [-s] [-t] [-v] [-x] [-X]

## DESCRIPTION
FreeRADIUS is a high-performance and highly configurable RADIUS server. It supports many database back-ends such as flat-text files, SQL, LDAP, Perl, Python, etc. It also supports many authentication protocols such as PAP, CHAP, MS-CHAP(v2), HTTP Digest, and EAP (EAP-MD5, EAP-TLS, PEAP, EAP-TTLS, EAP-SIM, etc.).

It also has full support for Cisco's VLAN Query Protocol (VMPS) and DHCP.

Please read the DEBUGGING section below. It contains instructions for quickly configuring the server for your local system.

## OPTIONS
The following command-line options are accepted by the server:

-C

Check the configuration and exit immediately. If there is a problem reading the configuration, then the server will exit with a non-zero status code. If the configuration appears to be acceptable, then the server will exit with a zero status code. Note that there are limitations to this check. Due to the complexities involved in almost starting a RADIUS server, these checks are necessarily incomplete. The server can return a zero status code when run with -C, but may still exit with an error when run normally.

See the output of radiusd -XC for an informative list of which modules are checked for correct configuration, and which modules are skipped, and therefore not checked.

-d config directory

Defaults to /etc/raddb. Radiusd looks here for its configuration files such as the dictionary and the users files.

-D dictionary directory

Set main dictionary directory. Defaults to /usr/share/freeradius.

-f

Do not fork, stay running as a foreground process.

-h

Print usage help information.

-i ip-address

Defines which IP address that the server uses for sending and receiving packets. If this command-line option is given, then the "bind_address" and all "listen{}" entries in radiusd.conf are ignored.

This option MUST be used in conjunction with "-p".

-l log_file

Defaults to ${logdir}/radius.log. Radiusd writes it's logging information to this file. If log_file is the string "stdout" logging will be written to stdout.

-m

On SIGINT or SIGQUIT exit cleanly instead of immediately. This is most useful for when running the server with "valgrind".

-n name

Read raddb/name.conf instead of raddb/radiusd.conf.

-p port

Defines which port is used for receiving authentication packets. Accounting packets are received on "port + 1". When this command-line option is given, all "listen" sections in radiusd.conf are ignored.

This option MUST be used in conjunction with "-i".

-P

Always write out PID, even with -f.

-s

Run in "single server" mode. The server normally runs with multiple threads and/or processes, which can lower its response time to requests. Some systems have issues with threading, however, so running in "single server" mode may help to address those issues. In single server mode, the server will also not "daemonize" (auto-background) itself.

-t

Do not spawn threads.

-v

Print server version information and exit.

-X

Debugging mode. Equivalent to "-sfxx -l stdout". When trying to understand how the server works, ALWAYS run it with "radiusd -X". For production servers, use "raddebug"

-x

Finer-grained debug mode. In this mode the server will print details of every request on it's stdout output. You can specify this option multiple times (-x -x or -xx) to get more detailed output.

## DEBUGGING
The default configuration is set to work in the widest possible circumstances. It requires minimal changes for your system.

However, your needs may be complex, and may require significant changes to the server configuration. Making random changes is a guaranteed method of failure. Instead, we STRONGLY RECOMMEND proceeding via the following steps:

1) Always run the server in debugging mode ( radiusd -X ) after making a configuration change. We cannot emphasize this enough. If you are not running the server in debugging mode, you will not be able to see what is doing, and you will not be able to correct any problems.

If you ask questions on the mailing list, the first response will be to tell you "run the server in debugging mode". Please, follow these instructions.

2) Change as little as possible in the default configuration files. The server contains a decade of experience with protocols, databases, and different systems. Its default configuration is designed to work almost everywhere, and to do almost everything you need.

3) When you make a small change, testing it before changing anything else. If the change works, save a copy of the configuration, and make another change. If the change doesn't work, debug it, and try to understand why it doesn't work.

If you begin by making large changes to the server configuration, it will never work, and you will never be able to debug the problem.

4) If you need to add a connection to a database FOO (e.g. LDAP or SQL), then:

a) Edit raddb/modules/foo

This file contains the default configuration for the module. It contains comments describing what can be configured, and what those configuration entries mean.

b) Edit raddb/sites-available/default

This file contains the default policy for the server. e.g. "enable CHAP, MS-CHAP, and EAP authentication". Look in this file for all references to your module "foo". Read the comments, and remove the leading hash '#' from the lines referencing the module. This enables the module.

c) Edit raddb/sites-available/inner-tunnel

This file contains the default policy for the "tunneled" portion of certain EAP methods. Perform the same kind of edits as above, for the "default" file.. If you are not using EAP (802.1X), then this step can be skipped.

d) Start the server in debugging mode ( radiusd -X ), and start testing.

5) Ask questions on the mailing list (freeradius-users@lists.freeradius.org). When asking questions, include the output from debugging mode ( radiusd -X ). This information will allow people to help you. If you do not include it, the first response to your message will be "post the output of debug mode".

Ask questions earlier, rather than later. If you cannot solve a problem in a day, ask a question on the mailing list. Most questions have been seen before, and can be answered quickly.

## BACKGROUND
RADIUS is a protocol spoken between an access server, typically a device connected to several modems or ISDN lines, and a radius server. When a user connects to the access server, (s)he is asked for a loginname and a password. This information is then sent to the radius server. The server replies with "access denied", or "access OK". In the latter case login information is sent along, such as the IP address in the case of a PPP connection.

The access server also sends login and logout records to the radius server so accounting can be done. These records are kept for each terminal server separately in a file called detail, and in the wtmp compatible logfile /var/log/radwtmp.

## CONFIGURATION
Radiusd uses a number of configuration files. Each file has it's own manpage describing the format of the file. These files are:

radiusd.conf

The main configuration file, which sets the administrator-controlled items.

dictionary

This file is usually static. It defines all the possible RADIUS attributes used in the other configuration files. You don't have to modify it. It includes other dictionary files in the same directory.

hints

Defines certain hints to the radius server based on the users's loginname or other attributes sent by the access server. It also provides for mapping user names (such as Pusername -> username). This provides the functionality that the Livingston 2.0 server has as "Prefix" and "Suffix" support in the users file, but is more general. Of course the Livingston way of doing things is also supported, and you can even use both at the same time (within certain limits).

huntgroups

Defines the huntgroups that you have, and makes it possible to restrict access to certain huntgroups to certain (groups of) users.

users

Here the users are defined. On a typical setup, this file mainly contains DEFAULT entries to process the different types of logins, based on hints from the hints file. Authentication is then based on the contents of the UNIX /etc/passwd file. However it is also possible to define all users, and their passwords, in this file.

## SEE ALSO
radiusd.conf(5), users(5), huntgroups(5), hints(5), dictionary(5), raddebug(8)

## AUTHOR
The FreeRADIUS Server Project (http://www.freeradius.org)