ACRONIS BACKUP RECOVERY 10 ADVANCED WORKSTATION - COMMAND... Instruction Manual

Command Line Reference

Acronis® Backup & Recovery™ 10

Advanced Workstation

Table of contents

1Command-line mode and scripting in Windows ....................................................................... 3

1.1 Agent for Windows command-line utility .................................................................................3

1.1.1 Supported commands..................................................................................................................................3

1.1.2 Common options..........................................................................................................................................8

1.1.3 Specific options...........................................................................................................................................11

1.1.4 trueimagecmd.exe usage examples ..........................................................................................................21

1.2 Storage node command-line utility .........................................................................................26

1.2.1 Supported commands................................................................................................................................26

1.2.2 Options........................................................................................................................................................27

1.2.3 Examples.....................................................................................................................................................29

1.2.4 Exporting vaults and importing multiple archives.....................................................................................31

1.3 Scripting ...................................................................................................................................31

1.3.1 Script execution parameters......................................................................................................................31

1.3.2 Script structure ...........................................................................................................................................32

1.3.3 Script usage examples................................................................................................................................33

2Index ..................................................................................................................................... 34

1Command-line mode and scripting in Windows

Acronis Backup & Recovery 10 supports the command-line mode and enables backup automation by

executing XML scripts.

Acronis Backup & Recovery 10 uses the Acronis True Image Echo command line utility with the

following additions:

1. Ability to use the before/after data capture commands.

2. Ability to use the VSS support option.

3. Ability to check for a license on the license server with the /ls_check command.

4. Ability to use file exclusion at disk backup.

5. Ability to export archives and backups.

The rest of the commands and options are exactly the same. For this reason, the command line

reference uses the terminology accepted in Acronis True Image Echo.

The command line logs are saved in the old (Echo) format and cannot be converted to Acronis

Backup & Recovery 10 logs.

Command line mode limitations

The command-line mode functionality is somewhat limited as compared to the GUI mode. You will

not be able to perform operations that require:

the reboot of the system, such as restore a system volume or clone a system disk

a user interaction, such as inserting removable media (CD, DVD or tape) - the operation fails if

there is no media in the drive or the inserted media is full.

These operations only can be done through the GUI.

Scripting is intended only for backup.

1.1 Agent for Windows command-line utility

An administrator might need a console interface in some situations. Acronis Backup & Recovery 10

supports this mode with trueimagecmd.exe utility. The file is located in the folder where Acronis

Backup & Recovery 10 Agent for Windows has been installed, by default it is C:\Program

Files\Acronis\BackupAndRecovery.

This utility is also available when operating under the PE-based bootable media.

1.1.1 Supported commands

trueimagecmd has the following format:

trueimagecmd /command /option1 /option2…

Commands may be accompanied with options. Some options are common for most trueimagecmd

commands, while others are specific for individual commands. Below is a list of supported commands

and compatible options.

Command Common Options Specific Options

create

Creates an image of

specified disks and

partitions

/vault:[path]

/arc:[archive name]

/arc_id:[archive id]

/filename:[file name]

/password:[password]

/asz:[number of archive]

/net_user:[username]

/net_password:[password]

/ftp_user:[username]

/ftp_password:[password]

/incremental

/differential

/compression:[0…9]

/split:[size in MB]

/oss_numbers

/progress:[on|off]

/reboot

/log:[file name]

/log_net_user:[remote user]

/log_net_password:[password]

/harddisk:[disk number]

/partition:[partition number]

/file_partition:[partition letter]

/raw

/exclude_names:[names]

/exclude_masks:[masks]

/exclude_system

/exclude_hidden

/before:[pre-data capture command]

/after:[post-data capture command]

/use_vss

filebackup

Backs up specified files

and folders

/vault:[path]

/arc:[archive name]

/arc_id:[archive id]

/filename:[file name]

/password:[password]

/asz:[number of archive]

/net_user:[username]

/net_password:[password]

/ftp_user:[username]

/ftp_password:[password]

/incremental

/differential

/compression:[0…9]

/split:[size in MB]

/reboot

/log:[file name]

/log_net_user:[remote user]

/log_net_password:[password]

/include:[names]

/exclude_names:[names]

/exclude_masks:[masks]

/exclude_system

/exclude_hidden

/before:[pre-data capture command]

/after:[post-data capture command]

/use_vss

deploy

Restores disks and

partitions, except for

the MBR, from an

image

/vault:[path]

/arc:[archive name]

/arc_id:[archive id]

/filename:[file name]

/password:[password]

/asz:[number of archive]

