Return codes

XClarity Essentials OneCLI issues a return code to indicate either successful execution of a command or to indicate that an error occurred while the program was running. A return code of zero indicates that the operation was successful, and a nonzero return code indicates an error.

To determine whether any errors occurred and when based on the associated timestamp, refer to one of the following log files:
  • For Windows, review the C:\Lenovo_Support\onecli.log file.
  • For Linux, review the /var/log/Lenovo_Support/onecli.log file.
OneCLI return code tables provide a complete list of all return codes.
Table 1. XClarity Essentials OneCLI common return codes
Return code Decimal base Description
0x00 0 Success.
0x01 1 Generic failure.
0x03 3 Invalid application.
0x04 4 Invalid command.
0x05 5 Invalid parameter.
0x06 6 Local file does not exist.
0x07 7 Invalid file.
0x08 8 Failed to create directory.
0x09 9 Failed to open file.
0x0A 10 Failed to read file.
0x0B 11 Failed to write file.
0x0C 12 Authentication failed.
0x0D 13 Connection failed.
0x0E 14 Ping failed.
0x0F 15 Upload failed.
0x10 16 Download failed.
0x11 17 Internal error.
0x12 18 Time-out.
0x13 19 Failed to get XCC account through KCS.
0x14 20 Users are running on an IBM system. Do not use proxy tool in onecli extract path when set the executable binary of legacy ToolsCenter path in global.config.
0x15 21 LAN-over-USB device is disabled on BMC side. Enable it manually.
0x16 22 The BMC default internal IP conflicts with external machine. Correct the problem, and try again.
0x17 23 Failed to restart host system.
0x18 24 Failed to restart BMC.
0x19 25 Platform error.
0x1a 26
  • For windows servers, LAN-over-USB device is not detected.

    .
  • For linux servers, some tools are not installed, including lsusb,lsmod,and modprobe.

0x1b 27 Failed to get driver information
0x1c 28 Failed to get machine type.
0x1e 30 Internal error of BMC.
0x1f 31 Failed to find applicable hardware component.
0x20 32 Failed to load LAN-over-USB device driver.
0x21 33

For windows servers: Failed to run commands without root permission. Switch to root user and try again.

For linux servers: Failed to run commands without administrator permission. Switch to administrator user and try again.

0x22 34 Failed to update due to ESXI internal error.
0x23 35 CMM internal error.
0x24 36 Failed to verify the certificate/fingerprint for the connection(s) specified.
0x25 37 Manually quit OneCLI.
0x26 38 Invalid file folder.
0x27 39 Failed to encrypt/decrypt.
0x28 40 Fail to find the matching credential.
0x29 41 Fail to find the matching tool package for remote machine.
0x2a 42 Remote operation not support this remote machine.
0x2b 43 Could not find credential file.
0x2c 44 The path behind the option remoteos does not exist.
0x2d 45 Attended or unattended mode conflict.
0x2e 46 Passphrase error.
0x2f 47 Interrupted by user.
0x30 48 Encrypted file is not exist.
0x31 49 Encrypted file is invalid.
0x32 50 Failed to connect KCS. Check IPMI over KCS status.
0x33 51 Unable to access IPMI service with a password over 20 characters according to IPMI standard.
0x34 52 There is no RESTful service for the target server.
0x35 53 Check the format of input for connection parameter. For credential encrypt user, can't find crypt.json.
0x36 54 The password provided for this account must be changed before access is granted.
0x37 55 BMC CIM Over HTTPS is disabled.
0x38 56 Invalid BMC/CMM/SMM Address.
0x39 57 Check BMU requirement failed.
0x3a 58 One or more tasks failed.
0x3b 59 One or more tasks skipped.
0x3c 60 Fail to get data from Rest interface of BMC.
Note: This table can be used with the following specific return codes based on the actual needs.
  1. See Table 2 for specific configuration-related return codes.
  2. See Table 3 for specific update-related return codes.
  3. See Table 4 for specific FFDC-related return codes.
  4. See Table 5 for specific raid-related return codes.
  5. See Table 6 for specific diags-related return codes.
  6. See Table 7 for specific FoD-related return codes.
