Set-VBOCopyJobSchedulePolicy

Short Description

Modifies the backup copy job schedule settings.

Syntax

This cmdlet provides parameter sets that allow you to:

  • Change the schedule type to Immediate.

Set-VBOCopyJobSchedulePolicy -Policy <VBOCopyJobSchedulePolicy> [-Type <VBOCopyJobFrequencyType>] [-BackupWindowSettings <VBOBackupWindowSettings>] [-EnableBackupWindow] [<CommonParameters>]

  • Change the schedule type to Periodically.

Set-VBOCopyJobSchedulePolicy -Policy <VBOCopyJobSchedulePolicy> [-Type <VBOCopyJobFrequencyType>] [-PeriodicallyEvery <VBOPeriodicInterval>] [-BackupWindowSettings <VBOBackupWindowSettings>] [-EnableBackupWindow] [<CommonParameters>]

  • Change the schedule type to Daily.

Set-VBOCopyJobSchedulePolicy -Policy <VBOCopyJobSchedulePolicy> [-Type <VBOCopyJobFrequencyType>] [-DailyTime <TimeSpan>] [-DailyType <VBODailyType>] [-BackupWindowSettings <VBOBackupWindowSettings>] [-EnableBackupWindow] [<CommonParameters>]

Detailed Description

This cmdlet modifies the backup copy job schedule settings. 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

Policy

Specifies the backup copy job schedule whose settings you want to modify.

Accepts the VBOCopyJobSchedulePolicy object.

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

True

Named

True (ByValue)

Type

Specifies a type of the backup copy job schedule:

  • Immediate: runs the backup copy job right after the latest restore point appears in the source backup repository.

During the first run of the backup copy job, Veeam Backup for Microsoft 365 copies the latest restore point created by the source backup job (backup job for which you create a backup copy job). During next runs — each subsequent restore point.

  • Daily: runs the backup copy job on specific days at the specified hours.
  • Periodically: runs the backup copy job repeatedly throughout a day with a specific time interval.

VBOCopyJobFrequencyType

False

Named

False

BackupWindowSettings

Specifies the backup window within which the backup copy job must be completed.

Accepts the VBOBackupWindowSettings object.

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

False

Named

False

EnableBackupWindow

Defines that the job run will be terminated if it exceeds the allowed backup window.

Default: False

SwitchParameter

False

Named

False

PeriodicallyEvery

Specifies the time interval between the job runs:

  • Minutes5
  • Minutes10
  • Minutes15
  • Minutes30
  • Hours1
  • Hours2
  • Hours4
  • Hours8
  • Hours12

VBOPeriodicInterval

False

Named

False

DailyTime

Specifies the time to start the backup copy job.

TimeSpan

False

Named

False

DailyType

Specifies the days when the backup copy job will run:

  • Everyday
  • Weekends
  • Workdays
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday

VBODailyType

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 VBOCopyJobSchedulePolicy object that contains the backup copy job schedule settings.

Examples

Set-VBOCopyJobSchedulePolicyExample 1. Changing Backup Copy Job Schedule Type to Immediate

Set-VBOCopyJobSchedulePolicyExample 2. Changing Backup Copy Job Schedule Type from Daily to Periodically

Set-VBOCopyJobSchedulePolicyExample 3. Changing Backup Copy Job Schedule Type from Periodically to Daily

Related Commands

Page updated 5/28/2024

Page content applies to build 8.1.1.159