The GNU FreeIPMI User's Guide

This edition of the documentation was last updated on November, 13 2006 for release 0.3.0 of the GNU FreeIPMI.

1. Introduction to the GNU FreeIPMI system
2. Installing GNU FreeIPMI		Installing the software.
3. IPMI C library (libfreeipmi)		C library for IPMI
4. ipmi-locate IPMI device probing tool		IPMI device probing tool.
5. bmc-config		Baseboard Management Controller configurator.
6. bmc-info		Baseboard Management Controller information.
7. bmc-autoconfig		Wizard-like frontend for bmc-config.
8. ipmi-raw		executes IPMI commands by hex values.
9. ipmi-sensors		IPMI sensors utility.
10. ipmi-sel		IPMI System Event Log.
11. bmc-watchdog		Watchdog daemon.
12. IPMI power control utility		IPMI power control utility.
13. IPMI SOL console utility		IPMI SOL Console utility.
14. ipmiping		IPMI ping reachability test utility.
15. rmcpping		RMCP ping reachability test utility.
16. Trouble-shooting		Trouble-shooting tips.
17. Contact us		Contact Information.
18. Authors		FreeIPMI core team members.
19. Copying		GNU FreeIPMI is a Free Software.
20. Glossary		Conventions and terminologies.
Concept index		Index of concepts.
Program index		Index of programs.

1. Introduction to the GNU FreeIPMI system

GNU FreeIPMI is a Free Intelligent Platform Management System Software. It provides "Remote-Console" (out-of-band), "System Management Software" (in-band) and a development library confirming to Intelligent Platform Management Interface (IPMI v1.5 and v2.0) standards.

GNU FreeIPMI User's Guide concentrates installation, usage, troubleshooting and bug reporting. It corresponds to 0.3.0 release.

1.1 Who should read this guide?
1.2 IPMI - Platform Management Standard		Platform Management Standard.

1.1 Who should read this guide?

1.2 IPMI - Platform Management Standard

The IPMI specifications define standardized, abstracted interfaces to the platform management subsystem. IPMI includes the definition of interfaces for extending platform management between board within the main chassis, and between multiple chassis.

The term platform management is used to refer to the monitoring and control functions that are built in to the platform hardware and primarily used for the purpose of monitoring the health of the system hardware. This typically includes monitoring elements such as system temperatures, voltages, fans, power supplies, bus errors, system physical security, etc. It includes automatic and manually driven recovery capabilities such as local or remote system resets and power on/off operations. It includes the logging of abnormal or out-of-range conditions for later examination and alerting where the platform issues the alert without aid of run-time software. Lastly it includes inventory information that can help identify a failed hardware unit.

2. Installing GNU FreeIPMI

2.1 Dependencies		Dependent run-time and libraries.
2.2 Building the source package.		Compile and install from the source.
2.3 Test Fire		Test fire your installation.

2.1 Dependencies

List of dependencies under GNU/Linux:

• GNU libgcrypt

List of dependencies under FreeBSD:

• FreeBSD (tested on FreeBSD 5.3-BETA7) -
  You will need "options SYSVSEM" in your kernel config or sysvsem.ko module loaded. On FreeBSD > 5.2.1 You will also need "device io" in kernel or loaded as module unless You specify USE_IOPERM compilation option (see note on i386_set_ioperm below).

• argp library (tested with argp-standalone-1.3) - ports/devel/argp-standalone.
• gmake

2.2 Building the source package.

To compile the program, you must first run the configure script included with the source tar ball. It works just like any other standard GNU autoconf created script. See the more generic configure related installation instructions below.

For complete list of options, try configure --help.

Note: Please run ./autogen.sh script before ./configure, if you are compiling FreeIPMI source from CVS.

Note2: Under some x86-64 platforms such as SUSE GNU/Linux, native 64 bit libraries reside under lib64 and 32 bit libs under lib. Autotools by default installs libfreeipmi.so under /usr/lib, instead of /usr/lib64 causing dynamic linking errors. Pass libdir appropriately to configure script to workaround this problem. (i.e. --libdir=/usr/lib64)

# ./configure --prefix=/usr # make # make install

2.2.1 Installing under FreeBSD:

Example:

tar xzvf freeipmi-0.3.0.tar.gz cd freeipmi-0.3.0 env CFLAGS="-I/usr/local/include" \ LDFLAGS="-L/usr/local/lib -largp" \ ./configure gmake all # su to root gmake install mkdir -p /var/lib/freeipmi chmod 0700 /var/lib/freeipmi touch /var/lib/freeipmi/ipckey

2.2.1.1 Using i386_set_ioperm(2) instead of io(4) under FreeBSD:

Example:

env CFLAGS="-DUSE_IOPERM -I/usr/local/include" \ LDFLAGS="-L/usr/local/lib -largp" \ ./configure

2.3 Test Fire

Test if IPMI works:

ipmitest:~# bmc-info Device ID: 20 Device Revision: 1 [SDR Support] Firmware Revision: 1.32 [Device Available (normal operation)] IPMI Version: 1.5 Additional Device Support: [Sensor Device] [SDR Repository Device] [SEL Device] [FRU Inventory Device] [IPMB Event Receiver] [Chassis Device] Manufacturer ID: B000157h Product ID: 1Bh Aux Firmware Revision Info: 10011500h Channel Information: Channel No: 0 Medium Type: IPMB (I2C) Protocol Type: IPMB-1.0 Channel No: 1 Medium Type: Asynch. Serial/Modem (RS-232) Protocol Type: IPMB-1.0 Channel No: 3 Medium Type: PCI SMBus Protocol Type: IPMI-SMBus Channel No: 4 Medium Type: System Interface (KCS, SMIC, or BT) Protocol Type: KCS Channel No: 6 Medium Type: 802.3 LAN Protocol Type: IPMB-1.0 Channel No: 7 Medium Type: 802.3 LAN Protocol Type: IPMB-1.0 ipmitest:~#

If you don't get the expected response from bmc-info command, please refer to 16. Trouble-shooting.

3. IPMI C library (libfreeipmi)

The Core of the GNU FreeIPMI system consists of LAN, OpenIPMI, KCS, and SSIF interface drivers, all packaged in a single portable C library. Management applications can access the BMC at various levels using higher level IPMI command APIs or raw read/write interfaces to the drivers.

The library internally uses DMI, SMBIOS, PCI, and ACPI drivers to locate the system interfaces.

4. ipmi-locate IPMI device probing tool

4.1 Command-line options

• --brief
  Shorten output.

• --quiet, --silent
  Inhibit usual output.

• -v, --verbose
  Print more information.

• -?, --help
  Give this help list.

• --usage
  Give a short usage message.

• -V, --version
  Print program version.

4.2 Example

www:~# ipmi-locate 
Probing KCS device using SMBIOS... done
IPMI Version: 1.5
IPMI locate driver: SMBIOS
IPMI locate driver: 0
IPMI interface: KCS
BMC I2C device: (null)
BMC I/O base address: CA2
Register space: 1

Probing SMIC device using SMBIOS... FAILED

Probing BT device using SMBIOS... FAILED

Probing SSIF device using SMBIOS... FAILED

Probing KCS device using ACPI... FAILED

Probing SMIC device using ACPI... FAILED

Probing BT device using ACPI... FAILED

Probing SSIF device using ACPI... FAILED

Probing KCS device using PCI... FAILED

Probing SMIC device using PCI... FAILED

Probing BT device using PCI... FAILED

Probing SSIF device using PCI... FAILED

KCS device default values:
IPMI Version: 1.5
IPMI locate driver: DEFAULT
IPMI locate driver: 0
IPMI interface: KCS
BMC I2C device: (null)
BMC I/O base address: CA2
Register space: 1

SMIC device default values:
IPMI Version: 1.5
IPMI locate driver: DEFAULT
IPMI locate driver: 0
IPMI interface: SMIC
BMC I2C device: (null)
BMC I/O base address: CA9
Register space: 1

BT device default values:

SSIF device default values:
IPMI Version: 1.5
IPMI locate driver: DEFAULT
IPMI locate driver: 0
IPMI interface: SSIF
BMC I2C device: /dev/i2c-0
BMC SMBUS slave address: 20
Register space: 1

www:~# 

5. bmc-config

5.1 Command-line arguments to bmc-config
5.2 Sample Configuration File
5.3 Extracting current BMC configuration
5.4 Update BMC configuration
5.5 Compare BMC configuration

5.1 Command-line arguments to bmc-config

• --no-probing
  Do not probe IPMI devices.

• -D, --driver-type=IPMIDRIVER
  Use this IPMIDRIVER instead of auto selection. Allowed values are KCS, SMIC, SSIF and LAN.

• --driver-address=DRIVERADDR
  Use this DRIVERADDR address instead of probed one.

• --driver-device=DEVICE
  Use this DEVICE for IPMI driver.

• --register-spacing=REGISTERSPACING
  Use this REGISTERSPACING instead of the probed one.

• -h, --hostname=IPMIHOST
  Connect to IPMIHOST.

• -u, --username=USERNAME
  Use USERNAME instead of NULL. Maximum USERNAME length is 16.

• -p, --password=PASSWORD
  Use PASSWORD instead of NULL. Maximum PASSWORD length is 16.

• -a, --auth-type=AUTHTYPE
  Use AUTHTYPE instead of MD5. Allowed values are NONE, MD2, MD5, and PLAIN.

• -l, --priv-level=PRIVILEGE-LEVEL
  Use this PRIVILEGE-LEVEL instead of ADMIN. Allowed values are CALLBACK, USER, OPERATOR, ADMIN and OEM.

• -?, --help
  Give this help list.

• --usage
  Give a short usage message.

• -V, --version
  Print program version.

• -o, --checkout
  Fetch configuration information from BMC.

• -i, --commit
  Update configuration information to BMC.

