Help Center
Choose product document...
Veeam Backup for Microsoft Office 365 3.0
PowerShell Reference

Set-VBORepository

Short Description

Modifies backup repository settings.

Syntax

This cmdlet provides the following parameter sets.

  • Modify repository with retention period measured in years

Set-VBORepository -Repository <VBORepository> [-Name <string>] [-Description <string>] [-RetentionPeriod <VBORetentionPeriod> {Year1 | Years2 | Years3 | Years5 | Years7 | Years10 | Years25 | KeepForever}] [-RetentionFrequencyType <VBORetentionFrequencyType> {Daily | Monthly}] [-DailyTime <timespan>] [-DailyType <VBODailyType> {Everyday | Workdays | Weekends | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday}] [-MonthlyTime <timespan>] [-MonthlyDayNumber <VBOMonthlyDayNumber> {First | Second | Third | Fourth | Last}] [-MonthlyDayOfWeek <DayOfWeek> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}]  [<CommonParameters>]

  • Modify repository with retention period measured in months or days

Set-VBORepository -Repository <VBORepository> [-Name <string>] [-Description <string>] [-CustomRetentionPeriodType <VBOCustomRetentionPeriodType> {Months | Days}] [-CustomRetentionPeriod <int>] [-RetentionFrequencyType <VBORetentionFrequencyType> {Daily | Monthly}] [-DailyTime <timespan>] [-DailyType <VBODailyType> {Everyday | Workdays | Weekends | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday}] [-MonthlyTime <timespan>] [-MonthlyDayNumber <VBOMonthlyDayNumber> {First | Second | Third | Fourth | Last}] [-MonthlyDayOfWeek <DayOfWeek> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}]  [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of a backup repository added to Veeam Backup for Microsoft Office 365 infrastructure.

To modify settings, enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Repository

Specifies the backup repository.  The cmdlet will modify settings of this object.

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

True

Named

True (ByValue)

False

Retention
Period

Specifies the retention period in years. Veeam Backup for Microsoft Office 365 will remove items from a backup repository once this period is passed. You can set either of the following periods:

  • Year1
  • Years2
  • Years3
  • Years5
  • Years7
  • Years10
  • Years25
  • KeepForever

Default: Years3.

Apply the CustomRetentionPeriodType parameter to set the retention period in months or days.

True

Named

False

False

Name

Specifies a name for the backup repository.

False

Named

False

False

Description

Specifies a description for future reference. The default description contains information on the user who added the backup repository, date and time when the backup repository was added.

False

Named

False

False

Custom
Retention
Period
Type

Specifies the type of custom retention period. You can set either of the following types:

  • Months
  • Days

Set the CustomRetentionPeriod parameter to specify the number of days or the number of months.

False

Named

False

False

Custom
Retention
Period

For the CustomRetentionPeriodType option.

Specifies the retention period to keep data on a backup repository.

  • Sets the retention period to the number of months if the CustomRetentionPeriodType parameter is set to Months.
  • Sets the retention period to the number of days if the CustomRetentionPeriodType parameter is set to Days.

Veeam Backup for Microsoft Office 365 will remove items from a backup repository once this period is passed.

False

Named

False

False

Retention
Frequency
Type

Specifies retention policy schedule. Veeam Backup for Microsoft Office 365 will check a backup repository and will remove the outdated backups according to this schedule. You can set either of the following schedule:

  • Daily: to check a backup repository and remove the outdated backups once a day.
    Set the DailyTime and  DailyType parameters to specify daily retention policy schedule.
  • Monthly: to check a backup repository and remove the outdated backups once a month.
    Set the MonthlyTime, MonthlyDayNumber and MonthlyDayOfWeek parameters to specify monthly retention policy schedule.

Default: Daily

False

Named

False

False

Daily
Time

For daily retention policy schedule.

Specifies the time of the day when Veeam Backup for Microsoft Office 365 must apply the retention policy.

Default: 00:00:00

False

Named

False

False

Daily
Type

For daily retention policy schedule.

Specifies the days when Veeam Backup for Microsoft Office 365 must apply the retention policy:

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

Default: Everyday

False

Named

False

False

Monthly
Time

For monthly retention policy schedule.

Specifies the time of the day when Veeam Backup for Microsoft Office 365 must apply the retention policy.

Default: 18:00:00

False

Named

False

False

Monthly
DayNumber

For monthly retention policy schedule.

Specifies the order number for the day of the week when Veeam Backup for Microsoft Office 365 must apply the retention policy.

  • First
  • Second
  • Third
  • Fourth
  • Last

Default: First

False

Named

False

False

Monthly
DayOfWeek

For monthly retention policy schedule.

Specifies the day of the week when Veeam Backup for Microsoft Office 365 must apply the retention policy.

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

Default: Monday

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Example 1

This example shows how to configure retention settings for the backup repository:

  • Retention period must be 5 years.
  • Clean-up must be performed on weekends at 11:59 PM.

You will need to perform the following steps:

  1. Run Get-VBORepository to get the backup repository. Save the result to the $repository variable.
  2. Run Set-VBORepository with $repository variable.

$repository = Get-VBORepository -Name "ABC Backup"

Set-VBORepository -Repository $repository -RetentionPeriod years5 -RetentionFrequencyType Daily -DailyType Weekends -DailyTime 23:59:00

Example 2

This example shows how to change the name of the backup repository and configure clean-up schedule with the following settings:

  • Retention period for organization backups must be 6 months.
  • Clean-up must be performed on every second Monday at 7:59 AM.

You will need to perform the following steps:

  1. Run Get-VBORepository to get the backup repository. Save the result to the $repository variable.
  2. Run Set-VBORepository with the $repository variable.

$repository = Get-VBORepository -Name "ABC Backup"

Set-VBORepository -Repository $repository -Name "Monthly Reports" -CustomRetentionPeriodType Months -CustomRetentionPeriod 6 -RetentionFrequencyType Monthly -MonthlyDayNumber Second -MonthlyDayOfWeek Monday -MonthlyTime 07:59:00

Related Commands

Get-VBORepository

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference