Veeam Agent Linux 1 0 User Guide en
Veeam Agent Linux 1 0 User Guide en
Veeam Agent Linux 1 0 User Guide en
Version 1.0
User Guide
February, 2017
© 2017 Veeam Software.
All rights reserved. All trademarks are the property of their respective owners.
No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system,
or translated into any language in any form by any means, without written permission from Veeam
Software (Veeam). The information contained in this document represents the current view of Veeam
on the issue discussed as of the date of publication and is subject to change without notice. Veeam
shall not be liable for technical or editorial errors or omissions contained herein. Veeam makes no
warranties, express or implied, in this document. Veeam may have patents, patent applications,
trademark, copyright, or other intellectual property rights covering the subject matter of this
document. All other trademarks mentioned herein are the property of their respective owners. Except
as expressly provided in any written license agreement from Veeam, the furnishing of this document
does not give you any license to these patents, trademarks, copyrights, or other intellectual property.
Important! Please read the End User Software License Agreement before using the accompanying software
program(s). Using any part of the software indicates that you accept the terms of the End User
Software License Agreement.
Intended Audience
The user guide is intended for anyone who wants to use Veeam Agent for Linux to protect his/her
computer.
Backup Types
Veeam Agent for Linux lets you create the following backup types:
Volume-level backup
File-level backup
When you back up a specific computer volume, Veeam Agent for Linux captures only the data
that resides on this specific volume: files, folder, application data and so on.
If you choose to back up the system volume (volume to which the root file system is
mounted), Veeam Agent for Linux automatically includes the bootloader into the backup
scope.
You can exclude from the backup some directories of the directories that are included in the
backup. When you recover from such backup, you will be able to restore directories that you
have selected to back up, specific subdirectories of these directories and files in these
directories.
Note: You cannot change the backup job type from volume-level to file-level, and vice versa.
In Veeam Agent for Linux, you can configure several backup jobs with different settings. For example,
you can configure one backup job to create volume-level backup and another backup job to create
file-level backup. You can configure backup jobs targeted at different backup locations to keep several
copies of your backed-up data. You can also configure several backup jobs with individual schedule to
fine-tune automatic backup creation process.
Note: You can create more than one backup job only if Veeam Agent for Linux operates in the server mode.
To learn more about modes, see Product Functionality Modes.
Veeam Agent for Linux launches the backup job according to the schedule you define. You can
schedule the job to start at specific time daily or on specific week days. You can also start a backup job
manually to perform backup on demand when needed.
Backup job scheduling settings are configured globally for all user accounts of the Linux OS. For every
backup job, Veeam Agent for Linux creates a record in the crontab configuration file of the root
account. As a result, Veeam Agent for Linux can start a backup job automatically regardless of the
currently running user session.
You can define schedule for a job in Veeam Agent for Linux or edit the crontab file directly to fine-
tune the schedule. To learn more, refer to the Cron job scheduler documentation.
Backup Repository
A backup job configured in Veeam Agent for Linux creates backup files in a backup repository. A
backup repository is a directory on the storage where you want to keep backup files. You can use the
following types of disk-based storage to create a backup repository:
Local (internal) storage of the protected machine (not recommended).
Direct attached storage (DAS), such as USB, eSATA or Firewire external drives.
Network Attached Storage (NAS) able to represent itself as SMB (CIFS) or NFS share.
Veeam Backup & Replication 9.5 Update 1 or later backup repository.
Important! A backup repository must be created on a separate volume from a volume whose data you plan to
back up.
Veeam Agent for Linux works with backup storage differently depending on the way you configure
and start backup jobs — with the Veeam Agent for Linux control panel or command line interface.
After several backup cycles, you have a chain of backup files in the target location: the first full backup
file and subsequent incremental backup files. Every backup file contains a restore point for backed up
data. A restore point is a "snapshot" of your data at a specific point in time. You can use restore points
to roll back your data to the necessary state.
To recover data to a specific restore point, you need a chain of backup files: a full backup file plus a set
of incremental backup files following this full backup file. If some file from the backup chain is missing,
you will not be able to roll back to the necessary state. For this reason, it is recommended that you do
not delete separate backup files manually. To learn more, see Deleting Backups.
2. If an obsolete restore point exists, Veeam Agent for Linux transforms the backup chain. As
part of this process, it performs the following operations:
a. Veeam Agent for Linux re-builds the full backup file to include in it data of the
incremental backup file that follows the full backup file. To do this, Veeam
Agent for Linux injects into the full backup file data blocks from the earliest
incremental backup file in the chain. This way, a full backup ‘moves’ forward in
the backup chain.
b. The earliest incremental backup file is removed from the chain as redundant:
its data has already been injected into the full backup file, and the full backup
file includes data of this incremental backup file.
Volume-Level Restore
If data on a computer volume gets corrupted, you can restore this volume from the backup. For
volume-level restore, you can use backups that were created at the volume level. File-level backups
cannot be used for volume restore.
When you perform volume-level restore, Veeam Agent for Linux restores the entire content of the
volume. It retrieves from the backup data blocks pertaining to a specific volume and copies them to
the necessary location.
Note that you cannot browse the volume in the backup and select individual files and directories for
restore. For granular file-level restore, you can use the File-Level Restore option.
A volume can be restored to its original location or new location. If you restore the volume to its
original location, Veeam Agent for Linux overwrites data on the original volume. If you restore the
volume to a new location, and the target disk contains any data, Veeam Agent for Linux overwrites
data in the target location with data retrieved from the backup.
2. Veeam Agent for Linux mounts the loop device to the mount point directory in the
computer's file system.
For file-level restore with the Veeam Agent for Linux control panel or Veeam
Recovery Media, Veeam Agent for Linux mounts the backup content to the
/mnt/backup directory.
For file-level restore with the command line interface, you can specify a directory in
which Veeam Agent for Linux should mount the backup content.
After the backup content is mounted, you can use Linux command line utilities or preferred file
browser to work with restored files and directories. You can browse for files and directories in the
mounted backup and copy them to their initial location or to a new location.
Note: If you create a backup job with the Veeam Agent for Linux command line interface, you need to
specify a Veeam backup repository in the backup job settings. Veeam backup repository appears in
the list of backup repositories after you connect to a Veeam backup server. To learn more, see
Managing Veeam Backup & Replication Servers.
Veeam Agent for Linux works with the Veeam Backup & Replication backup repository as with any
other backup repository. Backup files are stored to a separate folder; you can perform standard restore
operations using these files.
Information about Veeam Agent for Linux backups stored on the Veeam Backup & Replication backup
repositories, backup jobs and sessions becomes available in the Veeam Backup & Replication console:
The Veeam Agent for Linux backup job is displayed in the list of jobs in Veeam Backup &
Replication.
Backup files created with Veeam Agent for Linux are displayed in the list of backups, under
the Agents node.
Performed job sessions are available in the History view of Veeam Backup & Replication.
System Requirements
The protected Linux-based endpoint must meet the following requirements:
Specification Requirement
Veeam Agent for Linux supports data backup and restore for the
following file systems*:
Ext 2/3/4
F2FS
FAT16
FAT32
HFS
HFS+
HFSP
JFS
File System
LVM2
NILFS2
NTFS
ReiserFS
XFS
The following file systems are not supported:
BTRFS
exFAT
Reiser4
UFS
Backup Target
Backup can be performed to the following disk-based storage:
Local (internal) storage of the protected computer (not recommended).
Direct attached storage (DAS), such as USB, eSATA or Firewire external drives.
Network Attached Storage (NAS) able to represent itself as SMB (CIFS) or NFS share. Requires
cifs-utils or nfs-utils packages to be installed on the Veeam Agent for Linux
computer, depending on a network storage type.
Veeam Backup & Replication 9.5 Update 1 or later backup repository (except DataDomain
DDboost, HPE StoreOnce, Exagrid, cloud and scale-out backup repositories).
Veeam
Shared 135, 137 Ports used as a transmission channel from the
Agent for TCP
folder SMB to 139, Veeam Agent for Linux computer to the target
Linux UDP
(CIFS) share 445 SMB (CIFS) share.
Computer
Veeam
Shared Standard NFS ports used as a transmission
Agent for TCP
folder NFS 111, 2049 channel from the Veeam Agent for Linux
Linux UDP
share computer to the target NFS share.
Computer
1025 to
5000
(for
Veeam Microsoft
Agent for Windows
Linux 2003) Dynamic RPC port range. For more information,
Computer Microsoft
TCP 49152- see
Windows
65535 http://support.microsoft.com/kb/929851/en-us.
server
performing (for
the role of a Microsoft
backup Windows
repository 2008 and
newer)
Important! The list of ports required for computers booted from the Veeam Recovery Media is the same as the
list of ports required for Veeam Agent for Linux computers.
For information about software packages that will be installed for Veeam Agent for Linux, see RPM
Packages and Debian Packages.
3. Make sure that you have allowed unsupported modules. To learn more, see
https://www.suse.com/documentation/sles-12/book_sle_admin/data/sec_admsupport
_kernel.html.
RPM Packages
During the installation process, the following packages are downloaded from the Veeam software
repository and installed in an RPM-based Linux distribution.
In a 32-bit Linux OS:
veeamsnap-<version>-1.noarch.rpm (for SUSE Linux Enterprise Server — veeamsnap-
<version>-1.sles.noarch.rpm)
where:
<username> — user name of the account to which you want to grant access to Veeam Agent for
Linux.
For example:
groups
For example:
user@srv01:~$ groups
user adm cdrom sudo dip plugdev lpadmin sambashare veeam
Note: Veeam Agent for Linux control panel is based on the ncurses programming library. To use the
Veeam Agent for Linux control panel, you must have the ncurses library installed in your Linux OS.
To launch the Veeam Agent for Linux control panel, you can use the following commands:
veeamconfig ui
or
veeam
When you launch the Veeam Agent for Linux control panel for the first time, Veeam Agent for Linux
displays a welcome screen with the short product description and a notification window offering to
install a license. You can install the license immediately or perform this operation later. To learn more,
see Veeam Agent for Linux Licensing.
Before you configure the first backup job, you can use the Veeam Agent for Linux control panel to
perform the following operations:
Configure a new backup job.
Restore files and folders from existing backup.
Manage license and product logs
After you configure one or several backup jobs, you can also use the control panel to start a backup
job and work with backup job sessions.
In the Veeam Agent for Linux control panel, the use of a mouse is not supported. To start an operation,
you need to use a specific key on your keyboard. For example, you can press the 'c' key to start the
backup job configuration, press the 's' key to start a backup job or press the 'r' key to start the file-level
restore process. Short help information on the currently available operations and keys is displayed at
the bottom of the control panel.
To navigate the control panel, backup job configuration and file-level restore wizards, you can use the
following keys:
Tab — to switch between controls and buttons in the Backup Job wizard.
Up and Down — to switch between items in a scrollable list.
Space — to select the necessary item in a list. The selected item's mark may vary in different
steps of the wizard.
Enter — to proceed to the next step of a wizard or to view details of the backup job session
selected in the list of sessions.
Backspace — to return to the previous step of a wizard (you cannot use this button to
change wizard steps when a text field is selected).
Esc — to exit the currently used wizard or close the Veeam Agent for Linux control panel.
where:
<command_1> — command that defines a type of an object with which you want to perform
a task. Currently, the following commands are available in Veeam Agent for Linux:
backup
config
help
job
license
point
repository
schedule
session
ui
vbrserver
<command_2> — command that defines a task that you want to perform with an object of the
specified type. For example, you can perform the following commands with backup
repositories:
create
delete
edit
help
list
rescan
<parameter_1>, <parameter_2>, <parameter_n> — parameters for the command that
you want to execute. Commands may require one or several mandatory or optional
parameters. Some commands, for example, veeamconfig ui and veeamconfig
[<command>] help do not require parameters.
Viewing Help
You can view short help information on the specific Veeam Agent for Linux command. To view help,
use the following command:
where:
<command> — name of the command for which you want to view help information.
For example:
or
or
You can also view the manual page for the veeamconfig utility. Use the following command:
man veeamconfig
Tip: To check in which mode Veeam Agent for Linux currently operates, you can use the Veeam Agent for
Linux command line interface. To learn more, see Viewing License Information.
When you install a license on the protected computer, you can select in which mode Veeam Agent for
Linux should operate: server mode or workstation mode (if both modes are supported by the license).
If you use Veeam Agent for Linux with Veeam Backup & Replication, you can manage product licenses
and functionality modes from the Veeam Backup & Replication console. To learn more, see Managing
License with Veeam Backup & Replication.
After the license expires, Veeam Agent for Linux automatically switches to the free mode. To learn
more, see License Expiration.
Note: If you choose not to install a license and use Veeam Agent for Linux in the free functionality mode,
the notification window offering to install a license will appear every time you open the control
panel until Veeam Agent for Linux completes the first backup job session.
To install a license:
1. Launch the Veeam Agent for Linux control panel with the veeam or veeamconfig ui
command.
2. In the Veeam Agent for Linux control panel, press the 'm' key to open the Miscellaneous
menu.
3. In the menu, make sure that the License option is selected and press Enter.
4. In the Choose license window, in the File location section, specify a path to the license key:
a. Select the Browse option with the Tab key and press Space or Enter.
b. In the Choose license file location window, select the necessary directory and
press Enter.
c. Repeat the step 'a' until a path to the directory in which the license key resides
appears in the Current directory field.
d. In the directory where the license key resides, select the license key and press
Enter.
Tip: If you chose to install the license immediately from the Veeam Backup & Replication welcome screen
notification, you will pass to this step right from the notification window.
5. In the License mode section, select the product functionality mode in which Veeam Agent
for Linux will operate and press Enter. To learn more about modes, see Product Functionality
Modes.
6. Veeam Agent for Linux will install the license and display a window notifying that the license
is successfully installed. Press Enter to finish the license installation process.
Tip: You can view information about the installed license (expiration date, status of the license, current
functionality mode of the product and so on) using the Veeam Agent for Linux command line
interface. To learn more, see Viewing License.
Installing License
To install a license, use the following command:
or
where:
<path> — path to the license key file in the local file system of your computer.
workstation or server — functionality mode in which Veeam Agent for Linux will operate.
To learn more about modes, see Product Functionality Modes.
Veeam Agent for Linux will install the license and display information about the license. You can also
view this information later at any time. To learn more, see Viewing License Information.
For example:
Tip: You can also install a license using the Veeam Agent for Linux control panel. To learn more, see
Installing License.
Veeam Agent for Linux will display information about the license. For example:
Removing License
You can remove a license with the following command:
After you remove the license, Veeam Agent for Linux will continue to operate in the free functionality
mode. Mind the following:
If Veeam Agent for Linux operated in the server mode and multiple backup jobs were
configured, after switching to the free mode, all backup jobs will be failing.
If pre-freeze and/or post-thaw scripts were specified for a backup job, after switching to the
free mode, this backup job will be failing.
Note: The Configure new job option is not available if Veeam Agent for Linux operates in the free or
workstation mode and you have already configured one backup job.
To edit settings of a backup job that you have already configured, select the job in the list and press
Enter. To learn more, see Editing Backup Job Settings.
If you have decided not to create a backup job, press Escape to close the list of backup jobs and return
to the welcome screen. After that, you can press Escape once again to return to the command line
interface.
Tip: To proceed to the next step of the wizard, you can also select the Next button with the Tab key and
then press Enter.
Tip: File-level backup is typically slower than volume-level backup. If you plan to back up all folders with
files on a specific volume, it is recommended that you configure volume-level backup instead of file-
level backup.
4. Switch to the OK button and press Enter. Veeam Agent for Linux will display paths to the
selected directories and the number of excluded subdirectories for each directory.
5. Specify file name masks for files that you want to include or exclude in/from the backup:
a. Select the File Masks option with the Tab key and press Enter.
b. In the File masks window, make sure that the Create Mask button is selected and
press Enter.
c. In the Mask field, enter the file name mask, for example, report.pdf, *filename*
or *.odt.
d. In the Type field, select one of the following options:
Exclude — if you do not want to back up files whose names match the
specified mask. Veeam Agent for Linux will back up all files in the
directories selected for backup except for such files.
Include — if you want to back up files whose names match the specified
mask. Veeam Agent for Linux will create a backup only for such files in
the directories selected for backup.
Tip: To remove a file name mask, in the File masks window, select the necessary mask and press Delete.
Important! If you specify a DNS name of the Veeam backup server, make sure that the Veeam backup server
name is resolved into IPv4 address on the machine where Veeam Agent for Linux is installed. The
Veeam Backup Service in Veeam Backup & Replication listens on IPv4 addresses only. If the Veeam
backup server name is resolved into IPv6 address, Veeam Agent for Linux will fail to connect to the
Veeam backup server.
Important! You cannot use the following types of backup repositories as a target for the Veeam Agent for Linux
backup job:
Scale-out backup repositories
Cloud repositories
Deduplicating storage appliances: EMC Data Domain, ExaGrid and HPE StoreOnce
Important! You can specify snapshot script settings only if Veeam Agent for Linux operates in the server mode.
To learn more about modes, see Product Functionality Modes.
You can specify a path to the executable file of the job or snapshot script in one of the following ways:
Type a path to the executable file.
Browse to the executable file:
a. Select the Browse option with the Tab key and press Enter.
b. In the Choose script location window, select the directory being a part of the path
to the script and press Enter.
c. Repeat the step 'b' until a path to the directory in which the executable file resides
appears in the Current directory field.
d. Select the necessary executable file and press Enter.
Alternatively, you can switch to the Ok button and press Enter.
Tip: If you do not want to execute a script, you can leave the corresponding field blank and proceed to
the next step of the wizard.
where:
<job_name> — name for the created backup job.
For simple volumes — name of a block device that represents a volume or an entire
disk that should be included in backup. You can specify entire disk(s) to create
backup of the entire computer image or individual computer volumes to create
backup of specific volumes. If you want to back-up several disks or volumes, specify
them one after another using a ',' (comma) character as a separator.
For LVM volumes — name of an LVM logical volume or an LVM volume group that
should be included in backup. You can specify LVM volume group(s) to create
backup of the entire computer image or individual LVM logical volumes to create
backup of specific volumes. If you want to back-up several LVM logical volumes or
volume groups, specify them one after another using a ',' (comma) character as a
separator.
<advanced_options> — advanced options for the backup job. To learn more, see Advanced
Backup Job Settings.
You can also specify the schedule for the backup job. To learn more, see Configuring Backup
Schedule.
For example:
Tip: To create a volume-level backup of the entire computer image, you can use the --
backupallsystem option instead of the --objects option. For example: veeamconfig job
create --name SystemBackup --reponame Repository_01 --backupallsystem.
The number of restore points that you want to store in the backup location. By
default, Veeam Agent for Linux keeps 14 latest restore points. When the new restore
--maxpoints
point that exceeds the specified number is created, Veeam Agent for Linux will
remove the earliest restore point from the backup chain.
Path to the pre-freeze script that should be executed before the snapshot creation.
--prefreeze This option is available only if Veeam Agent for Linux operates in the server mode.
To learn about modes, see Product Functionality Modes.
Path to the post-thaw script that should be executed after the snapshot creation.
--postthaw This option is available only if Veeam Agent for Linux operates in the server mode.
To learn about modes, see Product Functionality Modes.
--prejob Path to the script that should be executed at the start of the backup job.
--postjob Path to the script that should be executed after the backup job completes.
where:
<job_name> — name for the created backup job.
Full path to a directory that should be included in backup, for example: /home/user.
--includedirs You can specify one or several paths to directories in the computer file system. To
separate several paths, use a ',' (comma) character, for example:
/home/user/Documents,/home/user/reports.
Full path to a directory that should be excluded from backup. The directory specified
with this option must be a subdirectory of the directory specified with the --
--excludedirs
includedirs option. To separate several paths, use a ',' (comma) character, for
example, /home/user/Documents,/home/user/reports.
Mask for file name or path that should be included in backup. You can use the
following UNIX wildcard characters for file name masks:
'*' — a substitution for one or more characters in the file name or path. Can
be used for any sequence of characters (including no characters). For
example, *.pdf.
'?' — a substitution of one character in the file name or path. For example,
repor?.pdf.
'[]' — a substitution of one character in the file name or path with any of
the characters enclosed in square brackets (or a range of characters defined
with the '-' character). For example: report_201[3456].pdf or
--includemasks
report_201[3-6].pdf.
If you want to use several file name masks, you must specify them in double quotation
marks ("") and separated with a comma (,). For example: --includemasks
"*.bak,*.pdf".
File inclusion option is applied to all directories that are specified with the --
includedirs option. For example, if you include in backup the
/home/user/Documents directory and files that match the repor?.pdf file name
mask, Veeam Agent for Linux will back up the
/home/user/Documents/report.pdf file and will not back up the
/home/user/reports/report.pdf file.
Mask for file name or path that should be excluded from backup. You can use the
following UNIX wildcard characters for file name masks:
'*' — a substitution for one or more characters in the file name or path. Can
be used for any sequence of characters (including no characters). For
example, *.pdf.
'?' — a substitution of one character in the file name or path. For example,
repor?.pdf.
'[]' — a substitution of one character in the file name or path with any of
the characters enclosed in square brackets (or a range of characters defined
with the '-' character). For example: report_201[3456].pdf or
report_201[3-6].pdf.
If you want to use several file name masks, you must specify them in double quotation
--excludemasks marks ("") and separated with a comma (,). For example: --includemasks
"*.bak,*.pdf".
File exclusion option is applied to all directories that are specified with the --
includedirs option and files that match file name masks specified with the --
includemasks option. For example, you may want to specify the following backup
scope for the backup job:
Include in backup the /home/user/Documents directory
Include files that match the report.* file name mask
Exclude files that match the *.odt file name mask.
In this case, Veeam Agent for Linux will back up the
/home/user/Documents/report.pdf file and will not back up
/home/user/Documents/report.odt and
/home/user/reports/report.pdf files.
The number of restore points that you want to store in the backup location. By
default, Veeam Agent for Linux keeps 14 latest restore points. When the new restore
--maxpoints
point that exceeds the specified number is created, Veeam Agent for Linux will
remove the earliest restore point from the backup chain.
Path to the pre-freeze script that should be executed before the snapshot creation.
--prefreeze This option is available only if Veeam Agent for Linux operates in the server mode.
To learn about modes, see Product Functionality Modes.
Path to the post-thaw script that should be executed after the snapshot creation.
--postthaw This option is available only if Veeam Agent for Linux operates in the server mode.
To learn about modes, see Product Functionality Modes.
--prejob Path to the script that should be executed at the start of the backup job.
--postjob Path to the script that should be executed after the backup job completes.
or
where:
<job_id> — ID of the backup job for which you want to configure the schedule. You should
look up the job ID in advance, before configuring the schedule, for example, with the the
veeamconfig job list command. To learn more, see Viewing List of Backup Jobs.
Tip: To view IDs of all existent backup jobs, you can press the Tab key right after you type the --jobid
option.
<days> — days when the backup job must start separated by a comma (','). For example:
Monday,Tuesday,Wednesday,Thursday,Friday.
<time> — time of day when the backup job must start specified in the HH:MM format. For
example: 20:00.
For example:
where:
<job_id> — ID of the backup job for which you want to enable the schedule. You should look up the
job ID in advance, for example, with the veeamconfig job list command. To learn more, see
Viewing List of Backup Jobs.
For example:
You can disable the schedule for the job at any time. To learn more, see Disabling Backup Schedule.
where:
<job_id> — ID of the backup job for which you want to view the schedule.
Veeam Agent for Linux displays the following information about the backup job schedule:
Parameter Description
where:
<job_id> — ID of the backup job for which you want to disable the schedule.
For example:
Note: Veeam Agent for Linux can currently perform only one backup job at a time. You cannot start a
backup job when another backup job is already running.
or
where:
<job_name> — name of the backup job that you want to start.
For example:
You can check the backup job session status or view the backup job session log using the Veeam
Agent for Linux command line interface.
You can also monitor the backup job performance in the Veeam Agent for Linux control panel. To
learn more, see Viewing Real-Time Job Session Statistics.
In the list of backup jobs, Veeam Agent for Linux displays the following information:
Parameter Description
Repository Name of the backup repository that is specified as a backup storage for the backup job.
For example:
or
where:
<job_name> — name of the backup job that you want to delete.
Parameter Description
Repository ID ID of the backup repository that is specified as a backup storage for the backup job.
Repository
Name of the backup repository that is specified as a backup storage for the backup job.
name
Objects for
Backup scope specified for the backup job.
backup
For example:
or
or
where:
<option> — option used to change parameter that you want to edit for the job. You can
specify one or several options at a time. To learn more about available options, see Backup
Job Options.
<job_name> — name of the backup job that you want to edit.
For example:
The number of restore points that you want to store in the backup location. By
default, Veeam Agent for Linux keeps 14 latest restore points. When the new restore
--maxpoints
point that exceeds the specified number is created, Veeam Agent for Linux will
remove the earliest restore point from the backup chain.
--prefreeze Pre-freeze command that should be executed before the snapshot creation.
--postthaw Post-thaw command that should be executed after the snapshot creation.
Full path to a directory that should be excluded from backup. The option is
available for file-level backup jobs only.
--excludedirs The directory specified with this option must be a subdirectory of the directory
specified with the --includedirs option. To separate several paths, use a ','
(comma) character, for example,
/home/user/Documents,/home/user/reports.
Mask for file name or path that should be included in backup. The option is
available for file-level backup jobs only.
You can use the following UNIX wildcard characters for file name masks:
'*' — a substitution for one or more characters in the file name or path.
Can be used for any sequence of characters (including no characters). For
example, *.pdf.
'?' — a substitution of one character in the file name or path. For
example, repor?.pdf.
'[]' — a substitution of one character in the file name or path with any
--includemasks of the characters enclosed in square brackets (or a range of characters
defined with the '-' character). For example:
report_201[3456].pdf or report_201[3-6].pdf.
To separate several masks, use a ',' (comma) character, for example,
report.*,reports.*.
File inclusion option is applied to all directories that are specified with the --
includedirs option. For example, if you include in backup the
/home/user/Documents directory and files that match the repor?.pdf file
name mask, Veeam Agent for Linux will back up the
/home/user/Documents/report.pdf file and will not back up the
/home/user/reports/report.pdf file.
Mask for file name or path that should be excluded from backup. The option is
available for file-level backup jobs only.
You can use the following UNIX wildcard characters for file name masks:
'*' — a substitution for one or more characters in the file name or path.
Can be used for any sequence of characters (including no characters). For
example, *.pdf.
'?' — a substitution of one character in the file name or path. For
example, repor?.pdf.
'[]' — a substitution of one character in the file name or path with any
of the characters enclosed in square brackets (or a range of characters
defined with the '-' character). For example:
report_201[3456].pdf or report_201[3-6].pdf.
--excludemasks To separate several masks, use a ',' (comma) character, for example,
report.*,reports.*.
File exclusion option is applied to all directories that are specified with the --
includedirs option and files that match file name masks specified with the --
includemasks option. For example, you may want to specify the following
backup scope for the backup job:
Include in backup the /home/user/Documents directory
Include files that match the report.* file name mask
Exclude files that match the *.odt file name mask.
In this case, Veeam Agent for Linux will back up the
/home/user/Documents/report.pdf file and will not back up
/home/user/Documents/report.odt and
/home/user/reports/report.pdf files.
Tip: Full backup takes much more time than incremental backup. If you change the target location, you
can copy an existing backup chain to the new location manually. In this case, the new backup job
session will produce an incremental backup file and add it to the backup chain.
or
where:
<job_name> — name of the backup job that you want to delete.
For example:
Important! A backup repository must be created on a separate volume from a volume whose data you plan to
back up.
where:
<repository_name> — desired name for the backup repository.
<path> — path to the directory in the local file system of your computer in which backup
files should be stored.
For example:
Note: To create a backup repository in a network shared folder, you must mount the network shared folder
to a directory in your computer's file system in advance. After you mount the network shared folder,
you can create the backup repository in the same way as in local directory.
Parameter Description
Location Directory in the local file system specified as a target location for backup files.
Type Type of the backup repository. Currently, only the local type is supported.
Backup server on which Veeam backup repository added to Veeam Agent for
Backup server
Linux is configured.
For example:
Note: If you change location for the backup repository that is already used by a backup job and contains
backup files, during the next backup job run, Veeam Agent for Linux will create a new backup chain
in the new repository location.
Tip: You can temporarily change backup repository location if you want to create an ad hoc full backup in
addition to the backup chain created by the backup job in the original repository location.
or
where:
<old_name> — current name of the backup repository.
For example:
or
where:
<path> — desired path for the backup repository.
For example:
or
where:
<repository_id> — ID of the backup repository that you want to rescan.
For example:
or
where:
<repository_id> — ID of the backup repository that you want to delete.
For example:
Note: You cannot delete a backup repository that is specified as a backup storage location in the backup
job settings.
Note: Currently, Veeam Agent for Linux can be connected to one Veeam Backup & Replication server only.
If you want to create backups on the backup repository managed by another Veeam backup server,
you need to delete currently used backup server and all jobs targeted at backup repositories
managed by this backup server. To learn more, see Deleting Connection to Veeam Backup Server.
To connect Veeam Agent for Linux to a Veeam backup server, use the following command:
where:
<vbr_name> — name of the Veeam backup server that manages the backup repository.
<vbr_ip_port> — IP address of the Veeam backup server and port over which Veeam Agent
for Linux must communicate with Veeam Backup & Replication specified in the IP:PORT
format. The default port used for communication with the Veeam backup server is 10002.
<username> — a user name of the account that has access to the Veeam backup repository.
<domain> — a name of the domain in which the account that has access to the Veeam
backup repository is registered.
<password> — password of the account that has access to the Veeam backup repository.
Permissions on the backup repository managed by the target Veeam backup server must be
granted beforehand. To learn more, see Setting Up User Permissions on Backup Repositories.
For example:
When Veeam Agent for Linux connects to a Veeam Backup & Replication server, Veeam Agent for
Linux retrieves information about backup repositories managed by this Veeam backup server and
displays them in the list of available backup repositories. You can then specify a Veeam backup
repository as a target for a backup job.
Tip: To view the list of backup repositories, use the veeamconfig repository list command. To
learn more, see Viewing List of Backup Repositories.
Veeam Agent for Linux will display a list of Veeam backup servers.
Important! Currently, Veeam Agent for Linux can be connected to one Veeam Backup & Replication server only.
If you add a connection to another backup server, backup jobs targeted at the original backup server
will fail and backups created on the Veeam backup repository will become unavailable in Veeam
Agent for Linux. To continue using the original backup server, you need to delete the connection to
the new backup server and recreate all backup jobs that use the original backup server.
For the Veeam backup server in the list, Veeam Agent for Linux displays the following information:
Parameter Description
ID ID of the Veeam backup server in the Veeam Agent for Linux database.
IP address of the Veeam backup server and port over which Veeam Agent for Linux
Endpoint
communicates with Veeam Backup & Replication.
For example:
or
where:
<vbr_name> — name of the Veeam backup server.
<vbr_id> — ID of the Veeam backup server in the Veeam Agent for Linux database.
Parameter Description
ID ID of the Veeam backup server in the Veeam Agent for Linux database.
IP address of the Veeam backup server and port over which Veeam Agent for
Endpoint
Linux communicates with Veeam Backup & Replication.
Login User name of the account that has access to the Veeam backup repository.
Name of the domain in which the account that has access to the Veeam backup
Domain
repository is registered.
For example:
or
where:
<old_vbr_name> — current name of the backup server.
For example:
or
where:
<vbr_ip_port> — IP address of the Veeam backup server and port over which Veeam Agent
for Linux must communicate with Veeam Backup & Replication specified in the IP:PORT
format. The default port used for communication with the Veeam backup server is 10002.
<vbr_name> — name of the backup server.
For example:
or
where:
<vbr_name> — name of the Veeam backup server.
For example:
If a Veeam backup repository was removed from the backup infrastructure and Veeam Agent for Linux
did not reflect this change in the database for some reason, the veeamconfig vbrserver resync
command may fail. In this case, you can use the --force option to refresh information about
available Veeam backup repositories. For example:
With the --force option, the veeamconfig vbrserver resync command will update the list of
backup repositories currently managed by the Veeam backup server.
Tip: To view updated list of available Veeam backup repositories after resync, use the veeamconfig
repository list command. To learn more, see Viewing List of Backup Repositories.
or
where:
<vbr_name> — name of the Veeam backup server.
For example:
Viewing Backups
To view a list of backups created by a backup job configured in Veeam Agent for Linux, use the
following command:
In the list of backups, Veeam Agent for Linux displays the following information:
Parameter Description
Job name Name of the backup job by which the backup was created.
For example:
where:
<backup_id> — ID of the backup for which you want to view detailed information.
For a volume-level backup, Veeam Agent for Linux displays the following information:
Parameter Description
Host name of the machine on which the backup job is configured and the name of the
Machine name
job.
Device Path to the block device file that represents the volume.
For example:
For a file-level backup, Veeam Agent for Linux displays the following information:
Parameter Description
Host name of the machine on which the backup job is configured and the name of the
Machine name
job.
For example:
or
where:
<backup_id> — ID of the backup for which you want to view information on restore points.
For example:
or
Veeam Agent for Linux displays the following information about restore points in the backup:
Parameter Description
Job name Name of the backup job by which the backup was created.
where:
<path> — path to the VBM or VBK file of the backup that you want to import.
For example:
2. You can monitor the import process and result by viewing the import session log with the
following command:
where:
<session_id> — ID of the import session.
For example:
For example:
Deleting Backups
Backup files created with Veeam Agent for Linux are removed automatically according to the
retention policy settings. You can also remove backups from the target location and/or Veeam Agent
for Linux configuration database manually if necessary.
where:
<backup_id> — ID of the backup that you want to delete.
Veeam Agent for Linux will remove records about the deleted backup from the Veeam Agent for Linux
database. Backup files themselves (VBK, VIB, VBM) remain in the backup repository. You can import
the removed backup later to Veeam Agent for Linux and perform restore operations with the
imported backup.
where:
<backup_id> — ID of the backup that you want to delete.
Veeam Agent for Linux will remove records about the deleted backup from the Veeam Agent for Linux
database and, additionally, delete backup files themselves from the destination storage.
Restoring Volumes
You can restore a specific computer volume or all volumes from the volume-level backup.
Volumes can be restored to their original location or to a new location.
If you restore a volume to its original location, Veeam Agent for Linux will overwrite the data
on the original volume with the data restored from the backup.
If you restore volume data to a new location, Veeam Agent for Linux will restore data from the
backup and write it to the selected destination. If necessary, you can specify new disk
mapping settings for the restored volume.
Tip: To stop working with the Veeam Recovery Media and shut down or restart your computer, in the
Veeam Recovery Media main menu, select the Reboot or Shutdown option and press Enter.
You can manually configure TPC/IP v4 settings for the network adapter. To configure network settings:
1. In the Choose adapter list, select the network adapter that you want to use to connect to the
network shared folder or Veeam backup repository where the backup resides and press
Enter.
2. In the Configure adapter dialog, select the Manual option and press Enter.
3. In the Adapter settings dialog, specify the following network settings:
IP address
• Subnet mask
• Default gateway
• DNS server
4. Select the Apply button and press Enter.
Tip: You can mount several network shared folders to work with backup files that are stored in different
locations if needed. To do this, return to the Select Backup Location step of the wizard and select the
Add shared folder option once again. For every mounted location, Veeam Agent for Linux displays
its name, type and mount point. You can view the list of mounted network shared folders and
browse for a backup file located on the necessary storage.
Tip: You can mount several devices to work with backup files that are stored in different locations if
needed. To do this, return to the Select Backup Location step of the wizard and select the Mount
local disk option once again. For every mounted location, Veeam Agent for Linux displays its name,
type and mount point. You can view the list of mounted devices and browse for a backup file located
on the necessary storage.
Important! It is strongly recommended that you change disk mapping settings only if you have experience in
working with Linux disks and partitions. If you make a mistake, your computer data may get
corrupted.
You can map volumes in the backup (source volumes) and volumes on your computer (target
volumes) in one of the following ways:
Map a source volume to a target volume
Map a target volume to a source volume
As well as individual volumes, you can also map entire disks:
Map a source disk to a target disk
Map a target disk to a source disk
If you choose to restore an entire disk, Veeam Agent for Linux will try to map all volumes that reside
on this disk.
The In backup pane of the Veeam Recovery Media wizard contains a list of disks and volumes in the
backup. You can select volumes in the backup that you want to restore to your computer and specify
mapping rules for these volumes.
To map a source volume to a target volume:
1. In the In backup pane, select a volume in the backup whose data you want to recover and
press Enter.
2. Veeam Agent for Linux will display a window with information on the selected volume
(partition type, file system type, mount point and volume size) and a list of available
operations:
Restore volume to — select this option if you want to restore the selected volume
to your computer.
Close — select this option if you want to close the window and select another
volume.
4. Veeam Agent for Linux will display a list of volumes on your computer. Select the volume that
you want to restore and press Enter.
6. Repeat steps 1–5 for all volumes that you want to restore.
7. Press 's' to start the restore process.
The Current system pane of the Veeam Recovery Media wizard displays a partition table of your
computer booted from the Veeam Recovery Media. In this pane, you can select volumes on your
computer which you want to restore and specify mapping rules for these volumes. If necessary, you
can edit the disk layout before restoring volumes.
To map a target volume to a source volume:
1. In the Current system pane, select a volume on your computer whose data you want to
recover and press Enter.
2. Veeam Agent for Linux will display a window with information on the selected volume
(partition type, file system type, mount point and volume size) and a list of available
operations:
Restore volume from — select this option if you want to recover the selected
volume from the backup.
Delete partition [for simple volumes] or Delete volume [for LVM volumes] —
select this option if you want to change the disk layout before restoring a volume.
After you delete a partition or volume, you will be able to create a new partition or
volume of the desired size and map a volume in the backup to the volume on your
computer.
[For simple volumes] Create LVM physical volume — select this option if you
want to create an LVM physical volume on the selected disk partition. In the
created physical volume, you will be able to create a volume group and restore to
this volume group LVM logical volumes from the backup.
Close — select this option if you want to close the window and select another
volume.
4. Veeam Agent for Linux will display a window with a list of volumes in the backup. Select the
volume that you want to restore and press Enter.
6. Repeat steps 1–5 for all volumes that you want to restore.
7. Press 's' to start the restore process.
4. Veeam Agent for Linux will display a list of disks and volumes on your computer. Select the
disk whose volumes you want to restore and press Enter.
6. Repeat steps 1–5 for all computer disks whose volumes you want to restore.
7. Press 's' to start the restore process.
5. In the Current system pane, in the Restore column, Veeam Agent for Linux will display
which volumes from the disk in the backup will be restored to the target disk.
6. Repeat steps 1–5 for all disks whose volumes you want to restore.
7. Press 's' to start the restore process.
2. Press Enter to start the volume-level restore process. Veeam Agent for Linux will perform
partition re-allocation operations if necessary, restore the necessary data from the backup
and overwrite data on your computer with it.
Tip: To stop working with the Veeam Recovery Media and shut down or restart your computer, in the
Veeam Recovery Media main menu, select the Reboot or Shutdown option and press Enter.
You can manually configure TPC/IP v4 settings for the network adapter. To configure network settings:
1. In the Choose adapter list, select the network adapter that you want to use to connect to the
network shared folder where the backup resides and press Enter.
2. In the Configure adapter dialog, select the Manual option and press Enter.
3. In the Adapter settings dialog, specify the following network settings:
IP address
• Subnet mask
• Default gateway
• DNS server
4. Select the Apply button and press Enter.
Tip: You can mount several network shared folders to work with backup files that are stored in different
locations if needed. To do this, return to the Select Backup Location step of the wizard and select the
Add shared folder option once again. For every mounted location, Veeam Agent for Linux displays
its name, type and mount point. You can view the list of mounted network shared folders and
browse for a backup file located on the necessary storage.
Tip: You can mount several devices to work with backup files that are stored in different locations if
needed. To do this, return to the Select Backup Location step of the wizard and select the Mount
local disk option once again. For every mounted location, Veeam Agent for Linux displays its name,
type and mount point. You can view the list of mounted devices and browse for a backup file located
on the necessary storage.
3. Veeam Agent for Linux will mount the content of the backup file to the /mnt/backup
directory in the recovery image OS file system and display a notification window with the
corresponding message. Press Enter to proceed to the File Level Restore wizard menu, open
the file manager and save restored files.
When you perform file-level restore with the File Level Restore wizard, Veeam Agent for Linux
always mounts the backup to the /mnt/backup directory. If you want to specify another
directory for backup mount, you can perform file-level restore with the Veeam Agent for
Linux command line interface. To learn more, see Restoring Files and Folders with Command
Line Interface.
Tip: To stop working with the Veeam Recovery Media and shut down or restart your computer, in the File
Level Restore wizard menu, select the Reboot or Shutdown option and press Enter.
To work with restored files and folders, you can use Midnight Commander — a file manager that is
included into the Veeam Recovery Media. With the Midnight Commander file manager, you can
browse the mounted backup content and file system on your computer, and save restored files and
folders to the original location or to a new location.
To launch the file manager, in the File Level Restore wizard menu, select Start file commander and
press Enter.
When you launch Midnight Commander, Veeam Agent for Linux displays in the file manager the
directory with the backup content and your computer's file system:
In the left pane, Veeam Agent for Linux displays a directory of your computer's file system
mounted under the /mnt/system directory of the recovery image OS file system. By default,
Veeam Agent for Linux mounts to the recovery image OS file system the following volumes of
your computer:
o If you use a volume-level backup for file-level restore, Veeam Agent for Linux
detects the partition table in the backup, mounts to the /mnt/system directory
block devices that represent volumes of your computer with the same names as
volumes in the backup. For example, if your volume-level backup contains
/dev/sda1 and /dev/sda6 volumes with / and /home mount points, Veeam
Agent for Linux will mount to the /mnt/system directory both root (/) and /home
partitions.
o If you use a file-level backup for file-level restore, Veeam Agent for Linux mounts to
the /mnt/system directory only the system volume of your computer, for example,
/dev/sda1. If you want to save restored files and folders to a directory on another
computer volume or to a network shared folder, you need to mount this volume or
folder manually. To mount a target storage for restored files:
a. In Midnight Commander, press F10 to close the file manager.
b. In the File Level Restore wizard menu, select the Switch to command
line option and press Enter.
c. Mount the target storage for the restored files and folders with the mount
command.
To save restored files or folders to their initial location on your computer, do the following:
1. In the left pane of the file manager window, open the directory in your computer's file system
in which the backed-up file or folder that you want to restore originally resided.
2. In the right pane of the file manager window, open the directory that contains the file or
folder in the backup that you want to restore to its original location.
3. Select the file or folder that you want to restore and press F5.
4. In the Copy dialog window, review the file or folder copy settings, select Ok and press Enter.
6. After you finish working with files and folders, press F10 to close the file manager.
To save restored files or folders to a new location on your computer or to a network shared folder, do
the following:
1. In the left pane of the file manager window, open the directory in your computer's file system
in which you want to restore a file or folder.
2. In the right pane of the file manager window, open the directory that contains the file or
folder in the backup that you want to restore.
3. Select the file or folder that you want to restore and press F5.
4. In the Copy dialog window, review the file or folder copy settings, select Ok and press Enter.
5. Midnight Commander will save the file or folder to the specified location.
When Veeam Agent for Linux mounts a backup for file-level restore, Veeam Agent for Linux starts a
new backup mount session. To unmount a backup, you need to stop the backup mount session. This
may be required, for example, if you want to stop working with files and folders in one backup and
mount another backup for file-level restore.
To stop the backup mount session with the Veeam Recovery Media, in the File Level Restore wizard
menu, select the Stop backup mount option and press Enter. Veeam Agent for Linux will stop the
backup mount session, unmount the backup from the /mnt/backup directory of the recovery image
OS file system, exit the File Level Restore wizard and display the Veeam Recovery Media main menu.
In the list of backups, Veeam Agent for Linux displays information about all backups stored in all
backup repositories. If Veeam Agent for Linux is connected to a Veeam backup server, backups that
are kept on a Veeam backup repository also appear in this list. For each backup, Veeam Agent for
Linux displays the following information:
Parameter Description
Job name Name of the backup job by which the backup was created.
Repository Name of the backup repository in which the backup was created.
For example:
Tip: If you want to recover data from a backup that is stored in another location, for example, a backup
created with another instance of Veeam Agent for Linux you can import such backup into the Veeam
Agent for Linux database on your computer. To learn more, see Importing Backups.
where:
<backup_id> — ID of the backup for which you want to view detailed information.
Parameter Description
Host name of the machine on which the backup job is configured and the name of the
Machine name
job.
For example:
where:
<backup_id> — ID of the backup.
<target_volume> — path to a block device that represents a volume on your computer that
you want to recover.
<volume_in_backup> — path to a block device that represents a volume in the backup.
This parameter is optional. If you do not specify this parameter, Veeam Agent for Linux will
restore from the backup a volume that has the same name as a <target_volume>.
For example:
where:
<session_id> — ID of the restore session.
For example:
Tip: You can also check the restore session status with the veeamconfig session info command. To
learn more, see Viewing Session Status.
In the list of backups, Veeam Agent for Linux displays information about all backups stored in all
backup repositories. If Veeam Agent for Linux is connected to a Veeam backup server, backups that
are kept on a Veeam backup repository also appear in this list. For each backup, Veeam Agent for
Linux displays the following information:
Parameter Description
Job name Name of the backup job by which the backup was created.
Repository Name of the backup repository in which the backup was created.
For example:
Tip: If you want to recover data from a backup that is stored in another location, for example, a backup
created with another instance of Veeam Agent for Linux you can import such backup into the Veeam
Agent for Linux database on your computer. To learn more, see Importing Backups.
or
where
<backup_id> — ID of the backup for which you want to view information on restore points.
Parameter Description
Job name Name of the backup job by which the backup was created.
or
where:
<point_id> — ID of the restore point.
<target_volume> — path to a block device that represents a volume on your computer that
you want to recover.
<volume_in_backup> — path to a block device that represents a volume in the backup.
This parameter is optional. If you do not specify this parameter, Veeam Agent for Linux will
restore from the backup a volume that has the same name as a <target_volume>.
Important! You can restore a backed-up volume only to a target volume that is not used by your Linux OS (that
does not have file system mount points). For example, you can add a new disk to your computer and
restore a volume in the backup to this disk. To restore a volume to its original location or to another
volume used by Linux OS, you should boot from the Veeam Recovery Media and perform volume-
level restore with the Volume Restore wizard.
where:
<session_id> — ID of the restore session.
For example:
Tip: You can also check the restore session status with the veeamconfig session info command. To
learn more, see Viewing Session Status.
Tip: When you finish working with restored files and folders, you can unmount the backup from the
/mnt/backup folder.
user@srv01:~$ ls Documents/
Reports
user@srv01:~$ ls
/mnt/backup/FileLevelBackup_0/home/user/Documents/Reports/
Report1.pdf Report2.pdf
user@srv01:~$ cp
/mnt/backup/FileLevelBackup_0/home/user/Documents/Reports/Report1.pdf
Documents/
user@srv01:~$ ls Documents/
Report1.pdf Reports
In the list of backups, Veeam Agent for Linux displays information about all backups stored in all
backup repositories. If Veeam Agent for Linux is connected to a Veeam backup server, backups that
are kept on a Veeam backup repository also appear in this list. For each backup, Veeam Agent for
Linux displays the following information:
Parameter Description
Job name Name of the backup job by which the backup was created.
Repository Name of the backup repository in which the backup was created.
For example:
Tip: If you want to recover data from a backup that is stored in another location, for example, a backup
created with another instance of Veeam Agent for Linux you can import such backup into the Veeam
Agent for Linux database on your computer. To learn more, see Importing Backups.
where:
<backup_id> — ID of the backup for which you want to view detailed information.
Parameter Description
Host name of the machine on which the backup job is configured and the name of the
Machine name
job.
For a file-level backup, Veeam Agent for Linux displays the following information:
Parameter Description
Host name of the machine on which the backup job is configured and the name of the
Machine name
job.
For example:
where:
<backup_id> — ID of the backup that you want to mount to the computer file system for
file-level restore.
<path> — path to the directory to which you want to mount the backup file content.
For example:
where:
<session_id> — ID of the backup mount session.
For example:
To ensure that the backup is successfully mounted, you can browse to the directory that you specified
in the veeamconfig backup mount command. For example:
user@srv01:~$ ls /mnt/backup/
FileLevelBackup_0
Tip: You can also check the restore session status with the veeamconfig session info command. To
learn more, see Viewing Session Status.
user@srv01:~$ ls Documents/
Reports
user@srv01:~$ ls
/mnt/backup/FileLevelBackup_0/home/user/Documents/Reports/
Report1.pdf Report2.pdf
user@srv01:~$ cp
/mnt/backup/FileLevelBackup_0/home/user/Documents/Reports/Report1.pdf
Documents/
user@srv01:~$ ls Documents/
Report1.pdf Reports
where:
<session_id> — ID of the backup mount session that you want to stop.
Veeam Agent for Linux will stop the mount session and unmount the backup from the computer file
system. For example:
In the list of backups, Veeam Agent for Linux displays information about all backups stored in all
backup repositories. If Veeam Agent for Linux is connected to a Veeam backup server, backups that
are kept on a Veeam backup repository also appear in this list. For each backup, Veeam Agent for
Linux displays the following information:
Parameter Description
Job name Name of the backup job by which the backup was created.
Repository Name of the backup repository in which the backup was created.
For example:
Tip: If you want to recover data from a backup that is stored in another location, for example, a backup
created with another instance of Veeam Agent for Linux you can import such backup into the Veeam
Agent for Linux database on your computer. To learn more, see Importing Backups.
or
where:
<backup_id> — ID of the backup for which you want to view information on restore points.
Parameter Description
Job name Name of the backup job by which the backup was created.
or
where:
<point_id> — ID of the restore point that you want to mount to the computer file system
for file-level restore.
<path> — path to the directory to which you want to mount the backup file content.
For example:
where:
<session_id> — ID of the restore point mount session.
For example:
To ensure that the restore point is successfully mounted, you can browse to the directory that you
specified in the veeamconfig point mount command. For example:
user@srv01:~$ ls /mnt/backup/
FileLevelBackup_0
Tip: You can also check the restore session status with the veeamconfig session info command. To
learn more, see Viewing Session Status.
user@srv01:~$ ls Documents/
Reports
user@srv01:~$ ls
/mnt/backup/FileLevelBackup_0/home/user/Documents/Reports/
Report1.pdf Report2.pdf
user@srv01:~$ cp
/mnt/backup/FileLevelBackup_0/home/user/Documents/Reports/Report1.pdf
Documents/
user@srv01:~$ ls Documents/
Report1.pdf Reports
where:
<session_id> — ID of the restore point mount session that you want to stop.
Veeam Agent for Linux will stop the mount session and unmount the restore point from the computer
file system. For example:
Exporting Backups
You can export the backup file to a virtual disk in the VHD format. When you export a backup, you
export to a virtual disk data pertaining to the latest restore point in the backup. The created VHD disk
will reflect the state in which backed-up volumes were at the time when the latest restore point was
created.
To export backup to a VHD disk:
1. Start the export process with the following command:
where:
<backup_id> — ID of the backup that you want to export to a virtual disk.
<path> — full path to a directory in which you want to save the created virtual
disk. Specifying relative paths is not supported.
For example:
2. You can monitor the export process and result by viewing the export session log with the
following command:
where:
<session_id> — ID of the export session.
You can also check the restore session status with the veeamconfig session info
command. To learn more, see Viewing Session Status.
3. Exported backup will be saved as a virtual disk file in the specified directory. You can check
this with a file browser or with the following command:
ls <path>
where:
<path> — path to the directory in which the virtual disk with the backup is saved.
For example:
user@srv01:~$ ls disk/
dev_30460cb5.vhd
where:
<point_id> — ID of the restore point that you want to export to a virtual disk.
<path> — full path to a directory in which you want to save the created virtual
disk. Specifying relative paths is not supported.
For example:
2. You can monitor the export process and result by viewing the export session log with the
following command:
where:
<session_id> — ID of the export session.
For example:
You can also check the restore session status with the veeamconfig session info
command. To learn more, see Viewing Session Status.
ls <path>
where
<path> — path to the directory in which the virtual disk with the backup is saved.
For example:
user@srv01:~$ ls /home/user/veeam/
dev_30460cb5.vhd
Tip: You can stop the backup job session at any time. To stop the backup job session, press the 's'
keyboard key.
Statistics Counters
Veeam Agent for Linux displays jobs statistics for the following counters:
The pane at the top of the control panel shows information on the job session type,
percentage of the job completion and session status. If Veeam Agent for Linux operates in the
server mode and you have created more than one backup job, the job name also appears on
the pane.
The Summary box shows general information about the job:
Duration — time from the job start till the job end.
Processing rate — average speed of data processing. This counter is a ratio
between the amount of processed data (Processed counter) and job duration
(Duration counter).
Bottleneck — bottleneck in the data transmission process.
The Data box shows information about processed data:
veeam
or
veeamconfig ui
or
veeamconfig session ui
2. In the Latest backup sessions list, select the necessary backup job session with Up and
Down keys and press Enter.
Tip: To return to the list of backup job sessions, press Esc. You can then select another backup job session
or exit the Veeam Agent for Linux control panel in one of the following ways:
with the Esc key — if you opened the control panel with the veeam or veeamconfig ui
command.
with the 'q' key — if you opened the control panel with the veeamconfig session ui
command.
where:
<session_id> — ID of the session for which you want to check status.
Veeam Agent for Linux displays the following information about sessions:
Parameter Description
ID ID of the session
Name of the backup job parent to the session. Veeam Agent for Linux displays value for
Job name
this parameter only for backup job sessions.
ID of the backup job parent to the session. Veeam Agent for Linux displays value for this
Job ID
parameter only for backup job sessions.
State changed Date and time of the latest change of the session status.
Date and time of the session completion. Veeam Agent for Linux displays value for this
End time
parameter only for completed sessions.
The following example shows status information on the completed backup job session:
The following example shows status information on the running volume restore session:
where:
<session_id> — ID of the backup job or restore session.
For example:
where:
<path> — path to a configuration file to which you want to import configuration.
For example:
Note: A directory in which you want to save the configuration file must exist in the file system.
where:
<path> — path to a configuration file from which you want to import the configuration database.
For example:
Restore tasks
Restore files and folders from Veeam Agent for Linux backups
Restore disks from Veeam Agent for Linux backups
Restore data from Veeam Agent for Linux backups to Microsoft Azure
Administrative tasks
Import Veeam Agent for Linux backups
Enable and disable Veeam Agent for Linux backup jobs
Delete Veeam Agent for Linux backup jobs
Remove Veeam Agent for Linux backups
View Veeam Agent for Linux backup statistics
Configure global settings
Assign roles to users
Note: If the user is granted restore permissions on the Veeam backup server, he or she will be able to see all
backups on the backup repository.
Backup jobs targeted at the backup repository become visible in Veeam Backup & Replication under
the Jobs > Agents node in the Backup & Replication view. Backups created with Veeam Agent for
Linux are available under the Disk node in Backup & Replication view.
The backup administrator working with Veeam Backup & Replication can manage Veeam Agent for
Linux backup jobs and restore data from these backups. To learn more, see Performing Restore Tasks
and Performing Administration Tasks.
Note: If you have selected to store the resulting virtual disk to a datastore, you will be able to save the
virtual disk in the VMDK format only. Other options will be disabled.
Note: If you do not want to display the Restore Reason step of the wizard in future, select the Do not
show me this page again check box