Attix5 Pro FAQ
Search:     Advanced search

How to do a restore using a task file

Article ID: 61
Last updated: 09 Sep, 2015

This article explains how to do a restore directly on the Storage Platform by using a special task file. This will instruct the Storage Platform to restore directly to a local or UNC path, without using the Backup Client at all.

Advantages

  • Multi-threaded for faster restores
  • No Backup Client required

Disadvantages

  • Slightly technical to perform
  • No file permissions / rights are restored

Requirements

  • Windows operating systems only
  • Storage Platform V6.1 or higher
  • The account GUID
  • The account encryption key
  • Full access the the StorageServer where the backup data resides
  • Write access to the target location where the data must be written

Instructions

Create a text file with an extension .Restore, say Local.Restore (ensure it does not have a .txt extension) and open it in Notepad. Paste in the following text and modify as necessary. Then save the file and drop it in the TaskQueue folder on the correct SS. Progress can be seen in the Console. (Note: do not create the file in the TaskQueue folder, it will be read before you can populate it.)

AccountGuid=???
BackupDate=
Key=encryptionKey
Target=X:\RestoreLocal
Path=C:\Program Files\Attix5 Backup Professional SE\log*
CheckDiskSpace=true
AllowConcurrency=true
OverwriteExisting=false
Script=

Details of taskfile contents

Key Example Description
AccountGuid 79e8e23c-6741-470a-9f37-c34640e7f6e3 GUID for the Backup Account, can be found in the SP Console or SS logs.
BackupDate 20100331235959 The backup date to restore from. If left out it will restore from the last backup.  Get list of dates from Backups folder under GUID.
Key secret Encryption key for the Backup Account (required).
Target X:\RestoreLocal This is where the data will be written to. At the start of restore the service will check if it can write to the specified target and abort if it cannot.
If a UNC path is used, ensure the SS service runs as a user with write access to the UNC folder.
Path

C:\folder1\file*
will match
C:\folder1\file4.txt
C:\folder1\files\readme.txt

PLUGIN:\29*
will match
all files from plugin 29 (VSS)

Data you want to restore.
If Path ends with a *, it will match all files that have a full path starting with whatever is before the *, including files in all subfolders.
If Path does not end with a *, it will match a file that has a full path equalling the Path parameter (E.g. C:\folder1\file4.txt).
* will restore everything.
*.txt will not work.

CheckDiskSpace  true Check if enough free space is available on the target, on by default.
AllowConcurrency true Restore in multithreaded mode – faster, on by default.
OverwriteExisting false If target files exist should they be overwritten? Default is false. Number of skipped files will be reported.
Script c:\scripts\after_restore.ps Optional Powershell script to run after restore. Will only be executed if the restore was successful.


Creating a task file using REST

The task file on the SS can also be created by making a REST call to the SS for example:

https://192.168.1.1:8443/api/tasks/queue/restore?AccountGuid=xxx&Date=yyy&Key=zzz

In order for this to work you will to need to authenticate the HTTPS request on the SS using the admin key (master password).

Doing multiple restores simultaneously

The Storage Platform is able to do multiple restores simultaneously.  To do that, simply create a single task file per restore. Call each task file <guid>.Restore or <account_name>.Restore. As soon as a restore is done the task file will be deleted.  That way you will know when it is finished.  You can drop as many task files in the queue as you want, but it will of course use more and more resources, so keep the active tasks limited to what the server can handle (i.e. don’t throw in 1000 at once, it will kick off 1000 restores at the same time).

A restore task can be cancelled from the SP Console by right-clicking on the progress.

Article ID: 61
Last updated: 09 Sep, 2015
Revision: 2
Views: 20041
Comments: 0
Posted: 29 Apr, 2011 by Marais D.
Updated: 09 Sep, 2015 by Du Plessis S.
This article was:  
Prev   Next
Article 60 - System State (using WSB) plug-in V2.3     Article 63 - Connectivity issues between SP components