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

Creating File-Level Backup Job

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

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

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 the Veeam backup repository, you should connect to the Veeam backup server in advance, before configuring the backup job. To learn more, see Connecting to Veeam Backup Server.

  • <indexing_options> — file system indexing options for the backup job. To learn more, see File System Indexing Settings.
  • --nosnap — option that instructs Veeam Agent for Linux to perform backup in the snapshot-less mode. With this option enabled, Veeam Agent for Linux will not create a snapshot of the backed-up volume(s) during backup. This allows Veeam Agent to back up data residing in file systems that are not supported for snapshot-based backup with Veeam Agent for Linux. Note 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.

For example:

$ veeamconfig job create filelevel --name HomeFolderBackup --reponame NetworkRepository --includedirs /home/user --excludedirs /home/user/temp --excludemasks *.pdf

 

Creating File-Level Backup Job Tip:

You can also specify the schedule for the backup job. To learn more, see Configuring Backup Schedule.

File Inclusion Options

When you create a file-level backup job, you must specify at least one directory that should be included in backup. If you do not want to back up some files and directories in the specified directory, you can exclude specific files and directories from backup.

To define the backup scope for the file-level backup job, you can use the following command-line options:

Option

Description and values

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

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

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.

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.

 

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 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 mode. To learn about modes, see Product Functionality Modes.

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

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

By default, the retention period for old backups is 30 days.

 

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 in the directories 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.

Veeam Large Logo

User Guide

Veeam Agent Management Guide

Veeam Backup & Replication Documentation

Veeam ONE Documentation

Veeam Management Pack Documentation

Veeam Agent for Microsoft Windows Documentation