Lenovo XClarity Essentials OneCLI - Applications for Server Configuration and Management

Explore Lenovo XClarity Essentials OneCLI: Versatile Command-Line Applications for Server Configuration & Management

Explore Lenovo XClarity Essentials OneCLI: Versatile Command-Line Applications for Server Configuration & Management

Overview

Lenovo XClarity Essentials OneCLI is a collection of several command-line applications, which can be used to configure the server, collect service data for the server, update firmware and device drivers, and perform power-management functions on the server. Lenovo XClarity Essentials OneCLI (OneCLI) is comprised of individual ToolsCenter application modules that are easily updated. Starting from 1.2.0, Lenovo XClarity Essentials OneCLI (OneCLI) also support inventory on some ThinkServer systems.

IMPORTANT

New setting names on ThinkSystem V4 platform

Due to ThinkSystem V4 platform adopting OpenBMC and aiming for full Redfish alignment, the format of UEFI and BMC settings have changed. User must use XClarity Essentials OneCLI 5.x to read and configure UEFI and BMC settings. This is applicable to all ThinkSystem V4 servers with Intel and AMD processors with XCC3.

The command parameter is same as previous version of OneCLI, but the setting names have changed to reflect new Redfish style and to get rid of legacy IMM.xyz style. For example:

  • On ThinkSystem V1 / V2 / V3:
  • onecli config set Processors.TurboMode Enabled
  • onecli config set IMM.SSLPort 443
  • On ThinkSystem V4:
  • onecli config set UEFI.Processors_TurboMode Enabled
  • onecli config set BMC.HTTPSPort 443

If the user need to run one batch configuration command against servers of multiple generations, there is a “-c” feature for backward compatibility so that user can retain the existing configuration file across servers. 

  • Only UEFI settings are handled by compatibility mode at this moment.
  • OneCLI 5.x will translate the old format settings to the new format when applying to a V4 server.
  • The settings that are not translated by compatibility mode will cause error 104 at runtime. Testing is advised.

Applicable Systems

Supported Lenovo Systems

  • ThinkEdge
  • ThinkSystem
  • ThinkServer
  • WenTian(问天)
  • Legacy ThinkServer (inventory function only)
  • System x

Supported Lenovo Storage (Secure erasure function only)

  • Storage

What's New

Version 5.0.0

  • New Features
    • Deploy OS on the ThinkSystem V3 servers
    • Update disk drive firmware in the in-band mode without restarting the ThinkSystem V3 servers and next generations
    • Update standalone FPGA and PSoC firmware starting from ThinkSystem V4 servers
    • Perform SMM related functions when IPMI is disabled
    • Erase the disk drive data securely in the unattended customized mode
    • Mount media file from network to RDOC
    • Add the CIFS/NFS protocols for the mount media file from network
    • Create the RAID array by using all remaining disk capacity
    • Make drive unconfigured good on the WenTian servers
    • Configure LDAP settings on the ThinkServer and WenTian servers
    • Update BMC primary and backup images at one time on the ThinkServer and WenTian servers
    • Add compatibility mode for UEFI settings on the ThinkSystem V4 servers
  • ​New System Support
    • Lenovo ThinkSystem SD520 V4     7DFY,7DFZ
    • Lenovo ThinkSystem SR630 V4     7DG8,7DG9,7DGA,7DGB
    • Lenovo ThinkSystem ST45 V3        7DH4,7DH5
    • Lenovo ThinkAgile MX650 V3 PR  7DKB
    • Lenovo WenTian WR5225 G3        7DG2
  • New Operating System Support
    • Microsoft Windows Server 2025
    • SUSE Linux Enterprise Server 15 SP6
    • Ubuntu 24.04 LTS

For more information about each version, click What's new and look for the desired version you're searching for.

Download OneCLI

Version 5.0.0 Binaries

Microsoft Windows

lnvgy_utl_lxce_onecli02y-5.0.0_windows_indiv

  • Supported Operating Systems
    • Microsoft Windows 10/11
    • Microsoft Windows Server 2016 (no support on Nano)/2019/2022/2025
    • Microsoft Windows Server 2012/2012 R2
    • Microsoft Windows Server, version 1709/1803/1904
Linux

