Set-VBRComputerBackupJob

Short Description

Modifies Veeam Agent backup jobs and Veeam Agent backup policies.

Applies to

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

Syntax

Set-VBRComputerBackupJob -Job <VBRComputerBackupJob> [-Name <string>] [-Description <string>] [-BackupObject <Object[]>] [-BackupType <VBRComputerBackupJobBackupType> {EntireComputer | SelectedFiles | SelectedVolumes}][-SelectedFilesOptions <VBRSelectedFilesBackupOptions>]
[-SelectedVolumes <IVBRSelectedVolume[]>] [-IncludeUsbDrives][-DestinationOptions <VBRComputerDestinationOptions>] [-BackupRepository <CBackupRepository>]
[-RetentionPolicy <int>] [-StorageOptions <VBRStorageOptions>][-SyntheticFullOptions <VBRSyntheticFullOptions>] [-ActiveFullOptions <VBRFullBackupOptions>] [-HealthCheckOptions <VBRFullBackupOptions>][-CompactFullOptions <VBRFullBackupOptions>][-NotificationOptions <VBRNotificationOptions>] [-ScriptOptions <VBRJobScriptOptions>][-EnableDeletedComputerRetention] [-DeletedComputerRetentionPolicy <int>]
[-EnableApplicationProcessing][-ApplicationProcessingOptions <VBRApplicationProcessingOptions[]>] [-EnableIndexing] [-IndexingOptions <VBRComputerIndexingOptions[]>][-EnableSchedule] [-ScheduleOptions <VBRObject>] [-BackupCacheOptions <VBRBackupCacheOptions>]  [-RetentionType {RestorePoints | RestoreDays}] [-GFSOptions <VBRComputerGFSOptions>][-EnableGFSRetention] [-SanIntegrationOptions <VBRSanIntegrationOptions>][-HighPriority] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of Veeam Agent backup jobs and Veeam Agent backup policies. To modify settings, enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Job

Specifies the backup job or a backup policy that you want to modify.

Accepts the VBRComputerBackupJob variable.

True

Named

True (ByValue)

Name

Specifies the name that you want to assign to a backup job or to a backup policy.

False

Named

False

Description

Specifies the description of a backup job or a backup policy.

False

Named

False

BackupObject

Specifies an array of protection groups and discovered computers that you want to add to a backup job or to a backup policy.

Accepts the VBRDiscoveredEntityType and VBRProtectionGroup[] types.

Important! The cmdlet will replace the protection groups that are currently added to the backup job with this array.

False

Named

False

BackupType

Specifies the scope of data that you want to back up.

  • EntireComputer: for entire computer image backups.
  • SelectedFiles: for file-level backups.
    NOTE:
    This option is not available for the job that backs up failover clusters.
    If you select this option, you will not be able to switch to the EntireComputer or SelectedVolumes options.
  • SelectedVolumes: for volume-level backups.
  • MacUserHome: for backups of the Users folder that contains the Home folders of all users.

False

Named

False

SelectedFilesOptions

For file-level backups.

Specifies an array of the folders with the files that you want to back up.

Accepts the VBRSelectedFilesBackupOptions type.

False

Named

False

SelectedVolumes

For volume-level backups.

Specifies an array of computer volumes that you want to back up.

Accepts the following types:

  • String[]
    Note: You can set this type for Windows-based computers only.
  • VBRLinuxSelectedVolume
    Note: You can set this type for Linux-based computers only.

False

Named

False

ExcludedVolumes

For volume-level backups.

Specifies an array of computer volumes that you want to exclude from backup.

Accepts the VBRWindowsSelectedVolume type.

False

Named

False

IncludeUsbDrives

Indicates that Veeam Backup & Replication will back up the periodically connected USB drives.

Note: You can set this parameter only for the following types of Veeam Agent jobs:

  • Veeam Agent jobs that back up entire images of Windows computers.
  • Veeam Agent backup policies that back up the Users folder that contains the Home folders of all users.

False

Named

False

DestinationOptions

Specifies the target backup location for the protected computers that you want to add to the backup policy.

