Integrated Management Module (IMM) Firmware Update for Linux

Installation README File

Version: 1.55 BUILDID: YUOOH5A

(C) Copyright International Business Machines Corporation 2008 - 2018
All rights reserved.
US Government Users Restricted Rights - Use, duplication, or disclosure
restricted by GSA ADP Schedule Contract with IBM Corporation.


CONTENTS
________

1.0   Overview
2.0   Installation and Setup Instructions
 2.1   Updating the IMM firmware using the command line interface
 2.2   Updating the IMM firmware using the web interface
 2.3   Updating the IMM Firmware on a Blade using the Advanced Management
       Module
 2.4   Extracting the update package contents
 2.5 IBM Systems Director discovery after an IMM install
3.0   Configuration Information
4.0   Unattended Mode
5.0   Web Sites and Support Phone Number
6.0   Trademarks and Notices
7.0   Disclaimer

1.0   Overview

       1.1  This README file contains the latest information about
            installing the IMM firmware update.

       1.2  Limitations:

         -  This flash utility is only able to update systems which can
            be reached via an Ethernet connection.  If the Integrated
            Management Module cannot be reached due to lack of a physical
            connection or firewall protections, then the update will fail.

            Limitations for versions 1.07 and 1.08:
            If you are down-levelling the IMM firmware to a version older
            than 1.07 and the IMM firmware is currently at version 1.07
            or 1.08, you must remove AC power from the server before
            performing a server reboot.

       1.3  Enhancements:

         -  Refer to the change history file ibm_fw_imm_yuooh5a-1.55_anyos_noarch.chg
            for a history of enhancements and fixes.

       1.4  Recommendations and Prerequisites for the Update:

            IMPORTANT: Updating to IMM firmware version 1.30 (yuooc7e) requires the
            ========== current IMM firmware version to be 1.10 (yuoo57h), or later. If
            this prerequisite is not met before updating to version 1.30 (yuooc7e) the
            system will not power on correctly. If the system is not running a minimum
            of IMM version 1.10 (yuoo57h), update the IMM before attempting to update
            to 1.30 (yuooc7e).
            This prerequisite was a limitation of IMM version 1.30, and it has been fixed
            in IMM version 1.31(yuooc7f). This prerequisite does not apply to IMM
            version 1.31 or later.
			
            IMPORTANT: Make sure the current IMM firmware level is 1.07 or later
            ========== before you update the uEFI firmware or DSA Preboot firmware.
            The recommended firmware update sequence is IMM followed by UEFI
            followed by DSA Preboot.

            IMPORTANT: When updating through AMM, after the IMM update is complete,
            ========== wait at least fifteen minutes before you initiate any planned
            uEFI or DSA Preboot firmware updates.

            Note: If you are updating to IMM version 1.09 or higher with AMM version 50L
            ===== or higher, wait at least ten minutes before you initiate any planned
            UEFI or DSA Preboot firmware updates.

            IMPORTANT: Due to an Intel errata, if your server is running a 32-bit Linux
            ========== Operating System, C-states may need to be disabled while
            updating uEFI, IMM, or DSA Preboot through the Linux command line interface.
            See RETAIN TIP H195678 for more information. Updates performed
            through the AMM, Bootable Media Creator, or the IMM web or CLI
            interfaces do not have this requirement.

            IMPORTANT: If your server has advanced management module (AMM) level
            ========== 50G or earlier and you will be updating multiple blades in
            the chassis, restart the AMM once before beginning multiple updates.

            Note: Updated firmware version numbers might not be visible in SMBIOS
            ===== tables until after the server is rebooted.

            Note: When updating the IMM firmware from a version earlier than
            ===== version 1.05 (build YUOO32F) to version 1.05 or newer, the
            Remote Alert Recipient Email Addresses and the Daylight Saving
            Time setting will revert to the default setting.
            Users that utilize these settings will need to set them again
            after the update.

         -  Updating the Integrated Management Module firmware using the
            LAN-over-USB interface may require operating system drivers and/or
            other configuration before this update may be used. The required
            drivers may not be installed by the operating system by default.

            In order to load the device driver for LAN-over-USB device, there
            must be no network device on the system configured with an IP
            address of 169.254.95.x other than the CDC Ethernet Device (the
            LAN-over-USB device).

            The update package will attempt to perform the setup if needed.  If
            the automatic setup fails or it is desired to setup the LAN-over-USB
            via manual intervention, the following process can be used:

            Linux  Driver Requirements
            ==========================
            The IMM LAN-over-USB interface requires the usbnet and
            cdc_ether drivers to be loaded. If the drivers have not been
            installed, use modprobe to install them. When these drivers are
            loaded, the IMM's LAN-over-USB interface will show up as a network
            device in the operating system.

            If the drivers have not been installed (such as the case with
            RHEL4), use "modprobe" to install them. To do this, open terminal
            and type:
                modprobe usbnet

            To discover the name that the operating system has assigned to the
            IMM's LAN-over-USB interface, type
                dmesg | grep -i cdc_ether

            The interface should be configured with ifconfig to have an IP
            address in the range 169.254.95.xxx. For example:
                ifconfig IMM_device_name 169.254.95.102 netmask 255.255.255.0

            Updating UEFI
            =============
            If you are updating the UEFI firmware through the IMM user
            interfaces, you should make sure that the server is powered
            up and booted into the Operating System, otherwise the IMM
            is unable to access the UEFI flash device.

       1.5  Dependencies:

          - none