Table 2. XClarity Essentials OneCLI Config-related Return Codes.
Note: For the return codes not covered in the following table, refer to Table 1.
Return code Decimal base Description
0x5C 92 Invalid data field.
0x5D 93 Failed to change the settings. It is recommended to change the settings in batch mode by using the provided password.
0x5E 94 The required FoD key has not been installed.
0x5F 95 The setting has invalid current value.
0x60 96 Operation unavailable. Users should wait a moment and retry later.
0x61 97 Certificate does not exist.
0x62 98 The default value is empty.
0x63 99 Invalid e-maill address of destination.
0x64 100 The current version of firmware does not support this function. To resolve this issue, update the target firmware to the latest version.
0x65 101 Redfish internal error.
0x66 102 Failed to parse BMC data.
0x67 103 BMC data error.
0x68 104 The command is not supported on current system.
0x69 105 Query BMC error.
0x6A 106 Invalid certificates.
0x6B 107 Failed restoration.
0x6C 108 Failed replication.
0x6D 109 The password can only be changed in low security level.
0x6E 110 Previous passwords are not allowed. Try another passwords.
0x6F 111 The password does not meet password policy requirements.
0x70 112 User already exists.
0x71 113 Failed to run commands when executing batch command.
0x72 114 BMC internal error: No priviledge to complete this operation.
0x73 115 Invalid setting value.
0x74 116 Failed to display the instance setting. Create the instance first.
0x75 117 Invalid commands in the batch file.
0x76 118 Failed to reconnect to BMC after the command is executed successfully. To check the result, try another method.
0x77 119 Failed to generate, export, import, or delete certificates.
0x78 120 Failed to set the setting items.
0x79 121 Failed to get information.
0x7A 122 Create the record key of instance first.
0x7B 123 Unable to find setting.
0x7C 124 BMC internal error.
0x7D 125 Failed to run command.
Table 3. XClarity Essentials OneCLI Update-related Return Codes.
Note: For the return codes not covered in the following table, refer to Table 1.
Return code Decimal base Description
0x7d 125 Skip updating this package.
0x7c 124 Update does not take effect after successful flash.
0x7b 123 Current BMC version does not support this package. Upgrade BMC to the latest version and try again.
0x7a 122 Failed to update because this package does not support current method.
0x79 121 Failed to update because this device does not support current method.
0x78 120 The candidate update is older than the allowed minimum version.
0x77 119 Current BMC setting disallows downgrade.
0x76 118 Device error.
0x75 117 Another update in progress.
0x74 116 Failed to prepare update environment.
0x73 115 BMC RDOC space not enough. Remove other mounted device from BMC RDOC.
0x72 114 Failed to set up BMU environment.
0x71 113 Failed to boot into Maintenance Mode OS.
0x70 112 Failed to acquire.
0x6f 111 Unsupported OS.
0x6e 110 Failed to get OS type by using the scan command.
0x6d 109 No package needs update.
0x6c 108 UXSPI does not support the current command run in the IBM system.
0x6b 107 Update blue not supported.
0x6a 106 Failed to run UXSPI. For more information about the error, see UXSPI logs.
0x69 105 Failed to update flash because the error backup does not support the update.
0x68 104 Invalid or unsupported machine type.
0x67 103 Update error: Flash finished running, however multiple packages failed to be flashed. Check flash status xml for further information.
0x66 102 Users are running on an IBM system. Ensure that UXSPI_PATH is set to the executable binary of UXSPI in global.config.
0x65 101 Update error: Failed to generate common_result.xml.
0x64 100 Update not found.
0x63 99 No applicable update available in the Repository for the specified machine type or OS.
0x62 98 Failed to connect to the Repository.
0x61 97 Unrevoverable error.
0x60 96 Failed to download some update packages.
Table 8. Mapping table of return codes between OneCLI V2.3.0 and OneCLI V2.4.0
V2.3.0 V2.4.0

Return code/

decimal base

Description

Return code/

decimal base

