Command
Its Parameters
|
Optional/
Mandatory
|
Description and examples
|
list
|
|
Returns a partition list for a local drive or an image file
|
-a=<PathOfNewArchiveFile>
|
Mandatory
|
Specifies a path (including its file name) to the image file.
Examples:
-a=C:\Images\Test.arc or -a="C:\Image Files\Test 1.arc"
|
-p=<Password>
|
Mandatory/Not used
|
Specifies an image password. Mandatory if the image file has been already encrypted. It there is a space in the password, the password should be in quotes.
Examples: -p=Password or -p='My Password'
|
-t=<TimeSliceNumber>
|
Optional
|
Specifies which incremental data will be used to list the partitions in the image. If the TimeSliceNumber is not specified, the first data in the image will be used. -1 specifies the last incremental data in the image.
first: R-Drive Image will use the first incremental data in the image.
last: R-Drive Image will use the last incremental data in the image.
+<n>: R-Drive Image will use the n-th incremental data from the beginning in the image.
-<n>: R-Drive Image will use the n-th incremental data from the end in the image.
Examples: -t="+2" specifies the second incremental data from the beginning in the image will be used to list partitions.
|
Example:
list -a=C:\Images\Test.arc -p="mY pasSsworRrd"
This script command returns a list of partitions stored in the C:\Images\Test.arc image file protected by the password mY pasSsworRrd.
|
sysdump
|
|
Creates a system dump that may be necessary to obtain technical support. An image file can be included into that system dump. In this case, the keys -a, -p, -t from the list command should be used.
|
-sysdump="<SysDumpFile>"
|
Mandatory
|
Specifies the filename for the system dump.
|
Example:
sysdump -sysdump="MySysDump" -a=C:\Images\Test.arc -p="mY pasSsworRrd"
This script command creates a file with the system dump, its name is MySysDump. The system dump includes the image file C:\Images\Test.arc protected by the password mY pasSsworRrd.
|
register
|
|
Registers R-Drive Image from the command line.
|
-reg-user="<UserName>"
|
Mandatory
|
Specifies the user name for registration.
|
-reg-key="<RegistrationKey>"
|
Mandatory
|
Specifies the register key for registration.
|
-reg-company="<UserCompany>"
|
Optional
|
Specifies the company for registration.
|
Example:
register -reg-user="Tester 1" -reg-company=R-TT Testing Team" -reg-key="fafaasertghzfvasfje134"
This script command registers R-Drive Image for the user Tester 1 from the company R-TT Testing Team using the key fafaasertghzfvasfje134.
|
Disk descriptors used in the -s and -d commands
Below is the list of disk descriptors R-Drive Image uses to identify hard drives, logical disks, and partitions. It is written in the order of importance, from the most important descriptor to the least important one. If there are several objects with identical disk descriptors, R-Drive Image identifies them using the most important disk descriptor with different values.
|
hdd_vtype
|
HDD type.
|
real : a basic disk
dynamic : a dynamic disk
pure : disk objects like USB pendrives with only one logical disk on it.
Example: hdd_vtype=real
|
hdd_size
|
HDD size
|
Disk size should be specified in bytes, no KB or MB are allowed.
Example: hdd_size=40060403712
|
hdd_name
|
HDD name
|
Example: hdd_name=SAMSUNG SP0411NTW100-11 (  denotes a space)
|
hdd_serial
|
HDD serial number
|
Example: hdd_serial=S01JJ30X912841
|
hdd_bus_type
|
Type of the HDD bus
|
Can be: none, ata, atapi, scsi, floppy, usb, firewire, ssa, fibre, raid, smart, abios, sata, sata2.
Example: hdd_bus_type=ata
|
hdd_port_num
|
Port number for HDD
|
Example: hdd_port_num=0
|
hdd_target_id
|
Target ID for HDD
|
Example: hdd_target_id=1
|
hdd_num
|
Disk number, coincides with the disk number used in the old notations.
|
Example: hdd_num=1
|
part_free_space
|
Free space mark
|
1 if this object is a disk free space, 0 if not.
Example: part_free_space=1
|
part_ofs
|
Partition offset in bytes.
|
Partition offset should be specified in bytes, no KB or MB are allowed.
Example: part_ofs=16778264576
|
part_size
|
Partition size
|
Partition size should be specified in bytes, no KB or MB are allowed.
Example: part_size=23279435776
|
part_fs
|
Partition file system
|
Can be: none, ntfs, fat12, fat16, fat32, exfat, ext2fs, ext3fs, ext4fs, ufs1, ufs2, hfs ,hfsplus ,hfsx, iso9660
Example: part_fs=ntfs
|
part_label
|
Disk label
|
Example: part_label=Test_Data
|
part_mounted
|
Disk letter of folder
|
Example: part_mounted=G:\
|
part_num
|
Partition number, coincides with the partition number used in the old notations.
|
Example: part_num=2
|
A partition may be identified using its descriptors: hdd_size=40060403712+part_num=2+hdd_num=1+hdd_target_id=0+hdd_bus_type=ata+part_label=Part2+part_ofs=16778264576+part_mounted=G:\+hdd_name=SAMSUNG SP0411NTW100-11+part_size=23279435776+hdd_port_num=0+hdd_serial=S01JJ30X912831+part_fs=ntfs+hdd_vtype=real
|
create
|
|
|
append
|
|
Incrementally appends data to an existing image file. If such file does not exist, it will be created.
|
-s=<SourceDisk>
|
Mandatory
|
Specifies a source object to create the image or append to it. The <SourceDisk> parameter consists of one or several disk descriptors written in the form: descriptor_name1=value[+descriptor_name1=value...]. The disk descriptors are presented in the Disk descriptors section of this table. Old notation is also valid:
Old notation examples:
for hard drive 1: -s=1
for the second partition on hard drive 1: -s=1:2
for a logical disk: -s=D:
for several logical disks: -s="D: F:"
|
-a=<PathOfNewArchiveFile>
|
Mandatory
|
Specifies a path (including its file name) to the image file.
Examples:
-a=C:\Images\Test.arc or -a="C:\Image Files\Test 1.arc"
|
-c=<CompressionLevel>
|
Optional
|
Specifies compression level (1...11).
Example: -c=3
|
-u
|
Optional
|
Backups useful information only. May be used as a Boolean parameter.
|
-v=<ArchiveSize>
|
Optional
|
Specifies image split size. May be in the float-point format.
Example: -v=650 or -v='4.5 Gb'
|
-append-inc
|
Optional
|
Creates an incremental backup.
|
-p=<Password>
|
Mandatory/Not used
|
Specifies an image password. Mandatory if the append command is used and the image file has been already encrypted. It there is a space in the password, the password should be in quotes.
Examples: -p=Password or -p='My Password'
|
-r=<Description of archive>
|
Optional
|
Specifies an image description. It there is a space in the description, the description should be in quotes.
Examples: -r=Description or -r="Image Description"
|
-s-xw
|
Optional
|
Makes R-Drive Image not to use the Windows snapshot provider.
|
-s-xr
|
Optional
|
Makes R-Drive Image not to use the R-TT snapshot provider.
|
-s-n
|
Optional
|
Notifies system application that a snapshot is being taken.
|
-s-b0=<AppBeforeBack>
|
Optional
|
Specifies an application that will start before the backup operation starts. The application should return a 0 exit code.
Example: -s-b0="C:\commands\start.exe"
|
-s-b1=<AppAfterBack>
|
Optional
|
Specifies an application that will start after the backup operation completes. The application should return a 0 exit code.
Example: -s-b1="C:\commands\end.exe"
|
-s-s0=<AppBeforeSnapShot>
|
Optional
|
Specifies an application that will start before the snapshot is taken. The application should return a 0 exit code.
Example: -s-s0="C:\commands\startsnapshot.exe"
|
-s-s1=<AppAfterSnapShot>
|
Optional
|
Specifies an application that will start after the snapshot is taken. The application should return a 0 exit code.
Example: -s-s1="C:\commands\endsnapshot.exe"
|
-xe=<AppIfError>
|
Optional
|
Specifies a command line that will start an application if R-Drive Image fails to perform the specified action. If there is a space in the command line, the command line should be in quotes.
Examples: -xe=error.exe or -xe="winamp C:\sounds\error.mp3"
|
-xs=<AppIfSucc>
|
Optional
|
Specifies a command line that will start an application if R-Drive Image successfully performs the specified action. If there is a space in the command line, the command line should be in quotes.
Examples: -xs=success.exe or -xs="winamp C:\sounds\success.mp3"
|
-bs
|
Optional
|
Specifies that R-Drive Image will use backup sets.
|
-bs-size="<Quota_in_MB>"
|
Optional
|
May be used only if the -bs is set. Specifies the total size in MB on the disk allocated for the backup set. If it is exceeded, the backup set (all its files) will be removed.
Example: -bs-size="20000"
|
-bs-num-b="<Number_of_backs>"
|
Optional
|
May be used only if the -bs is set. Specifies the number of backup sets If it is exceeded, the older backup sets (all their files) will be removed.
Example: -bs-num-b="10"
|
-bs-num-f="<Number_of_files>"
|
Optional
|
May be used only if the -bs is set. Specifies the number of files in all backup sets. If it is exceeded, the older backup sets (all their files) will be removed.
Example: -bs-num-f="30"
|
-bs-age="<Days>"
|
Optional
|
May be used only if the -bs is set. Specifies the number of days for which R-Drive Image will keep the backup set. Then the backup set will be removed.
Example: -bs-age="14"
|
-cd-cache
|
Optional
|
Used when an image file is written to CD discs. R-Drive Image creates an ISO image of the CD disc and then copies it to the CD disc. Without it R-Drive Image writes data directly to the CD disc.
|
-cd-speed=<Speed>
|
Optional
|
Used when an image file is written to CD discs. Specifies burning speed in KB/sec.
Example: -cd-speed="1200"
|
-dvd-cache
|
Optional
|
Used when an image file is written to DVD discs. R-Drive Image creates an ISO image of the DVD disc and then copies it to the DVD disc. Without it R-Drive Image writes data directly to the DVD disc.
|
-dvd-speed
|
Optional
|
Used when an image file is written to DVD discs. Specifies burning speed in KB/sec.
Example: -dvd-speed="3324"
|
Example:
create -s="hdd_size=40060403712+part_num=1+hdd_num=2+hdd_target_id=0+hdd_bus_type=ata+part_label=Part1+part_ofs=1048576+part_mounted=F:\+hdd_name=SAMSUNG SP0411NTW100-11+part_size=16777216000+hdd_port_num=0+hdd_serial=S01JJ30X912831+part_fs=ntfs+hdd_vtype=real,hdd_size=40060403712+part_num=2+hdd_num=2+hdd_target_id=0+hdd_bus_type=ata+part_label=Part2+part_ofs=16778264576+part_mounted=H:\+hdd_name=SAMSUNG SP0411NTW100-11+part_size=23279435776+hdd_port_num=0+hdd_serial=S01JJ30X912831+part_fs=ntfs+hdd_vtype=real" -a="I:\Test Image.arc" -c=3 -u = true -p="My Password" -r="This is a test image" -xe="winamp C:\sounds\error.mp3" -xs="winamp C:\sounds\success.mp3"
This script command creates an image of logical disks F: and H: on the Samsung HDD. The path and filename for this image file is I:\Test Image.arc, with compression level 3, and only useful information on this disk will be written to the image. This image is protected with the password "My Password", and its description is "This is a test image". If the script action has been performed successfully, the winamp application will play the success.mp3 file, and if an error occurs, it will play the error.mp3 file.
|
restore
|
|
Restores data from an image to a specified disk place
|
copy
|
|
Copies a disk to a disk.
|
-s=<SourceDisk>
|
Mandatory
|
Specifies a source object to copy. The <SourceDisk> parameter consists of one or several disk descriptors written in the form: descriptor_name1=value[+descriptor_name1=value...]. The disk descriptors are presented in the Disk descriptors section of this table. Old notation is also valid:
Old notation examples:
for hard drive 1: -s=1
for the second partition on hard drive 1: -s=1:2
for a logical disk: -s=D:
|
-d=<DestinationDisk>
|
Mandatory
|
Specifies a destination disk:partition on which the data is to be restored. The <DestinationDisk> parameter consists of one or several disk descriptors written in the form: descriptor_name1=value[+descriptor_name1=value...]. The disk descriptors are presented in the Disk descriptors section of this table. Old notation is also valid:
Old notation examples:
for hard drive 1: -d=1
for the second partition on hard drive 1: -d=1:2
for a logical disk: -d=D:
|
-a=<PathOfArchiveFile>
|
Mandatory
|
Applicable to restore only.
Specifies a path (including its file name) to the image file from which data is to be restored. It there is a space in the path, the path should be in quotes.
Examples: -a=C:\Images\Test.arc or -a="C:\Image Files\Test.arc"
|
-k=<"PartitionStatus">
|
Optional
|
Specifies a status (primary/active) for a partition to be restored.
Settings:
+p is a primary partition -p is a secondary partition
+a is an active partition -a is a non-active partition
Please note that the combination "-p +a" is invalid. If this parameter is not specified, the data from the image will be used.
Examples:
-k="+p+a" the partition will be primary and active.
-k="+p" the partition will be primary. Information in the image will be used to make the partition either active or non-active.
|
-t=<TimeSliceNumber>
|
Optional
|
Applicable to restore only.
Specifies which incremental data will be used to restore data from the image. If the TimeSliceNumber is not specified, the first data in the image will be used. -1 specifies the last incremental data in the image.
first: R-Drive Image will use the first incremental data in the image.
last: R-Drive Image will use the last incremental data in the image.
+<n>: R-Drive Image will use the n-th incremental data from the beginning in the image.
-<n>: R-Drive Image will use the n-th incremental data from the end in the image.
Examples: -t="+2" specifies the second incremental data from the beginning in the image will be used to restore data.
|
-lr=<DiskLetter>
|
Optional
|
Specifies a disk letter. This parameter is case-insensitive.
Examples: -lr="K" or -lr=K.
|
-sz=<PartitionSize>
|
Optional
|
Specifies a partition size. May be in the float-point format.
Example: -sz=512 or -sz='0.5 Gb'
|
-of=<PartitionOfset>
|
Optional
|
Specifies an offset from the beginning of the destination. May be in the float-point format. Default is 0.
Example: -of=512 or -of='0.5 Gb'
|
-bs-use="<Parameter>"
|
Optional
|
Applicable to restore only.
Specifies the backup set R-Drive Image will use to restore data. Parameter may be:
first: R-Drive Image will use the first backup set.
last: R-Drive Image will use the last backup set.
+<n>: R-Drive Image will use the n-th backup set from the beginning.
-<n>: R-Drive Image will use the n-th backup set from the end.
<date>: R-Drive Image will use the backup set containing the date in its name.
Examples:
-bs-use="+3": R-Drive Image will use the 3-rd backup set from the beginning.
-bs-use="20080521": R-Drive Image will use the backup set containing the " 20080521" string in its name.
|
-p=<password>
|
Mandatory / Not used
|
Applicable to restore only.
Mandatory for password-protected files. Specifies a password for the archive.
Example: -p="my password"
|
-hdd-mode="<ModeType>"
|
Optional
|
Applicable to copy/restore entire hard drives only.
Specifies an HDD copy mode when copying entire hard drives. Parameter may be:
0: The default method
1: Raw disk copy
2: Copy all partitions onto original places
19: One partition after another
20: One partition after another (Fixed active partition)
51: Expand/Shrink partition to whole disk
52: Expand/Shrink partition to whole disk (Fixed active partition)
|
Example:
restore -a="I:\Test Image.arc" -s="hdd_size=40060403712+part_num=1+hdd_num=1+hdd_target_id=0+hdd_bus_type=ata+part_label=Part2+part_ofs=16778264576+part_mounted=G:\+hdd_name=SAMSUNG SP0411NTW100-11+part_size=23279435776+hdd_port_num=0+hdd_serial=S01JJ30X912831+part_fs=ntfs+hdd_vtype=real" -d="hdd_size=40060403712+part_num=2+hdd_num=1+hdd_target_id=0+hdd_bus_type=ata+part_label=Part2+part_ofs=16778264576+part_mounted=G:\+hdd_name=SAMSUNG SP0411NTW100-11+part_size=23279435776+hdd_port_num=0+hdd_serial=S01JJ30X912831+part_fs=ntfs+hdd_vtype=real" -p="My Password" -xe="winamp C:\sounds\error.mp3" -xs="winamp C:\sounds\success.mp3"
This script command restores data to the logical disk G: on the Samsung HDD, the source image is stored in the "I:\Test Image.arc", the data is taken from the first partition in the image. This image is protected with the password "My Password". If the script action has been performed successfully, the winamp application will play the success.mp3 file, and if an error occurs, it will play the error.mp3 file.
|
check
|
|
Checks consistency of the archive
|
-a=<PathOfArchiveFile>
|
Mandatory
|
Specifies a path (including its file name) to the image which integrity is to be checked. It there is a space in the path, the path should be in quotes.
Examples: -a=C:\Images\Test.arc or -a="C:\Image Files\Test.arc"
|
Example:
check -a="I:\Test Image.arc"
This script command checks the image file I:\Test Image.arc for its consistency.
|
mount
|
|
Connects an image file as a read-only virtual disk.
|
-a=<PathOfNewArchiveFile>
|
Mandatory
|
Specifies a path (including its file name) to the image file.
Examples:
-a=C:\Images\Test.arc or -a="C:\Image Files\Test 1.arc"
|
-s=<SourceDisk>
|
Mandatory
|
Specifies an object in the image to connect. Specifies a source object to copy. Specifies a source object to copy. The <SourceDisk> parameter consists of one or several disk descriptors written in the form: descriptor_name1=value[+descriptor_name1=value...]. The disk descriptors are presented in the Disk descriptors section of this table. Old notation is also valid:
Old notation examples:
for the second partition on hard drive 1: -s=1:2
for a logical disk: -s=D:
|
-lr=<DiskLetter>
|
Mandatory
|
Specifies a disk letter. This parameter is case-insensitive.
Examples: -lr="K" or -lr=K.
|
-t=<TimeSliceNumber>
|
Optional
|
Specifies which incremental data in the image will be used to connect a disk. If the TimeSliceNumber is not specified, the first data in the image will be used. -1 specifies the last incremental data in the image.
first: R-Drive Image will use the first incremental data in the image.
last: R-Drive Image will use the last incremental data in the image.
+<n>: R-Drive Image will use the n-th incremental data from the beginning in the image.
-<n>: R-Drive Image will use the n-th incremental data from the end in the image.
Examples: -t="+2" specifies the second incremental data from the beginning in the image will be used to connect a disk.
|
-bs-use="<Parameter>"
|
Optional
|
Specifies the backup set R-Drive Image will use to connect as a logical disk. Parameter may be:
first: R-Drive Image will use the first backup set.
last: R-Drive Image will use the last backup set.
+<n>: R-Drive Image will use the n-th backup set from the beginning.
-<n>: R-Drive Image will use the n-th backup set from the end.
<date>: R-Drive Image will use the backup set containing the date in its name.
Examples:
-bs-use="+3": R-Drive Image will use the 3-rd backup set from the beginning.
-bs-use="20080521": R-Drive Image will use the backup set containing the " 20080521" string in its name.
|
Example:
mount -a="I:\Test Image.arc" -s=1:2 lr=F: -t=-1
This script command connects the second partition of the first hard drive contained in the image file I:\Test Image.arc. The virtual logical disk will have the F: letter.
|
unmount
|
|
Disconnects a mounted virtual disk.
|
-lr=<DiskLetter>
|
Mandatory
|
Specifies a disk letter. This parameter is case-insensitive.
Examples: -lr="K" or -lr=K.
|
Example:
unmount lr=F:
This script command disconnects the virtual logical disk F:.
|
activate
|
|
Sets a specified partition active.
The required partition should be specified
|
-s=<SourceDisk>
|
Mandatory
|
Specifies the partition on the disk to set active. Specifies a source object to copy. The <SourceDisk> parameter consists of one or several disk descriptors written in the form: descriptor_name1=value[+descriptor_name1=value...]. The disk descriptors are presented in the Disk descriptors section of this table. Old notation is also valid:
Old notation examples:
for the second partition on hard drive 1: -s=1:2
for a logical disk: -s=D:
|
Example:
activate -s=1:1
This script command set the first partition of the first hard drive active.
|
delete
|
|
Deletes a partition on a drive
The required partition should be specified
|
-s=<SourceDisk>
|
Mandatory
|
Specifies a source object to copy. The <SourceDisk> parameter consists of one or several disk descriptors written in the form: descriptor_name1=value[+descriptor_name1=value...]. The disk descriptors are presented in the Disk descriptors section of this table. Old notation is also valid:
Old notation examples:
for the second partition on hard drive 1: -s=1:2
for a logical disk: -s=D:
|
Example:
delete -s=F:
This script command deletes the logical disk F:.
|
clear
|
|
Deletes all partition on a drive
|
-s=<SourceDisk>
|
Mandatory
|
Specifies the hard drive where all partitions should be deleted. Specifies a source object to copy. The <SourceDisk> parameter consists of one or several disk descriptors written in the form: descriptor_name1=value[+descriptor_name1=value...]. The disk descriptors are presented in the Disk descriptors section of this table. Old notation is also valid:
Old notation examples:
for hard drive 1: -s=1
|
Example:
clear -s=2
This script command deletes all partitions on the second hard drive.
|
fixmbr
|
|
Installs a default boot loader on a hard drive
|
-s=<SourceDisk>
|
Mandatory
|
Specifies the hard drive where the boot loader will be installed. Example:
for hard drive 1: -s=1
|
Example:
fixmbr -s=1
This script command installs the default boot loader to the first hard drive.
|
mail
|
Optional
|
Specifies all mail options globally for the entire script
|
Example:
mail -ms=mail.example.com -ma=rtt1@example.com -mr=rtt2@example.com -ml=rtt1:password -me -mx
This script command sends e-mails confirming success or error of the action from rtt1@example.com to rtt2@example.com via the mail.example.com SMTP server using the default (25) port with the rtt1 login and password password.
|
Parameters applicable to all commands
These parameters can be used in all commands
|
-log="<LogOptions>"
|
Optional
|
Controls the way R-Drive Image logs its command-line activity. By default, it outputs its activity into WinNT event log if started from Windows scheduler, but can create its own xml-type log files.
LogOptions may be:
#nodefault: disables the default log output into syslog
<filename>: writes the log to the specified file name and path. Example: c:\mylogs\mylog.txt. The "," character in the file name should be doubled.
<filepath>: writes the log files (a separate one to each session) to the specified folder. Each file name will have the following filename: date_time.rdl. Examples: c:\mydir\, file name: 20081003_215302.rdl.
#syslog: output logs into WinNT event log.
#sysdir: outputs logs into C:\Documents and Settings\All Users\Application Data\R-TT\R-Drive Image\Logs\.
Example: -log="#nodefault,c:\mylog.txt,c:\mydir\,#sysdir"
This will make R-Drive Image write its logs to the c:\mylog.txt file, and to the c:\mydir\ and C:\Documents and Settings\All Users\Application Data\R-TT\R-Drive Image\Logs\ folders without writing to WinNT event log.
|
mail options
|
Optional
|
Sends e-mail messages if the action fails or succeeds and specifies e-mail parameters. If a personal firewall is installed on your computer, you should allow the r-driveimagecl.exe application to get access to the e-mail server.
|
-me
|
Optional
|
Sends an e-mail message when R-Drive Image fails to perform the specified action. May be used as a Boolean parameter.
|
-mx
|
Optional
|
Sends an e-mail message when R-Drive Image successfully performs the specified action. May be used as a Boolean parameter.
|
-ms=<SMTPServer[:port]>
|
Mandatory/Not used
|
Mandatory if the -me or/and -mx option is used. Specifies an SMTP server and port (optional).
Examples: -ms=mail.example.com or -ms=mail.example.com:25
|
-ma=<SenderEmail>
|
Mandatory/Not used
|
Mandatory if the -me or/and -mx option is used. Specifies a sender's e-mail address.
Example: -ma=rtt1@example.com
|
-mr=<RecepientEmail>
|
Mandatory/Not used
|
Mandatory if the -me or/and -mx option is used. Specifies a recipient's e-mail address or addresses.
Example: -ma=rtt2@example.com
|
-ml=<Login:Password>
|
Optional
|
Specifies a login and password at the SMTP server.
Example: -ml=rtt1:password
|