lnvgy_utl_lxce_onecli02y-5.0.0_linux_indiv    

  • Supported Operating Systems
    • Red Hat Enterprise Linux 7/8/9 Editions
    • SUSE Linux Enterprise Server 12/15 Editions
    • Ubuntu 24.04 LTS/22.04 LTS/20.04 LTS/18.04 LTS 
      • Full support on V3 servers from OneCLI 4.4.0 on
      • Full system FW update support, no Adapter FW update support and full support the other functions on pre-V3 servers from OneCLI 4.4.0 on

User Guide

 
Lenovo XClarity Essentials OneCLI User Guide  
Lenovo XClarity Essentials OneCLI User Guide for ThinkServer  

Older Versions

Version 4.4.1 Binaries

Lenovo XClarity Essentials OneCLI Version 4.4.1

Microsoft Windows

lnvgy_utl_lxce_onecli02a-4.4.1_winsrv_x86-64

lnvgy_utl_lxceb_onecli02a-4.4.1_winsrv_x86-64 (executable)

  • Supported Operating Systems
    • Microsoft Windows 10/11
    • Microsoft Windows Server 2016 (no support on Nano)/2019/2022
    • Microsoft Windows Server 2012/2012 R2
    • Microsoft Windows Server, version 1709/1803/1904
Linux

lnvgy_utl_lxce_onecli02a-4.4.1_linux_x86-64

lnvgy_utl_lxceb_onecli02a-4.4.1_linux_x86-64 (executable)

lnvgy_utl_lxcer_onecli02a-4.4.1_linux_x86-64 (rpm)

  • Supported Operating Systems
    • Red Hat Enterprise Linux 7/8/9 Editions
    • SUSE Linux Enterprise Server 12/15 Editions
    • Ubuntu 24.04 LTS/22.04 LTS/20.04 LTS/18.04 LTS 
      • Full support on V3 servers from OneCLI 4.4.0 on
      • Full system FW update support, no Adapter FW update support and full support the other functions on pre-V3 servers from OneCLI 4.4.0 on
OneCLI 4.4.1 open source software license
OneCLI 4.4.1 Windows opensource code OneCLI 4.4.1 Windows ThirdPartyNotice
OneCLI 4.4.1 Linux opensource code
OneCLI 4.4.1 Linux ThirdPartyNotice

Version 4.4.0 Binaries

Lenovo XClarity Essentials OneCLI Version 4.4.0

Microsoft Windows

lnvgy_utl_lxce_onecli01t-4.4.0_winsrv_x86-64

lnvgy_utl_lxceb_onecli01t-4.4.0_winsrv_x86-64 (executable)

  • Supported Operating Systems
    • Microsoft Windows 10/11
    • Microsoft Windows Server 2016 (no support on Nano)/2019/2022
    • Microsoft Windows Server 2012/2012 R2
    • Microsoft Windows Server, version 1709/1803/1904
Linux

lnvgy_utl_lxce_onecli01t-4.4.0_linux_x86-64

lnvgy_utl_lxceb_onecli01t-4.4.0_linux_x86-64 (executable)

lnvgy_utl_lxcer_onecli01t-4.4.0_linux_x86-64 (rpm)

  • Supported Operating Systems
    • Red Hat Enterprise Linux 7/8/9 Editions
    • SUSE Linux Enterprise Server 12/15 Editions
    • Ubuntu 24.04 LTS/22.04 LTS/20.04 LTS/18.04 LTS 
      • Full support on V3 servers from OneCLI 4.4.0 on
      • Full system FW update support, no Adapter FW update support and full support the other functions on pre-V3 servers from OneCLI 4.4.0 on
OneCLI 4.4.0 open source software license
OneCLI 4.4.0 Windows opensource code OneCLI 4.4.0 Windows ThirdPartyNotice
OneCLI 4.4.0 Linux opensource code
OneCLI 4.4.0 Linux ThirdPartyNotice

Version 4.1.0 Binaries

Lenovo XClarity Essentials OneCLI Version 4.1.0 02c

Lenovo XClarity Essentials OneCLI Version 4.1.0 02g (Hotfix for ThinkSystem SR850 V3 and SR860 V3 only)

Microsoft Windows

lnvgy_utl_lxce_onecli02c-4.1.0_winsrv_x86-64

  • Supported Operating Systems
    • Microsoft Windows 10/11
    • Microsoft Windows Server 2016 (no support on Nano)/2019/2022
    • Microsoft Windows Server 2012/2012 R2
    • Microsoft Windows Server, version 1709/1803/1904
