Supported commands
trueimagecmd has the following format:
trueimagecmd /command /option1 /option2…
Commands may be accompanied with options. Some options are common for most trueimagecmd commands, while others are specific for individual commands. Below is a list of supported commands and compatible options.
Command
|
Common Options
|
Specific Options
|
create
Creates an image of specified disks and partitions
|
/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
Suppresses the command’s output.
If the log file is created on a network share, include the password for logon to the share.
If the log file is created on a network share, include the user name for logon to the share.
Create a log file of the current operation with the specified file name.
Reboot the machine before the operation (if required) or after the operation is completed.
Use this option when performing the following operations that require a reboot: recovering locked files, creating/deleting Acronis Secure Zone on a system disk, cloning a system disk. The machine will be rebooted automatically. To postpone the operation until a user reboots the system manually, add the /later option. With this option, the operation will be performed after the user initiates a reboot.
The /reboot option can be used with operations that do not necessarily require a reboot. Examples of such operations are: recovery under bootable media, recovering files that are not locked by the operating system, archives validation, and most types of backup. In those cases a reboot will be performed after the operation is completed. The /later option is not necessary.
The following table summarizes the software behavior with and without the /reboot and /later options.
|
Reboot is necessary |
Reboot is not required |
/reboot /later |
Reboot before operation (postponed)
|
Reboot after operation
|
/reboot |
Reboot before operation
|
Reboot after operation
|
no option |
No reboot, operation fails
|
No reboot, operation succeeds
|
Shows/hides the progress information (percent completed). It is shown by default.
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. For example, if the disk has one primary and two logical partitions, their numbers can appear as follows:
/partition:1-1,1-2,1-3
or
/oss_numbers /partition:1-1,1-5,1-6
Split the backup into parts of the specified size, if the archive location is other than ASZ.
Specify the data compression level.
It ranges from 0 to 9 and is set to 3 by default.
Set the backup type to differential.
If not specified or there is no basic full backup, a full backup will be created.
Set the backup type to incremental.
If not specified or there is no basic full backup, a full backup will be created.
Specify a password for access to an FTP server.
Specify a user name for access to an FTP server.
Specify a password for network drive access.
Specify a user name for network drive access.
Addresses to the ASZ and selects the archive (a full backup with or without increments).
To get the archive number, use asz_content.
Specifies the key size for the AES algorithm encryption of the password-protected archive. The option is used together with the /password option. For example:
/password:QWerTY123 /crypt:AES256
The randomly generated encryption key is then encrypted with AES-256 using a SHA-256 hash of the password as a key. The password itself is not stored anywhere on the disk or in the backup file; the password hash is used for verification purposes. With this two-level security, the backup data is protected from any unauthorized access, but recovering a lost password is not possible.
If the /crypt option is not specified, the password-protected archive will be not encrypted.
- Password for the archive, if the archive location is other than ASZ.
- Password for the ASZ, if archive location is ASZ.
- Backup file name, if the archive location is other than ASZ.
- Archive name, whe
n restoring or deleting files from ASZ. Can be obtained with asz_files.
If the vault option is specified the filename option is ignored.
Specifies the Universally Unique Identifier (UUID) of the archive, e.g.:
/arc_id:183DE307-BC97-45CE-9AF7-60945A568BE8
If not specified, the arc option is used. If both options are specified, the arc_id option is used.
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.
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"
- Network folders, e.g.:
/vault:\\ServerA\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.:
/vault:F:\
- 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.
|
/harddisk:[disk number] /partition:[partition number] /file_partition:[partition letter] /raw /exclude_names:[names] /exclude_masks:[masks] /exclude_system /exclude_hidden /before:[pre-data capture command] /after:[post-data capture command] /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.
Enables to define the command to be automatically executed after data capture at the beginning of the backup procedure. For example:
/after:"net start MSSQLSERVER"
Enables to define the command to be automatically executed before data capture at the beginning of the backup procedure. For example:
/before:"net stop MSSQLSERVER"
Excludes all hidden files from the backup.
Excludes all system files from the backup.
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”.
Files and folders to be excluded from the backup (comma separated). For example:
/exclude_names:E:\MyProject\111.doc,E:\MyProject\Old
Use this option to create an image of a disk (partition) with an unrecognized or unsupported file system. This will copy all disk/partition contents sector-by-sector. Without this option only the sectors containing useful system and user data are imaged (for the supported file systems).
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.tib”
Specifies the partitions to include into the image file. The list of available partitions is provided by /list. Partition numbers are specified as <disk number>-<partition number>, e.g.:
/partition:1-1,1-2,3-1
Dynamic volumes are specified with the prefix DYN, e.g.:
/partition:DYN1,DYN2
Both basic partitions and dynamic volumes can be specified by their letters, for example:
/partition:"C"
Mixed notation is also acceptable, for example:
/partition:1-1,"D"
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.
|
filebackup
Backs up specified files and folders
|
/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] /reboot /log:[file name] /log_net_user:[remote user] /log_net_password:[password] /silent |
/include:[names] /exclude_names:[names] /exclude_masks:[masks] /exclude_system /exclude_hidden /before:[pre-data capture command] /after:[post-data capture command] /use_vss
Files and folders to be included in the backup (comma separated). For example:
/include:E:\Workarea\MyProject
|
deploy
Restores disks and partitions, except for the MBR, from an image
|
/vault:[path] /arc:[archive name] /arc_id:[archive id] /filename:[file name] /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] /
silent
N = Number of the backup in an archive:
- 1 = basic full backup
- 2 = 1st increment… and so on
- 0 (default) = latest increment
Selects a backup in a sequence of incremental backups inside the archive.
To get a backup index from the ASZ, use asz_content.
|
/file_partition:[partition letter] /harddisk:[disk number] /partition:[partition number] /target_harddisk:[disk number] /target_partition:[partition number] /start:[start sector] /size:[partition size in sectors] /fat16_32 /type:[active|primary|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. Then, with the preserve_mbr option, the restored partition’s entry will occupy the upper empty position in the target disk MBR. Thus, the target disk MBR is preserved. If not specified, the restored partition’s entry will occupy the same position as in the source disk MBR saved in the image. If the position is not empty, the existing entry will be moved to another position.
Sets the restored partition active, primary or logical, if possible (for example, there cannot be more than four primary partitions on the disk). Setting a partition active always sets it primary, while a partition set primary may remain inactive.
If the type is not specified, the program tries to keep the target partition type. If the target partition is active, the restored partition is set active. If the target partition is primary, and there are other primary partitions on the disk, one of them will be set active, while the restored partition becomes primary. If no other primary partitions remain on the disk, the restored partition is set active.
When restoring a partition on unallocated space, the program extracts the partition type from the image. For the primary partition, the type will be set as follows:
- 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.
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.
Sets the new partition size (in sectors).
Sets the start sector for restoring a partition to the hard disk unallocated space.
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.
Dynamic volumes are specified with the prefix DYN, e.g.:
/target_partition:DYN1
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.
Specifies the partitions to restore.
Dynamic volumes are specified with the prefix DYN, e.g.:
/partition:DYN1
Specifies the basic hard disks to restore.
When using the Acronis Universal Restore option:
/ur_path:[path] /ur_username:[user] /ur_password:[pwd] /ur_driver:[inf-filename]
Specifies using Acronis Universal Restore and the mass-storage driver to be installed.
Specifies using Acronis Universal Restore and a password associated with the ur_username option value.
Specifies using Acronis Universal Restore and a user name.
When getting access to a place located on the remote computer, the username depends on the service which is used to get access to the remote resource. E.g. if the remote resource is a shared folder located on a workgroup computer, the username must contain the remote computer name (“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”).
Specifies using Acronis Universal Restore and the path to the drivers storage.
|
deploy_mbr
Restores the MBR from a disk or partition image
|
/vault:[path] /arc:[archive name] /arc_id:[archive id] /filename:[file name] /password:[password] /asz:[number of archive] /index:N /net_user:[username] /net_password:[password] /ftp_user:[username] /ftp_password:[password] /reboot /log:[file name] /log_net_user:[remote user] /log_net_password:[password] /silent |
/harddisk:[disk number] /target_harddisk:[disk number] |
filerestore
Restores files and folders from a file archive
|
/vault:[path] /arc:[archive name] /arc_id:[archive id] /filename:[file name] /password:[password] /asz:[number of archive] /index:N /net_user:[username] /net_password:[password] /ftp_user:[username] /ftp_password:[password] /reboot /later /log:[file name] /log_net_user:[remote user] /log_net_password:[password] /silent
Postpone the reboot until a user restarts the system manually. The option is used with the /reboot option in the following operations that require a reboot: recovering locked files, creating/deleting Acronis Secure Zone on a system disk, cloning a system disk.
|
/target_folder:[target folder] /overwrite:[older|never|always] /restore_security:[on|off] /original_date:[on|off] /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.
Specifies whether to restore files’ original date and time from the archive or whether to assign the current date and time to the restored files. If not specified, the current date is assigned.
Specifies whether to restore files’ security attributes (default) or whether the files will inherit the security settings of the folder where they will be restored.
This option allows you to keep useful data changes made since the backup being restored was done. Choose what to do if the target folder contains a file with the same name as in the archive:
- older – this will give priority to the most recent file modification, whether it be in the archive or on the disk.
- never – this will give the file on the hard disk unconditional priority over the archived file.
- always – this will give the archived file unconditional priority over the file on the hard disk.
If not specified, the files on the disk will always be replaced with the archived files.
Specifies a folder where folders/files will be restored (a target folder). If not specified, the original path is re-created from the archive.
|
verify
Verifies the archive data integrity
|
/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] /reboot /log:[file name] /log_net_user:[remote user] /log_net_password:[password] /silent |
folder_name:[path] no_subdir
This option is used together with the /folder_name option. Prohibits verification of archives stored in the subfolders of the specified folder.
For example:
/folder_name:D:\MyBackups /no_subdir
If the option not specified, all archives stored in the parent folder and its subfolders will be verified.
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. To exclude the subfolders from verification, add the /no_subdir option.
|
pit_info
Displays the numbered list of backups, contained in the specified archive
|
/filename:[file name] /password:[password] /asz:[number of archive] /net_user:[username] /net_password:[password] /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:[remote user] /log_net_password:[password] /silent
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
The “0″ value means the last backup in the archive, for example:
/include_pits:0
If not specified the whole archive is selected.
|
/target_filename:[file name] /net_src_user:[username] /net_src_password:[password] /net_user:[username] /net_password:[password]
Specifies the password for logon to the network share to save the resulting archive.
Specifies the user name for logon to the network share to save the resulting archive.
Specifies the password for logon to the network share to access the source archive.
Specifies the user name for logon to the network share to access the source archive.
Specifies the path to and name of the archive copy to be created. If there are two or more backups (pits) in the copy, numbers will be added to their names.
|
export Creates a copy of an archive or a self-sufficient part copy of an archive in the location you specify
|
/vault:[path] /arc:[archive name] /arc_id:[archive id] /include_pits:[pits numbers] /password:[password] /ftp_user:[username] /ftp_password:[password] /progress:[on|off] /log:[file name] /log_net_user:[remote user] /log_net_password:[password] /silent |
/net_src_user:[username] /net_src_password:[password] /ftp_src_user:[username] /ftp_src_password:[password] /target_vault:[target path] /target_arc:[target archive name] /net_user:[username] /net_password:[password]
The name of the target archive. Has to be unique within the target folder. If there is an archive with the same name, the operation will fail.
Specifies a path to the target location to export the archive to.
The following target locations are supported:
- Local folders, e.g.:
/target_vault:C:\Test , or /vault:”C:\Test 1”
- Network folders, e.g.:
/target_vault:\\ServerA\Share\
- Managed vaults (for advanced product editions only), e.g.:
/target_vault:bsp://StorageNode/VaultName
- FTP and SFTP, e.g.:
/target_vault:ftp://ServerA/Folder1
- CD, DVD – with the path specified as a local path, e.g.:
/target_vault:F:\
- Acronis Secure Zone, e.g.:
/target_vault:atis:///asz
- Tapes, e.g.:
/target_vault:atis:///tape?0
- Unmanaged vaults are specified by thei
r path. For example, if a vault is located in a folder, specify the path to that folder.
Specifies the password for logon to the FTP/SFTP server to access the source archive.
Specifies the user name for logon to the FTP/SFTP server to access the source archive.
|
convert
Converts an image to virtual disk format for using with a virtual machine
|
/filename:[file name] /password:[password] /asz:[number of archive] /index:N /net_user:[username] /net_password:[password] /ftp_user:[username] /ftp_password:[password] /log:[file name] /log_net_user:[remote user] /log_net_password:[password] /silent |
/target_filename:[file name] /harddisk:[disk number] /vm_type:[vmware|esx|microsoft|parallels] /ur /ur_path:[path]
The same as ur with custom path to the virtual machine drivers storage.
Use when converting the image of a disk, containing Windows, and the resulting virtual disk is supposed to be bootable. With this key, the program will add drivers, necessary for the virtual machine type selected with the vm_type key, to the resulting virtual disk. If the image was taken from a virtual machine of the same type, normally the key is not needed.
Drivers for the virtual machine reside in the storage, defined by the registry key HKEY_LOCAL_MACHINE\SOFTWARE\Acronis\UniversalRestore\DriversPackPath. In case the storage has been moved, please change the key or use the command ur_path:[path].
The type of virtual machine to which the virtual disk will be added.
Specifies the hard disks to convert by numbers. For each disk, a separate virtual disk will be created.
By specifying
/harddisk:DYN
you will convert all dynamic volumes that are present in the system.
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.
|
list
Lists available drives and partitions. When used with the filename option, it lists the image contents.
When used with the vault option, it lists archives located in the specified location. When the arc, or the arc_id option is added, it lists all backups contained in the archive.
|
/password:[password] /index:N /asz:[number of archive] /net_user:[username] /net_password:[password] /ftp_user:[username] /ftp_password:[password] |
/filename:[file name] /vault:[path] /arc:[archive name] /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. If both the arc and arc_id options are specified, the arc_id option is used.
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.
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"
- Network folders, e.g.:
/vault:\\ServerA\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.:
/vault:F:\
- 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.
With this option, the image contents are displayed.
When listing image contents, the partition numbers may not coincide with those in the drives/partitions list, if the image does not contain all the disk partitions. For example, if the image contains partitions 2-3 and 2-5, they will be listed as 2-1 and 2-2.
If the deploy /partition command cannot find a partition in the image by its physical number, use the partition:<number in the image> /target_partition:<physical number of the 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.
|
explore
Connects an image as a virtual drive
|
/vault:[path] /arc:[archive name] /arc_id:[archive id] /filename:[file name]* /password:[password] /asz:[number of archive] /index:N /net_user:[username] /net_password:[password] /log:[file name] /log_net_user:[remote user] /log_net_password:[password] /silent
*for a split image, the name of the last created file
|
/partition:[partition number] /letter:X
Assigns letters to the mounted drives. This option is used with the partition option only.
Specifies a list of partitions to be mounted as virtual drives. Without this option, all partitions stored in the image will be mounted.
To obtain the partition number for this option, list the image contents with the /list/filename command and use the number from the Idx column
.
|
unplug
Disconnects the image connected as a virtual drive
|
|
/letter:X /letter:all
Disconnects all virtual drives.
Specifies the virtual drive to be disconnected by letter.
|
asz_create
Creates the Acronis Secure Zone on the selected drive
|
/password:[password] /oss_numbers /reboot /later /log:[file name] /log_net_user:[remote user] /log_net_password:[password] /silent |
/harddisk:X /partition:[partition number] /size:[ASZ size in sectors|unallocated]
Sets the Acronis Secure Zone size (in sectors).
If not specified, the size is set as an average between the maximal (unallocated space plus free space on all partitions selected with the partition option) and minimal (about 35MB) values.
Either way, the program will first use the unallocated space. If there is not enough unallocated space, the selected partitions will be decreased. Resizing of locked partitions requires a reboot.
With “unallocated”, the zone will use all unallocated space on the disk. Partitions will be moved, if necessary, but not resized. Moving of locked partitions requires a reboot. The partition option is ignored.
Specifies partitions from which free space will be taken for Acronis Secure Zone.
Specifies the hard disk number where the Acronis Secure Zone will be created.
|
asz_content
Displays the Acronis Secure Zone size, free space and contents
|
/password:[password] |
|
asz_files
Displays the Acronis Secure Zone size, free space and contents using the generated file names
|
/password:[password] |
|
asz_delete_files
Deletes the most recent backup in the archive located in the Acronis Secure Zone
|
/filename:[file name] /password:[password] /log:[file name] /log_net_user:[remote user] /log_net_password:[password] /silent |
|
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]
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.
|
asrm_activate
Activates the Acronis Startup Recovery Manager
|
|
|
asrm_deactivate
Deactivates the Acronis Startup Recovery Manager
|
|
|
clone
Clones a hard disk
|
/later /silent
|
/harddisk:[disk number] /target_harddisk:[disk number]
Specifies the target hard disk number where the source hard disk will be cloned.
Specifies a source hard disk which will be cloned to the
new hard disk.
|
help
Shows usage
|
|
|
ls_check
Checks if there are licenses for the local machine on the license server
|
|
|
|