Skip to main content

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).

Users 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.

Note

When necessary, OneCLI will automatically enable the disabled CIM-over-HTTPs and IPMI-over-LAN on BMC, and restore them to the original state before exiting.

Table 1. OneCLI applications
ApplicationDescription
config
  • View the current system configuration settings.
  • Create and change configuration settings for BMC-based systems.
multiconfigRemotely show or change the system configuration for multiple IMM- or XCC-based servers.
multiinventoryAcquire system information from multi servers.
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.

  • Execute the CMOS action.

  • 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 LED status of hard disk drive.

  • Manage the host server OS power for single or multiple servers.
  • Create, clear, and save the RAID configuration for single or multiple servers.
  • Restart BMC/CMM/IOM/SMM.
  • Reseat the blades/switch on CMM.
  • Restore the BMU status on BMC.
  • Restore the SMM update progress.
  • Disable or enable SMM LAN.
  • Switch over CMM.
  • Query/enable/disable USB LAN.
  • Manage virtual medias on BMC.
  • Disk Secure Erase.
  • Change BMC password when first login or password expired for single or multiple systems.
  • Collect system health information for multiple systems.
  • Configure Raid for multiple systems.
  • Get disk drive SMART data.
  • Query/enable/disable cim/ipmilan/ipmikcs connection.

  • Assert/deassert Remote Physical Presence.

diagsRun the diagnostics program of the remote server.
tuiLaunch OneCLI interactive menu.
fodManage the FoD key.

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

Table 2. OneCLI global parameters
ParameterDescription

--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 CIM port for in-band connection with BMC.

--bmc-password, -w

Specify the BMC password for in-band mode.

--bmc-rest-port

Specify the rest port for in-band connection with BMC.

--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.

--cmm, -c

Specify the CMM information.

Format: user:password@IP:port

--help, -h

Specify the help information.

--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

Run OneCLI without recording log.

--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.

--quiet, -q

Answer yes for all questions and display less screen output as required.

--redfish

Force to communicate with BMC through Redfish API directly.

--unattended

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

  • For the parameters input:

    • The userid can contain the following characters: A-Z, a-z, 0-9, -,_.

    • The password can contain the following characters: A-Z, a-z, 0-9, ~`!@#$%^&*()-+={}[]|:;”’<>,?/_.

    • The userid and password cannot contain space or white-space characters.

    • If the password contains special characters, use "" on Windows and ‘’ on Linux to quote these special characters.

    • If the parameter contains path, the path name should not contain reserved characters.

  • To start using OneCLI, see Downloading and using OneCLI.