• -d, --diff
  Show differences between BMC and config file or key pairs.

• -f, --filename=FILENAME
  Use this file for BMC get/set.

• -k, --key-pair=KEY-PAIR
  Update configuration information to BMC. This option can be used multiple times.

• -S, --section=SECTION
  Use SECTION for checkout. This option can be used multiple times.

• -L, --listsections
  List available sections for checkout.

• -v, --verbose
  Print detailed information.

5.2 Sample Configuration File

Example: Extracting BMC configuration to stdout.

debian-ia64:~# bmc-config --checkout Section User1 ## Give Username Username NULL ## Possible values: Yes/No or blank to not set ## Enable_User ## Give password or blank to clear. MAX 16 chars. ## Password ## Possible values: Yes/No Lan_Enable_IPMI_Msgs No ## Possible values: Yes/No Lan_Enable_Link_Auth No ## Possible values: Yes/No Lan_Enable_Restricted_to_Callback No ## Possible values: Callback/User/Operator/Administrator/OEM_Proprietary/No_Access Lan_Privilege_Limit No_Access ## Possible values: Yes/No Serial_Enable_IPMI_Msgs No ## Possible values: Yes/No Serial_Enable_Link_Auth No ## Possible values: Yes/No Serial_Enable_Restricted_to_Callback No ## Possible values: Callback/User/Operator/Administrator/OEM_Proprietary/No_Access Serial_Privilege_Limit Administrator EndSection Section User2 ## Give Username Username USER ## Possible values: Yes/No or blank to not set ## Enable_User ## Give password or blank to clear. MAX 16 chars. ## Password ## Possible values: Yes/No Lan_Enable_IPMI_Msgs Yes ## Possible values: Yes/No Lan_Enable_Link_Auth No ## Possible values: Yes/No Lan_Enable_Restricted_to_Callback No ## Possible values: Callback/User/Operator/Administrator/OEM_Proprietary/No_Access Lan_Privilege_Limit User ## Possible values: 0-255, 0 is unlimited Serial_Enable_IPMI_Msgs No ## Possible values: Yes/No Serial_Enable_Link_Auth No ## Possible values: Yes/No Serial_Enable_Restricted_to_Callback No ## Possible values: Callback/User/Operator/Administrator/OEM_Proprietary/No_Access Serial_Privilege_Limit No_Access EndSection Section User3 ## Give Username Username OPERATOR ## Possible values: Yes/No or blank to not set ## Enable_User ## Give password or blank to clear. MAX 16 chars. ## Password ## Possible values: Yes/No Lan_Enable_IPMI_Msgs Yes ## Possible values: Yes/No Lan_Enable_Link_Auth No ## Possible values: Yes/No Lan_Enable_Restricted_to_Callback No ## Possible values: Callback/User/Operator/Administrator/OEM_Proprietary/No_Access Lan_Privilege_Limit Operator ## Possible values: Yes/No Serial_Enable_IPMI_Msgs No ## Possible values: Yes/No Serial_Enable_Link_Auth No ## Possible values: Yes/No Serial_Enable_Restricted_to_Callback No ## Possible values: Callback/User/Operator/Administrator/OEM_Proprietary/No_Access Serial_Privilege_Limit No_Access EndSection Section User4 ## Give Username Username ADMIN ## Possible values: Yes/No or blank to not set ## Enable_User ## Give password or blank to clear. MAX 16 chars. ## Password ## Possible values: Yes/No Lan_Enable_IPMI_Msgs Yes ## Possible values: Yes/No Lan_Enable_Link_Auth No ## Possible values: Yes/No Lan_Enable_Restricted_to_Callback No ## Possible values: Callback/User/Operator/Administrator/OEM_Proprietary/No_Access Lan_Privilege_Limit Administrator ## Possible values: Yes/No Serial_Enable_IPMI_Msgs No ## Possible values: Yes/No Serial_Enable_Link_Auth No ## Possible values: Yes/No Serial_Enable_Restricted_to_Callback No ## Possible values: Callback/User/Operator/Administrator/OEM_Proprietary/No_Access Serial_Privilege_Limit No_Access EndSection Section Lan_Channel ## Possible values: Disabled/Pre_Boot_Only/Always_Available/Shared Volatile_Access_Mode Always_Available ## Possible values: Yes/No Volatile_Enable_User_Level_Auth Yes ## Possible values: Yes/No Volatile_Enable_Per_Message_Auth Yes ## Possible values: Yes/No Volatile_Enable_Pef_Alerting No ## Possible values: Callback/User/Operator/Administrator/OEM_Proprietary/No_Access Volatile_Channel_Privilege_Limit Administrator ## Possible values: Disabled/Pre_Boot_Only/Always_Available/Shared Non_Volatile_Access_Mode Always_Available ## Possible values: Yes/No Non_Volatile_Enable_User_Level_Auth Yes ## Possible values: Yes/No Non_Volatile_Enable_Per_Message_Auth Yes ## Possible values: Yes/No Non_Volatile_Enable_Pef_Alerting No ## Possible values: Callback/User/Operator/Administrator/OEM_Proprietary/No_Access Non_Volatile_Channel_Privilege_Limit Administrator EndSection Section Lan_Conf ## Possible values: Unspecified/Static/Use_DHCP/Use_BIOS/Use_Others IP_Address_Source Static ## Give valid IP address IP_Address 192.168.1.60 ## Give valid MAC address MAC_Address 00:0E:0C:21:81:B4 ## Give valid Subnet Mask Subnet_Mask 255.255.255.0 ## Give valid IP address Default_Gateway_IP_Address 0.0.0.0 ## Give valid MAC address Default_Gateway_MAC_Address 00:00:00:00:00:00 ## Give valid IP address Backup_Gateway_IP_Address 0.0.0.0 ## Give valid MAC address Backup_Gateway_MAC_Address 00:00:00:00:00:00 EndSection Section Lan_Conf_Auth ## Possible values: Yes/No Callback_Enable_Auth_Type_None No ## Possible values: Yes/No Callback_Enable_Auth_Type_MD2 No ## Possible values: Yes/No Callback_Enable_Auth_Type_MD5 No ## Possible values: Yes/No Callback_Enable_Auth_Type_Straight_Password No ## Possible values: Yes/No Callback_Enable_Auth_Type_OEM_Proprietary No ## Possible values: Yes/No User_Enable_Auth_Type_None No ## Possible values: Yes/No User_Enable_Auth_Type_MD2 No ## Possible values: Yes/No User_Enable_Auth_Type_MD5 Yes ## Possible values: Yes/No User_Enable_Auth_Type_Straight_Password No ## Possible values: Yes/No User_Enable_Auth_Type_OEM_Proprietary No ## Possible values: Yes/No Operator_Enable_Auth_Type_None No ## Possible values: Yes/No Operator_Enable_Auth_Type_MD2 No ## Possible values: Yes/No Operator_Enable_Auth_Type_MD5 Yes ## Possible values: Yes/No Operator_Enable_Auth_Type_Straight_Password No ## Possible values: Yes/No Operator_Enable_Auth_Type_OEM_Proprietary No ## Possible values: Yes/No Admin_Enable_Auth_Type_None No ## Possible values: Yes/No Admin_Enable_Auth_Type_MD2 No ## Possible values: Yes/No Admin_Enable_Auth_Type_MD5 Yes ## Possible values: Yes/No Admin_Enable_Auth_Type_Straight_Password No ## Possible values: Yes/No Admin_Enable_Auth_Type_OEM_Proprietary No ## Possible values: Yes/No OEM_Enable_Auth_Type_None No ## Possible values: Yes/No OEM_Enable_Auth_Type_MD2 No ## Possible values: Yes/No OEM_Enable_Auth_Type_MD5 No ## Possible values: Yes/No OEM_Enable_Auth_Type_Straight_Password No ## Possible values: Yes/No OEM_Enable_Auth_Type_OEM_Proprietary No EndSection Section Lan_Conf_Security_Keys ## Give string or blank to clear. Max 20 chars ## K_R ## Give string or blank to clear. Max 20 chars ## K_G EndSection Section Lan_Conf_Misc ## Possible values: Yes/No Enable_Gratuitous_ARPs No ## Possible values: Yes/No Enable_ARP_Response No ## Give a number (x 500ms) Gratuitous_ARP_Interval 10 EndSection Section Rmcpplus_Conf_Privilege ## Possible values: Unused/User/Operator/Administrator/OEM_Proprietary Maximum_Privilege_Cipher_Suite_Id_0 Administrator ## Possible values: Unused/User/Operator/Administrator/OEM_Proprietary Maximum_Privilege_Cipher_Suite_Id_1 Administrator ## Possible values: Unused/User/Operator/Administrator/OEM_Proprietary Maximum_Privilege_Cipher_Suite_Id_2 Administrator ## Possible values: Unused/User/Operator/Administrator/OEM_Proprietary Maximum_Privilege_Cipher_Suite_Id_3 Administrator ## Possible values: Unused/User/Operator/Administrator/OEM_Proprietary Maximum_Privilege_Cipher_Suite_Id_4 Administrator ## Possible values: Unused/User/Operator/Administrator/OEM_Proprietary Maximum_Privilege_Cipher_Suite_Id_5 Administrator ## Possible values: Unused/User/Operator/Administrator/OEM_Proprietary Maximum_Privilege_Cipher_Suite_Id_6 Administrator ## Possible values: Unused/User/Operator/Administrator/OEM_Proprietary Maximum_Privilege_Cipher_Suite_Id_7 Administrator ## Possible values: Unused/User/Operator/Administrator/OEM_Proprietary Maximum_Privilege_Cipher_Suite_Id_8 Administrator ## Possible values: Unused/User/Operator/Administrator/OEM_Proprietary Maximum_Privilege_Cipher_Suite_Id_9 Administrator ## Possible values: Unused/User/Operator/Administrator/OEM_Proprietary Maximum_Privilege_Cipher_Suite_Id_10 Administrator ## Possible values: Unused/User/Operator/Administrator/OEM_Proprietary Maximum_Privilege_Cipher_Suite_Id_11 Administrator ## Possible values: Unused/User/Operator/Administrator/OEM_Proprietary Maximum_Privilege_Cipher_Suite_Id_12 Administrator ## Possible values: Unused/User/Operator/Administrator/OEM_Proprietary Maximum_Privilege_Cipher_Suite_Id_13 Administrator ## Possible values: Unused/User/Operator/Administrator/OEM_Proprietary Maximum_Privilege_Cipher_Suite_Id_14 Administrator EndSection Section Serial_Channel ## Possible values: Disabled/Pre_Boot_Only/Always_Available/Shared Volatile_Access_Mode Always_Available ## Possible values: Yes/No Volatile_Enable_User_Level_Auth Yes ## Possible values: Yes/No Volatile_Enable_Per_Message_Auth No ## Possible values: Yes/No Volatile_Enable_Pef_Alerting No ## Possible values: Callback/User/Operator/Administrator/OEM_Proprietary/No_Access Volatile_Channel_Privilege_Limit Administrator ## Possible values: Disabled/Pre_Boot_Only/Always_Available/Shared Non_Volatile_Access_Mode Always_Available ## Possible values: Yes/No Non_Volatile_Enable_User_Level_Auth Yes ## Possible values: Yes/No Non_Volatile_Enable_Per_Message_Auth No ## Possible values: Yes/No Non_Volatile_Enable_Pef_Alerting No ## Possible values: Callback/User/Operator/Administrator/OEM_Proprietary/No_Access Non_Volatile_Channel_Privilege_Limit Administrator EndSection Section Serial_Conf ## Possible values: Yes/No Enable_Basic_Mode Yes ## Possible values: Yes/No Enable_PPP_Mode Yes ## Possible values: Yes/No Enable_Terminal_Mode Yes ## Possible values: Modem_Connect/Direct_Mode Connect_Mode Direct_Connect ## Give a valid number Page_Blackout_Interval 0 ## Give a valid number Call_Retry_Interval 60 ## Possible values: Yes/No Enable_DTR_Hangup No ## Possible values: No_Flow_Control/RTS_CTS/XON_XOFF Flow_Control No_Flow_Control ## Possible values: 9600/19200/38400/57600/115200 Bit_Rate 115200 EndSection Section PEF_Conf ## Possible values: Yes/No Enable_PEF No ## Possible values: Yes/No Enable_PEF_Event_Messages No ## Possible values: Yes/No Enable_PEF_Startup_Delay No ## Possible values: Yes/No Enable_PEF_Alert_Startup_Delay No ## Possible values: Yes/No Enable_Alert_Action Yes ## Possible values: Yes/No Enable_Power_Down_Action Yes ## Possible values: Yes/No Enable_Reset_Action Yes ## Possible values: Yes/No Enable_Power_Cycle_Action Yes ## Possible values: Yes/No Enable_OEM_Action No ## Possible values: Yes/No Enable_Diagnostic_Interrupt Yes ## Give value in seconds PEF_Startup_Delay 255 ## Give value in seconds PEF_Alert_Startup_Delay 60 EndSection Section SOL_Conf ## Possible values: Yes/No Enable_SOL Yes ## Possible values: Callback/User/Operator/Administrator/OEM_Proprietary SOL_Privilege_Level Administrator ## Possible values: Yes/No Force_SOL_Payload_Authentication Yes ## Possible values: Yes/No Force_SOL_Payload_Encryption Yes ## Give a valid integer. Each unit is 5ms Character_Accumulate_Interval 50 ## Give a valid number Character_Send_Threshold 100 ## Give a valid integer SOL_Retry_Count 5 ## Give a valid integer. Interval unit is 10ms SOL_Retry_Interval 50 ## Possible values: Serial/9600/19200/38400/57600/115200 Non_Volatile_Bit_Rate 115200 ## Possible values: Serial/9600/19200/38400/57600/115200 Volatile_Bit_Rate 115200 ## Give a valid port number ## SOL_Payload_Port_Number 623 EndSection Section Misc ## Possible values: Off_State_AC_Apply/Restore_State_AC_Apply/On_State_AC_Apply Power_Restore_Policy Off_State_AC_Apply EndSection debian-ia64:~#

