Restore optional parameters

Optional parameters follow the restore command and positional parameters.

/CONFIGfile=configfilename

Use the /configfile parameter to specify the name (configfilename) of the IBM Storage Protect Snapshot configuration file that contains the values to use for a restore operation.

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 fcmcfg.xml.

If the configfilename variable includes spaces, enclose the entire /configfile parameter entry in double quotation marks. For example:

/CONFIGfile="c:\Program Files\fcmcfg.xml"

See Update config positional parameters for descriptions of available configuration parameters.

/FROMSERVer=server-name

Use the /fromserver parameter to specify the name of the server where the original backup was done. The default is the local server.

/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 are on local shadow volumes. An IBM® Systems Storage SAN Volume Controller, DS8000®, the XIV® system, and IBM Storwize® V7000 storage subsystem is required to perform VSS instant restores.

You can specify:

Yes: Use volume level snapshot restore for a VSS backup 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 on local shadow volumes. Bypassing volume-level copy means that Exchange log files and the checkpoint file are the only data overwritten on the source volumes.

When you complete VSS instant restores with DS8000, make sure that any previous background copies (that involve the volumes that are being restored) are completed before you initiate the VSS instant restore. The /instantrestore parameter is ignored and VSS instant restore capabilities are automatically disabled when performing any type of VSS restore into operation. You cannot run VSS instant restore of differential and incremental backups.

/INTO=volume-drive | mount-point-dir

Use the /into parameter to restore the backup that is stored on IBM Storage Protect server to an alternate destination.

You can specify either volume-drive or mount-point-dir. The volume-drive or mount-point-dir location that you specify must be present on the server; the location is not dynamically created.

You can issue the /into parameter for one restore operation per command. You cannot use multiple restore specifications with the /into parameter.

The following sample provides an example of how to use the parameter:

FCMCLI RESTORE M: /INTO=P:

/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\myfcm.log"

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

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

/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.

/NOPROMPT

When the restore command is issued, you are prompted to confirm whether to overwrite the volumes you specified for restore. Use the /noprompt parameter to bypass this prompt and proceed with the restore operation.

/PITDAte=date

Use the /pitdate parameter with the /pittime parameter to establish a point in time for which you want to restore the latest version of your backups. Backups that were backed up on or before the date and time you specified, and, which were not deleted before the date and time you specified, are processed. Backup versions that you create after this date and time are ignored. Specify the appropriate date in the date variable; use the same format that you selected with the DATEFORMAT option in the IBM Storage Protect Snapshot options file.

If neither date nor time is specified, then no date and time are established. By default the backup is restored from the most recent available backup.

If either date or time is specified, then the backup is restored from the earliest backup that is selected after the established restore date and time. If no backup after the established date and time is found, by default the backup is restored from the most recent available backup.

Notes:

If you specify both date and time, this selection establishes the restore period.
If you specify date and you do not specify time, time defaults to a value of 23:59:59. This selection establishes the date at the specified date.
If you specify time without date, then date defaults to the current date. This selection establishes the restore date and time as the current date at the specified time.

/PITTime=time

Use the /pittime parameter with the /pitdate option to establish a point in time for which you want to restore the latest version of your backups. Files or images that were backed up on or before the date and time you specify, and that were not deleted before the date and time you specify, are processed. Backup versions that you create after this date and time are ignored. This option is ignored if you do not specify the /pitdate parameter. Specify the appropriate time in the time variable; use the same format that you selected with the TIMEFORMAT option in the IBM Storage Protect Snapshot options file.

If neither date nor time is specified, then no date and time are established. By default the backup is restored from the most recent available backup.

Notes:

If you specify both date and time, this selection establishes the restore period.
If you specify date and you do not specify time, time defaults to a value of 23:59:59. This selection establishes the date at the specified date.
If you specify time without date, then date defaults to the current date. This selection establishes the restore date and time as the current date at the specified time.

/TSMNODe=tsmnodename

Use the tsmnodename variable to refer to the IBM Storage Protect node name that IBM Storage Protect Snapshot 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 IBM Storage Protect 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 IBM Storage Protect password that IBM Storage Protect Snapshot uses to log on to the IBM Storage Protect server.

If you specified

PASSWORDACCESS
                        GENERATE

in the IBM Storage Protect Snapshot options file (dsm.opt), supplying the password is not necessary here 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 IBM Storage Protect Snapshot 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 IBM Storage Protect Snapshot uses to log on to the IBM Storage Protect server can be up to 63 characters in length.