=============================================================================
Readme and Installation Tips
Lenovo XClarity Essentials UpdateXpress
Software
=============================================================================
For a list of the fixes, enhancements, and updates that were made for this 
release, see the Change History that is provided with this update package.
The Change History also lists all prerequisites and co-requisites for this 
update.

Lenovo typically releases firmware and drivers in bundles called UpdateXpress
System Packs (UXSPs). To ensure that all of the firmware and driver updates 
are compatible, you should update all firmware and drivers at the same time.
Instructions can be found in the UpdateXpress User Guide here:
https://sysmgt.lenovofiles.com/help/topic/ux_essentials/ux_book.pdf

=============================================================================
CONTENTS
=============================================================================
1.0 Installation and Setup Instructions
2.0 Configuration Hints and Tips 
3.0 Related Information
4.0 Open Source and Licensing
5.0 Trademarks and Disclaimers

=============================================================================
1.0 Installation and Setup Instructions
=============================================================================
Lenovo provides several tools that can used to install and set up firmware, 
depending on the firmware setup procedures used by your organization.  

Before updating the firmware, it is a good practice to back up the firmware 
configuration.

----------------------------------------------------------------------
1.1 Standalone usage instructions
----------------------------------------------------------------------
The procedure to install the Lenovo XClarity Essentials UpdateXpress for 
Windows is as follows:
  a) Copy the .zip to a directory on the hard drive.
  b) Unzip the .zip file to a specified folder, lxce_ux.exe and other 
     package files will be extracted.
  c) Run the lxce_ux.exe command in the command line.
       
The procedure to install the Lenovo XClarity Essentials UpdateXpress for 
linux is as follows:
  a) Copy the .tgz to a directory on the hard drive.
  b) Run "tar zxvf <Lenovo XClarity Essentials UpdateXpress 
     distribution>.tgz -C <folder>" where <Lenovo XClarity Essentials 
     UpdateXpress distribution>.tgz is the downloaded .tgz and <folder> 
     is folder stores all the Lenovo XClarity Essentials UpdateXpress 
     package files.
  c) Run the ./start_lxce_ux.sh command in the command line.

It is required that users have administrator's/root's privilege to run Lenovo 
XClarity Essentials UpdateXpress. Lenovo XClarity Essentials UpdateXpress 
will not check the privilege while running, but some functions may not work 
correct if it is not administrator/root.

----------------------------------------------------------------------
1.2 Lenovo tools
----------------------------------------------------------------------
See the following table to determine the best Lenovo tool to use for 
installing and setting up your product:
* In-band. The installation or update can be performed while the operating system 
  is running by running the tool inside of the host operating system.
* Out-of-band (OOB). The installation or update must be performed while the system 
  is powered on. However, the tool is not running in the host operating system.  
  Instead, the tool is communicating with the XClarity Controller interface on the server.

XClarity Essentials OneCLI
IN_BAND:  [Yes]
OOB: [Yes]
GRAPHICAL USER INTERFACE: [No]
COMMAND-LINE INTERFACE: [Yes]

XClarity Essentials UpdateXpress
IN_BAND:  [Yes]
OOB: [Yes]
GRAPHICAL USER INTERFACE: [Yes]
COMMAND-LINE INTERFACE: [No]

XClarity Essentials Bootable Media Creator (BoMC)
IN_BAND:  [Yes]
OOB: [No]
GRAPHICAL USER INTERFACE: [Yes]
COMMAND-LINE INTERFACE: [Yes]


XClarity Provisioning Manager

IN_BAND: [Yes]
OOB: [No]
GRAPHICAL USER INTERFACE: [Yes]
COMMAND-LINE INTERFACE: [No]

XClarity Controller
IN_BAND: [No]
OOB: [Yes]
GRAPHICAL USER INTERFACE: [Yes]
COMMAND-LINE INTERFACE: [Yes]


XClarity Administrator

IN_BAND:  [No]
OOB: [Yes]
GRAPHICAL USER INTERFACE: [Yes]
COMMAND-LINE INTERFACE: [Yes]