5.3 Extracting current BMC configuration

Example: Creating a BMC configuration file.

debian-ia64:~# bmc-config --checkout --filename=/tmp/bmc.conf

Alternatively you can redirect stdout to the configuration file too.

debian-ia64:~# bmc-config --checkout > /tmp/bmc.conf

5.4 Update BMC configuration

Example using configuration file:

debian-ia64:~# bmc-config --commit -f /tmp/bmc.conf

Example using a specific key:

debian-ia64:~# bmc-config --commit -k "Lan_conf:Ip_Address=192.168.1.60"

Note: At this point of time, configuration settings can only be fed through a file or key-value pairs and not stdin.

5.5 Compare BMC configuration

To compare the differences between current active BMC settings and the configuration file, use "diff" option

Example: Comparing the configuration file and BMC settings.

debian-ia64:~# bmc-config --diff -f /tmp/bmc.conf Lan_Conf:IP_Address - input=`192.168.10.160':actual=`192.168.1.60' debian-ia64:~# bmc-config --diff -k "User2:Username=guest" User2:Username - input=`guest':actual=`usertest' debian-ia64:~#

6. bmc-info

6.1 Command-line options

• --no-probing
  Do not probe IPMI devices.

• -D, --driver-type=IPMIDRIVER
  Use this IPMIDRIVER instead of auto selection. Allowed values are KCS, SMIC, SSIF and LAN.

• --driver-address=DRIVERADDR
  Use this DRIVERADDR address instead of probed one.

• --driver-device=DEVICE
  Use this DEVICE for IPMI driver.

• --register-spacing=REGISTERSPACING
  Use this REGISTERSPACING instead of the probed one.

• -h, --hostname=IPMIHOST
  Connect to IPMIHOST.

• -u, --username=USERNAME
  Use USERNAME instead of NULL. Maximum USERNAME length is 16.

• -p, --password=PASSWORD
  Use PASSWORD instead of NULL. Maximum PASSWORD length is 16.

• -a, --auth-type=AUTHTYPE
  Use AUTHTYPE instead of MD5. Allowed values are NONE, MD2, MD5, and PLAIN.

• -l, --priv-level=PRIVILEGE-LEVEL
  Use this PRIVILEGE-LEVEL instead of USER. Allowed values are CALLBACK, USER, OPERATOR, ADMIN and OEM.

• -?, --help
  Give this help list.

• --usage
  Give a short usage message.

• -V, --version
  Print program version.

6.2 Example

ipmitest:~# bmc-info
Device ID:         20
Device Revision:   1
                   [SDR Support]
Firmware Revision: 1.32
                   [Device Available (normal operation)]
IPMI Version:      1.5
Additional Device Support:
                   [Sensor Device]
                   [SDR Repository Device]
                   [SEL Device]
                   [FRU Inventory Device]
                   [IPMB Event Receiver]
                   [Chassis Device]
Manufacturer ID:   B000157h
Product ID:        1Bh
Aux Firmware Revision Info: 10011500h
Channel Information:
       Channel No: 0
      Medium Type: IPMB (I2C)
    Protocol Type: IPMB-1.0
       Channel No: 1
      Medium Type: Asynch. Serial/Modem (RS-232)
    Protocol Type: IPMB-1.0
       Channel No: 3
      Medium Type: PCI SMBus
    Protocol Type: IPMI-SMBus
       Channel No: 4
      Medium Type: System Interface (KCS, SMIC, or BT)
    Protocol Type: KCS
       Channel No: 6
      Medium Type: 802.3 LAN
    Protocol Type: IPMB-1.0
       Channel No: 7
      Medium Type: 802.3 LAN
    Protocol Type: IPMB-1.0
ipmitest:~# 

7. bmc-autoconfig

7.1 Command-line options

bmc-autoconfig command-line options are as same as bmc-config utility. If no arguments are passed, wizard interface is shown. For a complete list of options, refer here See bmc-config Command-line options.

8. ipmi-raw

8.1 Command-line options

• --no-probing
  Do not probe IPMI devices.

• -D, --driver-type=IPMIDRIVER
  Use this IPMIDRIVER instead of auto selection. Allowed values are KCS, SMIC, SSIF and LAN.

• --driver-address=DRIVERADDR
  Use this DRIVERADDR address instead of probed one.

• --driver-device=DEVICE
  Use this DEVICE for IPMI driver.

• --register-spacing=REGISTERSPACING
  Use this REGISTERSPACING instead of the probed one.

• -h, --hostname=IPMIHOST
  Connect to IPMIHOST.

• -u, --username=USERNAME
  Use USERNAME instead of NULL. Maximum USERNAME length is 16.

• -p, --password=PASSWORD
  Use PASSWORD instead of NULL. Maximum PASSWORD length is 16.

• -a, --auth-type=AUTHTYPE
  Use AUTHTYPE instead of NONE. Allowed values are NONE, MD2, MD5, and PLAIN.

• -l, --priv-level=PRIVILEGE-LEVEL
  Use this PRIVILEGE-LEVEL instead of USER. Allowed values are CALLBACK, USER, OPERATOR, ADMIN and OEM.

• -?, --help
  Give this help list.

• --usage
  Give a short usage message.

• -V, --version
  Print program version.

8.2 Example

www:~# ipmi-raw
0 6 01
rcvd: 1C 01 00 20 81 01 20 51 9F 57 01 00 1B 00 00 15 01 10 
www:~# 

9. ipmi-sensors

9.1 command-line arguments		Command-line arguments.
9.2 ipmi-sensors output		Example.

9.1 command-line arguments

