Editing Backup Job Settings

--compressionlevel

Data compression level. Possible values are:

• 0 — No compression
• 1 — Rle
• 2 — Lz4
• 3 — Zstd 3
• 4 — Zstd 9

--blocksize

Data block size in kilobytes. The default value is 1024. Possible values are 256, 512, 1024 or 4096. To learn more about available sizes of data blocks, see Data Compression.

--maxdays

Retention period that specifies the number of days for which you want to store the latest restore points in the backup repository. After the retention period ends, Veeam Agent removes from the backup chain any restore points that are older than the specified period. By default, Veeam Agent keeps restore points for 7 days.

--immutableentire

[For backup jobs targeted at object storage] Makes backups immutable to modification or deletion for the entire duration of the specified retention period.

--immutabledays

[For backup jobs targeted at object storage] The time period in days during which the backup stored in an object storage repository will be immutable to modification or deletion. For more information, see Backup Immutability.

--prefreeze

[For snapshot-based backup jobs] Pre-freeze command that should be executed before the snapshot creation.

--postthaw

[For snapshot-based backup jobs] Post-thaw command that should be executed after the snapshot creation.

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

--objects

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

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

--includedirs

[For file-level backup jobs] 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

[For file-level backup jobs] 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

[For file-level backup jobs] 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 will back up the /home/user/Documents/report.pdf file and will not back up the /home/user/reports/report.pdf file.

--excludemasks

[For file-level backup jobs] 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 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 must index all files on the volumes included in backup.

--indexonly

[For volume-level backup jobs] 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. The option is available for volume-level backup jobs only.

--indexexcept

[For volume-level backup jobs] 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. The option is available for volume-level backup jobs only.

--setencryption

Defines that data encryption option is enabled for the job. You can use this option to enable encryption for the existing backup job or change a password used for encryption for the backup job. When you use the veeamconfig job edit command with the --setencryption option, Veeam Agent for Linux will prompt you to specify a password for data encryption and hint for the password.

--resetencryption

Defines that data encryption option is disabled for the job. You can use this option to disable encryption for the existing backup job.

--deleteold

The number of days to keep the backup created with the backup job in the target location. If Veeam Agent for Linux does not create new restore points for the backup, the backup will remain in the target location for the specified number of days. When this period is over, the backup will be removed from the target location.Possible values are: 1–999.

If you do not specify the --deleteold option, Veeam Agent will not apply this setting. The backup will be stored in the target location until you delete it manually.

If you specified the value earlier and want to disable this setting, specify the false value for this option: --deleteold false. After the next successful backup session, this setting will be disabled for the backup in the target location.

--nosnap

[For file-level backup jobs] Defines whether Veeam Agent must perform backup in the snapshot-less mode. Possible values:

• true — if you use this option, Veeam Agent will create a snapshot of the backed-up volumes during file-level backup.
• false — if you use this option, Veeam Agent will not create a snapshot of the backed-up volumes during file-level backup.

Keep in mind that the snapshot-less file level backup does not guarantee that data in the backup is consistent. To learn more, see Snapshot-Less File-Level Backup.