Restore optional parameters

Optional parameters follow the restore command and positional parameters.

/BACKUPDESTination=TSM|LOCAL

Use the /BACKUPDESTination parameter to specify the location from where the backup is to be restored. The default is the value (if present) specified in the Data Protection for Exchange Server preferences file (tdpexc.cfg). If no value is present, the backup is restored from Tivoli® Storage Manager server storage.

You can specify:

TSM: The backup is restored from Tivoli Storage Manager server storage. TSM is the default value.
LOCAL: The backup is restored from the local shadow volumes.

/CONFIGfile=configfilename

Use the /CONFIGfile parameter to specify the name of the Data Protection for Exchange Server configuration file that contains the values for the Data Protection for Exchange Server configuration options.

The configfilename variable can include a fully qualified path. If the configfilename variable does not include a path, the Data Protection for Exchange Server installation directory is used. If the /CONFIGfile parameter is not specified, or if the configfilename variable is not specified, the default value is tdpexc.cfg.

If the configfilename variable includes spaces, enclose the entire /CONFIGfile parameter entry in double quotation marks. For example:

/CONFIGfile="c:\Program Files\file.cfg"

/DAGNODe=nodename

Specify the node name that you want to use to back up the databases in an Exchange Server Database Availability Group. With this setting, backups from all Database Availability Group members that are configured to use the DAG node are backed up to a common file space on the Tivoli Storage Manager server. The database copies are managed as a single entity, regardless of which Database Availability Group member they are backed up from. This setting can prevent FlashCopy® Manager for Microsoft Exchange Server from making too many backups of the same database.

/ERASEexistinglogs=YES|NO

Use the /ERASEexistinglogs parameter to erase the existing transaction log files for the database that is being restored before you restore the specified databases. If you do not erase existing data, existing transaction logs can be reapplied when the Exchange databases are mounted. This parameter is valid only when you restore a VSS FULL or VSS COPY backup of Exchange Server databases.

/FROMEXCSERVer=server-name

Use the /FROMEXCSERVer parameter to specify the name of the Exchange Server where the original backup was done.

The default is the local Exchange Server. However, you must specify the name if the Exchange Server is not the default.

If a DAG node is specified by using the /dagnode parameter, Data Protection for Exchange Server uses this node name instead of the Data Protection for Exchange Server node to back up databases in an Exchange Server Database Availability Group. Therefore, the restore command automatically restores the backups that were created by the other DAG members, without having to specify the /fromexcserver parameter.

/INSTANTREStore=YES|NO

Use the /INSTANTREStore parameter to specify whether to use volume level snapshot or file level copy to restore a VSS backup on local shadow volumes. A SAN Volume Controller, Storwize® V7000, or IBM System Storage DS8000® series storage system is required to perform VSS instant restore operations.

You can specify:

YES: Use volume level snapshot restore for a VSS backup on local shadow volumes if the backup exists on volumes that support it. YES is the default.
NO: Use file level copy to restore the files from a VSS backup on local shadow volumes. Bypassing volume-level copy means that Exchange database files, log files, and the checkpoint file are the only data overwritten on the source volumes.

When you run VSS instant restore operations, you must make sure that any previous background copies (that involve the volumes that are being restored) are completed before initiating the VSS instant restore. The /INSTANTREStore parameter is ignored and VSS instant restore capabilities are automatically disabled when doing any type of VSS restore into operation.

When you run a VSS instant restore in a Database Availability Group (DAG) environment, do not choose the option that automatically mounts the databases after the recovery is completed. As described in the Database Availability Group considerations section, to run the VSS instant restore for databases in a DAG environment, you must stop the Microsoft Exchange Replication service before doing the VSS instant restore or the restore fails. In this case, after the VSS instant restore is completed, start the Microsoft Exchange Replication service and then finally mount the database.

/INTODB=into-db-name

Use the /INTODB parameter to specify the name of the Exchange Server database into which the VSS backup is restored. The database name must be specified with the into-db-name variable. For example, if RDB is the name of the database into which the VSS backup is restored, the command-line entry would be as follows:

