1184 - InstantData command-line parameters (v18.2 and newer)

Note: This article applies to v18.2 and newer. For v18.1 and older, see Article 926.

InstantData can be automated to restore data by means of a scripted disaster recovery plan. For this, you will need the command-line parameters for the relevant InstantData agent's .exe file.

Since v18.10, the InstantData agent .exe files (Permanent, Temporary, and Full System Recovery) no longer form part of the Storage Platform Installer file. Instead, each of the three InstantData agents can be downloaded and installed as a separate .exe file. The default locations of the respective .exe files are as follows:

Permanent

C:\Users\<user>\AppData\Roaming\Redstor Backup Pro\InstantDataPermanent\<version>\InstantDataPermanent.exe

Example: 

C:\Users\jacques\AppData\Roaming\Redstor Backup Pro\InstantDataPermanent\18.11.26.11141\InstantDataPermanent.exe

Temporary

C:\Users\<user>\AppData\Roaming\Redstor Backup Pro\InstantDataTemporary\<version>\InstantDataTemporary.exe

FSR

C:\Users\<user>\AppData\Roaming\Redstor Backup Pro\InstantDataFSR\<version>\InstantDataFSR.exe

Page contents

• Updates
• Parameters
  • Commonly used parameters
  • Advanced parameters

Updates

Since v18.10, the agents are each released separately to the LicenceServer.

• If auto updates are enabled on your Storage Platform, you can set your update preference to the Latest, Latest-1 or Preview version in the Storage Platform Console.
• Even if auto updates are not enabled on the Storage Platform, the AccountServer will download the appropriate agent installers from the LicenceServer after an installation or upgrade. The AccountServer will then sync the updates to the StorageServers.

Parameters 

The minimum command-line parameters required for automated restoring are Server, Account, Key, Path, and Target. For example, to bypass login and immediately start the backup browser, start up InstantData FSR with credentials predefined, as in the following example:

   InstantDataFSR.exe
            Server="server"
            Account="group\account"
            Key="encryptionKey"
            [Port=8443]
            [Secure=true]

Commonly used parameters

Account

GUID or full account name used for restore.

Account=group\account
Account=DBAD2BAB-90FB-4E2A-9AAC-36018993090B

Automate

Start the application automatically and close when done.

Automate=false
/Automate

Backup

Specify the backup to restore from (can be AllBackups, LastBackup or a specific backup date in yyyymmddhhmmss).

Backup=AllBackups 
Backup=20170807135017

MountPoint

Silently mount to a specified drive letter.

MountPoint="Z:"

FileExclusions

Exclude files with these extensions.

FileExclusions="*.mp4,*.mov"

FolderExclusions

Exclude entire folders from being restored.

FolderExclusions="C:\temp"

Help | ?

Launch the InstantData FSR help html page.

/help
-help
help
/?
-?
?

To see all parameter options for a specific agent, run *.exe help for that agent.

InstantDataFSR.exe help

Key

Encryption key for the account.

Key=encryptionkey

Port

Address port of AccountServer or StorageServer where the account is located.

Port=443

Secure

Whether the connection to the Platform should be over https (set to True if your network uses a transparent proxy).

Secure=false
/Secure

Server

Address of AccountServer or StorageServer where the account is located.

Server=192.168.21.150
Server=servername

Target

Target to restore to.

Local path:

Target="G:\RestoreToPath"

 

The following options are also available, but only when using InstantData.Console.exe:

VMware hypervisor (runs with no GUI and requires the Automate flag to be set):

Target=VMWare(Server:192.168.1.1,Username:username,Password:password,FolderId:group-v2321,

ResourcePoolId:resgroup-3620,DatastoreName:datastore1,VMName:NewVM,MemoryMb:1024,CpuCount:1)

Azure:

Target=Azure('SubscriptionId:SubscriptionId,TenantId:TenantId,StorageAccountName:StorageAccountName,

ContainerName:ContainerName,MachineSize:MachineSize,VmNamePrefix:VmNamePrefix,NetworkId:NetworkId,

SubnetName:SubnetName')

where:

 

SubscriptionId = GUID assigned by Azure
TenantId = Tenant ID (in GUID format)
StorageAccountName = DNS name (in TXT format) of the StorageServer where the backup is located
MachineSize = type of Azure VM, e.g. Basic_A0, Standard_A1, Standard_B2ms

NetworkId = name, ID or path of the virtual network

Note that the whole value must be a single string.

The Azure target also supports a JSON configuration file format:

Target=AzureFile(C:\azureConfig.json)

TargetType

Default is VHDX. Alternatives are VHD and VMDK.

TargetType=VHDX

Advanced parameters

AutoConfirm

When restoring with the GUI and a confirmation is required, the option is to auto confirm or not. This option is required when restoring without the GUI.

AutoConfirm=false
/AutoConfirm

ConnectionLimit

Maximum concurrent connections to the platform.

ConnectionLimit=10

Data

Directory path where data can be cached. Default location is %APPDATA%\Redstor Backup Pro\InstantData\Data

Data="C:\CustomCacheDirectory"

LocalBackupPath

LocalBackupPath="C:\BackupPath"

LogLevel

Set the NLog logging level (options are Error, Info, Debug and Trace).

LogLevel=Debug

Logs

Directory where log files should be written. Default location is %APPDATA%\Redstor Backup Pro\InstantData\Logs

Logs="C:\CustomLogsDirectory"

Silent

Silent mode suppresses any dialog messages and prompts (required when restoring without the GUI).

Silent=false
/Silent

Timeout

Storage Platform request timeout (in seconds).

Timeout=100

UrlRefreshInterval

How often the cached server URLs should be refreshed (in minutes).

UrlRefreshInterval=1440

VersionPassword

SP admin password to override the version check.

VersionPassword=password

VersionToReport

The version that InstantData reports to the SP. If not specified, the InstantData agent version will be reported.

VersionToReport=17.11.29.4003