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:

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

or

veeamconfig job edit <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 DailyBackup for --name SystemBackup

 

Backup Job Options

You can use the following options to edit parameters for the backup job:

Option

Description and values

--name

Name of the backup job.

--reponame

Name of the backup repository that will be used as a target location for backup files.

--compressionlevel

Data compression level. Possible values:

  • 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 Oracle Solaris keeps 7 latest restore points. When the new restore point that exceeds the specified number is created, Veeam Agent for Oracle Solaris will remove the earliest restore point from the backup chain.

--includedirs

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

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

IMPORTANT! Performing bare metal recovery requires a backup that includes the full contents of the root directory. To configure such backup job, set the value of the --includedirs option to /, for example: veeamconfig job create --name system\ backup --reponame VeeamBackup --includedirs /. This backup job generates an additional configuration file required for restoring your files during bare metal recovery. If use excludedirs, includemasks or excludemasks options in backup job settings, mind that no system data is excluded from backup.

--excludedirs

Full path to a directory that should be excluded from backup.

The directory specified with this option should be a subdirectory of one of the directories specified with the --includedirs option. Otherwise, the --excludedirs option does not have any effect on backup.

To separate several paths, use a ',' (comma) character, for example, /export/home/user/Documents,/export/home/user/reports.

--includemasks

File name mask that defines files that must be included in backup. You can use the following UNIX wildcard characters for file name masks:

  • '*' — a substitution for zero 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 use wildcard characters in file name masks, you must specify masks in double quotation marks (""). To separate several masks, use a ',' (comma) character. For example: --includemasks "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 Oracle Solaris will back up the /export/home/user/Documents/report.pdf file and will not back up the /export/home/user/reports/report.pdf file.

--excludemasks

File name mask that defines files that must be excluded from backup.

You can use the following UNIX wildcard characters for file name masks:

  • '*' — a substitution for zero 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 use wildcard characters in file name masks, you must specify masks in double quotation marks (""). To separate several masks, use a ',' (comma) character. For example, --excludemasks "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 /export/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 Oracle Solaris will back up the /export/home/user/Documents/report.pdf file and will not back up /export/home/user/Documents/report.odt and /export/home/user/reports/report.pdf files.

--indexnothing

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

--indexall

Defines that Veeam Agent for Oracle Solaris must index all files included in backup.

--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 Oracle Solaris will prompt you to specify a password for data encryption and hint for the password.

You cannot use this option if you want to save backup files on a Veeam Backup & Replication repository. Encryption options for Veeam Agent backup jobs targeted at a Veeam backup repository are managed by a backup administrator working with Veeam Backup & Replication. To learn more, see Setting Up User Permissions on Backup Repositories.

--resetencryption

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

You cannot use this option if you want to save backup files on a Veeam Backup & Replication repository. Encryption options for Veeam Agent backup jobs targeted at a Veeam backup repository are managed by a backup administrator working with Veeam Backup & Replication. To learn more, see Setting Up User Permissions on Backup Repositories.

--prejob

Path to the script that will be executed at the start of the backup job.

--postjob

Path to the script that will be executed after the backup job completes.

--deleteold

The number of days to keep the backup created with the backup job in the target location. If Veeam Agent for Oracle Solaris 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.

You can specify this option only for backup jobs targeted at a Veeam Backup & Replication repository.

 

Editing Backup Job Settings Note

Mind the following:

  • If you change the target location for the backup job, during the next backup job session Veeam Agent for Oracle Solaris will perform full backup. All subsequent backup sessions will produce incremental backups — Veeam Agent for Oracle Solaris 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 for the backup job, during the next backup job session Veeam Agent for Oracle Solaris will create a new incremental backup. The backup will contain new files added to the backup scope and existing files in the backup scope that changed on the Veeam Agent machine since the previous backup job session.
  • If you enable or disable encryption for the existing backup job that has already created one or more restore points, during the next job session, Veeam Agent for Oracle Solaris will create active full backup.
  • 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.