TDPEXCC RESTore Maildb1 FULL /INTODB=RDB

However, when you restore a database that is relocated (system file path, log file path, or database file path), you must specify the same database name as the one you are restoring. For example, if Maildb1 is the name of the relocated database that is being restored, the command-line entry would be as follows:

TDPEXCC RESTore Maildb1 FULL /INTODB=Maildb1

Considerations:

There is no default value.
To restore into a Recovery Database (RDB) or alternate database, an RDB or alternate database must exist before you attempt the restore operation.

/LOGFile=logfilename

Use the /LOGFile parameter to specify the name of the activity log file that is generated by Data Protection for Exchange Server.

The logfilename variable identifies the name of the activity log file.

If the specified log file does not exist, a new log file is created. If the specified log file exists, new log entries are appended to the file. The logfilename variable can include a fully qualified path. However, if no path is specified, the log file is written to the Data Protection for Exchange Server installation directory.

If the logfilename variable includes spaces, enclose the entire /LOGFile parameter entry in double quotation marks. For example:

/LOGFile="c:\Program Files\mytdpexchange.log"

If you do not specify the /LOGFile parameter, log records are written to the default log file, tdpexc.log.

The /LOGFile parameter cannot be turned off, logging always occurs.

When you using multiple simultaneous instances of Data Protection for Exchange Server to perform operations, use the /LOGFile parameter to specify a different log file for each instance used. This function 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=numdays|No

Use the /LOGPrune parameter to disable log pruning or to explicitly request to prune the log for one command run. By default, log pruning is enabled and done once per day. The numdays variable represents the number of days to save log entries. By default, 60 days of log entries are saved in the pruning process. You can use the Data Protection for Exchange Server GUI or the set command to change the defaults so that log pruning is disabled, or so that more or less days of log entries are saved. If you use the command line, you can use the /LOGPrune parameter to override these defaults. When the value of the /LOGPrune variable numdays is a number in the range 0 to 9999, the log is pruned even if log pruning is already done for the day.

Changes to the value of the TIMEformat or DATEformat parameter can result in prunning the log unintentionally. If the value of the TIMEformat or DATEformat parameter is changed, before you issue a Data Protection for Exchange Server command that might prune the log file, do one of the following actions to prevent the log file from being pruned:

Make a copy of the existing log file.
Specify a new log file with the /logfile parameter or logfile setting.

/MOUNTDAtabases=No|Yes

Use the /MOUNTDAtabases parameter to specify whether to mount the databases after the restore operation is completed. Specify one of the following values:

Yes: Mount the databases after the restore operation is completed.
No: Do not mount the databases after the restore operation is completed. No is the default.

/MOUNTWait=Yes|No

Use the /MOUNTWait parameter to specify whether Data Protection for Exchange Server is to wait for removable media to mount (such as tapes or CDs) or to stop the current operation. This situation occurs when the Tivoli Storage Manager server is configured to store backup data on removable media and waits for a required storage volume to be mounted.

You can specify:

Yes: Wait for tape mounts. This option is the default.
No: Do not wait for tape mounts.

/OBJect=object-name

Use the /OBJect parameter to specify the name of the backup object you want to restore. The object name uniquely identifies each backup object and is created by Data Protection for Exchange Server.

Use the Data Protection for Exchange Server query tsm command to view the names of the backup objects.

If the tdpexcc restore dbname incr command is entered (without the /OBJect parameter) to restore multiple active incremental backups, all multiple active incremental backups are restored sequentially. The /OBJect parameter is used to restore only one incremental backup at a time.

/Quiet

This parameter prevents status information from being displayed. The level of information that is written to the activity log is not affected.

/RECOVER=APPLYRESToredlogs|APPLYALLlogs

