Acronis Backup Command Line Reference 11.7 Cmdlineref En

User Manual: acronis Backup 11.7 - Command-Line Reference Free User Guide for Acronis Backup Software, Manual

Open the PDF directly: View PDF PDF.
Page Count: 149 [warning: Documents this large are best viewed by clicking the View PDF Link!]

Acronis Backup
Version 11.7
COMMAND-LINE REFERENCE
APPLIES TO THE FOLLOWING PRODUCTS
All products of the Acronis Backup family and the Acronis Backup Advanced suite
2 Copyright © Acronis International GmbH, 2002-2016
Copyright Statement
Copyright © Acronis International GmbH, 2002-2016. All rights reserved.
“Acronis” and “Acronis Secure Zone” are registered trademarks of Acronis International GmbH.
"Acronis Compute with Confidence", “Acronis Startup Recovery Manager”, “Acronis Active Restore”,
“Acronis Instant Restore” and the Acronis logo are trademarks of Acronis International GmbH.
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
Acronis patented technologies
Technologies, used in this product, are covered and protected by one or more U.S. Patent Numbers:
7,047,380; 7,275,139; 7,281,104; 7,318,135; 7,353,355; 7,366,859; 7,475,282; 7,603,533; 7,636,824;
7,650,473; 7,721,138; 7,779,221; 7,831,789; 7,886,120; 7,895,403; 7,934,064; 7,937,612; 7,949,635;
7,953,948; 7,979,690; 8,005,797; 8,051,044; 8,069,320; 8,073,815; 8,074,035; 8,145,607; 8,180,984;
8,225,133; 8,261,035; 8,296,264; 8,312,259; 8,347,137; 8,484,427; 8,645,748; 8,732,121 and patent
pending applications.
3 Copyright © Acronis International GmbH, 2002-2016
Table of contents
1 Command-line utility overview ........................................................................................7
1.1 Installation ................................................................................................................................. 7
1.2 Backward compatibility and upgrade ........................................................................................ 8
1.3 Syntax ......................................................................................................................................... 8
1.4 Local, remote, and centralized management ............................................................................ 9
1.5 Uninstallation ...........................................................................................................................11
1.6 List of abbreviated names........................................................................................................12
2 Commands .................................................................................................................... 13
2.1 Commands by services ............................................................................................................13
2.1.1 Disk, file, virtual machine backup................................................................................................................. 13
2.1.2 Application backup ........................................................................................................................................ 15
2.2 help ..........................................................................................................................................18
2.3 Backup and recovery ...............................................................................................................18
2.3.1 Disks and volumes ......................................................................................................................................... 18
2.3.2 Files ................................................................................................................................................................. 24
2.3.3 Virtual machines ............................................................................................................................................ 27
2.3.4 Microsoft Exchange ....................................................................................................................................... 33
2.3.5 Microsoft SQL ................................................................................................................................................ 38
2.3.6 Microsoft Active Directory............................................................................................................................ 41
2.4 Operations with archives and backups ....................................................................................42
2.4.1 Archives .......................................................................................................................................................... 42
2.4.2 Backups .......................................................................................................................................................... 46
2.4.3 Mounting volumes ........................................................................................................................................ 53
2.4.4 Mounting SQL databases .............................................................................................................................. 54
2.5 Operations with Acronis Secure Zone .....................................................................................56
2.5.1 create asz ....................................................................................................................................................... 56
2.5.2 resize asz ........................................................................................................................................................ 57
2.5.3 cleanup asz..................................................................................................................................................... 58
2.5.4 delete asz_files .............................................................................................................................................. 58
2.5.5 delete asz ....................................................................................................................................................... 59
2.6 Operations with Acronis Startup Recovery Manager ..............................................................59
2.6.1 activate asrm ................................................................................................................................................. 59
2.6.2 deactivate asrm ............................................................................................................................................. 60
2.7 Operations with tapes .............................................................................................................60
2.7.1 list tape_libraries ........................................................................................................................................... 60
2.7.2 list tape_slots ................................................................................................................................................. 61
2.7.3 inventory tape ............................................................................................................................................... 61
2.8 Operations with vaults .............................................................................................................62
2.8.1 list vaults ........................................................................................................................................................ 62
2.8.2 validate vault ................................................................................................................................................. 63
2.8.3 catalog vault................................................................................................................................................... 63
2.9 Operations with disks ..............................................................................................................64
2.9.1 clone disk ....................................................................................................................................................... 64
2.10 Operations with machines .......................................................................................................65
2.10.1 add machine .................................................................................................................................................. 65
4 Copyright © Acronis International GmbH, 2002-2016
2.11 Administration operations .......................................................................................................66
2.11.1 Collecting information .................................................................................................................................. 66
2.11.2 Activities ......................................................................................................................................................... 67
2.11.3 Plans ............................................................................................................................................................... 68
2.11.4 Tasks ............................................................................................................................................................... 72
2.11.5 Licenses .......................................................................................................................................................... 74
2.11.6 Reports ........................................................................................................................................................... 74
3 Parameters .................................................................................................................... 76
3.1 Access to a physical machine ...................................................................................................76
3.1.1 host ................................................................................................................................................................. 76
3.1.2 service ............................................................................................................................................................ 76
3.1.3 address ........................................................................................................................................................... 76
3.2 Virtual machines ......................................................................................................................77
3.2.1 Access to a virtual machine .......................................................................................................................... 77
3.2.2 New virtual machine ..................................................................................................................................... 78
3.3 Access to applications ..............................................................................................................80
3.3.1 exchange_credentials ................................................................................................................................... 80
3.3.2 instance .......................................................................................................................................................... 81
3.3.3 items ............................................................................................................................................................... 81
3.3.4 Specifying Exchange data ............................................................................................................................. 82
3.3.5 Specifying SQL data ....................................................................................................................................... 83
3.3.6 Access to SQL Server instance ...................................................................................................................... 83
3.4 Location ...................................................................................................................................84
3.4.1 loc ................................................................................................................................................................... 84
3.4.2 arc ................................................................................................................................................................... 84
3.4.3 backup ............................................................................................................................................................ 85
3.4.4 target .............................................................................................................................................................. 86
3.4.5 target_arc....................................................................................................................................................... 88
3.4.6 mailbox_location ........................................................................................................................................... 88
3.5 Disks and volumes ...................................................................................................................88
3.5.1 disk ................................................................................................................................................................. 88
3.5.2 nt_signature ................................................................................................................................................... 89
3.5.3 volume ........................................................................................................................................................... 89
3.5.4 start ................................................................................................................................................................ 91
3.5.5 size .................................................................................................................................................................. 91
3.5.6 mbr_disk ........................................................................................................................................................ 91
3.5.7 target_mbr_disk ............................................................................................................................................ 92
3.6 Backup parameters ..................................................................................................................92
3.6.1 application_aware ......................................................................................................................................... 92
3.6.2 backuptype .................................................................................................................................................... 92
3.6.3 cleanup ........................................................................................................................................................... 92
3.6.4 Comments...................................................................................................................................................... 93
3.6.5 copy_only ....................................................................................................................................................... 93
3.6.6 exclude ........................................................................................................................................................... 93
3.6.7 express ........................................................................................................................................................... 95
3.6.8 fixed_drive ..................................................................................................................................................... 95
3.6.9 ignore_app_errors ........................................................................................................................................ 96
3.6.10 include ............................................................................................................................................................ 96
3.6.11 mssql_truncate_logs ..................................................................................................................................... 96
3.6.12 plain_archive ................................................................................................................................................. 97
3.6.13 raw .................................................................................................................................................................. 97
3.6.14 Backup options .............................................................................................................................................. 98
3.7 Recovery parameters .............................................................................................................103
5 Copyright © Acronis International GmbH, 2002-2016
3.7.1 autorename ................................................................................................................................................. 103
3.7.2 database ....................................................................................................................................................... 104
3.7.3 database_location ....................................................................................................................................... 104
3.7.4 database_state ............................................................................................................................................ 105
3.7.5 destination_database ................................................................................................................................. 105
3.7.6 destination_instance ................................................................................................................................... 106
3.7.7 disk_location ................................................................................................................................................ 106
3.7.8 exclude ......................................................................................................................................................... 106
3.7.9 ext2_3 .......................................................................................................................................................... 107
3.7.10 fat16_32 ....................................................................................................................................................... 107
3.7.11 file ................................................................................................................................................................. 107
3.7.12 log_location ................................................................................................................................................. 107
3.7.13 original_date ................................................................................................................................................ 108
3.7.14 outlookmachine .......................................................................................................................................... 108
3.7.15 overwrite ...................................................................................................................................................... 108
3.7.16 pit .................................................................................................................................................................. 109
3.7.17 power_on ..................................................................................................................................................... 109
3.7.18 preserve_mbr .............................................................................................................................................. 109
3.7.19 recover_absolute_path .............................................................................................................................. 109
3.7.20 recovery_point ............................................................................................................................................ 110
3.7.21 target_disk ................................................................................................................................................... 111
3.7.22 target_volume ............................................................................................................................................. 111
3.7.23 type ............................................................................................................................................................... 112
3.7.24 use_all_space .............................................................................................................................................. 112
3.8 Mounting parameters ............................................................................................................112
3.8.1 for_all_users ................................................................................................................................................ 112
3.8.2 letter ............................................................................................................................................................. 113
3.8.3 mount_point ................................................................................................................................................ 113
3.8.4 rw .................................................................................................................................................................. 113
3.9 Acronis Secure Zone parameters ...........................................................................................114
3.9.1 asz_size ........................................................................................................................................................ 114
3.10 Filtering ..................................................................................................................................114
3.10.1 content_path ............................................................................................................................................... 114
3.10.2 content_type ............................................................................................................................................... 115
3.10.3 filter_available_for_backup ........................................................................................................................ 115
3.10.4 filter_date .................................................................................................................................................... 116
3.10.5 filter_edition ................................................................................................................................................ 116
3.10.6 filter_guid ..................................................................................................................................................... 116
3.10.7 filter_host ..................................................................................................................................................... 116
3.10.8 filter_library ................................................................................................................................................. 117
3.10.9 filter_machines ............................................................................................................................................ 117
3.10.10 filter_name .................................................................................................................................................. 117
3.10.11 filter_resource ............................................................................................................................................. 117
3.10.12 filter_state.................................................................................................................................................... 118
3.10.13 filter_status .................................................................................................................................................. 118
3.10.14 filter_type .................................................................................................................................................... 118
3.10.15 filter_user ..................................................................................................................................................... 118
3.10.16 filter_version ................................................................................................................................................ 119
3.11 Tape management parameters .............................................................................................119
3.11.1 assign2free ................................................................................................................................................... 119
3.11.2 libraries ......................................................................................................................................................... 119
3.11.3 mode ............................................................................................................................................................ 119
3.11.4 slots .............................................................................................................................................................. 120
3.12 General parameters ...............................................................................................................120
3.12.1 credentials ................................................................................................................................................... 120
6 Copyright © Acronis International GmbH, 2002-2016
3.12.2 Error handling .............................................................................................................................................. 120
3.12.3 file_params .................................................................................................................................................. 121
3.12.4 force_yes ...................................................................................................................................................... 121
3.12.5 id ................................................................................................................................................................... 122
3.12.6 log ................................................................................................................................................................. 122
3.12.7 log_format ................................................................................................................................................... 122
3.12.8 oss_numbers ............................................................................................................................................... 122
3.12.9 output........................................................................................................................................................... 123
3.12.10 password ...................................................................................................................................................... 123
3.12.11 process_priority ........................................................................................................................................... 123
3.12.12 progress........................................................................................................................................................ 124
3.12.13 read_speed .................................................................................................................................................. 124
3.12.14 reboot ........................................................................................................................................................... 125
3.12.15 recreate_archive_meta .............................................................................................................................. 125
3.12.16 report_format.............................................................................................................................................. 125
3.12.17 silent_mode ................................................................................................................................................. 126
3.12.18 use_registry_defaults.................................................................................................................................. 126
3.12.19 utc ................................................................................................................................................................. 126
4 Usage examples ........................................................................................................... 127
4.1 Backup and recovery .............................................................................................................127
4.1.1 Disks and volumes ....................................................................................................................................... 127
4.1.2 Files ............................................................................................................................................................... 130
4.1.3 Virtual machines .......................................................................................................................................... 131
4.1.4 Microsoft Exchange ..................................................................................................................................... 132
4.1.5 Microsoft SQL .............................................................................................................................................. 134
4.1.6 Microsoft Active Directory.......................................................................................................................... 135
4.2 Operations with archives and backups ..................................................................................136
4.2.1 Archives ........................................................................................................................................................ 136
4.2.2 Backups ........................................................................................................................................................ 137
4.2.3 Mounting volumes ...................................................................................................................................... 139
4.2.4 Mounting SQL databases ............................................................................................................................ 139
4.3 Operations with Acronis Secure Zone ...................................................................................140
4.4 Operations with Acronis Startup Recovery Manager ............................................................141
4.5 Operations with tapes ...........................................................................................................141
4.6 Operations with vaults ...........................................................................................................142
4.7 Operations with disks ............................................................................................................143
4.8 Operations with machines .....................................................................................................143
4.9 Administration operations .....................................................................................................143
4.9.1 Collecting information ................................................................................................................................ 143
4.9.2 Activities ....................................................................................................................................................... 143
4.9.3 Plans ............................................................................................................................................................. 144
4.9.4 Tasks ............................................................................................................................................................. 145
4.9.5 Licenses ........................................................................................................................................................ 145
4.9.6 Reports ......................................................................................................................................................... 145
4.10 Selecting logical volumes and MD devices for backup ..........................................................145
4.11 Scheduling backups under Linux using the cron service .......................................................146
5 Comparison of the old and new command-line syntax .................................................. 148
6 acronis_encrypt utility ................................................................................................. 149
7 Copyright © Acronis International GmbH, 2002-2016
1 Command-line utility overview
Acronis Backup 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 componentsagents, 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 in 64-bit Linux-based bootable media and in PE-based bootable
media.
1.1 Installation
Products with local management only (Acronis Backup)
If you have installed Acronis Backup, 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.
Products with centralized management (Acronis Backup Advanced)
Acronis Backup Advanced enables you to perform local, remote and centralized management (p. 9)
of any machine where an Acronis Backup 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 setup program.
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.
8 Copyright © Acronis International GmbH, 2002-2016
Installation paths
The default installation paths are:
%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, 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 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. 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
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, 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.
1.3 Syntax
acrocmd has the following format:
acrocmd <command> --<parameter 1>=<value list 1> … --<parameter N>=<value list N>
9 Copyright © Acronis International GmbH, 2002-2016
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
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
General view
"<value with space character>"
\"<value with comma>\"
"\"<value with space character and
comma>\""
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
Acronis Backup Advanced enables you to perform local, remote, and centralized management of any
machine where an Acronis Backup agent is installed.
10 Copyright © Acronis International GmbH, 2002-2016
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).
Along with the command, you specify:
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
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
11 Copyright © Acronis International GmbH, 2002-2016
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.5 Uninstallation
Uninstallation in Linux
In Linux, run the following commands to uninstall the command-line utility:
# 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.
12 Copyright © Acronis International GmbH, 2002-2016
Uninstallation in Windows
When you uninstall Acronis Backup by clicking Start -> All Programs -> Acronis -> Uninstall Acronis
Backup, 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 setup program.
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.
7. Run the following command:
msiexec /uninstall <path>\AcronisCommandLineTool.msi /qb
where <path> is the folder where the file is extracted.
If you have Acronis Backup Advanced, you can also uninstall the command-line utility as follows. Run
the Acronis Backup setup program, click Install Acronis Backup, 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 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 Storage Node and this component's service.
13 Copyright © Acronis International GmbH, 2002-2016
2 Commands
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. 18) command.
2.1 Commands by services
2.1.1 Disk, file, 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. 76) command
description.
Command
AMS
MMS
ASN
Agent for
Windows
Agent for
Linux
Agent for
VMware or
Hyper-V
Bootable
media*
Backup and recovery
list disks (p. 18)
+
+
+
+
backup disk (p. 19)
+
+
+
recover disk (p. 20)
+
+
+
recover mbr (p. 22)
+
+
+
recover lvm_structure
(p. 23)
Linux-base
d
backup file (p. 24)
+
+
+
recover file (p. 25)
+
+
+
+
list vmservers (p. 27)
+
+
list vms (p. 27)
+
+
deploy vm_agent (p. 28)
+
backup vm (p. 29)
+**
+
recover vm (p. 31)
+**
+ (create
vm files)
+ (create
vm files)
+ (create vm
on a server)
Operations with archives and backups
list archives (p. 42)
+
+
+
+
+
+
export archive (p. 43)
+
+
+
+
+
+
validate archive (p. 44)
+
+
+
+
+
+
catalog archive (p. 44)
+
+
+
+ except Agent
for VMware
(VA)
+
delete archive (p. 45)
+
+
+
+
+
+
list backups (p. 46)
+
+
+
+
+
+
14 Copyright © Acronis International GmbH, 2002-2016
Command
AMS
MMS
ASN
Agent for
Windows
Agent for
Linux
Agent for
VMware or
Hyper-V
Bootable
media*
list content (p. 46)
+
+
+
+
+
+
validate backup (p. 47)
+
+
+
+
+
+
catalog backup (p. 48)
+
+
+
+ except Agent
for VMware
(VA)
+
export backup (p. 49)
+
+
+
+
+
+
replicate backup (p. 49)
+
+
+
+
+
+
convert full (p. 50)
+
+
+
+
+
+
consolidate backup (p.
51)
+
+
+
+
+
delete backup (p. 52)
+
+
+
+
+
+
list mounts (p. 53)
+
+
+
mount (p. 53)
+
+
+
umount (p. 54)
+
+
+
Operations with Acronis Secure Zone
create asz (p. 56)
+
+
+
resize asz (p. 57)
+
+
+
cleanup asz (p. 58)
+
+
+
delete asz_files (p. 58)
+
+
+
delete asz (p. 59)
+
+
+
Operations with Acronis Startup Recovery Manager
activate asrm (p. 59)
+
+
+
deactivate asrm (p. 60)
+
+
+
Operations with tapes
list tape_libraries (p.
60)
+
+
+
list tape_slots (p. 61)
+
+
+
inventory tape (p. 61)
+
+
+
Operations with vaults
list vaults (p. 62)
+
+
+
+
+
validate vault (p. 63)
+
+
+
+
+
+
catalog vault (p. 63)
+
+
+
+ except Agent
for VMware
(VA)
+
Operations with disks
clone disk (p. 64)
+
+
+
Operations with machines
add machine (p. 65)
+
15 Copyright © Acronis International GmbH, 2002-2016
Command
AMS
MMS
ASN
Agent for
Windows
Agent for
Linux
Agent for
VMware or
Hyper-V
Bootable
media*
Administration operations
get log (p. 66)
+
+
+
+
+
+
sysinfo (p. 66)
+
+
+
+
+
+
list activities (p. 67)
+
+
+
+
+
stop activity (p. 68)
+
+
+
+
+
list plans (p. 68)
+
+
+
+
delete plan (p. 71)
+
+
+
+
export plan (p. 69)
+
+
+
+
import plan (p. 70)
+
+
+
+
disable plan (p. 70)
+
+
+
+
enable plan (p. 71)
+
+
+
+
list tasks (p. 72)
+
+
+
+
run task (p. 72)
+
+
+
+
stop task (p. 73)
+
+
+
+
delete task (p. 73)
+
+
+
+
list licenses (p. 74)
+
+
+
+
generate report (p. 74)
+
* The command-line utility is not available in 32-bit Linux-based bootable media.
** 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.
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. 76) command
description.
Command
AMS
MMS
ASN
Agent for
Exchange
Agent for
SQL*
Agent for
Active
Directory*
Reserved
Backup and recovery
list
exchange_databases (p.
33)
+
list
exchange_mailboxes (p.
33)
+
16 Copyright © Acronis International GmbH, 2002-2016
Command
AMS
MMS
ASN
Agent for
Exchange
Agent for
SQL*
Agent for
Active
Directory*
Reserved
backup
exchange_database (p.
34)
+
backup
exchange_mailbox (p.
35)
+
recover
exchange_database (p.
36)
+
recover
exchange_mailbox (p.
37)
+
list mssql_instances
(p. 39)
+
list mssql_databases
(p. 39)
+
backup disk (p. 19)
+
+
recover
mssql_database (p. 40)
+
recover ad_database (p.
41)
+
Operations with archives and backups
list archives (p. 42)
+
+
+
+
+
export archive (p. 43)
+
+
+
+
+
validate archive (p. 44)
+
+
+
+
+
catalog archive (p. 44)
+
+
+
+
+
delete archive (p. 45)
+
+
+
+
+
list backups (p. 46)
+
+
+
+
+
list content (p. 46)
+
+
+
+
+
validate backup (p. 47)
+
+
+
+
+
catalog backup (p. 48)
+
+
+
+
+
export backup (p. 49)
+
+**
+
+
+
replicate backup (p. 49)
+
+
+
+
+
delete backup (p. 52)
+
+***
+
+
+
list mssql_mounts (p.
55)
+
mount mssql_database
(p. 55)
+
17 Copyright © Acronis International GmbH, 2002-2016
Command
AMS
MMS
ASN
Agent for
Exchange
Agent for
SQL*
Agent for
Active
Directory*
Reserved
umount mssql_database
(p. 56)
+
Operations with tapes
list tape_libraries (p.
60)
+
+
+
+
list tape_slots (p. 61)
+
+
+
+
inventory tape (p. 61)
+
+
+
+
Operations with vaults
list vaults (p. 62)
+
+
+
+
+
validate vault (p. 63)
+
+
+
+
+
catalog vault (p. 63)
+
+
+
+
+
Operations with machines
add machine (p. 65)
+
Administration operations
get log (p. 66)
+
+
+
+
+
sysinfo (p. 66)
+
+
+
+
+
list activities (p. 67)
+
+
+
+
+
stop activity (p. 68)
+
+
+
+
+
list plans (p. 68)
+
+
+
+
delete plan (p. 71)
+
+
+
+
export plan (p. 69)
+
+
+
+
import plan (p. 70)
+
+
+
+
disable plan (p. 70)
+
+
+
+
enable plan (p. 71)
+
+
+
+
list tasks (p. 72)
+
+
+
+
run task (p. 72)
+
+
+
+
stop task (p. 73)
+
+
+
+
delete task (p. 73)
+
+
+
+
list licenses (p. 74)
+
+
+
generate report (p. 74)
+
18 Copyright © Acronis International GmbH, 2002-2016
* This agent can also execute all of the commands that can be executed by Agent for Windows (p. 13).
** When exporting a transaction log backup, the data from the entire backup chain (the full database backup
plus the set of subsequent transaction log backups including the selected one) is copied to a single backup.
Transaction log files will be applied to the database during recovery.
When exporting an incremental mailbox backup, the data from the backup chain (the full backup plus the set of
the subsequent incremental mailbox backups including the selected one) is consolidated into a single backup.
*** Backups that have no dependencies are deleted without any limitations. A backup that has dependencies
cannot be deleted separately from its dependent backups.
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
The commands listed in this section can be executed on a machine where Agent for Windows or
Agent for Linux is installed.
2.3.1.1 list disks
Lists available disk groups, disks, volumes and unallocated space.
Examples (p. 127)
Parameters
--oss_numbers={true|false} (p. 122)
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. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
{-f|--file_params}=<full local path> (p. 121)
19 Copyright © Acronis International GmbH, 2002-2016
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams} (p. 76)
Access to a virtual machine (Acronis Backup Advanced for virtual environments only)
{--vmid=<virtual machine ID>|--vmname=<virtual machine
name>|--vmconfig=<path>} (p. 77)
2.3.1.2 backup disk
Creates a backup of the specified disks or volumes. If neither the --disk parameter nor the
--volume parameter is specified, the command backs up the entire machine.
Backing up the entire machine is highly recommended when you perform a single-pass disk and
application backup (i.e. specify the --application_aware parameter). Otherwise, application
data may be backed up incompletely.
Examples (p. 127)
Parameters
What to back up
--disk=<disk numbers> (p. 88)
--volume=<volume numbers> (p. 89)
--oss_numbers={true|false} (p. 122)
--exclude_hidden (p. 93)
--exclude_mask=<masks> (p. 93)
--exclude_names=<names> (p. 93)
--exclude_system (p. 93)
Where to save the backup
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
--password=<password>,encrypted (p. 123)
How to back up
--archive_comment=<comments> (p. 93)
--backup_comment=<comments> (p. 93)
--backuptype={full|incremental|differential} (p. 92)
--cleanup (p. 92)
--fixed_drive (p. 95)
--plain_archive (p. 97)
--raw (p. 97)
Single-pass backup
20 Copyright © Acronis International GmbH, 2002-2016
--application_aware (p. 92)
--ignore_app_errors (p. 96)
--mssql_truncate_logs (p. 96)
Backup options
--cataloging={full|fast} (p. 98)
--compression={none|normal|high|max} (p. 99)
--encryption={none|aes128|aes192|aes256} (p. 99)
--fast (p. 99)
--force_yes (p. 121)
--hdd_speed=<speed>{kb|p} (p. 99)
--ignore_bad_sectors (p. 100)
--multi_volume_snapshot={true|false} (p. 100)
--network_speed=<speed>{kb|p} (p. 101)
--post_cmd=<command> (p. 101)
--pre_cmd=<command> (p. 101)
--process_priority={low|normal|high} (p. 123)
--reboot_after (p. 125)
--retry_count=<number of attempts> (p. 120)
--retry_delay=<delay> (p. 120)
--silent_mode={on|off} (p. 126)
--split=<size> (p. 102)
--use_registry_defaults (p. 126)
--use_vss={none|auto|software_auto|software|hardware|acronis|native} (p. 103)
Tape management options
--tape_eject_successful (p. 102)
--tape_full_empty (p. 102)
--tape_overwrite (p. 102)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP addresses or hostnames> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams} (p. 76)
2.3.1.3 recover disk
Recovers the specified disks or volumes.
21 Copyright © Acronis International GmbH, 2002-2016
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.
Examples (p. 127)
Parameters
What to recover
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
--password=<password>,encrypted (p. 123)
--backup=<backup ID> (p. 85)
--disk=<disk numbers> (p. 88)
--nt_signature={auto|new|backup|existing} (p. 89)
--volume=<volume numbers> (p. 89)
--oss_numbers={true|false} (p. 122)
--mbr_disk=<disk number> (p. 91)
Where to recover
--target_disk=<disk numbers> (p. 111)
--target_volume=<volume numbers> (p. 111)
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. 91)
--size=<volume size>{s|kb|mb|gb} (p. 91)
--target_mbr_disk=<disk number> (p. 92)
22 Copyright © Acronis International GmbH, 2002-2016
How to recover
--fat16_32 (p. 107)
--ext2_3 (p. 107)
--preserve_mbr (p. 109)
--type={active|primary|logical} (p. 112)
--use_all_space (p. 112)
--active_restore
If the parameter is specified, the Acronis Active Restore technology is enabled.
Recovery options
--force_yes (p. 121)
--reboot (p. 125)
--reboot_after (p. 125)
--retry_count=<number of attempts> (p. 120)
--retry_delay=<delay> (p. 120)
--silent_mode={on|off} (p. 126)
--use_registry_defaults (p. 126)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP addresses or hostnames> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams} (p. 76)
2.3.1.4 recover mbr
Recovers the MBR from a disk or volume backup.
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. 20) command with either the --disk parameter (the
MBR will be recovered automatically) or the --volume, --mbr_disk, and --target_mbr_disk
parameters.
Examples (p. 127)
Parameters
What to recover
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
23 Copyright © Acronis International GmbH, 2002-2016
--password=<password>,encrypted (p. 123)
--backup=<backup ID> (p. 85)
--disk=<disk number> (p. 88)
Where to recover
--target_disk=<disk number> (p. 111)
Recovery options
--force_yes (p. 121)
--reboot (p. 125)
--reboot_after (p. 125)
--retry_count=<number of attempts> (p. 120)
--retry_delay=<delay> (p. 120)
--silent_mode={on|off} (p. 126)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP addresses or hostnames> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams} (p. 76)
2.3.1.5 recover lvm_structure
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. 20) 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.
Examples (p. 127)
Parameters
What to recover
24 Copyright © Acronis International GmbH, 2002-2016
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
--password=<password>,encrypted (p. 123)
--backup=<backup ID> (p. 85)
Recovery options
--force_yes (p. 121)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
2.3.2 Files
The commands listed in this section can be executed on a machine where Agent for Windows or
Agent for Linux is installed.
2.3.2.1 backup file
Creates a backup of specified files and folders.
Examples (p. 130)
Parameters
What to back up
--include=<paths> (p. 96)
--exclude_hidden (p. 93)
--exclude_mask=<masks> (p. 93)
--exclude_names=<names> (p. 93)
--exclude_system (p. 93)
Where to save the backup
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
--password=<password>,encrypted (p. 123)
How to back up
--archive_comment=<comments> (p. 93)
--backup_comment=<comments> (p. 93)
--backuptype={full|incremental|differential} (p. 92)
--cleanup (p. 92)
25 Copyright © Acronis International GmbH, 2002-2016
--fixed_drive (p. 95)
--plain_archive (p. 97)
Backup options
--cataloging={full|fast} (p. 98)
--compression={none|normal|high|max} (p. 99)
--encryption={none|aes128|aes192|aes256} (p. 99)
--force_yes (p. 121)
--hdd_speed=<speed>{kb|p} (p. 99)
--ignore_bad_sectors (p. 100)
--multi_volume_snapshot={true|false} (p. 100)
--network_speed=<speed>{kb|p} (p. 101)
--post_cmd=<command> (p. 101)
--pre_cmd=<command> (p. 101)
--process_priority={low|normal|high} (p. 123)
--reboot_after (p. 125)
--retry_count=<number of attempts> (p. 120)
--retry_delay=<delay> (p. 120)
--silent_mode={on|off} (p. 126)
--snapshot={always|possible|none} (p. 102)
--split=<size> (p. 102)
--use_registry_defaults (p. 126)
--use_vss={none|auto|software_auto|software|hardware|acronis|native} (p. 103)
Tape management options
--tape_eject_successful (p. 102)
--tape_full_empty (p. 102)
--tape_overwrite (p. 102)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP addresses or hostnames> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams} (p. 76)
2.3.2.2 recover file
Recovers files and folders from a file-level or disk-level backup.
Examples (p. 130)
26 Copyright © Acronis International GmbH, 2002-2016
Parameters
What to recover
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
--password=<password>,encrypted (p. 123)
--backup=<backup ID> (p. 85)
--file=<paths> (p. 107)
--exclude=<files, folders and masks> (p. 106)
Where to recover
--target=<path> (p. 86)
--credentials=<user name>,<password>,encrypted (p. 120)
How to recover
--overwrite={always|older|never} (p. 108)
--recover_absolute_path (p. 109)
--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 (p. 108)
Recovery options
--force_yes (p. 121)
--reboot (p. 125)
--reboot_after (p. 125)
--retry_count=<number of attempts> (p. 120)
--retry_delay=<delay> (p. 120)
--silent_mode={on|off} (p. 126)
--use_registry_defaults (p. 126)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostnames> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams} (p. 76)
27 Copyright © Acronis International GmbH, 2002-2016
2.3.3 Virtual machines
The commands listed in this section are available in Acronis Backup Advanced only if Agent for
VMware or Agent for Hyper-V is installed. (This does not apply to the recover vm (p. 31) 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. 131)
Parameters
--filter_guid=<GUIDs> (p. 116)
--filter_name=<names> (p. 117)
--filter_machines=<quantities of machines> (p. 117)
--filter_type=<server types> (p. 118)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP addresses or hostnames> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams} (p. 76)
2.3.3.2 list vms
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.
Examples (p. 131)
Parameters
--filter_available_for_backup={true|false} (p. 115)
--filter_guid=<GUIDs> (p. 116)
--filter_host=<hostnames> (p. 116)
--filter_name=<names> (p. 117)
--filter_state=<states> (p. 118)
--filter_status=<statuses> (p. 118)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
28 Copyright © Acronis International GmbH, 2002-2016
--output={formatted|raw} (p. 123)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams} (p. 76)
2.3.3.3 deploy vm_agent
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. 131)
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=<user name>,<password>,encrypted (p. 120)
Credentials for the vCenter Server or stand-alone ESX(i) host.
--vmconnection_credentials=<user name>,<password>,encrypted
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}
29 Copyright © Acronis International GmbH, 2002-2016
Network interface card of the virtual appliance. If not specified, the value is vmxnet3.
--vmnetwork=<network label>
Network to which the virtual appliance's network interface card will be connected. For example,
--vmnetwork="VM Network". If not specified, the software will automatically select one of the
available networks.
--mac_address=<MAC address>
MAC address of the virtual appliance's network interface card. 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.
--wins=<WINS servers>
IP addresses of the WINS servers. For example, --wins=10.200.200.111,10.200.200.112.
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote management server
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
Access to the management server service
--service=ams (p. 76)
2.3.3.4 backup vm
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.
30 Copyright © Acronis International GmbH, 2002-2016
Examples (p. 131)
Parameters
Access to a virtual machine
{--vmid=<virtual machine IDs>|--vmname=<virtual machine
names>|--vmconfig=<paths>} (p. 77)
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.
What to back up
--disk=<disk numbers> (p. 88)
--volume=<volume numbers> (p. 89)
--exclude_hidden (p. 93)
--exclude_mask=<masks> (p. 93)
--exclude_names=<names> (p. 93)
--exclude_system (p. 93)
Where to save the backup
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
--password=<password>,encrypted (p. 123)
How to back up
--archive_comment=<comments> (p. 93)
--backup_comment=<comments> (p. 93)
--backuptype={full|incremental|differential} (p. 92)
--cleanup (p. 92)
--raw (p. 97)
Backup options
--cataloging={full|fast} (p. 98)
--cbt_mode={on|off} (p. 98)
--compression={none|normal|high|max} (p. 99)
--encryption={none|aes128|aes192|aes256} (p. 99)
--fast (p. 99)
--force_yes (p. 121)
--hdd_speed=<speed>{kb|p} (p. 99)
--network_speed=<speed>{kb|p} (p. 101)
--process_priority={low|normal|high} (p. 123)
--retry_count=<number of attempts> (p. 120)
--retry_delay=<delay> (p. 120)
--silent_mode={on|off} (p. 126)
31 Copyright © Acronis International GmbH, 2002-2016
--split=<size> (p. 102)
--use_registry_defaults (p. 126)
Tape management options
--tape_eject_successful (p. 102)
--tape_full_empty (p. 102)
--tape_overwrite (p. 102)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote physical machine
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams} (p. 76)
2.3.3.5 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 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.
Agent for Windows and Agent for Linux recover a disk (volume) backup to a new virtual machine
of any of the following types: VMware Workstation, Microsoft Virtual PC, Red Hat Enterprise
Virtualization, 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 corresponding 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. 131)
Parameters
What to recover
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
32 Copyright © Acronis International GmbH, 2002-2016
--password=<password>,encrypted (p. 123)
--backup=<backup ID> (p. 85)
--disk=<disk numbers> (p. 88)
--volume=<volume number> (p. 89)
Where to recover
If you want to recover to an existing virtual machine:
{--vmid=<virtual machine ID>|--vmname=<virtual machine
name>|--vmconfig=<path>} (p. 77)
If you want to create a new virtual machine on an ESX(i) or Hyper-V host:
--vmname=<virtual machine name> (p. 78)
--vmstorage=<path> (p. 78)
{--vmserver_name=<server name>|--vmserver_id=<server GUID>} (p. 78)
--vmram=<memory size> (p. 78)
--vmcpu=<number of CPUs> (p. 78)
--vmdisk_size=<disk sizes> (p. 78)
--vmdisk_type=<disk types> (p. 78)
--vmdisk_provisioning=<disk provisioning types> (p. 78)
If you want to create a new virtual machine in a local or network folder:
--vmname=<virtual machine name> (p. 80)
--vmtype={vmware|virtualpc|redhat|xen} (p. 80)
--vmstorage=<path> (p. 80)
--credentials=<user name>,<password>,encrypted (p. 120)
Credentials for a network folder where the virtual machine is to be created.
--target_disk=<disk number> (p. 111)
--target_volume=<volume number> (p. 111)
--start=<offset>{s|kb|mb|gb} (p. 91)
--size=<volume size>{s|kb|mb|gb} (p. 91)
How to recover
--ext2_3 (p. 107)
--fat16_32 (p. 107)
--preserve_mbr (p. 109)
--type={active|primary|logical} (p. 112)
--use_all_space (p. 112)
Recovery options
--force_yes (p. 121)
--power_on (p. 109)
--retry_count=<number of attempts> (p. 120)
--retry_delay=<delay> (p. 120)
--silent_mode={on|off} (p. 126)
--use_registry_defaults (p. 126)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
33 Copyright © Acronis International GmbH, 2002-2016
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams} (p. 76)
2.3.4 Microsoft Exchange
The commands listed in this section can be executed on a machine where Agent for Exchange is
installed.
2.3.4.1 list exchange_databases
Lists storage groups (for Exchange 2003/2007) and databases.
Examples (p. 132)
Parameters
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
{-f|--file_params}=<full local path> (p. 121)
--exchange_credentials=<domain user name>,<password>,encrypted (p. 80)
Access to a remote machine
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine
--service={mms|ams} (p. 76)
2.3.4.2 list exchange_mailboxes
Lists mailboxes and public folders in the specified Exchange database.
Examples (p. 132)
Parameters
--mailbox_location=<path> (p. 88)
--filter_name=<names> (p. 117)
General parameters
34 Copyright © Acronis International GmbH, 2002-2016
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
{-f|--file_params}=<full local path> (p. 121)
--exchange_credentials=<domain user name>,<password>,encrypted (p. 80)
Access to a remote machine
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine
--service={mms|ams} (p. 76)
2.3.4.3 backup exchange_database
Creates a backup of the specified storage groups (for Exchange 2003/2007) or databases (for
Exchange 2010 or later).
Examples (p. 132)
Parameters
What to back up
--items=<items> (p. 81)
Where to save the backup
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
--password=<password>,encrypted (p. 123)
How to back up
--archive_comment=<comments> (p. 93)
--backup_comment=<comments> (p. 93)
--backuptype={full|transaction_log} (p. 92)
--cleanup (p. 92)
--copy_only (p. 93)
--express (p. 95)
Backup options
--cataloging={full|fast} (p. 98)
--compression={none|normal|high|max} (p. 99)
--encryption={none|aes128|aes192|aes256} (p. 99)
--force_yes (p. 121)
--metadata_level={{mailboxes_only|1}|{folders_and_mailboxes|2}|{all|3}} (p.
100)
--post_cmd=<command> (p. 101)
--pre_cmd=<command> (p. 101)
--retry_count=<number of attempts> (p. 120)
35 Copyright © Acronis International GmbH, 2002-2016
--retry_delay=<delay> (p. 120)
--silent_mode={on|off} (p. 126)
--split=<size> (p. 102)
--use_registry_defaults (p. 126)
Tape management options
--tape_eject_successful (p. 102)
--tape_full_empty (p. 102)
--tape_overwrite (p. 102)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
--exchange_credentials=<domain user name>,<password>,encrypted (p. 80)
Access to a remote machine
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine
--service={mms|ams} (p. 76)
2.3.4.4 backup exchange_mailbox
Creates a backup of the specified mailboxes and public folders. The command cannot be used to back
up data of Microsoft Exchange 2013 or later.
Examples (p. 132)
Parameters
What to back up
--items=<items> (p. 81)
--exclude_age=<date> (p. 93)
--exclude_attach=<files and masks> (p. 93)
--exclude_size=<size>{kb|mb|gb} (p. 93)
--exclude_types=<types> (p. 93)
Where to save the backup
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
--password=<password>,encrypted (p. 123)
How to back up
36 Copyright © Acronis International GmbH, 2002-2016
--archive_comment=<comments> (p. 93)
--backup_comment=<comments> (p. 93)
--backuptype={full|incremental} (p. 92)
--cleanup (p. 92)
Backup options
--cataloging={full|fast} (p. 98)
--compression={none|normal|high|max} (p. 99)
--encryption={none|aes128|aes192|aes256} (p. 99)
--force_yes (p. 121)
--post_cmd=<command> (p. 101)
--pre_cmd=<command> (p. 101)
--retry_count=<number of attempts> (p. 120)
--retry_delay=<delay> (p. 120)
--silent_mode={on|off} (p. 126)
--split=<size> (p. 102)
--use_registry_defaults (p. 126)
Tape management options
--tape_eject_successful (p. 102)
--tape_full_empty (p. 102)
--tape_overwrite (p. 102)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
--exchange_credentials=<domain user name>,<password>,encrypted (p. 80)
Access to a remote machine
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine
--service={mms|ams} (p. 76)
2.3.4.5 recover exchange_database
Recovers the specified storage groups (for Exchange 2003/2007) or databases (for Exchange 2010 or
later).
Examples (p. 132)
Parameters
What to recover
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
37 Copyright © Acronis International GmbH, 2002-2016
--arc=<archive name> (p. 84)
--password=<password>,encrypted (p. 123)
--recovery_point={point_of_failure|latest_backup|point_in_time|selected_ba
ckup} (p. 110)
--pit=<date and time> (p. 109)
--backup=<backup ID> (p. 85)
--items=<items> (p. 81)
Where to recover
--target={original|disk|another_database|recovery_database} (p. 86)
--disk_location=<path> (p. 106)
--credentials=<user name>,<password>,encrypted (p. 120)
--destination_database=<db> (p. 105)
--database=<db_name> (p. 104)
--database_location=<local path> (p. 104)
--log_location=<local path> (p. 107)
How to recover
--overwrite (p. 108)
--active_restore
If the parameter is specified, the Acronis Active Restore technology is enabled.
Recovery options
--force_yes (p. 121)
--retry_count=<number of attempts> (p. 120)
--retry_delay=<delay> (p. 120)
--silent_mode={on|off} (p. 126)
--use_registry_defaults (p. 126)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
--exchange_credentials=<domain user name>,<password>,encrypted (p. 80)
Access to a remote machine
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine
--service={mms|ams} (p. 76)
2.3.4.6 recover exchange_mailbox
Recovers the specified mailboxes and public folders from a database-level or mailbox-level backup.
Examples (p. 132)
38 Copyright © Acronis International GmbH, 2002-2016
Parameters
What to recover
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
--password=<password>,encrypted (p. 123)
--recovery_point={latest_backup|point_in_time|selected_backup} (p. 110)
--pit=<date and time> (p. 109)
--backup=<backup ID> (p. 85)
--items=<items> (p. 81)
Where to recover
--target={original|pst} (p. 86)
--disk_location=<local path> (p. 106)
--outlookmachine=<IP address or hostname> (p. 108)
--credentials=<user name>,<password>,encrypted (p. 120)
How to recover
--overwrite (p. 108)
Recovery options
--force_yes (p. 121)
--retry_count=<number of attempts> (p. 120)
--retry_delay=<delay> (p. 120)
--silent_mode={on|off} (p. 126)
--use_registry_defaults (p. 126)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
--exchange_credentials=<domain user name>,<password>,encrypted (p. 80)
Access to a remote machine
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine
--service={mms|ams} (p. 76)
2.3.5 Microsoft SQL
The commands listed in this section can be executed on a machine where Agent for SQL is installed.
39 Copyright © Acronis International GmbH, 2002-2016
2.3.5.1 list mssql_instances
Lists Microsoft SQL Server instances.
Examples (p. 134)
Parameters
--filter_edition=<editions> (p. 116)
--filter_name=<names> (p. 117)
--filter_version=<versions> (p. 119)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams} (p. 76)
2.3.5.2 list mssql_databases
Lists Microsoft SQL databases of the specified instance. Only the databases whose files are stored in
local folders of the SQL server are displayed.
Examples (p. 134)
Parameters
--filter_name=<names> (p. 117)
--instance=<instance name> (p. 81)
--credentials=<user name>,<password>,encrypted
For information about specifying access credentials for Microsoft SQL Server, see "Access to SQL
Server instance" (p. 83).
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
40 Copyright © Acronis International GmbH, 2002-2016
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams} (p. 76)
2.3.5.3 recover mssql_database
Recovers the specified Microsoft SQL databases.
Examples (p. 134)
Parameters
What to recover
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
--password=<password>,encrypted (p. 123)
--backup=<backup ID> (p. 85)
--items=<items> (p. 81)
Where to recover
--target={original|disk|another_instance} (p. 86)
--disk_location=<path> (p. 106)
--credentials=<user name>,<password>,encrypted (p. 120)
--destination_instance=<instance name> (p. 106)
--credentials=<user name>,<password>,encrypted
For information about specifying access credentials for Microsoft SQL Server, see "Access to SQL
Server instance" (p. 83).
--database_location=<local path> (p. 104)
How to recover
--overwrite (p. 108)
--autorename (p. 103)
--database_state={recovery|norecovery|standby} (p. 105)
--active_restore
If the parameter is specified, the Acronis Active Restore technology is enabled.
Recovery options
--retry_count=<number of attempts> (p. 120)
--retry_delay=<delay> (p. 120)
--silent_mode={on|off} (p. 126)
--use_registry_defaults (p. 126)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
41 Copyright © Acronis International GmbH, 2002-2016
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams} (p. 76)
2.3.6 Microsoft Active Directory
The command described in this section can be executed on a machine where Agent for Active
Directory is installed.
2.3.6.1 recover ad_database
Extracts Microsoft Active Directory database files and the SYSVOL folder from a single-pass backup to
a local or network folder. Full paths of the files are recreated.
For information about what to do with the extracted files, refer to the "Recovering the Active
Directory data from a single-pass backup" section of the product Help or the User Guide.
Examples (p. 135)
Parameters
What to recover
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
--password=<password>,encrypted (p. 123)
--backup=<backup ID> (p. 85)
Where to recover
--target=<path> (p. 86)
--credentials=<user name>,<password>,encrypted (p. 120)
How to recover
--overwrite={always|older|never} (p. 108)
--original_date (p. 108)
Recovery options
--force_yes (p. 121)
--retry_count=<number of attempts> (p. 120)
--retry_delay=<delay> (p. 120)
--silent_mode={on|off} (p. 126)
--use_registry_defaults (p. 126)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
42 Copyright © Acronis International GmbH, 2002-2016
--output={formatted|raw} (p. 123)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams} (p. 76)
2.4 Operations with archives and backups
2.4.1 Archives
2.4.1.1 list archives
Lists the information about archives in the specific location. The displayed records are sorted by date
in descending order.
Examples (p. 136)
Parameters
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--filter_type=<types> (p. 118)
{-a|--all}
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, comments on the archive, whether the
archive is encrypted (password-protected) or not, and size of the backed-up data. If not specified,
only name, type, and creation date will be displayed for each archive.
--recreate_archive_meta={true|false} (p. 125)
--utc (p. 126)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
43 Copyright © Acronis International GmbH, 2002-2016
--service={mms|ams|asn} (p. 76)
In a managed vault (--loc=bsp://<storage node>/<vault name>), the operation is always
executed by the storage node service. If you specify a different service, it will transmit the
command to asn.
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.
To export individual backups, use the export backup (p. 49) command.
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. See the examples for more details.
Examples (p. 136)
Parameters
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
--password=<password>,encrypted (p. 123)
--target=<path> (p. 86)
--credentials=<user name>,<password>,encrypted (p. 120)
--target_arc=<archive name> (p. 88)
--cataloging={full|fast} (p. 98)
--silent_mode={on|off} (p. 126)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams|asn} (p. 76)
Exporting archives from a managed vault (--loc=bsp://<storage node>/<vault name>) is
always executed by the storage node service. If you specify a different service, it will transmit the
command to asn.
44 Copyright © Acronis International GmbH, 2002-2016
2.4.1.3 validate archive
Validates the archive data integrity.
Examples (p. 136)
Parameters
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
--password=<password>,encrypted (p. 123)
--process_priority={low|normal|high} (p. 123)
--read_speed=<speed>{kb|p} (p. 124)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams|asn} (p. 76)
In a managed vault (--loc=bsp://<storage node>/<vault name>), the operation is always
executed by the storage node service. If you specify a different service, it will transmit the
command to asn.
2.4.1.4 catalog archive
Performs a full cataloging of all the backups in the specified archive.
Usage tip. To speed up backups, you can prohibit full cataloging by adding the --cataloging=fast
parameter to the backup command. Use the catalog backup (p. 48), catalog archive (p. 44), or
catalog vault (p. 63) command to perform the full cataloging at a later time.
Examples (p. 136)
Parameters
--loc=<path> (p. 84)
The command does not support the following locations: Acronis Cloud Storage, encrypted
managed vaults, and removable media such as CD, DVD, BD, Iomega REV, RDX or USB devices.
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
45 Copyright © Acronis International GmbH, 2002-2016
The command does not support encrypted and password-protected archives, archives created by
using Acronis True Image Echo or earlier product versions, and archives that use the simplified
backup naming (p. 97).
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams|asn} (p. 76)
In a managed vault (--loc=bsp://<storage node>/<vault name>), the operation is always
executed by the storage node service. If you specify a different service, it will transmit the
command to asn.
2.4.1.5 delete archive
Deletes an archive.
Examples (p. 136)
Parameters
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams|asn} (p. 76)
46 Copyright © Acronis International GmbH, 2002-2016
In a managed vault (--loc=bsp://<storage node>/<vault name>), the operation is always
executed by the storage node service. If you specify a different service, it will transmit the
command to asn.
2.4.2 Backups
2.4.2.1 list backups
Lists backups in the specified archive. The displayed records are sorted by date in descending order.
Examples (p. 137)
Parameters
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
--password=<password>,encrypted (p. 123)
--filter_date=<dates and times> (p. 116)
--filter_type=<types> (p. 118)
--recreate_archive_meta={true|false} (p. 125)
--utc (p. 126)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams|asn} (p. 76)
In a managed vault (--loc=bsp://<storage node>/<vault name>), the operation is always
executed by the storage node service. If you specify a different service, it will transmit the
command to asn.
2.4.2.2 list content
Lists the contents of a backup (backed-up disks, volumes, files, virtual machines, databases, etc.).
Examples (p. 137)
Parameters
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
--password=<password>,encrypted (p. 123)
47 Copyright © Acronis International GmbH, 2002-2016
--backup=<backup ID> (p. 85)
--content_type={volume|file|exchange_database|exchange_mailbox|mssql_datab
ase|ad_database} (p. 115)
--content_path=<path> (p. 114)
--oss_numbers={true|false} (p. 122)
--utc (p. 126)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams|asn} (p. 76)
In a managed vault (--loc=bsp://<storage node>/<vault name>), the operation is always
executed by the storage node service. If you specify a different service, it will transmit the
command to asn.
2.4.2.3 validate backup
Validates the backup data integrity.
Examples (p. 137)
Parameters
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
--password=<password>,encrypted (p. 123)
--backup=<backup ID> (p. 85)
--process_priority={low|normal|high} (p. 123)
--read_speed=<speed>{kb|p} (p. 124)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
48 Copyright © Acronis International GmbH, 2002-2016
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams|asn} (p. 76)
In a managed vault (--loc=bsp://<storage node>/<vault name>), the operation is always
executed by the storage node service. If you specify a different service, it will transmit the
command to asn.
2.4.2.4 catalog backup
Performs a full cataloging of the specified backup.
Usage tip. To speed up backups, you can prohibit full cataloging by adding the --cataloging=fast
parameter to the backup command. Use the catalog backup (p. 48), catalog archive (p. 44), or
catalog vault (p. 63) command to perform the full cataloging at a later time.
Examples (p. 137)
Parameters
--loc=<path> (p. 84)
The command does not support the following locations: Acronis Cloud Storage, encrypted
managed vaults, and removable media such as CD, DVD, BD, Iomega REV, RDX or USB devices.
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
The command does not support encrypted and password-protected archives, archives created by
using Acronis True Image Echo or earlier product versions, and archives that use the simplified
backup naming (p. 97).
--backup=<backup ID> (p. 85)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams|asn} (p. 76)
In a managed vault (--loc=bsp://<storage node>/<vault name>), the operation is always
executed by the storage node service. If you specify a different service, it will transmit the
command to asn.
49 Copyright © Acronis International GmbH, 2002-2016
2.4.2.5 export backup
Copies the archive specified by the --arc parameter from the location specified by the --loc
parameter to the location specified by the --target parameter. The copy will contain only the
backups specified by the --backup parameter.
To export an entire archive or all the archives stored in a location, use the export archive (p. 43) command.
The command always creates a new archive in the target location. You cannot specify an existing
archive in the --target_arc parameter. Both the --target and the --target_arc parameters
are mandatory.
If the --backup parameter is not specified, the command will export only the latest backup.
Examples (p. 137)
Parameters
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
--password=<password>,encrypted (p. 123)
--backup=<backup IDs> (p. 85)
--target=<path> (p. 86)
--credentials=<user name>,<password>,encrypted (p. 120)
--target_arc=<archive name> (p. 88)
--cataloging={full|fast} (p. 98)
--silent_mode={on|off} (p. 126)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams|asn} (p. 76)
Exporting backups from a managed vault (--loc=bsp://<storage node>/<vault name>) is
always executed by the storage node service. If you specify a different service, it will transmit the
command to asn.
2.4.2.6 replicate backup
Replicates the latest backup of the specified archive to a different location. If the --backup
parameter is specified, the specified backups will be replicated. If the target location is the same as
the source one, the command will fail.
50 Copyright © Acronis International GmbH, 2002-2016
If the target archive exists, the command will append the specified backups to it. This means that a
backup will not be replicated if the target archive already contains a backup with the same GUID.
Using this command, you can replicate each backup of your archive to a second location immediately
after backing up or on a schedule. This helps you make your archive more reliable by maintaining its
copy in a different location.
Examples (p. 137)
Parameters
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
The command does not support archives that use the simplified backup naming (p. 97).
--password=<password>,encrypted (p. 123)
--target=<path> (p. 86)
--credentials=<user name>,<password>,encrypted (p. 120)
--target_arc=<archive name> (p. 88)
--backup={<backup IDs>|all} (p. 85)
If the value is all, all backups of the specified archive will be selected for replication.
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams|asn} (p. 76)
Replicating backups from a managed vault (--loc=bsp://<storage node>/<vault name>)
is always executed by the storage node service. If you specify a different service, it will transmit
the command to asn.
2.4.2.7 convert full
Converts an incremental or differential backup into a full one. The backup time stamp remains
unchanged. The dependent incremental and differential backups are also updated. However, the old
backup versions are deleted only after the new ones have been created. Therefore, the location must
have enough space to temporarily store both the old and the new versions.
Examples (p. 137)
Parameters
--loc=<path> (p. 84)
51 Copyright © Acronis International GmbH, 2002-2016
The command does not support the following locations: Acronis Cloud Storage, tape and
CD/DVD.
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
The command does not support archives that use the simplified backup naming (p. 97) and
archives of Microsoft Exchange Server data (p. 33).
--password=<password>,encrypted (p. 123)
--backup=<backup ID> (p. 85)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
--output={formatted|raw} (p. 123)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams|asn} (p. 76)
In a managed vault (--loc=bsp://<storage node>/<vault name>), the operation is always
executed by the storage node service. If you specify a different service, it will transmit the
command to asn.
2.4.2.8 consolidate backup
Modifies an archive so that only the backups specified in the --backup parameter are kept. All
other backups of the archive are deleted.
If the --backup parameter is not specified, only the latest backup of the archive is kept. As a result,
the archive will contain only one backup.
Examples (p. 137)
Parameters
--loc=<path> (p. 84)
The command does not support the following location: Acronis Backup Storage Node.
--credentials=<user name>,<password>,encrypted (p. 120)
--arc=<archive name> (p. 84)
--password=<password>,encrypted (p. 123)
--backup=<backup IDs> (p. 85)
General parameters
--log=<full path> (p. 122)
--log_format={structured|unstructured} (p. 122)
52 Copyright © Acronis International GmbH, 2002-2016
--output={formatted|raw} (p. 123)
--progress (p. 124)
{-f|--file_params}=<full local path> (p. 121)
Access to a remote machine (Acronis Backup Advanced only)
--host=<IP address or hostname> (p. 76)
--credentials=<user name>,<password>,encrypted (p. 120)
--address=<IP address or hostname> (p. 76)
Access to a specific service within a machine (Acronis Backup Advanced only)
--service={mms|ams} (p. 76)
2.4.2.9 delete backup
Deletes the selected backup from an archive. If incremental or differential backups depend on the
backup being deleted, a consolidation will be performed. This consolidation may be time and
resource consuming.
A backup stored on a tape (--loc=atis:///tape) is not physically deleted until the tape is
overwritten. Therefore, the backup will be present in the output of the list backups (p. 46)
command.
Examples (p. 137)
Parameters
--loc=<path> (p. 84)
--credentials=<user name>,<password>,encrypted