• --no-probing
  Do not probe IPMI devices.

• -D, --driver-type=IPMIDRIVER
  Use this IPMIDRIVER instead of auto selection. Allowed values are KCS, SMIC, SSIF and LAN.

• --driver-address=DRIVERADDR
  Use this DRIVERADDR address instead of probed one.

• --driver-device=DEVICE
  Use this DEVICE for IPMI driver.

• --register-spacing=REGISTERSPACING
  Use this REGISTERSPACING instead of the probed one.

• -h, --hostname=IPMIHOST
  Connect to IPMIHOST.

• -u, --username=USERNAME
  Use USERNAME instead of NULL. Maximum USERNAME length is 16.

• -p, --password=PASSWORD
  Use PASSWORD instead of NULL. Maximum PASSWORD length is 16.

• -a, --auth-type=AUTHTYPE
  Use AUTHTYPE instead of MD5. Allowed values are NONE, MD2, MD5, and PLAIN.

• -l, --priv-level=PRIVILEGE-LEVEL
  Use this PRIVILEGE-LEVEL instead of USER. Allowed values are CALLBACK, USER, OPERATOR, ADMIN and OEM.

• -v, --verbose
  Verbose sensor output.

• -vv
  Very verbose sensor output.

• -i, --sdr-info
  Show SDR Information.

• -f, --flush-cache
  Flush sensor cache.

• -L, --list-groups
  List sensor groups.

• -g, --group=GROUP-NAME
  Show sensors belongs to this GROUP.

• -s, --sensors=SENSORS-LIST
  Show listed sensors.

• --sdr-cache-directory=DIRECTORY
  Use DIRECTORY for sensor cache.

• -?, --help
  Give this help list.

• --usage
  Give a short usage message.

• -V, --version
  Print program version.

9.2 ipmi-sensors output

www:~# ipmi-sensors 
1: MB Bd +1.25V (Voltage): 1.27 V (1.15/1.34): [OK]
2: MB Bd +1.5V (Voltage): 1.57 V (1.38/1.61): [OK]
3: MB Bd +1.8V (Voltage): 1.80 V (1.66/1.93): [OK]
4: MB Bd +3.3V (Voltage): 3.33 V (3.04/3.53): [OK]
5: MB Bd +3.3V SB (Voltage): 3.40 V (2.93/3.58): [OK]
6: MB Bd +5V (Voltage): 4.91 V (4.60/5.36): [OK]
7: MB Bd +12V (Voltage): 11.97 V (10.97/12.77): [OK]
8: MB Bd -12V (Voltage): -12.13 V (-13.00/-11.20): [OK]
9: MB Bd +1.2V (Voltage): 1.22 V (1.08/1.31): [OK]
10: MB Bd +1.3V (Voltage): 1.31 V (1.17/1.42): [OK]
11: MB Bd +1.5V SB (Voltage): 1.50 V (1.38/1.61): [OK]
12: MB Bd +2.5V (Voltage): 2.49 V (2.28/2.69): [OK]
13: MB Bd +2.5V SB (Voltage): 2.52 V (2.28/2.69): [OK]
14: MB Bd +5V SB (Voltage): 5.10 V (4.50/5.34): [OK]
15: MB Bd Temp (Temperature): 33.00 C (5.00/55.00): [OK]
16: MB Bd SNC Temp (Temperature): 46.00 C (5.00/105.00): [OK]
17: MB Bd SIOH Temp (Temperature): 38.00 C (5.00/95.00): [OK]
18: FPBD AMB Temp (Temperature): 20.00 C (5.00/50.00): [OK]
19: PCI Rsr Temp (Temperature): 23.00 C (5.00/60.00): [OK]
20: CPU AREA Temp (Temperature): 20.00 C (5.00/60.00): [OK]
21: MEM AREA Temp (Temperature): 35.00 C (5.00/80.00): [OK]
22: Bnk1 Tach Fan 6 (Fan): 6174.00 RPM (5040.00/NA): [OK]
23: Bnk1 Tach Fan 5 (Fan): 6636.00 RPM (5040.00/NA): [OK]
24: Bnk1 Tach Fan 4 (Fan): 6594.00 RPM (5040.00/NA): [OK]
25: Bnk2 Tach Fan 3 (Fan): 7009.00 RPM (5676.00/NA): [OK]
26: Bnk2 Tach Fan 2 (Fan): 6579.00 RPM (5676.00/NA): [OK]
27: Bnk2 Tach Fan 1 (Fan): 6762.00 RPM (5544.00/NA): [OK]
28: MB FanBst (OEM Reserved): 33.00 C (NA/NA): [OK]
29: MB SNC FanBst (OEM Reserved): 46.00 C (NA/NA): [OK]
30: MB SIOH FanBst (OEM Reserved): 38.00 C (NA/NA): [OK]
31: FPBD AMB FanBst (OEM Reserved): 20.00 C (NA/NA): [OK]
32: PCI RSR FanBst (OEM Reserved): 23.00 C (NA/NA): [OK]
33: CPU Area FanBst (OEM Reserved): 20.00 C (NA/NA): [OK]
34: MEM Area FanBst (OEM Reserved): 35.00 C (NA/NA): [OK]
35: Proc 1 Temp (Temperature): 39.00 C (2.00/112.00): [OK]
36: Proc 2 Temp (Temperature): 39.00 C (2.00/112.00): [OK]
37: Proc 1 FanBst (OEM Reserved): 39.00 C (NA/NA): [OK]
38: Proc 2 FanBst (OEM Reserved): 39.00 C (NA/NA): [OK]
39: HSC SCSI BP Temp (Temperature): NA(NA/NA): [Unknown]
40: Pwr Unit Status (Power Unit): [OK]
41: Pwr Unit Redund (Power Unit): [Redundancy Lost]
42: Watchdog  (Watchdog 2): [OK]
43: Scrty Violation (Platform Security Violation): [OK]
44: Physical Scrty (Platform Chassis Intrusion): [OK]
45: POST Error (System Firmware): [OK]
46: Crit Int Status (Critical Interrupt): [OK]
47: EVT Log Disabled (Event Logging Disabled): [OK]
48: System Event (System Event): [OK]
49: Int SCSI TERMV0 (Voltage): [Performance Met]
50: Int SCSI TERMV1 (Voltage): [Performance Met]
51: Int SCSI TERMV2 (Voltage): [Performance Met]
52: Ext SCSI TERMV0 (Voltage): [Performance Met]
53: Ext SCSI TERMV1 (Voltage): [Performance Met]
54: Ext SCSI TERMV2 (Voltage): [Performance Met]
55: Pwr Supply 1 (Power Supply): [Presence detected]
56: Pwr Supply 2 (Power Supply): [Presence detected]
57: Pwr Supply 3 (Power Supply): [OK]
58: Fan 6 Present (Fan): [Device Inserted/Device Present]
59: Fan 5 Present (Fan): [Device Inserted/Device Present]
60: Fan 4 Present (Fan): [Device Inserted/Device Present]
61: Fan 3 Present (Fan): [Device Inserted/Device Present]
62: Fan 2 Present (Fan): [Device Inserted/Device Present]
63: Fan 1 Present (Fan): [Device Inserted/Device Present]
64: SYS Bd Intrlock (Board): [Device Inserted/Device Present]
65: INIT State (OEM Reserved): [OK]
66: Proc 1 Status (Processor): [Processor Presence detected]
67: Proc 2 Status (Processor): [Processor Presence detected]
68: Proc 1 PpodGd (Voltage): [Performance Met]
69: Proc 2 PpodGd (Voltage): [Performance Met]
70: HSC Drv 1 Status (Drive Slot): [Unknown]
71: HSC Drv 2 Status (Drive Slot): [Unknown]
72: HSC Drv 1 Pres (Drive Slot): [Unknown]
73: HSC Drv 2 Pres (Drive Slot): [Unknown]
www:~# 

10. ipmi-sel

10.1 command-line arguments		Command-line arguments.
10.2 ipmi-sel sample output

10.1 command-line arguments

• --no-probing
  Do not probe IPMI devices.

• -D, --driver-type=IPMIDRIVER
  Use this IPMIDRIVER instead of auto selection. Allowed values are KCS, SMIC, SSIF and LAN.

• --driver-address=DRIVERADDR
  Use this DRIVERADDR address instead of probed one.

• --driver-device=DEVICE
  Use this DEVICE for IPMI driver.

• --register-spacing=REGISTERSPACING
  Use this REGISTERSPACING instead of the probed one.

• -h, --hostname=IPMIHOST
  Connect to IPMIHOST.

• -u, --username=USERNAME
  Use USERNAME instead of NULL. Maximum USERNAME length is 16.

• -p, --password=PASSWORD
  Use PASSWORD instead of NULL. Maximum PASSWORD length is 16.

• -a, --auth-type=AUTHTYPE
  Use AUTHTYPE instead of MD5. Allowed values are NONE, MD2, MD5, and PLAIN.

• -l, --priv-level=PRIVILEGE-LEVEL
  Use this PRIVILEGE-LEVEL instead of USER. Allowed values are CALLBACK, USER, OPERATOR, ADMIN and OEM.

• -?, --help
  Give this help list.

• --usage
  Give a short usage message.

• -V, --version
  Print program version.

• -i, --info
  Show SEL info

• -x, --hex-dump=FILE
  Output a hexadecimal dump of the SEL

• -c, --delete-all
  Delete all records in SEL

• -d, --delete=REC-LIST
  Delete REC-LIST in SEL

• --delete-range=START-END
  Delete records from START to END in SEL

• -f, --flush-cache
  Flush SDR cache.

• --sdr-cache-directory=DIRECTORY
  Use DIRECTORY for sensor cache.

10.2 ipmi-sel sample output