/index:N

/net_user:[username]

/net_password:[password]

/ftp_user:[username]

/ftp_password:[password]

/oss_numbers

/reboot

/log:[file name]

/log_net_user:[remote user]

/log_net_password:[password]

/file_partition:[partition letter]

/harddisk:[disk number]

/partition:[partition number]

/target_harddisk:[disk number]

/target_partition:[partition number]

/start:[start sector]

/size:[partition size in sectors]

/fat16_32

/type:[active|primary|logical]

/preserve_mbr

When using the Acronis Universal Restore

option:

/ur_path:[path]

/ur_username:[user]

/ur_password:[pwd]

/ur_driver:[inf-filename]

deploy_mbr

Restores the MBR from

a disk or partition

image

/vault:[path]

/arc:[archive name]

/arc_id:[archive id]

/filename:[file name]

/password:[password]

/asz:[number of archive]

/index:N

/net_user:[username]

/net_password:[password]

/ftp_user:[username]

/ftp_password:[password]

/oss_numbers

/reboot

/log:[file name]

/log_net_user:[remote user]

/log_net_password:[password]

/harddisk:[disk number]

/target_harddisk:[disk number]

filerestore

Restores files and

folders from a file

archive

/vault:[path]

/arc:[archive name]

/arc_id:[archive id]

/filename:[file name]

/password:[password]

/asz:[number of archive]

/index:N

/net_user:[username]

/net_password:[password]

/ftp_user:[username]

/ftp_password:[password]

/reboot

/log:[file name]

/log_net_user:[remote user]

/log_net_password:[password]

/target_folder:[target folder]

/overwrite:[older|never|always]

/restore_security:[on|off]

/original_date:[on|off]

verify

Verifies the archive

data integrity

/vault:[path]

/arc:[archive name]

/arc_id:[archive id]

/filename:[file name]

/password:[password]

/asz:[number of archive]

/net_user:[username]

/net_password:[password]

/ftp_user:[username]

/ftp_password:[password]

/reboot

/log:[file name]

/log_net_user:[remote user]

/log_net_password:[password]

pit_info

Displays the numbered

list of backups,

contained in the

specified archive

/filename:[file name]

/password:[password]

/asz:[number of archive]

/net_user:[username]

/net_password:[password]

/ftp_user:[username]

/ftp_password:[password]

consolidate

Creates a consistent

copy of the archive

which will contain only

the specified backups

/include_pits:[pits numbers]

/filename:[file name]

/password:[password]

/ftp_user:[username]

/ftp_password:[password]

/reboot

/log:[file name]

/log_net_user:[remote user]

/log_net_password:[password]

/target_filename:[file name]

/net_src_user:[username]

/net_src_password:[password]

/net_user:[username]

/net_password:[password]

export

Creates a copy of an

archive or a self-

sufficient part copy of

an archive in the

location you specify

/vault:[path]

/arc:[archive name]

/arc_id:[archive id]

/include_pits:[pits numbers]

/password:[password]

/ftp_user:[username]

/ftp_password:[password]

/progress:[on|off]

/log:[file name]

/log_net_user:[remote user]

/log_net_password:[password]

/net_src_user:[username]

/net_src_password:[password]

/ftp_src_user:[username]

/ftp_src_password:[password]

/target_vault:[target path]

/target_arc:[target archive name]

/net_user:[username]

/net_password:[password]

convert

Converts an image to

virtual disk format for

using with a virtual

machine

/filename:[file name]

/password:[password]

/asz:[number of archive]

/index:N

/net_user:[username]

/net_password:[password]

/ftp_user:[username]

/ftp_password:[password]

/log:[file name]

/log_net_user:[remote user]

/log_net_password:[password]

/target_filename:[file name]

/harddisk:[disk number]

/vm_type:[vmware|esx|microsoft|parallels]

/ur

/ur_path:[path]

list

Lists available drives

and partitions. When

used with the filename

option, it lists the

image contents.

When used with the

vault option, it lists

archives located in the

specified location.

When the arc, or the

arc_id option is added,

it lists all backups

contained in the

archive.

/password:[password]

/index:N

/asz:[number of archive]

/net_user:[username]

/net_password:[password]

/ftp_user:[username]

/ftp_password:[password]

/filename:[file name]

/vault:[path]

/arc:[archive name]

/arc_id:[archive id]

explore

Connects an image as a

virtual drive

/vault:[path]

/arc:[archive name]

/arc_id:[archive id]

/filename:[file name]*

/password:[password]

/asz:[number of archive]

/index:N

