Return codes for use in IBM Spectrum Protect scripts
You can write IBM Spectrum® Protect scripts that use return codes to determine how script processing proceeds. The return codes can be one of three severities: OK, WARNING, ERROR.
IBM Spectrum Protect scripts use the symbolic return code for processing, not the numeric value. The administrative client displays the numeric values when a command is run. The return codes are shown in the following table.
| Return code | Severity | Numeric value | Description |
|---|---|---|---|
| RC_OK | OK | 0 | The command completed successfully. |
| RC_UNKNOWN | ERROR | 2 | The command is not found; not a known command. |
| RC_SYNTAX | ERROR | 3 | The 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 command failed because 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_NOTFOUND | WARNING | 11 | Returned by a QUERY or SQL SELECT command when no objects are found that match specifications. |
| 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 input/output (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. |
| RC_INVALIDUSE | ERROR | 27 | The command failed because the command is used in an invalid manner. |
| RC_NOTABLE | ERROR | 28 | The command failed because of an unknown SQL table name. |
| RC_FS_NOTCAP | ERROR | 29 | The command failed because of incompatible file space name types. |
| RC_INVALIDADDR | ERROR | 30 | The command failed because of an incorrect high-level address or low-level address. |
| RC_INVALIDCG | ERROR | 31 | The command failed because the management class does not have an archive copy group. |
| RC_OVERSIZE_VOL | ERROR | 32 | The command failed because the volume size exceeds the maximum allowed. |
| RC_DEFVOL_FAIL | ERROR | 33 | The command failed because volumes cannot be defined in RECLAMATIONTYPE=SNAPLOCK storage pools. |
| RC_DELVOL_FAIL | ERROR | 34 | The command failed because volumes cannot be deleted in RECLAMATIONTYPE=SNAPLOCK storage pools. |
| RC_CANCELED | WARNING | 35 | The command is canceled. |
| RC_INVPOLICY | ERROR | 36 | The command failed because there is an invalid definition in the policy domain. |
| RC_INVALIDPW | ERROR | 37 | The command failed because of an invalid password. |
| RC_UNSUPP_PARM | WARNING | 38 | The command failed because the command or the parameter is not supported. |
| RC_SEGPREEMPTED | WARNING | 39 | The command failed because the object to be operated upon was not available. |
| RC_BAD_CRED | ERROR | 40 | The command failed because the credentials that were specified for the cloud service provider to access the storage pool were invalid. |
| RC_BAD_URL | ERROR | 41 | The command failed because the cloud URL is invalid. |
| RC_NO_PERMISS | ERROR | 42 | The command failed because the credentials have insufficient permissions to access the bucket or vault. |
| RC_BUCKETAVAIL | ERROR | 43 | The command completed successfully. Credentials for the cloud container storage pool are valid but the bucket does not yet exist. |
| RC_WRONG_REGION | ERROR | 44 | The command failed because the bucket or vault exists in a different region or access pool. |
| RC_NO_WORK | OK | 45 | The command completed successfully. No eligible objects were found to process. |