Updating the XClarity Administrator management server

You can update the Lenovo XClarity Administrator management server to install the latest software and license enablement.

Before you begin

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

For all Electronic Customer Care (ECC) connections that are configured for a proxy, the proxy must be a forwarding proxy and must not terminate the connection. The call home and updates functions of XClarity Administrator use the ECC connections.

  • When you update XClarity Administrator, some predefined device drivers and boot files might also be updated. Any customized OS-image profiles that use those files are automatically updated to include the new files. For more information about customized OS-image profiles, see Customizing OS-image profiles.

  • For XClarity Administrator v2.4.0 and later:

    • Stored credentials are used to authenticate to ThinkServer and System x M4 servers. When updating to XClarity Administrator v2.4.0, XClarity Administrator creates a stored credential named "AutoCreated_User" for each managed ThinkServer or System x M4 server, associates the stored credential with the specific server, and registers the stored credential as a new IPMI account on server's baseboard management controller. If an IPMI account that starts with "AutoCreated_User" already exists on the management controller, the existing account is deleted before the new one is created.

    • Updates without payloads that are earlier than the currently installed version are not listed in the table on the Management Server Update page. Updates with payloads that are earlier than the currently installed version are listed in the table with an applied status of "Not applicable" and cannot be applied to the management server.

    • All repository packs with payloads are listed in the table on the Management Server Update page; however, for repository packs without payloads, only the latest packs are listed.

  • For XClarity Administrator v2.3.0 and later, service requests are no longer routed directly to IBM. When Call Home is enabled, service requests are first routed to the Lenovo Support, and then forwarded to IBM, if appropriate for certain devices.

    New DNS names and IP addresses are required to use Call Home to route service requests to Lenovo Support in XClarity Administrator v2.3.0 and later. The old DNS names and IP addresses are no longer required to use Call Home; however, they are needed to retrieve status for open service tickets that were submitted prior to updating to v2.3.0.

    Attention: During the update process, the existing Call Home forwarder is set to disabled and then updated to send service tickets to Lenovo Support. To continue using Call Home, you must ensure that the firewalls are configured to allow traffic through the new required URLs, and then re-enable the Call Home forwarder (see Firewalls and proxy servers and Setting up automatic problem notification to Lenovo Support (Call Home)).
  • For XClarity Administrator v2.2.0 and later, only stored credentials can be used to authenticate to RackSwtich devices. Manual user accounts are not supported. For devices that are managed using a manual user account, the update process changes the authentication for those servers to use the Universal_User stored credential.

  • XClarity Administrator v2.1.0 and later can be installed only on a XClarity Administrator v2.x virtual machine. It cannot be installed on XClarity Administrator v1.x.

    Attention: Updates within XClarity Administrator from v2.x.x take longer than previous updates in the 1.x.x release. The specific time required is highly dependent on the hardware that is used to host the VM, specifically disk subsystem performance. Typically, it takes 45 – 120 minutes to complete the update.
  • You cannot upgrade to XClarity Administrator v2.0.0 from an earlier release. You must install a new XClarity Administrator v2.0.0 virtual appliance, and then either migrate data, settings, and device management from the existing XClarity Administrator v1.x virtual appliance to the v2.0.0 virtual appliance using the migration tool in XClarity Administrator v1.4.1, or manually import data and settings and remanaged your devices in the v2.0.0 virtual appliance. For more information, see Migrating to Lenovo XClarity Administrator v2.0.0.

  • XClarity Administrator v1.3.0 changed its default minimum Transport Layer Security (TLS) level from TLS 1.0 to TLS 1.2.

    Because the TLS setting in XClarity Administrator and managed devices must match, XClarity Administrator generates a warning if there is a mismatch. Updating to XClarity Administrator to v1.3.0 or later does not change the TLS setting in XClarity Administrator, and new Lenovo servers ship with TLS 1.2 enabled. Therefore, when using newly purchased devices, you must either change the TLS setting to TLS 1.0 in XClarity Administrator v1.3.0 and later or change the TLS setting to TLS 1.2 on the existing managed devices.

    For more information about TLS settings in XClarity Administrator, see Configuring cryptography settings.

  • For XClarity Administrator v1.1.1 and earlier, you must manually download and import the management-server updates from XClarity Administrator download webpage.

About this task