2.0   Installation and Setup Instructions

           2.0.1 If you are updating the IMM using VMware, the following
                 steps should be completed prior to the update to ensure
                 that the flash utility can connect to the IMM.

                 VMware 3.5
                 ==========
                 1. esxcfg-firewall --allowIncoming
                 2. esxcfg-firewall --allowOutgoing

                 VMware 4.0
                 ==========
                 1. esxcfg-firewall --allowIncoming
                 2. esxcfg-firewall --allowOutgoing

                 VMware 5.0
                 ==========
                 1. esxcli network firewall set -d true

	     2.0.2 In order for the Linux flash utility to work in RHEL 6.0 64 bit,
                 the compatibility libraries must be installed.

                 During install after picking your default installation type (basic server,
                 database server, etc), select "Customize Now" button at bottom of screen.
                 Then under "base system" select the "compatibility libraries" checkbox.

                 For a system that already has RHEL 6 installed, you will have to load the
                 rpm's via the command line from the shell prompt:
                    rpm -ivh <package name>

                 List of rpm's that need to be installed:
                 compat-db-4.6.21-15.el6.x86_64.rpm
                 compat-expat1-1.95.8-8.el6.x86_64.rpm
                 compat-glibc-2.5-46.2.x86_64.rpm
                 compat-libcap1-1.10-1.x86_64.rpm
                 compat-libf2c-34-3.4.6-19.1.x86_64.rpm
                 compat-libgfortran-41-4.1.2-39.el6.x86_64.rpm
                 compat-libstdc++-296-2.96.144.el6..x86_64.rpm
                 compat-libstdc++-33-3.2.3-69.el6.x86_64.rpm
                 compat-libtermcap-2.08-49.el6.x86_64.rpm
                 compat-openldap-2.4-19_2.3.43-15.el3.x86_64.rpm
                 openssl098e-0.9e-17.el6.x86_64.rpm

      The procedure to update the IMM is as follows:

      2.1  Using the command line interface

         - Run the IMM Update with the following command line:

             "./ibm_fw_imm_yuooh5a-1.55_linux_32-64.bin -s"

             Note: "-u" is a supported synonym for command line switch "-s".

            2.1.1 Optional command line parameters supported by the update

               --backup
                  Target the secondary/alternate flash bank if available.
                  If a alternate device is not supported, the IMM may ignore
                  this option.

               --no-reboot
                  If the firmware type being updated requires an activation
                  step to be performed by the utility, this option will prevent
                  that step.

               --user <User name>
                   This option provides a method of setting the IMM user name
                   to use during a LAN IPMI session.  Use of this option will
                   disable the IPMI KCS authentication failover.

               --password <Password>
                   This option provides a method of setting the IMM password
                   to use during a LAN IPMI session.

               --silent
                  This option turns off text output from the update process.
                  Use of this option also turns on the --unattended option.



      2.2 Perform the following steps to update the IMM firmware using
           the web interface:
           (If you are updating the IMM Firmware on a Blade Using the
            Advanced Management Module, see section 2.3)

            a). Open a Web browser. In the address or URL field, type
                the IP address or host name of the IMM to which you
                want to connect. The Login web page opens.

                Note: The IMM defaults to DHCP. If a DHCP host is
                unavailable, the IMM assigns a static IP address of
                192.168.70.125.

            b). Type your user name and password on the Login page. If
                you are using the IMM for the first time, you can obtain
                your user name and password from your system administrator.
                All login attempts are documented in the event log.
                A welcome page opens in your browser.

                Note: The IMM is set initially with a user name of USERID
                and password of PASSW0RD (with a zero, not an O). This user
                has read/write access. Change this default password during
                your initial configuration for enhanced security.

            c). Select a timeout value, in minutes, in the field provided.
                If your browser is inactive for that number of minutes, the
                IMM logs you off the Web interface.

            d). Click Continue to start the session. The browser opens the
                System Status page, which gives you a quick view of the system
                status.

            e). In the navigation frame, click Firmware Update under Tasks,
                then click Browse.

            f). Navigate to this package (ibm_fw_imm_yuooh5a-1.55_linux_32-64.bin)
                and click Open. The file (including the full path) appears in
                the box beside Browse.

            g). To begin the update process, click Update. A progress indicator
                opens as the file is transferred to temporary storage on the IMM
                A confirmation page opens when the file transfer is completed.

            h). Verify that the upd file shown on the Confirm Firmware Update
                page is what you intend to update. If not, click the Cancel
                button.

            i). To complete the update process, click Continue. A progress
                indicator opens as the firmware on the IMM is flashed. A
                confirmation page opens to verify that the update was
                successful.

            j). After receiving a confirmation that the update process is
                complete, click the option "Restart IMM" and click the Restart
                button.  Click OK to confirm that you want to restart the IMM.
                NOTE: Restarting the IMM will disconnect your current session.

            k). Click OK to close the current browser window.

            l). To log into the IMM again, open your browser and follow the
                regular login process.

                Note: To cancel this process at any point, click Cancel.

      2.3 Updating the IMM Firmware on a Blade Using the Advanced Management
          Module

            IMPORTANT: If your server has advanced management module (AMM) level
            ========== 50G or earlier and you will be updating multiple blades in
            the chassis, restart the AMM once before beginning multiple updates.

          - Log into the Advanced Management Module's web interface on
            BladeCenter.
          - After you log in, select MM Control -> Network Protocols and
            ensure that TFTP is enabled on the AMM. It is disabled by default.
          - Select Blade Tasks -> Firmware update and select the target blade.
          - Use the browse button to point to the update file:
              ibm_fw_imm_yuooh5a-1.55_linux_32-64.bin
          - Click the Update button to update the IMM firmware.
            After the update finishes, the IMM will automatically be rebooted to
            use the new firmware.

      2.4  Extracting the update contents

            ibm_fw_imm_yuooh5a-1.55_linux_32-64.bin package contents:

             - This readme file
             - The IMM firmware update file named imm_yuooh5a.upd
             - Management Information Base files (MIBs)
                 immalert.mib and imm.mib
               which are used to manage the IMM through SNMP
             - immRegistries.zip containing
                 immMessageRegistry.xml and immPlatformRegistry.xml
               which can be used to decode the Alert Message ID
               that is received in traps and indications
             - A 32-bit flash utility named iflash
             - A 64-bit flash utility named iflash64
             - Open Source Notices

            2.4.1 Extraction of the package contents
               - Run the IMM Update with the following command line:

               "./ibm_fw_imm_yuooh5a-1.55_linux_32-64.bin -x <path>"
               where <path> is the path to which the Linux update files will
               be extracted.

            2.4.2 Mandatory command line parameters supported by iflash

               --package <file name>
                   This option designates the update file to be processed
                   by iflash.  Typically, updates are upd files included
                   in the update packages.  The update file contained in
                   this package is imm_yuooh5a.upd.

            2.4.3 Optional command line parameters supported by iflash

               --user <User name>
                   This option provides a method of setting the IMM user name
                   to use during a LAN IPMI session.  Use of this option will
                   disable the IPMI KCS authentication failover.

               --password <Password>
                   This option provides a method of setting the IMM password
                   to use during a LAN IPMI session.

               --unattended
                   This option turns off the prompt for user confirmation of
                   the update.  The utility will not prompt the user and only
                   continue with the update if it determines the firmware on
                   the target is downlevel.

               --force
                   Attempt to update even if the target is not downlevel.  No
                   prompt for user confirmation will be shown.  This option
                   overrides the --unatttended option.

               --backup
                  Target the secondary/alternate flash bank if available.
                  If a alternate device is not supported, the IMM may ignore
                  this option.

               --no-reboot
                  If the firmware type being updated requires an activation
                  step to be performed by the utility, this option will prevent
                  that step.

               -s, --silent
                  These options turn off text output from the update process.
                  Use of these options also turns on the --unattended option.

               -h, -?, --help
                  These options print the command usage details.

      2.5 IBM Systems Director discovery after an IMM install

       - If you are upgrading the IMM firmware: During the upgrade IMM firmware
         process, the mapping between IBM Director and IMM will lost for period
         of time (Depend on the IMM Upgrade/Restart timing can be 5-10 min or longer),
         During this period of time you will not receive any IMM event from IBM Director,
         and IBM Director will make status as "offline" to this IMM. Once the IMM's
         firmware upgrade/restart is been done and back online, the mapping between IBM
         Director and IMM is also back online automatically. Which mean the IBM Director
         system will recover by itself, without user/customer to do any manual interaction.

         If this firmware update is part of an initial deployment we recommend
         upgrading to the latest IMM firmware level prior to discovering the
         IMM with IBM Systems Director.


