Set-VBRNASBackupJob

Short Description

Modifies file backup jobs.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRNASBackupJob -Job <VBRNASBackupJob> [-Name <string>] [-Description <string>] [-BackupObject <VBRNASBackupJobObject[]>] [-ShortTermBackupRepository <CBackupRepository>] [-ShortTermRetentionType <VBRNASBackupShortTermRetentionType> {Daily | Monthly}] [-ShortTermRetentionPeriod <int>] [-EnableLongTermRetention] [-LongTermRetentionType <VBRNASBackupLongTermRetentionType> {Monthly | Yearly}] [-LongTermBackupRepository <CBackupRepository>] [-LongTermRetentionPeriod <int>] [-LongTermArchivalOptions <VBRNASBackupArchivalOptions>] [-EnableSecondaryTarget] [-SecondaryTarget <VBRNASBackupSecondaryTarget[]>] [-StorageOptions <VBRStorageOptions>] [-HealthCheckOptions <VBRFullBackupOptions>] [-NotificationOptions <VBRNotificationOptions>] [-ScriptOptions <VBRJobScriptOptions>] [-EnableFileACLChangeTracking] [-EnableSchedule][-ScheduleOptions <VBRServerScheduleOptions>] [-Force]  [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of file backup jobs. This cmdlet modifies an existing VMware replication 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

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Job

Specifies the file backup job. The cmdlet will modify settings of the specified job.

Accepts the VBRNASBackupJob object. To create this object, run the Get-VBRNASBackup cmdlet.

True

Named

True (ByValue, ByPropertyName)

 

Name

Specifies a name of the file backup job. The cmdlet will change the existing name of the file backup job with the specified name.

String

False

Named

False

 

Description

Specifies a description of the file backup job. The cmdlet will change the existing description of the file backup job with the specified description.

String

False

Named

False

 

BackupObject

Specifies folders and files. The cmdlet will add these folders and files to the file backup job.

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

False

Named

False

 

ShortTermBackupRepository

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

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

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

False

Named

False

 

ShortTermRetentionPeriod

For the ShortTermRetentionType option.

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

Int32

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

SwitchParamter

False

Named

False

 

LongTermRetentionType

Specifies a retention policy for the long-term 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 LongTermRetentionPeriod to specify the number of days or months.

VBRNASBackupLongTermRetentionType

False

Named

False

 

LongTermBackupRepository

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

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

False

Named

False

 

LongTermRetentionPeriod

For the LongTermRetentionType option.

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

Int32

False

Named

False

 

LongTermArchivalOptions

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

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

False

Named

False

 

EnableSecondaryTarget

Defines that the cmdlet will enable a secondary backup repository for a file backup job.

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

SwitchParamter

False

Named

False

 

SecondaryTarget

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

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

False

Named

False

 

StorageOptions

Specifies storage optimization settings. The cmdlet will create the file backup job 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 file backup jobs 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 file backup jobs with these notification options.

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

False

Named

False

 

ScriptOptions

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

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

False

Named

False

 

EnableFileACLChangeTracking

Defines that Veeam Backup & Replication will process attributes and permissions for folders. Files that are added to these folders will inherit permissions of the folders.

If you enable this option, Veeam Backup & Replication will back up folder ACL attributes and permissions. Otherwise, they will not be backed up.

SwitchParamter

False

Named

False

 

EnableSchedule

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

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

VBRJobScriptOptions

False

Named

False

 

ScheduleOptions

Specifies schedule options. The cmdlet will create file backup jobs with these schedule options.

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

False

Named

False

 

Force

Indicates that the cmdlet will add create file backup without showing warnings in the PowerShell console.

SwitchParameter

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.

Output Object

The cmdlet returns the VBRNASBackupJob object that contains settings of file backup jobs.

Examples

Set-VBRNASBackupJobExample 1. Modifying Long-Term Repository

This example shows how to modify a long-term repository for a file backup job. The file backup job will have the following settings:

  • Veeam Backup & Replication will move data from the short-term repository to the Repository 09 backup repository.
  • Veeam Backup & Replication will keep file versions on the long-term repository for 3 years.

 

$job = Get-VBRNASBackup -Name "NFS Backup"

$repository = Get-VBRBackupRepository -Name "Repository 09"

Set-VBRNASBackupJob -Job $job -LongTermBackupRepository -EnableLongTermRetention -LongTermRetentionType Yearly -LongTermRetentionPeriod 3

Perform the following steps:

  1. Run the Get-VBRNASBackup 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 $repository variable.
  3. Run the Set-VBRNASBackupJob cmdlet. Specify the following settings:
  • Set the $Job variable as the Job parameter value.
  • Specify the LongTermBackupRepository parameter value.
  • Specify the EnableLongTermRetention parameter value.
  • Set the Yearly option for the LongTermRetentionType parameter value.
  • Specify the LongTermRetentionPeriod parameter value.

Set-VBRNASBackupJobExample 2. Modifying Notification Options

This example shows how to modify notification options for a file backup job. Veeam Backup & Replication will send notifications about the job warnings and when the job completes successfully.

$options = New-VBRNotificationOptions -EnableAdditionalNotification -AdditionalAddress admin@domain.com -UseNotificationOptions -NotifyOnSuccess -NotifyOnWarning

$job = Get-VBRNASBackup -Name "NFS Backup"

Set-VBRNASBackupJob -Job $job -NotificationOptions $options

Perform the following steps:

  1. Run the New-VBRNotificationOptions cmdlet. Specify the necessary parameters. Save the result to the $options variable.
  1. Run the Get-VBRNASBackup cmdlet. Specify the Name parameter value. Save the result to the $job variable.
  2. Run the Set-VBRNASBackupJob cmdlet. Specify the following settings:
  • Set the $Job variable as the Job parameter value.
  • Specify the LongTermBackupRepository parameter value.
  • Specify the EnableLongTermRetention parameter value.
  • Set the Yearly option for the LongTermRetentionType parameter value.
  • Specify the LongTermRetentionPeriod parameter value.

Set-VBRNASBackupJobExample 3. Enabling Secondary Target Repository

This example shows how to enable the secondary repository for the file backup job. The secondary repository will be created with the following settings:

  • Veeam Backup & Replication will apply a retention policy that is set to the file backup job.
  • Veeam Backup & Replication will apply an encryption key that is set to the file backup job.
  • Veeam Backup & Replication will copy data to the repository continuously.

 

$job = Get-VBRNASBackup -Name "NFS Backup"

$secondary = Get-VBRBackupRepository -Name "Repository 09"

Set-VBRNASBackupJob -Job $job -EnableSecondaryTarget -SecondaryTarget $secondary

Perform the following steps:

  1. Run the Get-VBRNASBackup 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 $repository variable.
  3. Run the Set-VBRNASBackupJob cmdlet. Specify the following settings:
  • Set the $Job variable as the Job parameter value.
  • Specify the EnableSecondaryTarget parameter.
  • Set the $secondary variable as the SecondaryTarget parameter value.

Related Commands

I want to report a typo

There is a misspelling right here:

 

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