Restorefiles optional parameters

Edit online

Optional parameters follow the restorefiles command and positional parameters.

/BACKUPDESTINATION
VSS backups that are on the IBM Storage Protect server are restored by using the restorefiles command with /BACKUPDESTINATION=TSM. VSS backups that are running on a local system that uses a persistent snapshot are restored by 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 IBM Storage Protect Snapshot configuration file that contains the values for the IBM Storage Protect Snapshot 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 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 completed. The default is the local SQL Server name. To restore availability databases, specify the AlwaysOn Availability group.
/LOGFile=logfilename
Use the /logfile parameter to specify the name of the activity log file that is generated by IBM Storage Protect Snapshot.

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 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 you use multiple simultaneous instances of IBM Storage Protect Snapshot 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.
/MOUNTWait=Yes | No
The /MOUNTWait parameter is used to specify whether IBM Storage Protect Snapshot waits for removable media to mount, such as tapes or CDs, or stops the operation. This situation occurs when the IBM Storage Protect Snapshot is configured to store backup data on removable media and waits for a required storage volume to be mounted. This parameter is not valid for all backup types; the parameter does not work with DIFFFULL or LOG backup types.
You can specify these options:
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 files that you want to restore. The object name uniquely identifies each backup object and is created by IBM Storage Protect Snapshot.

Use the IBM Storage Protect Snapshot query tsm command to view the names of the backup objects.

/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.
/RELOCATEDir=dbfiledir[,logfiledir [,otherfiledir] [,filestream files]]

The /relocatedir parameter specifies the destination locations in which to restore the flat files. This restore includes databases, logs, and FILESTREAM files. It is not possible to use a mapped network drive as a destination directory.

The dbfiledir variable specifies the directory location of the SQL database you want to relocate. 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. 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. 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 are restored into the directory where the restorefiles command is issued. For example, if IBM Storage Protect Snapshot 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 IBM Storage Protect node name that IBM Storage Protect Snapshot uses to log on. You can store the node name in the IBM Storage Protect options file (dsm.opt). This parameter overrides the value in the IBM Storage Protect 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 IBM Storage Protect Snapshot options file.

The file name can include a fully qualified path name. If no path is specified, the directory where IBM Storage Protect Snapshot 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 password that IBM Storage Protect Snapshot uses to log on to IBM Storage Protect. If you specified PASSWORDACCESS GENERATE in the options file (dsm.opt), supplying the password is not necessary because the one that is stored in the registry is used. Store the password in the registry by specifying the IBM Storage Protect password for the first connection.

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 password can be up to 63 characters in length.