Description

Lenovo XClarity Essentials OneCLI (OneCLI) is a command-line utility that is ideal for a non-GUI environment. It not only provides users with a command-line interface to the same functions available with UpdateXpress, but it also enables the scripting of updates. This utility is used to apply firmware or driver updates within the operating system for a target server.

This article introduces the procedures used to run OneCLI to acquire and install firmware drivers on your system.

Applicable Systems

System Is Configured With

Lenovo XClarity Essentials OneCLI (OneCLI)

Operating Systems

Windows, Linux

Prerequisites

To use OneCLI if the target server is connected to the Internet:

• A OneCLI-supported operation system version must be installed on your local system
• OneCLI must be installed on your local system
• Users must have access to run OneCLI with administrator or root privileges
• The local system must have Internet access to acquire the update packages online

To use OneCLI if the target server is NOT connected to the Internet (Build your own repository):

• A OneCLI-supported operation system version must be installed on an Internet-connected workstation/laptop
• OneCLI must be installed on the workstation/laptop
• Users must have access to run OneCLI with administrator or root privileges

Solution

To use OneCLI if the target server is connected to the Internet:

1. Go to https://support.lenovo.com/solutions/lnvo-tcli, find the appropriate OS section, and download the requested ZIP or TGZ file.

2. Unzip the file and copy the contents to a specified folder.

For Windows:

Unzip and copy the contents to a specified folder.

For Linux:

(1) Open Terminal and ensure the user has root privileges.

(2) Use the tar command to unzip the file

tar xvf Zipfile.tgz -C /path/foldername,

where Zipfile.tgz is the downloaded file, and -C is the path and folder where the files will be extracted.

3. Follow the procedures set out below to launch OneCLI.

For Windows:

(1) Open a command prompt window with administrator privileges.

(2) Go to the directory where you saved the utility – e.g. C:\onecli.

For Linux:

Go to the directory where you saved the utility – e.g. /root/Desktop/onecli.

4. Acquire the update files for a specific server using the following command:

onecli update acquire --mt XXXX --ostype YYYYY --scope option --dir C:\Test

where:

• XXXX is the four-digit machine type of the target server – e.g. 7x04, 7x18.
• YYYYY is the OS installed on the server if you intend to download drivers for the server as well. Possible inputs are win2012, win2012r2, win2016, win2019, rhel6, rhel7, sles11, sles12, and none (OS independent).
• option is whether you want to download the latest package or use UpdateXpress packages. The input options are latest or uxsp. It is recommended that you use latest.
• C:\Test is the directory you want to download the files into.

Example:

onecli update acquire --mt 7x04 --ostype none –-scope latest --dir C:\7x04

5. (Optional) Use the following commands to compare the list of installed firmware and device drivers with the firmware and drivers in the downloaded package:

onecli update compare --scope option --type PP --dir C:\Test --output c:\compare\XML

where:

• PP is the type of comparison you want to make. The input options are:
• fw, dd (default) to compare firmware and device drivers
• fw to compare firmware
• dd to compare device drives
• --output is to download the logs or comparison XML in the directory. If you encounter failure, this will help you to identify the causes. It will also help you compare updates quickly.

Example:

onecli update compare --scope latest --type fw --dir C:\updates\7x04 --output c:\7x04\compare

6. Apply all the firmware and driver updates using one of the following commands:

• To perform a comparison and then update the firmware and drivers

onecli update flash --scope option --dir C:\Test

• To update firmware/driver from the onecli-update-compare.xml file

onecli update flash --comparexml C:\compareXML\onecli-update-compare.xml --dir C:\Test

7. To update a single piece of firmware or driver level, use one of the following commands:

• To update a single piece of firmware without performing a comparison

onecli update flash lnvgy_fw_imm2_tcoo26k-3.73_anyos_noarch --nocompare --includeid lnvgy_fw_imm2_tcoo26k-3.73_anyos_noarch --dir C:\Test --output c:\logs

# --includeid is required when --nocompare is specified.

• Specify the update scope --scope to individual with the --includeid parameter to update an individual device

onecli update flash --scope individual --includeid lnvgy_fw_imm2_tcoo26k-3.73_anyos_noarch --dir C:\Test --output c:\logs

• Specify --forceid to update a device driver/firmware if the installed version cannot be detected

onecli update flash --forceid lnvgy_fw_imm2_tcoo26k-3.73_anyos_noarch --dir C:\Test --output c:\logs

• Merge more than one file at a time by separating them with a comma

onecli update flash --forceid lnvgy_dd_immpbi_1.0.1.2015-2_windows_32-64, intc-lnvgy_dd_inteldp_10.1.2.19-1_windows_32-64 --dir C:\Test -–output C:\logs

To use OneCLI if the target server is NOT connected to the Internet (Build your own repository):

1. Go to https://support.lenovo.com/solutions/lnvo-tcli, find the appropriate OS section, and download the requested ZIP or TGZ file.

2. Unzip the file and copy the contents to a specified folder.

For Windows:

Unzip and copy the contents to a specified folder.

For Linux:

(1) Open Terminal and ensure the user has root privileges/

(2) Use the tar command to unzip the file

tar xvf Zipfile.tgz -C /path/foldername,

where Zipfile.tgz is the downloaded file, and -C is the path and folder where the files will be extracted.

3. Follow the procedures set out below to launch OneCLI.

For Windows:

(1) Open a command prompt window with administrator privileges.

(2) Go to the directory where you saved the utility – e.g. C:\onecli.

For Linux:

Go to the directory where you saved the utility – e.g. /root/Desktop/onecli.

4. Acquire the update files for a specific server using the following command:

onecli update acquire --mt XXXX --ostype YYYYY --scope option --dir C:\UXSP

where:

• XXXX is the four-digit machine type of the target server – e.g. 7x04, 7x18.
• YYYYY is the OS installed on the server if you intend to download drivers for the server as well. Possible inputs are win2012, win2012r2, win2016, win2019, rhel6, rhel7, sles11, sles12, and none (OS independent).
• option is whether you want to download the latest package or use UpdateXpress packages. The input options are latest or uxsp. It is recommended that you use latest.
• C:\UXSP is the directory you want to download the files into.

5. Transfer the file into a USB drive or over the network and insert the flash drive into a USB port of the target server.

6. Transfer the expanded OneCLI directory, which includes the update package files to a new directory on the target server. Apply all the firmware and driver updates using the following command:

onecli update flash --dir C:\UXSP

7. Reboot the server to put the changes into effect.

Table. 1 OneCLI global parameters

Video

Additional Information

• Lenovo XClarity Essentials OneCLI User Guide
• How to back up and restore the XClarity Controller configuration using the Lenovo XClarity Essentials Windows OneCLI

Related Articles

• How to update firmware on Lenovo XClarity Provisioning Manager
• How to update firmware and drivers using the Lenovo XClarity management tools
• How to update the firmware repository of LXCA
• How to use the Lenovo XClarity Essentials Bootable Media Creator (BOMC) to update firmware
• How to use Lenovo XClarity Essentials OneCLI to remotely update your system