3.0  Configuration Information

         - This update package does not provide the ability to set or modify
           IMM configuration settings.


4.0  Unattended Mode

      4.1  Performing the update in unattended mode

            - Run "./ibm_fw_imm_yuooh5a-1.55_linux_32-64.bin -s"

      4.2  Extracting the update files in unattended mode

            - Run the "./ibm_fw_imm_yuooh5a-1.55_linux_32-64.bin -x <path>"
              where <path> is the path to which the Linux update files will be
              extracted.

5.0  Web Sites and Support Phone Number

       5.1  IBM Support Web Site:
            http://www.ibm.com/systems/support

       5.2  IBM Marketing Web Site:
            http://www-03.ibm.com/systems/x/

       5.3  If you have any questions about this update, or problems
            applying the update go to the following Help Center World
            Telephone Numbers URL:
            http://www.ibm.com/planetwide/index.html


6.0  Trademarks and Notices

       6.1  IBM is a registered trademark of International Business Machines
            Corporation in the United States, other countries, or both.

       6.2  U.S. Government Users Restricted Rights - Use, duplication
            or disclosure restricted by GSA ADP Contract with IBM
            Corporation.  IBM web site pages may contain other
            proprietary notices and copyright information which should
            be observed.

            Linux is a registered trademark of Linus Torvalds in the
            United States and other countries.

            Red Hat is a registered trademark of Red Hat, Inc. in the
            United States and other countries.

            Novell, and SUSE are registered trademarks of Novell, Inc.
            in the United States and other countries.

            VMware is a registered trademark or trademark of VMware, Inc.
            in the United States and/or other jurisdictions.

            Intel is a trademark of Intel Corporation in the United
            States and other countries.

            Other company, product, or service names may be trademarks
            or service marks of others.

7.0  Disclaimer
           THIS DOCUMENT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
           KIND.  IBM DISCLAIMS ALL WARRANTIES, WHETHER EXPRESS OR
           IMPLIED, INCLUDING WITHOUT LIMITATION, THE IMPLIED WARRANTIES
           OF FITNESS FOR A PARTICULAR PURPOSE AND MERCHANTABILITY WITH
           RESPECT TO THE INFORMATION IN THIS DOCUMENT.  BY FURNISHING
           THIS DOCUMENT, IBM GRANTS NO LICENSES TO ANY PATENTS OR
           COPYRIGHTS.