www:~# ipmi-sel 3044:02-May-2005 16:00:30:Power Unit #1:Power Unit Failure detected 3064:31-Dec-1969 16:00:02:Power Unit #1:AC lost 3084:31-Dec-1969 16:00:02:Power Unit #1:AC lost 3104:31-Dec-1969 16:00:42:Platform Chassis Intrusion #5:LAN Leash Lost (system is unplugged from LAN):Network controller #15 3124:31-Dec-1969 16:00:49:Platform Chassis Intrusion #5:LAN Leash Lost (system is unplugged from LAN):Network controller #15 3144:04-May-2005 16:56:00:System Firmware #6:System Firmware Error (POST Error):OEM code = 09h:OEM code = 01h 3164:04-May-2005 16:56:02:System Event #8:OEM System Boot Event 3184:04-May-2005 17:07:58:Platform Chassis Intrusion #5:LAN Leash Lost (system is unplugged from LAN):Network controller #15 3204:04-May-2005 17:08:05:Platform Chassis Intrusion #5:LAN Leash Lost (system is unplugged from LAN):Network controller #15 3224:18-May-2005 08:55:38:System Firmware #6:System Firmware Error (POST Error):OEM code = 09h:OEM code = 01h 3244:18-May-2005 08:55:40:System Event #8:OEM System Boot Event 3264:16-Jun-2005 10:49:27:System Firmware #6:System Firmware Error (POST Error):OEM code = 09h:OEM code = 01h 3284:16-Jun-2005 10:49:29:System Event #8:OEM System Boot Event 3304:05-Jul-2005 10:10:56:System Firmware #6:System Firmware Error (POST Error):OEM code = 09h:OEM code = 01h 3324:05-Jul-2005 10:10:58:System Event #8:OEM System Boot Event 3344:25-Oct-2005 14:55:39:System Event #8:OEM System Boot Event 3364:25-Oct-2005 15:16:58:System Event #8:OEM System Boot Event 3384:25-Oct-2005 15:58:58:System Event #8:OEM System Boot Event 3404:02-Nov-2005 16:07:13:System Firmware #6:System Firmware Error (POST Error):OEM code = 09h:OEM code = 01h

11. bmc-watchdog

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.

11.1 BMC Watchdog Theory
11.2 command-line arguments		Command-line arguments.
11.3 bmc-watchdog example		bmc-watchdog example.
11.4 bmc-watchdog known issues		Known issues with the bmc-watchdog.

11.1 BMC Watchdog Theory

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 generated, 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.

11.2 command-line arguments

11.2.1 bmc-watchdog general options		General command-line arguments.
11.2.2 bmc-watchdog command options		Command command-line arguments.
11.2.3 bmc-watchdog set options		Set command-line arguments.
11.2.4 bmc-watchdog start options		Start command-line arguments.
11.2.5 bmc-watchdog daemon options		Daemon command-line arguments.

11.2.1 bmc-watchdog general options