XClarity Administrator supports the following types of updates:
  • Patch. XClarity Administrator code changes, including new releases and fix packs.
  • License Enablement. License for full-function entitlement (see Installing the full-function enablement license).
  • Supplemental Packs. Firmware-update repository packs, which contain firmware update packages for all manageable devices. When imported and applied, the firmware updates are added in the firmware-updates repository (see Downloading firmware updates).

Before you can update the XClarity Administrator management server, you must first check for available updates and then download the update package. When you download management-server updates, XClarity Administrator downloads the selected update package from the web, and stores the update packages in the management-server updates repository.

To check for and download management-server updates, XClarity Administrator must be connected to the Internet. If it is not connected to the Internet, you can manually download the management-server updates from the XClarity Administrator download webpage using a web browser to a workstation that has network access to the XClarity Administrator host and then import the updates into the management-server updates repository.

You can determine which management-server updates are stored in the updates repository from the Download Status column on Update Management Server page. This column can contain the following values:
  • Downloaded iconDownloaded. The firmware-update repository pack or management-server update is stored in the repository.
  • Not downloaded iconNot downloaded. The firmware-update repository pack or management-server update is available but not stored in the repository.
  • Not downloaded icon Cleaned up. The update was successfully applied and unneeded staging files were automatically removed.

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 update XClarity Administrator, complete the following steps.

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

    You can sort the table columns to make it easier to find specific updates. In addition, you can select a update type from the Filter By Type drop-down list to list only those updates that meet the selected criteria.

    Illustrates the Update Management Server page with a list of imported updates.
  2. Download the latest XClarity Administrator update:
    • If XClarity Administrator is connected to the Internet:

      1. Retrieve information about the latest updates by clicking the All Actions > Refresh Product Catalog. New management-server updates and firmware-update repository packs are listed in the table on the Management Server Update page.

        Refreshing this information might take several minutes to complete.

        Note: Refreshing the product catalog does not automatically download update packages.
      2. Select the management-server update that you want to download.
        Tip: Ensure that the package that you select has Patch in the Type column.
      3. Click the Download icon (Download updates icon).

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

    • If XClarity Administrator is not connected to the Internet:

      1. Download the management-server update from the XClarity Administrator download webpage to a workstation that has 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 management-server update on the workstation.
      4. Select all package files, and then click Open.

        You must import the .metadata file (.xml) 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 .XML file are discarded. If you do not include the XML file, the update is not imported.

      5. Click the Import.

        When the import is complete, the management-server update is listed in the table on the Management Server Update page, and the Download Status for that software update is "Downloaded."

      You can monitor the import progress by clicking Monitoring > Jobs from the XClarity Administrator menu bar.

  3. Back up the XClarity Administrator virtual appliance by creating a clone (see Backing up Lenovo XClarity Administrator).
  4. Ensure that no jobs are currently running. You can view a list of currently running jobs from the Jobs log (see Monitoring jobs).
  5. Select the update package that you want to install.
    Note: Ensure that Download Status is "Downloaded." and the Type is "Patch."
  6. Click the Perform Update icon (Perform update icon).

    You can monitor the update progress by clicking Monitoring > Jobs from the XClarity Administrator menu bar.

  7. Wait a few minutes for the update to complete and XClarity Administrator to be restarted.
    If you have access to the virtual appliance host, you can monitor the progress from the virtual-appliance console, for example:
    Lenovo XClarity Administrator - Version 1.1.0
    eth0      Link encap:Ethernet  HWaddr 00:00:00:00:00:10
              inet addr:  Bcase:  Mask:
              inet6 addr: fe80:200:ff:fe00:10/64 Scopt:Link
    eth1      Disabled
    idxhwmgr login: Lenovo XClarity Administrator Repository Update
    Detected appliance version is 1.1.0
    Applying XClarity Administrator Repository Update...
    Attention: Do not restart the virtual appliance manually during the update process.
  8. Determine if the update is complete by refreshing the web browser.
    • If the management server update that you applied is a patch or enablement license, the update files (including payload and metadata files) are removed from the repository, and the update is no longer listed in the table.

    • If the update is a supplemental pack, and the Applied Status column changes to "Applied." The payload for the update is also removed from the repository, and the Download Status changes to "Cleaned Up."

  9. Clear the web browser cache.

What to do next

From this page, you can perform the following actions: