Dell OpenManage Baseboard Management Controller Utilities 4.
Notes and Cautions NOTE: A NOTE indicates important information that helps you make better use of your computer. CAUTION: A CAUTION indicates potential damage to hardware or loss of data if instructions are not followed. ____________________ Information in this publication is subject to change without notice. © 2010 Dell Inc. All rights reserved. Reproduction of these materials in any manner whatsoever without the written permission of Dell Inc. is strictly forbidden.
Contents 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . Supported Systems and Operating Systems . . . . . . . 10 BMC Configuration and Management Tasks . . . . . . 10 . . . . . . . . . . . . . . . . 10 Configuring the BMC Managing the System Using BMC BMC Action on Event . . . . . . . . . . 11 . . . . . . . . . . . . . . . 13 Basic BMC Alerting Over a LAN IPMI Shell Over a LAN . . . . . . . . . . 13 . . . . . . . . . . . . . . . 14 IPMI Shell Over the Serial Cable .
Configuring System BIOS in Dell PowerEdge x9xx and xx0x Systems . . . . . . . . . 27 Configuring System BIOS in Dell PowerEdge xx1x Systems . . . . . . . . . . . . . . 29 Using BIOS Console Redirection With SOL Proxy . . . . . . . . . . . . . . . . . . . 30 Baseboard Management Controller Configuration Entering the Remote Access Configuration Utility in x9xx systems . . . . . . . . . . . . . . . 31 . . . .
Installing on Systems Running Supported Linux Enterprise Operating Systems . . . Uninstalling on Systems Running Supported Linux Enterprise Operating Systems . . . . . IPMI Shell . . . 57 . . . . . . . . . . . . . . . . . . . . . . . . 57 Using IPMI Shell IPMI Shell Global Options . . . . . . . . . . . 59 . . . . . . . . . . . . . 60 . . . . . . . . . . . . . . . 66 . . . . . . . . . . . . . . . . . . . . . . . . 78 IPMI Shell Commands Using SOL Proxy 91 . . . . . . . .
A BMC Management Utility Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 . . . . . . . . . . 117 . . . . . . . . . . . 117 . . . . . . . . . . . . . . 118 . . . . . . . . . . . . . . . . . 118 . . . . . . . . . . . . . . . . . . . . . . . . . 119 B Terminal Mode Commands Configuring Terminal Mode . Using Terminal Mode . Security Information . Syntax Command Length . . . . . . . . . . . . . . . . . Character Support . . . . . . . . . . . . . . . .
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents
1 Introduction The Dell systems’ Baseboard Management Controller (BMC) monitors the system for critical events by communicating with various sensors on the system board and sends alerts and logs events when certain parameters exceed their preset thresholds. The BMC supports the industry-standard Intelligent Platform Management Interface (IPMI) specification, enabling you to configure, monitor, and recover systems remotely.
Additionally, the BMC can be accessed by standard, off-the-shelf terminal or terminal emulator utilities that allow access to sensor status information and power control. Supported Systems and Operating Systems BMC Management Utility supports new Dell systems running supported Microsoft Windows and Linux systems by implementing the new IPMItool commands to monitor your system’s power, view, and set the LCD status. For the complete list of supported systems and operating systems, see the readme.
• Dell Remote Access Controller (DRAC) 5 graphical user interface (GUI) • iDRAC6 Enterprise graphical user interface (GUI) • Command Line Interface (CLI) from a management station depending on the scope of your required configuration tasks. Alternately, you can configure the BMC on a managed system with a running operating system using the Server Administrator home page GUI or CLI. See "Baseboard Management Controller Configuration" on page 31 for more information.
Figure 1-1.
BMC Action on Event If you plan to use your system’s BMC to perform actions when events occur, you must follow the BMC Action on Event configuration guidelines listed in Table 1-1. Table 1-1.
Table 1-2.
Table 1-3.
IPMI Shell Over the Serial Cable If you plan to use the BMC Management Utility’s IPMI Shell to access your system’s BMC over a serial cable, you must follow the BMC configuration guidelines listed in Table 1-4. NOTE: Console redirection does not apply to BMC when using the serial interface. Table 1-4.
Table 1-4.
SOL Proxy Over a LAN If you plan to use the BMC Management Utility’s SOL Proxy to access your system’s console over a LAN, you must follow the BMC configuration guidelines listed in Table 1-5. Table 1-5.
Table 1-5. BMC SOL Configuration Guidelines (continued) Features • Force a reboot on a remote system and activate console redirection • Access BMC of the remote system Connection BMC Configuration Basic Configuration Medium Tools Tasks Management Tools 4 Configure other Console Redirection parameters, such as baud rate, emulation type, and so on.
BMC Configuration and Management Tools Using the Remote Access Configuration Utility in x9xx systems The Remote Access Configuration Utility in x9xx systems provides basic BMC setup and configuration functions that can be accessed during system boot. Use the utility for initial BMC setup and configuration only. For advanced configuration tasks, you must use the Deployment Toolkit SYSCFG utility or Server Administrator Version 2.0 or later.
Using Server Administrator The Server Administrator provides a convenient and easy-to-use GUI for remotely configuring or managing your system’s BMC on a system running a supported operating system. You can use the Server Administrator to configure the most relevant BMC features, such as Platform Event Filter (PEF) parameters and alert destinations. Additionally, Server Administrator can be used as a command line interface.
• The Dell OpenManage Deployment Toolkit User’s Guide provides additional information about installing and using the DTK utilities. • The Dell OpenManage Deployment Toolkit Command Line Interface Reference Guide provides a complete list of all valid BMC-related command-line options, suboptions, and arguments.
Additionally, the Dell OpenManage readme.txt file provides the latest available information for the installation and operation of the programs and utilities used to manage your system through the BMC. The readme is available on the Dell Systems Management Tools and Documentation DVD and on the Dell Support website at support.dell.com/manuals.
Introduction
2 Configuring Your Managed System Before using the BMC Management Utility, configure certain items, such as the necessary system BIOS, network, Intelligent Platform Management Interface (IPMI) encryption key, and serial connection settings, depending on the functionality to be performed, to enable access to the BMC. NOTE: The IPMI encryption key is a public key that is used to generate an encryption key for use between the firmware and the application.
Configuring System BIOS in Dell PowerEdge x8xx/x9xx Systems 1 Turn on or restart your system. 2 Press immediately after you see the following message: = Setup The System Setup screen appears. NOTE: If the operating system begins to load before you press , allow your system to boot, and then restart your system, and try again. 3 Use the up- and down- arrow keys to navigate to the Integrated Devices field and press .
10 Use the up- and down- arrow keys to navigate to the Remote Terminal Type option and then use the space bar to select either VT 100/VT 200 or ANSI, if applicable. 11 Press to return to the System Setup screen. 12 Press to exit the System Setup program. The Exit screen displays the following options: • Save Changes and Exit • Discard Changes and Exit • Return to Setup 13 Choose the appropriate option and exit the system setup.
Off: COM1 and COM2 are both disabled and not available for use by the operating system or applications. BIOS Console redirection is disabled. NOTE: Select On with Console Redirection via COM2 to use Console Redirection with SOL. 6 Use the up- and down- arrow keys to navigate to the External Serial Communication field and press . 7 Use the spacebar to select the appropriate external serial communication option. The available options are COM1, COM2, and Remote Access. The default option is COM1.
Configuring System BIOS in Dell PowerEdge xx1x Systems 1 Turn on and restart your system. 2 Press immediately after you see the following message: = Setup The System Setup screen displays. NOTE: If the operating system begins to load before you press , allow your system to boot, and then restart your system, and try again. 3 Use the up- and down- arrow keys to navigate to the Serial Communication field and press .
8 Use the up- and down- arrow keys to navigate to the Failsafe Baud Rate option and then use the space bar to set the console failsafe baud rate, if applicable. 9 Use the up- and down- arrow keys to navigate to the Remote Terminal Type option and then use the space bar to select either VT 100/VT 220 or ANSI, if applicable. 10 Use the up- and down- arrow keys to navigate to and change the settings for Redirection After Boot. 11 Press to return to the System Setup screen.
Windows Special Administrative Console (SAC): Do not configure Windows SAC for serial console redirection. Enable console redirection after reboot in system BIOS. Linux: Do not configure console redirection after rebooting the system BIOS. Do the tasks listed in the "Installation and Setup for Linux Operating Systems" on page 44, to configure Linux for console redirection. NOTE: See "Escape Key Sequences" on page 129 for a list of keystrokes to be used for BIOS Setup operations from a serial terminal.
Entering the Remote Access Configuration Utility in x9xx systems 1 Turn on or restart your system. 2 Press when prompted after POST. If your operating system begins to load before you press , allow the system to finish booting, and then restart your system and try again. Remote Access Configuration Utility Options Table 2-1 lists the Remote Access Configuration Utility options and shows how to configure the BMC on a managed system.
Table 2-1. Remote Access Configuration Utility in x9xx systems (continued) Option Description NIC Selection Displays the configuration option. NOTE: This option is available only on Dell PowerEdge x9xx, xx0x, and xx1x systems. • Shared Select this option to share the network interface with the host operating system. The remote access device network interface is fully functional when the host operating system is configured for NIC teaming.
Table 2-1. Remote Access Configuration Utility in x9xx systems (continued) Option Description • Dedicated Select this option to enable the remote access device to utilize the dedicated network interface available on iDRAC6 Enterprise. This interface is not shared with the host operating system and routes the systems management traffic to a separate physical network, enabling it to be separated from the application traffic. NOTE: This option is available only on systems with iDRAC6 Enterprise.
Table 2-1. Remote Access Configuration Utility in x9xx systems (continued) Option Description Default Gateway The IP gateway for the static IP address. VLAN Enable Enables or disables the virtual LAN ID. VLAN ID This field is read-only when VLAN Enable is set to off. To enter a value, navigate to the VLAN ID field from another field. A valid value for the virtual LAN ID must be a number from 1 to 4094.
Table 2-1. Remote Access Configuration Utility in x9xx systems (continued) Option Description Alert Destination 1 This field is read-only when LAN Alert Enabled is set to off. Enter the IP address of the first alert destination. Use the Left or Right arrow keys to navigate to each octet. Use the numeric keypad to enter each octet. The following IPv4 rules apply: • IP addresses cannot be 127.xxx.xxx.xxx, where xxx is between 0-255. • The first octet must be between 1-223 (i.e. 143.xxx.xxx.
Table 2-1. Remote Access Configuration Utility in x9xx systems (continued) Option Description LAN Speed Setting This field is read-only when Auto-Negotiate is set to Enabled. Sets the LAN Speed Setting to 10 or 100 Mbps LAN Duplex Setting This field is read-only when Auto-Negotiate is set to Enabled. Sets the LAN communication method to Half or Full Duplex.
Table 2-1. Remote Access Configuration Utility in x9xx systems (continued) Option Description Register RAC Name This field is read-only when Register RAC Name is set to off. Enter the Current DNS RAC Name using 1-32 alphanumerics, spaces, and symbols. Press to save the value. Press to exit the field without saving. Domain Name from DHCP Turns the domain name on or off. Domain Name This field is read-only when DNS Servers from DHCP is set to on.
Table 2-1. Remote Access Configuration Utility in x9xx systems (continued) Option Description Account Access Enables or disables account privileges. Account Privilege Sets the account to: Admin, User, Operator, or No Access Account User Name Sets the account user name. Enter Password Enter the password for this Account User. You must enter at least one non-null character. Confirm Password Confirm the password you entered.
Configuring Your BMC Using the Deployment Toolkit Utility The Dell OpenManage Deployment Toolkit SYSCFG utility includes a set of Microsoft Windows PE and Linux-based utilities for configuring and deploying Dell systems. The Deployment ToolKit (DTK) SYSCFG utility is specifically designed to address all necessary BMC configuration tasks using a powerful and comprehensive command-line interface. This utility runs on PowerEdge 1435SC and all supported PowerEdge x7xx, x8xx, x9xx, xx0x, and xx1x systems.
1 Download the DTK file dtk-2.X-winpe-AXX.exe from the Dell Support website at support.dell.com and save it on a system running a supported Windows operating system. 2 After the zip file downloads, double-click the file. 3 Click OK. 4 Click Unzip. By default, the DTK files are unzipped to C:\. The SYSCFG.EXE utility is located in the C:\Dell\Toolkit\Tools directory. Dell-provided drivers are located in the C:\Dell\drivers folder.
NOTE: For your reference, a sample winpeoem.sif file is available under \Dell\Toolkit\template\Configs. 4 Starting required services: The mr2kserv service should be installed and started for RAID to function; the racsvc service should be installed and started for RACADM to function. For details on how to start the required services, see the sample winbom.ini file under \Dell\Toolkit\template\Configs. NOTE: When booting the target system, ensure that the RAC and the mr2kserv services are running.
ETFSBOOT.COM is part of the OPK tools and makes the Windows PE CD bootable. The following command line creates a bootable ISO image called Dellx86winpe.iso: C:\WINPE_OPKTOOLS\OSCDIMG -bETFSBOOT.com -n c:\DELLWINPEBUILD C:\FINALBUILD\Dellx86winpe.iso 9 Copy the SYSCFG.EXE utility to the root of the directory. 10 After you create an ISO image, you can use any CD-burning software to burn the image onto a CD. You are now ready to use your bootable CD to configure the BMC on a managed system.
NOTE: is passed as the destination to the WAIK command copype.cmd. The destination folder C:\vistaPE_x86 is created as part of the process, and should not already exist. Creating a Bootable CD Use the following steps to create bootable media: 1 Click Start, navigate to All ProgramsMicrosoft Windows AIK. 2 Click Windows PE Tools Command Prompt to open a command prompt window. 3 Run the following command: oscdimg -n -bc:\vistaPE_x86\etfsboot.com c:\vistaPE_x86\ISO c:\vistaPE_x86\WinPE2.0.
NOTE: Your scripts should also take care of copying miscellaneous items to unlock the CD, so that the CD can be mounted and ejected as required by the operating system’s installation process. 6 In /mnt/cdrom/isolinux.cfg, the cd install section points to your customized start-up script. NOTE: The scripts that you copy into the CD will be copied to and run from the RAM disk. This task is done to ensure the CD is not locked. Ensure that your sample scripts have valid path names.
1 Insert the bootable BMC configuration diskette or CD into the appropriate drive of the system to be deployed and reboot the system. 2 To create a new user, at the command prompt, type: syscfg username --userid=X --name=name where X is a number between 2–10 and name is an ASCII string of 16 or fewer characters. Press to execute the command line options.
For a complete list of valid options, suboptions, and arguments for configuring the BMC LAN channel see the Deployment Toolkit Command Line Interface Reference Guide. 3 To configure the BMC IP address source for the LAN channel to a static IP address, at the command prompt, type: syscfg lcp --ipaddrsrc=static --ipaddress= XXX.XXX.XXX.XX --subnetmask=XXX.XXX.XXX.X --gateway= XXX.XXX.XXX.X Press to execute the command line options.
Configuring Your BMC Using Server Administrator You can also configure the BMC options using Server Administrator Version 5.3 or later, which is a one-to-one systems management software program that must be installed on the managed system. Once installed, you can remotely access Server Administrator from a management station with a supported browser to perform BMC configuration tasks. See the Server Administrator User’s Guide for more information about installing and using Server Administrator.
7 Click the Users tab. Under the Users tab, you can modify the BMC user configuration. CAUTION: A password must be set for each BMC user. The BMC firmware does not allow access to users with null user names or passwords. Configuring BIOS in Server Administrator To configure BIOS in Server Administrator, complete the following steps: 1 Click the System object. 2 Click the Main System Chassis object. 3 Click the BIOS object. 4 Click the Setup tab.
4 Configure the DRAC 5 NIC settings in the Network Configuration page. Table 2-1 describes the Network Settings and IPMI Settings on the Network Configuration page. 5 Click Apply Changes when completed. 6 Click the appropriate Network Configuration page button to continue. Adding and Configuring DRAC 5 Users Create unique users with specific administrative permissions (or role-based authority) to manage your system with the DRAC 5 and maintain system security.
3 Using the BMC Management Utility The BMC Management Utility is a collection of software applications that enable remote management and configuration of Dell systems equipped with a BMC. The BMC Management Utility includes the following components: • Command Line Interface (IPMI Shell and IPMItool) Both IPMI Shell and IPMItool are scriptable console application programs used for the control and management of remote systems using the IPMI version 1.5 and later protocol.
• Serial-Over-LAN Proxy (SOL Proxy) The SOL Proxy is a telnet daemon that allows LAN-based administration of remote systems using the Serial Over LAN (SOL) and IPMI protocols. Any standard telnet client application, such as HyperTerminal on Microsoft Windows or telnet on Linux, can be used to access the daemon's features. SOL can be used either in the menu mode or command mode.
Installation Prerequisites Before using the BMC Management Utility, you must perform at least the basic BIOS and BMC configuration tasks described in "Configuring Your Managed System" on page 25. In addition, to access the BMC using the IPMI serial feature, you must have a working connection between the management station and the correct serial I/O port of the managed system’s BMC using a null modem cable. Figure 3-1.
Installing on Systems Running Supported Windows Operating Systems To install the BMC Management Utility on a management station running the Windows operating system, perform the following steps: 1 Log in with administrator privileges to the system where you want to install the systems management software components. 2 Exit any open application programs and disable any virus-scanning software. 3 Insert the Dell Systems Management Tools and Documentation DVD into your system's DVD drive.
9 Ensure that all information is correct and click Install. The Installing Dell OpenManage Management Station screen appears and displays the status of the installation. 10 When installation is complete, the Install Wizard Completed screen appears. Click Finish. NOTE: Enable the virus scanning software after installation. See the Dell OpenManage Installation and Security User’s Guide for additional information about installing the BMC Management Utility on a management station.
Installing on Systems Running Supported Linux Enterprise Operating Systems To install the BMC Management Utility on a management station running the Linux operating system: 1 Log in as root to the system where you want to install the management station components. 2 If required, mount the appropriate media supplied by Dell using the command: mount /mnt/cdrom 3 Install the BMC Management Utility with the following command for SUSE Linux Enterprise server: rpm -ivh /linux/bmc/osabmcutil9g-SUSE*.
Uninstalling on Systems Running Supported Linux Enterprise Operating Systems To uninstall the BMC Management Utility, perform the following steps: 1 Log in as root. 2 Enter either of the following commands to remove all the installed packages from SUSE Linux Enterprise Server or Red Hat Enterprise Linux. rpm -e osabmcutil9g-SUSE* rpm -e osabmcutil9g-RHEL* If the BMC Management Utility has been uninstalled, you will receive a success message.
In addition to the operations that can be performed by a user with user-level BMC user privileges, IPMI Shell allows a user with operator-level and administrator-level BMC user privileges to: • Power on, reset, or power cycle a managed system. • Simulate a hard power off on a managed system (forcing the system to turn off without shutting down the operating system). • Clear the system event log (SEL). • Turn the blinking system identification LED on or off.
Using IPMI Shell To use IPMI Shell, perform the following steps: On systems running a supported Microsoft Windows operating system: 1 Start a Command Prompt window. 2 Locate the ipmish.exe file. By default, ipmish.exe is located in the directory: C:\Program Files\Dell\SysMgt\bmc. 3 Enter IPMI Shell commands (see "IPMI Shell Command Syntax" on page 59) to manage the remote system. See "IPMI Shell Commands" on page 66 for a complete list of valid options, commands, subcommands, and arguments.
Arguments with embedded tabs or spaces must be enclosed in matching double quotation marks ("). For example: -user "John Smith" Every command has one default action. The default action is typically, but not always, the equivalent of reading and displaying the current setting or status for the command.
Specifies the KG value in Hex format. The IPMI encryption key is a public key used to generate an encryption key for use between firmware and application. It is differentiated from a password, which is not public and is used to access the firmware. The maximum value is 20 ASCII hex pairs with no spaces between the pairs. NOTE: Even number of hexadecimal characters is valid and odd number of hexadecimal characters is invalid. For example, 123456AB67 is valid, and 123 is invalid.
Options -com serial_port Specifies the serial port used when establishing an IPMI session to the managed system. For a system running Windows, the management station port can be 1, 2, 3, and so on. For systems running Linux, the management station port can be ttyS0, ttyS1, ttyS2, and so on. -baud baud_rate Specifies the communication baud rate over the serial channel.
Description This option displays the following information: • A summary page for all commands • A summary of all subcommands for a single command • A detailed description of a command-subcommand combination Options -help subcommand A command list and a capsule description of options are printed if no argument is given. When there is an argument specifying a valid command, the help option displays a detailed description of the command. See Figure 3-3 and Figure 3-4. Figure 3-3.
Figure 3-4. IPMISH Help option Example 2 IPMI Session Option -interactive Synopsis ipmish -interactive [-cfg ] Description This option invokes the interactive CLI mode. An IPMISH prompt appears when entering interactive CLI mode. Type quit to exit the IPMISH prompt and return to the CLI prompt. NOTE: The command prompt responds with an error message in the interactive mode, if a command is used before establishing an IPMI session with connect.
Specifies the configuration file for BMU to start the CLI mode with. If a configuration file is not specified, BMU operates with default configuration settings. NOTE: The -interactive option must be followed by connect for ipmish to work. See "Configuring the SOL Proxy Configuration File" on page 93 for more information on configuration files. Figure 3-5.
IPMI Shell Commands Table 3-1 lists IPMI Shell commands with a brief description. NOTE: The sol, sensor, and connect commands can be used in the IPMI Shell interactive and non-interactive modes and the quit command can be used only in the interactive mode. Table 3-1. IPMI Shell Commands Command Description identify Controls the identification LED on the front panel. sysinfo Retrieves and displays managed system information. power Controls the power state of the managed system.
Subcommands on off Turns the managed system’s front panel LED on or off. If the BMC supports the IPMI extension Chassis Identify On command, then the identify on command turns the LED on indefinitely until the identify off command is used to turn the LED off. NOTE: Acknowledgement or status check of the command is not displayed on the command prompt. You should manually check the status on the system. Options -t seconds Specifies how long the LED is on. It should be no longer than 255 seconds.
Subcommands fru — Returns FRU related information id — Returns BMC related information Default Subcommand If a subcommand is not specified, this command acts the same as sysinfo id. See Figure 3-7. Figure 3-7. sysinfo Option Example Figure 3-8.
power Synopsis power status power off [-force] | on | cycle | reset Description This command displays the current power status of the managed system, turns the system on or off, or resets the system. See Figure 3-9. Subcommands • status — Displays the current power status of the system, the returned value is on or off. • on — Turns on the managed system. • off — Issues a "graceful shutdown" IPMI command. NOTE: This reboot feature mimics restarting the system using the server's power button.
Figure 3-9. Power Option Example sel Synopsis sel status sel get [[-begin index1] [-end index2 | -max count]] | [-last n] [-format ] sel clear Description This command displays the system event log information, displays the contents of the event log, and deletes all the event log records. See Figure 3-10. Subcommands 70 • status — Displays the total number of system event log records. • get — Prints all or part of the event log. • clear — Deletes all the records in the event log.
Options -begin index1 Specifies the first record to display. -end index2 Specifies the last record to display. -max count Specifies the maximum number of records to display. If the value of the argument count is bigger than the total number of the records, the last record displayed will be the last one in the event log. -last n Specifies the number of records to be displayed, starting from the last record and counting backwards.
Figure 3-10. sel Option Example SOL Synopsis sol[enable |disable] sol config [-baud baud_rate][-priv privilege_level] [-retry count retry_count] [retry interval retry_interval] Description This command allows you to configure sol session parameters of a remote BMC. See Figure 3-11. NOTE: The command prompt responds with an error message if a command is used before establishing an IPMI session with connect. Subcommands 72 • enable — Allows you to enable SOL of connected server.
Options • -baud baud_rate Specifies the communication baud rate over the serial channel, such as 9600 or 19200. It should be in conformity with the SOL baud rate of the managed server. • -priv privilege_level Specifies minimum privilege levels required to establish an SOL session. Possible values are User, Operator, and Administrator. • -retry count retry_count Specifies number of times the BMC will retry sending SOL packages if no acknowledgement is received.
sensor Synopsis sensor [temp|fan|volt|discrete|numeric][-format ] Description This command displays the current status of platform sensors using one of the two possible formats. See Figure 3-12. OPTIONS [temp|fan|volt|discrete|numeric] Specifies the sensor group (temp, volt, fan, discrete, or numeric) for which information is displayed. If you do not specify a sensor group, all sensors for which there is information will be displayed.
Figure 3-12. Sensor option example connect Synopsis connect -ip bmc_ip_address | bmc_hostname [-u username] [-p password] [-k IPMI encryption key value] connect -com bmc_ip_address | bmc_hostname -u username -p password [-k KG value] Description This command establishes an IPMI connection with the remote server in the interactive mode to enable the user to perform server management activities.
-p password Specifies the password to be used to connect to the remote managed system. -k IPMI encryption key value Specifies the KG value in Hex format. The IPMI encryption key is a public key used to generate an encryption key for use between firmware and application. It is differentiated from a password, which is not public and is used to access the firmware. The maximum value is 20 ASCII hex pairs with no spaces between the pairs.
Default Subcommand If a subcommand is not specified, this command functions the same as LCD info. powermonitor Synopsis powermonitor status Description This command displays the current power status of the managed system. Subcommands • status — Displays the current power status of the system. The returned values denote energy consumption, peak power (in Watts), and peak amperage. • clear peakpower — Deletes the peak power value. • clear cumulativepower — Deletes the cumulative power values.
help Synopsis help [command] Description This command lists commands and capsule descriptions with syntax for each command. See Figure 3-14. Argument command Specifies the command for which detailed description is required. Figure 3-14. IPMISH help option SOL Proxy SOL Proxy is a simple telnet server. It allows a telnet client to interact with the hardware-designated serial port of a remote managed system using the LAN communication channel. See Figure 3-15.
When BIOS console redirection to serial port is enabled on the remote managed system, any application that uses the BIOS to read from or write to the system console will have its I/O redirected to the designated serial I/O port. When SOL is activated, the BMC firmware reads any data written to the serial port and transmits it to the SOL Proxy as LAN packets. SOL Proxy then forwards the data to the telnet client as TCP/IP packets.
You can use a variety of telnet clients to access SOL Proxy features. For example: • In a Windows environment, you can use a Command Prompt window as your console. However, function keys such as and will not operate correctly with this client except on systems running Windows Server 2003. • In a Windows environment, you can also use any telnet application that supports VT100 or ANSI emulation mode (such as HyperTerminal) as your console.
The Linux SysRq function is one example of an advanced debugging feature that is enabled by use of the break function. See the "BIOS Configuration" on page 25 on how to use this feature. See the "Serial Console redirection With SOL Proxy" on page 133 for more information on the SysRq feature. To enable BIOS console redirection for use with SOLProxy: • Configure the Console redirection attribute to On with Console Redirection via COM2 for Dell x9xx and xx0x.
4 Provide a password when prompted. SOL Proxy will use this combination of operating system username and password to authenticate you on the SOL Proxy Server. The specific authentication scheme will depend on the operating system configuration for the SOL Proxy Server. However, if localhost or an IP address of 127.0.0.1 is used, it is assumed that the user has login privileges to the current host, and is not prompted for a username and password.
5 After authentication, a login successful message and the SOL Proxy main menu prompt appear. You are ready to use SOL Proxy. See "SOL Proxy Main Menu" on page 83 for further instructions. SOL Proxy Main Menu After the telnet connection with SOL Proxy is successfully established, you are presented with the following choices. See Figure 3-16. Figure 3-16.
Menu option 2 allows you to enable, disable, and configure the SOL defaults, including the minimum user privilege level required for activating SOL and the communication baud-rate. Menu options 3 and 4 allow you to establish a SOL remote console session through the SOL Proxy main menu. Menu option 3 establishes a SOL session without changing the remote system’s state. This option is ideal for connecting to the Microsoft SAC/EMS or the Linux console.
Figure 3-17. Connecting to the Remote System’s BMC Configuring the SOL for the Remote Managed System Select option 2 in the main menu. NOTE: You must be connected to the managed system’s BMC before you can configure the SOL features. If SOL Proxy is not yet connected to the managed system’s BMC, you are prompted for an IP address, a username/password combination, and an IPMI encryption key. The IPMI encryption key value will be ignored if no key was set at the BMC on the target server.
The SOL configuration menu appears. According to the current SOL status, the content of the SOL configuration menu varies: • If SOL is already enabled, the current settings are displayed and you are presented with three choices. See Figure 3-18. Figure 3-18. Configuring the Serial-Over-LAN for the Remote System, Example 1 • 86 If SOL is currently disabled, the options shown in Figure 3-19 are displayed. Type Y to enable SOL or N to keep SOL disabled. See Figure 3-19.
Figure 3-19. Configuring the Serial-Over-LAN for the Remote System, Example 2 • If SOL is enabled, two BMC settings are displayed: – The communication baud-rate between the system serial port and the BMC – The minimum BMC user privilege level required for activating console redirection SOL Proxy displays a list of valid values for each feature, as well as the current value of the feature enclosed in a pair of brackets.
Figure 3-20. SOL Settings, Example 3 Activating Console Redirection Select option 3 in the main menu. NOTE: You must be connected to the managed system’s BMC before you can configure the SOL features. If SOL Proxy is not yet connected to the managed system’s BMC, you are prompted for an IP address and a username/password combination. See "Connecting to the Remote Managed System’s BMC" on page 84 for more information. The remote managed system’s text console is redirected to your management station.
Figure 3-21. Console Redirection Example Rebooting the Managed System and Activating Console Redirection Select option 4 in the main menu. NOTE: You must be connected to the managed system’s BMC before you can configure the SOL features. If SOL Proxy is not yet connected to the managed system’s BMC, you are prompted for an IP address, a username/password combination, and an IPMI encryption key. The IPMI encryption key value will be ignored if no key was set at the BMC on the target server.
While the managed system reboots, you can enter the BIOS system setup program to view or configure BIOS settings. See Figure 3-22. NOTE: Before activating the console redirection, you must first enable the console redirection features. See "Configuring Your Managed System" on page 25 for more information. Figure 3-22. Reboot Example Getting Help Select option 5 in the main menu to display detailed descriptions for each option. See Figure 3-23.
Figure 3-23. Sample Help Screen Exit Select option 6 to end your telnet session and disconnect from SOL Proxy. Using SOL proxy in command mode By default, SOL Proxy is installed for use in the menu mode by the system. See "Configuring the SOL Proxy Configuration File" on page 93 for instructions on how to change the default settings to command mode. Commands in SOL Proxy SOL Proxy command mode is similar to the IPMI Shell interactive mode.
console Synopsis console Description This command allows users to establish an SOL session with the connected server. NOTE: BMU responds with an error message if console is used before establishing an IPMI session with connect. reboot Synopsis reboot[-force] Description This command allows you to control power configurations and establish an SOL session in one atomic operation. It is equivalent to executing the menu command of "Reboot and Activate Console Redirection". See Figure 3-24.
Configuring the SOL Proxy Configuration File Certain parameters, for IPMI Shell and SOL Proxy, must be correctly configured in the SOL Proxy Configuration file, - SOLProxy.cfg, which is located in the default installation BMC directory. The parameters and their descriptions are as follows: Comments Any line starting with a “#” is treated as a comment. For example: #The file is an example. IP Address Specifies the specific IP address used to connect to SOL Proxy.
session_timeout=30 Power-off Timeout Specifies the time in seconds before the SOL Proxy gives up polling for the managed system's power status. If the SOL Proxy issues the power off command and the system does not power off within the specified interval, the SOL Proxy returns with a message, indicating that the SOL Proxy was unable to power off the system due to the timeout interval.
Sol Loss Silent Specifies system behavior when one or more SOL packets are lost. The possible values are 0 and 1. If it is set to 0 or is absent, the system will print an error message on the screen each time an SOL packet is lost. If it is set to 1, the system will not print error messages for loss of SOL packets. For example: sol_loss_silent=0 or 1 Sol Loss Threshold Specifies number of SOL packets that can be lost before SOL deactivation.
debug Specifies if the debug data will be logged. The default is off. debug=off IPMItool IPMItool is a CLI utility that helps in configuring and managing devices using the IPMI version 1.5 and later protocol. IPMItool supports out-of-band (OOB) access (over a LAN) to a single system at a time. However, multiple IPMItool sessions can run simultaneously on the same managed system. IPMItool allows a user with user-level BMC privileges to: • Display the current power status.
To facilitate command scripting, upon successful execution, IPMItool terminates with an exit code of zero, and will output the execution results in a parsable format. If an error is encountered, the program exits with a nonzero error code and outputs the error in a parsable format. See "BMC Management Utility Error Codes" on page 113 for a complete list of possible BMC Management Utility error codes. The complete list of commands listed under delloem in Table 3-2 are supported by the IPMItool.
Command Syntax: ipmitool -I lanplus -H -U -P -k delloem lcd set mode {none}|{modelname}|{ipv4address}|{macaddress}|{sy stemname}|{servicetag}|{ipv6address}|{ambienttemp }|{systemwatt}|{userdefined}|{assettag} NOTE: The kgkey (-k option in lanplus) is a string of 20 ASCII characters. This feature is enhanced for xx1x systems to support the kgkey in hex. The option is –x followed by a 40 character hex value.
ipmitool -I lanplus -H -U -P -k delloem lcd set vkvm {active}|{inactive} • lcd set frontpanelaccess: Sets the LCD mode to view and modify, view only, or disabled.
ipmitool -I lanplus -H -U -P -k delloem powermonitor powerconsumption The system peak headroom is applicable on systems with PMBus support. The peak headroom is reported in BTU/hr or Watt. Peak Headroom (in Watts) = Input Wattage to Power Supply–Peak Power drawn by the system. For redundant power supplies, the minimum input wattage between the two power supplies is taken. This value is not displayed in modular systems.
Command Syntax: ipmitool -I lanplus -H -U -P -k delloem powermonitor powerconsumptionhistory NOTE: The new power monitoring features are not supported on IPMIsh and SOLProxy. Default Subcommand If you do not specify a subcommand, this command displays the current power status of the system. The returned values denote energy consumption, peak power (in Watts), and peak amperage (in Amperes).
Default Subcommand If you do not specify a subcommand, this command is equivalent to the sensor list command. Options for mac • list: Displays the number, MAC address, and status of all NICs. It also displays the DRAC/iDRAC MAC address. • get : Displays the MAC address and status of the specified NIC number. Default Subcommand If you do not specify a subcommand, this command is equivalent to the mac list command. Options for lan • set : Allows you to set NIC selection mode.
ipmitool raw 0x18 0x58 0xe4 0x15 0x66 0x6f 0x6f 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 The ASCII character conversion chart is displayed in Table 3-3: Table 3-3.
Table 3-3.
Table 3-3.
Table 3-3.
Table 3-3.
Using the BMC Management Utility
Known Issues and Frequently Asked Questions 4 This section discusses known issues with using the BMC Management Utility, along with frequently asked questions. Known Issues General Issues • You must assign a valid BMC user name and password before you can connect to your system's BMC using the BMC Management Utility.
IPMI Shell Issues • If you type ipmish from any directory other than the directory where the BMU is installed, you will receive a "command not found" error from MS-DOS. This is because the BMU install directory is not included in the system search path. You can execute IPMISH directly by specifying a fully-qualified path or by first navigating to the BMC directory and then executing the command. You may also manually add the BMU install directory to the execution search path.
Q: Why can’t I connect to a console using the terminal emulation software included with my Microsoft Windows operating system? A: The version of HyperTerminal included with Windows does not provide many functions required during console redirection. Either upgrade to HyperTerminal Private Edition 6.1 or later, or select any other terminal emulation software that supports full configuration of VT100 or ANSI emulation mode. Q. What is the Spanning Tree feature? A.
Q: Why do I see a connection time-out error message when I perform the Power Reset command using the IPMISH command line tool? A: The spanning-tree feature described in the previous Q&A can cause problems during power management as well. Use the solution above to help assure that power reset and other power management commands can function without network timeouts.
BMC Management Utility Error Codes 5 The following is a list of error messages for the BMC Management Utility. In case of a functional failure, an error message will be printed to stderr. The text of the error message is listed in the Message column in Table 5-1. Errors will always be printed in a parsable format such as: Error ():! The following is an example: Error(0xC1):Invalid Command! Table 5-1.
Table 5-1. BMC Management Utility Error Codes (continued) Code Classification Message Description A5h Initialization errors. Authentication failure. Request for a session from the local or remote proxy was rejected. Access denied. Trying to access the proxy from a forbidden IP address. Unknown language. Unknown language code. Invalid IP address. IP resolving error. Session buffer limit exceeded. Length exceeds the limit of telnet input. A6h A8h A7h 114 Syntax errors. Command syntax error.
Table 5-1. BMC Management Utility Error Codes (continued) Code Classification Message Description IPMI Error First index larger than The first index is larger the last. than the last. First index larger than The first index is larger total SEL records. than the total SEL records. A8h A9h H/W or F/W errors. Unsupported command. Unsupported operation. Sensor not present. Request sensor, data, or 0xCB record not present. Sensor command error. Command illegal for specified sensor or record type.
Table 5-1. BMC Management Utility Error Codes (continued) Code Classification Message Description IPMI Error Duplicate command. Cannot execute duplicated request. 0xCF SDR busy. Sensor Data Record Repository in update mode. 0xD0 Device busy. Device in firmware update mode. 0xD1 BMC unavailable. BMC initialization in progress. 0xD2 Bad BMC state. Request not supported 0xD5 in present BMC state. BMC out of sessions. No session slots are 0x81, available for connection 0x82, request.
Terminal Mode Commands 6 This appendix provides information about terminal mode commands. Terminal mode allows you to directly connect to the system's Baseboard Management Controller (BMC) using a serial port connection and execute text-based commands.
• Disable the RAC serial Console if you have a DRAC 5 installed. Login to the DRAC GUI, navigate to Serial from Remote Access, and disable Enable Serial console. • Set Serial Port 1 for PowerEdge x8xx systems. This option is available in the BIOS Setup, in the Integrated Devices menu. Using Terminal Mode Use the Terminal Mode feature to perform the following tasks: • Power the server on or off. • Reset the server. • Retrieve the server's health status.
Syntax Terminal mode messages follow the general syntax below: [] Each terminal mode message must be preceded with the left bracket "start” character and must be ended with a right bracket “stop” character and the appropriate input new-line sequence. No input characters are accepted until the start character has been received. NOTE: Hex-ASCII commands can either use upper or lower-case letters for ASCII representations of hex digits.
Hex-ASCII Command Format Binary IPMI commands are sent and received as a series of case-insensitive hex-ASCII pairs, where each is separated from the preceding pair by a single space character. Table 6-1 lists the terminal mode requests to BMC and Table 6-2 lists the terminal mode responses from BMC. The following is an example of a binary IPMI request message: [18 00 22] Table 6-1.
Examples Hex-ASCII command example (IPMI Reset Watchdog Cmd): [18 00 22] [1C 00 22 00] Text command example: [SYS TMODE] [OK TMODE] Table 6-3. Terminal Mode Text Commands Command Switches Description SYS PWD -U -U activates a terminal mode session. USERNAME USERNAME corresponds to the ASCII text for the username. represents a printable password (up to 16 characters). If is not provided, then a Null password (all binary 0’s) is submitted.
Table 6-3. Terminal Mode Text Commands (continued) Command Switches Description SYS TMODE Used as a no-op confirm that Terminal Mode is active. The BMC returns an OK response followed by TMODE. SYS SET BOOT XX YY ZZ AA BB Sets the boot flags to direct a boot to the specified device following the next IPMI command or action initiated reset or power-on. XX…BB represent five hex-ASCII encoded bytes, which are the boot flags parameter in the Boot Option Parameters.
Table 6-3. Terminal Mode Text Commands (continued) Command SYS GET BOOTOPT XX YY ZZ Switches Description This is a text version of the IPMI Get System Boot Options command. It allows any of the boot option parameters to be retrieved. XX YY ZZ represents the hex-ASCII for the data bytes that are passed in the Get System Boot Options request. The BMC returns the data from the command in hexASCII format. XX—Parameter selector. [7]—Reserved. [6:0]—Boot option parameter selector. YY—Set Selector.
Table 6-3. Terminal Mode Text Commands (continued) Command Switches SYS SET TCFG Description Returns the Terminal Mode Configuration bytes where XX and YY represent hex-ASCII encoding for the volatile version of data bytes 1 and 2 as specified in Table 6-4, and AA BB represent hex-ASCII encoding of the non-volatile version. V:XX
Table 6-3. Terminal Mode Text Commands (continued) Command SYS HEALTH QUERY Switches Description Causes the BMC to return a high level version of the system health status in terse format. The BMC returns a string with the following format if the command is accepted. PWR:zzz H:xx T:xx V:xx PS:xx C:xx D:xx S:xx O:xx Where: PWR is system POWER state. H is overall Health. T is Temperature. V is Voltage. PS is Power Supply subsystem. C is cooling subsystem (Fans). D is Hard Drive/RAID Subsystem.
Table 6-3. Terminal Mode Text Commands (continued) Command Switches Description SYS HEALTH QUERY -V Causes the BMC to return a high level version of the system health status in multi-line verbose format. The BMC returns a string of the following format: SYS Health:xx
Table 6-3. Terminal Mode Text Commands (continued) Command Switches Description SYS IDENTIFY -ON Causes the BMC to indicate the system’s location, for example, with a blinking LED or beep for a specific period of time. XX is an optional hex-ASCII byte representing the number of seconds the BMC is to cause the system to identify itself. If XX is not provided, the BMC will indicate the system’s location only for 15 seconds. This is a text version of the optional Chassis Identify command.
Table 6-4. Terminal Mode Configuration (continued) Byte Explanation 2 [7:4]—Output newline sequence (BMC to console). Selects what characters the BMC uses as the sequence when the BMC writes a line to the console in Terminal Mode. 0h = no termination sequence. 1h = (Factory default) 2h = 3h = 4h = 5h = All other = reserved [3:0]—Input newline sequence (Console to BMC).
Escape Key Sequences 7 Console redirection uses ANSI or VT100/220 terminal emulation, which are limited to basic ASCII characters. There are no function keys, arrow keys, or control keys in this character set. However, most BIOS software requires the use of function keys and control keys for ordinary actions. Specific function keys and escape keys can be emulated by using a special key sequence, called an escape sequence, to represent a specific key.
Escape Key Sequences
Serial Port Console Redirection 8 Serial Communication For Dell PowerEdge x9xx, xx0x, and xx1x systems, serial console redirection can be accomplished using COM1 or COM2.
Serial Terminal Communication to BMC or DRAC Serial Terminal Mode allows you to directly connect to the BMC or DRAC using a serial port connection and execute text-based commands. See "Terminal Mode Commands" on page 117 for information about configuring your BMC and DRAC for Serial Terminal Communication as well as available Terminal Mode Commands.
NOTE: The unattend.txt file is automatically created after installation. [Data] EMSPort EMSBaudrate Where, EMSPort = Port used for serial communication. For example, COM1 or COM2. EMSBaudrate = Configured baud rate for communication. The minimum supported baud rate for supported Dell PowerEdge systems is 19200.
3 If the /etc/grub.conf contains a splashimage directive, you must comment it out. This sample file, using a baud rate of 19200, is an example. The following maximum baud rates are allowed for BMC serial communication and SOL: • 19200 for PowerEdge 1425SC and other PowerEdge x8xx systems. • 57600 for PowerEdge x9xx and xx0x systems without Dell Remote Access Controller 5 (DRAC 5). • 115200 for PowerEdge x9xx, and xx0x systems with DRAC 5. • 115200 for PowerEdge xx1x systems. Table 8-1.
Additional information for editing the grub.conf: 1 You may need to disable GRUB's graphical interface and use the text-based interface instead; otherwise, the GRUB screen will not be displayed in BMU console redirection. To do so, comment out the line starting with splashimage. 2 If you have multiple options in GRUB and you want all of them to start a console session through the BMU serial connection, add console= ttyS1,19200 to all options.
Table 8-2. Sample File: /etc/innitab # # inittab This file describes how the INIT process should set up # the system in a certain run-level. # # Author: Miquel van Smoorenburg,
Table 8-2. Sample File: /etc/innitab (continued) # Things to run in every runlevel. ud::once:/sbin/update # Trap CTRL-ALT-DELETE ca::ctrlaltdel:/sbin/shutdown -t3 -r now # When our UPS tells us power has failed, assume we have a few # minutes of power left. Schedule a shutdown for 2 minutes from now. # This does, of course, assume you have power installed and your # UPS is connected and working correctly.
Edit the file /etc/securetty, as follows: Add a new line, with the name of the serial tty for COM1: ttyS0 See the sample file, which shows the addition of the new line. Table 8-3.
Index A D ANSI, 52, 80, 111 delloem, 78 B baseboard management controller, 31 Baseboard Management Controller (BMC) features, 9 management activities, 9 deployment overview network-based, 21 E error codes BMC Management Utility, 113 Escape key sequences, 129 BMC, 31 BMC management tools BMC Management Utility, 9 Server Administrator, 9 standard terminal or terminal emulator utilities, 10 BMC Management Utility, 51, 113 installation prerequisites, 53 installing, 52 IPMI Shell, 51 SOL Proxy, 52 support
IPMI Shell, 57 command syntax, 59 commands, 66 diagram, 58 getting help, 62 global options, 60 IPMI help option, 62 management tasks, 57 serial channel session option, 64 using, 59 IPMI Shell diagram, 58 IPMItool, 96 K known issues, 109 P planning to use a BMC BMC LAN access configuration guidelines, 15 BMC LAN alerting configuration guidelines, 13-14 BMC serial configuration guidelines, 16 BMC SOL configuration guidelines, 18 R red hat linux, serial redirection, 30 140 Index running a scripted deploy
supported terminal emulation software, 52, 80, 111 supporting documentation other dell documents you might need, 21 system setup entering, 26, 32 T telnet, 52, 78, 80 terminal emulation software supported, 52, 80 terminal mode commands, 117 U using IPMI Shell, 59 using SOL Proxy, 81 V VT100, 52, 80, 111 Index 141
Index