Note: This parameter is not available for backup jobs.

Accepts the VBRComputerDestinationOptions type.

False

Named

False

BackupRepository

Specifies the target backup location for a backup job.

Note: This parameter is not available for backup policies.

Accepts the CBackupRepository type.

False

Named

False

RetentionPolicy

Specifies the retention policy for backups created by the Veeam Agent.

Note: Retention policy specifies the following settings:

  • For jobs that back up workstations, the retention policy specifies the number of days.
  • For jobs that back up Linux computes, the retention policy specifies the number of restore points.
  • For jobs that back up servers, the retention policy specifies the number of restore points.
  • For Veeam Agent policies that that back up macOS computers, the retention policy specifies the restore points.

False

Named

False

SyntheticFull Options

Specifies the schedule for synthetic full backup.

Accepts the VBRSyntheticFullOptions type.

False

Named

False

ActiveFullOptions

Specifies the schedule for active full backup.

Accepts the VBRFullBackupOptions type.

False

Named

False

HealthCheckOptions

Specifies the health check schedule for the latest restore point.

Accepts the VBRFullBackupOptions type.

Note: This parameter is not available for backup policies that Veeam Agent job applies to Linux computers.

False

Named

False

EnableDeletedComputerRetention

Indicates that Veeam Backup & Replication will keep the backup data for machines that have not been backed up for a certain period of time. Veeam Backup & Replication will remove backup files of these computers in case Veeam Agent backup job will not be able to back up these computers for the specified period.

Use the DeletedComputerRetentionPolicy parameter to specify the number of days for keeping the backup files of machines that have not been backed up for a certain period of time.

False

Named

False

DeletedComputerRetentionPolicy

For the EnableDeletedComputerRetention option.

Specifies the period of time in days to keep backup files for machines that have not been backed up for a certain period of time. Veeam Backup & Replication will remove backup files of these computers in case Veeam Agent backup job will not be able to back up these computers when the specified period of time is over.

Default: 30 days.

False

Named

False

CompactFullOptions

Specifies the schedule for the compact operation of full backups created by the Veeam Agent backup job.

Accepts the VBRFullBackupOptions type.

Veeam Backup & Replication will defragment and compact a full backup per the schedule settings specified in the VBRFullBackupOptions object.

Note: This parameter is not available for backup policies that Veeam Agent job applies to Linux computers.

False

Named

False

StorageOptions

Specifies the settings for compression and storage optimization of the target backup repository.

Accepts the VBRStorageOptions type.

False

Named

False

NotificationOptions

Specifies notification settings for the Veeam Agent backup job.

Accepts the VBRNotificationOptions type.

False

Named

False

ScriptOptions

Specifies custom script settings. Veeam Backup & Replication will run pre-job and post-job scripts per these settings.

Note: This parameter is not available for backup policies that Veeam Agent job applies to Windows computers.

Accepts the VBRJobScriptOptions type.

False

Named

False

EnableApplicationProcessing

Enables application-aware processing for the Veeam Agent backup job.

False

Named

False

ApplicationProcessingOptions

Specifies the settings for application-aware processing.

Accepts the VBRApplicationProcessingOptions type.

False

Named

False

EnableIndexing

Indicates that the guest file system indexing is enabled.

False

Named

False

IndexingOptions

Specifies indexing scope settings.

Accepts the VBRComputerIndexingOptions type.

False

Named

False

EnableSchedule

Indicates that Veeam Backup & Replication will schedule the Veeam Agent backup job to run on a regular basis.

False

Named

False

ScheduleOptions

Specifies the settings for Veeam Agent job schedule

Accepts the types returned by the following cmdlets:

False

Named

False

UseSnapshotlessFileLevelBackup

Indicates that the cmdlet will create the crash-consistent file-level backup without a snapshot.

Note: Available for Linux machines with the file-level backup scope only.

False

Named

False

BackupCacheOptions

Specifies backup cache settings of a Veeam Agent backup job for Microsoft Windows.

Note: You can apply backup cache settings for Veeam Agent backup jobs that are targeted at the following types of backup location:

  • Veeam backup repository
  • Veeam Cloud Connect repository