/partition:[partition number]

/letter:X

/net_user:[username]

/net_password:[password]

/log:[file name]

/log_net_user:[remote user]

/log_net_password:[password]

*for a split image, the name of

the last created file

unplug

Disconnects the image

connected as a virtual

drive

/letter:X

/letter:all

asz_create

Creates the Acronis

Secure Zone on the

selected drive

/password:[password]

/oss_numbers

/reboot

/log:[file name]

/log_net_user:[remote user]

/log_net_password:[password]

/harddisk:X

/partition:[partition number]

/size:[ASZ size in sectors|unallocated]

asz_content

Displays the Acronis

Secure Zone size, free

space and contents

/password:[password]

asz_files

Displays the Acronis

Secure Zone size, free

space and contents

using the generated file

names

/password:[password]

asz_delete_files

Deletes the most

recent backup in the

archive located in the

Acronis Secure Zone

/filename:[file name]

/password:[password]

/log:[file name]

/log_net_user:[remote user]

/log_net_password:[password]

asz_delete

Deletes the Acronis

Secure Zone

/password:[password]

/oss_numbers

/reboot

/log:[file name]

/log_net_user:[remote user]

/log_net_password:[password]

/partition:[partition number]

asrm_activate

Activates the Acronis

Startup Recovery

Manager

asrm_deactivate

Deactivates the Acronis

Startup Recovery

Manager

clone

Clones a hard disk

/reboot /harddisk:[disk number]

/target_harddisk:[disk number]

help

Shows usage

ls_check

Checks if there are

licenses for the local

machine on the license

server

1.1.2 Common options

1.1.2.1 Access to archives

vault:[path]

Specifies a path to the location that contains the archive. Used in combination with the arc, or the

arc_id option.

The following locations are supported:

Local folders, e.g.: /vault:C:\Test, or /vault:"C:\Test 1"

Network folders, e.g.: /vault:\\ServerA\Share\

Managed vaults (for advanced product editions only), e.g.:

/vault:bsp://StorageNode/VaultName

FTP and SFTP, e.g.: /vault:ftp://ServerA/Folder1

CD, DVD – with the path specified as a local path, e.g.: /vault:F:\

Acronis Secure Zone, e.g.: /vault:atis:///asz

Tapes, e.g.: /vault:atis:///tape?0

Unmanaged vaults are specified by their path. For example, if a vault is located in a folder,

specify the path to that folder.

If the vault option is specified the filename option is ignored.

arc:[archive name]

The name of the archive. If not specified, the arc_id option is used. If both the arc and arc_id options

are specified, the arc_id option is used.

arc_id:[archive id]

Specifies the Universally Unique Identifier (UUID) of the archive, e.g.:

/arc_id:183DE307-BC97-45CE-9AF7-60945A568BE8

If not specified, the arc option is used. If both options are specified, the arc_id option is used.

filename:[file name]

a) Backup file name, if the archive location is other than ASZ.

b) Archive name, when restoring or deleting files from ASZ. Can be obtained with asz_files.

If the vault option is specified the filename option is ignored.

password:[password]

a) Password for the archive, if the archive location is other than ASZ.

b) Password for the ASZ, if archive location is ASZ.

asz:[number of archive]

Addresses to the ASZ and selects the archive (a full backup with or without increments).

To get the archive number, use asz_content.

index:N

N = Number of the backup in an archive:

1 = basic full backup

2 = 1st increment… and so on

0 (default) = latest increment

Selects a backup in a sequence of incremental backups inside the archive.

To get a backup index from the ASZ, use asz_content.

include_pits:[pits numbers]

Specifies the backups (pits) to be included in the archive copy. To get the numbers of pits, use

pit_info. Separate multiple values with a comma, for example:

/include_pits:2,4,5

The "0" value means the last backup in the archive, for example:

/include_pits:0

If not specified the whole archive is selected.

net_user:[username]

Specify a user name for network drive access.

net_password:[password]

Specify a password for network drive access.

ftp_user:[username]

Specify a user name for access to an FTP server.

ftp_password:[password]

Specify a password for access to an FTP server.

1.1.2.2 Backup options

incremental

Set the backup type to incremental.

If not specified or there is no basic full backup, a full backup will be created.

differential

Set the backup type to differential.

If not specified or there is no basic full backup, a full backup will be created.

compression:[0…9]

Specify the data compression level.

It ranges from 0 to 9 and is set to 3 by default.

split:[size in MB]

Split the backup into parts of the specified size, if the archive location is other than ASZ.

1.1.2.3 General options

oss_numbers

