2.1 Commands by services ............................................................................................................11
2.1.1 Disk and file backup ...................................................................................................................................... 11
2.3.4 Microsoft Exchange ....................................................................................................................................... 31
2.3.5 Microsoft SQL ................................................................................................................................................ 35
2.4 Operations with archives and backups ....................................................................................38
2.7 Operations with tapes .............................................................................................................54
2.7.1 list tape_libraries ........................................................................................................................................... 54
2.7.2 list tape_slots ................................................................................................................................................. 55
2.9 Operations with disks ..............................................................................................................57
2.9.1 clone disk ....................................................................................................................................................... 57
2.10 Operations with machines .......................................................................................................57
2.12.1 Collecting information .................................................................................................................................. 63
3.1.2 service ............................................................................................................................................................ 71
3.2.1 Access to a virtual machine .......................................................................................................................... 72
3.2.2 New virtual machine ..................................................................................................................................... 73
3.3.4 Specifying Exchange data ............................................................................................................................. 78
3.3.5 Specifying SQL data ....................................................................................................................................... 78
3.3.6 Access to SQL Server instance ...................................................................................................................... 79
3.4.1 loc ................................................................................................................................................................... 79
3.5 Disks and volumes ...................................................................................................................83
3.5.1 disk ................................................................................................................................................................. 83
3.6.8 include ............................................................................................................................................................ 90
3.6.11 raw .................................................................................................................................................................. 91
3.7.21 type ............................................................................................................................................................... 103
3.8.2 letter ............................................................................................................................................................. 104
3.12.5 id ................................................................................................................................................................... 113
3.12.18 utc ................................................................................................................................................................. 117
4.1.4 Microsoft Exchange ..................................................................................................................................... 123
4.1.5 Microsoft SQL .............................................................................................................................................. 124
4.2 Operations with archives and backups ..................................................................................125
4.10.1 Collecting information ................................................................................................................................ 132
Acronis Backup supports the command-line interface with the acrocmd utility.
acrocmd does not contain any tools that physically execute the commands. It merely provides the
command-line interface to Acronis Backup components—agents 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 in 64-bit Linux-based bootable media and in PE-based bootable
media. When acrocmd is installed on a Mac machine or is accessed under Mac-based bootable
media, you need to specify the full path to the utility.
1.1 Installation
Install the command-line utility on the machine from which you prefer to operate (run commands or
scripts). The machine may run Windows, Linux, or Mac. From this machine, you can manage other
machines running any of these operating systems.
The command-line utility is installed by default with Agent for Windows, Agent for Linux, or Agent for
Mac.
In Windows, you can also install the utility separately from the setup file. To do this, in the offline
installer click Customize installation settings, and then clear all of the check boxes except for Command-Line Tool.
The default installation paths are:
%ProgramFiles%\Acronis\CommandLineTool (in Windows)
/usr/lib/Acronis/CommandLineTool (in Linux)
/Library/Application Support/BackupClient/Acronis/sbin (in Mac)
1.2 Syntax
acrocmd has the following format:
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
General view
Example
"<value with space character>"
--include="C:\my documents"
\"<value with comma>\"
--include=\"E:\Employees(A,B)\"
"\"<value with space character and comma>\""
--include="\"D:\my photos\my wife, my kids
and me\""
the plural. For example, if you see --volume=<volume numbers>, you can specify a list of volume
numbers in this parameter.
Separators
An equal sign separates a parameter name and a value list. A comma separates values in a value list.
Example:
acrocmd backup disk --disk=1,2
Enclosing parameter values that contain commas and space characters
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.3 Local, remote, and centralized management
Acronis Backup enables you to perform local, remote, and centralized management of any machine
where an Acronis Backup agent is installed.
Local management
For local management, you install the command-line utility on the same machine where the Acronis
Backup 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).
the IP address or host name of the remote machine that has an Acronis Backup 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
This functionality is only available in on-premise deployments of Acronis Backup, i.e. when Acronis
Backup Management Server is installed in your local network. For details about types of deployment,
refer to the "Installation overview" section of the Acronis Backup help.
Commands on a machine
Through Acronis Backup 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 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.
The operations on the machine are performed under the account of the agent service running on
that machine (Acronis Agent User account).
Example
To view all disks of a machine through the management server, run the following command:
acrocmd list disks --host=<ams hostname> --credentials=<user name>,<password>
--service=ams --address=<IP address or hostname>
Commands on the management server
There are commands that can be executed by the management server itself.
Example
To view the current activities of the management server, run the following command:
acrocmd list activities --host=<ams hostname> --credentials=<user name>,<password>
--service=ams
The below diagram shows options of access to a managed machine directly or via Acronis Backup
Management Server.
Options of access to a managed machine
1.4 Uninstallation
Uninstallation in Windows
To completely uninstall Acronis Backup, along with the command-line utility, go to Control panel and
select Programs and Features (Add or Remove Programs in Windows XP) > Acronis Backup > Uninstall.
To uninstall the command-line utility separately from the product
1. Download the Acronis Backup setup program. The links to the setup programs are present on the
Downloads page (click the account icon in the top-right corner > Downloads).
2. Run the setup program.
3. Click Modify the current installation.
4. Clear the check box next to the name of the command-line utility.
5. Click Modify.
Uninstallation in Linux and Mac
In Linux and Mac, the command-line utility is uninstalled along with all Acronis Backup components.
For the information about complete uninstallation of the product, refer to:
http://www.acronis.com/en-us/support/documentation/AcronisBackup_12.5/index.html#37129.htm
l
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. 16) command.
2.1 Commands by services
2.1.1 Disk and file backup
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. 71) command
description.
* The command-line utility is not available in 32-bit Linux-based bootable media.
Command
AMS
MMS
Agent for
Exchange
Agent for
SQL
Agent for
Active
Directory*
Reserved
Backup and recovery
list
exchange_databases (p.
32)
+
backup
exchange_database (p.
32)
+
recover
exchange_database (p.
33)
+
recover
exchange_mailbox (p.
34)
+
list mssql_instances
(p. 35)
+
list mssql_databases
(p. 35)
+
backup mssql_database
(p. 36)
+
recover
mssql_database (p. 37)
+
Operations with archives and backups **
list archives (p. 38)
+ + +
export archive (p. 39)
+ + +
validate archive (p. 40)
+ + +
delete archive (p. 40)
+ + +
list backups (p. 41)
+ + +
list content (p. 42)
+
+
validate backup (p. 42)
+ + +
2.1.2 Application backup
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. 71) command
description.
* This agent can execute all of the commands that can be executed by Agent for Windows (p. 11).
Command
AMS
MMS
Agent for
VMware
Agent for
Hyper-V
Reserved
Reserved
Backup and recovery
list vmservers (p. 24)
+ + +
list vms (p. 25)
+ + +
deploy vm_agent (p. 25)
+
list disks (p. 16)
+
+
backup vm (p. 27)
+* + +
backup esxi_config (p.
28)
+
recover vm (p. 30)
+* + +
delete vm (p. 31)
+
Advanced operations with virtual machines
list replicas (p. 58)
+
+
replicate vm (p. 58)
+
failover vm (p. 59)
+
fallback vm (p. 60)
+
mount vm (p. 61)
+
+
umount vm (p. 62)
+
+
finalize vm_recovery
(p. 63)
+
** Agent for Exchange and Agent for SQL can perform these operations only with backups of the respective
application data.
2.1.3 Virtual machine backup
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. 71) command
description.
* The AMS service does not execute these commands by itself. It only defines which Agent for VMware or
Agent for Hyper-V can execute the command and transmits the command to the corresponding MMS.
A disk is always recovered along with its MBR. When you recover a volume, the MBR is not recovered
unless you use the --mbr_disk and --target_mbr_disk parameters.
Recovering disks
If the --target_disk parameter is specified, the software will recover each disk specified in
the --disk parameter to the corresponding disk specified in the --target_disk parameter.
For example, if you type --disk=1,2 --target_disk=3,4, the software will recover disk 1 to
disk 3 and disk 2 to disk 4. If the number of values of the --disk and --target_disk
parameters differ, the command will fail.
If the --target_disk parameter is not specified, the software will automatically map the disks
specified in the --disk parameter to the target machine's disks. If the automatic mapping is not
successful, the command will fail.
Recovering volumes
If the --target_volume parameter is specified, the software will recover each volume
specified in the --volume parameter to the corresponding volume specified in the
--target_volume parameter. For example, if you type --volume=3-1,3-2
--target_volume=1-1,1-2, the software will recover volume 3-1 to volume 1-1 and volume
3-2 to volume 1-2. If the number of values of the --volume and --target_volume parameters
differ, the command will fail.
If the --target_volume parameter is not specified, and the --target_disk parameter is
specified, the software will try to recover all of the volumes specified in the --volume
parameter 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. You can specify only one target disk, even
when recovering several volumes.
If neither the --target_volume parameter nor the --target_disk parameter is specified,
the software will automatically map the volumes specified in the --volume parameter to the
target machine's disks. If the automatic mapping is not successful, the command will fail.
--start=<offset>{s|kb|mb|gb} (p. 86)
--size=<volume size>{s|kb|mb|gb} (p. 86)
--target_mbr_disk=<disk number> (p. 86)
How to recover
--fat16_32 (p. 99)
--ext2_3 (p. 99)
--preserve_mbr (p. 100)
--recovery_mode={auto|incremental|full} (p. 101)
--recreate_archive_meta={true|false} (p. 116)
--type={active|primary|logical} (p. 103)
--use_all_space (p. 103)
Recovery options
--force_yes (p. 112)
--reboot (p. 115)
--reboot_after (p. 115)
--retry_count=<number of attempts> (p. 111)
--retry_delay=<delay> (p. 111)
--silent_mode={on|off} (p. 116)
--use_registry_defaults (p. 116)
Acronis Universal Restore parameters
These parameters are only applicable under bootable media.
--ur_driver=<INF file name>
Specifies using Acronis Universal Restore and the mass storage driver to be installed.
Use this command to repair an MBR on the same machine that was backed up. When migrating to
different hardware, use the recover disk (p. 18) command with either the --disk parameter (the
MBR will be recovered automatically) or the --volume, --mbr_disk, and --target_mbr_disk
parameters.
Creates the same logical volume structure on the specified machine as in the backed-up system. Use
this command if you need to recover a Linux system, along with its software RAID or LVM structure,
to a machine with different logical volume structure or without logical volumes.
The specified machine must be booted with 64-bit Linux-based bootable media. If you are using
32-bit media, either run the command on another machine with the acrocmd utility installed or
recover the LVM structure via the graphical user interface.
Before executing the command, ensure that the machine has enough disks that are as big or bigger
than the original disks. Execute the command prior to the recover disk (p. 18) command. Then,
recover each volume to the corresponding volume of the target machine.
Caution: As a result of this command execution, the current volume structure on the machine will be replaced
with the one stored in the backup. This will destroy the data that is currently stored on some or all of the
machine's hard disks.
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.
The commands listed in this section are available only if Agent for VMware or Agent for Hyper-V is
installed. (This does not apply to the recover vm (p. 30) command.)
2.3.3.1 list vmservers
Lists virtualization servers and server clusters that are present on the specified management server
or that are accessible to Agent for VMware.
Examples (p. 121)
Parameters
--filter_guid=<GUIDs> (p. 107)
--filter_name=<names> (p. 107)
--filter_machines=<quantities of machines> (p. 107)
--filter_type=<server types> (p. 109)
General parameters
--log=<full path> (p. 113)
--log_format={structured|unstructured} (p. 113)
--output={formatted|raw} (p. 114)
{-f|--file_params}=<full local path> (p. 112)
Lists virtual machines that are present on the specified management server or that are managed by
Agent for VMware or Agent for Hyper-V, depending on the service that will execute the command.
Deploys Agent for VMware (Virtual Appliance) to an ESX(i) host managed by a vCenter Server or to a
stand-alone ESX(i) host.
You can deploy only one agent at a time. The --service=ams parameter is mandatory because the
command is executed by the management server.
Examples (p. 121)
Parameters
--vsphere_address=<IP address or hostname>
vCenter Server that manages the vSphere to which you want to deploy the agent. If you need to
deploy the agent to a stand-alone ESX(i) host, specify this host.
If the parameter is not specified, the command will fail.
Credentials that the agent will use to access the vCenter Server or the ESX(i) host. The account
must have the necessary privileges on the vCenter Server, as described in the "Privileges for VM
backup and recovery" section of the "Backing up virtual machines" document.
If the parameter is not specified, the agent will use the credentials specified after the
--vsphere_address parameter.
--vmhost=<IP address or hostname>
ESX(i) host to which you want to deploy the agent. If not specified, the host will be selected
automatically.
The parameter is used only if the --vsphere_address parameter points to a vCenter Server. If
it points to a stand-alone ESX(i) host, the --vmhost parameter is redundant.
--vmname=<virtual machine name>
Name of the virtual appliance. If not specified, the value is AcronisESXAppliance-[N] where
[N] is a sequence number of the appliance deployment attempt.
--vmstorage=<datastore name>
Location of the virtual appliance. If not specified, the software will automatically select one of
the datastores available to the host.
--vmnic={flexible|E1000|vmxnet|vmxnet2|vmxnet3}
Type of the virtual appliance's network adapter. If not specified, the value is vmxnet3.
--vmnetwork=<network label> (p. 76)
--mac_address=<MAC address>
MAC address of the virtual appliance's network adapter. The format is XX:XX:XX:XX:XX:XX.
For example, --mac_address=00:50:56:8c:00:00. If not specified, the software will
generate the MAC address.
Network settings of the virtual appliance
If any of the parameters described in this section are not specified, the virtual appliance will obtain
the values from the DHCP server that is present on your network.
--ip_address=<IP address>
IP address. For example, --ip_address=10.200.200.10.
--subnet_mask=<subnet mask>
Subnet mask. For example, --subnet_mask=255.255.255.0.
--gateway=<default gateway>
Default gateway. For example, --gateway=10.200.200.1.
--dns=<DNS servers>
IP addresses of the DNS servers. For example, --dns=10.200.200.101,10.200.200.102.
--dns_suffix=<DNS suffix>
DNS suffix. For example, --dns_suffix=mydomain.com.
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. The --vmname parameter is
case-sensitive.
--simultaneous_backup=<number>
Number of virtual machines to be backed up simultaneously by Agent for VMware 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.
Name or identifier of the ESXi host whose configuration will be backed up. If the software finds
more than one host with the same name, an error occurs.
To learn names and identifiers of virtualization hosts, use the list vmservers (p. 24)
command.
--credentials=<password>,encrypted
Password for the 'root' account on the selected host.
Recovers a disk or volume backup onto a new or existing virtual machine.
The recover vm command can be executed by the following agents:
Agent for VMware 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.
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.