Trace classes for a server or storage agent
The server and storage agent provide aggregate trace classes. These trace classes are a shortcut for using many related trace classes by specifying the aggregate trace class name for the TRACE ENABLE command.
The trace classes that are listed in Table 1 are those trace classes that are most typically requested or used for diagnosing problems. This table does not include all possible trace classes that are available. The trace class name is used with the TRACE ENABLE and TRACE DISABLE commands.
| Trace classes | Description | Usage |
|---|---|---|
| ADDMSG | Issues console messages such as ANR and ANE messages to the trace file. | This trace class is valuable for correlating server messages to trace messages and for preserving the timing for when each was issued. |
| ADMCMD | Traces related to command processing. | Use this trace class to debug the command interpreter, including the PARALLEL and SERIAL command handling. |
| AF | This trace class displays information about user data that is stored on sequential media devices. AF is an aggregate trace class that uses AFCREATE, AFMOVE, AFLOCK, AFTXN, and AFCOPY. Issue TRACE DISABLE AFLOCK unless the locking information is explicitly requested or needed. | Use this trace class to diagnose problems about reading or writing user files to sequential media volumes. |
| AFCREATE | This trace class displays information about storing user data on sequential media volumes. | Use this trace class to diagnose writing user data on sequential media volumes. |
| AFMOVE | This trace class displays operations that move user data with sequential media volumes. Move operations are completed by MIGRATION, RECLAMATION, MOVE DATA, and MOVE NODEDATA server processes. | Use this trace class to diagnose problems with the data movement server processes. |
| AS | This trace class displays information volume selection and assignment, coordination of drives (mount points), and management of data placement on volumes. This aggregate trace class uses ASALLOC, ASRTRV, ASDEALLOC, ASMOUNT, ASVOL, ASTXN, and ASSD. The typical method is to issue TRACE DISABLE ASTXN, unless the locking information is explicitly requested or needed. | Use this trace class to diagnose many different problems about volumes, mount points, or data read and write operations. |
| ASALLOC | This trace class displays information about reserving and allocating space on sequential media volumes for storing data. This space is for storing data on behalf of a client session or for server data movement operations such as MIGRATION, RECLAMATION, MOVE DATA, or MOVE NODEDATA. | Diagnose problems where the server or storage agent report no space available but space is supposed to be available in the storage hierarchy. |
| ASDEALLOC | This trace class displays information about releasing and de-allocating space on sequential media volumes for storing data. Typical deallocation operations on the server are EXPIRATION, MIGRATION, RECLAMATION, MOVE DATA, MOVE NODEDATA, AUDIT VOLUME, DELETE VOLUME, and DELETE FILESPACE. | Use this trace class to diagnose during the deletion of data. |
| ASMOUNT | This trace class displays information about drive (mount point) selection and assignment for sequential media devices. | Diagnose situations where sessions or processes are waiting for mount points or cases where an operation fails because no mount point is available. Also useful in cases where a mount point is pre-empted. |
| ASRTRV | This trace class displays information about reading data from sequential media volumes. | Use this trace class to diagnose problems about data such as RESTORE or RETRIEVE client by the client, or MIGRATION, RECLAMATION, STORAGE POOL BACKUP, AUDIT VOLUME, GENERATE BACKUPSET, EXPORT, MOVE DATA, or MOVE NODEDATA by the server. |
| ASTXN | This trace class displays information about transactions that are used to make database updates to information for sequential media volumes, storage pools, device classes, and other attributes. | Use this trace class to diagnose stoppages, database operations, failures reported for sequential media operations, or general data storage problems. |
| ASVOL | This trace class displays information about volume selection and assignment for sequential media volumes. | Use this trace class to diagnose situations where sessions or processes are waiting for volumes, or cases where an operation fails because no volume is available. Also useful in cases where volume access is pre-empted. |
| ASSD | This trace class displays information about sequential stream data operations. These operations use sequential media device classes, volumes, or mount points but do not store data in the storage hierarchy. Server processes that complete sequential stream data operations are BACKUP DB, EXPORT/IMPORT, and GENERATE BACKUPSET. | Use this trace class to diagnose server processes that complete sequential stream data operations. |
| BF | Information about user data (files) stored in the storage hierarchy. This aggregate trace class uses BFCREATE, BFRTRV, BFSALVAGE, BFLOCK, BFAGGR, BFREMOTE, BFSAGGR, and BFTRG. | Use this trace class to diagnose general data read-or-write problems for client operations and server processes. |
| BFAGGR | This trace class displays information about server aggregation of user data. The server aggregates many smaller user files into a larger file in the storage hierarchy to optimize performance for data movement operations such as MIGRATION, MOVE DATA, and MOVE NODEDATA. | Use this trace class to diagnose general data read-or-write problems for client operations and server processes, or both. |
| BFCREATE | This trace class displays information about client operations that store data in the storage hierarchy. Typically, these client operations are BACKUP, ARCHIVE, or SPACE MANAGE operations by the client. | Use this trace class to diagnose failures or other problems while a client is storing data. |
| BFREMOTE | Traces the first stage of NDMP (Network Data Management Protocol) backup and restore processes. | This trace class is used to identify NDMP-related backup or restore operations. These trace classes are specific to the functions that implement the NDMP protocol. The SPID trace class provides more detailed tracing, including tracing all NDMP file history records that are sent by the NDMP file server. |
| BFRTRV | This trace class displays information about client operations that read data from the storage hierarchy. | Use this trace class to diagnose failures or other problems while a client is reading data. |
| BFSAGGR | This trace class displays information about the storing, retrieving, and moving of super aggregates. An object larger than 10 GB is stored as a super aggregate. | Use this trace class to diagnose problems that are related to storing or retrieving objects larger than 10 GB. |
| BITVECTOR | Diagnoses problems where the server reports problems with disk storage pools. | Use this trace class to display information about reserving and allocating space on volumes in disk storage pools. |
| BKSET/OBJSET | Trace class for backup set functions. The BKSET and OBJSET trace classes are synonymous. | Use this trace class to debug problems in the GENERATE BACKUPSET command or during a client restore operation from a backup set. |
| BLKDISK | Trace class for viewing disk I/O activity to storage pool, database, and log volumes. | Use this trace class to view I/O activity to disk to diagnose performance and disk I/O errors. |
| BRNODE | Trace class for the BACKUP and RESTORE NODE commands, which are used during NDMP operations. | Use this trace class to debug problems in the BACKUP and RESTORE NODE commands. |
| CLOUD | This trace class displays information related to cloud input/output operations for database backup to cloud, retention cloud pools, and cloud-container storage pools with IBM Storage Protect 8.1.13 and later. | Use this trace class to diagnose cloud storage related problems. |
| CLOUDJ | This trace class displays information related to cloud input/output operations in the Java™ GUI components. The displayed information is about all the cloud operations and other code that uses the Java GUI components. This trace class is similar to the trace class SDCLOUDJ. | Use this trace class to diagnose problems related to cloud storage and the other code that uses the Java GUI component. |
| COLLOCATE | This trace class displays information about collocation processing on storage pools. COLLOCATEDETAIL trace class can also be used to get more detailed information about the collocation processing. For example, information about the files that are being processed for a collocation group. Files that are being processed for a collocation group can cause many output trace statements. | Use this trace class to diagnose problems with collocation processing. |
| CRC | This trace class displays information about generating and managing cyclic redundancy checks (CRCs) on the server or storage agent. CRC is an aggregate trace class that uses CRCDATA, CRCPROTO, and CRCVAL. | Use this trace class to diagnose data corruption issues where CRC processing did not report data corruption. |
| CRCDATA | This trace class displays information about
generating and managing CRCs for data that is stored in storage pools
with CRCDATA=YES set. |
Use this trace class to diagnose data corruption issues where CRC processing did not report data corruption. |
| CRCPROTO | This trace class displays information about
generating and managing CRCs for data that is exchanged between the
client and either the server or storage agent where this node is configured
with VALIDATEPROTOCOL=ALL or VALIDATEPROTOCOL=DATAOnly on
the server. |
Use this trace class to diagnose data corruption issues where CRC processing did not report data corruption. |
| CRCVAL | This trace class displays information about generating and comparing CRC values. | Informational for showing CRC values during processing. |
| CRYPTO | This trace class displays information about advanced encryption standard (AES) operations and some general encryption settings. | Use this trace class to isolate and identify encryption-related problems. |
| DBCLI | Traces the general set of interactions. | Use this trace class to trace the general set of Db2 interactions and the Db2 command-line interface. |
| DBCONN | Traces connection activities. | Use this trace class to trace IBM Storage Protect connections to Db2 connections. This trace class shows such things as the creation of connection handles and the assignment of connections to transactions. |
| DBDBG | Traces debugging processes. You might use this trace class first when you are debugging a database issue. | Use this trace class to show function entry or exit, exit return codes, and the statements that are built and are being run. |
| DBITXN | Traces database transaction-related activities. Transaction-related activities concern transaction latch acquisition and release, dbTxnDesc allocation and release, and transaction commit processing from the prepare and commit phase functions. | Use this trace class to trace transaction-related activities for the database interface. |
| DBNETDB | This trace class displays information about LAN-free operations and the negotiation and management of information between the server and storage agent. | Use this trace class to diagnose LAN-free problems when the server and storage agent are at different levels. They function better when they are at the same level. You can also use this trace class to diagnose problems with a storage agent that is obtaining configuration information from the server. |
| DBRC | Traces the return codes from functions in the database component. | Use this trace class to trace the return codes. |
| DEDUP | Traces the general logic path tracing for data deduplication processing. Does not typically include error paths. | Use DEDUP to trace general logic paths for data deduplication processing. |
| DEDUP1 | Traces error paths for data deduplication processing. | Use DEDUP1 to trace error paths for data deduplication processing. |
| DEDUP2 | Traces the fingerprinting and digital signatures path. | Use DEDUP2 to trace fingerprinting and digital signature paths. |
| DF | This trace class displays information about user data that is stored on disk volumes. DF is an aggregate trace class that enables DFCREATE, DFRTRV, DFMOVE, DFLOCK, DFTXN, and DFCOPY. Issue the TRACE DISABLE DFLOCK command unless the locking information is explicitly requested or needed. | Use this trace class to diagnose problems about reading or writing user files to disk volumes. |
| DFCREATE | This trace class displays information about storing user data on disk volumes. | Use this trace class to diagnose writing user data on disk volumes. |
| DFMOVE | This trace class displays operations that move user data by using disk volumes. Move operations are completed by the MIGRATION, MOVE DATA, and MOVE NODEDATA server processes. | Use this trace class to diagnose problems with the data movement server processes. |
| DFRTRV | This trace class displays information about reading user data from disk volumes. | Use this trace class to diagnose reading user data from disk volumes. |
| DS | This trace class displays information about volume selection, space reservation, assignment, and management of data placement on disk volumes. DS is an aggregate trace class that enables DSALLOC, DSRTRV, DSDEALLOC, and DSVOL. Issue TRACE DISABLE DSTXN unless the locking information is explicitly requested or needed. | Use this trace class to diagnose many different problems about disk volume data read-and-write operations. |
| DSALLOC | This trace class displays information about reserving and allocating space on disk volumes for storing data. The data storage might be completed on behalf of a client session or for server data movement operations such as MIGRATION, MOVE DATA, or MOVE NODEDATA. | Diagnose problems where the server or storage agent report that no space is available, but there appears to be space available in the storage hierarchy. |
| DSDEALLOC | This trace class displays information about releasing and de-allocating space on disk volumes. Typical deallocation operations on the server are EXPIRATION, MIGRATION, MOVE DATA, MOVE NODEDATA, AUDIT VOLUME, DELETE VOLUME, and DELETE FILESPACE. | Use this trace class to diagnose during the deletion of data. |
| DSRTRV | This trace class displays information about reading data from disk volumes. | Use this trace class to diagnose problems about reading data such as RESTORE or RETRIEVE client by the client, or MIGRATION, STORAGE POOL BACKUP, AUDIT VOLUME, GENERATE BACKUPSET, EXPORT, MOVE DATA, or MOVE NODEDATA by the server. |
| DSVOL | This trace class displays information about volume selection and assignment for disk volumes. | Use this trace class to diagnose situations where sessions or processes are waiting for volumes, or cases where an operation fails because no volume is available. |
| GROUP | Trace class for logical group functions. | Use this trace class to debug problems with logical groups, whether delta-base groups (subfile backup) or peer groups (Windows SYSTEM OBJECT or image backups). Group processing is relevant during just about any operation that references backup objects. The backup objects can include client backup and restore, expiration, deletion (DELETE FILESPACE, DELETE VOLUME), export/import, backup set generation and restore, no-query restore, database audit, and others. |
| ICVOLHST | Trace class for volume history functions. | Use this trace class to debug problems with creating volume history entries, for example; during EXPORT, BACKUP DB, or GENERATE BACKUPSET) or deleting volume history entries, for example; during DELETE VOLHISTORY). |
| IMFS | Trace class for file space functions. | Use this trace class to debug problems that are related to inventory file spaces (for example, during DELETE FILESPACE). |
| JVM | This trace class displays information related to the startup and basic function of the Java Virtual Machine (JVM) used by IBM Storage Protect. | Use this trace class to diagnose problems related to the startup of the JVM. Generally, this trace class should be enabled before you start the IBM Storage Protect server. |
| LANFREE | This trace class displays general information about LAN-free operations on either the server or storage agent. Also shows error information for LAN-free-related operations. LANFREE is an aggregate trace class that enables LNFVERB, LNFMEM, LNFENTRY, and LNFDATA. | Any LAN-free failure. |
| MMS | This trace class displays information about tape libraries and the server or storage agent that uses these libraries.MMS is an aggregate trace class that enables MMSBASE, MMSTXN, MMSLIB, MMSDRIVE, MMSOP, MMSMAN, MMSSCSI, MMSFLAG, MMSACSLS, and MMSSHARE. Include NA and PVR trace classes when you are tracing MMS. | Used to diagnose problems with tape libraries, library volume inventories, or other general library issues. |
| MONITOR | This trace class displays information about alert monitoring. | Use this trace class to determine why an alert might not be generated. |
| NA | This trace class displays information about path information for the server or storage agent. This information relates to the DEFINE PATH, UPDATE PATH, DELETE PATH, and QUERY PATH commands. This trace class is also used to identify issues that are related to operations that involve NDMP file servers, for example; DEFINE DATAMOVER, UPDATE DATAMOVER, BACKUP NODE, and RESTORE NODE commands. This aggregate trace class uses NALOCK, NAPATH, NAMOVER, NADISK, and NACONFIG. It might be best to include MMS and PVR trace classes when you are tracing NA. | Use this trace class to diagnose problems with paths to devices. |
| PRODCONS | If there are problems with getting work dispatched to batches, PRODCONS displays information about the problem and whether it is in the PC object or in replication. | Use PRODCONS to trace the internal workings of the producer/consumers objects that are used in the server. |
| PROXYNODE | This trace class displays information about proxynode sessions and the commands that are related to proxynode associations (GRANT, REVOKE, QUERY PROXYNODE). | Use this trace class to diagnose problems with proxynode sessions and related commands. It might be best to include SESSION trace when you are analyzing proxynode session problems. |
| PVR | This trace class displays information about
sequential media devices and the server or storage agent use of these
devices. PVR is an aggregate trace class that enables PVRVOL, PVRCLASS,
and PVRMP. The PVR trace class contains everything in the PVRIO aggregate trace class and the PVRNOIO trace class. |
Use this trace class to diagnose problems with tape drives, failures when reading or writing tape volumes, or other tape-volume-related issues. |
| PVRIO | This trace class displays tracing of read, write, or POS operations for sequential media devices and the server or storage agent use of these devices. | Use this trace class to diagnose problems with tape drive failures when reading or writing tape volumes. |
| PVRNOIO | This trace class displays PVRVOL, PVRCLASS, and PVRMP information. | Use this trace class to diagnose problems with tape drive mounts or other tape-volume-related issues. |
| REPL | REPL is an aggregate trace class that enables the other trace classes that are REPLBATCH, REPLCMD, REPLFS, REPLINV, REPLPROC, REPLSTATS, and REPLSESS. | Use this trace class to diagnose problems with replication. |
| REPLBATCH | This trace class displays tracing related to batch processing, where individual files are sent from the source replication server to the target replication server. | Use this trace class to diagnose replication problems with batch processing. |
| REPLCMD | This trace class displays tracing related to command parsing and the resolution of file space replication rules. | Use this trace class to diagnose replication problems with command parsing and the resolution of file space replication rules. |
| REPLFS | This trace class displays tracing related to the iteration of the file spaces to decide what is to be replicated, updated, or deleted. | Use this trace class to diagnose replication problems with iterating file spaces to decide what is to be replicated, updated, or deleted. |
| REPLINV | This trace class displays tracing related to the inventory updates (IM tables) as part of replication. | Use this trace class to diagnose replication problems with inventory updates. |
| REPLPROC | This trace class displays tracing of the overall replication process. This trace class is the main thread and dispatcher. | Use this trace class to diagnose replication problems with the replication process. |
| REPLSESS | This trace class displays tracing related to the establishment of sessions for replication, including the session management on both source and target servers. | Use this trace class to diagnose replication problems with the establishment of sessions. |
| REPLSTATS | This trace class displays tracing related to updating the statistics as replication runs. Also includes insertion or update of history records in the replication history table. | Use this trace class to diagnose replication problems with statistical updates. |
| RETPROT | Trace class for the archive retention protection functions. | Use this trace class to debug problems when you are using the RETINIT and RETMIN parameters in the archive copy group. You can also use this trace class for problems that are caused by using the VB_SignalObject verb (only supported by the client API) to signal an object's event or to hold or release an object. Finally, you can use this trace class for problems during expiration or deletion of retention protected objects. |
| RETS | This is an aggregate trace class that enables the other trace classes that are RETSIM, RETSBF, RETSAF, RETSSD, RETSCS, RETSREPL, and RETSSC. | Use this trace class to diagnose problems with defining, creating, and scheduling retention rules and retention sets. The RETSSCD trace class provides more detailed tracing related to copying of retention set data to tape or cloud. |
| ROWMGR | Traces activities for row-based operations.
Row-based operations are the following operations:
|
Use this trace class to trace the activities for row-based operations. |
| SC | This trace class displays tracing related to storage rules defined for the operations such as data retention, data replication, tiering data, and copying data. | Use this trace class to diagnose the problems related to the storage rule operations and the storage pool defined with the storage rule. |
| SCHED | Trace class for the central scheduler functions. This trace class applies to classic and enhanced schedules equally. | Use this trace class to debug problems that are related to schedule commands like DEFINE/UPDATE/QUERY SCHEDULE or DEFINE ASSOCIATION. Also use this trace class to debug problems that are related to the central scheduler background processes, such as the schedule manager and schedule prompter. |
| SD | This trace class displays tracing related to data processing with container storage pool, which includes both directory-container and cloud-container storage pools. | Use this trace class to diagnose the problems related to data processing with directory-container and cloud-container storage pools. |
| SDCLOUD | This trace class displays information related to cloud input/output operations for cloud-container storage pools. | Use this trace class to diagnose problems related to cloud-container storage pools. |
| SDCLOUDJ | This trace class displays information related to cloud input/output operations in the Java components related to cloud-container storage pools and other Java related operations. In general, use this trace class in conjunction with SDCLOUD. | Use this trace class to diagnose problems related to cloud-container storage pools or other code that uses the Java GUI component. |
| SDCRYPT | This trace class displays tracing related to encryption and decryption of data stored in directory-container and cloud-container storage pools. | Use this trace class to diagnose problems related to encrypting or decrypting data in container storage pools. |
| SDREPL | This trace class is used for chunk processing with any of the PROTECT STGPOOL operations or replication-based operations. To troubleshoot PROTECT STGPOOL operations, the trace class must be enabled on both the source and the target server. | Use this trace class to diagnose the problems with PROTECT STGPOOL of type REPLSERVER. |
| SDREPL AS |
This trace class is used for chunk processing with any of the PROTECT STGPOOL operations or replication-based operations. Additionally, AS tracing is required for PROTECT STGPOOL of type LOCAL, which helps to diagnose issues with tape-based operations. |
Use this trace class to diagnose the problems with PROTECT STGPOOL of type LOCAL. |
| SEC | This trace class displays tracing related to the server security component, which is responsible for securely storing passwords and other sensitive information. | Use this trace class to diagnose problems with storing or fetching passwords. |
| SESSION | This trace class displays information about sessions that are connected to the server, including all verbs that are sent and received by the server. | This trace class is used for protocol violations, transaction processing errors, or in cases where the client is stopped and not responding. |
| SESSREMOTE | Traces communication between the server and the client during NDMP backup and restore operations. | This trace class is used to identify NDMP-related backup or restore operations that are initiated when you are using the IBM Storage Protect web or command-line client. |
| SHRED | This trace class displays information that is related to data-shredding operations on the server. | This trace class is used to diagnose problems with data shredding. Data shredding is only applicable if one or more storage pools on the server have a nonzero value for the SHRED attribute. Activity that is related to data shredding occurs primarily during the EXPIRE INVENTORY, DELETE FILESPACE, DELETE VOLUME, MOVE DATA, MIGRATE, and SHRED DATA commands. Other trace classes that report activity related to data shredding are BFDESTROY, DFDESTROY, DSALLOC, DSDEALLOC, and CRCDATA. |
| SPI/SPID | Traces the server NDMP protocol interface. | The SPI and SPID trace classes are used to identify issues that are related to NDMP backup or restore operations of NAS file servers. These trace classes are specific to the functions that implement the NDMP protocol and communicate with a NAS file server. The SPID trace class provides more detailed tracing, including tracing all NDMP file history records that are sent by the NAS file server. |
| SSLDATA | Detailed Secure Sockets Layer (SSL) trace is used to display byte-level information about data that is sent or received between the backup-archive client and the server. | Use the SSLDATA trace class to debug the session data corruption issues that might be caused by SSL that is running through the SSLTCP or SSLTCPADMIN server options. This trace is a byte-level trace so it can collect a large amount of data. |
| SSLINFO | General SSL trace is used to display setup and characteristics of SSL sessions between the backup-archive client and the server. | Use the SSLINFO trace class to debug session connection and handshake errors that might be caused by the SSL that is running through the SSLTCP or SSLTCPADMIN server options. This trace class can be used in tandem with the TCPINFO and SESSION trace classes. |
| S3 | This trace class displays information related to the front-end operations of an Amazon S3 API, which is also known as the S3 Object Agent that is provided by IBM Storage Protect. | Use this trace class to diagnose problems related to the spObjectAgent service and cold-data-cache storage pool. |
| TBREORG | This trace class collects information about table and index reorganization activities that are initiated by the server. | Use the TBREORG trace class to debug server-initiated reorganization activity. |
| TBLMGR | Traces activities for table-based operations. | Use the TBLMGR trace class to view table-based operations such as table registration, table open, and table close. |
| TCP | This trace class collects information about TCP/IP used between the client and either server or storage agent. TCP is an aggregate trace class. It enables TCPINFO and TCPERROR. | Use this trace class to debug session connection errors or data corruption issues that might be caused by the network. |
| TCPDATA | The detailed TCP/IP trace is used to display byte-level information about data that is sent or received. | Use this trace class to debug session data corruption issues that might be caused by the network. |
| TCPINFO | The general TCP/IP trace is used to display setup and characteristics of TCP/IP on the server or storage agent. | Use this trace class to debug session data corruption issues that might be caused by the network. |
| TEC | This trace class provides information about events that are sent to a TEC server. These events correspond to the TIVOLI event receiver. | To debug connection issues that are incurred by TEC event logging. |
| TOC | This trace class is used for the Table Of Contents (TOC) component, which is used during file-level NDMP operations. TOC is an aggregate trace class that enables TOCBUILD, TOCLOAD, TOCREAD, and TOCUTIL. | Use this trace class to debug problems during file-level NDMP operations, such as an NDMP backup with the TOC=YES parameter, or an NDMP restore with the FILELIST parameter. |
| TOCBUILD | Tables Of Contents (TOC) build functions. | Use this trace class to debug problems during an NDMP backup with the TOC=YES parameter. |
| TOCLOAD | Table Of Contents (TOC) load functions. | Use this trace class to debug problems while you are displaying files and directories on the client graphical user interface (GUI). |
| TOCREAD | Table Of Contents (TOC) read functions. | Use this trace class to debug problems during a QUERY TOC command or while you are trying to load a TOC to display files and directories on the client GUI. |
| TOCUTIL | Table Of Contents (TOC) utility functions. | Use this trace class to debug problems that are related to TOC component initialization or TOC retention. |
| UNICODE | This trace class displays information about code page conversions and Unicode filespace operations. | Use this trace class to debug problems that are related to code page conversion problems or Unicode filespace problems. |
| XI | This trace class displays general information for the IMPORT and EXPORT commands. | Use this trace class to debug problems that are related to IMPORT and EXPORT commands. |