Domdsmc selective

How to use the domdsmc selective command is described.

Purpose

The domdsmc selective parameter backs up the databases you specify. You can exclude databases from backup with the exclude statement in the include-exclude options file. This command does not do comparisons of attributes with the active backup images as does the incremental command. It backs up all databases that match the dbname pattern and passes the include-exclude filter.

>>-DOMDSMC--Selective--+-"*"--------+--------------------------->
                       | .-,------. |   
                       | V        | |   
                       '---dbname-+-'   

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

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

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

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

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

>--+----------------------------+--+-------------+-------------->
   |            .-domdsm.log--. |  '-/LOGGedonly-'   
   '-/LOGFile=--+-logfilename-+-'                    

>--+--------------------+--+----------------------+------------->
   |             .-60-. |  |              .-Yes-. |   
   '-/LOGPRUne=--+-n--+-'  '-/MOUNTWait=--+-No--+-'   
                 '-No-'                               

>--+--------+--+-----------------------------+------------------>
   '-/Quiet-'  |             .-1-----------. |   
               '-/SESSIONS=--+-numsessions-+-'   

>--+-------------------+---------------------------------------><
   |           .-No--. |   
   '-/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 restored from the IBM Storage Protect server. The wildcard character asterisk (*) is used to specify a group of databases when used in the dbname. Multiple dbnames can be specified when they are separated with commas.

If you specify the wildcard character in the dbname, you must use double or single quotation marks, for example, "abc*" or 'abc*'.

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 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, 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 selective "dir_A/ter*"

The following example backs up all databases on the server:

   domdsmc selective "*" /subdir=yes

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

   domdsmc selective "*acct.n*" /subdir=yes
Note: Standard include and exclude processing applies to Domino database names. Specific databases can be excluded from the backup with the include-exclude list in the IBM Storage Protect include-exclude options file. Wildcards can be used on the backup command. 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 symbolics and not the physical file path. For more information on include and exclude options, see Include and exclude processing and IBM Storage Protect for UNIX and Linux Backup-Archive Clients Installation and User's Guide.
/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. Note the following considerations:
  • 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 works in the same way 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 are using 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 passwordaccessgenerate 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 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 from 2 to 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.

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.

/LOGGedonly
Specifies that only logged databases that match the dbname pattern must be backed up. This option is used to force periodic refreshes of the backup for logged databases. Without a refresh, the databases are not backed up by the Incremental command on a Domino server when archival logging is in effect.
/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 HCL 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.
/Quiet
Specifies that status information does not display. However, the information is written to the activity log.
/SESSions=numsessions|1
Specifies the number of IBM Storage Protect server sessions to be used by Data Protection for HCL Domino. You can specify 1 - 64 sessions. The default value is 1.
/SUBDir=No|Yes
Specifies whether subdirectories within the specified file path are searched for databases that match the file pattern. If this option is not specified, Data Protection for HCL Domino uses the value of the /subdir parameter in the Data Protection for HCL Domino preferences file.

You can specify:

No
Do not search the subdirectories within the specified file path for databases that match the file pattern. This value is the default unless reset in the Data Protection for HCL Domino preferences file.
Yes
Search the subdirectories within the specified file path for databases that match the file pattern.

Examples

Example 1: The following example backs up all databases that are contained in the a_dir directory and its subdirectories:

domdsmc selective "a_dir/*" /subdir=yes

Output example:

Starting Domino database backup...
Initializing Domino connection...
Querying Domino for a list of databases, please wait...

Backing up database a_dir/b_dir/clienttest2.nsf, 1 of 4.
Full: 0 	Read: 41,418,752 	Written: 41,418,752 	Rate: 25,327.49 Kb/Sec
Backup of a_dir/b_dir/clienttest2.nsf completed successfully.

Backing up database a_dir/clienttest.nsf, 2 of 4.
Full: 0 	Read: 41,418,752 	Written: 41,418,752 	Rate: 30,140.09 Kb/Sec
Backup of a_dir/clienttest.nsf completed successfully.

Backing up database a_dir/test.nsf, 3 of 4.
Full: 0 	Read: 16,252,928 	Written: 16,252,928 	Rate: 26,765.60 Kb/Sec
Backup of a_dir/test.nsf completed successfully.

Backing up database a_dir/testdb2.nsf, 4 of 4.
Full: 0 	Read: 29,622,272 	Written: 29,622,272 	Rate: 27,682.30 Kb/Sec
Backup of a_dir/testdb2.nsf completed successfully.


Total Domino databases inspected:			4
Total Domino databases backed up:			4
Total Domino databases excluded:			0
Total Domino databases deduplicated:			0

Throughput rate:		26,852.38 Kb/Sec
Total bytes inspected:			128,712,704
Total bytes transferred:		128,712,704
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:		4.68 Secs

Example 2: The following example backs up all databases by including subdirectories:

domdsmc selective "*" /subdir=yes