Description
0x00/0 Success. 0x00/0 Success.
0x01/1 Invalid command. 0x04/4 Invalid command.
0x02/2 Generic failure. 0x01/1 Generic failure.
0x03/3 XML file is missing. 0x06/6 Local file does not exist.
0x04/4 Restart OS Failure. 0x17/23 Failed to restart host system.
0x05/5 Failed to connect. 0x0D/13 Failed to connect.
0x06/6 Platform error. 0x19/25 Function not supported on target system.
0x07/7 Input xml file format error. 0x07/7 The file is not valid.
0x08/8 OPEN DLL FAILURE. 0x11/17 Internal error.
0x09/9 GET NULL POINTER. 0x11/17 Internal error.
0x0A/10 NO INTERFACE FOUND. 0x11/17 Internal error.
0x0B/11 RETURN INVALID RESULT. 0x11/17 Internal error.
0x0C/12 Unknown exception. 0x01/1 Generic failure.
0x0D/13 Invalid parameter. 0x05/5 Invalid parameter.
0x0E/14 Local file does not exist. 0x06/6 Local file does not exist.
0x0F/15 Failed to create directory. 0x08/8 Failed to create directory.
0x10/16 Failed to read or write file. 0x09/9 Failed to open file.
0x11/17 Ping BMC failed. 0x0E/14 Ping failed.
0x12/18 Fail to get XCC account through KCS. 0x13/19 Fail to get XCC account through KCS.
0x13/19
  • BMC Lan Over USB device driver is not detected (for windows).

  • Miss some tools, such as: lsusb, lsmod, and modprobe (for linux).

0x1A/26
  • LAN-over-USB device is not detected. Make sure that RNDIS is correctly installed (for windows).

  • LAN-over-USB device is not detected. Make sure that following tools are installed: lsusb, lsmod, and modprobe (for linux).

