New-VBRBackupToTapeScheduleOptions

Short Description

Creates schedule settings for backup to tape job.

Applies to

Platform: VMware, Hyper-V

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

Syntax

New-VBRBackupToTapeScheduleOptions [-Type <VBRBackupToTapePolicyType>] [-DailyOptions <VBRDailyOptions>] [-MonthlyOptions <VBRMonthlyOptions>] [-BackupWindowOptions <VBRBackupWindowOptions>] [-Job <VBRJob>] [-Enabled][-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

This cmdlet creates the VBRBackupToTapeScheduleOptions object. This object contains schedule settings for backup to tape job and is used further to apply these settings to an existing backup to tape job.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Type

Specifies the job schedule type:

  • AfterJob: the tape job will wait for the source backup job to complete.
  • AfterNewBackup: the tape job will periodically check the source jobs for new backups and archive new backups to tape.
  • Daily: the tape job will run on selected days. Use the DailyOptions parameter to set the days.
  • Monthly: the tape job will run on selected months. Use the MonthlyOptions parameter to set the months.

Default: Daily.

VBRBackupToTapePolicyType

False

Named

False

DailyOptions

Used to set days for the Type parameter (Daily option).

Default:

  • Type: SelectedDays.
  • Period: 18:00.
  • DayOfWeek: Saturday.

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

False

Named

False

MonthlyOptions

Used to set months for the Type parameter (Monthly option).

Default:

  • Period: 22:00.
  • DayNumberInMonth: Fourth.
  • DayOfWeek: Saturday.
  • Months: January, February, March, April, May, June, July, August, September, October, November, December.

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

False

Named

False

BackupWindowOptions

Specifies backup windows: the tape job will run within the specified time interval.

Default:

  • From Sunday to Saturday.
  • From 00:00 to 23:00.
  • Enabled: True.

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

False

Named

False

Job

Specifies the source backup job after which the tape job must run.

Default: Null.

Accepts the CBackupJob or the VBRJob objects. To get this object, run the Get-VBRJob cmdlet.

False

Named

False

Enabled

Defines if this schedule is enabled.

Default: False.

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

VBRBackupToTapeScheduleOptions

Examples

Creating Tape Job Schedule

This example shows how to create a tape job schedule with the following settings:

  • The job runs every Friday.
  • The job starts at 23:00.

$dailyoptions = New-VBRDailyOptions -DayOfWeek Friday -Period 23:00

$scheduleoptions = New-VBRBackupToTapeScheduleOptions -DailyOptions $dailyoptions -Enabled

Perform the following steps:

  1. Run the New-VBRDailyOptions cmdlet. Set Friday as the DayOfWeek parameter value and 23:00 as the Period parameter value. Save the result to the $dailyoptions variable.
  2. Run the New-VBRBackupToTapeScheduleOptions cmdlet. Set the $dailyoptions variable as the DailyOptions parameter value. Save the schedule to the $scheduleoptions variable for future use.

Related Commands