Linux

lnvgy_utl_lxce_onecli02c-4.1.0_linux_x86-64

  • Supported Operating Systems
    • Red Hat Enterprise Linux 7/8/9 Editions
    • SUSE Linux Enterprise Server 12/15 Editions
    • Ubuntu 22.04 LTS/20.04 LTS/18.04 LTS (only config and BMC-based log collection)

OneCLI 4.1.0 open source software license

OneCLI 4.1.0 Windows opensource code OneCLI 4.1.0 Windows ThirdPartyNotice
OneCLI 4.1.0 Linux opensource code

Version 4.0.1 Binaries

Lenovo XClarity Essentials OneCLI Version 4.0.1
Microsoft Windows

lnvgy_utl_lxce_onecli01w-4.0.1_winsrv_x86-64

  • Supported Operating Systems
    • Microsoft Windows 10/11
    • Microsoft Windows Server 2016 (no support on Nano)/2019/2022
    • Microsoft Windows Server 2012/2012 R2
    • Microsoft Windows Server, version 1709/1803/1904
SUSE Linux Enterprise Server Edition

lnvgy_utl_lxce_onecli01w-4.0.1_sles_x86-64

  • Supported Operating Systems
    • SUSE Linux Enterprise Server 12 Editions
    • SUSE Linux Enterprise Server 15 Editions
Red Hat Enterprise Linux Edition

lnvgy_utl_lxce_onecli01w-4.0.1_rhel_x86-64

lnvgy_utl_lxceb_onecli01w-4.0.1_rhel_x86-64 (executable)

  • Supported Operating Systems
    • Red Hat Enterprise Linux 7 Editions
    • Red Hat Enterprise Linux 8 Editions
    • Red Hat Enterprise Linux 9 Editions
OneCLI 4.0.1 open source software license
OneCLI 4.0.1 Windows opensource code OneCLI 4.0.1 Windows ThirdPartyNotice
OneCLI 4.0.1 Linux opensource code

Version 3.4.0 Binaries for RHEL 6 and SLES 11 (the last supported OneCLI version)

Lenovo XClarity Essentials OneCLI Version 3.4.0
SUSE Linux Enterprise Server 11 Edition

lnvgy_utl_lxce_onecli01u-3.4.0_sles_x86-64

  • Supported Operating Systems
    • SUSE Linux Enterprise Server 11 Editions
Red Hat Enterprise Linux 5 Edition

lnvgy_utl_lxce_onecli01u-3.4.0_rhel_x86-64

  • Supported Operating Systems
    • Red Hat Enterprise Linux 6 Editions

Version 2.7.0 Binaries for RHEL 5 and SLES 10 (the last supported OneCLI version)

Lenovo XClarity Essentials OneCLI Version 2.7.0
SUSE Linux Enterprise Server 10 Edition

lnvgy_utl_lxce_onecli01p-2.7.0_sles10_x86-64

  • Supported Operating Systems
    • SUSE Linux Enterprise Server 10 Editions
Red Hat Enterprise Linux 5 Edition

lnvgy_utl_lxce_onecli01p-2.7.0_rhel5_x86-64

  • Supported Operating Systems
    • Red Hat Enterprise Linux 5 Editions

Note: The Digital Certificate Authority on Lenovo's download service will be upgraded on September 21, 2018. After that date, you must use the latest version of OneCLI (Version 2.3.0, or newer) to acquire updates successfully. If you cannot switch to the x64 version, please follow the guide to update the certificate manually.

In OneCLI 2.4.0 (released on 10/26/2018), to better serve the purpose of scripting and automation, program exit/return code (IMPORTANT: this is the CLI code you typically get by running the command "echo%errorlevel%" for Windows and "echo $?" for Linux) has been refined. If you use OneCLI version 2.3.0 and before, when moving to 2.4.0, you may upgrade your scripting solution. Please click here for detailed information.

Related Articles

Downloading and installing OneCLI

Collecting inventory and service data 

System configuration settings 

Performing updates 

Diagnostics

Miscellaneous

Additional Information

Other LXCE Offerings

Alias Id:LNVO-TCLI
Document ID:HT116433
Original Publish Date:09/20/2016
Last Modified Date:12/05/2024