Tivoli Storage Manager for Windows Administrator's Reference


Appendix C. Return Code Checking in Tivoli Storage Manager Scripts

You can write TSM scripts that include return codes. As each command is processed in a script, the return code can be used to determine how processing of the script should proceed based on the return code value. Shown below are the return codes. The return codes can be one of three severities: OK, WARNING, ERROR. TSM scripts use the symbolic return code for processing, not the numeric value. The numeric values are displayed by the administrative client when a command is run.

Table 333. Return Code Checking

Return code Severity Numeric value Description
RC_OK OK 0 Command completed successfully
RC_NOTFOUND WARNING 11 Returned by a QUERY or SQL SELECT command when no objects are found that match specifications
RC_UNKNOWN ERROR 2 Command is not found; not a known command
RC_SYNTAX ERROR 3 Command is valid, but one or more parameters were not specified correctly
RC_ERROR ERROR 4 An internal server error prevented the command from successfully completing
RC_NOMEMORY ERROR 5 The command could not be completed because of insufficient memory on the server
RC_NOLOG ERROR 6 The command could not be completed because of insufficient recovery log space on the server
RC_NODB ERROR 7 The command could not be completed because of insufficient database space on the server
RC_NOSTORAGE ERROR 8 The command could not be completed because of insufficient storage space on the server
RC_NOAUTH ERROR 9 The administrator is not authorized to issue the command
RC_EXISTS ERROR 10 The command failed because the specified object already exists on the server
RC_INUSE ERROR 12 The command failed because the object to be operated upon was in use
RC_ISREFERENCED ERROR 13 The command failed because the object to be operated upon is still referenced by some other server construct
RC_NOTAVAILABLE ERROR 14 The command failed because the object to be operated upon is not available
RC_IOERROR ERROR 15 The command failed because an I/O error was encountered on the server
RC_NOTXN ERROR 16 The command failed because a database transaction failed on the server
RC_NOLOCK ERROR 17 The command failed because a lock conflict was encountered in the server database
RC_NOTHREAD ERROR 19 The command could not be completed because of insufficient memory on the server
RC_LICENSE ERROR 20 The command failed because the server is not in compliance with licensing
RC_INVDEST ERROR 21 The command failed because a destination value was invalid
RC_IFILEOPEN ERROR 22 The command failed because an input file that was needed could not be opened
RC_OFILEOPEN ERROR 23 The command failed because it could not open a required output file
RC_OFILEWRITE ERROR 24 The command failed because it could not successfully write to a required output file
RC_INVADMIN ERROR 25 The command failed because the administrator was not defined
RC_SQLERROR ERROR 26 An SQL error was encountered during a SELECT statement query


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]