How to back up and restore the XClarity Controller configuration using the Lenovo XClarity Essentials Windows OneCLI
How to back up and restore the XClarity Controller configuration using the Lenovo XClarity Essentials Windows OneCLI
How to back up and restore the XClarity Controller configuration using the Lenovo XClarity Essentials Windows OneCLI
Description
This article will introduce the procedure used to view and backup the current BMC configuration with the Lenovo XClarity Essentials Windows OneCLI. The saved configuration information can be replicated to another system or used to restore the current server.
Applicable Systems
ThinkSystem, ThinkServer
Limitations
- OneCLI does not restore or replicate some settings from the saved file
- When running the OneCLI config restore and replicate command, you could encounter one or more of the following situations:
- Some settings have been filtered to restore because their value is empty.
- Some settings, for example, the VPD settings for the restore command, have been skipped.
- Some settings that can’t be found on the target system have been ignored.
You might have to restart the BMC for some settings or values set through the OneCLI config application to take effect and be displayed in the BMC Web interface.
Solution
- Download the OneCLI utility from the following link: https://datacentersupport.lenovo.com/us/en/documents/LNVO-TCLI
- Scroll down to find the appropriate Windows section, and download the requested zip file.
- Create a directory for the OneCLI tool.
- Download and extract the contents of the.zip file to the new directory.
- Open a command prompt window with administrator permission by right-clicking Command Prompt and selecting Run as administrator.
Note: It is required that users have administrator privilege to run the XClarity Essentials OneCLI command. The XClarity Essentials OneCLI will not check the user privilege while running, some functions may not work correctly if the user is not an administrator.
- From the Command Prompt navigate to the directory where you extracted the OneCli Utility.(i.e. C:\XOneCli)
- Enter the config --help command to show the available config application commands.
- The table below lists commands to help you back up the XCC configuration.
Command Descriptions
- Show: Use this command to display the current values of specified settings.
- Showgroups: Use this command to display the names of variable classes on the system
- Save: Use this command to save specified settings to a setting file
- Restore: Use this command to restore a saved setting file to the current system
- Replicate: Use this command to replicate the save setting value on another system
Note: The only difference between the restore and replicate commands is that restore can set the noreplicate setting class.
- Run the config showgroups command to show the available names of the group class. The XCC(BMC) setting group is IMM.
OneCli.exe config showgroups
- Use the show command and IMM group class to view the XCC(BMC) settings.
OneCli.exe config show IMM
- Use the following commands to backup and save the XCC configuration.
- To retrieve the XCC configuration from the host server:
OneCli.exe config IMM save --file directory
- To retrieve the XCC configuration from the remote server:
OneCli.exe config IMM save --file directory connection_options
- Go to the directory in which you saved the configuration file, copy the file, and save it to another backup storage space.
- Use the following command to restore the saved setting file to the current system.
OneCli.exe config restore –file directory
The utility might take some time to complete the restoration process.
- You can also use the following command to replicate a saved setting file to the target server.
OneCli.exe config replicate –file directoryconnection_options
The settings in the non-replicated group are saved in a specific file and cannot be replicated.