“Acronis” and “Acronis Secure Zone” are registered trademarks of Acronis, Inc.
"Acronis Compute with Confidence", “Acronis Startup Recovery Manager”, “Acronis Active Restore”
and the Acronis logo are trademarks of Acronis, Inc.
Linux is a registered trademark of Linus Torvalds.
VMware and VMware Ready are trademarks and/or registered trademarks of VMware, Inc. in the
United States and/or other jurisdictions.
Windows and MS-DOS are registered trademarks of Microsoft Corporation.
All other trademarks and copyrights referred to are the property of their respective owners.
Distribution of substantively modified versions of this document is prohibited without the explicit
permission of the copyright holder.
Distribution of this work or derivative work in any standard (paper) book form for commercial
purposes is prohibited unless prior permission is obtained from the copyright holder.
DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED CONDITIONS,
REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE
EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.
Third party code may be provided with the Software and/or Service. The license terms for such
third-parties are detailed in the license.txt file located in the root installation directory. You can
always find the latest up-to-date list of the third party code and the associated license terms used
with the Software and/or Service at http://kb.acronis.com/content/7696
2.1 Commands by services ........................................................................................................ 12
2.2 help .................................................................................................................................... 14
2.3 Backup and recovery........................................................................................................... 14
2.3.1Disks and volumes .................................................................................................................................. 14
2.9 Operations with disks ......................................................................................................... 39
2.9.1clone disk ................................................................................................................................................ 39
2.10.1Logs and activities ................................................................................................................................... 40
3.2.1Access to a virtual machine .................................................................................................................... 49
4.1 Backup and recovery........................................................................................................... 70
4.1.1Disks and volumes .................................................................................................................................. 70
4.8.1Logs and activities ................................................................................................................................... 78
Acronis Backup & Recovery 11 supports the command-line interface with the acrocmd utility.
Unlike the trueimagecmd utility used in the older Acronis products, acrocmd does not contain any
tools that physically execute the commands. It merely provides the command-line interface to
Acronis Backup & Recovery 11 components—agents, storage nodes and the management server.
Once installed on a Windows or Linux machine, the acrocmd utility can be run from any folder or
directory. This utility is also available when operating in both Linux-based and PE-based bootable
media.
1.1 Installation
Stand-alone editions of Acronis Backup & Recovery 11
If you have installed a stand-alone edition of Acronis Backup & Recovery 11, the command-line utility
is already on your machine. Only local management of this machine is available. This means that any
command or script for this machine can be run only locally.
Editions with centralized management
Advanced editions of Acronis Backup & Recovery 11 enable you to perform local, remote and
centralized management (p. 8) of any machine where an Acronis Backup & Recovery 11 agent is
installed.
As with Management Console, you install the command-line utility on the machine from which you
prefer to operate (run commands or scripts). The machine may run Windows or Linux. Using the
command-line utility, you can manage a Windows machine from a machine running Linux or vice
versa.
Installation steps
In Linux, the command-line utility is installed by default with Management Console or Agent for
Linux.
In Windows, you install the utility from the setup file as a separate component. To access this
component in the installer, select the I want to manually select the Acronis components and customize the installation process check box. Or you can extract and run the corresponding .msi file.
To install the command-line utility from the .msi file:
1. Run the Acronis Backup & Recovery 11 setup file.
2. Click Extract installation files.
3. Select the check box corresponding to the AcronisCommandLineTool.msi file.
4. Specify the folder where to extract the file.
5. Click Extract.
6. After the file is successfully extracted, click Finish.
7. Go to the folder where the AcronisCommandLineTool.msi file is extracted, and launch the file.
8. Follow the Install Wizard instructions on the screen.
%ProgramFiles%\Acronis\CommandLineTool (in 32-bit Windows)
%ProgramFiles(x86)%\Acronis\CommandLineTool (in 64-bit Windows)
/usr/lib/Acronis/CommandLineTool (in Linux)
1.2 Backward compatibility and upgrade
Upgrading the command-line utility from Acronis Backup & Recovery 10
When you upgrade a stand-alone edition of Acronis Backup & Recovery 10 to Acronis Backup &
Recovery 11, no additional actions are needed to upgrade the command-line utility.
When you upgrade an edition with centralized management, the software installs the command-line
utility on every machine where an agent is installed. No additional actions are needed.
Backward compatibility
The Acronis Backup & Recovery 11 command-line utility is backward compatible with the Acronis
Backup & Recovery 10 command-line utility. You can continue using the old syntax. Just type
acrocmd instead of trueimagecmd.
To continue using your existing scripts, edit the scripts so that trueimagecmd is replaced with
acrocmd. If your scripts contain the path to the trueimagecmd utility, replace it with the path to
the acrocmd utility. Retain all other parameters and values.
Before switching to acrocmd, make sure that all the product components are upgraded. Acronis Backup &
Recovery 10 does not support acrocmd.
Combination of the old and new syntaxes is acceptable within a script, but is not acceptable within a
command string. When you create new scripts, we recommend that you use the new syntax.
Even when using the old syntax, logs and commands' output will appear in the new format.
Extensions of backup file names
The behavior of the /filename parameter with the backup commands is slightly different in Acronis
Backup & Recovery 10 and Acronis Backup & Recovery 11. Unlike Acronis Backup & Recovery 10,
where the extension of a backup file is exactly the same as you specify in the parameter value,
Acronis Backup & Recovery 11 adds the *.tib extension to this value.
For example:
In Acronis Backup & Recovery 10, if you specify /filename:<path>my_backup.bak, the
backup file name will be my_backup.bak
In Acronis Backup & Recovery 11, if you specify /filename:<path>my_backup.bak, the
backup file name will be my_backup.bak.tib. However, if you specify
/filename:<path>my_backup.tib, the backup file name will also be my_backup.tib.
acrocmd <command> --<parameter 1>=<value list 1> … --<parameter N>=<value list N>
Typographic conventions
Descriptions of commands and parameters use the following specific typographic conventions.
Between angle brackets (<>) – information that the user must supply. Example: <IP address or
hostname>
Between braces ({}); choices separated by pipe (|) – a set of choices from which the user must
choose only one. Example: {on|off}.
Parameter values
For some parameters, you should specify only one value. The description of such value is written in
the singular. For example, if you see --arc=<archive name>, specify only one archive name in this
parameter.
For some parameters, you can enter one or more values. The description of such values is written in
the plural. For example, if you see --volume=<volume numbers>, you can specify a list of volume
numbers in this parameter.
Separators
A parameter name and a value list can be separated by either an equals sign or a space character.
Values in a value list can be separated by either a comma or a space character.
Examples:
acrocmd backup disk --disk=1,2
acrocmd backup disk --disk=1 2
acrocmd backup disk --disk 1,2
acrocmd backup disk --disk 1 2
Files with input parameters
acrocmd supports files with input parameters. The contents of an input parameter file are
concatenated with the parameters in the command line.
For example, the command
acrocmd backup disk -f params.txt
where the content of the file params.txt is
--disk=1 --loc=e:\my_backups --arc=archive123
equals to
acrocmd backup disk --disk=1 --loc=e:\my_backups --arc=archive123
1.4 Local, remote and centralized management
Advanced editions of Acronis Backup & Recovery 11 enable you to perform local, remote and
centralized management of any machine where an Acronis Backup & Recovery 11 agent is installed.
For local management, you install the command-line utility on the same machine where the Acronis
Backup & Recovery 11 agent is installed. The operations are performed under the user account you
are logged on with.
Example
To view all disks of the local machine, run the following command:
acrocmd list disks
Remote management
For remote management, you install the command-line utility on the machine from which you prefer
to operate (run commands or scripts).
Along with the command, you specify:
the IP address or host name of the remote machine that has an Acronis Backup & Recovery 11
agent (--host)
credentials (a pair of user name and password) for access to that machine
The user whose credentials you specify must be a member of the Acronis Remote Users security
group on that machine. The operations are performed under this user account.
Example
To view all disks of a remote machine, run the following command:
acrocmd list disks --host=<IP address or hostname> --credentials=<user
name>,<password>
Centralized management
Commands on a machine
Through Acronis Backup & Recovery 11 Management Server, you can manage any registered
machine using the credentials of the management server's administrator. Credentials for each
remote machine are not required.
For a number of commands, you can specify comma-separated addresses of multiple machines. The
operation will be executed on all the specified machines one after another.
Along with the command, you specify:
the IP address or host name of the machine that has an Acronis Backup & Recovery 11 agent
(--address)
the IP address or host name of the management server (--host)
the name of the management server service (--service=ams)
credentials for access to the management server
The user whose credentials you specify must be a member of the Acronis Centralized Admins security
group on the management server. If you are running the command-line utility on a different
machine, the user must also be a member of the Acronis Remote Users security group on the
management server.
# cd /usr/lib/Acronis/CommandLineTool/uninstall
# ./uninstall
To uninstall the command-line utility in the unattended mode, run the ./uninstall commands
with the -a parameter.
Uninstallation in Windows
When you uninstall Acronis Backup & Recovery 11 by clicking Start -> All Programs -> Acronis ->
Uninstall Acronis Backup & Recovery 11, the command-line utility is uninstalled along with all
product components.
To uninstall the command-line utility separately from the product
1. Run the Acronis Backup & Recovery 11 setup file.
2. Click Extract installation files.
3. Select the check box corresponding to the AcronisCommandLineTool.msi file.
4. Specify the folder where to extract the file.
5. Click Extract.
6. After the file is successfully extracted, click Close.
where <path> is the folder where the file is extracted.
If you have an edition with centralized management, you can also uninstall the command-line utility
from the setup file. To do so, run the Acronis Backup & Recovery 11 setup file, click Install Acronis Backup & Recovery 11, then click Modify, and then clear the check box next to the name of the
command-line utility.
1.6 List of abbreviated names
This document uses the following abbreviated names.
AMS – Acronis Backup & Recovery 11 Management Server and this component's service.
MMS – Acronis Managed Machine Service, the service running on a machine where an Acronis agent
is installed.
ASN – Acronis Backup & Recovery 11 Storage Node and this component's service.
Agent for ESX(i) – Acronis Backup & Recovery 11 Agent for VMware vSphere ESX(i).
This section lists the supported commands and compatible parameters.
When using the command-line utility, you can view the information about the supported commands
by means of the help (p. 14) command.
2.1 Commands by services
The following table summarizes the commands that can be executed by the Acronis services. For
questions on how to connect to an Acronis service, please see the --service (p. 48) command
description.
* The AMS service does not execute these commands by itself. It only defines which Agent for ESX(i) or Agent
for Hyper-V can execute the command and transmits the command to the corresponding MMS. If you want
Agent for Windows to perform the operation, specify its registration address in the --address (p. 48)
parameter.
2.2 help
The command provides the information about the supported commands.
Type acrocmd help to get the list of all available commands.
Type acrocmd help <text fragment> to get the list of all commands that begin with the
fragment you specified.
For example, acrocmd help ba lists the following commands: backup disk, backup file,
etc.
Type acrocmd help <complete command name> to view the information about this command.
For example, acrocmd help backup disk displays the information about the backup disk
command.
2.3 Backup and recovery
2.3.1 Disks and volumes
2.3.1.1 list disks
Lists available disk groups, disks, volumes and unallocated space.
Examples (p. 70)
Parameters
Units of measurement
--size_measure={s|kb|mb|gb}
Measure of the size of disks and volumes. If not specified, the value is mb.
--start_measure={s|kb|mb|gb}
Measure of the offset of volumes. If not specified, the value is mb.
General parameters
--log=<full path> (p. 67)
--output={formatted|raw} (p. 67)
--progress (p. 67)
{-f|--file_params}=<full local path> (p. 67)
Access to a remote machine (advanced editions only)
--host=<IP address or hostname> (p. 48)
--credentials=<user name>,<password> (p. 50)
--address=<IP address or hostname> (p. 48)
Access to a specific service within a machine (advanced editions only)
--progress (p. 67)
{-f|--file_params}=<full local path> (p. 67)
Access to a remote machine (advanced editions only)
--host=<IP address or hostname> (p. 48)
--credentials=<user name>,<password> (p. 50)
--address=<IP addresses or hostnames> (p. 48)
Access to a specific service within a machine (advanced editions only)
--service={mms|ams} (p. 48)
2.3.1.3 recover disk
Recovers the specified disk or volume. You can recover only one disk or volume at a time.
A disk is always recovered along with its MBR. When you recover a volume, the MBR is not
recovered. You can use the recover mbr (p. 18) command in this case.
Examples (p. 70)
Parameters
What to recover
--loc=<path> (p. 51)
--credentials=<user name>,<password> (p. 50)
--arc=<archive name> (p. 51)
--password=<password> (p. 67)
--backup=<backup ID> (p. 52)
--disk=<disk number> (p. 53)
--nt_signature={auto|new|backup|existing} (p. 53)
--volume=<volume number> (p. 54)
--oss_numbers (p. 69)
Where to recover
--target_disk=<disk number> (p. 61)
--target_volume=<volume number> (p. 61)
Recovering a disk
If the --target_disk parameter is specified, the software will recover to the specified disk.
If the --target_disk parameter is not specified, the software will first try to recover to the
original disk, namely, to that very disk you backed up. If the original disk is not found, the
command will fail.
If the --target_volume parameter is specified, the software will recover to the specified
volume.
If the --target_volume parameter is not specified, and the --target_disk parameter is
specified, the software will try to recover to the first unallocated space of a suitable size on the
specified disk. If no unallocated space of a suitable size is found, the command will fail.
If neither the --target_volume parameter nor the --target_disk parameter is specified,
the software will first try to recover to the original volume, namely, to that very volume you
backed up. If the original volume is not found, the software will recover to the first unallocated
space of a suitable size. If no unallocated space of a suitable size is found, the command will fail.
A volume will not be considered original if its size, location or other physical parameters have
been changed after backup. Changing the volume letter or label does not prevent the software
from recognizing the volume.
--start=<offset>{s|kb|mb|gb} (p. 55)
--size=<volume size>{s|kb|mb|gb} (p. 55)
How to recover
--fat16_32 (p. 62)
--ext2_3 (p. 62)
--type={active|primary|logical} (p. 62)
--preserve_mbr (p. 62)
--active_restore
If the parameter is specified, the Acronis Active Restore technology is enabled.
Recovery options
--reboot (p. 68)
--reboot_after (p. 68)
--silent_mode={on|off} (p. 68)
--retry_count=<number of attempts> (p. 68)
--retry_delay=<delay> (p. 68)
--ftp_active (p. 69)
Acronis Universal Restore parameters
--ur_driver=<INF file name>
Specifies using Acronis Universal Restore and the mass storage driver to be installed.
--ur_path=<search folder>
Specifies using Acronis Universal Restore and the path to the driver storage.
General parameters
--log=<full path> (p. 67)
--output={formatted|raw} (p. 67)
--progress (p. 67)
{-f|--file_params}=<full local path> (p. 67)
Access to a remote machine (advanced editions only)
--progress (p. 67)
{-f|--file_params}=<full local path> (p. 67)
Access to a remote machine (advanced editions only)
--host=<IP address or hostname> (p. 48)
--credentials=<user name>,<password> (p. 50)
--address=<IP addresses or hostnames> (p. 48)
Access to a specific service within a machine (advanced editions only)
--service={mms|ams} (p. 48)
2.3.2.2 recover file
Recovers files and folders from a file-level or disk-level backup.
Examples (p. 72)
Parameters
What to recover
--loc=<path> (p. 51)
--credentials=<user name>,<password> (p. 50)
--arc=<archive name> (p. 51)
--password=<password> (p. 67)
--backup=<backup ID> (p. 52)
--file=<paths> (p. 60)
--exclude=<files, folders and masks> (p. 60)
Where to recover
--target=<path> (p. 52)
--credentials=<user name>,<password> (p. 50)
How to recover
--overwrite={always|older|newer} (p. 63)
--recover_absolute_path (p. 63)
--recover_security={true|false}
This parameter is effective only when recovering from a file-level backup of Windows files. If the
value is true or if the parameter is not specified, recover NTFS permissions for files along with
the files themselves. Otherwise, the files will inherit the NTFS permissions from the folder to
which they will be recovered.
--original_date
Recover files' original date and time from the backup. If not specified, the current date and time
are assigned.
--progress (p. 67)
{-f|--file_params}=<full local path> (p. 67)
Access to a remote machine (advanced editions only)
--host=<IP address or hostname> (p. 48)
--credentials=<user name>,<password> (p. 50)
--address=<IP address or hostnames> (p. 48)
Access to a specific service within a machine (advanced editions only)
--service={mms|ams} (p. 48)
2.3.3 Virtual machines
The commands listed in this section are available in the Acronis Backup & Recovery 11 Advanced
Server Virtual edition only if Agent for ESX(i) or Agent for Hyper-V is installed. (This does not apply to
the recover vm (p. 23) command.)
2.3.3.1 list vms
Lists virtual machines that are present on the specified management server or that are managed by
Agent for ESX(i) or Agent for Hyper-V, depending on the service that will execute the command.
Examples (p. 73)
Parameters
General parameters
--log=<full path> (p. 67)
--output={formatted|raw} (p. 67)
--progress (p. 67)
{-f|--file_params}=<full local path> (p. 67)
Access to a remote machine (advanced editions only)
--host=<IP address or hostname> (p. 48)
--credentials=<user name>,<password> (p. 50)
Access to a specific service within a machine (advanced editions only)
Creates a backup of specified disks and volumes of the specified virtual machines. If neither --disk
nor --volume parameter is specified, the command backs up the entire machine.
You can specify one or more virtual machines to be backed up.
--simultaneous_backup=<number>
Number of virtual machines to be backed up simultaneously by Agent for ESX(i) or Agent for
Hyper-V. If not specified, each agent will back up virtual machines two at a time simultaneously.
To back up machines one at a time, set the parameter value to 1.
--progress (p. 67)
{-f|--file_params}=<full local path> (p. 67)
Access to a remote physical machine
--host=<IP address or hostname> (p. 48)
--credentials=<user name>,<password> (p. 50)
Access to a specific service within a machine (advanced editions only)
--service={mms|ams} (p. 48)
2.3.3.3 recover vm
Recovers a disk or volume backup onto a new or existing virtual machine. The recover vm
command replaces and enhances the convert command which was available in earlier versions of
the Acronis software.
The recover vm command can be executed by the following agents:
Agent for ESX(i) recovers a disk (volume) backup to a new or existing ESX(i) virtual machine.
Agent for Hyper-V recovers a disk (volume) backup to a new or existing Hyper-V virtual machine.
Agent for Windows recovers a disk (volume) backup to a new virtual machine of any of the
following types: VMware Workstation, Microsoft Virtual PC, Parallels Workstation or Citrix
XenServer Open Virtual Appliance (OVA).
Files of the fully configured and operational machine will be placed in the folder you select. You
can start the machine using the respective virtualization software or prepare the machine files
for further usage. The OVA virtual appliance can be imported to XenServer. Disks of a Virtual PC
can be attached to a Hyper-V virtual machine.
A virtual machine must be powered off during the recovery to this machine. The target machine located on an
ESX(i) or Hyper-V host will be powered off without a prompt. Please be sure to specify the correct machine.
Examples (p. 73)
Parameters
What to recover
--loc=<path> (p. 51)
--credentials=<user name>,<password> (p. 50)
--arc=<archive name> (p. 51)
--password=<password> (p. 67)
--backup=<backup ID> (p. 52)
--disk=<disk number> (p. 53)
--volume=<volume number> (p. 54)
Where to recover
If you want to recover to an existing virtual machine:
If the parameter is specified, the following properties will be displayed for each archive: name;
type; creation date; machine whose data is contained in the archive; owner (the user who saved
the archive to the destination); occupied space in bytes; and comments on the archive. If not
specified, only name, type and creation date will be displayed for each archive.
General parameters
--log=<full path> (p. 67)
--output={formatted|raw} (p. 67)
--progress (p. 67)
{-f|--file_params}=<full local path> (p. 67)
Access to a remote machine (advanced editions only)
--host=<IP address or hostname> (p. 48)
--credentials=<user name>,<password> (p. 50)
--address=<IP address or hostname> (p. 48)
Access to a specific service within a machine (advanced editions only)
--service={mms|ams|asn} (p. 48)
2.4.1.2 export archive
Copies the archive specified by the --arc parameter from the location specified by the --loc
parameter to the location specified by the --target parameter.
If the --arc parameter is not specified, the command will export all the archives stored in the
source location.
The command always creates a new archive in the target location. You cannot specify an existing
archive in the --target_arc parameter.
Using this command, you can, for example, import an archive to a centralized managed vault or
export the entire vault to a different location.