Domdsmc archivelog

Purpose of Domdsmc archivelog

The Domdsmc archivelog command queries the Domino server to determine whether any log extents are ready for archiving. If so, the log files are backed up to IBM Storage Protect server storage, and the Domino server is notified of their availability for reuse. High and low threshold values can be specified as a percentage of the log capacity to control whether log files are archived when the command is run. This allows the command to be scheduled regularly to protect against a log full condition but to actually do the archive only if the log is getting close to being full. If enough log space is allocated to contain an average day of updates, it is possible to establish a strategy where log files are normally archived daily during low usage time. A daily schedule without threshold values but unusually high volumes of change can also be handled on an exception basis. For example, an hourly schedule of the archivelog command with appropriate specified threshold values archives only if necessary.

Run this command frequently to ensure that allocated transaction log space is freed.

The active transaction log is also backed up with Domino Server 8.5.x or a more recent version.

>>-DOMDSMC--ARCHivelog--+----------------------+---------------->
                        '-/ADSMNODe=--nodename-'   

>--+--------------------------------+--------------------------->
   |                .-dsm.opt-----. |   
   '-/ADSMOPTFile=--+-optionsfile-+-'   

>--+---------------------+-------------------------------------->
   '-/ADSMPWD=--password-'   

>--+--------------------------------------------+--------------->
   |            .-3----------.  .-,1024-------. |   
   '-/BUFFers=--+-numbuffers-+--+-,buffersize-+-'   

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

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

>--+----------------------+--+--------+------------------------->
   |              .-Yes-. |  '-/Quiet-'   
   '-/MOUNTWait=--+-No--+-'               

>--+---------------------------------------+-------------------><
   |                         .-,0--------. |   
   '-/THRESHold=--highvalue--+-,lowvalue-+-'   

Parameters

/ADSMNODe=nodename

Specifies the IBM Storage Protect node name Data Protection for HCL Domino uses to log on to the IBM Storage Protect server. The command-line value overrides the value in the IBM Storage Protect system options file.

/ADSMOPTFile=optionsfile

Specifies the name of the options file used by the IBM Storage Protect API. The default file name is dsm.opt. The optionsfile variable can include a fully qualified path name or a relative path. A relative path means that the path is relative to the directory from which Data Protection for HCL Domino is run. Review the following considerations:

• When Data Protection for HCL Domino is started by a Domino startup script tools/startup that was configured by the dominstall program, a relative path means that the path is relative to the Domino Data directory and not to the directory from which Data Protection for HCL Domino is run.
• This parameter functions in the same manner as the DSMI_CONFIG environment variable. When the DSMI_CONFIG environment variable is set, the options file specified by this environment variable is recognized as the default options file.
• Specify the adsmoptfile parameter in the Data Protection for HCL Domino preferences file, domdsm.cfg, when you use the web client GUI.

/ADSMPWD=password

Specifies the IBM Storage Protect password Data Protection for HCL Domino uses to log on to the IBM Storage Protect server. If you specify passwordaccess generate in the IBM Storage Protect system options file, then the password is not required. In this case, Data Protection for HCL Domino uses the password that is stored by the IBM Storage Protect API.

If passwordaccess is set to generate and you specify a password, the value is ignored unless a password for this node is not stored. In this case, the specified password is stored and used for the current command execution.

If passwordaccess is set to prompt and you specify a password on the command line, you are not prompted for a password. The command-line value overrides the need to prompt.

If passwordaccess is set to prompt and you do not specify a password on the command line, then you are prompted for a password.

/BUFFers=numbuffers,buffersize

Use this parameter to specify the number of data buffers and the size of data buffers that transfer data between the Domino server and the IBM Storage Protect API. Increasing the number and size of the data buffers can improve throughput.

You can specify from 2 to 8 buffers, the default value is 3. The size of the buffers can be from 64 to 8192 kb, the default value is 1024.

If the /buffers parameter is not specified on the command line or defined in the preferences file, Data Protection for HCL Domino uses the default values.

/CONFIGfile=cfgfilename

Specifies the name of the Data Protection for HCL 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.

You can also specify the preferences file with the DOMI_CONFIG environment variable.

The default preferences file is domdsm.cfg.

/LOGFile=logfilename

Specifies the name of the activity log that is generated by Data Protection for HCL 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.

You can specify the log file with the DOMI_LOG environment variable.

The default log file is domdsm.log.

When you are using multiple simultaneous instances of Data Protection for HCL Domino to run operations, use the /logfile parameter to specify a different log file for each instance used. This 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 performed once per day. You can use the set command to:

• 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 completed for the day.

You can specify:

60

Specifies that log entries are saved for 60 days before pruning. This is the default.

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 has changed, do one of the following to prevent unwanted 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.

/MOUNTWait=Yes|No

If the IBM Storage Protect server is configured to store transaction log backup data on removable media, then the IBM Storage Protect server can indicate to Data Protection for HCL Domino that it is waiting for a required storage volume to be mounted. The mount command is used to specify whether Data Protection for HCL Domino waits for the media mount or stops the current operation. Removable media is media such as tapes or DVDs.

You can specify:

Yes

Wait for tape mounts. This value is the default.

No

Do not wait for tape mounts.

/Quiet

Specifies that status information does not display. However, the information is written to the activity log.

/THRESHold=highvaluelowvalue

Use this option to specify when the archivelog command starts and stops archiving eligible transaction log files. The highvalue, specified as a percentage of the transaction log capacity, identifies the point at which log archiving begins. If the current occupancy of the transaction log equals or exceeds the value for this parameter, eligible log files are archived until the occupancy falls to or below the lowvalue which is also specified as a percentage of the log capacity.

The highvalue variable is an integer in the range from 1 to 99.

The lowvalue variable is an integer in the range from 0 to 98 but it must be less than the high value. The default is 0 which means that all log files eligible for archive are archived. Specify a low threshold value, greater than 0 to prevent the active transaction log from being backed up.

If the /threshold option is not specified, then all eligible transaction log files are archived. The active transaction log is an eligible transaction log file.

For example, specifying the following command will archive transaction log files after the log is at or more than 90% full. The archive process stops when sufficient space is reclaimed to make the log less than or equal to 50% full:

/threshold=90,50

It is important to note that the /threshold option is impacted by the total size of the transaction log. The total size of the transaction log is determined on the Domino server by the value of the TRANSLOG_UseAll and TRANSLOG_MaxSize options in the notes.ini file.

Example

domdsmc archivelog

Starting Domino transaction log archive...
Initializing Domino connection...
Logging on to the IBM Storage Protect server, please wait...

Archiving transaction log file /local/notesdata/domlogs/S0000002.TXN
Full: 0   Read: 67,109,888  Written: 67,109,888  Rate: 9,616.58 Kb/Sec
Archive of /local/notesdata/domlogs/S0000002.TXN completed successfully.

Total Domino transaction log files ready for archive: 1
Total Domino transaction log files archived:          1
Total Domino transaction log files deduplicated:      0

Throughput rate:                                      9,615.17 Kb/Sec
Total bytes inspected:                                67,109,888
Total bytes transferred:                              67,109,888
Total LanFree bytes transferred:                      0
Total bytes before deduplication:                     0
Total bytes after deduplication:                      0
Data compressed by:                                   0%
Deduplication reduction:                              0.00%
Total data reduction ratio:                           0.00%
Elapsed processing time:                              6.82 Secs