Domdsmc incremental

How to use the domdsmc incremental command is described.

Purpose

Running domdsmc incremental runs the following functions:
  • Backs up new databases since the last backup, or newly included ones.
  • Backs up any non-logged databases that changed since the last backup (based on modification dates of both data and metadata).
  • Backs up any logged databases with a changed DBIID when archival logging is in effect.
  • Inactivates any active database backups on the IBM Storage Protect server that are excluded from backup or no longer exist on the Domino® server.
A query of the current backup objects from the IBM Storage Protect server is required before any actions take place.
This command backs up a database by matching the dbname pattern with the following conditions:
  • The database is not excluded in the IBM Storage Protect options file. Standard include and exclude processing is supported.
  • The database is not logged, and was modified since the last active backup image for that database. Both data and non-data modification dates are checked. If either date is different from the active backup, the database is backed up.
  • Archival logging is in effect, and the DBIID of a logged database is changed. If the DBIID is not changed, then logged databases are not backed up. The changes are captured in the transaction log backups. In this case, periodic selective backups of all logged databases must be done to refresh the active backup images. This reduces the number of transaction logs to be applied during a recovery.
    Note: When circular logging is used on the Domino server (or when logging is disabled on the Domino server), transaction log files are not archived. For more information about logging, see NSF backup strategy.
  • The database is new or newly included in the backup (an active backup image does not exist on the IBM Storage Protect server).

The incremental command can also deactivate active backup images for databases that are deleted from the Domino server or excluded from backup. Backups can automatically be expired according to the retention parameters that are defined in the IBM Storage Protect management class.

Use the incremental command to back up a single directory or all databases within the Notes® data path by specifying an appropriate dbname pattern.

Syntax

>>-DOMDSMC--Incremental--+-*----------+------------------------->
                         | .-,------. |   
                         | V        | |   
                         '---dbname-+-'   

>--+----------------------+------------------------------------->
   '-/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--+-'               

>--+-----------------------------+--+-------------------+------><
   |             .-1-----------. |  |           .-No--. |  
   '-/SESSIONS=--+-numsessions-+-'  '-/SUBDir=--+-Yes-+-'   

Parameters

*|dbname,dbname,...,
Specifies the file path of a database or file path pattern for a group of databases. The file path pattern can represent a group of databases to be conditionally backed up. The wildcard character asterisk (*) is used to specify a group of databases when used in the dbname. Multiple dbnames can be specified separated with commas.

The file path must be relative to the Notes data directory.

Symbolic links are referred to by their symbolic names. To reference a database in a directory outside of the Notes data directory and any subsequent directories pointed to by a directory link in the data path, use the directory link name as the directory name. For example, if database xyz.nsf is in a directory, and pointed to by the link vol1.dir, refer to it as vol1\xyz.nsf. If a symbolic directory link is created with the same name as a physical directory in the Notes data path, only the physical directory is searched.

The wildcard character (*) is used to represent any number of any characters when used in the file name portion of the file path. The wildcard character is not supported within directory names. The following example backs up all databases within the dir_A directory beginning with the characters ter:

   domdsmc incremental dir_A\ter*

The following example backs up all databases on the server that meet the criteria of the incremental backup:

   domdsmc incremental * /subdir=yes

The following example backs up all databases whose file name ends in acct:

   domdsmc incremental *acct.n* /subdir=yes
Note: Standard include and exclude processing applies to Domino database names. Wildcards can be used on the backup command, and specific databases can be excluded from the backup with the include-exclude list in the Tivoli Storage Manager options file. For example, to exclude all databases on a volume pointed to by the symbolic directory link temp.dir, use the following statement:
   exclude \temp\*
The exclude statement refers to the relative file name that includes symbols, and not the physical file path. For more information about include and exclude options, see Include and exclude processing and IBM IBM Storage Protect for Windows Backup-Archive Client Installation and User's Guide.
/ADSMNODe=nodename
Specifies the IBM Storage Protect node name Data Protection for IBM® Domino uses to log on to the IBM Storage Protect server. The command-line value overrides the value in the IBM Storage Protect options file.
/ADSMOPTFile=optionsfile
Specifies the IBM Storage Protect options file name. The file name can include a fully qualified path name. If you do not specify a path, the installation directory and then the current directory are searched for the specified file. The default is dsm.opt.
/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 Tivoli Storage Manager options file, then the password is not required. In this case, Data Protection for HCL Domino uses the password that is stored by the Tivoli Storage Manager 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 requirement 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
Specifies the number and size of data buffers that transfer data between the Domino server and the IBM Storage Protect API. Increasing the number or size (or both) of the data buffers can improve throughput.

You can specify 2 - 8 buffers. The default value is 3. The size of the buffers can be 64 - 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.

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, use the /logfile parameter to specify a different log file for each instance. Logging is collected 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 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. 60 days 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 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.
/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. In this case, you can specify whether Data Protection for IBM Domino waits for the media mount or stops the current operation. Removable media is media such as tapes.
You can specify:
Yes
Wait for tape mounts. This value is the default.
No
Do not wait for tape mounts.

Example

This example shows a backup of all databases that are changed. Changes to any database IDs for logged databases, and data changes for non-logged databases are backed up. This example shows deactivated database backups that refer to databases that no longer exist on the Domino server, or ones that are excluded.
domdsmc incremental * /subdir=yes
Output example:
Starting Domino database backup...
Initializing Domino connection...
Querying Domino for a list of databases, please wait...
Querying Domino for a list of databases, please wait...

Backing up database mail\hvargas.nsf, 1 of 1.
Full: 0 		Read: 25,690,112 		Written: 8,379,837 		Rate: 2,707.06 Kb/Sec
Backup of mail\hvargas.nsf 		completed successfully.


Total Domino databases inspected: 			1
Total Domino databases backed up: 			1
Total Domino databases excluded:			0
Total Domino backup objects expired:	 		0
Total Domino databases deduplicated: 			1

Throughput rate:			2,678.70 Kb/Sec
Total bytes inspected:			25,690,112
Total bytes transferred:		8,379,837
Total LanFree bytes transferred:		0
Total bytes before deduplication:	25,690,112
Total bytes after deduplication: 		16,359,696
Data compressed by:				49%
Deduplication reduction:		36.32%
Total data reduction ratio:		67.39%
Elapsed processing time:		3.06 Secs