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:[filename]
–password:[password]
–crypt:[AES128|AES192|AES256]
–incremental
–differential
–compression:[0…9]
–split:[size in MB]
–oss_numbers
–log:[filename]
–silent

Suppresses the command’s output.

Create a log file of the current operation with the specified file name.

Declares that numbers of partitions in the partition option are adjusted for the MBR partition table rather than be simple ascending numbers. This means that primary partitions have numbers 1-1, 1-2, 1-3, 1-4 and 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.

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.

  1. Password for the archive, if the archive location is other than ASZ.
  2. Password for the ASZ, if archive location is ASZ.

Archive name, if the archive location is other than ASZ.

To get Samba network access, specify the backup file name and the log file name as follows:

–filename:smb://username:password@hostname/sharename/filename

–log:smb://username:password@hostname/sharename/logfilename

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://dhcp6-223.acronis.com/sdb3/nfs_root:/mike/md1.tib

shows contents of /mike/md1.tib archive. /mike/md1.tib is located on dhcp6-223.acronis.com node in /sdb3/nfs_root directory exported by NFS.

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 the arc and arc_id 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:/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.: –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.

–harddisk:[disk number]
–partition:[partition number]
–raw
–progress:[on|off]
–exclude_names:[names]
–exclude_masks:[masks]
–exclude_hidden
–before:[pre-data capture command]
–after:[post-data capture command]

Enables to define the command to be automatically executed after data capture.

Enables to define the command to be automatically executed before data capture.

Excludes all hidden files from the backup.

In Linux, a file is considered hidden if the first symbol in the file name is a dot.

Applies masks to select files
to be excluded from the backup. Use the common Linux masking rules. For example, to exclude all files with extension .sh, add *.sh. My???.sh will exclude all .sh files with names consisting of five symbols and starting with “my”.

Specifies files and folders to be excluded from the backup (comma separated). Object names have to be specified relative to the objects’ partitions root entry.

For example, if “boot” partition is mounted to the /boot directory and it is necessary to exclude the “grub” directory from a backup, then it must be specified as /grub/. If this directory is located on a root partition, then /boot/grub/ should be specified to exclude it from the backup.

Shows/hides the progress information (percent completed). It is shown by default.

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 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 <disk number>-<partition number>, e.g.: 

  --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

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.

filebackup

Backs up specified files and folders

–vault:[path]
–arc:[archive name]
–arc_id:[archive id]
–filename:[filename]
–password:[password]
–crypt:[AES128|AES192|AES256]
–incremental
–differential
–compression:[0…9]
–split:[size in MB]
–log:[filename]
–silent

–include:[names]
–exclude_names:[names]
–exclude_masks:[masks]
–exclude_hidden
–before:[pre-data capture command]
–after:[post-data capture command]
–progress:[on | off]

Files and folders to be excluded from the backup (comma separated). For example: 

  --exclude_names:'/home/bot/ATIESsafe.iso,/home/bot/MyProject/Old'

Files and folders to be included in the backup (comma separated). For example: 

  --include:'/home/bot/ATIESsafe.iso,/home/bot/ATIW.iso'

restore

Restores disks and partitions from an image

–filename:[filename]
–password:[password]
–asz:[number of archive]
–index:N
–oss_numbers
–log:[filename]
–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.

Addresses to the ASZ and selects the archive (a full backup with or without increments).

To get the archive number, use asz_content.

–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:[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.

Sets the new partition size (in sectors).

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 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.

Specifies the hard disk number where the image will be restored.

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.tib

Specifies the hard disks to restore by numbers.

filerestore

Restores files and folders from a file archive

–vault:[path]
–arc:[archive name]
–arc_id:[archive id]
–filename:[filename]
–password:[password]
–asz:[number of archive]
–index:N
–log:[filename]
–silent

–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:'/home/bot/file1.i686,/home/bot/MyProject'

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.

deploy_mbr

Restores the MBR from a disk or partition image

–vault:[path]
–arc:[archive name]
–arc_id:[archive id]
–filename:[filename]
–password:[password]
–asz:[number of archive]
–index:N
–oss_numbers
–log:[filename]
–silent

–harddisk:[disk number]
–target_harddisk:[disk number]

Specifies the target hard disk where the MBR will be deployed to.

Specifies the basic hard disk to restore the MBR from.

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

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:'/home/bot/MyProject' --no_subdir

If the option is 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:'/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 option.

pit_info

Displays the numbered list of backups, contained in the specified archive

–filename:[filename]
–password:[password]
–asz:[number of archive]

 

consolidate

Creates a consistent copy of the archive which will contain only the specified backups

–include_pits:[pits numbers]
–filename:[filename]
–password:[password]
–log:[filename]
–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

–target_filename:[file name]

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]
–progress:[on | off]
–log:[filename]
–net_user:[username]
–net_password:[password]
–ftp_user:[username]
–ftp_password:[password]
–silent

Specify a password for access to an FTP server.

Specify a user name for access to an FTP server.

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.

–target_vault:[target path]
–target_arc:[target archive name]

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 and unmanaged vaults, e.g.: –vault:/folder, or –vault:"/Folder 1"
  • 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.

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]

–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:/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.: –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.

With this option, the image contents are displayed.

When listing image contents, 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.

asz_create

Creates the Acronis Secure Zone on the selected drive

–password:[password]
–oss_numbers
–log:[filename]
–silent

–harddisk:X
–partition:[partition number]
–size:[ASZ size in sectors]

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

Deletes the Acronis Secure Zone

–password:[password]
–oss
_numbers
–log:[filename]
–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

 

–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

 

 

dumpraidinfo

Saves information about MD devices and LVM volumes to the /etc/Acronis directory

 

 

Supported commands