Restore optional parameters

Edit online

Optional parameters follow the restore command and positional parameters.

/CONFIGfile=configfilename
Use the /CONFIGfile parameter to specify the name of the IBM Storage Protect Snapshot for Microsoft Exchange Server configuration file that contains the values for the IBM Storage Protect Snapshot for Microsoft Exchange Server configuration options.

The configfilename variable can include a fully qualified path. If the configfilename variable does not include a path, the IBM Storage Protect Snapshot for Microsoft 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 IBM Storage Protect 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 IBM Storage Protect Snapshot for Microsoft Exchange Server from making too many backups of the same database.
/EXCLUDEDUMPster=dsmoptfilename
/FCMOPTFile=dsmoptfilename
The /FCMOPTFile parameter specifies the IBM Storage Protect Snapshot options file to use.
  • The dsmoptfilename variable can include a fully qualified path. If you do not include a path, the IBM Storage Protect Snapshot installation directory is used.
  • If the dsmoptfilename variable spaces, enclose it in double quotation marks.
  • If you do not specify /FCMOPTFile, the default value is dsm.opt.
  • If you specify /FCMOPTFile but not dsmoptfilename, the default is also dsm.opt.
/FROMEXCSERVer=server-name
Use the /fromexcserver parameter to specify the name of the Exchange Server where the original backup was processed.

The default is the local Exchange Server.

If a DAG node is specified by using the dagnode parameter, IBM Storage Protect Snapshot for Microsoft Exchange Server uses this node name instead of the IBM Storage Protect Snapshot for Microsoft Exchange Server node to back up databases in an Exchange Server Database Availability Group. Therefore, the delete command automatically deletes the backups that are 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 that is on local shadow volumes. The default value is Yes. An IBM® Systems Storage SAN Volume Controller, DS8000®, the XIV® system, and IBM Storwize® V7000 storage system is required to complete VSS instant restore operations.
You can specify:
Yes
Use volume level snapshot restore for a VSS backup that is on local shadow volumes if the backup exists on volumes that support it. This option is the default.
No
Use file level copy to restore the files from a VSS backup that is on local shadow volumes. Bypassing volume-level copy means that Exchange database files, log files, and the checkpoint file are overwritten on the source volumes.

When a VSS instant restore is completed on DS8000 and Storwize family, make sure that any previous background copies (that involve the volumes that are being restored) are completed before you initiate the VSS instant restore operation. The /instantrestore parameter is ignored and VSS instant restore capabilities are automatically disabled when it runs any type of VSS restore into operation. VSS instant restore of differential and incremental backups is not supported.

/INTODB=db-name
Use the /INTODB parameter to specify the name of the database into which the VSS backup is restored. The database name must be specified with the db-name variable. For example, if RDB is the name of the database into which the VSS backup is restored, the input on the command line is 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 Maildb5 is the name of the relocated database that is being restored, the command-line entry is as follows: 
TDPEXCC RESTore Maildb5 FULL /INTODB=Maildb5
  • 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 IBM Storage Protect Snapshot for Microsoft 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 IBM Storage Protect Snapshot for Microsoft 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 use multiple simultaneous instances of IBM Storage Protect Snapshot for Microsoft Exchange Server to run 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

When you prune log data, you can discard some of the generated logs according to detailed filtering criteria that you set. Depending on the option that you set for the /LOGPrune parameter, a certain number of days of data are saved. By default, 60 days of log entries are saved. The option No can be entered to disable log pruning.

Regardless of the option that you set for this parameter, you can explicitly request log pruning at any time.

Considerations:
  • For numdays, the range is 0 to 9999. A value of 0 deletes all entries in the activity log file except for the current command entries.
  • If you specify no, the log file is not pruned.
  • If you do not specify /LOGPrune, the default value is that specified by the logprune configurable option in the configuration file. The default value is 60.
  • If you specify /LOGPrune, its value is used instead of the value that is stored in the configuration file. Specifying this parameter does not change the value in the configuration file.
  • You can specify /LOGPrune without specifying numdays or no; in this case, the default value, 60, is used.
  • Changes to the value of the TIMEformat or DATEformat parameter can result in an unwanted pruning of the log file. If you are running a command that might prune the log file, and the value of the TIMEformat or DATEformat parameter is changed, complete one of the following to prevent unintentional 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.
/MOUNTDAtabases=No|Yes
Use the /mountdatabases parameter to specify whether to mount the databases after the restore operation is completed. You must 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. This option is the default.
/MOUNTWait=Yes | No
Use the /mountwait parameter to specify whether IBM Storage Protect Snapshot for Microsoft Exchange Server waits for removable media to mount (such as tapes or CDs) or to stop the current operation. This situation occurs when the is configured to store backup data on removable media and waits for a required storage volume to be mounted.
You can specify these options:
Yes
IBM Storage Protect Snapshot for Microsoft Exchange Server waits until all initial volumes of any required removable media are made available to the IBM Storage Protect server before it completes the command. This option is the default.
No
IBM Storage Protect Snapshot for Microsoft Exchange Server ends the command (if removable media are required). An error message is displayed.
/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 IBM Storage Protect Snapshot for Microsoft Exchange Server.
Use the IBM Storage Protect Snapshot for Microsoft Exchange Server 
query fcm
                        /all
command to view the names of active and inactive 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. This function does not affect the level of information that is written to the activity log.
/RECOVER=APPLYRESToredlogs|APPLYALLlogs
Use this parameter to specify whether you want to run recovery after you restore an object. If the database is not mountable, 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.
You must 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 display 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.
When you restore multiple backup objects, the /RECOVER option must be used on the restore of the last object.
/TEMPLOGRESTorepath=path-name
Use the /TEMPLOGRESTorepath parameter to specify the default temporary path to use when logs and patch files are restored. For best performance, this path must 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 IBM Storage Protect Snapshot for Microsoft Exchange Server configuration file. The default IBM Storage Protect Snapshot for Microsoft Exchange Server configuration file is tdpexc.cfg.

If you do not specify the /TEMPLOGRESTorepath parameter, and the /TEMPLOGRESTorepath value does not exist in the IBM Storage Protect Snapshot for Microsoft Exchange Server configuration file, the TEMP environment variable value is used.

When you do 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 must not be the same value as the current location for the database. If the value is the same, the database can become corrupted.

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