Restorefiles optional parameters

Edit online

The optional parameters for the restorefiles command and positional parameters are listed.

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

The configfilename variable can include a full path. If the configfilename variable does not include a path, the IBM Storage Protect Snapshot 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 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.
/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.

/INTO=path
Use the /INTO parameter to specify the root directory where files are to be restored. The restorefiles operation creates a subdirectory under the root directory that contains the name of the database. Restored files are placed in that subdirectory. If the /INTO parameter is not specified, the files are restored into the directory where the restorefiles command is issued. The /into parameter can be a directory on any mounted local disk. It is not possible to use a mapped network drive as a restore destination.
/LOGFile=logfilename
Use the /LOGFile parameter to specify the name of the activity log file that is generated by IBM Storage Protect Snapshot 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 IBM Storage Protect Snapshot 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 the /LOGFile parameter is not specified, 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 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.
/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
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 for Exchange Server.

Use the IBM Storage Protect Snapshot for Exchange Server query tsm * /all command to view the names of the backup objects.

/Quiet
This parameter prevents status information from being displayed. The level of information that is written to the activity log is not affected.
/FCMOPTFile=dsm.opt filename
Use the tsmoptfilename variable to identify the IBM Storage Protect Snapshot for Exchange Server options file.

The file name can include a fully qualified path name. If no path is specified, the directory where IBM Storage Protect Snapshot for Exchange Server is installed is searched.

If the tsmoptfilename variable includes spaces, enclose the entire dsm.opt filename parameter entry in double quotation marks. For example: 
/fcmoptfile="c:\Program Files\file.opt"

The default is dsm.opt.