Help Center
Choose product document...
Veeam Agent for Linux 1.0
User Guide

Editing Backup Job Settings

If you want to change settings of the backup job, you can edit it at any time. For example, you may want to edit the backup job to add a new directory to the backup scope or change the target location.

To edit a backup job, use the following command:

For volume-level backup jobs

veeamconfig job edit <option> for --name <job_name>

or

veeamconfig job edit <option> for --id <job_id>

For file-level backup jobs

veeamconfig job edit filelevel <option> for --name <job_name>

or

veeamconfig job edit filelevel <option> for --id <job_id>

where:

  • <option> — option 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.
  • <job_id> — ID of the backup job that you want to edit.

For example:

user@srv01:~$ veeamconfig job edit --name SystemVolumeBackup for --name SystemVolume

 

Backup Job Options

You can use the following options to edit parameters 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).

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

Pre-freeze command that should be executed before the snapshot creation.

--postthaw

Post-thaw command that should be executed after the snapshot creation.

--objects

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

This option is available for volume-level backup jobs only.

--includedirs

Full path to a directory that should be included in backup, for example: /home/user. The option is available for file-level backup jobs only.

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.

--excludedirs

Full path to a directory that should be excluded from backup. The option is available for file-level backup jobs only.

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.

--includemasks

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

--excludemasks

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.

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.

If you want to use several name masks, you must specify them in double quotation marks, for example: veeamconfig job create filelevel --name BackupJob1 --reponame vault13 --includedirs /home --includemasks "*.bak,*.pdf".

--indexnothing

Defines that file system indexing options are disabled for the backup job.

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

 

 

Editing Backup Job Settings Note:

Mind the following:

  • If you change the target location in the backup job, during the next backup job session Veeam Agent for Linux will perform full data backup. All subsequent backup sessions will produce incremental backups — Veeam Agent for Linux will copy only changed data to the target location and add a new incremental backup file to the backup chain.
  • If you change the backup scope in the backup job, during the next backup job session Veeam Agent for Linux will create a new incremental backup that will contain a full copy of all data that you have selected to back up.

 

 

Editing Backup Job Settings 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.

 

Veeam Large Logo

User Guide

Veeam Backup & Replication Documentation

Veeam ONE Documentation

Veeam Management Pack Documentation

Veeam Agent for Microsoft Windows Documentation