Acronis® Backup & Recovery ™ 10 Advanced Server Update 3 Command Line Reference
Table of contents 1 Command-line mode and scripting in Windows ......................................................................... 3 1.1 Agent for Windows command-line utility .............................................................................. 3 1.1.1 1.1.2 1.1.3 1.1.4 1.2 Storage node command-line utility ..................................................................................... 28 1.2.1 1.2.2 1.2.3 1.2.4 1.3 Supported commands ...........................................
1 Command-line mode and scripting in Windows Acronis Backup & Recovery 10 supports the command-line mode and enables backup automation by executing XML scripts. Acronis Backup & Recovery 10 uses the Acronis True Image Echo command line utility with the following additions: 1. Ability to use the before/after data capture commands. 2. Ability to use the VSS support option. 3. Ability to check for a license on the license server with the /ls_check command. 4. Ability to use file exclusion at disk backup. 5.
Command Common Options Specific Options create /vault:[path] /arc:[archive name] /arc_id:[archive id] /filename:[file name] /password:[password] /crypt:[AES128|AES192|AES256] /asz:[number of archive] /net_user:[username] /net_password:[password] /ftp_user:[username] /ftp_password:[password] /incremental /differential /compression:*0…9+ /split:[size in MB] /oss_numbers /progress:[on|off] /reboot /log:[file name] /log_net_user:[remote user] /log_net_password:[password] /silent /harddisk:[disk number] /pa
/ftp_password:[password] /oss_numbers /reboot /log:[file name] /log_net_user:[remote user] /log_net_password:[password] /silent deploy_mbr When using the Acronis Universal Restore option: /ur_path:[path] /ur_username:[user] /ur_password:[pwd] /ur_driver:[inf-filename] /vault:[path] /arc:[archive name] Restores the MBR from /arc_id:[archive id] a disk or partition /filename:[file name] image /password:[password] /asz:[number of archive] /index:N /net_user:[username] /net_password:[password] /ftp_user:[user
/silent pit_info /filename:[file name] /password:[password] Displays the numbered /asz:[number of archive] list of backups, /net_user:[username] contained in the /net_password:[password] specified archive /ftp_user:[username] /ftp_password:[password] consolidate Creates a consistent copy of the archive which will contain only the specified backups /include_pits:[pits numbers] /filename:[file name] /password:[password] /ftp_user:[username] /ftp_password:[password] /reboot /log:[file name] /log_net_user:[re
When the arc, or the arc_id option is added, it lists all backups contained in the archive.
asz_delete Deletes the Acronis Secure Zone /password:[password] /oss_numbers /reboot /later /log:[file name] /log_net_user:[remote user] /log_net_password:[password] /silent /partition:[partition number] /reboot /later /silent /harddisk:[disk number] /target_harddisk:[disk number] asrm_activate Activates the Acronis Startup Recovery Manager asrm_deactivate Deactivates the Acronis Startup Recovery Manager clone Clones a hard disk help Shows usage ls_check Checks if there are licenses for the local machi
Unmanaged vaults are specified by their path. For example, if a vault is located in a folder, specify the path to that folder. If the vault option is specified the filename option is ignored. arc:[archive name] The name of the archive. If not specified, the arc_id option is used. If both the arc and arc_id options are specified, the arc_id option is used. arc_id:[archive id] Specifies the Universally Unique Identifier (UUID) of the archive, e.g.
The "0" value means the last backup in the archive, for example: /include_pits:0 If not specified the whole archive is selected. net_user:[username] Specify a user name for network drive access. net_password:[password] Specify a password for network drive access. ftp_user:[username] Specify a user name for access to an FTP server. ftp_password:[password] Specify a password for access to an FTP server. 1.1.2.2 Backup options incremental Set the backup type to incremental.
If the /crypt option is not specified, the password-protected archive will be not encrypted. split:[size in MB] Split the backup into parts of the specified size, if the archive location is other than ASZ. 1.1.2.3 General options oss_numbers Declares that numbers of partitions in the /partition option are adjusted for the MBR partition table rather than just as ascending numbers. This means that primary partitions have numbers 1-1, 1-2, 1-3, 1-4; logical partitions numbers start with 1-5.
log:[file name] Create a log file of the current operation with the specified file name. log_net_user:[remote user] If the log file is created on a network share, include the user name for logon to the share. log_net_password:[password] If the log file is created on a network share, include the password for logon to the share. silent Suppresses the command's output. progress:[on | off] Shows/hides the progress information (percent completed). It is shown by default. 1.1.3 Specific options 1.1.3.
/partition:1-1,"D" file_partition:[partition letter] Specifies the partition where the image file will be stored (by letter or number). This option is used with filename:[file_name]. In that case the file name must be specified without a drive letter or root folder. For example: /file_partition:D /filename:”\1.tib” Dynamic volumes are specified with the prefix DYN, e.g.: /file_partition:DYN1 /filename:”\1.
use_vss Notifies the VSS-aware applications that the backup is about to start. This ensures the consistent state of all data used by the applications, in particular, completion of all database transactions, at the moment of taking the data snapshot. The data consistency, in turn, ensures that the application will be recovered in the correct state and become operational immediately after recovery. 1.1.3.2 filebackup include:[names] Files and folders to be included in the backup (comma separated).
moment of taking the data snapshot. The data consistency, in turn, ensures that the application will be recovered in the correct state and become operational immediately after recovery. 1.1.3.3 deploy file_partition:[partition letter] Specifies the partition where the image file will be stored (by letter or number). This option is used with filename:[file_name]. In that case the file name must be specified without a drive letter or root folder. For example: /file_partition:D /filename:”\1.
size:[partition size in sectors] Sets the new partition size (in sectors). fat16_32 Enables the file system conversion from FAT16 to FAT32 if the partition size after recovery is likely to exceed 2 GB. Without this option, the recovered partition will inherit the file system from the image. type:[active | primary | logical] Sets the restored partition active, primary or logical, if possible (for example, there cannot be more than four primary partitions on the disk).
("Computer_name\User_name"). If the resource is located on an FTP-server the computer name is not required. When the target and local computer are members of different domains, the username must contain the name of the domain the target computer is the member of (e.g. "Domain_name\User_name"). ur_password:[pwd] Specifies using Acronis Universal Restore and a password associated with the ur_username option value.
include:[names] Specifies the files and folders to restore from the file backup (comma separated). For example: /include:D:\MyFolder1,D:\MyFolder2\file_1.exe If not specified, all contents of the file backup are restored. 1.1.3.6 verify folder_name:[path] Specifies a path to the local folder that contains archives to verify. For example: /folder_name:D:\MyFolder By default, all archives stored in the folder and its subfolders will be verified.
net_password:[password] Specifies the password for logon to the network share to save the resulting archive. 1.1.3.8 export net_src_user:[username] Specifies the user name for logon to the network share to access the source archive. net_src_password:[password] Specifies the password for logon to the network share to access the source archive. ftp_src_user:[username] Specifies the user name for logon to the FTP/SFTP server to access the source archive.
1.1.3.9 convert target_filename:[file name] Specifies the path to and name of the virtual disk file to be created. The file extension corresponds to the type of virtual machine to which the virtual disk will be added: VMware virtual machine - .vmdk MS virtual machine and Citrix XenServer - .vhd Parallels virtual machine - .hdd. harddisk:[disk number] Specifies the hard disks to convert by numbers. For each disk, a separate virtual disk will be created.
If the deploy /partition command cannot find a partition in the image by its physical number, use the partition: /target_partition: keys. For the above example, to restore partition 2-5 to its original place use: /partition:2-2 /target_partition:2-5 If the vault option is specified the filename option is ignored. vault:[path] Specifies a path to the location whose archives you want to list.
letter:X Assigns letters to the mounted drives. This option is used with the partition option only. 1.1.3.12 unplug letter:X Specifies the virtual drive to be disconnected by letter. letter:all Disconnects all virtual drives. 1.1.3.13 asz_create harddisk:X Specifies the hard disk number where the Acronis Secure Zone will be created. partition:[partition number] Specifies partitions from which free space will be taken for Acronis Secure Zone.
target_harddisk:[disk number] Specifies the target hard disk number where the source hard disk will be cloned. 1.1.4 1.1.4.1 trueimagecmd.exe usage examples Image disks and partitions The following command will create an image named 1.tib of partitions 2-1 and 1-3: trueimagecmd /create /filename:"C:\Test\1.tib" /partition:2-1,1-3 The image will be saved to the C:\Test\ folder.
trueimagecmd /deploy /filename:"C:\Test\1.tib" /partition:2-1 /target_partition:1-1 The following command will restore partition 2-1, stored in image 1.tib, to hard disk 3: trueimagecmd /deploy /filename:"C:\Test\1.tib" /partition:2-1 /target_harddisk:3 /start:63 /size:64000 /type:logical A new logical partition will be created on disk 3 starting from sector 63. The partition will occupy about 64000 sectors—the exact size will depend on disk geometry and the type of the file system.
C:\Program Files\Acronis\BackupAndRecovery>trueimagecmd /pit_info /filename:\\srv\elenel\kons.tib Pit number: 1 type: image; kind: base; date: 6/27/2009 11:39:10 AM Pit number: 2 type: image; kind: incremental; date: 6/27/2009 11:43:13 AM Pit number: 3 type: image; kind: incremental; date: 6/27/2009 11:44:04 AM Pit number: 4 type: image; kind: incremental; date: 6/27/2009 11:48:22 AM Pit number: 5 type: image; kind: incremental; date: 6/27/2009 11:50:32 AM Operation has succeeded.
The following command will list contents of the specified image: trueimagecmd /list /filename:"C:\My Folder\Backup.tib" The following command will list all archives and their UUID's in the specified location: trueimagecmd /list /vault:D:Backups The following command will list all backups of the specified archive: trueimagecmd /list /vault:D:Backups /arc:"Archive 1" 1.1.4.
1.1.4.11 Acronis Secure Zone: managing backups by file names The following command will list the Acronis Secure Zone size, free space and contents using generated filenames: trueimagecmd /asz_files /password:aszpw Assume that the contents of Acronis Secure Zone are as follows: C:\Program Files\Acronis\BackupAndRecovery>trueimagecmd /asz_files /password: aaa ASZ size: 5.387 GB ASZ free space: 4.363 GB FILE name: AAA2.
C:\Program Files\Acronis\BackupAndRecovery>trueimagecmd /asz_files /password: aaa ASZ size: 5.387 GB ASZ free space: 4.363 GB FILE name: AAA2.TIB; size: 56414317 byte type: image, base; creation time: 2/16/2009 3:43:34 PM type: image, incremental; creation time: 4/25/2009 11:44:47 AM FILE name: FAAA.TIB; size: 3125550 byte type: file, base; creation time: 8/22/2009 12:28:40 PM FILE name: FAAB2.
Command Mandatory options Other options list /vault:Managed_Vault Either /arc:Archive_Name or /arc id:Archive_UUID Lists the contents of a centralized managed vault or of an archive stored in it /password:Password /credentials:User_Name:Password export /vault:Managed_Vault /include_pits:Backup_Numbers_List Exports an archive (or one or more backups stored in it) from a centralized managed vault to a local or network folder Either /arc:Archive_Name or /arc /password:Password id:Archive_UUID /cred
StorageNodeCmd /list /vault:"bsp://My Storage Node/MyVault" Specify only one of these options. If both are specified, the arc_id option is used. 1.2.2.2 credentials Specifies the user name and password to access the location (a managed vault or a folder) whose name is given by the vault option—for example: /credentials:"MyDomain\User A":"My PassWd123" 1.2.2.
1.2.2.8 progress Specifies whether to show (/progress:on) or hide (/progress:off) the progress of an exporting or importing operation. Without this option, the progress is shown. 1.2.2.9 target_arc Specifies the name of the exported archive—for example: /target_arc:"Exported Archive" Without this option, the exported archive will have the same name as the original archive. 1.2.2.
Listing the vault's archives The following command shows the list of archives that are stored in the vault.
StorageNodeCmd /export /vault:"bsp://My Node/My Vault" /arc:"My Archive" /include_pits:0 /target_vault:"C:\Archives" /target_arc:"Exported Archive" Importing an archive The following command imports the Archive 1 archive from the C:\Archives folder to the vault. StorageNodeCmd /import /vault:"C:\Archives" /arc:"Archive 1" /target_vault:"bsp://My Node/My Vault" 1.2.
TrueImageTerminal execution parameters: TrueImageTerminal.exe [arguments] Arguments include the following: /help – outputs help information about TrueImageTerminal.exe parameters. /progress – outputs the progress of backup operations run either from Acronis Backup & Recovery 10 graphics user interface, or from the script. /execute: [script file name] – executes a script. If there are several scripts to be executed, they are queued. An example for executing MyBackup.tis script: TrueImageTerminal.
Compression specifies the backup compression level. Can be None, Normal, High, Maximum. Incremental specifies whether you need to create an incremental image file. If equal to ”false” (or “0”), a complete image file will be created. If there is already a file with the specified name, it will be replaced without warnings. If equal to “true” (or “1”) and there is already a file with the specified name, an incremental image will be created. Otherwise the program will create a complete image file.
2 Console mode in Linux Console is a natural part of Linux OS. Acronis Backup & Recovery 10 supports it through the trueimagecmd command line tool. It provides a way to initiate data backup and recovery operations. trueimagecmd also enables you to automate backup with the ‘cron’ service. The trueimagecmd functionality is somewhat limited as compared to the GUI mode. trueimagecmd does not support operations that require: reboot of the system, such as restore a system partition or clone system drive.
Command Common Options create Specific Options --vault:[path] --arc:[archive name] Creates an image of specified --arc_id:[archive id] disks and partitions --filename:[filename] --password:[password] --crypt:[AES128|AES192|AES256] --incremental --differential --compression:*0…9+ --split:[size in MB] --oss_numbers --log:[filename] --silent --harddisk:[disk number] --partition:[partition number] --raw --progress:[on|off] --exclude_names:[names] --exclude_masks:[masks] --exclude_hidden --before:[pre-data
--log:[filename] --silent verify Verifies the archive data integrity --vault:[path] --arc:[archive name] --arc_id:[archive id] --filename:[filename] --password:[password] --asz:[number of archive] --log:[filename] --silent --folder_name:[path] --no_subdir pit_info --filename:[filename] --password:[password] Displays the numbered list of --asz:[number of archive] backups, contained in the specified archive consolidate Creates a consistent copy of the archive which will contain only the specified backups
asz_content --password:[password] Displays the Acronis Secure Zone size, free space and contents asz_files --password:[password] Displays the Acronis Secure Zone size, free space and contents using the generated file names asz_delete Deletes the Acronis Secure Zone --password:[password] --oss_numbers --log:[filename] --silent --partition:[partition number] asrm_activate Activates the Acronis Startup Recovery Manager asrm_deactivate Deactivates the Acronis Startup Recovery Manager clone Clones a hard
Network folders, e.g.: --vault:smb://Server/Share/ FTP and SFTP, e.g.: --vault:ftp://ServerA/Folder1 Managed vaults (for advanced product editions only), e.g.: --vault:bsp://StorageNode/VaultName CD, DVD – with the path specified as a local path, e.g.: --vault:/mnt/cdrom Acronis Secure Zone, e.g.: --vault:atis:///asz Tapes, e.g.: --vault:atis:///tape?0 Unmanaged vaults are specified by their path. For example, if a vault is located in a folder, specify the path to that folder.
password:[password] a) Password for the archive, if the archive location is other than ASZ. b) Password for the ASZ, if archive location is ASZ. asz:[number of archive] Addresses to the ASZ and selects the archive (a full backup with or without increments). To get the archive number, use asz_content.
differential Set the backup type to differential. If not specified or there is no basic full backup, a full backup will be created. compression:[0…9] Specify the data compression level. It ranges from 0 to 9 and is set to 3 by default. crypt:[AES128|AES192|AES256] Specifies the key size for the AES algorithm encryption of the password-protected archive. The option is used together with the --password (p. 9) option.
2.1.3 2.1.3.1 Specific options create harddisk:[disk number] Specifies the numbers of the hard disks to be imaged (comma separated). For example: --harddisk:1,3 You can obtain the list of available hard disks using the --list command. partition:[partition number] Specifies the partitions to include into the image file by numbers. The list of available partitions is provided by the --list command. Partition numbers are specified as -, e.g.
In Linux, a file is considered hidden if the first symbol in the file name is a dot. before:[pre-data capture command] Enables to define the command to be automatically executed before data capture. after:[post-data capture command] Enables to define the command to be automatically executed after data capture. 2.1.3.2 filebackup include:[names] Files and folders to be included in the backup (comma separated). For example: --include:'/home/bot/ATIESsafe.iso,/home/bot/ATIW.
2.1.3.3 restore harddisk:[disk number] Specifies the hard disks to restore by numbers. partition:[partition number] Specifies the partitions to restore by numbers. For example: --partition:1-1,1-2,3-1 To specify a logical volume (also called LVM volume) or an MD device (also called Linux Software RAID), use the DYN prefix. For example: --partition:dyn1 To list the partitions stored in the backup, use the --list command. For example: trueimagecmd --list --filename:backup.
When restoring a partition on unallocated space, the program extracts the partition type from the image.
--include:'/home/bot/file1.i686,/home/bot/MyProject' If not specified, all contents of the file backup are restored. 2.1.3.5 verify folder_name:[path] Specifies a path to the local folder that contains archives to verify. For example: --folder_name:'/home/bot/MyProject' By default, all archives stored in the folder and its subfolders will be verified. To exclude the subfolders from verification, add the --no_subdir (p. 47) option. no_subdir This option is used together with the /folder_name (p.
Managed vaults (for advanced product editions only), e.g.: --vault:bsp://StorageNode/VaultName Network folders, e.g.: --vault:smb://Server/Share/ FTP and SFTP, e.g.: --vault:ftp://ServerA/Folder1 CD, DVD – with the path specified as a local path, e.g.: --vault:/mnt/cdrom Acronis Secure Zone, e.g.: --vault:atis:///asz Tapes, e.g.: --vault:atis:///tape?0 Unmanaged vaults are specified by their path. For example, if a vault is located in a folder, specify the path to that folder.
If the vault option is specified the filename option is ignored. arc:[archive name] Used in combination with the vault option. Lists all backups contained in the archive. If not specified, the arc_id option is used. If both the arc and arc_id options are specified, the arc_id option is used. arc_id:[archive id] Used in combination with the vault option. Lists all backups of the selected archive. If not specified, the arc option is used.
2.1.3.12 clone harddisk:[disk number] Specifies a source hard disk which will be cloned to the new hard disk. target_harddisk:[disk number] Specifies the target hard disk number where the source hard disk will be cloned. 2.1.4 trueimagecmd usage examples The following command will list available partitions: trueimagecmd --list The following command will list the partitions (and their indices) saved in backup.tib: trueimagecmd --list --filename:backup.
The following command will list backups, contained in the archive /usr/backups/backups.tib, with their pit numbers. This command is designed to obtain pit numbers for consolidation: trueimagecmd --pit_info --filename:/usr/backups/backups.
Disk 1: 1-1 hda1 Pri,Act Table hda5 hda6 hda7 hda8 1-2 1-3 1-4 1-5 Disk 2: 2-1 (/1) hdd1 Pri,Act Table 2-2 hdd5 2-3 hdd6 31.35 MB 26.67 MB 980.5 4.887 9.767 3.462 MB GB GB GB 135.9 MB 1.751 GB 1.3 GB 4.806 GB 4.627 GB 3 GB 3.906 GB 1.319 GB FAT16 Table Linux Swap Ext2 Ext2 Ext2 Ext3 Table Ext3 Ext3 You need to back up partition 2-1. Let’s suppose a complete image has to be created weekly, supported by incremental images created daily. To do this, place the respective executable files (e.g.
-l|--list Lists already mounted user mode block devices. -m|--mount mountpoint Mounts the archive image specified by the -f|--filename option into the folder specified by the mountpoint option. The partition index should be specified by the -i|--index option. Image file contents (partitions and their indices) may be listed by the trueimagecmd --list --filename:filename command. To mount an incremental image, you must have all previous incremental images and the initial full image.
Specifies the password to explore password protected images. -t|--fstype filesystem type Specifies the explicit filesytem type to be passed to the standard "mount" command. This option is useful if the standard "mount" command can't guess the filesystem type for some reason. -i|--index partition index Index of the partition. -w|--read-write Opens the image in read-write mode. After umount, all changed data will be saved into the archive with a new index.
