Set-VBRObjectStorageBackupJob

Short Description

Modifies settings of object storage backup job.

Note

This cmdlet is available starting from Veeam Backup & Replication 12.1 (build 12.1.0.2131).

Applies to

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

Syntax

Set-VBRObjectStorageBackupJob <VBRObjectStorageBackupJob> [-BackupObject <VBRObjectStorageBackupJobObject[]>] [-SkipTagTracking] [-Name <String>] [-Description <String>] [-ShortTermBackupRepository <CBackupRepository>] [-ShortTermRetentionType <VBRUnstructuredBackupShortTermRetentionType>] [-ShortTermRetentionPeriod <Int32>] [-EnableLongTermRetention] [-LongTermRetentionType <VBRUnstructuredBackupLongTermRetentionType>] [-LongTermBackupRepository <IRepository>] [-LongTermRetentionPeriod <Int32>] [-LongTermArchivalOptions <VBRUnstructuredBackupArchivalOptions>] [-EnableCopyMode] [-EnableSecondaryTarget] [-SecondaryTarget <VBRUnstructuredBackupSecondaryTarget[]>] [-VersionRetentionOptions <VBRUnstructuredBackupVersionRetentionOptions>] [-StorageOptions <VBRStorageOptions>] [-HealthCheckOptions <VBRFullBackupOptions>] [-NotificationOptions <VBRNotificationOptions>] [-ScriptOptions <VBRJobScriptOptions>] [-EnableSchedule] [-ScheduleOptions <VBRServerScheduleOptions>] [-Force] [-HighPriority]  [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of object storage backup job.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Job

Specifies the object storage backup job that you want to modify.

Accepts the VBRObjectStorageBackupJob object. To get this object, run the Get-VBRUnstructuredBackupJob cmdlet.

True

Named

True (ByValue, ByPropertyName)

BackupObject

Specifies an array of objects. The cmdlet will add these objects to the object storage backup job.

Accepts the VBRObjectStorageBackupJobObject[] object. To define this object, run the New-VBRObjectStorageBackupJobObject cmdlet.

True

Named

False

Name

Specifies a name of the object storage backup job. The cmdlet will create the object storage backup job with this name.

String

False

Named

False

Description

Specifies a description of the object storage backup job. The cmdlet will create the the object storage backup job with this description.

String

False

Named

False

ShortTermBackupRepository

Specifies the backup repository. The cmdlet will add this repository as the short-term backup storage.

Accepts the CBackupRepository object. To create this object, run the Get-VBRBackupRepository cmdlet.

False

Named

False

ShortTermRetentionType

Specifies a retention policy for the short-term backup repository. You can set the retention policy to either of the following periods:

  • Daily: use this option if you want Veeam Backup & Replication to apply retention policy daily.
  • Monthly: use this option if you want Veeam Backup & Replication to apply retention policy monthly.

Use the ShortTermRetentionPeriod to specify the number of days or months.

VBRUnstructuredBackupShortTermRetentionType

False

Named

False

ShortTermRetentionPeriod

For the ShortTermRetentionType option.

Specifies the period of time to keep data on the short-term backup repository. When this period is passed, Veeam Backup & Replication will move data to the long-term archive repository.

Int

False

Named

False

EnableLongTermRetention

Defines that the cmdlet will enable custom retention policy for the long-term repository.

If you provide this parameter, Veeam Backup & Replication will apply custom retention policy for data that is stored on the long-term repository. Otherwise, Veeam Backup & Replication will keep data for three years on the long-term repository.

SwitchParameter

False

Named

False

LongTermRetentionType

Specifies a retention policy for the long-term archive repository. You can set the retention policy to either of the following periods:

  • Monthly: use this option if you want Veeam Backup & Replication to apply retention policy monthly.
  • Yearly: use this option if you want Veeam Backup & Replication to apply retention policy yearly.

Use the LongTermRetentionPeriod to specify the number of months or years.

VBRUnstructuredBackupLongTermRetentionType

False

Named

False

LongTermBackupRepository

Specifies the archive repository. The cmdlet will add this repository as the long-term archive storage.

Accepts the IRepository object. To get this object, run the following cmdlets:

False

Named

False

LongTermRetentionPeriod

For the LongTermRetentionType option.

Specifies the period of time to keep data on the long-term archive repository. When this period is passed, Veeam Backup & Replication will delete this data from the archive repository.

Int

False

Named

False

LongTermArchivalOptions

Specifies the retention policy for data versions that are located on the long-term archive repository. The cmdlet will create object storage backup jobs with the specified retention policy.

Accepts the VBRUnstructuredBackupArchivalOptions object. To create this object, run the New-VBRUnstructuredBackupArchivalOptions cmdlet.

False

Named

False

EnableCopyMode

Defines that the cmdlet will keep the copy of the data stored in the backup repository in the long-term archive repository

SwitchParameter

False

Named

False

EnableSecondaryTarget

Defines that the cmdlet will enable a secondary backup repository for an object storage backup job.

If you provide this parameter, Veeam Backup & Replication will create copies of object storage backup jobs and will keep them on a secondary backup repository. Otherwise, copies of object storage jobs will not be created.

SwitchParameter

False

Named

False

SecondaryTarget

Specifies the backup repository. The cmdlet will add this repository as the secondary repository to the object storage backup job.

Accepts the VBRUnstructuredBackupSecondaryTarget[] object. To create this object, run the New-VBRUnstructuredBackupSecondaryTarget cmdlet.

False

Named

False

VersionRetentionOptions

Specifies the settings of version-based retention for backup and archive repositories. The cmdlet will apply these settings to the object storage backup job.

Accepts the VBRUnstructuredBackupVersionRetentionOptions object. To create this object, run the New-VBRUnstructuredBackupVersionRetentionOptions cmdlet.

False

Named

False

StorageOptions

Specifies storage optimization settings. The cmdlet will create the object storage backup with these settings.

Accepts the VBRStorageOptions object. To create this object, run the New-VBRStorageOptions cmdlet.

False

Named

False

HealthCheckOptions

Specifies the healthcheck schedule. The cmdlet will create the object storage backup with this healthcheck schedule.

Accepts the VBRFullBackupOptions object. To create this object, run the New-VBRFullBackupOptions cmdlet.

False

Named

False

NotificationOptions

Specifies notification options. The cmdlet will create the object storage backup job with these notification options.

Accepts the VBRNotificationOptions object. To create this object, run the New-VBRFullBackupOptions cmdlet.

False

Named

False

EnableSchedule

Defines that the cmdlet will enable the custom schedule for a file share backup job.

if you provide this parameter, a file share backup job will run according to this schedule. Otherwise, to run the job, you will need to start it manually.

SwitchParameter

False

Named

False

ScriptOptions

Specifies pre-job and post-job script options. The cmdlet will create object storage backup jobs with these script options.

Accepts the VBRJobScriptOptions object. To create this object, run the New-VBRJobScriptOptions cmdlet.

False

Named

False

ScheduleOptions

Specifies schedule options. The cmdlet will create the object storage backup job with these schedule options.

Accepts the VBRJobScriptOptions object. To create this object, run the New-VBRServerScheduleOptions cmdlet.

False

Named

False

Force

Defines that the cmdlet will add a file backup without showing warnings or errors in the PowerShell console.

SwitchParameter

False

Named

False

HighPriority

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

SwitchParameter

False

Named

False

SkipTagTracking

Defines that the cmdlet will enable tag tracking for an object storage backup job. If you provide this parameter, the cmdlet will skip tracking of tags for incremental backups in case the objects content is not changed when the job runs.

Note: The cmdlet skips this parameter if you define tag masks settings with the New-VBRObjectStorageBackupTagMask cmdlet.

SwitchParameter

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the VBRObjectStorageBackupJob object that contains settings of object storage backup job.

Examples

Modifying Object Storage Backup Job

This example shows how to modify the object storage to keep data on the WinRepo2075 long-term archive repository.

$job = Get-VBRUnstructuredBackupJob -Name "Azure01"

$archiverepo = Get-VBRBackupRepository -Name "WinRepo2075"

Set-VBRObjectStorageBackupJob -Job $job -LongTermBackupRepository $archiverepo -EnableLongTermRetention -LongTermRetentionType Monthly LongTermRetentionPeriod 3

Perform the following steps:

  1. Run the Get-VBRUnstructuredBackupJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
  2. Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $archiverepo variable.
  3. Run the Set-VBRObjectStorageBackupJob cmdlet. Specify the following settings:
  • Set the $job variable as the Job parameter value.
  • Set the $archiverepo variable as the LongTermBackupRepository parameter value.
  • Provide the EnableLongTermRetention parameter.
  • Set the Monthly option for the LongTermRetentionType parameter.
  • Specify the LongTermRetentionPeriod parameter value

Related Commands