Installation and User's Guide

Chapter 8. Client return codesThe backup-archive command-line interface and the scheduler exit with returncodes that accurately reflect the success or failure of the client operation.Scripts, batch files, and other automation facilities can use the return code from thecommand-line interface. For operations that use the Tivoli Storage Managerscheduler, the return codes are shown in the output of the QUERY EVENTadministrative command.In general, the return code is related to the highest severity message during theclient operation.vvvIf the highest severity message is informational (ANSnnnnI), then the returncode is 0.If the highest severity message is a warning (ANSnnnnW), then the return codeis 8.If the highest severity message is an error (ANSnnnnE or ANSnnnnS), then thereturn code is 12.The exception to the above rules is warning or error messages that individual filescould not be processed. For such a skipped file, the return code is 4. For caseswhere the return code is not 0, you can examine the dsmerror.log file (and, forscheduled events, the dsmsched.log file).For a description of the return codes and their meanings, see the following table.Table 35. Client return codes and their meaningsCode Explanation0 All operations completed successfully.4 The operation completed successfully, but some files were not processed.There were no other errors or warnings. This return code is very common.Files are not processed for various reasons. The most common reasons are:v The file satisfies an entry in an exclude list.v The file was in use by another application and could not be accessed bythe client.v The file changed during the operation to an extent prohibited by the copyserialization attribute. See “Copy serialization attribute” on page 239.8 The operation completed with at least one warning message. For scheduledevents, the status is Completed. Review dsmerror.log (and dsmsched.log forscheduled events) to determine what warning messages were issued and toassess their impact on the operation.12 The operation completed with at least one error message (except for errormessages for skipped files). For scheduled events, the status is Failed.Review the dsmerror.log file (and dsmsched.log file for scheduled events) todetermine what error messages were issued and to assess their impact on theoperation. As a general rule, this return code means that the error was severeenough to prevent the successful completion of the operation. For example,an error that prevents an entire drive from being processed yields return code12.© Copyright IBM Corp. 1993, 2010 233