Log files and trace files

Refer to these examples of the log and trace files that are maintained by IBM® Storage Protect Snapshot.

IBM Storage Protect Snapshot document each operation in log files. In addition, trace files can be requested with the TRACE parameter in the profile. Do not activate tracing unless requested by IBM Support. If TRACE is set to YES, each IBM Storage Protect Snapshot component creates an extra trace file in the log directory.

Tip: Ensure to look for, and manage the amount of free space of the file system that contains the ACS_DIR/logs directory.

The following tables list the log and trace files that are maintained by IBM Storage Protect Snapshot. These files are in ACS_DIR/logs.

Table 1. IBM Storage Protect Snapshot log files
The following table identifies the log files that are created for IBM Storage Protect Snapshot.
Purpose	File
Overview of operations and their result.	summary.`timestamp`.log
Overview about the monitoring of the background copy that is done by the storage device.	monitor.`timestamp`.log
Detailed log of a particular operation.	details/`function`.`longtimestamp`
Note: `timestamp` is the date (`yyyymmdd`) `longtimestamp` is the date and time (`yyyymmddHHMMSS`) `function` is a value of backup, restore, inquire, delete, mount, unmount, `tsm`, or clone The summary log file is always used as an entry point. All major events, such as the start of a new operation or errors, are recorded in this file. A new summary log file is created for every day and records all operations of one day within a single file.

Table 2. IBM Storage Protect Snapshot trace files
The following table identifies the trace files that are created for IBM Storage Protect Snapshot.
Component	File
Management Agent (acsd)	acsd.`id`.trace
Application client (for DB2®, the Snapshot Backup Library)	client.`instance`.`db name`.`node`.`id`.trace
Generic Device Agent (acsgen)	acsgen.`hostname`.`device class`.`node num`.`id`.trace acsgen.`hostname`.`function`.`id`.trace acsgend.`hostname`.`id`.trace
Device Agent for IBM XIV®® Storage System Devices	xivadapter_`id`_`function`.trace
Device Agent for CIM Devices (DS8000®, SAN Volume Controller, Storwize® family)	fmcima.`hostname`.`function`.`id`.trace fmcima.`hostname`.`device class`.`node num`.`id`.trace
Offload Agent (tsm4acs)	tsm4acs. `host`.`id`.trace
fcmcli	fcmcli.`host`.`id`.trace
RMAN (when started by IBM Storage Protect Snapshot)	rman.`SID`.`id`.log
Notes: Names ending in -d are daemon processes (started with -D option). `id` is the date (`yyyymmdd`) for log files written by daemon processes, date, and process ID (`yyyymmdd.xxxxxx`) for trace files written by daemon processes or a timestamp (`yyyymmddHHMMSS`) for log and trace files for other processes. `device class` can be a device class specified in the profile or all if no command-line parameter -s device class was specified for the device agent. It can also be omitted for traces of the device agent. `instance` and `db hostname` can be `undef` for query and delete requests that are started with db2acsutil. `node num` is the DB2 partition number in the case of DB2 and SAP with DB2. It is `0` for Oracle and SAP with Oracle or it can also be omitted for Oracle and SAP with Oracle. `function` is backup, delete, restore, mount, unmount, or reconcile.

Table 3. IBM Storage Protect Snapshot return codes
The following table identifies the return codes that are used by IBM Storage Protect Snapshot.
Reason code	Explanation	User response
0	Operation is successful	None
1	Operation terminated successfully with warnings	The IBM Storage Protect Snapshot operation was successful but warning messages were reported. Check the IBM Storage Protect Snapshot summary log file and the therein referenced detail log files for more information.
2	Operation terminated with error	The IBM Storage Protect Snapshot operation failed. Check the IBM Storage Protect Snapshot summary log file and the therein referenced detail log files for more information.

Table 4. IBM Storage Protect Snapshot installer exit codes
The following table identifies the installer exit codes that are used by IBM Storage Protect Snapshot.
Exit Code	Explanation	User Response
0	The operation completed successfully	The installation completed successfully without any warnings or errors.
1	The operation completed successfully with warnings.	The installation completed successfully, but one or more of the actions from the installation sequence caused a warning or a non-fatal error. See the IBM Storage Protect Snapshot installer log file installation.log in the installation directory for details.
-1	The operation terminated with error	One or more of the actions from the installation sequence caused a unrecoverable error. See the IBM Storage Protect Snapshot installer log file installation.log in the installation directory for details.
>=1000	The operation terminated with error Note: There more error codes with numbers greater than or equal to 1000 which all mean that some kind of error occurred.	One or more of the actions from the installation sequence caused a unrecoverable error. See the IBM Storage Protect Snapshot installer log file installation.log in the installation directory for details.

Table 5. DB2 vendor reason codes
The following table identifies the reason codes that are used by the DB2 database.
Reason Code	Explanation	User Response
0	The operation is successful.	None
2	Communication error with device	TheIBM Storage Protect Snapshot operation failed. Check the db2diag.log and the IBM Storage Protect Snapshot summary log file for details.
3	The DB2 and vendor products are incompatible	The IBM Storage Protect Snapshot operation failed during initialization of the IBM Storage Protect Snapshot vendor library. The DB2 API version does not match the IBM Storage Protect Snapshot vendor library version. Check the db2diag.log for details.
6	Object specified cannot be found	The IBM Storage Protect Snapshot operation failed because the requested object cannot be found in the IBM Storage Protect Snapshot repository. Check the db2diag.log and the IBM Storage Protect Snapshot summary log file for details.
8	Invalid user ID specified	The IBM Storage Protect Snapshot operation failed because an invalid user ID was specified on the db2 command line. Check the db2diag.log.
9	Invalid password provided	The IBM Storage Protect Snapshot operation failed because an invalid password was specified on the db2 command line. Check the db2diag.log.
10	Invalid options specified	The IBM Storage Protect Snapshot operation failed because an invalid db2 command-line option was specified. Check the db2diag.log.
11	Initialization failed	The IBM Storage Protect Snapshot operation failed because the IBM Storage Protect Snapshot vendor library cannot be initialized. Check the db2diag.log and the IBM Storage Protect Snapshot summary log file for details.
14	End of data reached	Not an error condition.
18	Device error	The IBM Storage Protect Snapshot operation failed. Check the IBM Storage Protect Snapshot summary log file for details.
19	Warning	The IBM Storage Protect Snapshot operation is successful with warning messages. Check the IBM Storage Protect Snapshot summary log file for details.
21	More data to come	Not an error condition.
26	Delete object fails	The IBM Storage Protect Snapshot delete operation failed. Check theIBM Storage Protect Snapshot summary log file for details.
29	Abort request failed	The IBM Storage Protect Snapshot abort request failed. Check the IBM Storage Protect Snapshot summary log file for details.
30	Unexpected Error	The IBM Storage Protect Snapshot operation failed. Check the IBM Storage Protect Snapshot summary log file for details.
31	No data has been returned	Not an error condition.
32	Object not under Backup Adapter control	The IBM Storage Protect Snapshot operation failed because the object specified for a restore or query is not under the control of IBM Storage Protect Snapshot. It might be under control of IBM Storage Protect for Enterprise Resource Planning, for example. Check the db2diag.log and the IBM Storage Protect Snapshot summary log file for details.
34	Another database or application is using the same storage groups	The IBM Storage Protect Snapshot snapshot backup operation failed because another database or application is using the same storage group. Check the db2diag.log and the IBM Storage Protect Snapshot summary log file for details.