Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Set-VBRConfigurationBackupJob

Short Description

Modifies the configuration backup job.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

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 enter the corresponding parameters with new values. 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

Schedule
Options

Specifies the schedule for the configuration backup job.

Accepts VBRConfigurationBackupScheduleOptions type.

False

Named

False

False

RestorePoints
ToKeep

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

You can set 1 to 255.

False

Named

False

False

Enable
Encryption

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

Encryption
Key

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 about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

VBRConfigurationBackupJob

Example 1

This command disables the configuration backup job.

PS C:\PS> 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.

PS C:\PS> $daily = New-VBRDailyOptions -Period "05:00" -DayOfWeek Saturday

PS C:\PS> $dailyschedule = New-VBRConfigurationBackupScheduleOptions -Type Daily -DailyOptions $daily

PS C:\PS> $encryptionkey = Get-VBREncryptionKey -Description "veeam encryption"

PS C:\PS> Set-VBRConfigurationBackupJob -ScheduleOptions $configschedule -EnableEncryption -EncryptionKey $encryptionkey

Related Commands

Get-VBRBackupRepository

New-VBRConfigurationBackupScheduleOptions

Get-VBREncryptionKey

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Endpoint Backup Documentation

Veeam Management Pack Documentation