Declares that numbers of partitions in the /partition option are adjusted for the MBR partition table

rather than just as ascending numbers. This means that primary partitions have numbers 1-1, 1-2, 1-

3, 1-4; logical partitions numbers start with 1-5. For example, if the disk has one primary and two

logical partitions, their numbers can appear as follows:

/partition:1-1,1-2,1-3

/oss_numbers /partition:1-1,1-5,1-6

reboot

Reboot the server after the operation is completed.

log:[file name]

Create a log file of the current operation with the specified file name.

log_net_user:[remote user]

If the log file is created on a network share, include the user name for logon to the share.

log_net_password:[password]

If the log file is created on a network share, include the password for logon to the share.

This manual suits for next models

Table of contents

Other ACRONIS Software manuals

ACRONIS

ACRONIS BACKUP AND RECOVERY 10 WORKSTATION - INSTALLATION UPDATE... User manual

ACRONIS

ACRONIS BACKUP RECOVERY 10 ADVANCED SERVER VIRTUAL... User manual

ACRONIS

ACRONIS BACKUP RECOVERY 10 ADVANCED SERVER SBS EDITION - COMMAND... Instruction Manual

ACRONIS

ACRONIS PARTITIONEXPERT 2003 User manual

ACRONIS

ACRONIS SNAP DEPLOY 3 - FOR WORKSTATION User manual

ACRONIS

ACRONIS SNAP DEPLOY - User manual

ACRONIS

ACRONIS BACKUP AND RECOVERY 10 SERVER FOR LINUX - User manual

ACRONIS

ACRONIS BACKUP RECOVERY 10 ADVANCED SERVER - User manual

ACRONIS

ACRONIS DNS-1250-04 User manual

ACRONIS

ACRONIS BACKUP AND RECOVERY 10 SERVER FOR LINUX - User manual

ACRONIS

ACRONIS BACKUP RECOVERY 10 ADVANCED SERVER - User manual

ACRONIS

ACRONIS BACKUP AND RECOVERY 10 ADVANCED SERVER VIRTUAL EDITION - INSTALLATION UPDATE... User manual

ACRONIS

ACRONIS RECOVERYEXPERT User manual

ACRONIS

ACRONIS MIGRATE EASY 7.0 User manual

ACRONIS

ACRONIS TRUE IMAGE - FOR MICROSOFT WINDOWS SMALL BUSINESS... User manual

ACRONIS

ACRONIS BACKUP AND RECOVERY 10 SERVER FOR LINUX - User manual

ACRONIS

ACRONIS BACKUP RECOVERY 10 SERVER FOR LINUX - COMMAND... Instruction Manual

ACRONIS

ACRONIS DISK DIRECTOR SUITE 10.0 User manual

ACRONIS

ACRONIS BACKUP RECOVERY 10 ADVANCED SERVER SBS... User manual

ACRONIS

ACRONIS DISK DIRECTOR SERVER 10 User manual

ACRONIS

ACRONIS BACKUP AND RECOVERY 10 ADVANCED SERVER SBS EDITION - COMMAND LINE REFERENCE UPDATE... Instruction Manual

ACRONIS

ACRONIS RECOVERY - FOR MICROSOFT SQL SERVER User manual

ACRONIS

ACRONIS PRIVACY EXPERT CORPORATE - User manual

ACRONIS

ACRONIS TRUE IMAGE 9.1 - ENTERPRISE SERVER User manual

Popular Software manuals by other brands

COMPRO

COMPRO COMPROFM manual

Muratec

Muratec OFFICEBRIDGE ONLINE user guide

Oracle

Oracle Contact Center Anywhere 8.1 installation guide

Adobe

Adobe 65007312 - Photoshop Lightroom Programmer's guide

Avaya

Avaya NULL One-X for RIM Blackberry user guide

HP ProLiant BL420c user guide

PS Audio

PS Audio PowerPlay Programming manual

Brady

Brady LOCKOUT PRO 3.0 Administrator's guide

Avaya

Avaya Interaction Center user guide

Texas Instruments

Texas Instruments TI-83 Plus Silver Edition Guide book

Novell

Novell GROUPWISE 8 - INTERNET AGENT manual

Oracle

Oracle Application 9i Configuration guide

Acer

Acer RDM user guide

Canon

Canon Vixia HF21 instruction manual

Canon

Canon ZR950 instruction manual

Samsung

Samsung Auto Backup user manual

Polycom

Polycom Vortex EF2201 Application note

Brocade Communications Systems

Brocade Communications Systems Brocade 8/12c user manual