Use this parameter to specify whether or not you want to run recovery after you restore an object. This parameter is specified on the last backup object restored. To initiate recovery, use the /RECOVER parameter when you restore the last backup object. In addition, the value of /TEMPLOGRESTorepath is not to be the same value as the current location. If the value is the same, the database can become corrupted. Failure to use the /RECOVER parameter when you restore the last backup set leaves the databases unmountable. If this situation occurs, you can either restore the last backup again and specify the /RECOVER=value option or you can use the Microsoft ESEUTIL /cc command to run recovery manually.

Specify one of the following values when you use this parameter:

APPLYALLlogs: Specify /recover=applyalllogs to replay the restored-transaction log entries AND the current active-transaction log entries. Any transaction logs entries that are displayed in the current active-transaction log are replayed. This option is the default.
APPLYRESToredlogs: Specify /recover=applyrestoredlogs to replay only the restored-transaction log entries. The current active-transaction log entries are not replayed.
When you choose this option for a restore, your next backup must be a full or copy backup.

Considerations:

When you restore multiple backup objects, the /RECOVER option is to be used on the restore of the last object.
If you specify /RECOVER=APPLYRESToredlogs when doing a restore, the next backup must be a full backup.

/TEMPLOGRESTorepath=path-name

Use the /TEMPLOGRESTorepath parameter to specify the default temporary path to use when you are restoring logs and patch files. For best performance, this logger is to be on a different physical device than the current active-transaction logger.

If you do not specify the /TEMPLOGRESTorepath parameter, the default value is the value that is specified by the /TEMPLOGRESTorepath option in the Data Protection for Exchange Server configuration file. The default Data Protection for Exchange Server configuration file is tdpexc.cfg.

If you do not specify the /TEMPLOGRESTorepath parameter, and the /TEMPLOGRESTorepath value does not exist in the Data Protection for Exchange Server configuration file, the TEMP environment variable value is used.

When you run a FULL or COPY restore operation, all log files in the path that is specified by the /TEMPLOGRESTorepath parameter are erased.

In addition, the value of /TEMPLOGRESTorepath is not to be the same value as the current location. If the value is the same, the database can become corrupted.

Do not specify double-byte characters (DBCS) within the temporary log path.

/TSMNODe=tsmnodename

Use the tsmnodename variable to refer to the Tivoli Storage Manager node name that Data Protection for Exchange Server uses to log on to the Tivoli Storage Manager server.

You can store the node name in the Tivoli Storage Manager options file (dsm.opt). This parameter overrides the value in the Tivoli Storage Manager options file if PASSWORDACCESS is set to PROMPT. This parameter is not valid when PASSWORDACCESS is set to GENERATE in the options file.

/TSMOPTFile=tsmoptfilename

Use the tsmoptfilename variable to identify the Data Protection for Exchange Server options file.

The file name can include a fully qualified path name. If no path is specified, the directory where Data Protection for Exchange Server is installed is searched.

If the tsmoptfilename variable includes spaces, enclose the entire /TSMOPTFile parameter entry in double quotation marks. For example:

/TSMOPTFile="c:\Program Files\file.opt"

The default is dsm.opt.

/TSMPassword=tsmpassword

Use the tsmpassword variable to refer to the Tivoli Storage Manager password that Data Protection for Exchange Server uses to log on to the Tivoli Storage Manager server.

If you specified PASSWORDACCESS GENERATE in the Data Protection for Exchange Server options file (dsm.opt), supplying the password here is not necessary because the one that is stored in the registry is used. However, to store the password in the registry, you must specify the Tivoli Storage Manager password the first time Data Protection for Exchange Server connects to the Tivoli Storage Manager server.

If you do specify a password with this parameter when PASSWORDACCESS GENERATE is in effect, the command-line value is ignored unless the password for this node is not yet stored in the registry. In that case, the specified password is stored in the registry and used when you run this command.

If PASSWORDACCESS PROMPT is in effect, and you do not specify a password value on the command line, then you are prompted for a password.

The Tivoli Storage Manager password that Data Protection for Exchange Server uses to log on to the Tivoli Storage Manager server can be up to 63 characters in length.