Creating File-Level Backup Job

--includedirs

Full path to a directory that should be included in backup, for example: /home/user.

You can specify one or several paths to directories in the computer file system. To separate several paths, use the ',' (comma) character, for example: /home/user/Documents,/home/user/reports.

Tip: If you want to back up the root directory and specify the '/' (slash) character, Veeam Agent does not automatically include mount points in the backup scope. To include mount points, you need to specify paths to these mount points manually.

For example, you have a file system mounted to the /home/media directory. If you add / as an object to the backup scope, Veeam Agent will not back up the mounted file system. To back up the root directory and the mounted file system, add the following objects to the backup scope: /,/home/media.

--excludedirs

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 --includedirs option. To separate several paths, use the ',' (comma) character, for example, /home/user/Documents,/home/user/reports.

--includemasks

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 report_201[3-6].pdf.

Keep in mind that you must specify all names with masks in double quotation marks (""). For example: --includemasks "*.bak".

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.

--excludemasks

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.

Keep in mind that you must specify all names with masks in double quotation marks (""). For example: --excludemasks "*.bak".

If you want to use several file name masks, you must specify them in double quotation marks ("") and separated with a comma (,). For example: --excludemasks *.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.

--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, 4096 or 8192.

The default value is 1024.

--maxpoints

The number of restore points that you want to store in the backup location. By default, Veeam Agent for Linux keeps 7 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 pre-freeze script that should be executed before the snapshot creation.

This option is available only if Veeam Agent for Linux operates in the Server edition. To learn about editions, see Product Editions.

--postthaw

Path to the post-thaw script that should be executed after the snapshot creation.

This option is available only if Veeam Agent for Linux operates in the Server edition. To learn about editions, see Product Editions.

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

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

--daily

Defines that the backup job must start daily at specific time.

--weekdays

Weekdays when the backup job must start separated by a comma (','). Possible values are:

• Mon — Monday
• Tue — Tuesday
• Wed — Wednesday
• Thu — Thursday
• Fri — Friday
• Sat — Saturday
• Sun — Sunday

--at

Time of day when the backup job must start specified in the HH:MM format. For example: 20:00.

--weekdays-full

Weekdays when the backup job must create an active full backup separated by a comma (','). Possible values are:

• Mon — Monday
• Tue — Tuesday
• Wed — Wednesday
• Thu — Thursday
• Fri — Friday
• Sat — Saturday
• Sun — Sunday

--thisday-full

Days of the month when the backup job must create an active full backup separated by a comma (','). Possible values are: 1–30 (or 1–31, depending on the month length).

--indexall

Defines that Veeam Agent for Linux must index all files in the directories included in backup.