Domdsmc restore

Purpose

Running the domdsmc restore command restores a single database or a group of databases from IBM Storage Protect storage to the Domino® server. If you are planning to apply transaction logs to the restored databases to get a more current state, use the /activate=no parameter. You can apply transaction logs by running the activatedbs command.

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.

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

Symbolic links are referred to by their symbolic names. For example, if mydata.dir is a directory link in the Notes data directory that points to x:\data, database mydb.nsf in the x:\data directory would be named mydata\mydb.nsf. The physical file path for the relative name is resolved according to the symbolic values at the time of the restore.

If a symbolic link used in the name of a database backup image does not exist, the restore must be done with the /into parameter. This parameter specifies where the database is placed.

The wildcard character (*) can be used in the file name portion of the file path. The wildcard character is not supported within directory names. The * is used to represent any number of any characters. For example, the following command restores the active backup of all databases that begin with the characters ter:

   domdsmc restore ter*

For example, the following command lists all active database backups on the IBM Storage Protect server so that you can select which ones you want to restore:

   domdsmc restore * /pick

Note: The value of the /subdir parameter determines whether only the specified directory or all subdirectories are searched for databases that match the file pattern.

There is no default for dbname.

/ACTIVate=No|Yes

Specifies whether the databases that are being restored are to be brought online. If the restored database is to be rolled forward to a more current state by applying transaction logs, then /activate=no must be specified so that transaction logs can be applied with the activatedbs command.

Because there is a single transaction log for all logged databases, all databases must be activated together by running one command. This prevents the fetching of the same transaction logs multiple times from the IBM Storage Protect server. The databases can be restored separately by specifying /activate=no. The databases can then be activated together with a single activatedbs command.

If the /activate parameter is not specified, /activate=no is the default value.

No

Do not activate the database. This value is the default.

Yes

Activate the database.

/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 IBM Storage Protect 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 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.

/INTO=filepath

Specifies the file path and file name to be used for the restored database. The file path that is specified must be relative to the Notes data directory or can be a fully qualified physical path. If a relative file path is specified, symbolic names can be included when the symbolic links exist to resolve the names. The specified path is considered a physical file path if it begins with a directory delimiter or a drive letter that is followed by a colon.

If multiple databases are being restored at one time, the file name must be specified as a pattern with a single equal sign, =, represents the entire file name and extension of the database backup. For example, the following command restores all backups from the vola directory into the tempvol directory with the same file names:

  domdsmc restore vola\* /into=tempvol\=

For example, the following command restores all backups from the vola directory into the vola directory with the file names from the backup version that is prefixed with a t:

   domdsmc restore vola\* /into=vola\t=

If you entered domdsmc restore vola\* /into=vola\=xyz /activate=yes, xyz is appended to the database suffix. For example, a database that is called abc.nsf is restored as abc.nsfxyz.

If you restore without running activatedbs, .dad is appended to the suffix of the database name. When you run activatedbs or select the ACTIVATE tab on the GUI, the .dad append is removed from the suffix of the database name.

If multiple databases in a subdirectory branch are being restored and you must preserve the directory structure, the file name must be specified as a pattern with two equal signs, ==, representing the filepath of the database backup. For example, the following command restores all backups from the vola directory and its subdirectories into the tempvol directory with the same file names and directory structure. The == is replaced by the full relative path for each database file that is restored, including the vola directory:

  domdsmc restore vola\* /subdir=yes /into=tempvol\==

Note:

• When the /into parameter is used with the restore command, replication is disabled for the restored databases.
• If the /into parameter is not used, replication settings remain as they were in the backup version that is restored.

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

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

/PICk=SHOWACtive|SHOWALl

Displays a list of database backups that match the dbname pattern that can be selected for restore. The pick list is displayed as a scrollable list from which you can select the database backups for restore.

You can specify:

SHOWACtive

Displays a list of active database backup versions.

SHOWALl

Displays a list of both active and inactive database backup versions. All the backup versions that match the dbname pattern are shown.

/PIT=currentdate,currenttime|date,time

Specifies a point in time when the specified databases are restored. The date and time values must be specified in the same date and time format that is defined in the Data Protection for HCL Domino preferences file. The most recent database backup images that are taken before the specified point in time are restored. Deleted backup images are not restored. Logged databases can then be rolled forward to that point by specifying the same date and time values on the /applylogs option of the activatedbs command.

date

Specify a date string in the active date format. If you do not specify a date, the specified databases are restored unless the /pick parameter was used to select inactive backup versions.

The date must be specified with the same date format that is defined in the Data Protection for HCL Domino preferences file. See Domdsmc set for a list of available date formats.

time

Specify a time string in the active time format. If you specify a date without the time, HH:MM:SS on a 24-hour clock is used.

The time must be specified with the same time format that is defined in the Data Protection for HCL Domino preferences file. See Domdsmc set for a list of available time formats.

Note: If this parameter is used with the /pick parameter, the showactive and showall variables for the /pick parameter are ignored. The pick list contains the database backup images that meet the /PIT criteria.

/Quiet

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

/REPlace=Yes|No

Specifies whether to replace existing databases on the target system.

You can specify:

Yes

Allows an existing database on the target system to be replaced during the restore process.

No

Prevents an existing database on the target system from being overwritten during the restore process.

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