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

New-VBRFullBackupOptions

Short Description

Creates an active full backup schedule for Veeam Agent backup jobs.

Applies to

Product Edition: Community, Standard, Enterprise, Enterprise Plus

Syntax

New-VBRFullBackupOptions [-Enable] [-ScheduleType <VBRFullBackupScheduleType> {Weekly | Monthly}] [-SelectedDays <DayOfWeek[]> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-DayNumber <VBRDayNumberInMonth> {First | Second | Third | Fourth | Last | OnDay}] [-DayOfWeek <DayOfWeek> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-DayOfMonth <string>] [-SelectedMonths <VBRMonth[]> {January | February | March | April | May | June | July | August | September | October | November | December}][<CommonParameters>]

Detailed Description

This cmdlet creates the VBRFullBackupOptions object that contains schedule for Veeam Agent backup jobs. You can use this object to set up the following types of schedules for Veeam Agent backup jobs:

  • HealthCheck schedules
  • Compact full backup schedules
  • Active full backup schedules

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Enable

Indicates that the Veeam Agent backup job will create active full backups.

False

Named

False

 

ScheduleType

Specifies the active full backups schedule type.

  • Monthly: the job will create an active full on selected days of the month.
  • Weekly: the job will create an active full on selected days of the week.

False

Named

False

 

SelectedDays

For weekly backups.

Specifies the day of the week when the job creates active full backups.

Default: Saturday.

False

Named

False

 

DayNumber

For monthly backups.

Specifies the day of the month when the job creates active full backups.

  • First: the job will create an active full backup on the first specified day of the week for the selected months.
  • Second: the job will create an active full backup on the second specified day of the week for the selected months.
  • Third: the job will create an active full backup on the third specified day of the week for the selected months.
  • Fourth: the job will create an active full backup on the fourth specified day of the week for the selected months.
  • Last: the job will create an active full backup on the last specified day of the week for the selected months.
  • OnDay: the job will create an active full backup on the selected day of the month. Use the DayOfMonth parameter to set the day.

False

Named

False

 

DayOfWeek

For monthly backups.

Specifies the day of the week, when the job creates active full backups.

  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday

Default: Saturday.

False

Named

False

 

DayOfMonth

For monthly backups with the OnDay option.

Specifies the day of the month, when the job creates active full backups.

For example, on the 3rd day of November.

False

Named

False

 

SelectedMonths

Specifies the months, when the job creates active full backups.

  • January
  • February
  • March
  • April
  • May
  • June
  • July
  • August
  • September
  • October
  • November
  • December

Default: all months are selected.

False

Named

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

Example 1

This command schedules a Veeam Agent backup job to create active full backups weekly. The job will create active full backups on Sunday and Wednesday.

New-VBRFullBackupOptions -Enable -ScheduleType Weekly -SelectedDays Sunday, Wednesday

Example 2

This command schedules the Veeam Agent backup job to create active full backups monthly. The job will create active full backups on the 15th of January, April and September.

New-VBRFullBackupOptions -Enable -ScheduleType Monthly -DayNumber OnDay -DayOfMonth 15 -SelectedMonths January, April, September

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation