Skip to main content

Downloading firmware updates

You can download or import firmware updates in the firmware-updates repository, depending on your access to the Internet. Firmware updates must be available in the firmware-updates repository before you can update firmware on management devices.

Before you begin

Ensure that all ports and Internet address that Lenovo XClarity Administrator requires are available before you attempt to download firmware. For more information about ports, see Port availability and Firewalls and proxy servers.

If a device type is not listed in the firmware-updates repository, you must first manage a device of that type before downloading or importing individual firmware updates for that device type.

Important
  • For XClarity Administrator v1.1.1 and earlier, you must manually download and import the firmware updates for Lenovo hardware from Lenovo Data Center Support website.

  • XClarity Administrator cannot download updates for RackSwitch switches and Lenovo DE, DX, and SS series storage devices from the Lenovo website to the firmware-updates repository; instead, you must manually download and import these updates from the Lenovo website to a workstation that has network access to the XClarity Administrator host, or download and apply the firmware-update repository packs, which contain all available firmware updates.

  • Internet Explorer and Microsoft Edge web browsers have an upload limit of 4 GB. If the file that you are importing is greater than 4 GB, consider using another web browser (such as Chrome or Firefox).

  • To download firmware for ThinkSystem DM series storage devices:
    • One or more ThinkSystem DM series storage devices must be managed by XClarity Administrator.

    • Each ThinkSystem DM series storage device must be entitled for hardware service and support.

    • You must specify the country where the ThinkSystem DM series storage devices are located on the Firmware Updates: Repository page. Only encrypted firmware can be downloaded for devices in the following countries: Armenia, Belarus, China, Cuba, Iran, Kazakhstan, Kyrgyzsta, North Korea, Russia, Sudan, Syrian.

About this task

You can download firmware updates in a several different ways.
  • Firmware-update repository packs

    Firmware-update repository packs are collections of the latest firmware that is available at the same time as the XClarity Administrator release for most supported devices and a refreshed default firmware-compliance policy. These repository packs are imported and then applied from the Update Management Server page. When you apply a firmware-update repository pack, each update package in the pack is added to the firmware-updates repository, and a default firmware-compliance policy is automatically created for all manageable devices. You can copy this predefined policy, but you cannot change it.

    The following repository packs are available.
    • lnvgy_sw_lxca_cmmswitchrepox-x.x.x_anyos_noarch. Contains firmware updates for all CMMs and Flex System switches.
    • lnvgy_sw_lxca_storagerackswitchrepox-x.x.x_anyos_noarch. Contains firmware updates for all RackSwitch switches and Lenovo Storage devices.
    • lnvgy_sw_lxca_systemxrepox-x.x.x_anyos_noarch. Contains firmware updates for all Converged HX Series, Flex System, NeXtScale, and System x servers.
    • lnvgy_sw_thinksystemrepox-x.x.x_anyos_noarch. Contains firmware updates for all ThinkAgile and ThinkSystem servers.
    • lnvgy_sw_lxca_thinksystemv2repox-x.x.x_anyos_noarch. Contains firmware updates for all ThinkAgile and ThinkSystem V2 servers.
    • lnvgy_sw_lxca_thinksystemv3repox-x.x.x_anyos_noarch. Contains firmware updates for all ThinkAgile and ThinkSystem V3 servers.
  • UpdateXpress System Packs (UXSPs)
    UXSPs contains the latest available firmware and device driver updates, organized by operating system. When you download UXSPs, XClarity Administrator downloads the UXSP, based on the version that is listed in the catalog, and stores the update packages in the firmware-updates repository. When you download a UXSP, each firmware update in the UXSP is added to the firmware-updates repository and listed on the Individual Updates tab, and a default firmware-compliance policy is automatically created for all manageable devices using the following names. You can copy this predefined policy, but you cannot change it.
    • {uxsp-version}-{date}-{server-short-name}-UXSP (for example, v1.50-2017-11-22- SD530-UXSP)
    Firmware Updates: Repository
    When you download or import UXSPs from the page, only firmware updates are downloaded and stored in the repository. Device driver updates are discarded. For information about downloading or importing Windows device driver updates using UXSPs, see Managing the OS device-drivers repository.

    When you manually import UXSPs into XClarity Administrator, you must include the following required files: payload (*.zip), metadata (.xml), change history (.chg or .html), and readme (.txt).

  • System Firmware Bundles

    For ThinkSystem V3 servers (with XCC2), firmware updates packs are referred to as system firmware bundles.

    When you download a system firmware bundle form XClarity Administrator, each firmware update in the bundle is added to the firmware-updates repository and listed on the Individual Updates tab, and a default firmware-compliance policy is automatically created for all manageable devices using the following names. You can copy this predefined policy, but you cannot change it.

    • {bundle-version}-{server-short-name}-bundle (for example, 22a.0-kaj92va-SR650V3-bundle)

    When you manually import system firmware bundles into XClarity Administrator, only the bundle payload (.zip) is required. This file contains the payload, metadata, change history, and readme for each update.

  • Individual firmware updates

    You can download individual firmware-update packages, at one time. When you download firmware-update packages, XClarity Administrator downloads the update, based on the version that is listed in the catalog, and stores the update packages in the firmware-updates repository. You can then create firmware-compliance policies using those update packages for each of your managed devices.

    Note
    The core firmware updates (such as management controller, UEFI, and pDSA) are operating-system independent. Firmware-update packages for the RHEL 6 or SLES 11 operating systems are used to update compute nodes and rack servers. For more information about which firmware-update packages to use for your managed servers, see Downloading firmware updates.

    When you manually import firmware updates into XClarity Administrator, you must include the following required files: payload (image), metadata (.xml or .json), change history (.chg), and readme (.txt). Note that for ThinkSystem V3 servers, the metadata file is included in the payload file and is not imported separately.

You can determine whether specific firmware updates are stored in the firmware-updates repository from the Download Status column on the Individual Updates tab on the Firmware Updates: Repository page. This column contains the following values.
  • Downloaded icon Downloaded. The entire update package or the individual firmware update is stored in the repository.
  • Partially downloaded icon x of y Downloaded. Some but not all firmware updates in the update package are stored in the repository. The numbers in parentheses indicate the number of available updates and the number of stored updates, or there are no updates for the specific device type.
  • Not downloaded icon Not Downloaded. The entire update package or the individual firmware update is available but not stored in the repository.
Best practice
When you install XClarity Administrator or update to a new release, it is a best practice to download the latest repository pack to ensure you have the latest firmware updates. Then, you can schedule a recurring job to refresh the catalog to find individual updates that were posted on the web since the last repository pack and then electronically download those updates, one at a time.
XClarity Administrator must be connected to the Internet to refresh the catalog and download firmware updates. If it is not connected to the Internet, you can manually download the files to a workstation that has network access to the XClarity Administrator host using a web browser and then import the files into the firmware-updates repository.
Illustrates the steps involved in managing the repository, including refreshing the product catalog and acquiring or importing firmware updates.
Note
For certain ThinkSystem DM storage devices, when you download firmware updates, the Written Offer PDF file for the ONTAP operating system is also downloaded. You can optionally select the ONTAP Written Offer PDF (if applicable) when you manually import firmware updates for these devices as well. To view the file in the web interface, click the icon in the Release Notes column to display the Release Notes dialog, and then click the ONTAP Written Offer tab.
Attention
  • Only import these required files. Do not import other files that might be found on the firmware download websites.
  • If you do not include the metadata (.xml or .json) file in the update package, the update is not imported.
  • If you do not include all required files that are associated with the update, the repository shows that the update is not downloaded, which means that it is partially imported. You can then import the missing files by selecting and importing them.
  • The core firmware updates (such as management controller, UEFI, and pDSA) are operating-system independent. Firmware-update packages for the RHEL 6 or SLES 11 operating systems are used to update compute nodes and rack servers.

A message is displayed on the page when the repository is more than 50% full. Another message is displayed on the page when the repository is more than 85% full. To reduce the space used in the repository, you can remove unused images files and policies. You can remove unused firmware-compliance policies and associated firmware packages by clicking Provisioning > Compliance policies, selecting one or more policies to delete, and then clicking Actions > Delete any policy and firmware packages.

