Set-VBRStorageCopyJob

Short Description

Modifies storage backup copy jobs.

Applies to

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Set-VBRStorageCopyJob [-AnyTime] [-BackupWindowOptions <VBRBackupWindowOptions>] [-Description <String>] [-EnableHealthCheck] [-Force] -Job <VBRStorageCopyJob> [-KeepSecondaryCopies] [-Name <String>] [-NotificationOptions <VBRNotificationOptions>] [-ScriptOptions <VBRJobScriptOptions>] [-SecondaryCopiesRetentionPeriod <Int32>] [-SourceRepository <CBackupRepository[]>] [-TargetRepository <CBackupRepository[]>] [<CommonParameters>]

Detailed Description

This cmdlet modifies storage backup copy jobs for HPE StoreOnce and Dell Data Domain repositories.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Job	Specifies a storage backup copy job you want to modify. The cmdlet will modify the settings of this job.	Accepts the VBRStorageCopyJob object. To get this object, run the Get-VBRStorageCopyJob cmdlet.	True	Named	True (ByValue)
Name	Specifies a name of a storage backup copy job. The cmdlet will create the backup copy job with this name.	String	False	Named	False
Description	Specifies a description of a backup copy job. The cmdlet will create the backup copy job with this description.	String	False	Named	False
SourceRepository	Specifies an array of source repositories. The cmdlet will copy backup files from these repositories. You can specify the following types of repositories: HPE StoreOnce repositories. Scale-Out Backup repository that consists of HPE StoreOnce or Dell Data Domain extents. Dell Data Domain repositories.	Accepts the string and the CBackupRepository[] object. To get this object, run the Get-VBRBackupRepository cmdlet.	False	Named	False
TargetRepository	Specifies an array of target repositories. The cmdlet will copy backup files to these repositories. You can specify the following types of repositories: HPE StoreOnce repositories. Scale-Out Backup repository that consists of HPE StoreOnce or Dell Data Domain extents. Dell Data Domain repositories.	Accepts the string and the CBackupRepository[] object. To get this object, run the Get-VBRBackupRepository cmdlet.	False	Named	False
NotificationOptions	Specifies notification settings. The cmdlet will create the backup copy job with these settings.	Accepts the CBackupRepository object. To get this object, run the Get-VBRBackupRepository cmdlet.	False	Named	False
ScriptOptions	Specifies job script options. The cmdlet will create a copy job with these script options.	Accepts the VBRJobScriptOptions object. To create this object, run the New-VBRJobScriptOptions cmdlet.	False	Named	False
BackupWindowOptions	Specifies backup window settings for a job. The cmdlet will create the the backup copy job with these settings. Note: You cannot use this parameter together with the AnyTime parameter.	Accepts the VBRBackupWindowOptions object. To create this object, run the New-VBRBackupWindowOptions cmdlet.	False	Named	False
AnyTime	Defines that Veeam Backup & Replication will run a backup job continuously. Note: You cannot use this parameter together with the BackupWindowOptions parameter.	SwitchParameter	False	Named	False
KeepSecondaryCopies	Defines that the cmdlet will enable retention policy for the backup files in the target location.	SwitchParameter	False	Named	False
SecondaryCopiesRetentionPeriod	Specifies a number of days for which you want to store backup files in the target location.	Int32	False	Named	False
EnableHealthCheck	Defines that the cmdlet will enable the Health check option.	SwitchParameter	False	Named	False
Force	Defines that the cmdlet will modify backup copy jobs that are created for HPE StoreOnce and Dell Data Domain repositories without showing warnings in the PowerShell console.	SwitchParameter	False	Named	False

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

Output Object

The cmdlet returns the VBRStorageCopyJob object that contains settings of backup copy jobs for HPE StoreOnce and Dell Data Domain repositories.

Examples

Example 1. Modifying Backup Copy Job Schedule to Run at Specific Time

This example shows how to modify backup window settings for a backup copy job. The backup copy job will run from 20:00 to 22:59 every day from Monday to Friday.

$job = Get-VBRStorageCopyJob -Name "Backup Copy StoreOnce 05"

$windowoptions = New-VBRBackupWindowOptions -FromDay Monday -ToDay Friday -FromHour 20 -ToHour 22 -Enabled

Set-VBRStorageCopyJob -Job $job -BackupWindowOptions $windowoptions

Perform the following steps:

Run the Get-VBRStorageCopyJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
Run the New-VBRBackupWindowOptions cmdlet. Specify the necessary parameters. Save the result to the $windowoptions variable.
Run the Set-VBRStorageCopyJob cmdlet. Set the $job variable as the Job parameter value. Set the $windowoptions variable as the BackupWindowOptions parameter value.

Example 2. Modifying Backup Copy Job Schedule to Run Continuously

This example shows how to modify schedule settings for a backup copy job. The backup copy job will run continuously.

$job = Get-VBRStorageCopyJob -Name "Backup Copy StoreOnce 05"

Set-VBRStorageCopyJob -Job $job -BackupWindowOptions $windowoptions -AnyTime

Perform the following steps:

Run the Get-VBRStorageCopyJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
Run the Set-VBRStorageCopyJob cmdlet. Set the $job variable as the Job parameter value. Set the $windowoptions variable as the BackupWindowOptions parameter value. Provide the AnyTime parameter.

Related Commands