Set-VBOCopyJob

Short Description

Modifies settings of a backup copy job.

Syntax

Set-VBOCopyJob -Job <VBOCopyJob> [-Repository <VBORepository>] [-SchedulePolicy <VBOCopyJobSchedulePolicy>] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of a backup copy job. To modify settings, you need to enter the necessary 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 a backup copy job whose settings you want to modify.	Accepts the VBOCopyJob object. To get this object, run the Get-VBOCopyJob cmdlet.	True	Named	True (ByValue)	False
Repository	Specifies a backup repository extended with object storage. Veeam Backup for Microsoft 365 uses this backup repository as a target for backup copy jobs.	Accepts the VBORepository object. To get this object, run the Get-VBORepository cmdlet.	False	Named	False	False
SchedulePolicy	Specifies schedule settings for a backup copy job.	Accepts the VBOCopyJobSchedulePolicy object. To create this object, run the New-VBOCopyJobSchedulePolicy cmdlet.	False	Named	False	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Job

Specifies a backup copy job whose settings you want to modify.

Accepts the VBOCopyJob object.

To get this object, run the Get-VBOCopyJob cmdlet.

True

Named

True (ByValue)

False

Repository

Specifies a backup repository extended with object storage. Veeam Backup for Microsoft 365 uses this backup repository as a target for backup copy jobs.

Accepts the VBORepository object.

To get this object, run the Get-VBORepository cmdlet.

False

Named

False

SchedulePolicy

Specifies schedule settings for a backup copy job.

Accepts the VBOCopyJobSchedulePolicy object.

To create this object, run the New-VBOCopyJobSchedulePolicy cmdlet.

False

Named

False

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 VBOCopyJob object that contains settings for a backup copy job.

Examples

Set-VBOCopyJob Example 1. Modifying Backup Repository for Backup Copy Job

This example shows how to change a target backup repository for the backup copy job created for the backup job with the name ABC Backup.

$job = Get-VBOJob -Name "ABC Backup"

$copyjob = Get-VBOCopyJob -BackupJob $job

$repository = Get-VBORepository -Name "Amazon S3 Glacier Flexible Retrieval repository"

Set-VBOCopyJob -Job $copyjob -Repository $repository

Perform the following steps:

Run the Get-VBOJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
Run the Get-VBOCopyJob cmdlet. Set the $job variable as the BackupJob parameter value. Save the result to the $copyjob variable.
Run the Get-VBORepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
Run the Set-VBOCopyJob cmdlet. Specify the following settings:

Set the $copyjob variable as the Job parameter value.
Set the $repository variable as the Repository parameter value.

Set-VBOCopyJob Example 2. Setting New Schedule for Backup Copy Job

This example shows how to set new schedule settings for a backup copy job. A backup copy job will run every 8 hours.

$copyjob = Get-VBOCopyJob -Id 8b6b539e-15cc-4ed6-bd1d-b8c7c918f413

$every8hours = New-VBOCopyJobSchedulePolicy -Type Periodically -PeriodicallyEvery Hours8

Set-VBOCopyJob -Job $copyjob -SchedulePolicy $every8hours

Perform the following steps:

Run the Get-VBOCopyJob cmdlet to get a backup copy job whose schedule settings you want to configure. Specify the Id parameter value. Save the result to the $copyjob variable.
Run the New-VBOCopyJobSchedulePolicy cmdlet to set the job schedule. Specify the necessary parameters. Save the result to the $every8hours variable.
Run the Set-VBOCopyJob cmdlet. Set the $copyjob variable as the Job parameter value. Set the $every8hours variable as the SchedulePolicy parameter value.

Related Commands