0x14/20 No package needs update. 0x6E/110 No package needs update.
0x15/21 Users are running on a blue system. Do not use proxy uxspi in onecli extract path when set the executable binary of UXSPI path in global.config. 0x14/20 Users are running on a blue system. Do not use proxy uxspi in onecli extract path when set the executable binary of UXSPI path in global.config.
0x16/22 Authentication with BMC failed. 0x0C/12 Authentication failed.
0x17/23 Authentication failed by FTP server. 0x0C/12 Authentication failed.
0x18/24 Fail to create directory or put file in FTP server: No such file or directory, or permission denied for the specified user name. 0x0F/15 Upload failed.
0x19/25 LXCE has no enable permission. Enable BMC Lan Over USB device manually. 0x15/21 LAN-over-USB device is disabled on BMC side. Enable it manually.
0x1A/26 Fail to upload data to specified FTP server. 0x0F/15 Upload failed.
0x1B/27 Fail to connect through IPMI. 0x0D/13 Failed to connect.
0x1C/28 Ping CMM failed. 0x0E/14 Ping failed.
0x1D/29 Fail to get driver information. 0x01/1 Generic failure.
0x1E/30 Fail to get machine type. 0x01/1 Generic failure.
0x1F/31 Fail to get firmware information. 0x01/1 Generic failure.
0x20/32 Fail to read inventory XML. 0x0A/10 Failed to read file.
0x21/33 Fail to write inventory XML. 0x0B/11 Failed to write file.
0x22/34 Fail to write inventory HTML. 0x0B/11 Failed to write file.
0x23/35 UXSP xml do not exist. Check the UXSP package. 0x06/6 Local file does not exist.
0x24/36 Time-out. 0x12/18 Time-out.
0x60/96 Failed to run the command. 0x01/1 Generic failure.
0x61/97 Failed to get information. 0x7D/125 Failed to get information.
0x62/98 Failed to set the setting items. 0x7C/124 Failed to set the setting items.
0x63/99 Failed to open the file. 0x09/9 Failed to open file.
0x64/100 Failed to read the file. 0x0A/10 Failed to read file.
0x65/101 Failed to write the file. 0x0B/11 Failed to write file.
0x66/102 Failed to generate/export/import/delete certification. 0x7B/123 Failed to generate/export/import/delete certification.
0x67/103 Failed to reconnect to BMC after the command is executed successfully. Users could try another method to check the result. 0x7A/122 Failed to reconnect to BMC after the command is executed successfully. Users could try another method to check the result.
0x68/104 One or more commands are not valid in the batch file. 0x79/121 One or more commands are not valid in the batch file.
0x69/105 Failed to show the instance setting. The instance should be created at first. 0x78/120 Failed to show the instance setting. The instance should be created at first.
0x6A/106 Invalid value for set command. 0x77/119 Invalid value for set command.
0x40/64 Update error: Acquire command failed. 0x01/1 Generic failure.
0x41/65 Update error: Scan command failed. 0x01/1 Generic failure.
0x42/66 Update error: Query command failed. 0x01/1 Generic failure.
0x43/67 Update error: Compare command failed. 0x01/1 Generic failure.
0x44/68 Update error: Flash command failed. 0x01/1 Generic failure.
0x45/69 Update error: File related error occurred, see log/xml for more information. 0x0B/11 Failed to write file.
0x46/70 Update error: CIM service fails. See log/xml for more information. 0x01/1 Generic failure.
0x47/71 Update error: There is something wrong with the device. See log/xml for more information. 0x78/120 Update error: There is something wrong with the device. See log/xml for more information.
0x48/72 Update error: Failed to generate common_result.xml. 0x0B/11 Failed to write file.
0x49/73 Could not get OS type using scan command. 0x6F/111 Failed to get OS type.
0x4A/74 Invalid/unsupported machine type. 0x68/104 No applicable update available on the repository for specified machine-type/OS.
0x4B/75 Invalid/unsupported OS. 0x70/112 Current Operating System is not supported.
0x4C/76 Authentication failed, unable to validate userid/password. 0x0C/12 Authentication failed.
0x4D/77 Update error: Flash finished running, however multiple packages failed to be flashed. Check flash status xml for more information. 0x0B/11 Failed to write file.
0x4E/78 Users are running on an IBM system. Make sure that UXSPI_PATH is set correctly to the executable binary of UXSPI in global.config. 0x72/114 Users are running on an IBM system. Make sure that UXSPI_PATH is set correctly to the executable binary of UXSPI in global.config.
0x4F/79 Users are running on an IBM system. But the current command is not supported in UXSPI. 0x6D/109 Users are running against an IBM system, but the current command is not supported.
0x50/80 Update blue not supported. 0x6D/109 Users are running against an IBM system, but the current command is not supported.
0x51/81 UXSPI does not run successfully, to trace error, see log relate to UXSPI. 0x11/17 Internal error.
0x52/82 Update module was not able to write to XML file. 0x0B/11 Failed to write file.
0x53/83 Update flash module failure: failed to run flash with ESXi. See log/xml for more detail information. 0x01/1 Generic failure.
0x54/84 Update flash module failure: failed to run flash with IOSwitch. See log/xml for more detail information. 0x01/1 Generic failure.
0x55/85 Update flash module failure: failed to run flash with CMM Update. See log/xml for more detail information. 0x01/1 Generic failure.
0x56/86 Update flash module failure: failed to run flash with OOB. See log/xml for more detail information. 0x01/1 Generic failure.
0x57/87 Update flash module failure: Error occurred when running xFirmware for in-band flash. 0x01/1 Generic failure.
0x58/88 Update flash module failure: Error occurred when running Option Update for in-band flash. 0x01/1 Generic failure.
0x5A/90 Update flash failure: Error payload file does not exist. 0x07/7 Local file does not exist. (dynamic message)
0x5B/91 Update flash failure: Error backup does not support. 0x6C/108 Backup bank does not exist.
0x5C/92 The BMC default internal IP conflicts with external machine. Correct the problem, and try again. 0x16/22 The BMC default internal IP conflicts with external machine. Correct the problem, and try again.
0x5E/94 Update flash failure: current BMC does not support internal SFTP for this case. 0x7B/123 Current BMC version does not support this package. Upgrade BMC to the latest version, and try again.
0x5F/95 Update application fails to run. 0x01/1 Generic failure.
0xD0/208 Download SMM FFDC error: setup environment failed. 0x7D/125 Download SMM FFDC error: setup environment failed.
0xD1/209 Download SMM FFDC error: start dump failed. 0x7C/124 Download SMM FFDC error: start dump failed.
0xD2/210 Download SMM FFDC error: query failed. 0x7B/123 Download SMM FFDC error: query failed.
0xD3/211 Download SMM FFDC error: tar ffdc files failed. 0x7A/1222 Download SMM FFDC error: tar ffdc files failed.
0xD4/212 Download SMM FFDC error: upload path does not exist. 0x0F/15 Upload failed.
0xD5/213 Download SMM FFDC error: upload failed. 0x0F/15 Upload failed.
0xD6/214 Download SMM FFDC error: tftp server is not found. 0x79/121 Download SMM FFDC error: tftp server is not found.
0xD7/215 Download SMM FFDC error: time-out. 0x12/18 Time-out.
0xD8/216 Download SMM FFDC error: unknown error. 0x01/1 Generic failure.
0xD9/217 FFDC log is uploaded to the specified FTP/TFTP server, but fails to download FFDC log from FTP/TFTP server. 0x78/120 FFDC log is uploaded to the specified FTP/TFTP server, but fails to download FFDC log from FTP/TFTP server.
0xDA/218 Failed to get FFDC log. 0x77/119 Failed to get FFDC log.
0xB0/176 Raid config fails to operate. 0x7D/125 Raid config fails to operate.
0xB1/177 Raid config ini file error. 0x7C/124 Raid config ini file error.
0xB2/178 Raid config has no config to operate. 0x7B/123 Raid config has no config to operate.
0xB3/179 Raid config does not need make good. 0x7A/122 Raid config does not need make good.
0xB4/180 Raid config does not need make jbod. 0x79/121 Raid config does not need make jbod.
0x34/52 Fail to trigger diags. 0x7D/18 Fail to trigger diags.
0x35/53 Fail to get status of diags. 0x7C/124 Fail to get status of diags.
0x36/54 Fail to get result file. 0x7B/123 Fail to get result file.
0x37/55 Diagnostics time-out. 0x12/18 Time-out.
0x80/128 Failed to run the command. 0x01/1 Generic failure.
0x81/129 The FoD key file is not valid. 0x7D/125 The FoD key file is not valid.
0x82/130 Specified machine type or serial number is not valid. 0x7C/124 Specified machine type or serial number is not valid.
0x83/131 The FoD key file is not found. 0x7B/123 The FoD key file is not found.
0x84/132 Authentication failed. 0x0C/12 Authentication failed.
0x85/133 The FoD key is not found from target key repository. 0x7A/122 The FoD key is not found from target key repository.
0x86/134 The FoD key ID is not valid. 0x79/121 The FoD key ID is not valid.
0x87/135 Active key exists in KMS Web site. 0x78/120 Active key exists in KMS Web site.
0x88/136 Authentication code does not exist. 0x77/119 Authentication code does not exist.
0x89/137 Unique identifier is not valid. 0x76/118 Unique identifier is not valid.
0x8A/138 Failed to install the FoD key. 0x75/117 Failed to Install the FoD key.
0x8B/139 Failed to uninstall the FoD key. 0x74/116 Failed to export the FoD key.
0x8C/140 Failed to export the FoD key. 0x73/115 Fail to export the FoD key.
0x8D/141 Failed to report the FoD key. 0x72/114 Failed to report the FoD key.
0x8E/142 Failed to get current tier. 0x71/113 Failed to get current tier.
0xA0/160 MODULEMANAGER_ERROR Deprecated
0xA1/161 MODULEMANAGER_NO_NEWER_UPDATE Deprecated
0xA2/162 MODULEMANAGER_XML_PARSE_ERROR Deprecated
0xA3/163 MODULEMANAGER_DOWNLOAD_ERROR Deprecated
0xA4/164 MODULEMANAGER_INCOMPATIBLE_ERROR Deprecated
0xA5/165 MODULEMANAGER_COPY_ERROR Deprecated
0xDD/221 Switch does not support EHCM or the CMM build is not supported to check EHCM. 0x76/118 Switch does not support EHCM or the CMM build is not supported to check EHCM.
0xDE/222 Check EHCM time-out because the EHCMState is busy or setting up. 0x12/18 Time-out.
0xDF/223 Reseat failed. 0x01/1 Generic failure.