Set-VBRConfigurationBackupJob

In this article

    Short Description

    Modifies the configuration backup job.

    Applies to

    Platform: VMware, Hyper-V

    Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Set-VBRConfigurationBackupJob [-Enable] [-Repository <CBackupRepository>] [-ScheduleOptions <VBRConfigurationBackupScheduleOptions>] [-RestorePointsToKeep <int>] [-EnableEncryption] [-EncryptionKey <VBREncryptionKey>] [-PassThru] [<CommonParameters>]

    Detailed Description

    This cmdlet modifies settings of the configuration backup job. To modify settings, you need to specify new values for the necessary parameters. The parameters that you omit will remain unchanged.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Enable

    If set to TRUE, the job will be enabled.

    If set to FALSE, you will need to run the job manually.

    Default: TRUE.

    False

    Named

    False

    False

    Repository

    Specifies the backup repository where you want to store the configuration backups.

    Accepts CBackupRepository or string (repository name) types.

    You cannot specify a cloud repository that is created on base of scale-out backup repository.

    False

    Named

    False

    False

    ScheduleOptions

    Specifies the schedule for the configuration backup job.

    Accepts VBRConfigurationBackupScheduleOptions type.

    False

    Named

    False

    False

    RestorePointsToKeep

    Specifies the number of restore points you want to keep on disk.

    You can set 1 to 255.

    False

    Named

    False

    False

    EnableEncryption

    If set to TRUE, the configuration backup will be encrypted.

    Use the EncryptionKey parameter to specify the encryption key.

    NOTE:  if you have created at least one password in the Password Manager on the backup server, you must enable encryption for the configuration backup.

    False

    Named

    False

    False

    EncryptionKey

    Used to set the encryption key for the EnableEncryption parameter.

    Specifies the encryption key you want to use to encrypt the data.

    Accepts VBREncryptionKey type.

    False

    Named

    False

    False

    PassThru

    Indicates that the command returns the output object to the Windows PowerShell console.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Return Type

    VBRConfigurationBackupJob

    Example 1

    This command disables the configuration backup job.

    Set-VBRConfigurationBackupJob -Enable:$False

    Example 2

    This command modifies the configuration backup schedule and enables encryption. The job is set to run at 00:00 every Saturday.

    • Run Get-VBREncryptionKey to create an object that contains the encryption key. Save it to the "$encryptionkey" variable.
    • Run Set-VBRConfigurationBackupJob with the saved variables to modify the configuration job settings.

    $daily = New-VBRDailyOptions -Period "05:00" -DayOfWeek Saturday

    $dailyschedule = New-VBRConfigurationBackupScheduleOptions -Type Daily -DailyOptions $daily

    $encryptionkey = Get-VBREncryptionKey -Description "veeam encryption"

    Set-VBRConfigurationBackupJob -ScheduleOptions $configschedule -EnableEncryption -EncryptionKey $encryptionkey

    Related Commands

    Get-VBRBackupRepository

    New-VBRConfigurationBackupScheduleOptions

    Get-VBREncryptionKey