The following options can be used by any command.
• -h, --help
  Display the help menu. If a specific command (`--set', `--get', `--reset', `--start', `--stop', `--clear', or `--daemon') is listed on the command line, only the specific options for that command will be listed.

• -v, --version
  Display the version information.

• -I string, --driver-type=string
  Identify the IPMI driver type to use. The available driver types are KCS and SSIF. If not specified, bmc-watchdog will attempt both.

• -o int, --driver-address=int
  Identify the System Base Address for the IPMI Driver. If not specified, bmc-watchdog will attempt to probe for the system's default address. If the probe fails, the IPMI defined default will be used. If the io-port number is prefixed with a "0x", it is assumed to be a base 16 integer. Otherwise, it is assumed to be a base 10 integer.

• -R int, --reg-space=int
  Specify base address register spacing. If not specified, bmc-watchdog will attempt to probe for the system's default register spacing. If the probe fails, the IPMI defined default will be used.

• -E string, --driver-device=string
  Identify the driver device path the IPMI driver should use. It not specified, a default path will be assumed.

• -f string, --logfile=string
  Specify an alternate logfile from the default of `/var/log/freeipmi/bmc-watchdog.log'.

• -n, --no-logging Turns off all logging done by bmc-watchdog.

11.2.2 bmc-watchdog command options

• -s, --set
  Set BMC Watchdog Configuration. BMC watchdog timer configuration values can be set using the set command options listed below under 11.2.3 bmc-watchdog 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 identical to --reset command when the timer is stopped. Does nothing if the timer is currently running.

• -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 11.2.5 bmc-watchdog daemon options. The configuration values are set once, then the daemon will reset the timer at specified periodic intervals. Every time the BMC watchdog timer is reset, a log entry will be generated in the `bmc-watchdog' log. The default log is stored at `/var/log/freeipmi/bmc-watchdog.log'. The daemon can be stopped using the `--stop' command, `--clear' command, or by setting the `stop_timer' flag on the `--set' command.

11.2.3 bmc-watchdog set options

• -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 secs, --pre-timeout-interval=secs
  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 secs, --initial-countdown=secs
  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.

11.2.4 bmc-watchdog start options

• -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.

11.2.5 bmc-watchdog daemon options

• -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 secs, --pre-timeout-interval=secs
  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 secs, --initial-countdown=secs
  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.

11.3 bmc-watchdog example

debian-ia64:~# bmc-watchdog -d -u 4 -p 0 -a 1 -i 900 debian-ia64:~# ps -C bmc-watchdog PID TTY TIME CMD 1035 ? 00:00:00 bmc-watchdog debian-ia64:~#

11.4 bmc-watchdog known issues

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.

12. IPMI power control utility

PowerMan http://www.llnl.gov/linux/powerman/ now supports ipmipower as a remote power control device.

Whenever a power command (`--on', `--off', `--cycle', `--reset', `--stat', `--pulse', or `--soft') is specified on the command-line, ipmipower will run in non-interactive mode. 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 under 12.3 ipmipower interactive commands section.

12.1 Command-line arguments
12.2 ipmipower configuration file		Configuration file.
12.3 ipmipower interactive commands		Interactive commands.
12.4 Host ranges		Host range specificaiton.
12.5 ipmipower example
12.6 Use with powerman		PowerMan integration.
12.7 ipmipower workarounds		Workarounds.
12.8 Known issues with the ipmipower command		Known issues.

12.1 Command-line arguments

12.1.1 ipmipower basic options		Basic options.
12.1.2 ipmipower advanced options		Advanced options.
12.1.3 ipmipower network options		Network options.

12.1.1 ipmipower basic options

• -h, --hostnames host1,host2,...
  The list of hostname addresses to be controlled by ipmipower. The hostnames must resolve to the IP address of the NIC connected to the remote host BMC. If hostnames do not resolve to proper BMC IP addresses, RMCP ping messages will not discover the remote host or power commands will time out. This option is required if a power command (`--on', `--off', `--cycle', `--reset', or `--stat', `--pulse', `--soft') is specified on the command-line. Hostnames may be specified in a range format; see 12.4 Host ranges section.

• -u, --username name
  Sets the username to use when authenticating with the BMC. The user must have operator or administrator privilege to run the `--on', `--off', `--reset', `--cycle', `--pulse', or `--soft' power control commands. The user needs only user privileges to determine the status of the machine through `--stat'. If not specified, a null username (Anonymous Login `User ID 1') is assumed.

• -p, --password pw
  Sets the password to use when authenticating with the BMC. If not specified, a null password is assumed.

• -k, --k-g str
  Sets the K_g BMC Key when authenticating with the BMC for ipmi 2.0. If not specified, a null key is assumed.

• -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.

• -j, --pulse
  Send power diagnostic interrupt to target hosts.

• -m, --soft
  Initiate a soft-shutdown of the OS via ACPI.

• -H, --help
  Display the help menu and exit.

• -V, --version
  Display the version information and exit.

• -C, --config file
  Specify alternate configuration file.

12.1.2 ipmipower advanced options

• -a, --authentication-type str
  Sets the authentication type to use with ipmipower. The currently available authentication types are:

  `auto' => (default) `none' `straight_password_key' `md2' `md5'

• -l, --privilege str
  Sets the privilege type to use with ipmipower.

  `auto' => (default) `user' `operator' `admin'

• -R, --ipmi-version version
  Sets the IPMI protocol version to use with ipmipower.

  `auto' => (default) `1.5' `2.0'

• -T, --cipher-suite-id id
  Set 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.

  `auto' => (default) `0' `1' `2' `3' `6' `7' `8' `11' `12'

• -g, --on-if-off
  The IPMI specification does not require the cycle or 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.

• -A, --wait-until-on
  The IPMI specification allows power on commands to return prior 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.

• -B, --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.

• -o, --outputtype str
  Sets the output type to use with ipmipower. The currently available output types are:

  `none' `newline' => (default) `hostlist'

  Hostlist output can be used to shorten output if the number of nodes in your cluster is quite large. However, hostlist output will only output after the slowest node has completed its power control operation.

• -P, --force-permsg-authentication
  Forces ipmipower to use IPMI per message authentication regardless of what is advertised by the remote machine. This option has been specifically implemented to get around a compliance issue.

• -S, --accept-session-id-zero
  Forces ipmipower to accept packets with a session id of zero. This option has been specifically implemented to get around a compliance issue.

• -U, --check-unexpected-authcode
  Forces ipmipower to check packet authcodes even if no authcode should be received. This option has been specifically implemented to get around a compliance issue.

• -X, --intel-2-0-session
  Modifies the IPMI 2.0 session protocol for non-compliant Intel machines.

• -Y, --supermicro-2-0-session
  Modifies the IPMI 2.0 session protocol for non-compliant Supermicro machines.

12.1.3 ipmipower network options

• -t, --timeout ms
  Sets the time-out in milliseconds. ipmipower uses the time-out value to determine when to give up on a power command. If not specified, a default time-out of 20000 milliseconds (20 seconds) is used.

• -q, --retry-wait-timeout ms
  Sets the retry-wait-timeout in milliseconds. The retry-wait-timeout is similar to the retry-timeout above, but is used specifically for power completion verification in the `--wait-until-on' and `--wait-until-off' options.

• -y, --retry-timeout ms
  Sets the retry-timeout in milliseconds. The IPMI protocol sends a series of packets back and forth to a remote host BMC in order to perform a power control operation. When a response to any individual packet is not received after retry-timeout milliseconds, ipmipower will retry sending that packet. If not specified, packet retransmissions will occur after `400' milliseconds (0.4 seconds). The value ms must be less than the time out length specified with `--timeout'. Packet retransmissions can be disabled by setting the retry-timeout length to `0'.

  Note how this option differs from the `--timeout' option above. The `--timeout' option refers to the entire amount of time the IPMI protocol has to complete a power control operation. The `--retry' option refers to the amount of time any individual packet within the IPMI protocol has to complete.

• -b, --retry-backoff-count num
  After every retry-backoff-count retransmissions, ipmipower will increase the retry-timeout length by another factor for the duration of the current power control operation. This is done to reduce network traffic and allow BMC buffers to empty. If not specified, retry-backoff-count is `8'. Retransmission backoff can be disabled by setting the retry backoff count to `0'.

• -i, --ping-interval ms
  
• -z, --ping-timeout ms
  ipmipower will send RMCP ping discovery messages every ping-interval milliseconds to discover all remote hosts and confirm its support of IPMI. Power commands cannot be sent to a host until it is discovered. If a remote host does not respond within ping-timeout milliseconds, a host will be considered undiscovered and power commands will not be sent to it. If not specified, ping-interval is `5000' milliseconds (5 seconds) and ping-timeout is `30000' milliseconds (30 seconds). Ping discovery requests can be disabled by setting the ping interval to `0'. If ping discovery messages are disabled, power commands will be attempted without knowledge of the host's existence or its support of IPMI. The value of ping-interval must be less than the ping-timeout length. RMCP ping discovery messages are automatically disabled in non-interactive mode.

• -v, --ping-packet-count num
  
• -w, --ping-percent num
  It is difficult to distinguish between a missing node and node with a bad connection when using just RMCP pings and timeouts. For example, if a link consistently drops 80% of the packets to a particular node, a power control operation may have difficulty completing, although a recent pong response makes ipmipower believe the node exists and is functioning properly. The `--ping-packet-count' and `--ping-percent' options alleviate this problem. ipmipower will monitor ping packets in ping-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. If not specified, ping-packet-count is `10' and ping-percent is `50'. This heuristic can be disabled by setting either ping-packet-count or ping-percent to `0'. This feature is not used if ping-interval is set to `0'. Note that the `--ping-percent' option takes an integer as an argument, not a decimal.

• -x, --ping-consec-count ping-consec-count
  ping-consec-count is another measurement used to determine if a node should be considered discovered, undiscovered, or with a bad connection. If a valid response was received from the last ping-consec-count RMCP ping packets, a node will be considered discovered, regardless if ping-packet-count and ping-percent statistically consider the link to be unreliable. If not specified, ping-consec-count is `5'. This feature can be disabled by setting ping-consec-count to `0'. This feature is not used if ping-interval, `--ping-packet-count', or `--ping-percent' are set to `0'.

12.2 ipmipower configuration file

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

The user can still override the configuration file values by specifying the options on the command line. The configuration file does not stop a user from specifying certain options.

12.2.1 Configuration options

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

• hostnames host1 host2 host3 ...
  

  Specify the default hostnames. Multiple hostnames or hostname ranges can be specified by separating each range by whitespace. See 12.4 Host ranges for information on hostname ranges. For example, any of the following configuration listings would be acceptable:

  hostnames host1 host2 host3 foo1 bar1 hostnames host1,host2,host3,foo1,bar1 hostnames host[1-3] foo1 bar1 hostnames host[1-3] foo1,bar1

  At most 64 hostnames or hostname ranges can be separted by whitespace.

• username username
  Specify the default username to use.

• password password
  Specify the default password to use.

• k_g k_g_str
  Specify the BMC key K_g to use.

• authentication-type authtype
  Specify the default authentication type to use. ipmipower currently supports the following authentication types:

  `auto' `straight_password_key' `md2' `md5'

• privilege privilege
  Specify the default privilege type to use. ipmipower currently supports the following privilege types:

  `auto' `user' `operator' `admin'

• ipmi_version ipmi_version
  Specify the default IPMI protocol version to use. ipmipower currently supports the following version types:

  `auto' `1.5' `2.0'

• cipher_suite_id cipher_suite_id
  Specify the default Cipher Suite ID to use. ipmipower currently supports the following Cipher Suite IDs:

  `auto' `0' `1' `2' `3' `6' `7' `8' `11' `12'

• on-if-off enable|disable
  

• wait-until-on enable|disable
  

• wait-until-off enable|disable
  

• outputtype outputtype
  Specify the default outputtype type to use. ipmipower currently supports the following output types:

  `none' `newline' => (default) `hostlist'

• force_permsg_authentication enable|disable
  

• accept_session_id_zero enable|disable
  

• accept_unexpected_authcode enable|disable
  

• intel_2_0_session enable|disable
  

• supermicro_2_0_session enable|disable
  

• timeout timeout
  Specify the timeout in ms.

• retry_wait_timeout timeout
  Specify the retry wait timeout in ms.

• retry-timeout timeout
  Specify the retry timeout in ms. See 12. IPMI power control utility for an explanation on the difference between this is the timeout option.

• retry-backoff-count num
  Specify the retry backoff count.

• ping-interval interval-length
  Specify the ping interval-length in ms.

• ping-timeout timeout
  Specify the ping timeout length in ms.

• ping-packet-count count
  Specify a new ping packet count.

• ping-percent num
  Specify a new ping percent.

• ping-consec-count count
  Specify a new ping consec count.

12.3 ipmipower interactive commands

• hostnames str
  Specify a new set of hosts, no str to unconfigure all hosts.

• username str
  Specify a new username, no str for null username.

• password str
  Specify a new password, no str for null password.

• k_g str
  Specify a new k_g, no str for null.

• on host
  Turns on all hosts, or only the specified host.

• off host
  Turns off all hosts, or only the specified host.

• cycle host
  Power cycle all hosts, or specified host.

• reset host
  Hard reset all hosts or specified host.

• stat host
  Queries power status for all hosts, or only the specified host.

• pulse host
  Send pulse diagnostic interrupt to all hosts, or only the specified host.

• soft host
  Initiate a soft-shutdown of the OS via ACPI to all hosts, or only the specified host.

• help
  Display the help menu.

• advanced
  Display the advanced help menu.

• network
  Display the network help menu.

• quit
  Quit ipmipower.

• authentication_type str
  Specify a new authentication type:

  `none' `straight_passwd_key' `md2' `md5'

• privilege_type str
  Specify a new privilege type:

  `none' `user' `operator' `admin'

• ipmi_version str
  Specify a new IPMI version:

  `auto' `1.5' `2.0'

• cipher_suite_id str
  Specify a new cipher suite id:

  `auto' `0' `1' `2' `3' `6' `7' `8' `11' `12'

• on-if-off on|off
  

• wait-until-on on|off
  

• wait-until-off on|off
  

• outputtype str
  Specify a new output type:

  `none' `newline' `hostlist'

• force-permsg-authentication on|off
  

• accept-session-id-zero on|off
  

• check-unexpected-authcode on|off
  

• intel-2-0-session on|off
  

• supermicro-2-0-session on|off
  

• config
  Output the current configuration.

• timeout ms
  Specify a new timeout length.

• retry-timeout ms
  Specify a new retry timeout length.

• retry-backoff-count num
  Specify a new retry backoff count.

• ping-interval ms
  Specify a new ping interval length.

• ping-timeout ms
  Specify a new ping timeout length.

• ping-packet-count num
  Specify a new ping packet count.

• ping-percent num
  Specify a new ping percent.

• ping-consec-count num
  Specify a new ping consec count.

12.4 Host ranges

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.

12.5 ipmipower example

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

Hard reset the nodes configured in a configuration file.

ipmipower -C /etc/powerctrl.conf --reset

Example ipmipower session:

debian-sid:~# ipmipower --hostnames debian-ia64 --password "rea1secret" --stat debian-ia64: on debian-sid:~# ipmipower --hostnames debian-ia64 --password "rea1secret" --off debian-ia64: ok debian-sid:~# ipmipower --hostnames debian-ia64 --password "rea1secret" --stat debian-ia64: off debian-sid:~# ipmipower --hostnames debian-ia64 --password "rea1secret" --on debian-ia64: ok debian-sid:~#

12.6 Use with powerman

Due to deficiencies within powerman, the power control operations `--on', `--off', `--cycle', `--reset' will be reported as successful, despite any errors that may occur. The user should use the `--query' option to ensure that all remote hosts were successfully powered on or off.

It is recommend that the `--on-if-off' option be used with ipmipower when it is used in conjunction with powerman. This will ensure ipmipower behaves similarly to other powerman devices.

12.7 ipmipower workarounds

When possible, the workarounds have been implemented so they will be transparent to the user. However, some will require command line options be set due to issues with code logic or security. The workarounds listed below are listed in the order of their implementation. Therefore, workarounds implemented earlier may have solved problems for other vendors.

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

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

Tyan S2882 with m3289 BMC: After the IPMI session is brought up, packet responses return empty session IDs to the client. In order to work around this issue, the `-S' (`--accept-ses- sion-id-zero') option must be set. The option will allow empty session IDs to be accepted by the client. This problem is apparently fixed in later firmware releases.

Dell PowerEdge 2850,SC1425: When Per-Message Authentication is disabled, packet responses contain non-null authentication data (when it should in fact be null). In order to work around this issue, the `-U' (`--check-unexpected-authcode') option must be set. The option will allow unexpected non-null authcodes to be checked as though they were expected. Fix con- firmed on upgraded firmware.

Intel SE7520JR2 with National Semiconductor PC87431M mBMC: The activate session response and close session response packets have invalid sequence numbers. Specific workaround no longer required in later revisions of ipmipower.

IBM eServer 325: The remote BMC will advertise that Per Message Authentication is disabled, but actually require it for the protocol. In order to work around this issue, the `-P' (`--force-permsg-authentication') option must be set. The option will force Per Message Authentication to be used no matter what is advertised by the remote BMC.

Intel SE7520AF2 with Intel Server Management Module (Professional Edition): There are a number of Intel IPMI 2.0 bugs which can be worked around using the the `-X' (`--intel-2-0-session') option. The workrarounds include padding of usernames, automatic acceptance of a RAKP 4 response integrity check when using the integrity algorith MD5-128, and password truncation if the authentication algorithm is HMAC-MD5-128.

Supermicro H8QME with SIMSO daughter card: There are several Supermicro IPMI 2.0 bugs on early firmware revisions which can be worked around using the `-Y' (`--supermicro-2-0-session') option.

12.8 Known issues with the ipmipower command

On certain operating systems, if you input your username and password on the command line, the username and password may be discovered by other users when using the ps command or looking in the `/proc' file system. The most secure solution is to enter the username and password while in interactive mode. If administrators do not wish to type in their username and password at the interactive prompt, they can be listed in a configuration file, in which the access to this file can be limited.

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 power status queries to initially return information other than 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.

13. IPMI SOL console utility

13.1 Command-line arguments
13.2 ipmiconsole configuration file		Configuration file.
13.3 ipmiconsole workarounds		Workarounds.
13.4 Known issues with the ipmiconsole command		Known issues.

13.1 Command-line arguments

• -h, --hostnames host
  Specify the remote host to connect to.

• -u, --username name
  Specify the username to use to establish communication. If not specified, the NULL user is assumed. The user must have a high enough privilege to establish an SOL session.

• -p, --password pw
  Specify the password to use to establish communication. If not specified, a NULL password is assumed.

• -k, --k-g str
  Specify the BMC key to use for authentication. If not specified, a NULL key is assumed.

• -l, --privilege str
  Specify the privilege type to use. The privilege must be atleast the minimum required by the remote BMC to establish a SOL session.

  `user' `operator' `admin' => (default)

• -T, --cipher-suite-id 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.

  `0' `1' `2' `3' => (default) `6' `7' `8' `11' `12'

• -H, --help
  Output help menu and exit.

• -V, --version
  Output version and exit.

• -C, --config file
  Specify an alternate configuration file.

• -I, --intel-2-0-session
  Modifies the IPMI 2.0 session protocol for non-compliant Intel machines.

• -S, --supermicro-2-0-session
  Modifies the IPMI 2.0 session protocol for non-compliant Supermicro machines.

13.2 ipmiconsole configuration file

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

The user can still override the configuration file values by specifying the options on the command line. The configuration file does not stop a user from specifying certain options.

13.2.1 Configuration options

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

• hostname host
  Specify the default hostname.

• username username
  Specify the default username to use.

• password password
  Specify the default password to use.

• k_g k_g_str
  Specify the BMC key K_g to use.

• privilege privilege
  Specify the default privilege type to use. ipmiconsole currently supports the following privilege types:

  `user' `operator' `admin'

• cipher_suite_id cipher_suite_id
  Specify the default Cipher Suite ID to use. ipmiconsole currently supports the following Cipher Suite IDs:

  `0' `1' `2' `3' `6' `7' `8' `11' `12'

• intel_2_0_session enable|disable
  

• supermicro_2_0_session enable|disable
  

13.3 ipmiconsole workarounds

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

Intel SE7520AF2 with Intel Server Management Module (Professional Edition): There are a number of Intel IPMI 2.0 bugs which can be worked around using the the `-I' (`--intel-2-0-session') option. The workrarounds include padding of usernames, automatic acceptance of a RAKP 4 response integrity check when using the integrity algorith MD5-128, and password truncation if the authentication algorithm is HMAC-MD5-128.

