Domdsmc DB2archivelog

How to use the domdsmc db2archivelog command is described.

Purpose

The domdsmc db2archivelog parameter archives the Domino® DB2® database log files. Although DB2 automatically archives the log file, it is possible to force an archive of the log so that the latest transactions are available when the alternate database is rolled forward.

An archive copy group is required to archive the Domino DB2 database log file. If an archive copy group is not defined on the target management class, the db2archivelog command completes successfully but the log is not archived to the IBM Storage Protect server. The logs are archived to the path specified by the Domino DB2 database configuration option, FAILARCHPATH.

Syntax


>>-DOMDSMC--DB2ARCHivelog--+-------------------------------+---->
                           |               .-domdsm.cfg--. |   
                           '-/CONFIGfile=--+-cfgfilename-+-'   

>--+----------------------------+--+--------------------+------->
   |            .-domdsm.log--. |  |             .-60-. |   
   '-/LOGFile=--+-logfilename-+-'  '-/LOGPRUne=--+-n--+-'   
                                                 '-No-'     

>--+--------+--------------------------------------------------><
   '-/Quiet-'   

Parameters

/CONFIGfile=cfgfilename
Specifies the name of the Data Protection for IBM® Domino preferences file. The file name can include a fully qualified path. If you do not specify a path, it is assumed the preferences file in the directory where Data Protection for HCL Domino is installed.

The default preferences file is domdsm.cfg.

/LOGFile=logfilename
Specifies the name of the activity log that is generated by Data Protection for IBM Domino. The log file name is used for the current command and does not update the default log file that is stored in the preferences file. You can use the set command to change the default log file name that is stored in the preferences file. The command-line parameter can be used to override the default for one command run. If the specified file does not exist, it is created. If it does exist, new log entries are appended to the file. The file name can include a fully qualified path. If you do not specify a path, the file is written to the directory where Data Protection for HCL Domino is installed.

The default log file is domdsm.log.

When you are using multiple simultaneous instances of Data Protection for IBM Domino to run operations, use the /logfile parameter to specify a different log file for each instance. Using this parameter directs logging for each instance to a different log file and prevents interspersed log file records. Failure to specify a different log file for each instance can result in unreadable log files.

/LOGPRUne=60|n|No
Specifies whether to prune log entries. By default, log pruning is enabled and done daily. You can use the set command to do one of the following actions:
  • Change the defaults so that log pruning is disabled
  • Change the number of days log entries are saved
You can use the /logprune option to override these defaults for one command run. Note, when the value of /logprune is a number, the prune is done even if one is complete for the day.
You can specify:
60
Specifies that log entries are saved for 60 days before pruning.
n
Specifies the number of days to save log entries. The range of values is 0 - 9999. A value of 0 deletes all entries in the log except for the current command run entries.
No
Do not prune the log.
Changes to the value of the timeformat or dateformat parameter can result in an undesired pruning of the log file. If you are running a command that prunes the log file and the value of the timeformat or dateformat parameter changes, run one of the following to prevent pruning of the log file:
  • Make a copy of the existing log file.
  • Specify a new log file with the /logfile parameter or logfile setting.
/Quiet
Specifies that status information does not display. However, the information is written to the activity log.

Example

The following example archives the DB2 transaction log file:

domdsmc db2archivelog

Output example:

Starting Domino DB2 database transaction log archive...
Initializing Domino connection...
Initializing DB2 connection...

Archiving Domino DB2 transaction logs

Domino DB2 transaction log archive completed successfully.