* XClarity Essentials 
  Lenovo XClarity Essentials (LXCE) is a collection of server management 
  utilities which enable customers to manage Lenovo ThinkSystem, System x, 
  and ThinkServer servers more efficiently, less complicated and cost-effective.
  LXCE offering consists of OneCLI, UpdateXpress and Bootable Media Creator.
  More details on LXCE are available at:
  https://datacentersupport.lenovo.com/us/en/solutions/LNVO-CENTER

  Lenovo XClarity Essentials OneCLI is a command line based 
  utility, which covers the server management scope including 
  firmware configuration, system inventory, firmware and driver update. 
  It will replace ToolsCenter 1.x tools in Lenovo -- ASU, DSA and UXSPI.
  You can download Lenovo XClarity Essentials OneCLI at the following site:
  https://datacentersupport.lenovo.com/us/en/solutions/LNVO-TCLI

  Lenovo XClarity Essentials UpdateXpress is a software application that 
  applies UpdateXpress System Packs and individual updates to your system. 
  UpdateXpress System Packs contain Windows and Linux firmware and device 
  driver updates. LXCE UpdateXpress allows you to acquire and deploy these 
  updates, as with the UpdateXpress System Packs.         
  Supported Applications:
  * Update local machine
    Update the machine currently running this application. The machine 
    type will be detected and the updates will be acquired and 
    automatically applied.
  * Update remote machine
    To update a remote machine using the BMC service, you need a SFTP 
    server to transfer the updates to the target remote machine.
  * Create a repository of updates
    Choose one or more machine types to acquire updates from the Lenovo 
    support web site. Updates will be downloaded to the directory you 
    specified, but no updates will be applied. You can apply those updates 
    later.
  You can download Lenovo XClarity Essentials UpdateXpress at the following site:
  https://datacentersupport.lenovo.com/us/en/solutions/LNVO-XPRESS
  Lenovo XClarity Essentials UpdateXpress - Local install (YouTube Demo)
  https://www.youtube.com/watch?v=A9GS5d_O-uM
  Lenovo XClarity Essentials UpdateXpress - Remote install (YouTube/Youku Demo) 
  https://www.youtube.com/watch?v=MlnlcFcCCME
  http://v.youku.com/v_show/id_XMjk4NTUwNzQ4NA==.html

  Lenovo XClarity Essentials Bootable Media Creator is used to create bootable media 
  that is suitable for applying firmware updates, running preboot diagnostics, 
  and deploying Microsoft Windows operating systems on supported ThinkSystem, 
  System x and BladeCenter systems.
  Supported Applications:   
  * Create bootable media for ThinkSystem/System x/BladeCenter servers
  * Create a Lenovo ServerGuide Setup and Installation CD for System x/BladeCenter servers
  * Create a dynamic system analysis (DSA) media for System x/BladeCenter servers
  You can download Lenovo XClarity Essentials Bootable Media Creator (BoMC) at 
  the following site:
  https://datacentersupport.lenovo.com/us/en/solutions/LNVO-BOMC

  Specific details about updating firmware using Lenovo XClarity Essentials 
  are available at:
  http://sysmgt.lenovofiles.com/help/topic/xclarity_essentials/overview.html?cp=5

* XClarity Provisioning Manager
  From Lenovo XClarity Provisioning Manager, you can update the XClarity 
  Controller firmware, the UEFI firmware, and the XClarity Provisioning 
  Manager software.

  Note: By default, the Lenovo XClarity Provisioning Manager Graphical User 
  Interface is displayed when you press F1. If you have changed that default 
  to be the text-based system setup, you can bring up the Graphical User 
  Interface from the text-based system setup interface.

* XClarity Controller
  If you need to install a specific update, you can use the XClarity 
  Controller interface for a specific server. Typically, you should update 
  firmware using an UpdateXpress System Pack (UXSP) to ensure that all 
  related firmware and devices drivers are updated together.

  Specific details about updating firmware through the XClarity Controller 
  interface is available at:
  http://sysmgt.lenovofiles.com/help/topic/com.lenovo.systems.management.xcc.doc/NN1ia_c_manageserverfirmware.html?cp=2_6

* XClarity Administrator 
  If you are managing multiple servers using the Lenovo XClarity 
  Administrator, you can update firmware for all managed servers through that 
  interface, which can be used to store and deploy UXSPs. In addition, you 
  can apply firmware update policies to ensure that all managed servers are 
  running the same level of firmware.

  Specific details about updating firmware using Lenovo XClarity 
  Administrator is available at:
  http://sysmgt.lenovofiles.com/help/topic/com.lenovo.lxca.doc/update_fw.html?cp=1_19_0
  https://lenovopress.com/tips1200-lenovo-xclarity-administrator    
    
