OneCLI return codes mapping table between v2.3.0 (and before) and v2.4.0
OneCLI return codes mapping table between v2.3.0 (and before) and v2.4.0
OneCLI return codes mapping table between v2.3.0 (and before) and v2.4.0
In OneCLI 2.4.0, to better serve the purpose of scripting and automation, program exit/return code (IMPORTANT: this is the CLI code you typically get by running command "echo %errorlevel%" for Windows and "echo $?" for Linux) has been refined in the following aspects:
- Comply with POSIX standard
- Deprecate program exit/return codes for useless / internal errors
- Combine duplicated errors
- Add new program exit/return codes for common / useful errors
- Re-define program exit/return codes range for different functions of OneCLI (e.g, inventory, update, config, etc) for future code extensibility. Program exit/return codes are unique in each function, but can overlap across different functions
If you are using OneCLI version 2.3.0 (and before), when moving to 2.4.0, you may upgrade your scripting solution by simply looking up the code mapping table below.
A trivial sample approach would be like:
- Look for your current code (2.3.0 and before) in the 1st column
- Find out the corresponding new code in 2.4.0 in the 3rd column
- Replace your current code with the new code in your scripts
V 2.3.0 (and before) |
V 2.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 | You 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 | You 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. You could try another method to check the result. | 0x7A/122 | Failed to reconnect to BMC after the command is executed successfully. You 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 | You 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 | You 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 | You are running on an IBM system. But the current command is not supported in UXSPI. | 0x6D/109 | You are running against an IBM system, but the current command is not supported. |
0x50/80 | Update blue not supported. | 0x6D/109 | You 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 inband flash. | 0x01/1 | Generic failure. |
0x58/88 | Update flash module failure: Error occurred when running Option Update for inband 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 | Diagnosis 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. |