Note: This article applies to v18.1 and older. For v18.2 and newer, see Article 1184.
Using the InstantData.exe file's parameters (see below), InstantData can be automated to restore data by means of a scripted disaster recovery plan.
At a minimum, the parameters required for this are Server, Account, Key, Path, and Target.
- Example: This example will restore all files backed up on 17 January 2017 at 18:01:05 in folder C:\Database Files\ to C:\Restore:
InstantData.exe Server=previewsp.redstor.com Account=collection\group\myaccount key=mysecret Backup=20160117180105 Path="C:\Database Files\" Target="C:\Restore"
- FSR example: This example will silently restore the full system backup on 17 January 2017 at 18:01:05 to C:\Restore as a VHDX virtual disk:
InstantData.exe Server=previewsp.redstor.com Account=collection\group\myaccount key=mysecret Backup=20160117180105 Target="C:\Restore" TargetType=VHDX automate
InstantData command-line parameters
| PARAMETER | AGENT | DEFAULT VALUE | PURPOSE |
|---|---|---|---|
|
Server |
Temp, Perm, FSR |
|
|
|
Port |
Temp, Perm, FSR |
443 |
|
|
Account |
Temp, Perm, FSR |
|
Use "[group]\[name]" or account GUID |
|
Key |
Temp, Perm, FSR |
|
User encryption key |
|
TimeOut |
Temp, Perm, FSR |
90 |
Seconds |
|
Backup |
Temp, Perm, FSR |
Last |
Use the backup date and time (seconds included) as in the Data\[Account]\[Backups] folder of the StorageServer. The date and time must be given in UTC, as this is typically used in the API. Both the yyyyMMddHHmmss format (e.g. 20160331080415) and ISO 8601 format (e.g. 2018-10-24T13:46:59Z) are acceptable. Note that the Agent uses the local time zone by default, which means the date and time need to be converted to UTC. |
|
VersionToReport |
Temp, Perm, FSR |
|
Report agent version as specified version |
|
VersionPassword |
Temp, Perm, FSR |
(sp-admin-password) |
The SP admin password. get version from SP and report that version to SP as agent version |
|
BlockSizeKB |
Perm |
32 |
Smallest unit that InstantData keeps track of i.t.o. downloads and writes |
|
BlocksPerRequest |
Perm |
1024 |
Per BlockSizeKB, i.e. 1MB for background thread, combines blocks into one request for speed |
|
DownloaderCount |
Perm |
10 |
Number of threads downloading from server |
|
MaxDownloadersPerFile |
Perm |
2 |
As above but per single file i.e. 20 files selected, 5 at a time |
|
MaxQueuedWritesMB |
Perm |
256 |
Queue size control |
|
MaxKBperWrite |
Perm |
4096 |
Writes to disk |
|
MsToWaitForReads |
Perm |
50 |
Period to wait for more foreground requests before servicing background requests. |
|
BrandLogo |
Perm |
|
Path to logo to put on toolbar |
|
ShowDownloadRatio |
Perm |
FALSE |
|
|
MaxFileCount |
Perm |
1000 |
Limit of single drag-and-drop batch. |
|
DeleteCorruptFiles |
Perm |
true |
Whether to schedule deletion of partial files in registry for next reboot (in case machine crashes). |
|
DownloadOnDemandOnly |
Perm |
FALSE |
Only stub files will be created on disk and data will be downloaded as needed Note: This is an advanced setting and should only be modified by users with a sound understanding of stubs and how they are managed. Incorrect use of this setting could result in the referenced data being removed from the Storage Platform. |
|
Path |
Perm |
|
Source path for command line restore. To restore a folder ensure the last character is "\", e.g. "Path=C:\Temp\", or a filename is assumed |
|
Target |
Perm, FSR |
|
Restore target for command line restore, e.g. "Target=C:\Restore" |
|
Temp |
Temp |
%Temp%\InstantData\{new guid} |
|
|
MountPoint |
Temp |
Z: |
|
|
Path |
Temp |
|
Filter downloaded index(es) to those entries that start with this value |
|
IgnoreCase |
Temp |
true |
Only used if Path is specified |
|
ReadOnly |
Temp |
false |
Prohibit writes to the virtual drive |
|
Label |
Temp |
InstantData's Temporary restore |
Volume label of the mounted drive |
|
CacheDate |
Temp |
false |
Whether to store data downloaded from the SS in a local cache (writes are always cached) |
|
DriveType |
Temp |
FixedDisk |
Alternatives are RemovableDisk and NetworkDrive |
| TargetType | FSR | n/a | Specify VMware or Hyper-V destination disk types. Use either VHDX or VMDK. |
| Automate | FSR | n/a | The InstantData app's graphical user interface will not be started allowing silent recovery |
| FileExclusions | FSR | n/a | Exclude files matching the comma delimited spec, i.e. *.mp3,*.mov |
| FolderExclusions | FSR | n/a | Exclude entire folders that start with the comma delimited spec, i.e. C:\temp,E:\ The list is case insensitive. |
| Volumes | FSR | A list of volumes that should be restored from the backup. Should be in the format <disknumber>:<volumenumber>. E.g. /Volumes=1:2,1:3,2:1 | |
| LocalBackupPath | FSR | Specifies a local path to try and restore from. Currently this overrides the platform connection details. E.g. /LocalBackupPath=D:\path\to\backup |