This is an archive version of the document. To get the most up-to-date information, see the current version.

Creating Volume-Level Backup Job

Creating Volume-Level Backup Job Important!

Volume-level backup job relies on a device name under the /dev directory and requires volumes to have their corresponding device names under the /dev directory staying persistent (e.g. /dev/md-127, /dev/dm-1). Otherwise the job will back up the wrong volume.

To create a volume-level backup job, use the following command:

veeamconfig job create --name <job_name> --reponame <repository_name> --objects <volume_to_backup> <advanced_options> <indexing_options>

where:

<job_name> — name for the created backup job.
<repository_name> — name of the backup repository that should be used as a target location for the backup job. The backup repository must be created in advance. To learn more, see Creating Backup Repository.

If you want to create Veeam Agent backups in a Veeam backup repository of cloud repository, you need connect to the Veeam backup server or Veeam Cloud Connect service provider in advance, before configuring the backup job. To learn more, see Connecting to Veeam Backup Server and Connecting to Service Provider.

<volume_to_backup> — object that should be included in backup:

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 the ',' (comma) character as a separator.
For LVM volumes — name of an LVM logical volume that should be included in backup. If you want to back-up several LVM logical volumes, specify them one after another using the ',' (comma) character as a separator.

Creating Volume-Level Backup Job Note:

You cannot specify LVM volume group(s) in the backup job settings when you create a backup job with the command line interface. To add an entire volume group to a volume-level backup, consider creating a backup job with the Veeam Agent for Linux control panel.

<advanced_options> — advanced options for the backup job. To learn more, see Advanced Backup Job Settings.
<indexing_options> — file system indexing options for the backup job. To learn more, see File System Indexing Settings.

For example:

$ veeamconfig job create --name SystemBackup --reponame Repository_01 --objects /dev/sda1

Creating Volume-Level Backup Job Tip:

Consider the following:

If you want to create a backup of the entire computer image, you can use the --backupallsystem option instead of the --objects option to include in the backup all volumes of your computer. For example: veeamconfig job create --name SystemBackup --reponame Repository_01 --backupallsystem.
You can also specify the schedule for the backup job. To learn more, see Configuring Backup Schedule.

Advanced Backup Job Settings

You can specify the following advanced options for the backup job:

Option	Description and values
--compressionlevel	Data compression level. Possible values are: 0 — No compression 1 — Rle 2 — Lz4 3 — ZlibLow 4 — ZlibHigh
--blocksize	Data block size in kilobytes. Possible values are 256, 512, 1024 or 4096.
--maxpoints	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 point that exceeds the specified number is created, Veeam Agent for Linux will remove the earliest restore point from the backup chain.
--prefreeze	Path to the script that should be executed before the snapshot creation. This option is available only if Veeam Agent for Linux operates in the server mode. To learn about modes, see Product Functionality Modes.
--postthaw	Path to the script that should be executed after the snapshot creation. 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.
--setencryption	Defines that data encryption option is enabled for the job. When you use the veeamconfig job create command with the --setencryption option, Veeam Agent for Linux will prompt you to specify a password for data encryption and hint for the password.

File System Indexing Settings

You can specify one the following file system indexing options for the backup job:

Option	Description and values
--indexall	Defines that Veeam Agent for Linux must index all files on the volumes included in backup.
--indexonly	Path to a directory that contains files that you want to index. Enter paths to the necessary directories. To separate several paths, use the ',' (comma) character.
--indexexcept	Path to a directory that contains files that you do not want to index. You can specify one or more paths. To separate several paths, use the ',' (comma) character.

To learn more about file indexing, see File System Indexing.