Accepts the VBRBackupCacheOptions type.

False

Named

False

RetentionType

Specifies retention type for Veeam Agent jobs managed by the Veeam Backup server. You can specify either of the following types:

  • RestorePoints
  • RestoreDays

False

Named

False

EnableGFSRetention

Defines that the cmdlet will enable GFS retention for Veeam Agent jobs.

If you do not provide this parameter, Veeam Agent jobs will run without GFS retention policy.

Note: This options is not available for Veeam Agent policies.

Use the GFSOptions parameter to specify the GFS retention policy.

False

Named

False

GFSOptions

For the EnableGFSRetention option.

Specifies GFS retention. The cmdlet will create Veeam Agent job with the specified policy.

Accepts the VBRComputerGFSOptions type.

False

Named

False

WarningOptions

Specifies notifications settings for computers processed by Veeam Agent policies.

Note: This parameter is not available for computers processed by Veeam Agent backup jobs.

Accepts the VBRComputerWarningOptions type.

False

Named

False

SanIntegrationOptions

Specifies storage integration settings for the Veeam Agent jobs.

Accepts the VBRSanIntegrationOptions type.

False

Named

False

HighPriority

Note: This parameter is available starting from Veeam Backup & Replication 11a (build 11.0.1.1261).

Defines that Veeam Backup & Replication will prioritize this job higher than other similar jobs and will allocate resources to it in the first place.

False

Named

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

This cmdlet returns the VBRComputerBackupJob[] object that contains settings of Veeam Agent backup jobs and Veeam Agent backup policies.

Example 1

This example shows how to apply new storage settings to an existing Veeam Agent backup job.

  1. Run Get-VBRComputerBackupJob to get the job that you want to modify. Save the result to the $job variable.
  2. Run New-VBRStorageOptions to specify compression and storage optimization settings. Save the result to the $storage variable.
  3. Run Set-VBRComputerBackupJob with the $job and $storage variables.

$job = Get-VBRComputerBackupJob -Name "ClusterJob"

$storage = New-VBRStorageOptions -CompressionLevel Optimal -StorageOptimizationType LocalTarget

Set-VBRComputerBackupJob -Job $job -StorageOptions $storage

Example 2

This example shows how to modify an existing Veeam Agent backup job. The job will run with the following settings:

  • The job will create a full backup on a regular basis.
  • Veeam Backup & Replication will apply the retention policy for the backups created by the job.

To modify an existing Veeam Agent backup job, perform the following steps:

  1. Run Get-VBRComputerBackupJob to get the job that you want to modify. Save the result to the $job variable.
  2. Run New-VBRFullBackupOptions to specify the full backup job schedule. Save the result to the $fulloptions variable.
  3. Run Set-VBRComputerBackupJob with the $job and $fulloptions variables. Use the RetentionPolicy parameter to specify the retention period.

$job = Get-VBRComputerBackupJob -Name "LinuxJob"

$fulloptions = New-VBRFullBackupOptions -Enable -ScheduleType Weekly -SelectedDays Sunday, Wednesday

Set-VBRComputerBackupJob -Job $job -ActiveFullOptions $fulloptions -RetentionPolicy 7

Example 3

This example shows how to add a protection group to an existing Veeam Agent backup job.

  1. Run Get-VBRComputerBackupJob to get the backup job that you want to modify. Save the result to the $job variable.
  2. Get the BackupObject property of the $job variable. Save the result to the $objects variable.
  3. Get the protection group scope. Use the BackupObject property of the backup job object to get an array. Save the result to the $objects variable.
  4. Run Get-VBRProtectionGroup to get the protection group that you want to add. Save the result to the $group variable.
  5. Add the protection group to the BackupObject array. Use the += operator.
  6. Run Set-VBRComputerBackupJob with the $job and $objects variables.

$job = Get-VBRComputerBackupJob -Name "BackupJob"

$objects = $job.BackupObject

$group = Get-VBRProtectionGroup -Name "Protection group"

$objects += $group

Set-VBRComputerBackupJob -Job $job -BackupObject $objects

Related Commands