Linux-UNIX: guardctl return codes
The guardctl error codes clarify error conditions that occur, in particular, when you are call the guardctl script to manage ATAP instances via another script.
| Code | Description | Usage |
|---|---|---|
| 0 | success | Returned by every command. When returned in response to deactivate, all instances are deactivated When returned in response to is-active, there are no active instances |
| 1 | bad parameter | Returned by every command when a parameter is invalid or missing |
| 2 | is-active called on unrecognized instance | Returned by is-active when a db-instance specified is not known to guardctl and as such cannot be determined to be active or not |
| 20 | attempted to activate instance while database was running, but not yet active | Returned by activate to indicate that the DB instance is running, so activation could not take place |
| 21 | attempted to deactivate instance while database was running, but not yet inactive | Returned by deactivate to indicate that the DB instance is running, so deactivation could not take place |
| 22 | user is not authorized | Returned by instrument and activate to indicate that the db-user specified is not authorized as a member of the 'guardium' group. Run authorize-user to correct. |
| 23 | db-home parameter doesn't match db_install_dir parameter in guard_tap.ini | Returned by store-conf and activate to indicate that the current guard_tap.ini doesn't have an IE configured with a db_home that matches the db_install_dir ATAP parameter. One of those needs to be adjusted to the correct value or STAP may not run. |
| 24 | attempt to deactivate an instance where the executable is neither an ATAP executor or the instrumented binary | Returned by deactivate. This instance looks like it should be activated, but the binary isn't what it should be if it is. DB executable could have been updated while ATAP was active. Run the repair command to fix the issue and activate again. |
| 25 | attempt to activate atap when encryption=1 set in guard_tap.ini | Returned by activate when the encryption parameter is set to 1 in the IE. Do not activate with guardctl and use the encryption parameter in the ini. |
| 26 | db executable file not found | Returned by activate, deactivate, instrument, deinstrument, store-conf, prepare-libs, and repair. The DB executable is missing (e.g. the oracle binary itself is not in the path specified). Check the path parameters used when configuring the instance. |
| 27 | instrumentation required but not done | Returned by activate and store-conf when instrumentation is required, but has not already been done. Oracle instrumentation is now automatically done in most cases, but still needs to be manually specified for AIX and Oracle versions <= 10. |
| 28 | is-active reports instance is not active | Returned by is-active. Informational only. The db-instance specified is not active or if no instances were specified, no instances are active. |
| 29 | deactivate-all not complete success | Returned by deactivate-all when at least one active instance could not be deactivated. |
| 30 | is-instrumented reports instance is not instrumented | Not exported via command. |
| 40 | internal instrumentation error | Returned by instrument when instrumentation couldn't be completed. |
| 41 | internal instrumentation error | Returned by instrument when instrumentation couldn't be completed. |
| 42 | internal instrumentation error | Returned by instrument when instrumentation couldn't be completed. |
| 43 | instrumentation error, cannot save original binary | Returned by instrument when the -guard-original file already exists. Either A-TAP is currently active with instrumentation, or A-TAP is inactive but the instrumentation is still active. Deactivate and deinstrument before subsequent instrument and activate. |
| 44 | attempt to instrument while instance running and not already instrumented | Returned by instrument when DB instance is currently running. Stop DB instance before attempting to instrument again. |
| 45 | attempt to instrument while A-TAP is active and not already instrumented | Returned by instrument when A-TAP is already active, but instrumentation is not active. This can happen when switching from an Oracle configuration that doesn't require instrumentation to one that does. Deactivate A-TAP before attempting to instrument again. |
| 46 | attempt to instrument and already instrumented instance | Returned by instrument while instance is already instrumented. If instrumentation needs to be redone, deinstrument first. |
| 93 | unspecified error due to DB running not when activating, deactivating, or instrumenting (e.g. when running repair command) | |
| 94 | no atap library supporting this db | Returned by instrument, deinstrument, prepare-libs, activate, deactivate, repair, list-active, and list-configured. Usually indicates that an unknown error occurred. |
| 95 | system error, cannot find group | Returned by activate. The guardium group doesn't appear to be known to this system. |
| 96 | system error, cannot create group | Returned by authorize-user. The guardium group did not exist and an attempt to create the group failed. |
| 97 | filesystem error, cannot create directory or file, or insufficient space detected | |
| 98 | platform unsupported | Returned by instrument, deinstrument, prepare-libs, activate, deactivate, repair, list-active, list-configured, store-conf. The DB you're trying to use with ATAP is not supported on this platform (e.g. DB2, Informix, teradata, or mongo on anything but Linux, etc). |
| 99 | other unspecified error |