Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

New-VBRBackupToTapeScheduleOptions

Short Description

Creates a new VBRBackupToTapeScheduleOptions object.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

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

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

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.

False

Named

False

False

Daily
Options

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

Accepts VBRDailyOptions type.

Default:

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

False

Named

False

False

Monthly
Options

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

Accepts VBRMonthlyOptions type.

Default:

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

False

Named

False

False

Backup
Window
Options

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

Accepts VBRBackupWindowOptions type.

Default:

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

False

Named

False

False

Job

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

Accepts VBRJob or CBackupJob type.

Default: Null.

False

Named

False

False

Enabled

Indicates if this schedule is enabled.

Default: False.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

VBRBackupToTapeScheduleOptions

Example

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.

To create a job schedule:

  1. Run New-VBRDailyOptions to set the day and time. Save the result to the $dailyoptions variable.
  2. Run New-VBRBackupToTapeScheduleOptions with the saved variable. Save the schedule to the $scheduleoptions variable for future use.

PS C:\PS> $dailyoptions = New-VBRDailyOptions -DayOfWeek Friday -Period 23:00

PS C:\PS> $scheduleoptions = New-VBRBackupToTapeScheduleOptions -DailyOptions $dailyoptions -Enabled

Related Commands

New-VBRDailyOptions

New-VBRMonthlyOptions

New-VBRBackupWindowOptions

Get-VBRJob

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Endpoint Backup Documentation

Veeam Management Pack Documentation