Creating Standalone Backup Job

--includedirs

Full path to a folder 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.

Note: You cannot use UNIX wildcard characters in the paths to the folders you want to include.

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

For example, you have a network 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 network file system. To back up the root directory and the mounted network file system, add the following objects to the backup scope: /,/home/media.

--excludedirs

Full path to a folder that should be excluded from backup. The folder specified with this option must be a subfolder of the folder specified with the --includedirs option. To separate several paths, use the ',' (comma) character, for example, /home/user/Documents,/home/user/reports.

Note: You cannot use UNIX wildcard characters in the paths to the folders you want to exclude.

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

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

--compressionlevel

Data compression level. Possible values are:

• 0 — None
• 1 — Dedupe-friendly
• 2 — Optimal
• 3 — High
• 4 — Extreme

For more information on compression levels, see Data Compression.

--blocksize

Data block size in kilobytes. Possible values are 256, 512, 1024 or 4096.

The default value is 1024.

--maxpoints

The number of restore points that you want to store in the backup location. By default, Veeam Agent keeps 7 latest restore points. When the new restore point that exceeds the specified number is created, Veeam Agent will remove the earliest restore point from the backup chain.

--immutabledays

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.

--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 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 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. As a result, backup will be stored in the target location until you delete it manually.

--weekdays

[For weekly schedules] Specifies the weekdays when the backup job must run. If you want to run the backup job more than once during the week, the list of weekdays must be separated by a comma (','). Possible values are:

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

--daily

[For weekly schedules] Defines that the backup job must start daily at specific time.

--thisday

[For monthly schedules] Specifies the day of the month when the backup job must run. Possible values: from 1 to 31 or Last.

--weeknumber

[For monthly schedules] Specifies the week of the month when the backup job must run. Possible values: First, Second, Third, Fourth or Last. This option must be used in combination with the --monthlyweekday option.

--monthlyweekday

[For monthly schedules] Specifies the day of the week when the backup job must run. You can select only one weekday. Possible values are:

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

--months

[For monthly schedules] Specifies the months when the backup job must run. If you specify more than one month, the list must be separated by a comma (,) — for example: Jan,Apr,Jul,Oct. If you do not specify this option, the backup job will run every month.

--every

[For periodic schedules] Specifies the period of time in minutes or hours between the runs of the backup job. The period must be specified in the HH: MM format — for example, 06:00.

--at

[For weekly and monthly schedules]  Specifies the time of day in the HH:MM format when the backup job must start — for example: 20:00.

--weekdays-full

[For weekly schedules] Specifies the weekdays when the backup job must create an active full backup. If you want to create an active full backup more than once during the week, the list of weekdays must be separated by a comma (','). Possible values are:

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

--thisday-full

[For monthly schedules] Specifies the day of the month when the backup job must create an active full backup. Possible values: from 1 to 31 or Last.

--weeknumber-full

[For monthly schedules] Specifies the week of the month when the backup job must create an active full backup.. Possible values: First, Second, Third, Fourth or Last. This option must be used in combination with the --monthlyweekday option.

--monthlyweekday-full

[For monthly schedules] Specifies the day of the week when the backup job must create an active full backup. You can select only one weekday. Possible values are:

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

--months-full

[For monthly schedules] Specifies the months when the backup job must create an active full backup. If you specify more than one month, the list must be separated by a comma (,) — for example: Jan,Apr,Jul,Oct. If you do not specify this option, the backup job will create an active full backup. every month.