----------------------------------------------------------------------
1.2 ESXi support
----------------------------------------------------------------------
Performing in-band updates with ESXi host operating systems is not supported.  
Instead, perform the updates using the out-of-band method for the selected Lenovo 
tool. Alternatively, you can use the Lenovo XClarity Essentials Bootable Media Creator (BoMC)
to create bootable media (such as an ISO) for the update. Additional information about using 
Lenovo XClarity Essentials Bootable Media Creator (BoMC) at the following site:
https://datacentersupport.lenovo.com/us/en/solutions/lnvo-bomc

----------------------------------------------------------------------
1.3 Vendor-supported updates
----------------------------------------------------------------------
For certain adapters, updates are supported using vendor utilities and 
packages. Obtain the updates and the procedures for performing the updates 
directly from the vendor.

=============================================================================
2.0 Configuration Hints and Tips
=============================================================================
* To perform an in-band update through Windows or Linux by OneCLI/UpdateXpress, 
  the RNDIS device driver must be installed and the Ethernet-over-USB 
  (sometimes called LAN-over-USB) interface must be enabled on the Operating System.
  To perform update via BOMC, Lan-over-USB must be enabled to allow the BOMC tool to correctly 
  compare the installed firmware with the firmware repository on disk.
  There must be no network device on the system configured with an IP address 
  of 169.254.x.y other than the RNDIS Device.
  Additional information about configuring Ethernet over USB is available at:
  http://sysmgt.lenovofiles.com/help/topic/com.lenovo.systems.management.xcc.doc/NN1ia_c_configuringUSB.html 
      
* As OneCLI need to get an temp account to communicate with BMC through ipmi KCS in Inband case, 
  Customer need to make the OS's ipmi KCS ready.

* When installing firmware for a server, you should always install the 
  complete set of firmware for that server at the same time (bundle).  The 
  best practice is to install the firmware using the UpdateXpress System 
  Pack (UXSP) bundle through XClarity Essentials.

* The BMC (XClarity Controller) must be reset after a firmware update to 
  apply the configuration changes. You can reset the BMC through the XClarity 
  Controller interface. However, if you update the firmware using the UXSP 
  bundle, the management processor will be updated automatically.

* If you update firmware through the XClarity Controller, make sure that you 
  have downloaded and installed the latest device drivers for the operating 
  system that is running on the server.

=============================================================================
3.0 Related Information
=============================================================================
Lenovo Data Center forums
https://forums.lenovo.com/t5/Datacenter-Systems/ct-p/sv_eg

Lenovo Data Center Support
http://datacentersupport.lenovo.com

Lenovo Product Security Advisories
https://datacentersupport.lenovo.com/us/en/product_security/home

Lenovo XClarity Essentials Web Site: 
https://datacentersupport.lenovo.com/us/en/solutions/LNVO-CENTER

Lenovo XClarity Essentials FAQ Web Site: 
https://datacentersupport.lenovo.com/tw/en/solutions/ht506369

Lenovo XClarity Essentials Customer Documentation: 
http://sysmgt.lenovofiles.com/help/topic/xclarity_essentials/overview.html

XClarity Controller Customer Documentation
http://sysmgt.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.systems.management.xcc.doc%2Fproduct_page.html

Lenovo ThinkSystem Rack Server Customer Documentation
http://thinksystem.lenovofiles.com/help/topic/rack_servers/overview_rack_servers.html

=============================================================================
4.0 Open Source and Licensing
=============================================================================
This product contains open source code in the compiled form. Contact 
Lenovo Support for information about obtaining the original source code.

Licensing files could be obtained on UpdateXpress GUI Welcome page, by clicking "License" link. 
=============================================================================
5.0 Trademarks and Disclaimers
=============================================================================
* The following are registered trademarks of Lenovo.
  o Lenovo
  o The Lenovo Logo
* Intel is a registered trademark of Intel Corporation.
* Microsoft and Windows are registered trademarks of Microsoft Corporation.

LENOVO PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER 
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Some jurisdictions do not allow disclaimer of express or implied warranties 
in certain transactions, therefore, this statement may not apply to you. This 
information could include technical inaccuracies or typographical errors.  
Changes are periodically made to the information herein; these changes will be 
incorporated in new editions of the publication. Lenovo may make improvements 
and/or changes in the product(s) and/or the program(s) described in this 
publication at any time without notice.

BY FURNISHING THIS DOCUMENT, LENOVO GRANTS NO LICENSES TO ANY PATENTS OR COPYRIGHTS.

(C) Copyright Lenovo 2013-2022. All rights reserved.
