Acronis® Backup & Recovery™ 10 Advanced Server 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 .........................................................................................26 1.2.1 1.2.2 1.2.3 1.2.4 1.3 Script execution parameters ..............................
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. 2. 3. 4. 5. Ability to use the before/after data capture commands. Ability to use the VSS support option. Ability to check for a license on the license server with the /ls_check command. Ability to use file exclusion at disk backup.
create Creates an image of specified disks and partitions filebackup Backs up specified files and folders deploy Restores disks and partitions, except for the MBR, from an image 4 /vault:[path] /arc:[archive name] /arc_id:[archive id] /filename:[file name] /password:[password] /asz:[number of archive] /net_user:[username] /net_password:[password] /ftp_user:[username] /ftp_password:[password] /incremental /differential /compression:[0…9] /split:[size in MB] /oss_numbers /progress:[on|off] /reboot /log:[f
deploy_mbr /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:[username] /ftp_password:[password] /oss_numbers /reboot /log:[file name] /log_net_user:[remote user] /log_net_password:[password] /harddisk:[disk number] /target_harddisk:[disk number] filerestore /target_folder:[target folder] /overwrite:[older|never|always]
consolidate Creates a consistent copy of the archive which will contain only the specified backups export Creates a copy of an archive or a selfsufficient part copy of an archive in the location you specify convert Converts an image to virtual disk format for using with a virtual machine /include_pits:[pits numbers] /filename:[file name] /password:[password] /ftp_user:[username] /ftp_password:[password] /reboot /log:[file name] /log_net_user:[remote user] /log_net_password:[password] /target_filename:[f
/net_user:[username] /net_password:[password] /log:[file name] /log_net_user:[remote user] /log_net_password:[password] *for a split image, the name of the last created file unplug /letter:X /letter:all Disconnects the image connected as a virtual drive asz_create Creates the Acronis Secure Zone on the selected drive /password:[password] /oss_numbers /reboot /log:[file name] /log_net_user:[remote user] /log_net_password:[password] asz_content /password:[password] /harddisk:X /partition:[partition numb
clone /reboot Clones a hard disk /harddisk:[disk number] /target_harddisk:[disk number] help Shows usage ls_check Checks if there are licenses for the local machine on the license server 1.1.2 1.1.2.1 Common options Access to archives vault:[path] Specifies a path to the location that contains the archive. Used in combination with the arc, or the arc_id option. The following locations are supported: Local folders, e.g.: /vault:C:\Test, or /vault:"C:\Test 1" FTP and SFTP, e.g.
b) Archive name, when restoring or deleting files from ASZ. Can be obtained with asz_files. If the vault option is specified the filename option is ignored. password:[password] a) Password for the archive, if the archive location is other than ASZ. b) Password for the ASZ, if archive location is ASZ. asz:[number of archive] Addresses to the ASZ and selects the archive (a full backup with or without increments). To get the archive number, use asz_content.
1.1.2.2 Backup options incremental Set the backup type to incremental. If not specified or there is no basic full backup, a full backup will be created. differential Set the backup type to differential. If not specified or there is no basic full backup, a full backup will be created. compression:[0…9] Specify the data compression level. It ranges from 0 to 9 and is set to 3 by default. split:[size in MB] Split the backup into parts of the specified size, if the archive location is other than ASZ. 1.1.
1.1.3 Specific options 1.1.3.1 create harddisk:[disk number] Specifies the hard disks to include into the image file. The list of available hard disks is provided by the /list command. An image may contain data of more than one hard disk. In that case, separate disk numbers by commas, e.g.: /harddisk:1,3 By specifying /harddisk:DYN you will back up all dynamic volumes present in the system. partition:[partition number] Specifies the partitions to include into the image file.
progress:[on | off] Shows/hides the progress information (percent completed). It is shown by default. exclude_names:[names] Files and folders to be excluded from the backup (comma separated). For example: /exclude_names:E:\MyProject\111.doc,E:\MyProject\Old exclude_masks:[masks] Applies masks to select files to be excluded from the backup. Use the common Windows masking rules. For example, to exclude all files with extension .exe, add *.exe. My???.exe will exclude all .
exclude_masks:[masks] Applies masks to select files to be excluded from the backup. Use the common Windows masking rules. For example, to exclude all files with extension .exe, add *.exe. My???.exe will exclude all .exe files with names consisting of five symbols and starting with “my”. exclude_system Excludes all system files from the backup. exclude_hidden Excludes all hidden files from the backup.
partition:[partition number] Specifies the partitions to restore. Dynamic volumes are specified with the prefix DYN, e.g.: /partition:DYN1 target_harddisk:[disk number] Specifies the hard disk number where the image will be restored. By specifying /target_harddisk:DYN you will select unallocated space on all dynamic disks that are present in the system. target_partition:[partition number] Specifies the target partition number for restoring a partition over the existing one.
if the target disk is the 1st according to BIOS and it has no other primary partitions, the restored partition will be set active if the target disk is the 1st according to BIOS and there are other primary partitions on it, the restored partition will be set logical if the target disk is not the 1st, the restored partition will be set logical. preserve_mbr When restoring a partition over an existing one, the target partition is deleted from the disk along with its entry in the target disk MBR.
1.1.3.5 filerestore target_folder:[target folder] Specifies a folder where folders/files will be restored (a target folder). If not specified, the original path is re-created from the archive. overwrite:[older | never | always] This option allows you to keep useful data changes made since the backup being restored was done.
1.1.3.7 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. ftp_src_password:[password] Specifies the password for logon to the FTP/SFTP server to access the source archive.
1.1.3.8 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 vault option is specified the filename option is ignored. vault:[path] Specifies a path to the location whose archives you want to list. Along with archive names, it lists Universally Unique Identifiers (UUID) that are used with the arc_id option. The following locations are supported: Local folders, e.g.: /vault:C:\Test , or /vault:"C:\Test 1" FTP and SFTP, e.g.: /vault:ftp://ServerA/Folder1 Network folders, e.g.
1.1.3.11 unplug letter:X Specifies the virtual drive to be disconnected by letter. letter:all Disconnects all virtual drives. 1.1.3.12 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. size:[ASZ size in sectors | unallocated] Sets the Acronis Secure Zone size (in sectors).
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. The following command will create an image of partitions 2-1 and 1-3 in the Acronis Secure Zone: trueimagecmd /create /asz /partition:2-1,1-3 The following command will create an image named 1.
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. The following command will restore partition 1-1, stored in image Server30Cdrive.tib, protected with password ‘123qwe’, to partition 2-1. The restored partition will be of the active type: trueimagecmd /deploy /filename:z:\Server30Cdrive.
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.
stored in it export /vault:Managed_Vault 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 /credentials:User_Name:Password /target_vault:Folder_Name /target_arc:Archive_Name /include_pits:Backup_Numbers_List /target_credentials:User_Name:Password /progress:{on|off} /log:Log_File_Name /log_net_user:User_Name /log_net_password:Password import /vault:Folder_Name /pas
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.3 include_pits For the archive whose name is given by the arc or arc_id option, specifies the list of backups (sometimes called pits) that you want to export—for example: /include_pits:0,4,5 The number 0 identifies the newest backup in the archive. Use commas to separate the backup numbers.
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.10 target_credentials Specifies the user name and password to access the location (a managed vault or a folder) whose name is given by the target_vault option—for example: /target_credentials:"MyDomain\User A":"My PassWd123" 1.2.2.
type: image; owner: domain/sample_user; machine: sample-comp; date: 6/27/2009 11:39:10 AM; used_space: 1000000000; id: 183DE307-BC97-45CE-9AF7-60945A568BE8 Archive name: My new Archive type: file; owner: domain/sample_user; machine: sample-comp; date: 6/27/2009 11:50:10 AM; used_space: 2000000000; id: 283DE307-BC97-45CE-9AF7-60945A568BE8 Archive name: The last Archive type: image; owner: domain/sample_user; machine: sample-comp; date: 6/29/2009 11:20:10 AM; used_space: 3000000000; id: 383DE307-BC97-45CE-9AF
1.2.4 Exporting vaults and importing multiple archives To export all archives stored in a managed vault or to import all archives from a folder to a managed vault, you can use the scripts that are provided with Acronis Backup & Recovery 10 Storage Node. The scripts are located in the folder where the storage node is installed—by default, C:\Program Files\Acronis\StorageNode. Password-protected archives will be skipped during export or import. To export all archives from a managed vault to a folder 1.
/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.exe /execute:C:\MyBackup.tis /nowait – an optional script execution argument. Enables to terminate TrueImageTerminal before backup is finished. Example: TrueImageTerminal /execute:C:\MyBackup.tis /nowait By pressing Ctrl+C you can forcibly turn off backup progress output and switch TrueImageTerminal to a background operation.
Description adds a description to an image file. The comment must be a single string (though its length is not limited.) Split splits a large image file into a number of smaller files of the specified size, which can be provided in bytes, kilobytes, megabytes, etc. Password adds password protection to an image file. 1.3.3 Script usage examples The following example illustrates the usage of a script to back up two partitions (logical drives), C and F. mybackup2.
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.
--incremental --differential --compression:[0…9] --split:[size in MB] --log:[filename] restore --after:[post-data capture command] --progress:[on | off] --filename:[filename] --password:[password] Restores disks and partitions --asz:[number of archive] from an image --index:N --oss_numbers --log:[filename] --harddisk:[disk number] --partition:[partition number] --target_harddisk:[disk number] --target_partition:[partition number] --start:[start sector] --fat16_32 --size:[partition size in sectors] --type
you specify --progress:[on | off] --log:[filename] --net_user:[username] --net_password:[password] --ftp_user:[username] --ftp_password:[password] list --password:[password] --index:N --asz:[number of archive] --filename:[file name] --vault:[path] --arc:[archive name] --arc_id:[archive id] --password:[password] --oss_numbers --log:[filename] --harddisk:X --partition:[partition number] --size:[ASZ size in sectors] Lists available drives and partitions.
license server dumpraidinfo Saves information about MD devices and LVM volumes to the /etc/Acronis directory 2.1.2 2.1.2.1 Common options Access to archives vault:[path] Specifies a path to the location that contains the archive. Used in combination with the arc, or the arc_id option. The following locations are supported: Local folders, e.g.: --vault:/folder, or --vault:"/Folder 1" FTP and SFTP, e.g.: --vault:ftp://ServerA/Folder1 Network folders, e.g.
or: --filename:smb://hostname/sharename/filename –-net_user:username \ -– net_password:password --log:smb://hostname/sharename/logfilename –-log_net_user:username \ -– log_net_password:password Only the last two options can be used if the user name or password contains the @ or / symbols. To access an NFS network drive, specify the backup file name as follows: nfs://hostname/share name:/remote filename For example: trueimagecmd --list --filename:nfs://dhcp6223.acronis.com/sdb3/nfs_root:/mike/md1.
net_password:[password] Specifies the password for logon to the network share to save the resulting archive. include_pits:[pits numbers] Specifies the backups (pits) to be included in the archive copy. To get the numbers of pits, use pit_info. Separate multiple values with a comma, for example: --include_pits:2,4,5 2.1.2.2 Backup options incremental Set the backup type to incremental. If not specified or there is no basic full backup, a full backup will be created.
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.
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.iso' exclude_names:[names] Files and folders to be excluded from the backup (comma separated). For example: --exclude_names:'/home/bot/ATIESsafe.
partition:[partition number] Specifies the partitions to restore by numbers. target_harddisk:[disk number] Specifies the hard disk number where the image will be restored. target_partition:[partition number] Specifies the target partition number for restoring a partition over the existing one. If the option is not specified, the program assumes that the target partition number is the same as the partition number specified with the partition option.
source disk MBR saved in the image. If the position is not empty, the existing entry will be moved to another position. 2.1.3.4 filerestore target_folder:[target folder] Specifies a folder where folders/files will be restored (a target folder). If not specified, the original path is re-created from the archive. overwrite:[older | never | always] This option allows you to keep useful data changes made since the backup being restored was done.
2.1.3.7 export target_vault:[target path] Specifies a path to the target location to export the archive to. The following target locations are supported: Local folders and unmanaged vaults, e.g.: --vault:/folder, or --vault:"/Folder 1" Network folders, e.g.: --vault:smb://Server/Share/ Managed vaults (for advanced product editions only), e.g.: -vault:bsp://StorageNode/VaultName FTP and SFTP, e.g.: --vault:ftp://ServerA/Folder1 CD, DVD – with the path specified as a local path, e.g.
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.
2.1.3.10 asz_delete partition:[partition number] Specifies partitions to which free space will be added after the Acronis Secure Zone is deleted. If you specify several partitions, the space will be distributed proportionally based on each partition’s size. 2.1.3.11 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.
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 31.35 MB 1-2 hda5 980.5 1-3 hda6 4.887 1-4 hda7 9.767 1-5 hda8 3.462 Disk 2: 2-1 (/1) hdd1 Pri,Act Table 2-2 hdd5 3 GB 2-3 hdd6 3.906 MB GB GB GB 26.67 MB 135.9 MB 1.751 GB 1.3 GB 4.806 GB GB FAT16 Table Linux Swap Ext2 Ext2 Ext2 4.627 GB 1.319 GB Ext3 Ext3 Ext3 Table 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.
-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.
3 Index A Command-line mode and scripting in Windows • 3 Common options • 8, 37 compression Access to archives • 8, 37 Acronis Secure Zone deleting backups • 25 managing backups by archive numbers • 24 managing backups by file names • 25 after [post-data capture command] • 12, 13, 41 Agent for Windows command-line utility • 3 arc [archive name] • 8, 19, 37, 45 [0…9] • 10, 39 Console mode in Linux • 34 consolidate • 16, 43 Consolidate backups • 22 convert • 18 Convert an image to virtual disk • 23 create
[file name] • 8, 18 log_net_password • 28 [password] • 10 [filename] • 37, 44 filerestore • 16, 43 log_net_user • 28 [remote user] • 10 ftp_password [password] • 9, 38 N ftp_src_password [password] • 17 net_password [password] • 9, 16, 17, 39 ftp_src_user [username] • 17 net_src_password [password] • 16, 17 ftp_user [username] • 9, 38 net_src_user [username] • 16, 17 G net_user [username] • 9, 16, 17, 38 General options • 10, 39 H O harddisk Options • 27, 32 [disk number] • 11, 13, 15, 18
Restore files • 22 trueimagecmd.