The following table summarizes the where to manually download firmware-updates.
Update packageUI page for downloading and importing filesWebpage to download files manuallyIs the firmware updates repository refreshed?Is the firmware- compliance policy refreshed automatically?
Firmware-update repository packsUpdate Management Server page
Note
You must import and then apply the repository pack.
XClarity Administrator download webpageYesYes
UpdateXpress System PacksFirmware Updates: Repository page, UpdateXpress System Packs (UXSPs) tabLenovo Data Center Support website
Note
Search for the product name, and then look for “UpdateXpress System Packs.“
YesYes
System Firmware BundlesFirmware Updates: Repository page, UpdateXpress System Packs (UXSPs) tabLenovo Data Center Support website
Note
Search for the product name, and then look for “Update Bundles.“
YesYes
Firmware-updatesFirmware Updates: Repository page, Individual Updates tabLenovo Data Center Support website
Note
You can download firmware from the following devices from ibm.com.
  • Flex System x220 Type 2585, 7906
  • Flex System x222 Compute Nod Type 2589, 7916
  • Flex System x240 Type 7863, 8737, 8738, 8956
  • Flex System x280 / x480 / x880 X6 Type 4259, 7903
  • Flex System x440 Type 2584, 7917
YesNo

Procedure

To download one or more firmware updates, complete the following steps.

  • To import one or more firmware-update repository packs:

    1. From the XClarity Administrator menu bar, click Administration > Update Management Server to display the Management Server Update page.

    2. Download the latest repository packs:

      • If XClarity Administrator is connected to the Internet:
        1. Retrieve information about the latest updates by clicking the Refresh Catalog > Refresh All Managed – Latest only ). New management-server updates and firmware-update repository packs are listed in the table on the Management Server Update page.

          Refreshing the repository might take several minutes to complete.

          Note
          Refreshing the repository does not automatically download payload files. Only the metadata and readme files are downloaded.
        2. Select the firmware-update repository packs that you want to download.
          Tip
          Ensure that the packages that you select have Supplemental Pack in the Type column.
        3. Click the Download Selected icon (Download updates icon).

          When the download is complete, the Download Status for that software update changes to Downloaded.

      • If XClarity Administrator is not connected to the Internet:
        1. Download the firmware-update repository packs from the XClarity Administrator download webpage to a workstation that has a network connection to the XClarity Administrator host.
        2. From the Management Server Update page, click the Import icon (Import icon).
        3. Click Select Files, and browse to the location of the firmware-update repository packs on the workstation.
        4. Select all package files, and then, click Open.

          You must import the metadata file (.xml or.json) as well as the image or payload file (.zip, .bin, .uxz, or .tgz), change history file (.chg), and readme file (.txt) for the update. Any files that are selected but are not specified in the metadata file are discarded. If you do not include the metadata file, the update is not imported.

        5. Click Import.

          When the import is complete, the firmware-update repository packs are listed in the table on the Management Server Update page, and the Download Status for each update is Downloaded.

    3. Select the firmware-update repository packs that you want to install to the firmware-updates repository.

      Note
      Ensure that Download Status is Downloaded and that the Type is Patch.
    4. Click the Perform Update icon (Perform update icon) add the firmware-update packages to the repository.

    5. Wait a few minutes for the update to complete and XClarity Administrator to be restarted.

    6. Determine if the update is complete by refreshing the web browser.

      When completed, the Management Server Update page is displayed, and the Applied Status column changes to Applied.

    7. Clear the web browser cache.

  • To download one or more UXSPs.

    1. From the XClarity Administrator menu bar, click Provisioning > Firmware Updates: Repository to display the Firmware Updates Repository page.

    2. Click the UpdateXpress System Packs (UXSPs) tab.

    3. Download the latest UXSPs:

      • If XClarity Administrator is connected to the Internet:

        To refresh the catalog and download the latest UXSPs for all managed devices, click All Actions > Refresh and download the latest for all managed devices.

        To refresh the catalog and download the latest UXSPs for only selected devices:

        1. Expand the device to display the list of available UXSPs.

        2. Select one or more UXSPs that you want to download.

        3. Click All Actions > Refresh and download the latest for selected devices.

          When the download is complete, the Download Status for the selected UXSPs changes to Downloaded.

      • If XClarity Administrator is not connected to the Internet:

        1. Download the UXSPs from the Lenovo XClarity Essentials UpdateXpress webpage to a workstation that has a network connection to the XClarity Administrator host

        2. From XClarity Administrator, click the Import icon (Import icon).

        3. Click Select Files, and browse to the location of the UXSPs on the workstation.

        4. Select all package files, and then, click Open.

          You must import the metadata file (.xml or.json) as well as the image or payload file (.zip, .bin, .uxz, or .tgz), change history file (.chg), and readme file (.txt) for the update. Any files that are selected but are not specified in the metadata file are discarded. If you do not include the metadata file, the update is not imported.

        5. Click Import.

          When the import is complete, the firmware-update repository packs are listed in the table on the Management Server Update page, and the Download Status for each update is "Downloaded.

  • To download one or more individual firmware-update packages.

    1. From the XClarity Administrator menu bar, click Provisioning > Firmware Updates: Repository to display the Firmware Updates Repository page.

    2. If downloading firmware for ThinkSystem DM series storage devices, select the country where the storage devices are located.

    3. Click the Individual Updates tab.

    4. Download the latest individual firmware-updates:

      • If XClarity Administrator is connected to the Internet:

        To refresh the catalog and download the latest firmware for all managed devices, click All Actions > Refresh and download the latest for all managed devices.

        To refresh the catalog and download the latest firmware for only selected devices:

        1. Expand the device to display the list of available firmware updates.

        2. Select one or more firmware updates that you want to download.

          Tip
          An update package can consist of multiple firmware updates. When you download a firmware update, you can choose to download the entire update package or only specific updates. You can also choose to download multiple packages at one time.
        3. Click All Actions > Refresh and download the latest for selected devices.

          When the download is complete, the Download Status for the selected firmware updates changes to Downloaded.

      • If XClarity Administrator is not connected to the Internet:

        1. Download the firmware-update packages from the Lenovo Data Center Support website to a workstation that has network connection to the XClarity Administrator host.

          For the following servers, download firmware updates for the SLES 11 operating system from the Fix Central website:
          • Flex System x220 Type 2585, 7906
          • Flex System x222 Compute Nod Type 2589, 7916
          • Flex System x240 Type 7863, 8737, 8738, 8956
          • Flex System x280 / x480 / x880 X6 Type 4259, 7903
          • Flex System x440 Type 2584, 7917

          For all other servers, download firmware updates for the RHEL 6 operating system. from the Lenovo XClarity Support website.

        2. From XClarity Administrator, click the Import icon (Import icon).

        3. Click Select Files, and browse to the location of the firmware updates on the workstation.

        4. Select all package files, and then click Open.

          You must import the metadata file (.xml or.json ) as well as the image or payload file (.zip, .bin, .uxz, or .tgz), change history file (.chg), and readme file (.txt) for the update. For applicable ThinkSystem DM storage devices, optionally select the Written Offer PDF file for the ONTAP operating system. Any files that are selected but are not specified in the metadata file are discarded.

          Attention
          • Only import these required files. Do not import other files that might be found on the firmware download websites.
          • If you do not include the metadata (.xml or .json) file in the update package, the update is not imported.
          • If you do not include all required files that are associated with the update, the repository shows that the update is not downloaded, which means that it is partially imported. You can then import the missing files by selecting and importing them.
          • The core firmware updates (such as management controller, UEFI, and pDSA) are operating-system independent. Firmware-update packages for the RHEL 6 or SLES 11 operating systems are used to update compute nodes and rack servers.
        5. Click Import.

Refreshing the catalog and downloading the firmware updates might take a several minutes. When the updates have been downloaded and stored in the repository, the row in the product catalog is highlighted, and the Download Status column is changed to Downloaded.
Note
The machine type for some switches might show up as a hexadecimal number.

Illustrates the acquisition status of devices on the Firmware Updates: Repository page.

After you finish

You can configure the maximum size of the updates repository (including firmware, OS device drivers, and management server updates) from the Firmware Repository page by clicking All Actions > Global Settings. The minimum size is 50 GB. The maximum size is dependent on the amount of disk space on the local system.