Supermicro H8QME with SIMSO daughter card: There are several Supermicro IPMI 2.0 bugs on early firmware revisions which can be worked around using the `-S' (`--supermicro-2-0-session') option.

13.4 Known issues with the ipmiconsole command

14. ipmiping

ipmiping uses the IPMI Get Authentication Capabilities request datagram to elicit an IPMI Get Authentication Capabilities response from a remote host. The utility can be used to verify if a remote host supports IPMI.

Returns `0' to the environment if it receives at least `1' response from the remote host. Otherwise, it exists with a value of `1'.

14.1 command-line arguments		Command-line arguments.
14.2 ipmiping example		ipmiping example.
14.3 ipmiping known issues		Known issues with the ipmi-ping

14.1 command-line arguments

14.1.1 Synopsis

The following options are available

• -h
  Display the help menu.

• -V
  Display the version information.

• -c count
  Stop after sending count request 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.

• -r version
  Specify IPMI protocol version.

  `1.5' `2.0'

• -s num
  Specify an initial starting sequence number.

• -v
  Verbose Display.

14.2 ipmiping example

Example: Test the BMC reachability of host `debian-ia64' using IPMI protocol.

debian-sid:~# ipmiping debian-ia64 ipmiping debian-ia64 (192.168.1.60) response received from 192.168.1.60: rq_seq=6 response received from 192.168.1.60: rq_seq=7 response received from 192.168.1.60: rq_seq=8 response received from 192.168.1.60: rq_seq=9 response received from 192.168.1.60: rq_seq=10 response received from 192.168.1.60: rq_seq=11 --- ipmiping debian-ia64 statistics --- 6 requests transmitted, 6 responses received in time, 0.0% packet loss

Example: Test the BMC reachability of host `debian-ia64' in verbose mode.

debian-sid:~# ipmiping -v debian-ia64 ipmiping debian-ia64 (192.168.1.60) response received from 192.168.1.60: rq_seq=45, auth: none=clear md2=clear md5=set passwd=clear oem=clear anon=clear null=clear non-null=set user=clear permsg=clear response received from 192.168.1.60: rq_seq=46, auth: none=clear md2=clear md5=set passwd=clear oem=clear anon=clear null=clear non-null=set user=clear permsg=clear response received from 192.168.1.60: rq_seq=47, auth: none=clear md2=clear md5=set passwd=clear oem=clear anon=clear null=clear non-null=set user=clear permsg=clear response received from 192.168.1.60: rq_seq=48, auth: none=clear md2=clear md5=set passwd=clear oem=clear anon=clear null=clear non-null=set user=clear permsg=clear response received from 192.168.1.60: rq_seq=49, auth: none=clear md2=clear md5=set passwd=clear oem=clear anon=clear null=clear non-null=set user=clear permsg=clear --- ipmiping debian-ia64 statistics --- 5 requests transmitted, 5 responses received in time, 0.0% packet loss

Example: Test the BMC reachability of host `debian-ia64' by sending exactly 2 packets.

debian-sid:~# ipmiping -c 2 debian-ia64 ipmiping debian-ia64 (192.168.1.60) response received from 192.168.1.60: rq_seq=30 response received from 192.168.1.60: rq_seq=31 --- ipmiping debian-ia64 statistics --- 2 requests transmitted, 2 responses received in time, 0.0% packet loss debian-sid:~#

14.3 ipmiping known issues

15. rmcpping

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.

Returns 0 to the environment if it receives at least `1' response from the remote host. Otherwise, it exits with a value of `1'.

15.1 Command-line arguments
15.2 rmcpping example		rmcpping example.
15.3 rmcpping known issues		Known issues with the rmcpping.

15.1 Command-line arguments

15.1.1 Synopsis

• -h
  Display the help menu.

• -V
  Display the version information.

• -c count
  Stop after sending count ping packets.

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

• -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 `5' seconds.

• -v Verbose display.

• -s num
  Specify an initial starting sequence number.

15.2 rmcpping example

debian-sid:~# rmcpping debian-ia64 rmcpping debian-ia64 (192.168.1.60) pong received from 192.168.1.60: msg_tag=0 pong received from 192.168.1.60: msg_tag=1 pong received from 192.168.1.60: msg_tag=2 pong received from 192.168.1.60: msg_tag=3 pong received from 192.168.1.60: msg_tag=4 pong received from 192.168.1.60: msg_tag=5 pong received from 192.168.1.60: msg_tag=6 pong received from 192.168.1.60: msg_tag=7 pong received from 192.168.1.60: msg_tag=8 --- rmcpping debian-ia64 statistics --- 9 pings transmitted, 9 pongs received in time, 0.0% packet loss

Example: Test the BMC reachability of host `debian-ia64' in verbose mode.

debian-sid:~# rmcpping -v debian-ia64 rmcpping debian-ia64 (192.168.1.60) pong received from 192.168.1.60: msg_tag=0, ipmi supported pong received from 192.168.1.60: msg_tag=1, ipmi supported pong received from 192.168.1.60: msg_tag=2, ipmi supported pong received from 192.168.1.60: msg_tag=3, ipmi supported pong received from 192.168.1.60: msg_tag=4, ipmi supported --- rmcpping debian-ia64 statistics --- 5 pings transmitted, 5 pongs received in time, 0.0% packet loss

