Short Description
Modifies backup repository settings.
Syntax
This cmdlet provides 2 parameter sets.
- For modifying 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>] |
- For modifying 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.
To modify settings, enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Repository | Specifies the backup repository that you want to modify. | True | Named | True (ByValue) | False |
Name | Specifies the name you want to assign to the backup repository. | False | Named | False | False |
Description | Specifies the description of the backup repository. | False | Named | False | False |
Retention | Specifies the retention period in years:
Backup jobs targeted to this repository will back up organization mailbox items that were created or modified within the indicated retention period. For example, if you set the retention period to 2 years, the backup job will back up all items that were created or modified 2 years ago or later. When an item’s age exceeds the retention, it is deleted. If you select Keep forever, the backup job will back up all items in the mailbox and will never remove them. If you want to measure the retention period in months or days, use CustomRetentionPeriodType parameter. | True | Named | False | False |
Retention | Indicates that the retention period will be set either in months or days:
| False | Named | False | False |
Custom | Specifies the retention period in months or days:
Backup jobs targeted to this repository will back up organization mailbox items that were created or modified within the indicated retention period. For example, if you set the CustomRetentionPeriodType to Months and CustomRetentionPeriod to 23, the backup job will back up all items that were created or modified 23 months ago or later. When an item’s age exceeds the retention, it is deleted. | False | Named | False | False |
Retention | Specifies clean-up schedule type:
| False | Named | False | False |
Daily | For daily clean-up schedule. Specifies the time of the day when clean-up must be performed. | False | Named | False | False |
Daily | For daily clean-up schedule. Specifies the days when clean-up must be performed:
| False | Named | False | False |
Monthly | For monthly clean-up schedule. Specifies the time of the day when clean-up must be performed. | False | Named | False | False |
Monthly | For monthly clean-up schedule. Specifies the order number for the day of the week when clean-up must be performed:
| False | Named | False | False |
Monthly | For monthly clean-up schedule. Specifies the day of the week when clean-up must be performed:
| 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.
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:
- Run Get-VBORepository to get the backup repository. Save the result to the $repository variable.
- Run Set-VBORepository with $repository variable.
PS C:\PS> $repository = Get-VBORepository -Name "ABC Backup" PS C:\PS> 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 mailbox 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:
- Run Get-VBORepository to get the backup repository. Save the result to the $repository variable.
- Run Set-VBORepository with the $repository variable.
PS C:\PS> $repository = Get-VBORepository -Name "ABC Backup" PS C:\PS> Set-VBORepository -Repository $repository -Name "Monthly Reports" -CustomRetentionPeriodType Months -CustomRetentionPeriod 6 -RetentionFrequencyType Monthly -MonthlyDayNumber Second -MonthlyDayOfWeek Monday -MonthlyTime 07:59:00 |
Related Commands
