Technical overview

Lenovo XClarity Essentials OneCLI (hereinafter referred to as OneCLI) is a consolidated command line software for managing Lenovo systems. It replaces the previous generation of ToolsCenter tools (Advanced Settings Utility for system configuration, Online Dynamic System Analysis for system inventory collection, and UpdateXpress System Pack Installer for firmware and device driver update).

You can run multiple OneCLI instances on a client operating system to manage multiple servers remotely.

The following table lists the functions and applications supported by OneCLI.

Table 1. OneCLI applications
Application Description
config
  • View the current system configuration settings.
  • Create and change configuration settings for BMC-based systems.
inventory
  • Collect system information for BMC-based systems.
  • Upload inventory results to Lenovo Web site.
update
  • Download firmware and device driver updates.

  • Get device inventory information and check for available firmware and device driver updates.

  • Check for update packages in the local system folder.

  • Compare installed and available firmware and device driver versions, recommending updates to perform.

  • Update firmware and device drivers requiring upgrade.

misc
  • Encrypt credentials in plain text file.
  • Collect the FFDC of BMC/CMM/SMM.
  • View or set the configurations of the front panel USB port.
  • Manage the system event logs and the BMC event logs.
  • Manage the host server OS.
  • Create, clear, and save the raid configuration.
  • Restart BMC.
  • Restart CMM.
  • Restart IOM.
  • Restart SMM.
  • Reseat the blades on CMM.
  • Reseat CMM.
  • Reseat the switch on CMM.
  • Restore the BMU status on BMC.
  • Restore the SMM update progress.
  • Disable or enable SMM LAN.
  • Switch over CMM.
  • Collect and view the system health information.
  • Query or enable or disable USB LAN.
diags Run the diagnosis program of the remote server.
fod Manage the FoD key

The following table lists the OneCLI global parameters used in different applications.

Table 2. OneCLI global parameters

Parameter

Description

--bmc/imm, -b

Specify the access information of the target BMC.

The format is userid:password@host[:port].

If the --bmc parameter is specified, OneCLI runs in out-of-band mode; otherwise, OneCLI runs in in-band mode.
Note: Both the IPv4 address and the IPv6 address are supported. The IPv6 address shall be enclosed in brackets. For example, [FE80:3BA7:94FF:FE07:CBD0].

If the IPv6 is Link Local Address (LLA), the format is [FE80:3BA7:94FF:FE07:CBD0%xxx]. Replace xxx with the interface name. If the service processor or the SFTP server connects to local network of the OS that runs OneCLI, the service processor, the SFTP server, and the OS shall have the same interface name.

--bmc-cim-port, -p

Specify the BMC CIM port for in-band mode.

--bmc-password, -w

Specify the BMC password for in-band mode.

--bmc-username, -u

Specify the BMC user name for in-band mode.

--configfile

Specify the file containing credentials in plain text.

The template file is available in Sample/credentials_config.json.

--config

Specify the OneCLI configuration file path.

--check-trust, -C

Verify the SSL certificate by using the HTTPS protocol, or verify the fingerprint of remote host by using the SSH protocol.

--never-check-trust, -N

Neither verify the SSL certificate by using the HTTPS protocol, nor verify the fingerprint of remote host by using the SSH protocol.

--node, -n

Specify the node index for in-band mode in the multi-node system.

--nolog

Cancel logging when running OneCLI.

--output, -o

Specify where OneCLI logs are generated.
If not specified, the logs of each OneCLI command are saved in the corresponding folder. The format of folder name is logs/Onecli-%PID %-%date%-%time%/.
Note: The arguments of the --output parameter are case-sensitive.

--unattended

Specify the unattended mode for managing password and sensitive setting values.

To start using OneCLI, see Downloading and using OneCLI.