Domdsmc query dbbackup

Purpose

This command displays a list of database backups that are stored on the IBM Storage Protect server that match the dbname pattern. Active and inactive objects can be displayed. By default, only the active backup objects are displayed. To include inactive backup versions in the list, use the /inactive parameter.

The following information is provided:

• Database title.
• Database relative path name.
• Database size.
• Database backup date and time.
• Domino server name.
• Whether the backup is active or inactive.
• Whether the database is logged or not.
• Whether the database is encrypted.
• Whether the database is compressed.
• Whether the database is deduplicated.

>>-DOMDSMC--Query--DBBackup--+-"*"----+------------------------->
                             '-dbname-'   

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

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

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

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

>--+--------------------+--+-----------------------------+------>
   |             .-60-. |  |           .-currentserver-. |   
   '-/LOGPRUne=--+-n--+-'  '-/SERVer=--+-servername----+-'   
                 '-No-'                                      

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

Parameters

"*"|dbname

Specifies the file path of a database or file path pattern. The file path pattern can represent a group of databases. You can also specify a group of databases by using the wildcard character asterisk (*).

If you specify the wildcard character in the dbname, you must use double or single quotation marks, for example, "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. For example:

   domdsmc query dbbackup "abc*"

This example lists all databases that begin with the characters abc. When used with the /subdir parameter, all databases within all subdirectories are listed.

/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:

• 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.

/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.

/DEtail

Displays information about the backup, such as whether it is encrypted, compressed, or deduplicated.

/INACTive

Specifies that both active and inactive backup objects are displayed. The default is to display only the active backup objects.

/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 done daily. 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 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.

/SERVer=currentserver|servername

Specifies the Domino server name. If not specified, Data Protection for HCL Domino uses the current Domino server.

/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. No is the default unless it is 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.