Editing Backup Job Settings

In this article

    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 folder to the backup scope or change the target location.

    To edit a backup job, use the following command:

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

    or

    veeamconfig job edit filelevel <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, 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@wrk01:~$ veeamconfig job edit filelevel --name SystemVolumeBackup for --name SystemVolume

     

    Backup Job Options

    You can use the following options to edit parameters 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

    --maxpoints

    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.

    --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 a ',' (comma) character, for example: /home/user/Documents,/home/user/reports.

    --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 a ',' (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.

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

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

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

    --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 Mac 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 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 the --deleteold option is not specified, Veeam Agent does not apply this setting. As a result, 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 the option: --deleteold false. After the next successful backup session, this setting will be disabled for the backup in the target location.

     

     

    Editing Backup Job Settings NOTE

    Consider the following:

    • If you change the target location for the backup job, during the next backup job session Veeam Agent for Mac will perform full data backup. All subsequent backup sessions will produce incremental backups — Veeam Agent for Mac 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 Mac will create a new incremental backup. The backup will contain all data blocks pertaining to new data added to the backup scope and changed data blocks pertaining to original data in the backup scope (data that was processed by the job at the time before you changed the backup scope).
    • 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.

     

     

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.