Restorefiles optional parameters

Edit online

Optional parameters follow the restorefiles command and positional parameters.

/BACKUPDESTINATION
VSS backups can have a backup destination of TSM or LOCAL.
/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 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 done. The default is the local Exchange Server name.

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.

/INTO=pathname
Use the /into parameter to specify the root directory where files must 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 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 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 Data Protection for Exchange Server to run operations, use the /logfile parameter to specify a different log file for each instance used. This parameter 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 Data Protection for Exchange Server waits for removable media to mount (such as tapes or CDs) or to stop the current operation. This situation occurs when the IBM Storage Protect 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 files that 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.

/Quiet
This parameter prevents status information from being displayed. The level of information that is written to the activity log is not affected.
/TSMNODe=tsmnodename
Use the tsmnodename variable to refer to the IBM Storage Protect node name that Data Protection for Exchange Server uses to log on to the IBM Storage Protect server.

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 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 IBM Storage Protect password that Data Protection for Exchange Server uses to log on to the IBM Storage Protect 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 IBM Storage Protect password the first time Data Protection for Exchange Server connects to the IBM Storage Protect 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 IBM Storage Protect password that Data Protection for Exchange Server uses to log on to the IBM Storage Protect server can be up to 63 characters in length.