Run backup or restore tasks from the command line

Summary

ActiveImage Protector provides a command line interface. This article explains the syntax for running backup or restore tasks, with default paths depending on the operating system: 

Default path on Windows
C:\Program Files\Actiphy\ActiveImage ProtectorAipControl.exe

Default path on Linux
/opt/Actiphy/aipcontrol

Details

Run a backup using a specified profile.
Before running from the command line, configure the schedule.

1) Profile Name
* Use the same name as the schedule name.
Command Syntax: profiles

> cd C:\Program Files\Actiphy\ActiveImage Protector
> aipcontrol profiles
Actiphy Controller [Version 5.1.11.6500]
job ----Full Backup Profile Name
jobINC ----Incremental Backup Profile Name

2) Run backup task
Command Syntax: createimage <Profile Name >

> cd C:\Program Files\Actiphy\ActiveImage Protector
> aipcontrol createimage job ---->Full Backup task is executed.
> aipcontrol createimage jobINC ---->Incremental Backup task is executed.

Sample
Batch processing to run incremental backup task 30 seconds later

@echo off
cd C:\Program Files\Actiphy\ActiveImage Protector
setlocal enableDelayedExpansion
for /l %%N in (30 -1 1) do (
   set /a "min=%%N/60, sec=%%N%%60, n-=1"
   if !sec! lss 10 set sec=0!sec!
   cls
   choice /c:CY1 /n /m "Run backup task? !min!:!sec! - To run the task immediately, enter Y, to cancel the task enter C. " /t:1 /d:1
   if not errorlevel 3 goto :break
) 
cls
echo Run backup task? 0:00 - To run the task immediately, enter Y, to cancel the task enter C. 
:break
if errorlevel 2 (
   aipcontrol createimage JobINC
)

Run restore task
Command Syntax: restoredisk <Image File Name> <Destination disk> diskmeta

Restore a disk from a specific image file.
* Incorrectly specifying the destination can overwrite data—using the GUI is recommended.

 Boot Environment (WinPE-based)

* To restore to a NAS, provide credentials using: networkuser <Host Name> <User Name> <Password>.

> cd x:\Program Files\Actiphy\ActiveImage Protector
> aipcontrol networkuser srv20administrator password123

2) Restore by disk

> aipcontrol restoredisk \\srv20sharew2012@test_d00_00001.aiv disk0 diskmeta

No credential information is required for authentication when the backup image is on a local drive.

> cd x:\Program Files\Actiphy\ActiveImage Protector
> aipcontrol restoredisk z:\w2012@test_d00_00001.aiv disk0 diskmeta

Boot Environment (CentOS-based)

1) Ensure that the shared folder is mounted when the backup image is located on a NAS.

mount -t cifs //192.168.0.123/share /mnt -o user=administrator,password=test1234

2) Restore by disk.

# cd /opt/BE
# aipcontrol restoredisk /mnt/backup/w2012@test_d00_00001.aiv disk0 diskmeta

Target Product

– ActiveImage Protector 2018
- ActiveImage Protector 2022

(13451167469849)