Example: Test the BMC reachability of host `debian-ia64' by sending exactly 2 packets.

debian-sid:~# rmcpping -c 2 debian-ia64 rmcpping debian-ia64 (192.168.1.60) pong received from 192.168.1.60: msg_tag=0 pong received from 192.168.1.60: msg_tag=1 --- rmcpping debian-ia64 statistics --- 2 pings transmitted, 2 pongs received in time, 0.0% packet loss debian-sid:~#

15.3 rmcpping known issues

16. Trouble-shooting

16.1 Fencing IPMI IP ports
16.2 Non-unique IPC key
16.3 Kernel Driver conflict		Kernel Driver conflicts.

16.1 Fencing IPMI IP ports

Append the following to /etc/services:
# BMC IPMI/RMCP services
rmcp    623/udp         # Aux Bus Shunt (Primary RMCP Port)
rmcps   664/udp         # Secure Aux Bus (Secondary RMCP Port)

Most common victims to this issue are Remote-shell (rsh) and NIS services. You will notice "time out" errors under heavy load, when these services run over the BMC reserved ports.

Secure connections to BMC port 664 is not enabled on most BMC implementations by default.

Thanks to Anand Manian (GE Power Systems) for reporting this problem.

16.2 Non-unique IPC key

To regenerate a new system wide unique IPC key, you have to recreate `/var/lib/freeipmi/ipckey' with a new inode number.

Example: Recreating `/var/lib/freeipmi/ipckey' file.

debian-ia64:~# touch -f /var/lib/freeipmi/ipckey.new debian-ia64:~# ls --inode /var/lib/freeipmi/ipckey 2289282 /var/lib/freeipmi/ipckey debian-ia64:~# ls --inode /var/lib/freeipmi/ipckey.new 2289284 /var/lib/freeipmi/ipckey.new debian-ia64:~# mv -f /var/lib/freeipmi/ipckey.new /var/lib/freeipmi/ipckey debian-ia64:~# ls --inode /var/lib/freeipmi/ipckey 2289284 /var/lib/freeipmi/ipckey debian-ia64:~#

16.3 Kernel Driver conflict

17. Contact us

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

• Project Main: https://savannah.gnu.org/projects/freeipmi/

• Download: https://savannah.gnu.org/files/?group=freeipmi

• Mailing List: https://savannah.gnu.org/mail/?group=freeipmi

• Support: https://savannah.gnu.org/support/?group=freeipmi

• Patches: https://savannah.gnu.org/patch/?group=freeipmi

• News: https://savannah.gnu.org/news/?group=freeipmi

• Bugs: https://savannah.gnu.org/bugs/?group=freeipmi

• Tasks: https://savannah.gnu.org/task/?group=freeipmi

• CVS: https://savannah.gnu.org/cvs/?group=freeipmi

Contact FreeIPMI Core Team <ab(@)gnu.org.in>

18. Authors

18.1 FreeIPMI Contributors (sorted alphabetically)

18.1.1 Core team

18.1.2 Documentation

18.1.3 Packaging

18.1.4 contact point

19. Copying

19.1 GNU FreeIPMI license
19.2 GNU FreeIPMI documentation license

19.1 GNU FreeIPMI license

Copyright (C) 1989, 1991 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

19.1.1 Preamble

The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too.

When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things.

To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.

For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.

We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software.

Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.

Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.

The precise terms and conditions for copying, distribution and modification follow.

1. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you".

   Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.

2. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.

   You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.

3. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:
   1. You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.

   2. You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.

   3. If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)

   These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.

   Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.

   In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.

4. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:
   1. Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

   2. Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

   3. Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)

   The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.

   If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.

5. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

6. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.

7. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.

8. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.

   If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.

   It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.

   This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.

9. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.

10. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

    Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.

11. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.
    NO WARRANTY

12. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

13. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

19.1.2 Appendix: How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.

one line to give the program's name and a brief idea of what it does. Copyright (C) yyyy name of author 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 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Also add information on how to contact you by electronic and paper mail.

If the program is interactive, make it output a short notice like this when it starts in an interactive mode:

Gnomovision version 69, Copyright (C) 19yy name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.

The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program.

You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names:

Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. signature of Ty Coon, 1 April 1989 Ty Coon, President of Vice

This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License.

19.2 GNU FreeIPMI documentation license

Copyright (C) 2000,2001,2002 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02110-1301, USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

1. PREAMBLE

   The purpose of this License is to make a manual, textbook, or other functional and useful document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

   This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

   We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.

2. APPLICABILITY AND DEFINITIONS

   This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.

   A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

   A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

   The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.

   The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.

   A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called "Opaque".

   Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.

   The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.

   A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document means that it remains a section "Entitled XYZ" according to this definition.

   The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.

3. VERBATIM COPYING

   You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

   You may also lend copies, under the same conditions stated above, and you may publicly display copies.

4. COPYING IN QUANTITY

   If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

   If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

   If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

   It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.

5. MODIFICATIONS

   You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

   1. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.

   2. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.

   3. State on the Title page the name of the publisher of the Modified Version, as the publisher.

   4. Preserve all the copyright notices of the Document.

   5. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.

   6. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.

   7. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice.

   8. Include an unaltered copy of this License.

   9. Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled "History" in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.

   10. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the "History" section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.

   11. For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.

   12. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.

   13. Delete any section Entitled "Endorsements". Such a section may not be included in the Modified Version.

   14. Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with any Invariant Section.

   15. Preserve any Warranty Disclaimers.

   If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.

   You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties--for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

   You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

   The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.

6. COMBINING DOCUMENTS

   You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.

   The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

   In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements."

7. COLLECTIONS OF DOCUMENTS

   You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

   You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.

8. AGGREGATION WITH INDEPENDENT WORKS

   A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.

   If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.

9. TRANSLATION

   Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.

   If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.

10. TERMINATION

    You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

11. FUTURE REVISIONS OF THIS LICENSE

    The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.

    Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.

19.2.1 ADDENDUM: How to use this License for your documents

To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:

Copyright (C) year your name. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled ``GNU Free Documentation License''.

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the "with...Texts." line with this:

with the Invariant Sections being list their titles, with the Front-Cover Texts being list, and with the Back-Cover Texts being list.

If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.

If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.

20. Glossary

Concept index

Program index

Footnotes

(1)

see default bmc-watchdog rc script `/etc/init.d/bmc-watchdog' a more complete example.

Table of Contents

1. Introduction to the GNU FreeIPMI system

1.1 Who should read this guide?
1.2 IPMI - Platform Management Standard

2. Installing GNU FreeIPMI

2.1 Dependencies
2.2 Building the source package.

2.2.1 Installing under FreeBSD:

2.2.1.1 Using i386_set_ioperm(2) instead of io(4) under FreeBSD:

2.3 Test Fire

3. IPMI C library (libfreeipmi)
4. ipmi-locate IPMI device probing tool

4.1 Command-line options
4.2 Example

5. bmc-config

5.1 Command-line arguments to bmc-config
5.2 Sample Configuration File
5.3 Extracting current BMC configuration
5.4 Update BMC configuration
5.5 Compare BMC configuration

6. bmc-info

6.1 Command-line options
6.2 Example

7. bmc-autoconfig

7.1 Command-line options

8. ipmi-raw

8.1 Command-line options
8.2 Example

9. ipmi-sensors

9.1 command-line arguments
9.2 ipmi-sensors output

10. ipmi-sel

10.1 command-line arguments
10.2 ipmi-sel sample output

11. bmc-watchdog

11.1 BMC Watchdog Theory
11.2 command-line arguments

11.2.1 bmc-watchdog general options
11.2.2 bmc-watchdog command options
11.2.3 bmc-watchdog set options
11.2.4 bmc-watchdog start options
11.2.5 bmc-watchdog daemon options

11.3 bmc-watchdog example
11.4 bmc-watchdog known issues

12. IPMI power control utility

12.1 Command-line arguments

12.1.1 ipmipower basic options
12.1.2 ipmipower advanced options
12.1.3 ipmipower network options

12.2 ipmipower configuration file

12.2.1 Configuration options

12.3 ipmipower interactive commands
12.4 Host ranges
12.5 ipmipower example
12.6 Use with powerman
12.7 ipmipower workarounds
12.8 Known issues with the ipmipower command

13. IPMI SOL console utility

13.1 Command-line arguments
13.2 ipmiconsole configuration file

13.2.1 Configuration options

13.3 ipmiconsole workarounds
13.4 Known issues with the ipmiconsole command

14. ipmiping

14.1 command-line arguments

14.1.1 Synopsis

14.2 ipmiping example
14.3 ipmiping known issues

15. rmcpping

15.1 Command-line arguments

15.1.1 Synopsis

15.2 rmcpping example
15.3 rmcpping known issues

16. Trouble-shooting

16.1 Fencing IPMI IP ports
16.2 Non-unique IPC key
16.3 Kernel Driver conflict

17. Contact us
18. Authors

18.1 FreeIPMI Contributors (sorted alphabetically)

18.1.1 Core team
18.1.2 Documentation
18.1.3 Packaging
18.1.4 contact point

19. Copying

19.1 GNU FreeIPMI license

19.1.1 Preamble
19.1.2 Appendix: How to Apply These Terms to Your New Programs

19.2 GNU FreeIPMI documentation license

19.2.1 ADDENDUM: How to use this License for your documents

20. Glossary
Concept index
Program index

Short Table of Contents

1. Introduction to the GNU FreeIPMI system
2. Installing GNU FreeIPMI
3. IPMI C library (libfreeipmi)
4. ipmi-locate IPMI device probing tool
5. bmc-config
6. bmc-info
7. bmc-autoconfig
8. ipmi-raw
9. ipmi-sensors
10. ipmi-sel
11. bmc-watchdog
12. IPMI power control utility
13. IPMI SOL console utility
14. ipmiping
15. rmcpping
16. Trouble-shooting
17. Contact us
18. Authors
19. Copying
20. Glossary
Concept index
Program index

About this document

• 1. Section One
• 1.1 Subsection One-One
• ...
• 1.2 Subsection One-Two
• 1.2.1 Subsubsection One-Two-One
• 1.2.2 Subsubsection One-Two-Two
• 1.2.3 Subsubsection One-Two-Three     <== Current Position
• 1.2.4 Subsubsection One-Two-Four
• 1.3 Subsection One-Three
• ...
• 1.4 Subsection One-Four