Restorefiles optional parameters

Optional parameters for the Data Protection for SQL restorefiles command and optional parameters.

/BACKUPDESTINATION

VSS backups that are located on the Tivoli® Storage Manager server are restored using the restorefiles command with /BACKUPDESTINATION=TSM. VSS backups that are running on a local machine using a persistent snapshot are restored using the restorefiles command with /BACKUPDESTINATION=LOCAL. TSM is the default destination for restorefiles.

/CONFIGfile=configfilename

Use the /configfile parameter to specify the name of the Data Protection for SQL Server configuration file that contains the values for the Data Protection for SQL 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 SQL Server installation directory is used. If the /configfile parameter is not specified, or if the configfilename variable is not specified, the default value is tdpsql.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"

/FROMSQLserver=sqlservername

Use the /fromsqlserver parameter to specify the name of the SQL Server where the original backup was performed. The default is the local SQL Server name.

/LOGFile=logfilename

Use the /logfile parameter to specify the name of the activity log file that is generated by Data Protection for SQL 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 SQL 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\mytdpsqlserver.log"

If the /logfile parameter is not specified, log records are written to the default log file, tdpsqlserver.log.

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

When using multiple simultaneous instances of Data Protection for SQL Server to perform 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=numdays|No

Use the /logprune parameter to disable log pruning or to explicitly request that the log be pruned for one command run. By default, log pruning is enabled and performed 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 Management Console (MMC) 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 has already been performed for the day.

Changes to the value of the timeformat or dateformat parameter can result in the log file being pruned unintentionally. If the value of the timeformat or dateformat parameter has changed, prior to issuing a Data Protection for SQL Server command that might prune the log file, perform 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.

/MOUNTWait=Yes|No

This parameter is not valid for all backup types; does not work with DIFFFULL or LOG backup types. The /mountwait parameter is used to specify whether Data Protection for SQL Server should 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 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 files that you want to restore. The object name uniquely identifies each backup object and is created by Data Protection for SQL Server.

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

/Quiet

This parameter prevents status information from being displayed. This does not affect the level of information written to the activity log.

/RELOCATEDir=dbfiledir[ ,logfiledir [ ,otherfiledir] [ ,filestream files]]

The /relocatedir parameter specifies the destination locations in which to restore the flat files. This includes databases, logs, and FILESTREAM files.

The dbfiledir variable specifies the directory location of the SQL database you want to relocate. Note that if the logfiledir or otherfiledir variables are not specified, the logs and SQL Server full-text index files are restored to the directory specified by dbfiledir.

The logfiledir variable specifies the directory location of the SQL log files you want to relocate. Note that if the logfiledir variable is not specified, the SQL log files are restored to the directory specified by dbfiledir.

The otherfiledir variable specifies the directory location of the SQL Server full-text index files you want to relocate. Note that if the otherfiledir variable is not specified, the SQL Server full-text index files are restored to the directory specified by dbfiledir.

The restorefiles operation creates a subdirectory under the root directory that contains the name of the database name. Restored files are placed in that subdirectory. If the /relocatedir parameter is not specified, the files will be restored into the directory where the restorefiles command is issued. For example, if Data Protection for SQL Server is installed in the c:\Program Files\Tivoli\TSM\TDPSQLC directory and the following command is issued from E:\Somedir:

e:\Somedir> c:\"Program Files"\Tivoli\TSM\TDPSQLC\tdpsqlc restorefiles 
db1 full

Then, the files are restored to the subdirectories in the e:\Somedir location:

e:\Somedir\db1\db1.mdf
e:\Somedir\db1\db1.ldf

/TSMNODe=tsmnodename

Use the tsmnodename variable to refer to the Tivoli Storage Manager node name that Data Protection for SQL 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 SQL Server options file.

The file name can include a fully qualified path name. If no path is specified, the directory where Data Protection for SQL 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 SQL Server uses to log on to the Tivoli Storage Manager server. If you specified PASSWORDACCESS GENERATE in the Data Protection for SQL Server options file (dsm.opt), you do not need to supply the password here 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 SQL 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 has not yet been 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 SQL Server uses to log on to the Tivoli Storage Manager server can be up to 63 characters in length.